Merge remote-tracking branch 'origin/master' into v3

Author: joelgallant

app-config-cli/package.json

@@ -53,6 +53,7 @@
     "yargs": "16"
   },
   "devDependencies": {
+    "@app-config/test-utils": "^3.0.0-alpha.4",
     "@types/common-tags": "1",
     "@types/fs-extra": "9"
   },

app-config-cli/tsconfig.json

@@ -10,6 +10,8 @@
     { "path": "../app-config-core" },
     { "path": "../app-config-config" },
     { "path": "../app-config-node" },
-    { "path": "../app-config-generate" }
+    { "path": "../app-config-generate" },
+    { "path": "../app-config-utils" },
+    { "path": "../app-config-test-utils" }
   ]
 }

app-config-encryption/src/encryption.ts

@@ -140,9 +140,17 @@ export async function loadKey(contents: string | Buffer): Promise<Key> {
   return keys[0];
 }
 
-export async function loadPrivateKey(
-  override: string | Buffer | undefined = process.env.APP_CONFIG_SECRETS_KEY,
-): Promise<Key> {
+export async function loadPrivateKey(override?: string | Buffer): Promise<Key> {
+  if (override === undefined) {
+    if (process.env.APP_CONFIG_SECRETS_KEY) {
+      // eslint-disable-next-line no-param-reassign
+      override = process.env.APP_CONFIG_SECRETS_KEY;
+    } else if (process.env.APP_CONFIG_SECRETS_KEY_FILE) {
+      // eslint-disable-next-line no-param-reassign
+      override = (await fs.readFile(process.env.APP_CONFIG_SECRETS_KEY_FILE)).toString();
+    }
+  }
+
   let key: Key;
 
   if (override) {
@@ -176,9 +184,17 @@ export async function loadPrivateKey(
   return key;
 }
 
-export async function loadPublicKey(
-  override: string | Buffer | undefined = process.env.APP_CONFIG_SECRETS_PUBLIC_KEY,
-): Promise<Key> {
+export async function loadPublicKey(override?: string | Buffer): Promise<Key> {
+  if (override === undefined) {
+    if (process.env.APP_CONFIG_SECRETS_PUBLIC_KEY) {
+      // eslint-disable-next-line no-param-reassign
+      override = process.env.APP_CONFIG_SECRETS_PUBLIC_KEY;
+    } else if (process.env.APP_CONFIG_SECRETS_PUBLIC_KEY_FILE) {
+      // eslint-disable-next-line no-param-reassign
+      override = (await fs.readFile(process.env.APP_CONFIG_SECRETS_PUBLIC_KEY_FILE)).toString();
+    }
+  }
+
   let key: Key;
 
   if (override) {

app-config-exec/package.json

@@ -36,7 +36,8 @@
     "@app-config/utils": "^3.0.0-alpha.4"
   },
   "devDependencies": {
-    "@app-config/main": "^3.0.0-alpha.4"
+    "@app-config/main": "^3.0.0-alpha.4",
+    "@app-config/test-utils": "^3.0.0-alpha.4"
   },
   "prettier": "@lcdev/prettier",
   "jest": {

app-config-exec/tsconfig.json

@@ -12,6 +12,7 @@
     { "path": "../app-config-utils" },
     { "path": "../app-config-core" },
     { "path": "../app-config-node" },
-    { "path": "../app-config-extension-utils" }
+    { "path": "../app-config-extension-utils" },
+    { "path": "../app-config-test-utils" }
   ]
 }

app-config-extensions/src/extends-directive.ts

@@ -33,7 +33,7 @@ function fileReferenceDirective(keyName: string, meta: ParsedValueMetadata): Par
 
         return SchemaBuilder.oneOf(reference, SchemaBuilder.arraySchema(reference));
       },
-      (value, _, __, context) => async (_, __, source, extensions) => {
+      (value, _, __, context) => async (_, ___, source, extensions) => {
         const retrieveFile = async (
           filepath: string,
           subselector?: string,

app-config-main/package.json

@@ -47,7 +47,9 @@
     "@app-config/utils": "^3.0.0-alpha.4",
     "ajv": "8"
   },
-  "devDependencies": {},
+  "devDependencies": {
+    "@app-config/test-utils": "^3.0.0-alpha.4"
+  },
   "prettier": "@lcdev/prettier",
   "jest": {
     "preset": "@lcdev/jest",

app-config-main/tsconfig.json

@@ -11,6 +11,8 @@
     { "path": "../app-config-test-utils" },
     { "path": "../app-config-core" },
     { "path": "../app-config-node" },
-    { "path": "../app-config-cli" }
+    { "path": "../app-config-cli" },
+    { "path": "../app-config-utils" },
+    { "path": "../app-config-test-utils" }
   ]
 }

app-config-test-utils/src/index.ts

@@ -34,10 +34,15 @@ export async function withTempFiles(
     await callback((filename) => join(folder, filename), folder);
   } finally {
     await remove(folder).catch((error) => {
+      // eslint-disable-next-line no-console
       console.warn(error);
 
       // we'll just ignore this, it's spurious in CI
-      if (isWindows && error.code !== 'EBUSY') {
+      if (
+        isWindows &&
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+        error.code !== 'EBUSY'
+      ) {
         throw error;
       }
     });

docs/guide/intro/encryption.md

@@ -105,6 +105,11 @@ This key (public + private) can be added as protected environment variables in y
 - `APP_CONFIG_SECRETS_KEY`
 - `APP_CONFIG_SECRETS_PUBLIC_KEY`
 
+Or, in files referenced by:
+
+- `APP_CONFIG_SECRETS_KEY_FILE`
+- `APP_CONFIG_SECRETS_PUBLIC_KEY_FILE`
+
 The CLI will output both of these with instructions.
 
 ## Implementation Details