@tgwf/co2 0.7.0 → 0.8.0

package/CHANGELOG.md

@@ -9,6 +9,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## Unreleased
 
 - Include a new alternative, "Green Byte Model" with the figures after speaking to folks at the IEA and other places.
+
+# [0.8.0] - 2021-11-28
+
+### Fixed
+
+- Update further dependencies
+- Fix embarassing order of magnitude typo in 1byte model (thanks @mstaschik!)
+
+## Added
+
+- Read JSON blob also as gzipped #44 (thanks @soulgalore)
+
+### Changed
+
+- The 1bye model will give different numbers now. It's mentioned in `#fixed` but it's worth repeating.
+
 ## [0.7.0] - 2021-11-28
 
 ### Fixed

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tgwf/co2",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "description": "Work out the co2 of your digital services",
   "main": "src/index.js",
   "scripts": {

package/src/1byte.js

@@ -9,16 +9,25 @@ const CO2_PER_KWH_IN_DC_GREY = 519;
 
 // 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.
+//  2. the *making* the device, which is comparatively high.
 
-const KWH_PER_BYTE_IN_DC = 0.00000000072;
+const KWH_PER_BYTE_IN_DC = 7.2e-11;
 
 // this is probably best left as something users can define, or
 // a weighted average based on total usage.
+// Using a simple mean for now, as while web traffic to end users might trend
+// towards wifi and mobile,
+// Web traffic between servers is likely wired networks
+
+const FIXED_NETWORK_WIRED = 4.29e-10;
+const FIXED_NETWORK_WIFI = 1.52e-10;
+const FOUR_G_MOBILE = 8.84e-10;
+
 // Pull requests gratefully accepted
-const KWH_PER_BYTE_FOR_NETWORK = 0.00000000488;
+const KWH_PER_BYTE_FOR_NETWORK =
+  (FIXED_NETWORK_WIRED + FIXED_NETWORK_WIFI + FOUR_G_MOBILE) / 3;
 
-const KWH_PER_BYTE_FOR_DEVICES = 0.00000000013;
+const KWH_PER_BYTE_FOR_DEVICES = 1.3e-10;
 module.exports = {
   KWH_PER_BYTE_IN_DC,
   KWH_PER_BYTE_FOR_NETWORK,

package/src/1byte.test.js

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

@@ -8,13 +8,13 @@ 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 TGWF_GREY_VALUE = 0.20497;
+  const TGWF_GREEN_VALUE = 0.54704;
+  const TGWF_MIXED_VALUE = 0.16718;
 
   const MILLION = 1000000;
-  const MILLION_GREY = 2.9064;
-  const MILLION_GREEN = 2.318;
+  const MILLION_GREY = 0.29081;
+  const MILLION_GREEN = 0.23196;
 
   beforeEach(function () {
     co2 = new CO2();
@@ -28,12 +28,18 @@ describe("co2", function () {
 
   describe("perByte", function () {
     it("returns a CO2 number for data transfer using 'grey' power", function () {
-      expect(co2.perByte(MILLION)).toBe(MILLION_GREY);
+      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)).toBe(MILLION_GREY);
-      expect(co2.perByte(MILLION, true)).toBe(MILLION_GREEN);
+      expect(co2.perByte(MILLION, false).toPrecision(5)).toBe(
+        MILLION_GREY.toPrecision(5)
+      );
+      expect(co2.perByte(MILLION, true).toPrecision(5)).toBe(
+        MILLION_GREEN.toPrecision(5)
+      );
     });
   });
 
@@ -42,7 +48,9 @@ describe("co2", function () {
       const pages = pagexray.convert(har);
       const pageXrayRun = pages[0];
 
-      expect(co2.perPage(pageXrayRun)).toBe(TGWF_GREY_VALUE);
+      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);
@@ -75,7 +83,9 @@ describe("co2", function () {
         "fonts.gstatic.com",
         "api.thegreenwebfoundation.org",
       ];
-      expect(co2.perPage(pageXrayRun, green)).toBe(TGWF_MIXED_VALUE);
+      expect(co2.perPage(pageXrayRun, green).toPrecision(5)).toBe(
+        TGWF_MIXED_VALUE.toPrecision(5)
+      );
     });
   });
   describe("perDomain", function () {

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

@@ -11,7 +11,13 @@ describe("hostingJSON", function () {
     "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);
@@ -19,6 +25,13 @@ describe("hostingJSON", function () {
       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);