Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bug/236: Include all gridIntensity values in adjustments when only some are overridden #237

Merged
merged 3 commits into from
Nov 30, 2024
Merged

Bug/236: Include all gridIntensity values in adjustments when only some are overridden #237

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4c1b8cb
reduce repeated code and ensure default gridIntensity is returned
APJohns Nov 7, 2024
afea798
address linter errors
APJohns Nov 7, 2024
e58125e
Squashed commit of the following:
fershad Nov 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
105 changes: 31 additions & 74 deletions src/helpers/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,96 +33,53 @@ function parseOptions(options = {}, version = 3, green = false) {

const adjustments = {};

if (options?.gridIntensity) {
adjustments.gridIntensity = {};
const { device, dataCenter, network } = options.gridIntensity;
if (device || device === 0) {
if (typeof device === "object") {
if (!averageIntensity.data[device.country?.toUpperCase()]) {
console.warn(
`"${device.country}" is not a valid country. Please use a valid 3 digit ISO 3166 country code. \nSee https://developers.thegreenwebfoundation.org/co2js/data/ for more information. \nFalling back to global average grid intensity.`
);
adjustments.gridIntensity["device"] = {
value: globalGridIntensity,
};
}
adjustments.gridIntensity["device"] = {
country: device.country,
value: parseFloat(
averageIntensity.data[device.country?.toUpperCase()]
),
};
} else if (typeof device === "number") {
adjustments.gridIntensity["device"] = {
value: device,
};
} else {
adjustments.gridIntensity["device"] = {
value: globalGridIntensity,
};
console.warn(
`The device grid intensity must be a number or an object. You passed in a ${typeof device}. \nFalling back to global average grid intensity.`
);
}
}
if (dataCenter || dataCenter === 0) {
if (typeof dataCenter === "object") {
if (!averageIntensity.data[dataCenter.country?.toUpperCase()]) {
console.warn(
`"${dataCenter.country}" is not a valid country. Please use a valid 3 digit ISO 3166 country code. \nSee https://developers.thegreenwebfoundation.org/co2js/data/ for more information. \nFalling back to global average grid intensity.`
);
adjustments.gridIntensity["dataCenter"] = {
value: SWDM3_GLOBAL_GRID_INTENSITY,
};
}
adjustments.gridIntensity["dataCenter"] = {
country: dataCenter.country,
value: parseFloat(
averageIntensity.data[dataCenter.country?.toUpperCase()]
),
};
} else if (typeof dataCenter === "number") {
adjustments.gridIntensity["dataCenter"] = {
value: dataCenter,
};
} else {
adjustments.gridIntensity["dataCenter"] = {
value: globalGridIntensity,
};
console.warn(
`The data center grid intensity must be a number or an object. You passed in a ${typeof dataCenter}. \nFalling back to global average grid intensity.`
);
}
}
if (network || network === 0) {
if (typeof network === "object") {
if (!averageIntensity.data[network.country?.toUpperCase()]) {
/**
*
* @param {string} segment The name of the segment ("device"|"dataCenter"|"network")
* @param {number|object} segmentIntensity The segment intensity
*/
function setIntensity(segment, segmentIntensity) {
if (segmentIntensity || segmentIntensity === 0) {
if (typeof segmentIntensity === "object") {
if (!averageIntensity.data[segmentIntensity.country?.toUpperCase()]) {
console.warn(
`"${network.country}" is not a valid country. Please use a valid 3 digit ISO 3166 country code. \nSee https://developers.thegreenwebfoundation.org/co2js/data/ for more information. Falling back to global average grid intensity. \nFalling back to global average grid intensity.`
`"${segmentIntensity.country}" is not a valid country. Please use a valid 3 digit ISO 3166 country code. \nSee https://developers.thegreenwebfoundation.org/co2js/data/ for more information. \nFalling back to global average grid intensity.`
);
adjustments.gridIntensity["network"] = {
adjustments.gridIntensity[segment] = {
value: globalGridIntensity,
};
}
adjustments.gridIntensity["network"] = {
country: network.country,
adjustments.gridIntensity[segment] = {
country: segmentIntensity.country,
value: parseFloat(
averageIntensity.data[network.country?.toUpperCase()]
averageIntensity.data[segmentIntensity.country?.toUpperCase()]
),
};
} else if (typeof network === "number") {
adjustments.gridIntensity["network"] = {
value: network,
} else if (typeof segmentIntensity === "number") {
adjustments.gridIntensity[segment] = {
value: segmentIntensity,
};
} else {
adjustments.gridIntensity["network"] = {
adjustments.gridIntensity[segment] = {
value: globalGridIntensity,
};
console.warn(
`The network grid intensity must be a number or an object. You passed in a ${typeof network}. \nFalling back to global average grid intensity.`
`The ${segment} grid intensity must be a number or an object. You passed in a ${typeof segmentIntensity}. \nFalling back to global average grid intensity.`
);
}
} else {
adjustments.gridIntensity[segment] = {
value: globalGridIntensity,
};
}
}

if (options?.gridIntensity) {
adjustments.gridIntensity = {};
const { device, dataCenter, network } = options.gridIntensity;
setIntensity("device", device);
setIntensity("dataCenter", dataCenter);
setIntensity("network", network);
} else {
adjustments.gridIntensity = {
device: { value: globalGridIntensity },
Expand Down
Loading