fix(builtins): rename global-config to config in plugins

Green-Software-Foundation · Aug 12, 2024 · cea711a · cea711a
1 parent 7bdc885
commit cea711a
Show file tree

Hide file tree

Showing 17 changed files with 122 additions and 155 deletions.
diff --git a/src/if-run/builtins/coefficient/index.ts b/src/if-run/builtins/coefficient/index.ts
@@ -12,10 +12,10 @@ import {validate} from '../../../common/util/validations';
 import {STRINGS} from '../../config';
 
 const {GlobalConfigError} = ERRORS;
-const {MISSING_GLOBAL_CONFIG} = STRINGS;
+const {MISSING_CONFIG} = STRINGS;
 
 export const Coefficient = (
-  globalConfig: CoefficientConfig,
+  config: CoefficientConfig,
   parametersMetadata: PluginParametersMetadata
 ): ExecutePlugin => {
   const metadata = {
@@ -28,7 +28,7 @@ export const Coefficient = (
    * Calculate the product of each input parameter.
    */
   const execute = (inputs: PluginParams[]) => {
-    const safeGlobalConfig = validateGlobalConfig();
+    const safeGlobalConfig = validateConfig();
     const inputParameter = safeGlobalConfig['input-parameter'];
     const outputParameter = safeGlobalConfig['output-parameter'];
     const coefficient = safeGlobalConfig['coefficient'];
@@ -66,23 +66,20 @@ export const Coefficient = (
   ) => input[inputParameter] * coefficient;
 
   /**
-   * Checks global config value are valid.
+   * Checks config value are valid.
    */
-  const validateGlobalConfig = () => {
-    if (!globalConfig) {
-      throw new GlobalConfigError(MISSING_GLOBAL_CONFIG);
+  const validateConfig = () => {
+    if (!config) {
+      throw new GlobalConfigError(MISSING_CONFIG);
     }
 
-    const globalConfigSchema = z.object({
+    const configSchema = z.object({
       coefficient: z.number(),
       'input-parameter': z.string().min(1),
       'output-parameter': z.string().min(1),
     });
 
-    return validate<z.infer<typeof globalConfigSchema>>(
-      globalConfigSchema,
-      globalConfig
-    );
+    return validate<z.infer<typeof configSchema>>(configSchema, config);
   };
 
   return {

diff --git a/src/if-run/builtins/copy-param/index.ts b/src/if-run/builtins/copy-param/index.ts
@@ -10,14 +10,14 @@ import {validate} from '../../../common/util/validations';
 
 import {STRINGS} from '../../config';
 
-const {MISSING_GLOBAL_CONFIG} = STRINGS;
+const {MISSING_CONFIG} = STRINGS;
 const {GlobalConfigError} = ERRORS;
 //   keep-existing: true/false (whether to remove the parameter you are copying from)
 //   from-param: the parameter you are copying from (e.g. cpu/name)
 //   to-field: the parameter you are copying to (e.g. cpu/processor-name)
 
 export const Copy = (
-  globalConfig: Record<string, any>,
+  config: Record<string, any>,
   parametersMetadata: PluginParametersMetadata
 ): ExecutePlugin => {
   const metadata = {
@@ -27,23 +27,20 @@ export const Copy = (
   };
 
   /**
-   * Checks global config value are valid.
+   * Checks config value are valid.
    */
-  const validateGlobalConfig = () => {
-    if (!globalConfig) {
-      throw new GlobalConfigError(MISSING_GLOBAL_CONFIG);
+  const validateConfig = () => {
+    if (!config) {
+      throw new GlobalConfigError(MISSING_CONFIG);
     }
 
-    const globalConfigSchema = z.object({
+    const configSchema = z.object({
       'keep-existing': z.boolean(),
       from: z.string().min(1),
       to: z.string().min(1),
     });
 
-    return validate<z.infer<typeof globalConfigSchema>>(
-      globalConfigSchema,
-      globalConfig
-    );
+    return validate<z.infer<typeof configSchema>>(configSchema, config);
   };
 
   /**
@@ -70,7 +67,7 @@ export const Copy = (
   };
 
   const execute = (inputs: PluginParams[]) => {
-    const safeGlobalConfig = validateGlobalConfig();
+    const safeGlobalConfig = validateConfig();
     const keepExisting = safeGlobalConfig['keep-existing'] === true;
     const from = safeGlobalConfig['from'];
     const to = safeGlobalConfig['to'];

diff --git a/src/if-run/builtins/csv-lookup/index.ts b/src/if-run/builtins/csv-lookup/index.ts
@@ -20,7 +20,7 @@ const {
   FILE_READ_FAILED,
   MISSING_CSV_COLUMN,
   NO_QUERY_DATA,
-  MISSING_GLOBAL_CONFIG,
+  MISSING_CONFIG,
 } = STRINGS;
 
 const {
@@ -33,7 +33,7 @@ const {
 } = ERRORS;
 
 export const CSVLookup = (
-  globalConfig: any,
+  config: any,
   parametersMetadata: PluginParametersMetadata
 ): ExecutePlugin => {
   const metadata = {
@@ -191,13 +191,13 @@ export const CSVLookup = (
   };
 
   /**
-   * 1. Validates global config.
+   * 1. Validates config.
    * 2. Tries to retrieve given file (with url or local path).
    * 3. Parses given CSV.
    * 4. Filters requested information from CSV.
    */
   const execute = async (inputs: PluginParams[]) => {
-    const safeGlobalConfig = validateGlobalConfig();
+    const safeGlobalConfig = validateConfig();
     const {filepath, query, output} = safeGlobalConfig;
 
     const file = await retrieveFile(filepath);
@@ -227,14 +227,14 @@ export const CSVLookup = (
   };
 
   /**
-   * Checks for `filepath`, `query` and `output` fields in global config.
+   * Checks for `filepath`, `query` and `output` fields in config.
    */
-  const validateGlobalConfig = () => {
-    if (!globalConfig) {
-      throw new GlobalConfigError(MISSING_GLOBAL_CONFIG);
+  const validateConfig = () => {
+    if (!config) {
+      throw new GlobalConfigError(MISSING_CONFIG);
     }
 
-    const globalConfigSchema = z.object({
+    const configSchema = z.object({
       filepath: z.string(),
       query: z.record(z.string(), z.string()),
       output: z
@@ -243,10 +243,7 @@ export const CSVLookup = (
         .or(z.array(z.array(z.string()))),
     });
 
-    return validate<z.infer<typeof globalConfigSchema>>(
-      globalConfigSchema,
-      globalConfig
-    );
+    return validate<z.infer<typeof configSchema>>(configSchema, config);
   };
 
   return {

diff --git a/src/if-run/builtins/divide/index.ts b/src/if-run/builtins/divide/index.ts
@@ -12,10 +12,10 @@ import {validate} from '../../../common/util/validations';
 import {STRINGS} from '../../config';
 
 const {GlobalConfigError, MissingInputDataError} = ERRORS;
-const {MISSING_GLOBAL_CONFIG, MISSING_INPUT_DATA, ZERO_DIVISION} = STRINGS;
+const {MISSING_CONFIG, MISSING_INPUT_DATA, ZERO_DIVISION} = STRINGS;
 
 export const Divide = (
-  globalConfig: ConfigParams,
+  config: ConfigParams,
   parametersMetadata: PluginParametersMetadata
 ): ExecutePlugin => {
   const metadata = {
@@ -28,7 +28,7 @@ export const Divide = (
    * Calculate the division of each input parameter.
    */
   const execute = (inputs: PluginParams[]) => {
-    const safeGlobalConfig = validateGlobalConfig();
+    const safeGlobalConfig = validateConfig();
     const {numerator, denominator, output} = safeGlobalConfig;
 
     return inputs.map((input, index) => {
@@ -46,11 +46,11 @@ export const Divide = (
   };
 
   /**
-   * Checks global config value are valid.
+   * Checks config value are valid.
    */
-  const validateGlobalConfig = () => {
-    if (!globalConfig) {
-      throw new GlobalConfigError(MISSING_GLOBAL_CONFIG);
+  const validateConfig = () => {
+    if (!config) {
+      throw new GlobalConfigError(MISSING_CONFIG);
     }
 
     const schema = z.object({
@@ -59,7 +59,7 @@ export const Divide = (
       output: z.string(),
     });
 
-    return validate<z.infer<typeof schema>>(schema, globalConfig);
+    return validate<z.infer<typeof schema>>(schema, config);
   };
 
   /**

diff --git a/src/if-run/builtins/exponent/index.ts b/src/if-run/builtins/exponent/index.ts
@@ -9,7 +9,7 @@ import {
 import {validate} from '../../../common/util/validations';
 
 export const Exponent = (
-  globalConfig: ExponentConfig,
+  config: ExponentConfig,
   parametersMetadata: PluginParametersMetadata
 ): ExecutePlugin => {
   const metadata = {
@@ -19,19 +19,16 @@ export const Exponent = (
   };
 
   /**
-   * Checks global config value are valid.
+   * Checks config value are valid.
    */
-  const validateGlobalConfig = () => {
-    const globalConfigSchema = z.object({
+  const validateConfig = () => {
+    const configSchema = z.object({
       'input-parameter': z.string().min(1),
       exponent: z.number(),
       'output-parameter': z.string().min(1),
     });
 
-    return validate<z.infer<typeof globalConfigSchema>>(
-      globalConfigSchema,
-      globalConfig
-    );
+    return validate<z.infer<typeof configSchema>>(configSchema, config);
   };
 
   /**
@@ -55,7 +52,7 @@ export const Exponent = (
       'input-parameter': inputParameter,
       exponent,
       'output-parameter': outputParameter,
-    } = validateGlobalConfig();
+    } = validateConfig();
 
     return inputs.map(input => {
       validateSingleInput(input, inputParameter);

diff --git a/src/if-run/builtins/interpolation/index.ts b/src/if-run/builtins/interpolation/index.ts
@@ -14,15 +14,11 @@ import {validate} from '../../../common/util/validations';
 import {STRINGS} from '../../config';
 
 const {GlobalConfigError} = ERRORS;
-const {
-  MISSING_GLOBAL_CONFIG,
-  X_Y_EQUAL,
-  ARRAY_LENGTH_NON_EMPTY,
-  WITHIN_THE_RANGE,
-} = STRINGS;
+const {MISSING_CONFIG, X_Y_EQUAL, ARRAY_LENGTH_NON_EMPTY, WITHIN_THE_RANGE} =
+  STRINGS;
 
 export const Interpolation = (
-  globalConfig: ConfigParams,
+  config: ConfigParams,
   parametersMetadata: PluginParametersMetadata
 ): ExecutePlugin => {
   const metadata = {
@@ -68,7 +64,7 @@ export const Interpolation = (
     config: ConfigParams,
     input: PluginParams
   ) => {
-    const parameter = input[globalConfig['input-parameter']];
+    const parameter = input[config['input-parameter']];
     const xPoints: number[] = config.x;
     const yPoints: number[] = config.y;
 
@@ -98,7 +94,7 @@ export const Interpolation = (
     config: ConfigParams,
     input: PluginParams
   ) => {
-    const parameter = input[globalConfig['input-parameter']];
+    const parameter = input[config['input-parameter']];
     const xPoints: number[] = config.x;
     const yPoints: number[] = config.y;
     const spline: any = new Spline(xPoints, yPoints);
@@ -113,7 +109,7 @@ export const Interpolation = (
     config: ConfigParams,
     input: PluginParams
   ) => {
-    const parameter = input[globalConfig['input-parameter']];
+    const parameter = input[config['input-parameter']];
     const xPoints: number[] = config.x;
     const yPoints: number[] = config.y;
 
@@ -133,12 +129,12 @@ export const Interpolation = (
   };
 
   /**
-   * Validates global config parameters.
+   * Validates config parameters.
    * Sorts elements of `x` and `y`.
    */
   const validateConfig = () => {
-    if (!globalConfig) {
-      throw new GlobalConfigError(MISSING_GLOBAL_CONFIG);
+    if (!config) {
+      throw new GlobalConfigError(MISSING_CONFIG);
     }
 
     const schema = z
@@ -156,16 +152,11 @@ export const Interpolation = (
         message: ARRAY_LENGTH_NON_EMPTY,
       });
 
-    const defaultMethod = globalConfig.method ?? Method.LINEAR;
-    const updatedConfig = Object.assign(
-      {},
-      {method: defaultMethod},
-      globalConfig,
-      {
-        x: sortPoints(globalConfig.x),
-        y: sortPoints(globalConfig.y),
-      }
-    );
+    const defaultMethod = config.method ?? Method.LINEAR;
+    const updatedConfig = Object.assign({}, {method: defaultMethod}, config, {
+      x: sortPoints(config.x),
+      y: sortPoints(config.y),
+    });
 
     return validate<z.infer<typeof schema>>(schema, updatedConfig);
   };
@@ -179,7 +170,7 @@ export const Interpolation = (
    * Validates inputes parameters.
    */
   const validateInput = (input: PluginParams, index: number) => {
-    const inputParameter = globalConfig['input-parameter'];
+    const inputParameter = config['input-parameter'];
     const schema = z
       .object({
         timestamp: z.string().or(z.date()),
@@ -188,8 +179,8 @@ export const Interpolation = (
       })
       .refine(
         data =>
-          data[inputParameter] >= globalConfig.x[0] &&
-          data[inputParameter] <= globalConfig.x[globalConfig.x.length - 1],
+          data[inputParameter] >= config.x[0] &&
+          data[inputParameter] <= config.x[config.x.length - 1],
         {
           message: WITHIN_THE_RANGE,
         }

diff --git a/src/if-run/builtins/mock-observations/helpers/common-generator.ts b/src/if-run/builtins/mock-observations/helpers/common-generator.ts
@@ -6,7 +6,7 @@ import {STRINGS} from '../../../config';
 import {Generator} from '../interfaces';
 
 const {GlobalConfigError} = ERRORS;
-const {MISSING_GLOBAL_CONFIG} = STRINGS;
+const {MISSING_CONFIG} = STRINGS;
 
 export const CommonGenerator = (config: ConfigParams): Generator => {
   /**
@@ -16,7 +16,7 @@ export const CommonGenerator = (config: ConfigParams): Generator => {
    */
   const validateConfig = (config: object) => {
     if (!config || Object.keys(config).length === 0) {
-      throw new GlobalConfigError(MISSING_GLOBAL_CONFIG);
+      throw new GlobalConfigError(MISSING_CONFIG);
     }
 
     return structuredClone(config);