feat: adds resolveFilepath to @app-config/node for resolving $exec files relatively

Author: joelgallant

app-config-exec/package.json

@@ -32,6 +32,7 @@
   "dependencies": {
     "@app-config/core": "^2.2.0",
     "@app-config/extension-utils": "^2.2.0",
+    "@app-config/node": "^2.2.0",
     "@app-config/utils": "^2.2.0"
   },
   "devDependencies": {

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

@@ -1,5 +1,7 @@
 import { defaultEnvExtensions, defaultExtensions, loadUnvalidatedConfig } from '@app-config/main';
 import { isWindows } from '@app-config/utils';
+import { withTempFiles } from '@app-config/test-utils';
+import { FileSource } from '@app-config/node';
 import execParsingExtension from '.';
 
 const defaultOptions = {
@@ -129,4 +131,31 @@ describe('execParsingExtension', () => {
 
     await expect(action()).rejects.toThrow();
   });
+
+  it('reads from command as root level string', async () => {
+    process.env.APP_CONFIG = JSON.stringify({
+      $exec: 'echo test123',
+    });
+
+    const { fullConfig } = await loadUnvalidatedConfig(defaultOptions);
+
+    expect(fullConfig).toEqual('test123');
+  });
+
+  it('loads file relative to app-config', () =>
+    withTempFiles(
+      {
+        'config.yml': `
+          $exec: node ./foo.js
+        `,
+        'foo.js': `
+          console.log("foo bar");
+        `,
+      },
+      async (inDir) => {
+        const source = new FileSource(inDir('config.yml'));
+
+        expect(await source.readToJSON([execParsingExtension()])).toEqual('foo bar');
+      },
+    ));
 });

app-config-exec/src/index.ts

@@ -1,7 +1,9 @@
 import { Json } from '@app-config/utils';
 import { ParsingExtension, parseRawString, guessFileType, AppConfigError } from '@app-config/core';
 import { forKey, validateOptions } from '@app-config/extension-utils';
+import { resolveFilepath } from '@app-config/node';
 import { exec } from 'child_process';
+import { dirname } from 'path';
 import { promisify } from 'util';
 
 const execAsync = promisify(exec);
@@ -30,7 +32,7 @@ function execParsingExtension(): ParsingExtension {
             .addBoolean('parseOutput', {}, false)
             .addBoolean('trimWhitespace', {}, false),
         ),
-      (value) => async (parse) => {
+      (value) => async (parse, _, context) => {
         let options;
 
         if (typeof value === 'string') {
@@ -47,7 +49,8 @@ function execParsingExtension(): ParsingExtension {
         } = options;
 
         try {
-          const { stdout, stderr } = await execAsync(command);
+          const dir = resolveFilepath(context, '.');
+          const { stdout, stderr } = await execAsync(command, { cwd: dir });
 
           if (failOnStderr && stderr) {
             throw new ExecError(`$exec command "${command}" produced stderr: ${stderr}`);

app-config-exec/tsconfig.json

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

app-config-extensions/src/index.ts

@@ -19,6 +19,7 @@ import {
 import {
   currentEnvironment,
   defaultAliases,
+  resolveFilepath,
   EnvironmentAliases,
   FileSource,
 } from '@app-config/node';
@@ -343,18 +344,7 @@ function fileReferenceDirective(keyName: string, meta: ParsedValueMetadata): Par
       },
       (value) => async (_, __, context, extensions) => {
         const retrieveFile = async (filepath: string, subselector?: string, isOptional = false) => {
-          let resolvedPath = filepath;
-
-          // resolve filepaths that are relative to the current FileSource
-          if (!isAbsolute(filepath) && context instanceof FileSource) {
-            resolvedPath = join(dirname(context.filePath), filepath);
-
-            if (resolve(context.filePath) === resolvedPath) {
-              throw new AppConfigError(
-                `A ${keyName} directive resolved to it's own file (${resolvedPath}). Please use $extendsSelf instead.`,
-              );
-            }
-          }
+          const resolvedPath = resolveFilepath(context, filepath);
 
           logger.verbose(`Loading file for ${keyName}: ${resolvedPath}`);
 

app-config-node/src/file-source.ts

@@ -1,11 +1,12 @@
-import { resolve } from 'path';
+import { isAbsolute, join, dirname, resolve } from 'path';
 import { readFile, pathExists } from 'fs-extra';
 import {
   filePathAssumedType,
   ConfigSource,
   FileType,
   ParsedValue,
   ParsingExtension,
+  AppConfigError,
   NotFoundError,
 } from '@app-config/core';
 import { logger } from '@app-config/logging';
@@ -95,3 +96,18 @@ export class FlexibleFileSource extends ConfigSource {
     return source.read(extensions);
   }
 }
+
+export function resolveFilepath(context: ConfigSource, filepath: string) {
+  let resolvedPath = filepath;
+
+  // resolve filepaths that are relative to the current FileSource
+  if (!isAbsolute(filepath) && context instanceof FileSource) {
+    resolvedPath = join(dirname(context.filePath), filepath);
+
+    if (resolve(context.filePath) === resolvedPath) {
+      throw new AppConfigError(`An extension tried to resolve to it's own file (${resolvedPath}).`);
+    }
+  }
+
+  return resolvedPath;
+}

app-config-node/src/index.ts

@@ -1,4 +1,4 @@
-export { FileSource, FlexibleFileSource } from './file-source';
+export { FileSource, FlexibleFileSource, resolveFilepath } from './file-source';
 export { currentEnvironment, defaultAliases, EnvironmentAliases } from './environment';
 export { EnvironmentSource } from './environment-source';
 export { promptUser, promptUserWithRetry, consumeStdin } from './prompts';