@tgwf/co2 0.8.0 → 0.10.0

package/data/fixtures/url2green.test.json

@@ -1 +0,0 @@
-["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/src/1byte.test.js

@@ -1,16 +0,0 @@
-"use strict";
-
-const oneByte = require("./1byte");
-
-describe("onebyte", function () {
-  describe("perByte", function () {
-    it.only("returns a simple average of the different networks", function () {
-      // we limit this to 12 figures with toFixed(12), because
-      // we have a recurring 333333 afterwards
-      // 4.88e-10 is the same as 0.000000000488
-      const expected_val = (0.000000000488).toFixed(12);
-
-      expect(oneByte.KWH_PER_BYTE_FOR_NETWORK.toFixed(12)).toBe(expected_val);
-    });
-  });
-});

package/src/co2.test.js

@@ -1,150 +0,0 @@
-"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 = 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;
-
-  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).toPrecision(5)).toBe(
-        MILLION_GREY.toPrecision(5)
-      );
-    });
-
-    it("returns a lower CO2 number for data transfer from domains using entirely 'green' power", function () {
-      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", function () {
-    it("returns CO2 for total transfer for page", function () {
-      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", 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).toPrecision(5)).toBe(
-        TGWF_MIXED_VALUE.toPrecision(5)
-      );
-    });
-  });
-  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,26 +0,0 @@
-// PLEASE DO NOT USE THIS MODEL YET FOR CALCS
-
-const CO2_PER_KWH_IN_DC_GREY = 519;
-
-// this subs in the IEA's recent figure in analyis from the carbon brief
-// https://www.carbonbrief.org/factcheck-what-is-the-carbon-footprint-of-streaming-video-on-netflix
-
-// datacentres
-const KWH_PER_BYTE_IN_DC = 0.00000000007;
-
-// networks
-const KWH_PER_BYTE_FOR_NETWORK = 0.00000000058;
-
-// the device used to access a site/app
-const KWH_PER_BYTE_FOR_DEVICES = 0.00000000055;
-
-// The device usage figure combines figures for:
-//  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,
-};

package/src/hosting-api.test.js

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

@@ -1,31 +0,0 @@
-"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.test.js

@@ -1,44 +0,0 @@
-"use strict";
-
-const hosting = require("./hosting-json");
-const path = require("path");
-
-describe("hostingJSON", function () {
-  const jsonPath = path.resolve(
-    __dirname,
-    "..",
-    "data",
-    "fixtures",
-    "url2green.test.json"
-  );
-  const jsonPathGz = path.resolve(
-    __dirname,
-    "..",
-    "data",
-    "fixtures",
-    "url2green.test.json.gz"
-  );
-  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("checking a single domain with #check", function () {
-    test("against the list of domains as JSON loaded from a gzipped JSON", async function () {
-      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", 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");
-    });
-  });
-});