feat(lib): allow config and globalConfig parameters as input

Signed-off-by: alexzurbonsen <alexander.zur.bonsen@tngtech.com>

Author: alexzurbonsen

src/__tests__/unit/lib/co2js/index.test.ts

@@ -86,29 +86,21 @@ describe('lib/co2js: ', () => {
         ]);
       });
 
-      it('returns a result when provided `options` in the global config.', async () => {
-        const config = {type: 'swd', 'green-web-host': false};
-        const output = Co2js({
-          options: {
-            dataReloadRatio: 0.6,
-            firstVisitPercentage: 0.9,
-            returnVisitPercentage: 0.1,
-            gridIntensity: {
-              device: 560.98,
-              dataCenter: 50,
-              networks: 437.66,
-            },
-          },
-        });
-
+      it('returns a result when `green-web-host` and `options` are provided in input.', async () => {
+        const config = {type: 'swd'};
         const inputs = [
           {
             timestamp: '2021-01-01T00:00:00Z',
             duration: 3600,
             'network/data/bytes': 100000,
+            'green-web-host': false,
+            options: {
+              dataReloadRatio: 0.6,
+              firstVisitPercentage: 0.9,
+              returnVisitPercentage: 0.1,
+            },
           },
         ];
-
         const result = await output.execute(inputs, config);
 
         expect.assertions(1);
@@ -118,7 +110,13 @@ describe('lib/co2js: ', () => {
             timestamp: '2021-01-01T00:00:00Z',
             duration: 3600,
             'network/data/bytes': 100000,
-            'carbon-operational': 0.034497244224,
+            'carbon-operational': 0.034032441600000005,
+            'green-web-host': false,
+            options: {
+              dataReloadRatio: 0.6,
+              firstVisitPercentage: 0.9,
+              returnVisitPercentage: 0.1,
+            },
           },
         ]);
       });
@@ -169,5 +167,54 @@ describe('lib/co2js: ', () => {
         }
       });
     });
+
+    it('throws an error if `green-web-host` is neither provided in config nor in input.', async () => {
+      const config = {type: '1byte'};
+      const inputs = [
+        {
+          timestamp: '2021-01-01T00:00:00Z',
+          duration: 3600,
+          'network/data/bytes': 100000,
+        },
+      ];
+
+      expect.assertions(2);
+
+      try {
+        await output.execute(inputs, config);
+      } catch (error) {
+        expect(error).toEqual(
+          new InputValidationError(
+            `\`green-web-host\` is provided neither in config nor in input.\nConfig: ${config}\nInput: ${inputs[0]}`
+          )
+        );
+        expect(error).toBeInstanceOf(InputValidationError);
+      }
+    });
+
+    it('throws an error if `green-web-host` is provided in config and input.', async () => {
+      const config = {type: '1byte', 'green-web-host': true};
+      const inputs = [
+        {
+          timestamp: '2021-01-01T00:00:00Z',
+          duration: 3600,
+          'network/data/bytes': 100000,
+          'green-web-host': true,
+        },
+      ];
+
+      expect.assertions(2);
+
+      try {
+        await output.execute(inputs, config);
+      } catch (error) {
+        expect(error).toEqual(
+          new InputValidationError(
+            `\`green-web-host\` is provided in config and in input. Please only provide once.\nConfig: ${config}\nInput: ${inputs[0]}`
+          )
+        );
+        expect(error).toBeInstanceOf(InputValidationError);
+      }
+    });
   });
 });

src/lib/co2js/README.md

@@ -4,28 +4,27 @@
 
 # Parameters
 
-## Plugin global config
-
-- `options`: **SWD Plugin Only** an object containing any Sustainable Web Design specific variables to the changed. All keys are optional.
-  - `dataReloadRatio` - a value between 0 and 1 representing the percentage of data that is downloaded by return visitors. -`firstVisitPercentage` - a value between 0 and 1 representing the percentage of new visitors.
-  - `returnVisitPercentage` - a value between 0 and 1 representing the percentage of returning visitors.
-  - `gridIntensity` - an object that can contain the following optional keys:
-    - `device` - a number representing the carbon intensity for the given segment (in grams per kilowatt-hour). Or, an object, which contains a key of country and a value that is an Alpha-3 ISO country code.
-    - `dataCenter` - a number representing the carbon intensity for the given segment (in grams per kilowatt-hour). Or, an object, which contains a key of country and a value that is an Alpha-3 ISO country code.
-    - `networks` - A number representing the carbon intensity for the given segment (in grams per kilowatt-hour). Or, an object, which contains a key of country and a value that is an Alpha-3 ISO country code.
-
-The value for `device`, `dataCenter`, or `networks` can be a number representing the carbon intensity for the given segment (in grams per kilowatt-hour). Or, an object, which contains a key of country and a value that is an Alpha-3 ISO country code.
-
 ## Plugin node config
 
 - `type`: supported plugins by the library, `swd` or `1byte`
-- `green-web-host`: true if the website is hosted on a green web host, false otherwise
+- `green-web-host`: true if the website is hosted on a green web host, false otherwise (has to be provided either as config or input)
 
 ## Inputs
 
 - `network/data/bytes`: the number of bytes transferred or `network/data` if the number is in GB
+- `green-web-host`: true if the website is hosted on a green web host, false otherwise (has to be provided either as config or input)
 - `duration`: the amount of time the observation covers, in seconds
 - `timestamp`: a timestamp for the observation
+- `options`: **SWD Plugin Only** an object containing any Sustainable Web Design specific variables to the changed. All keys are optional.
+- `dataReloadRatio` - a value between 0 and 1 representing the percentage of data that is downloaded by return visitors. -`firstVisitPercentage` - a value between 0 and 1 representing the percentage of new visitors.
+- `returnVisitPercentage` - a value between 0 and 1 representing the percentage of returning visitors.
+- `gridIntensity` - an object that can contain the following optional keys:
+  - `device` - a number representing the carbon intensity for the given segment (in grams per kilowatt-hour). Or, an object, which contains a key of country and a value that is an Alpha-3 ISO country code.
+  - `dataCenter` - a number representing the carbon intensity for the given segment (in grams per kilowatt-hour). Or, an object, which contains a key of country and a value that is an Alpha-3 ISO country code.
+  - `networks` - A number representing the carbon intensity for the given segment (in grams per kilowatt-hour). Or, an object, which contains a key of country and a value that is an Alpha-3 ISO country code.
+
+The value for `device`, `dataCenter`, or `networks` can be a number representing the carbon intensity for the given segment (in grams per kilowatt-hour). Or, an object, which contains a key of country and a value that is an Alpha-3 ISO country code.
+
 
 ## Returns
 
@@ -58,15 +57,6 @@ initialize:
     co2js:
       method: Co2js
       path: '@grnsft/if-unofficial-plugins'
-      global-config:
-        options:
-          dataReloadRatio: 0.6
-          firstVisitPercentage: 0.9
-          returnVisitPercentage: 0.1
-          gridIntensity:
-            device: 560.98
-            dataCenter:
-              country: 'TWN'
 tree:
   children:
     child:
@@ -80,6 +70,14 @@ tree:
         - timestamp: 2023-07-06T00:00
           duration: 1
           network/data/bytes: 1000000
+          options:
+            dataReloadRatio: 0.6
+            firstVisitPercentage: 0.9
+            returnVisitPercentage: 0.1
+            gridIntensity:
+              device: 560.98
+              dataCenter:
+                country: 'TWN'
 ```
 
 You can run this by passing it to `ie`. Run impact using the following command run from the project root:
@@ -101,15 +99,6 @@ initialize:
     co2js:
       path: '@grnsft/if-unofficial-plugins'
       method: Co2js
-      global-config:
-        options:
-          dataReloadRatio: 0.6
-          firstVisitPercentage: 0.9
-          returnVisitPercentage: 0.1
-          gridIntensity:
-            device: 560.98
-            dataCenter:
-              country: TWN
 tree:
   children:
     child:
@@ -123,11 +112,28 @@ tree:
         - timestamp: 2023-07-06T00:00
           duration: 1
           network/data/bytes: 1000000
+          options:
+          dataReloadRatio: 0.6
+          firstVisitPercentage: 0.9
+          returnVisitPercentage: 0.1
+          gridIntensity:
+            device: 560.98
+            dataCenter:
+              country: TWN
       outputs:
         - timestamp: 2023-07-06T00:00
           duration: 1
           network/data/bytes: 1000000
           carbon-operational: 0.34497244224000007
+          green-web-host: true
+          options:
+          dataReloadRatio: 0.6
+          firstVisitPercentage: 0.9
+          returnVisitPercentage: 0.1
+          gridIntensity:
+            device: 560.98
+            dataCenter:
+              country: TWN
 ```
 
 ## TypeScript
@@ -139,26 +145,24 @@ You can see example Typescript invocations for each plugin below.
 ```typescript
 import {Co2js} from '@grnsft/if-unofficial-plugins';
 
-const globalConfig = {
-  options: {
-    // Optional
-    dataReloadRatio: 0.6,
-    firstVisitPercentage: 0.9,
-    returnVisitPercentage: 0.1,
-    gridIntensity: {
-      device: 560.98,
-      dataCenter: 50,
-      networks: 437.66,
-    },
-  },
-};
-const co2js = Co2js(globalConfig);
+const co2js = Co2js();
 const results = await co2js.execute(
   [
     {
       duration: 3600, // duration institute
       timestamp: '2021-01-01T00:00:00Z', // ISO8601 / RFC3339 timestamp
       'network/data/bytes': 1000000, // bytes transferred
+      options: {
+        // Optional
+        dataReloadRatio: 0.6,
+        firstVisitPercentage: 0.9,
+        returnVisitPercentage: 0.1,
+        gridIntensity: {
+          device: 560.98,
+          dataCenter: 50,
+          networks: 437.66,
+        },
+      },
     },
   ],
   {