fix: marks $env as "lazy" in validateOptions, to allow "enc:" in a non-active environment path

Author: joelgallant

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

@@ -46,14 +46,21 @@ export function validateOptions<T>(
     key: ParsingExtensionKey,
     context: ParsingExtensionKey[],
   ) => ParsingExtensionTransform | false,
+  { lazy = false }: { lazy?: boolean } = {},
 ): ParsingExtension {
   const schema = builder(SchemaBuilder);
 
   schema.cacheValidationFunction();
 
   return (value, ctxKey, ctx) => {
     return async (parse, ...args) => {
-      const valid = ((await parse(value)).toJSON() as unknown) as T;
+      let valid: T;
+
+      if (lazy) {
+        valid = (value as unknown) as T;
+      } else {
+        valid = ((await parse(value)).toJSON() as unknown) as T;
+      }
 
       try {
         schema.validate(valid);
@@ -74,6 +81,7 @@ export function validateOptions<T>(
       if (call) {
         return call(parse, ...args);
       }
+
       throw new AppConfigError(
         `A parsing extension returned as non-applicable, when using validateOptions. This isn't supported.`,
       );

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

@@ -1,6 +1,7 @@
 import { withTempFiles } from '@app-config/test-utils';
 import { LiteralSource, NotFoundError } from '@app-config/core';
 import { FileSource } from '@app-config/node';
+import { forKey } from '@app-config/extension-utils';
 import {
   envDirective,
   extendsDirective,
@@ -508,6 +509,20 @@ describe('$env directive', () => {
     expect(parsed.toJSON()).toEqual(null);
   });
 
+  it('doesnt evaluate non-current environment', async () => {
+    const failDirective = forKey('$fail', () => () => {
+      throw new Error();
+    });
+
+    process.env.NODE_ENV = 'test';
+    const source = new LiteralSource({
+      $env: { test: null, dev: { $fail: true } },
+    });
+
+    const parsed = await source.read([envDirective(), failDirective]);
+    expect(parsed.toJSON()).toEqual(null);
+  });
+
   it('merges selection with sibling keys', async () => {
     const source = new LiteralSource({
       sibling: true,

app-config-extensions/src/index.ts

@@ -108,6 +108,7 @@ export function envDirective(
           `An $env directive was used, but none matched the current environment (wanted ${environment}, saw [${found}])`,
         );
       },
+      { lazy: true },
     ),
   );
 }