@tgwf/co2 0.7.0 → 0.9.0

package/src/co2.test.js

@@ -4,137 +4,286 @@ const fs = require("fs");
 const path = require("path");
 
 const CO2 = require("./co2");
+const swd = require("./sustainable-web-design");
 const pagexray = require("pagexray");
 
-describe("co2", function () {
+describe("co2", () => {
   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"
-      )
-    );
-  });
 
-  describe("perByte", function () {
-    it("returns a CO2 number for data transfer using 'grey' power", function () {
-      expect(co2.perByte(MILLION)).toBe(MILLION_GREY);
-    });
+  describe("1 byte model", () => {
+    const TGWF_GREY_VALUE = 0.20497;
+    const TGWF_GREEN_VALUE = 0.54704;
+    const TGWF_MIXED_VALUE = 0.16718;
+
+    const MILLION = 1000000;
+    const MILLION_GREY = 0.29081;
+    const MILLION_GREEN = 0.23196;
 
-    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);
+    beforeEach(() => {
+      co2 = new CO2();
+      har = JSON.parse(
+        fs.readFileSync(
+          path.resolve(__dirname, "../data/fixtures/tgwf.har"),
+          "utf8"
+        )
+      );
     });
-  });
 
-  describe("perPage", function () {
-    it("returns CO2 for total transfer for page", function () {
-      const pages = pagexray.convert(har);
-      const pageXrayRun = pages[0];
+    describe("perByte", () => {
+      it("returns a CO2 number for data transfer using 'grey' power", () => {
+        expect(co2.perByte(MILLION).toPrecision(5)).toBe(
+          MILLION_GREY.toPrecision(5)
+        );
+      });
 
-      expect(co2.perPage(pageXrayRun)).toBe(TGWF_GREY_VALUE);
+      it("returns a lower CO2 number for data transfer from domains using entirely 'green' power", () => {
+        expect(co2.perByte(MILLION).toPrecision(5)).toBe(
+          MILLION_GREY.toPrecision(5)
+        );
+        expect(co2.perByte(MILLION, true).toPrecision(5)).toBe(
+          MILLION_GREEN.toPrecision(5)
+        );
+      });
     });
-    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);
+
+    describe("perPage", () => {
+      it("returns CO2 for total transfer for page", () => {
+        const pages = pagexray.convert(har);
+        const pageXrayRun = pages[0];
+
+        expect(co2.perPage(pageXrayRun).toPrecision(5)).toBe(
+          TGWF_GREY_VALUE.toPrecision(5)
+        );
+      });
+      it("returns lower CO2 for page served from green site", () => {
+        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", () => {
+        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).toPrecision(5)).toBe(
+          TGWF_MIXED_VALUE.toPrecision(5)
+        );
+      });
     });
-    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("perDomain", () => {
+      it("shows object listing Co2 for each domain", () => {
+        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", () => {
+        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("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");
-      }
+
+  describe("Sustainable Web Design model", () => {
+    // the SWD model should have slightly higher values as
+    // we include more of the system in calculations for the
+    // same levels of data transfer
+    const MILLION = 1000000;
+    const MILLION_GREY = 0.33343;
+    const MILLION_GREEN = 0.28908;
+
+    const TGWF_GREY_VALUE = 0.23501;
+    const TGWF_GREEN_VALUE = 0.54704;
+    const TGWF_MIXED_VALUE = 0.20652;
+
+    beforeEach(() => {
+      co2 = new CO2({ model: swd });
+      har = JSON.parse(
+        fs.readFileSync(
+          path.resolve(__dirname, "../data/fixtures/tgwf.har"),
+          "utf8"
+        )
+      );
+    });
+
+    describe("perByte", () => {
+      it("returns a CO2 number for data transfer", () => {
+        co2.perByte(MILLION);
+        expect(co2.perByte(MILLION).toPrecision(5)).toBe(
+          MILLION_GREY.toPrecision(5)
+        );
+      });
+
+      it("returns a lower CO2 number for data transfer from domains using entirely 'green' power", () => {
+        expect(co2.perByte(MILLION, false).toPrecision(5)).toBe(
+          MILLION_GREY.toPrecision(5)
+        );
+
+        expect(co2.perByte(MILLION, true).toPrecision(5)).toBe(
+          MILLION_GREEN.toPrecision(5)
+        );
+      });
+    });
+
+    describe("perPage", () => {
+      it("returns CO2 for total transfer for page", () => {
+        const pages = pagexray.convert(har);
+        const pageXrayRun = pages[0];
+
+        expect(co2.perPage(pageXrayRun).toPrecision(5)).toBe(
+          TGWF_GREY_VALUE.toPrecision(5)
+        );
+      });
+      it("returns lower CO2 for page served from green site", () => {
+        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", () => {
+        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).toPrecision(5)).toBe(
+          TGWF_MIXED_VALUE.toPrecision(5)
+        );
+      });
     });
-    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("perDomain", () => {
+      it("shows object listing Co2 for each domain", () => {
+        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", () => {
+        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/constants/file-size.js

@@ -0,0 +1,5 @@
+const GIGABYTE = 1024 * 1024 * 1024;
+
+module.exports = {
+  GIGABYTE,
+};

package/src/constants/index.js

@@ -0,0 +1,3 @@
+const fileSize = require("./file-size");
+
+module.exports = { fileSize };

package/src/helpers/index.js

@@ -0,0 +1,5 @@
+const formatNumber = (num) => parseFloat(num.toFixed(2));
+
+module.exports = {
+  formatNumber,
+};

package/src/hosting-api.test.js

@@ -3,9 +3,9 @@
 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", () => {
+  describe("checking a single domain with #check", () => {
+    it("using the API", async () => {
       const scope = nock("https://api.thegreenwebfoundation.org/")
         .get("/greencheck/google.com")
         .reply(200, {
@@ -16,8 +16,8 @@ describe("hostingAPI", function () {
       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", () => {
+    it("using the API", async () => {
       const scope = nock("https://api.thegreenwebfoundation.org/")
         .get("/v2/greencheckmulti/[%22google.com%22,%22kochindustries.com%22]")
         .reply(200, {

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", () => {
+  describe("checking a single domain with #check", () => {
+    test("tries to use a local database if available ", async () => {
       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", () => {
+    test("tries to use a local database if available", async () => {
       const res = await hosting.check(
         ["google.com", "kochindustries.com"],
         dbPath

package/src/hosting-json.js

@@ -3,11 +3,31 @@
 const log = require("debug")("tgwf:hostingCache");
 const path = require("path");
 const fs = require("fs");
+const zlib = require("zlib");
 const { promisify } = require("util");
 const readFile = promisify(fs.readFile);
+const gunzip = promisify(zlib.gunzip);
+
+async function streamToString(stream) {
+  return new Promise((resolve, reject) => {
+    const chunks = [];
+    stream.on("error", reject);
+    stream.on("data", (chunk) => chunks.push(chunk));
+    stream.on("end", () => resolve(Buffer.concat(chunks)));
+  });
+}
+
+async function getGzippedFileAsJson(jsonPath) {
+  const readStream = fs.createReadStream(jsonPath);
+  const text = await streamToString(readStream);
+  const unzipped = await gunzip(text);
+  return unzipped.toString();
+}
 
 async function loadJSON(jsonPath) {
-  const jsonBuffer = await readFile(jsonPath);
+  const jsonBuffer = jsonPath.endsWith(".gz")
+    ? await getGzippedFileAsJson(jsonPath)
+    : await readFile(jsonPath);
   return JSON.parse(jsonBuffer);
 }
 

package/src/hosting-json.test.js

@@ -3,7 +3,7 @@
 const hosting = require("./hosting-json");
 const path = require("path");
 
-describe("hostingJSON", function () {
+describe("hostingJSON", () => {
   const jsonPath = path.resolve(
     __dirname,
     "..",
@@ -11,16 +11,29 @@ describe("hostingJSON", function () {
     "fixtures",
     "url2green.test.json"
   );
-
-  describe("checking a single domain with #check", function () {
-    test("against the list of domains as JSON", async function () {
+  const jsonPathGz = path.resolve(
+    __dirname,
+    "..",
+    "data",
+    "fixtures",
+    "url2green.test.json.gz"
+  );
+  describe("checking a single domain with #check", () => {
+    test("against the list of domains as JSON", async () => {
       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("checking a single domain with #check", () => {
+    test("against the list of domains as JSON loaded from a gzipped JSON", async () => {
+      const db = await hosting.loadJSON(jsonPathGz);
+      const res = await hosting.check("google.com", db);
+      expect(res).toEqual(true);
+    });
+  });
+  describe("implicitly checking multiple domains with #check", () => {
+    test("against the list of domains as JSON", async () => {
       const db = await hosting.loadJSON(jsonPath);
       const domains = ["google.com", "kochindustries.com"];
 

package/src/hosting.test.js

@@ -14,9 +14,9 @@ const jsonPath = path.resolve(
   "url2green.test.json"
 );
 
-describe("hosting", function () {
+describe("hosting", () => {
   let har;
-  beforeEach(function () {
+  beforeEach(() => {
     har = JSON.parse(
       fs.readFileSync(
         path.resolve(__dirname, "../data/fixtures/tgwf.har"),
@@ -24,8 +24,8 @@ 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 ", () => {
+    it("it returns a list of green domains, when passed a page object", async () => {
       const pages = pagexray.convert(har);
       const pageXrayRun = pages[0];
       const db = await hosting.loadJSON(jsonPath);
@@ -53,23 +53,23 @@ 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 () {
+  describe("checking a single domain with #check", () => {
+    it("use the API instead", async () => {
       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 () {
+  describe("implicitly checking multiple domains with #check", () => {
+    it("Use the API", async () => {
       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 () {
+  describe("explicitly checking multiple domains with #checkMulti", () => {
+    it("use the API", async () => {
       const db = await hosting.loadJSON(jsonPath);
       const res = await hosting.check(["google.com", "kochindustries.com"], db);
       expect(res).toContain("google.com");