@tgwf/co2 0.6.1 → 0.7.0

package/.github/workflows/unittests.yml

@@ -0,0 +1,26 @@
+name: Unit tests
+on:
+  push:
+    branches:
+    - main
+  pull_request:
+    branches:
+    - main
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [12.x, 14.x, 16.x]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+    - name: Install 
+      run: npm ci
+    - name: Verify lint
+      run: npm run lint
+    - name: Run unit tests
+      run: npm test

package/CHANGELOG.md

@@ -5,12 +5,22 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 -
+
 ## Unreleased
 
+- Include a new alternative, "Green Byte Model" with the figures after speaking to folks at the IEA and other places.
+## [0.7.0] - 2021-11-28
+
+### Fixed
+
+- Update tests to avoid network requests #50
+- Update dependencies across the board
+
+### Changed
 
-- Include the new alternative, "Green Byte Model" with the figures after speaking to folks at the IEA and other places.
+- Switch to github actions instead of travis for CI.
 
-## ## [0.6.1] - 2020-03-15
+## [0.6.1] - 2020-03-15
 
 ### Fixed
 

package/README.md

@@ -1,10 +1,11 @@
 # CO2
 
-<img src="https://travis-ci.org/thegreenwebfoundation/co2.js.svg?branch=master" />
+<img src="https://github.com/thegreenwebfoundation/co2.js/actions/workflows/unittests.yml/badge.svg" />
+
 
 We know computers use electricity, and because most of the electricity we use comes from burning fossil fuels to generate, there is an environmental cost to every upload and download we make over the internet.
 
-We cando something about this though. The same way we use performance budgets make apps and website faster and cheaper to run, we can use carbon budgets to make them faster, cheaper and _greener_.
+We can do something about this though. The same way we use performance budgets to make apps and websites faster and cheaper to run, we can use carbon budgets to make them faster, cheaper and _greener_.
 
 The CO2 package from [The Green Web Foundation][tgwf] lets you quickly estimate these emissions, to make measurable improvements as part of your workflow.
 
@@ -24,17 +25,40 @@ This is open source software, with all the guarantees associated, so if you want
 
 ## Usage
 
+### Calculating emissions per byte
+
+#### Server-side
+
+This approach relies on the `fs` module and so can only be used on platforms, like Node.js, that support this.
+
 ```js
 
 const CO2 = require('@tgwf/co2')
-const bytesSent = 1_000_000
+const bytesSent = (1024 * 1024 * 1024)
 const co2Emission = new CO2();
 estimatedCO2 = co2Emission.perByte(bytesSent)
 
-console.log(`Sending a million bytes, had a carbon footprint of ${estimatedCO2.toFixed(3)} grams of CO2`)
+console.log(`Sending a gigabyte, had a carbon footprint of ${estimatedCO2.toFixed(3)} grams of CO2`)
 
 ```
 
+#### Browser-side
+
+For browser-based solutions, you must import the `co2.js` submodule directly from `node_modules`. For example, like this:
+
+```js
+
+const CO2 = require('node_modules/@tgwf/co2/src/co2.js')
+const bytesSent = (1024 * 1024 * 1024)
+const co2Emission = new CO2();
+estimatedCO2 = co2Emission.perByte(bytesSent)
+
+console.log(`Sending a gigabyte, had a carbon footprint of ${estimatedCO2.toFixed(3)} grams of CO2`)
+
+```
+
+### Checking for green power
+
 Because different digital services and websites use different forms of power, there is also a module for checking if a domain uses green power or not, and whether the domains linked to on a page use green power as well.
 
 ```js
@@ -44,25 +68,30 @@ const greencheck = require('@tgwf/hosting')
 // returns true if green, otherwise false
 greencheck.check("google.com")
 
-// returns an array of the green domains, in this case ["google.
-greencheck.check(["google.com", "kochindustries.com"]) com"]
+// returns an array of the green domains, in this case ["google.com"].
+greencheck.check(["google.com", "kochindustries.com"])]
 
 // returns an array of green domains, again in this case, ["google.com"]
 greencheck.checkPage(["google.com"])
 
 ```
 
-Please note, we currently look at just the carbon cost of _generating_ the electricity, similar to how the IEA does, not the full life cycle cost of the energy, which would include things like:
+### Notes
+
+Please note, we currently look at just the carbon cost of _generating_ the electricity, similar to how the [International Energy Agency (IEA)] does, not the full life cycle cost of the energy.
+
+Doing this would include things like:
 
-- the carbon associated with digging up the fuel
-- the carbon associated with mining the materials to build the power stations, datacentres
+- the carbon emitted when carrying out activity associated with digging up the fuel
+- the carbon associated with mining the materials to _build_ the power stations, datacentres, and so on
 - the end of life costs
 - the maintenance costs over the life of the datacentres, power generation and end user devices, and the rest of the internet
 
-We'd like to do this, and we know how complicated this is likely to be.
+Life cycle figures do exist, but they are very difficult to do well. If you're interested in contributing to this, we'd love to hear from you.
 
 
 # Licenses
 
 Apache 2.0
 
+[International Energy Agency (IEA)]: https://www.iea.org/

package/data/fixtures/url2green.test.json

@@ -1 +1 @@
-["google.com"]
+["google.com","maxcdn.bootstrapcdn.com","thegreenwebfoundation.org","www.thegreenwebfoundation.org","fonts.googleapis.com","ajax.googleapis.com","assets.digitalclimatestrike.net","cdnjs.cloudflare.com","graphite.thegreenwebfoundation.org","analytics.thegreenwebfoundation.org","fonts.gstatic.com","api.thegreenwebfoundation.org"]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tgwf/co2",
-  "version": "0.6.1",
+  "version": "0.7.0",
   "description": "Work out the co2 of your digital services",
   "main": "src/index.js",
   "scripts": {
@@ -21,15 +21,17 @@
   "author": "Chris Adams",
   "license": "Apache-2.0",
   "devDependencies": {
-    "@tgwf/url2green": "^0.3.0",
-    "eslint": "6.8.0",
-    "eslint-config-prettier": "6.10.0",
-    "eslint-plugin-jest": "23.8.1",
-    "eslint-plugin-prettier": "3.1.2",
-    "jest": "25.1.0",
-    "np": "^5.2.1",
-    "pagexray": "^2.5.9",
-    "prettier": "1.19.1"
+    "@tgwf/url2green": "^0.4.0",
+    "eslint": "^8.3.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-jest": "^25.2.4",
+    "eslint-plugin-prettier": "^4.0.0",
+    "jest": "^27.3.1",
+    "minimist": "^1.2.5",
+    "nock": "^13.2.1",
+    "np": "^7.6.0",
+    "pagexray": "^4.3.1",
+    "prettier": "^2.4.1"
   },
   "np": {
     "yarn": false

package/src/1byte.js

@@ -23,5 +23,5 @@ module.exports = {
   KWH_PER_BYTE_IN_DC,
   KWH_PER_BYTE_FOR_NETWORK,
   KWH_PER_BYTE_FOR_DEVICES,
-  CO2_PER_KWH_IN_DC_GREY
+  CO2_PER_KWH_IN_DC_GREY,
 };

package/src/co2.js

@@ -57,10 +57,10 @@ class CO2 {
       co2PerDomain.push({
         domain,
         co2,
-        transferSize: pageXray.domains[domain].transferSize
+        transferSize: pageXray.domains[domain].transferSize,
       });
     }
-    co2PerDomain.sort(function(a, b) {
+    co2PerDomain.sort(function (a, b) {
       return b.co2 - a.co2;
     });
 
@@ -105,10 +105,10 @@ class CO2 {
       all.push({
         type,
         co2: co2PerContentType[type].co2,
-        transferSize: co2PerContentType[type].transferSize
+        transferSize: co2PerContentType[type].transferSize,
       });
     }
-    all.sort(function(a, b) {
+    all.sort(function (a, b) {
       return b.co2 - a.co2;
     });
     return all;
@@ -125,7 +125,7 @@ class CO2 {
       );
       allAssets.push({ url: asset.url, co2: co2ForTransfer, transferSize });
     }
-    allAssets.sort(function(a, b) {
+    allAssets.sort(function (a, b) {
       return b.co2 - a.co2;
     });
 

package/src/co2.test.js

@@ -6,7 +6,7 @@ const path = require("path");
 const CO2 = require("./co2");
 const pagexray = require("pagexray");
 
-describe("co2", function() {
+describe("co2", function () {
   let har, co2;
   const TGWF_GREY_VALUE = 2.0484539712;
   const TGWF_GREEN_VALUE = 0.54704300112;
@@ -16,7 +16,7 @@ describe("co2", function() {
   const MILLION_GREY = 2.9064;
   const MILLION_GREEN = 2.318;
 
-  beforeEach(function() {
+  beforeEach(function () {
     co2 = new CO2();
     har = JSON.parse(
       fs.readFileSync(
@@ -26,25 +26,25 @@ describe("co2", function() {
     );
   });
 
-  describe("perByte", function() {
-    it("returns a CO2 number for data transfer using 'grey' power", function() {
+  describe("perByte", function () {
+    it("returns a CO2 number for data transfer using 'grey' power", function () {
       expect(co2.perByte(MILLION)).toBe(MILLION_GREY);
     });
 
-    it("returns a lower CO2 number for data transfer from domains using entirely 'green' power", function() {
+    it("returns a lower CO2 number for data transfer from domains using entirely 'green' power", function () {
       expect(co2.perByte(MILLION, false)).toBe(MILLION_GREY);
       expect(co2.perByte(MILLION, true)).toBe(MILLION_GREEN);
     });
   });
 
-  describe("perPage", function() {
-    it("returns CO2 for total transfer for page", function() {
+  describe("perPage", function () {
+    it("returns CO2 for total transfer for page", function () {
       const pages = pagexray.convert(har);
       const pageXrayRun = pages[0];
 
       expect(co2.perPage(pageXrayRun)).toBe(TGWF_GREY_VALUE);
     });
-    it("returns lower CO2 for page served from green site", function() {
+    it("returns lower CO2 for page served from green site", function () {
       const pages = pagexray.convert(har);
       const pageXrayRun = pages[0];
       let green = [
@@ -56,11 +56,11 @@ describe("co2", function() {
         "graphite.thegreenwebfoundation.org",
         "analytics.thegreenwebfoundation.org",
         "fonts.gstatic.com",
-        "api.thegreenwebfoundation.org"
+        "api.thegreenwebfoundation.org",
       ];
       expect(co2.perPage(pageXrayRun, green)).toBeLessThan(TGWF_GREY_VALUE);
     });
-    it("returns a lower CO2 number where *some* domains use green power", function() {
+    it("returns a lower CO2 number where *some* domains use green power", function () {
       const pages = pagexray.convert(har);
       const pageXrayRun = pages[0];
       // green can be true, or a array containing entries
@@ -73,13 +73,13 @@ describe("co2", function() {
         "graphite.thegreenwebfoundation.org",
         "analytics.thegreenwebfoundation.org",
         "fonts.gstatic.com",
-        "api.thegreenwebfoundation.org"
+        "api.thegreenwebfoundation.org",
       ];
       expect(co2.perPage(pageXrayRun, green)).toBe(TGWF_MIXED_VALUE);
     });
   });
-  describe("perDomain", function() {
-    it("shows object listing Co2 for each domain", function() {
+  describe("perDomain", function () {
+    it("shows object listing Co2 for each domain", function () {
       const pages = pagexray.convert(har);
       const pageXrayRun = pages[0];
       const res = co2.perDomain(pageXrayRun);
@@ -95,7 +95,7 @@ describe("co2", function() {
         "graphite.thegreenwebfoundation.org",
         "analytics.thegreenwebfoundation.org",
         "fonts.gstatic.com",
-        "api.thegreenwebfoundation.org"
+        "api.thegreenwebfoundation.org",
       ];
 
       for (let obj of res) {
@@ -103,7 +103,7 @@ describe("co2", function() {
         expect(typeof obj.co2).toBe("number");
       }
     });
-    it("shows lower Co2 for green domains", function() {
+    it("shows lower Co2 for green domains", function () {
       const pages = pagexray.convert(har);
       const pageXrayRun = pages[0];
 
@@ -116,7 +116,7 @@ describe("co2", function() {
         "graphite.thegreenwebfoundation.org",
         "analytics.thegreenwebfoundation.org",
         "fonts.gstatic.com",
-        "api.thegreenwebfoundation.org"
+        "api.thegreenwebfoundation.org",
       ];
       const res = co2.perDomain(pageXrayRun);
       const resWithGreen = co2.perDomain(pageXrayRun, greenDomains);

package/src/green-byte.js

@@ -22,5 +22,5 @@ module.exports = {
   KWH_PER_BYTE_IN_DC,
   KWH_PER_BYTE_FOR_NETWORK,
   KWH_PER_BYTE_FOR_DEVICES,
-  CO2_PER_KWH_IN_DC_GREY
+  CO2_PER_KWH_IN_DC_GREY,
 };

package/src/hosting-api.js

@@ -28,7 +28,6 @@ async function checkDomainsAgainstAPI(domains) {
         )}`
       )
     );
-
     return greenDomainsFromResults(allGreenCheckResults);
   } catch (e) {
     return [];
@@ -37,20 +36,19 @@ async function checkDomainsAgainstAPI(domains) {
 
 function greenDomainsFromResults(greenResults) {
   const entries = Object.entries(greenResults);
-  let greenEntries = entries.filter(function([key, val]) {
+  let greenEntries = entries.filter(function ([key, val]) {
     return val.green;
   });
-
-  return greenEntries.map(function([key, val]) {
+  return greenEntries.map(function ([key, val]) {
     return val.url;
   });
 }
 
 async function getBody(url) {
   // Return new promise
-  return new Promise(function(resolve, reject) {
+  return new Promise(function (resolve, reject) {
     // Do async job
-    const req = https.get(url, function(res) {
+    const req = https.get(url, function (res) {
       if (res.statusCode < 200 || res.statusCode >= 300) {
         log(
           "Could not get info from the Green Web Foundation API, %s for %s",
@@ -61,7 +59,7 @@ async function getBody(url) {
       }
       const data = [];
 
-      res.on("data", chunk => {
+      res.on("data", (chunk) => {
         data.push(chunk);
       });
 
@@ -72,5 +70,5 @@ async function getBody(url) {
 }
 
 module.exports = {
-  check
+  check,
 };

package/src/hosting-api.test.js

@@ -1,16 +1,35 @@
 "use strict";
 
 const hosting = require("./hosting-api");
+const nock = require("nock");
 
-describe("hostingAPI", function() {
-  describe("checking a single domain with #check", function() {
-    it("using the API", async function() {
+describe("hostingAPI", function () {
+  describe("checking a single domain with #check", function () {
+    it("using the API", async function () {
+      const scope = nock("https://api.thegreenwebfoundation.org/")
+        .get("/greencheck/google.com")
+        .reply(200, {
+          url: "google.com",
+          green: true,
+        });
       const res = await hosting.check("google.com");
       expect(res).toEqual(true);
     });
   });
-  describe("implicitly checking multiple domains with #check", function() {
-    it("using the API", async function() {
+  describe("implicitly checking multiple domains with #check", function () {
+    it("using the API", async function () {
+      const scope = nock("https://api.thegreenwebfoundation.org/")
+        .get("/v2/greencheckmulti/[%22google.com%22,%22kochindustries.com%22]")
+        .reply(200, {
+          "google.com": {
+            url: "google.com",
+            green: true,
+          },
+          "kochindustries.com": {
+            url: "kochindustries.com",
+            green: null,
+          },
+        });
       const res = await hosting.check(["google.com", "kochindustries.com"]);
       expect(res).toContain("google.com");
     });

package/src/hosting-database.test.js

@@ -12,15 +12,15 @@ const dbPath = path.resolve(
   "url2green.test.db"
 );
 
-describe("hostingDatabase", function() {
-  describe("checking a single domain with #check", function() {
-    test("tries to use a local database if available ", async function() {
+describe("hostingDatabase", function () {
+  describe("checking a single domain with #check", function () {
+    test("tries to use a local database if available ", async function () {
       const res = await hosting.check("google.com", dbPath);
       expect(res).toEqual(true);
     });
   });
-  describe("implicitly checking multiple domains with #check", function() {
-    test("tries to use a local database if available", async function() {
+  describe("implicitly checking multiple domains with #check", function () {
+    test("tries to use a local database if available", async function () {
       const res = await hosting.check(
         ["google.com", "kochindustries.com"],
         dbPath

package/src/hosting-json.js

@@ -29,11 +29,11 @@ function checkInJSON(domain, db) {
 
 function greenDomainsFromResults(greenResults) {
   const entries = Object.entries(greenResults);
-  let greenEntries = entries.filter(function([key, val]) {
+  let greenEntries = entries.filter(function ([key, val]) {
     return val.green;
   });
 
-  return greenEntries.map(function([key, val]) {
+  return greenEntries.map(function ([key, val]) {
     return val.url;
   });
 }
@@ -51,5 +51,5 @@ function checkDomainsInJSON(domains, db) {
 
 module.exports = {
   check,
-  loadJSON
+  loadJSON,
 };

package/src/hosting-json.test.js

@@ -3,7 +3,7 @@
 const hosting = require("./hosting-json");
 const path = require("path");
 
-describe("hostingJSON", function() {
+describe("hostingJSON", function () {
   const jsonPath = path.resolve(
     __dirname,
     "..",
@@ -12,15 +12,15 @@ describe("hostingJSON", function() {
     "url2green.test.json"
   );
 
-  describe("checking a single domain with #check", function() {
-    test("against the list of domains as JSON", async function() {
+  describe("checking a single domain with #check", function () {
+    test("against the list of domains as JSON", async function () {
       const db = await hosting.loadJSON(jsonPath);
       const res = await hosting.check("google.com", db);
       expect(res).toEqual(true);
     });
   });
-  describe("implicitly checking multiple domains with #check", function() {
-    test("against the list of domains as JSON", async function() {
+  describe("implicitly checking multiple domains with #check", function () {
+    test("against the list of domains as JSON", async function () {
       const db = await hosting.loadJSON(jsonPath);
       const domains = ["google.com", "kochindustries.com"];
 

package/src/hosting.js

@@ -14,23 +14,23 @@ function check(domain, db) {
 
 function greenDomainsFromResults(greenResults) {
   const entries = Object.entries(greenResults);
-  let greenEntries = entries.filter(function([key, val]) {
+  let greenEntries = entries.filter(function ([key, val]) {
     return val.green;
   });
 
-  return greenEntries.map(function([key, val]) {
+  return greenEntries.map(function ([key, val]) {
     return val.url;
   });
 }
 
-async function checkPage(pageXray) {
+async function checkPage(pageXray, db) {
   const domains = Object.keys(pageXray.domains);
-  return check(domains);
+  return check(domains, db);
 }
 
 module.exports = {
   check,
   checkPage,
   greenDomains: greenDomainsFromResults,
-  loadJSON: hostingJSON.loadJSON
+  loadJSON: hostingJSON.loadJSON,
 };

package/src/hosting.test.js

@@ -6,9 +6,17 @@ const path = require("path");
 const hosting = require("./hosting");
 const pagexray = require("pagexray");
 
-describe("hosting", function() {
+const jsonPath = path.resolve(
+  __dirname,
+  "..",
+  "data",
+  "fixtures",
+  "url2green.test.json"
+);
+
+describe("hosting", function () {
   let har;
-  beforeEach(function() {
+  beforeEach(function () {
     har = JSON.parse(
       fs.readFileSync(
         path.resolve(__dirname, "../data/fixtures/tgwf.har"),
@@ -16,17 +24,16 @@ describe("hosting", function() {
       )
     );
   });
-  describe("checking all domains on a page object with #checkPage ", function() {
-    it("it returns a list of green domains, when passed a page object", async function() {
+  describe("checking all domains on a page object with #checkPage ", function () {
+    it("it returns a list of green domains, when passed a page object", async function () {
       const pages = pagexray.convert(har);
       const pageXrayRun = pages[0];
+      const db = await hosting.loadJSON(jsonPath);
+      const greenDomains = await hosting.checkPage(pageXrayRun, db);
 
-      // TODO find a way to not hit the API each time
-      const greenDomains = await hosting.checkPage(pageXrayRun);
-
-      expect(greenDomains).toHaveLength(10);
-
+      expect(greenDomains).toHaveLength(11);
       const expectedGreendomains = [
+        "maxcdn.bootstrapcdn.com",
         "thegreenwebfoundation.org",
         "www.thegreenwebfoundation.org",
         "fonts.googleapis.com",
@@ -36,9 +43,9 @@ describe("hosting", function() {
         "graphite.thegreenwebfoundation.org",
         "analytics.thegreenwebfoundation.org",
         "fonts.gstatic.com",
-        "api.thegreenwebfoundation.org"
+        "api.thegreenwebfoundation.org",
       ];
-      greenDomains.forEach(function(dom) {
+      greenDomains.forEach(function (dom) {
         expect(expectedGreendomains).toContain(dom);
       });
     });
@@ -46,21 +53,25 @@ describe("hosting", function() {
     //   'it returns an empty list, when passed a page object with no green domains'
     // );
   });
-  describe("checking a single domain with #check", function() {
-    it("use the API instead", async function() {
-      const res = await hosting.check("google.com");
+  describe("checking a single domain with #check", function () {
+    it("use the API instead", async function () {
+      const db = await hosting.loadJSON(jsonPath);
+      const res = await hosting.check("google.com", db);
       expect(res).toEqual(true);
     });
   });
-  describe("implicitly checking multiple domains with #check", function() {
-    it("Use the API", async function() {
-      const res = await hosting.check(["google.com", "kochindustries.com"]);
+  describe("implicitly checking multiple domains with #check", function () {
+    it("Use the API", async function () {
+      const db = await hosting.loadJSON(jsonPath);
+
+      const res = await hosting.check(["google.com", "kochindustries.com"], db);
       expect(res).toContain("google.com");
     });
   });
-  describe("explicitly checking multiple domains with #checkMulti", function() {
-    it("use the API", async function() {
-      const res = await hosting.check(["google.com", "kochindustries.com"]);
+  describe("explicitly checking multiple domains with #checkMulti", function () {
+    it("use the API", async function () {
+      const db = await hosting.loadJSON(jsonPath);
+      const res = await hosting.check(["google.com", "kochindustries.com"], db);
       expect(res).toContain("google.com");
     });
   });

package/src/index.js

@@ -3,5 +3,5 @@ const hosting = require("./hosting");
 
 module.exports = {
   co2,
-  hosting
+  hosting,
 };

package/.travis.yml

@@ -1,12 +0,0 @@
-language: node_js
-node_js: 10
-script: npm run travis 
-matrix:
-  include:
-    - name: "Test on Linux"
-      dist: bionic
-    - name: "Test on OS X"
-      os: osx
-      osx_image: xcode11.3  
-    - name: "Test on Windows"
-      os: windows