@tgwf/co2 0.4.7 → 0.7.0

package/src/co2.test.js

@@ -1,141 +1,140 @@
-'use strict';
-
-const fs = require('fs');
-const path = require('path');
-
-const co2 = require('./co2');
-const pagexray = require('pagexray');
-
-
-describe('sustainableWeb', function () {
-  describe('co2', function () {
-    let har;
-    const TGWF_GREY_VALUE = 2.0484539712;
-    const TGWF_GREEN_VALUE = 0.54704300112;
-    const TGWF_MIXED_VALUE = 1.7485750598399998;
-
-    const MILLION = 1000000;
-    const MILLION_GREY = 2.9064;
-    const MILLION_GREEN = 2.4393599999999998;
+"use strict";
+
+const fs = require("fs");
+const path = require("path");
+
+const CO2 = require("./co2");
+const pagexray = require("pagexray");
+
+describe("co2", function () {
+  let har, co2;
+  const TGWF_GREY_VALUE = 2.0484539712;
+  const TGWF_GREEN_VALUE = 0.54704300112;
+  const TGWF_MIXED_VALUE = 1.6706517455999996;
+
+  const MILLION = 1000000;
+  const MILLION_GREY = 2.9064;
+  const MILLION_GREEN = 2.318;
+
+  beforeEach(function () {
+    co2 = new CO2();
+    har = JSON.parse(
+      fs.readFileSync(
+        path.resolve(__dirname, "../data/fixtures/tgwf.har"),
+        "utf8"
+      )
+    );
+  });
 
-    beforeEach(function () {
-      har = JSON.parse(fs
-        .readFileSync(path.resolve(__dirname, '../data/fixtures/tgwf.har'), 'utf8'))
+  describe("perByte", function () {
+    it("returns a CO2 number for data transfer using 'grey' power", function () {
+      expect(co2.perByte(MILLION)).toBe(MILLION_GREY);
     });
 
-    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 () {
-        expect(co2.perByte(MILLION, false)).toBe(MILLION_GREY);
-        expect(co2.perByte(MILLION, true)).toBe(MILLION_GREEN);
-      });
+    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 () {
-        const pages = pagexray.convert(har);
-        const pageXrayRun = pages[0];
+  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 () {
-        const pages = pagexray.convert(har);
-        const pageXrayRun = pages[0];
-        let green = [
-          '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'
-        ];
-        expect(co2.perPage(pageXrayRun, green)).toBeLessThan(TGWF_GREY_VALUE);
-      });
-      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
-        let green = [
-          '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'
-        ];
-        expect(co2.perPage(pageXrayRun, green)).toBe(TGWF_MIXED_VALUE);
-      });
+      expect(co2.perPage(pageXrayRun)).toBe(TGWF_GREY_VALUE);
     });
-    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);
-
-        const domains = [
-          'thegreenwebfoundation.org',
-          'www.thegreenwebfoundation.org',
-          'maxcdn.bootstrapcdn.com',
-          'fonts.googleapis.com',
-          'ajax.googleapis.com',
-          'assets.digitalclimatestrike.net',
-          'cdnjs.cloudflare.com',
-          'graphite.thegreenwebfoundation.org',
-          'analytics.thegreenwebfoundation.org',
-          'fonts.gstatic.com',
-          'api.thegreenwebfoundation.org'
-        ];
-
-        for (let obj of res) {
-          expect(domains.indexOf(obj.domain)).toBeGreaterThan(-1);
-          expect(typeof obj.co2).toBe('number');
-        };
-      });
-      it('shows lower Co2 for green domains', function () {
-        const pages = pagexray.convert(har);
-        const pageXrayRun = pages[0];
-
-        const greenDomains = [
-          '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'
-        ];
-        const res = co2.perDomain(pageXrayRun);
-        const resWithGreen = co2.perDomain(pageXrayRun, greenDomains);
-
-        for (let obj of res) {
-          expect(typeof obj.co2).toBe('number');
-        };
-        for (let obj of greenDomains) {
-          let index = 0
-          expect(resWithGreen[index].co2).toBeLessThan(res[index].co2);
-          index++
-        }
-      });
+    it("returns lower CO2 for page served from green site", function () {
+      const pages = pagexray.convert(har);
+      const pageXrayRun = pages[0];
+      let green = [
+        "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",
+      ];
+      expect(co2.perPage(pageXrayRun, green)).toBeLessThan(TGWF_GREY_VALUE);
+    });
+    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
+      let green = [
+        "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",
+      ];
+      expect(co2.perPage(pageXrayRun, green)).toBe(TGWF_MIXED_VALUE);
     });
-    // describe('perContentType', function () {
-    //   test.skip('shows a breakdown of emissions by content type');
-    // });
-    // describe('dirtiestResources', function () {
-    //   it.skip('shows the top 10 resources by CO2 emissions');
-    // });
   });
+  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);
+
+      const domains = [
+        "thegreenwebfoundation.org",
+        "www.thegreenwebfoundation.org",
+        "maxcdn.bootstrapcdn.com",
+        "fonts.googleapis.com",
+        "ajax.googleapis.com",
+        "assets.digitalclimatestrike.net",
+        "cdnjs.cloudflare.com",
+        "graphite.thegreenwebfoundation.org",
+        "analytics.thegreenwebfoundation.org",
+        "fonts.gstatic.com",
+        "api.thegreenwebfoundation.org",
+      ];
+
+      for (let obj of res) {
+        expect(domains.indexOf(obj.domain)).toBeGreaterThan(-1);
+        expect(typeof obj.co2).toBe("number");
+      }
+    });
+    it("shows lower Co2 for green domains", function () {
+      const pages = pagexray.convert(har);
+      const pageXrayRun = pages[0];
+
+      const greenDomains = [
+        "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",
+      ];
+      const res = co2.perDomain(pageXrayRun);
+      const resWithGreen = co2.perDomain(pageXrayRun, greenDomains);
+
+      for (let obj of res) {
+        expect(typeof obj.co2).toBe("number");
+      }
+      for (let obj of greenDomains) {
+        let index = 0;
+        expect(resWithGreen[index].co2).toBeLessThan(res[index].co2);
+        index++;
+      }
+    });
+  });
+  // describe('perContentType', function () {
+  //   test.skip('shows a breakdown of emissions by content type');
+  // });
+  // describe('dirtiestResources', function () {
+  //   it.skip('shows the top 10 resources by CO2 emissions');
+  // });
 });
-

package/src/green-byte.js

@@ -1,4 +1,3 @@
-
 // PLEASE DO NOT USE THIS MODEL YET FOR CALCS
 
 const CO2_PER_KWH_IN_DC_GREY = 519;
@@ -19,10 +18,9 @@ const KWH_PER_BYTE_FOR_DEVICES = 0.00000000055;
 //  1. the usage for devices (which is small proportion of the energy use)
 //  2. the *making* the device, which is comparitively high.
 
-
 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/{hostingAPI.js → hosting-api.js}

@@ -1,25 +1,22 @@
-'use strict';
+"use strict";
 
-const log = require('debug')('tgwf:hostingAPI');
-const https = require('https');
+const log = require("debug")("tgwf:hostingAPI");
+const https = require("https");
 
 function check(domain) {
   // is it a single domain or an array of them?
-  if (typeof domain === 'string') {
-    return checkAgainstAPI(domain)
-  }
-  else {
-    return checkDomainsAgainstAPI(domain)
+  if (typeof domain === "string") {
+    return checkAgainstAPI(domain);
+  } else {
+    return checkDomainsAgainstAPI(domain);
   }
 }
 
 async function checkAgainstAPI(domain) {
   const res = JSON.parse(
-    await getBody(
-      `https://api.thegreenwebfoundation.org/greencheck/${domain}`
-    )
+    await getBody(`https://api.thegreenwebfoundation.org/greencheck/${domain}`)
   );
-  return res.green
+  return res.green;
 }
 
 async function checkDomainsAgainstAPI(domains) {
@@ -31,9 +28,7 @@ async function checkDomainsAgainstAPI(domains) {
         )}`
       )
     );
-
-    return greenDomainsFromResults(allGreenCheckResults)
-
+    return greenDomainsFromResults(allGreenCheckResults);
   } catch (e) {
     return [];
   }
@@ -44,13 +39,11 @@ function greenDomainsFromResults(greenResults) {
   let greenEntries = entries.filter(function ([key, val]) {
     return val.green;
   });
-
   return greenEntries.map(function ([key, val]) {
     return val.url;
   });
 }
 
-
 async function getBody(url) {
   // Return new promise
   return new Promise(function (resolve, reject) {
@@ -58,7 +51,7 @@ async function getBody(url) {
     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',
+          "Could not get info from the Green Web Foundation API, %s for %s",
           res.statusCode,
           url
         );
@@ -66,16 +59,16 @@ async function getBody(url) {
       }
       const data = [];
 
-      res.on('data', chunk => {
+      res.on("data", (chunk) => {
         data.push(chunk);
       });
 
-      res.on('end', () => resolve(Buffer.concat(data).toString()));
+      res.on("end", () => resolve(Buffer.concat(data).toString()));
     });
     req.end();
   });
 }
 
 module.exports = {
-  check
+  check,
 };

package/src/hosting-api.test.js

@@ -0,0 +1,37 @@
+"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 () {
+      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 () {
+      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

@@ -0,0 +1,31 @@
+"use strict";
+
+const log = require("debug")("tgwf:url2green:test");
+const { hosting } = require("@tgwf/url2green");
+const path = require("path");
+
+const dbPath = path.resolve(
+  __dirname,
+  "..",
+  "data",
+  "fixtures",
+  "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 () {
+      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 () {
+      const res = await hosting.check(
+        ["google.com", "kochindustries.com"],
+        dbPath
+      );
+      expect(res).toContain("google.com");
+    });
+  });
+});

package/src/hosting-json.js

@@ -0,0 +1,55 @@
+"use strict";
+
+const log = require("debug")("tgwf:hostingCache");
+const path = require("path");
+const fs = require("fs");
+const { promisify } = require("util");
+const readFile = promisify(fs.readFile);
+
+async function loadJSON(jsonPath) {
+  const jsonBuffer = await readFile(jsonPath);
+  return JSON.parse(jsonBuffer);
+}
+
+async function check(domain, db) {
+  // is it a single domain or an array of them?
+  if (typeof domain === "string") {
+    return checkInJSON(domain, db);
+  } else {
+    return checkDomainsInJSON(domain, db);
+  }
+}
+
+function checkInJSON(domain, db) {
+  if (db.indexOf(domain) > -1) {
+    return true;
+  }
+  return false;
+}
+
+function greenDomainsFromResults(greenResults) {
+  const entries = Object.entries(greenResults);
+  let greenEntries = entries.filter(function ([key, val]) {
+    return val.green;
+  });
+
+  return greenEntries.map(function ([key, val]) {
+    return val.url;
+  });
+}
+
+function checkDomainsInJSON(domains, db) {
+  let greenDomains = [];
+
+  for (let domain of domains) {
+    if (db.indexOf(domain) > -1) {
+      greenDomains.push(domain);
+    }
+  }
+  return greenDomains;
+}
+
+module.exports = {
+  check,
+  loadJSON,
+};

package/src/hosting-json.test.js

@@ -0,0 +1,31 @@
+"use strict";
+
+const hosting = require("./hosting-json");
+const path = require("path");
+
+describe("hostingJSON", function () {
+  const jsonPath = path.resolve(
+    __dirname,
+    "..",
+    "data",
+    "fixtures",
+    "url2green.test.json"
+  );
+
+  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 () {
+      const db = await hosting.loadJSON(jsonPath);
+      const domains = ["google.com", "kochindustries.com"];
+
+      const res = await hosting.check(domains, db);
+      expect(res).toContain("google.com");
+    });
+  });
+});

package/src/hosting.js

@@ -1,21 +1,21 @@
-'use strict';
+"use strict";
 
-const log = require('debug')('tgwf:hosting');
-const hostingAPI = require('./hostingAPI');
-const hostingDatabase = require('./hostingDatabase');
+const log = require("debug")("tgwf:hosting");
+const hostingAPI = require("./hosting-api");
+const hostingJSON = require("./hosting-json");
 
-function check(domain, dbName) {
-  if (dbName) {
-    return hostingDatabase.check(domain, dbName)
+function check(domain, db) {
+  if (db) {
+    return hostingJSON.check(domain, db);
   } else {
     return hostingAPI.check(domain);
   }
 }
 
 function greenDomainsFromResults(greenResults) {
-  const entries = Object.entries(greenResults)
+  const entries = Object.entries(greenResults);
   let greenEntries = entries.filter(function ([key, val]) {
-    return val.green
+    return val.green;
   });
 
   return greenEntries.map(function ([key, val]) {
@@ -23,13 +23,14 @@ function greenDomainsFromResults(greenResults) {
   });
 }
 
-async function checkPage(pageXray) {
-  const domains = Object.keys(pageXray.domains)
-  return check(domains)
+async function checkPage(pageXray, db) {
+  const domains = Object.keys(pageXray.domains);
+  return check(domains, db);
 }
 
 module.exports = {
   check,
   checkPage,
   greenDomains: greenDomainsFromResults,
+  loadJSON: hostingJSON.loadJSON,
 };