Merge pull request #944 from Green-Software-Foundation/fix-parameter-…

…metadata Merge `parameter-metadata` with plugin's hardcoded data
Green-Software-Foundation · Aug 8, 2024 · 2e6981a · 2e6981a
2 parents ce87cca + bb83d4d
commit 2e6981a
Show file tree

Hide file tree

Showing 5 changed files with 72 additions and 68 deletions.
diff --git a/src/if-run/builtins/coefficient/index.ts b/src/if-run/builtins/coefficient/index.ts
@@ -20,20 +20,8 @@ export const Coefficient = (
 ): ExecutePlugin => {
   const metadata = {
     kind: 'execute',
-    inputs: parametersMetadata?.inputs || {
-      carbon: {
-        description: 'an amount of carbon emitted into the atmosphere',
-        unit: 'gCO2e',
-        'aggregation-method': 'sum',
-      },
-    },
-    outputs: parametersMetadata?.outputs || {
-      'carbon-product': {
-        description: 'a product of cabon property and the coefficient',
-        unit: 'gCO2e',
-        'aggregation-method': 'sum',
-      },
-    },
+    inputs: parametersMetadata?.inputs,
+    outputs: parametersMetadata?.outputs,
   };
 
   /**

diff --git a/src/if-run/builtins/sci-embodied/index.ts b/src/if-run/builtins/sci-embodied/index.ts
@@ -1,6 +1,7 @@
 import {z} from 'zod';
 import {
   ExecutePlugin,
+  ParameterMetadata,
   PluginParametersMetadata,
   PluginParams,
 } from '@grnsft/if-core/types';
@@ -16,37 +17,41 @@ export const SciEmbodied = (
 ): ExecutePlugin => {
   const metadata = {
     kind: 'execute',
-    inputs: parametersMetadata?.inputs || {
-      'device/emissions-embodied': {
-        description: 'total embodied emissions of some component',
-        unit: 'gCO2e',
-        'aggregation-method': 'sum',
-      },
-      'device/expected-lifespan': {
-        description: 'Total Expected Lifespan of the Component in Seconds',
-        unit: 'seconds',
-        'aggregation-method': 'sum',
-      },
-      'resources-reserved': {
-        description: 'resources reserved for an application',
-        unit: 'count',
-        'aggregation-method': 'none',
-      },
-      'resources-total': {
-        description: 'total resources available',
-        unit: 'count',
-        'aggregation-method': 'none',
-      },
-      'vcpus-allocated': {
-        description: 'number of vcpus allocated to particular resource',
-        unit: 'count',
-        'aggregation-method': 'none',
-      },
-      'vcpus-total': {
-        description: 'total number of vcpus available on a particular resource',
-        unit: 'count',
-        'aggregation-method': 'none',
-      },
+    inputs: {
+      ...({
+        'device/emissions-embodied': {
+          description: 'total embodied emissions of some component',
+          unit: 'gCO2e',
+          'aggregation-method': 'sum',
+        },
+        'device/expected-lifespan': {
+          description: 'Total Expected Lifespan of the Component in Seconds',
+          unit: 'seconds',
+          'aggregation-method': 'sum',
+        },
+        'resources-reserved': {
+          description: 'resources reserved for an application',
+          unit: 'count',
+          'aggregation-method': 'none',
+        },
+        'resources-total': {
+          description: 'total resources available',
+          unit: 'count',
+          'aggregation-method': 'none',
+        },
+        'vcpus-allocated': {
+          description: 'number of vcpus allocated to particular resource',
+          unit: 'count',
+          'aggregation-method': 'none',
+        },
+        'vcpus-total': {
+          description:
+            'total number of vcpus available on a particular resource',
+          unit: 'count',
+          'aggregation-method': 'none',
+        },
+      } as ParameterMetadata),
+      ...parametersMetadata?.inputs,
     },
     outputs: parametersMetadata?.outputs || {
       'carbon-embodied': {

diff --git a/src/if-run/builtins/sci/index.ts b/src/if-run/builtins/sci/index.ts
@@ -5,6 +5,7 @@ import {
   PluginParams,
   ConfigParams,
   PluginParametersMetadata,
+  ParameterMetadata,
 } from '@grnsft/if-core/types';
 
 import {validate, allDefined} from '../../../common/util/validations';
@@ -25,18 +26,21 @@ export const Sci = (
 ): ExecutePlugin => {
   const metadata = {
     kind: 'execute',
-    inputs: parametersMetadata?.inputs || {
-      carbon: {
-        description: 'an amount of carbon emitted into the atmosphere',
-        unit: 'gCO2e',
-        'aggregation-method': 'sum',
-      },
-      'functional-unit': {
-        description:
-          'the name of the functional unit in which the final SCI value should be expressed, e.g. requests, users',
-        unit: 'none',
-        'aggregation-method': 'sum',
-      },
+    inputs: {
+      ...({
+        carbon: {
+          description: 'an amount of carbon emitted into the atmosphere',
+          unit: 'gCO2e',
+          'aggregation-method': 'sum',
+        },
+        'functional-unit': {
+          description:
+            'the name of the functional unit in which the final SCI value should be expressed, e.g. requests, users',
+          unit: 'none',
+          'aggregation-method': 'sum',
+        },
+      } as ParameterMetadata),
+      ...parametersMetadata?.inputs,
     },
     outputs: parametersMetadata?.outputs || {
       sci: {

diff --git a/src/if-run/builtins/sum/README.md b/src/if-run/builtins/sum/README.md
@@ -86,13 +86,16 @@ initialize:
           cpu/energy:
             description: energy consumed by the cpu
             unit: kWh
+            aggregation-method: sum
           network/energy:
             description: energy consumed by data ingress and egress
             unit: kWh
+            aggregation-method: sum
         outputs:
           energy:
             description: sum of energy components
             unit: kWh
+            aggregation-method: sum
 tree:
   children:
     child:

diff --git a/src/if-run/builtins/time-sync/index.ts b/src/if-run/builtins/time-sync/index.ts
@@ -10,6 +10,7 @@ import {
   TimeNormalizerConfig,
   TimeParams,
   PluginParametersMetadata,
+  ParameterMetadata,
 } from '@grnsft/if-core/types';
 
 import {validate} from '../../../common/util/validations';
@@ -57,17 +58,20 @@ export const TimeSync = (
 ): ExecutePlugin => {
   const metadata = {
     kind: 'execute',
-    inputs: parametersMetadata?.inputs || {
-      timestamp: {
-        description: 'refers to the time of occurrence of the input',
-        unit: 'RFC3339',
-        'aggregation-method': 'none',
-      },
-      duration: {
-        description: 'refers to the duration of the input',
-        unit: 'seconds',
-        'aggregation-method': 'sum',
-      },
+    inputs: {
+      ...({
+        timestamp: {
+          description: 'refers to the time of occurrence of the input',
+          unit: 'RFC3339',
+          'aggregation-method': 'none',
+        },
+        duration: {
+          description: 'refers to the duration of the input',
+          unit: 'seconds',
+          'aggregation-method': 'sum',
+        },
+      } as ParameterMetadata),
+      ...parametersMetadata?.inputs,
     },
     outputs: parametersMetadata?.outputs,
   };