Merge branch 'add-unit-tests' into unit-tests-for-aws-secrets-manager

neofinancial · Jan 9, 2025 · f4d2b6b · f4d2b6b
2 parents c51c676 + edd45e6
commit f4d2b6b
Show file tree

Hide file tree

Showing 27 changed files with 6,897 additions and 2,569 deletions.
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -1 +1 @@
-* @iansu
+* @iansu @Neo-Malcolm-Fischer @AD-Blue
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/config-dug/.eslintignore b/packages/config-dug/.eslintignore
@@ -0,0 +1,4 @@
+**/build
+**/coverage
+**/node_modules
+.eslintrc.cjs
diff --git a/packages/config-dug/.eslintrc.cjs b/packages/config-dug/.eslintrc.cjs
@@ -0,0 +1,16 @@
+module.exports = {
+  extends: ['eslint-config-neo/config-backend'],
+  parser: '@typescript-eslint/parser',
+  plugins: ['@typescript-eslint'],
+  parserOptions: {
+    project: ['./tsconfig.cjs.json', './test/tsconfig.json'],
+    sourceType: 'module',
+  },
+  rules: {
+    jest: 'off',
+    'jest/no-commented-out-tests': 'off',
+    'jest/no-deprecated-functions': 'off',
+    'jest/valid-expect': 'off',
+    'jest/valid-expect-in-promise': 'off',
+  },
+};
diff --git a/packages/config-dug/package.json b/packages/config-dug/package.json
@@ -1,6 +1,6 @@
 {
   "name": "config-dug",
-  "version": "2.0.0-alpha.0",
+  "version": "2.0.0-alpha.1",
   "description": "Config management library for Node.js with support for multiple environments, config files, environment variables and plugins",
   "author": "Neo Financial Engineering <[email protected]>",
   "license": "MIT",
@@ -41,19 +41,27 @@
     "build": "tsc -b tsconfig.cjs.json tsconfig.esm.json tsconfig.types.json",
     "watch": "tsc -b tsconfig.cjs.json tsconfig.esm.json tsconfig.types.json --watch",
     "clean": "rimraf build",
-    "prepublishOnly": "npm run clean && npm run build",
-    "test": "vitest run --config ./test/vitest.config.ts"
+    "format": "prettier --write \"**/*.{ts,tsx,js,json,graphql,md}\"",
+    "format:check": "prettier --debug-check \"**/*.{ts,tsx,js,json,graphql,md}\"",
+    "lint": "eslint .",
+    "test": "NODE_ENV=test TZ=UTC vitest run --config vite.config.js --isolate=false",
+    "prepublishOnly": "npm run clean && npm run build"
   },
   "dependencies": {
     "chalk": "^4.1.2",
     "change-case": "^4.1.2",
     "debug": "^4.3.4",
-    "zod": "^3.21.4"
+    "ms": "^2.1.3",
+    "zod": "^3.23.8"
   },
   "devDependencies": {
     "@tsconfig/node18": "^1.0.3",
     "@types/debug": "^4.1.7",
     "@types/node": "^18.11.18",
+    "eslint-config-neo": "^0.12.0",
     "typescript": "^5.0.4"
+  },
+  "optionalDependencies": {
+    "@rollup/rollup-linux-x64-gnu": "^4.9.6"
   }
 }
diff --git a/packages/config-dug/src/config-dug.ts b/packages/config-dug/src/config-dug.ts
@@ -1,9 +1,10 @@
 import EventEmitter from 'events';
 import createDebug from 'debug';
 import { z } from 'zod';
+import * as changeKeys from './lib/change-case-keys';
 
-import { getOptions, ConfigDugOptions, ConfigDugOptionsWithDefaults } from './lib/options.js';
-import { recordOrigin, recordOriginDefaults, mergeOrigins } from './lib/origins.js';
+import { ConfigDugOptions, ConfigDugOptionsWithDefaults, getOptions } from './lib/options.js';
+import { mergeOrigins, recordOrigin, recordOriginDefaults } from './lib/origins.js';
 import { logger } from './lib/logger.js';
 import { ConfigDugError } from './lib/errors.js';
 import { loadConfigFile } from './lib/config-file.js';
@@ -127,7 +128,7 @@ class ConfigDug<T extends ConfigDugSchema> extends EventEmitter {
     if (this.loaded === true) {
       debug('config already loaded');
 
-      return Promise.resolve();
+      return;
     }
 
     await this.loadConfig();
@@ -150,17 +151,13 @@ class ConfigDug<T extends ConfigDugSchema> extends EventEmitter {
 
   private async loadConfig(): Promise<void> {
     const environmentName = getEnvironmentName(this.options.envKey);
-
-    if (!this.pluginsInitialized) {
-      await this.initializePlugins();
-      this.pluginsInitialized = true;
-    }
+    const environmentVariables = this.loadEnvironment(Object.keys(this.schema));
 
     this.valueOrigins = {};
     this.rawValues = {
       ...(await this.loadConfigFile('config.default')),
       ...(await this.loadConfigFile(`config.${environmentName}`)),
-      ...(await this.loadPlugins()),
+      ...(await this.loadPlugins(environmentVariables)),
       ...(await this.loadLocalConfigFile(`config.${environmentName}.local`)),
       ...(await this.loadLocalConfigFile('config.local')),
       ...this.loadEnvironment(Object.keys(this.schema)),
@@ -192,12 +189,13 @@ class ConfigDug<T extends ConfigDugSchema> extends EventEmitter {
     }
 
     const [resolvedFilename, values] = await loadConfigFile(filename, this.options.basePath, ['js', 'cjs', 'mjs']);
+    const keyCorrectedValues = changeKeys[this.options.keyStyle](values);
 
     if (resolvedFilename) {
-      this.valueOrigins = recordOrigin(this.valueOrigins, values, resolvedFilename);
+      this.valueOrigins = recordOrigin(this.valueOrigins, keyCorrectedValues, resolvedFilename);
     }
 
-    return values;
+    return keyCorrectedValues;
   }
 
   private async loadLocalConfigFile(filename: string): Promise<UntypedConfig> {
@@ -210,13 +208,14 @@ class ConfigDug<T extends ConfigDugSchema> extends EventEmitter {
     }
 
     const [resolvedFilename, values] = await loadConfigFile(filename, this.options.basePath, ['js', 'cjs', 'mjs']);
+    const keyCorrectedValues = changeKeys[this.options.keyStyle](values);
 
     if (resolvedFilename) {
       this.options.warnOnLocalConfigFile && logger.warn(`Loaded local config file: ${resolvedFilename}`);
-      this.valueOrigins = recordOrigin(this.valueOrigins, values, resolvedFilename);
+      this.valueOrigins = recordOrigin(this.valueOrigins, keyCorrectedValues, resolvedFilename);
     }
 
-    return values;
+    return keyCorrectedValues;
   }
 
   private loadEnvironment(keys: string[]): UntypedConfig {
@@ -229,39 +228,38 @@ class ConfigDug<T extends ConfigDugSchema> extends EventEmitter {
     }
 
     const values = loadEnvironment(keys);
-
     this.valueOrigins = recordOrigin(this.valueOrigins, values, 'environment');
 
     return values;
   }
 
-  private async initializePlugins(): Promise<void> {
-    debug('initialize plugins');
+  private async loadPlugins(values: UntypedConfig): Promise<UntypedConfig> {
+    let nextPluginReloadIn: number | undefined;
 
     for (const plugin of this.options.plugins) {
-      if (typeof plugin.initialize === 'function') {
-        await plugin.initialize(this.options);
+      if (!plugin.isInitialized()) {
+        await plugin.initialize(this.options, values);
       }
-    }
-  }
 
-  private async loadPlugins(): Promise<UntypedConfig> {
-    let values: UntypedConfig = {};
-
-    for (const plugin of this.options.plugins) {
       const pluginReturnValue: ConfigDugPluginOutput = await plugin.load();
-
-      values = { ...values, ...pluginReturnValue.values };
-
+      const keyCorrectedValues = changeKeys[this.options.keyStyle](pluginReturnValue.values);
+      values = { ...values, ...keyCorrectedValues };
       this.valueOrigins = mergeOrigins(this.valueOrigins, pluginReturnValue.valueOrigins);
 
       if (pluginReturnValue.nextReloadIn) {
-        this.reloadTimeout = setTimeout(async () => {
-          await this.reload();
-        }, pluginReturnValue.nextReloadIn);
+        // We will reload in time for the nearest plugin reload
+        nextPluginReloadIn = nextPluginReloadIn
+          ? Math.min(nextPluginReloadIn, pluginReturnValue.nextReloadIn)
+          : pluginReturnValue.nextReloadIn;
       }
     }
 
+    if (nextPluginReloadIn) {
+      this.reloadTimeout = setTimeout(async () => {
+        await this.reload();
+      }, nextPluginReloadIn);
+    }
+
     debug('plugin values', values);
 
     return values;

diff --git a/packages/config-dug/src/index.ts b/packages/config-dug/src/index.ts
@@ -2,5 +2,6 @@ export { z } from 'zod';
 
 export { ConfigDug, ConfigDugSchema, ConfigDugConfig, UntypedConfig, ValueOrigins } from './config-dug.js';
 export { ConfigDugError } from './lib/errors.js';
-export type { ConfigDugPlugin, ConfigDugPluginOutput } from './lib/plugin.js';
+export { BaseConfigDugPlugin } from './lib/plugin.js';
+export type { ConfigDugPlugin, ConfigDugPluginOptions, ConfigDugPluginOutput } from './lib/plugin.js';
 export type { ConfigDugOptions } from './lib/options.js';
diff --git a/packages/config-dug/src/lib/change-case-keys.ts b/packages/config-dug/src/lib/change-case-keys.ts
@@ -0,0 +1,45 @@
+// Implementation from https://www.npmjs.com/package/change-case
+import * as changeCase from 'change-case';
+import { UntypedConfig } from '../config-dug';
+
+export enum KeyStyle {
+  camelCase = 'camelCase',
+  capitalCase = 'capitalCase',
+  constantCase = 'constantCase',
+  dotCase = 'dotCase',
+  noCase = 'noCase',
+  pascalCase = 'pascalCase',
+  pathCase = 'pathCase',
+  sentenceCase = 'sentenceCase',
+  snakeCase = 'snakeCase',
+}
+
+const isObject = (object: unknown) => object !== null && typeof object === 'object';
+
+function changeKeysFactory<Options extends changeCase.Options = changeCase.Options>(
+  changeCase: (input: string, options?: changeCase.Options) => string
+): (object: UntypedConfig, depth?: number, options?: Options) => UntypedConfig {
+  return function changeKeys(object: UntypedConfig, depth = 1, options?: Options): UntypedConfig {
+    if (depth === 0 || !isObject(object)) return {};
+
+    const result: Record<string, unknown> = Object.create(Object.getPrototypeOf(object));
+
+    Object.keys(object as object).forEach((key) => {
+      const value = (object as Record<string, unknown>)[key];
+      const changedKey = changeCase(key, options);
+      result[changedKey] = value;
+    });
+
+    return result;
+  };
+}
+
+export const camelCase = changeKeysFactory(changeCase.camelCase);
+export const capitalCase = changeKeysFactory(changeCase.capitalCase);
+export const constantCase = changeKeysFactory(changeCase.constantCase);
+export const dotCase = changeKeysFactory(changeCase.dotCase);
+export const noCase = changeKeysFactory(changeCase.noCase);
+export const pascalCase = changeKeysFactory(changeCase.pascalCase);
+export const pathCase = changeKeysFactory(changeCase.pathCase);
+export const sentenceCase = changeKeysFactory(changeCase.sentenceCase);
+export const snakeCase = changeKeysFactory(changeCase.snakeCase);
diff --git a/packages/config-dug/src/lib/config-file.ts b/packages/config-dug/src/lib/config-file.ts
@@ -65,7 +65,7 @@ const loadConfigFile = async (
     }
   }
 
-  return Promise.resolve([undefined, {}]);
+  return [undefined, {}];
 };
 
 export { loadConfigFile };
diff --git a/packages/config-dug/src/lib/environment.ts b/packages/config-dug/src/lib/environment.ts
@@ -11,14 +11,15 @@ const getEnvironmentName = (envKey: string): string => {
 
   const environmentName = process.env[envKey];
 
-  if (!environmentName) {
+  if (environmentName) {
+    debug('resolved environment name', environmentName);
+
+    return environmentName;
+  } else {
     debug('unable to load environment name, defaulting to `development`');
     logger.warn(`Unable to load environment from ${envKey}. Defaulting to \`development\`.`);
 
     return 'development';
-  } else {
-    debug('resolved environment name', environmentName);
-    return environmentName;
   }
 };
 

diff --git a/packages/config-dug/src/lib/options.ts b/packages/config-dug/src/lib/options.ts
@@ -1,4 +1,6 @@
 import { z } from 'zod';
+import { pluginSchema } from './plugin';
+import { KeyStyle } from './change-case-keys';
 
 export type ConfigDugOptions = z.infer<typeof optionsSchema>;
 export type ConfigDugOptionsWithDefaults = z.infer<typeof optionsWithDefaultsSchema>;
@@ -7,10 +9,10 @@ const optionsSchema = z
   .object({
     basePath: z.string().optional(),
     envKey: z.string().optional(),
+    keyStyle: z.nativeEnum(KeyStyle).optional(),
     loadConfigFiles: z.boolean().optional(),
     loadEnvironment: z.boolean().optional(),
-    // TODO: Add plugin types
-    plugins: z.array(z.any()).optional(),
+    plugins: z.array(pluginSchema).optional(),
     printConfig: z.boolean().optional(),
     strict: z.boolean().optional(),
     warnOnLocalConfigFile: z.boolean().optional(),
@@ -20,9 +22,10 @@ const optionsSchema = z
 const optionsWithDefaultsSchema = z.object({
   basePath: z.string().default(process.cwd()),
   envKey: z.string().default('APP_ENV'),
+  keyStyle: z.nativeEnum(KeyStyle).default(KeyStyle.camelCase),
   loadConfigFiles: z.boolean().default(true),
   loadEnvironment: z.boolean().default(true),
-  plugins: z.array(z.any()).default([]),
+  plugins: z.array(pluginSchema).default([]),
   printConfig: z.boolean().default(false),
   strict: z.boolean().default(false),
   warnOnLocalConfigFile: z.boolean().default(true),

diff --git a/packages/config-dug/src/lib/origins.ts b/packages/config-dug/src/lib/origins.ts
@@ -1,6 +1,6 @@
 import createDebug from 'debug';
 
-import { ValueOrigins, UntypedConfig } from '../config-dug.js';
+import { UntypedConfig, ValueOrigins } from '../config-dug.js';
 
 const debug = createDebug('config-dug:lib:origins');
 

diff --git a/packages/config-dug/src/lib/parser.ts b/packages/config-dug/src/lib/parser.ts
@@ -1,8 +1,8 @@
 import { z } from 'zod';
 
-import { ConfigDugSchema, ConfigDugConfig, UntypedConfig, ValueOrigins } from '../config-dug.js';
+import { ConfigDugConfig, ConfigDugSchema, UntypedConfig } from '../config-dug.js';
 import { getSchemaWithPreprocessor } from './preprocessor.js';
-import { ErrorWithContext, reportErrors, errorMap } from './reporter.js';
+import { errorMap, ErrorWithContext, reportErrors } from './reporter.js';
 import { logger } from './logger.js';
 
 const parseConfig = <T extends ConfigDugSchema>(
@@ -45,7 +45,7 @@ const parseConfig = <T extends ConfigDugSchema>(
           defaultValue = schemaOrExtendedSchema.schema._def.defaultValue();
           defaults.push(key);
         }
-
+        schemaOrExtendedSchema.schema.parse;
         parsed[key] = strict
           ? schemaOrExtendedSchema.schema.parse(value, { errorMap })
           : getSchemaWithPreprocessor(schemaOrExtendedSchema.schema).parse(value, { errorMap });