Merge pull request #22 from Mermaid-Chart/feat/support-loading-tokens-from-environment-variables

aloisklink · web-flow · commit ce94af61940f · 2024-04-22T13:07:28.000+09:00
feat(cli): support reading auth token in CLI with `--auth-token` and in ENV with `MERMAID_CHART_AUTH_TOKEN`
diff --git a/cSpell.json b/cSpell.json
@@ -5,6 +5,7 @@
     "Cataa",
     "colour",
     "Cookiebot",
+    "ENONET",
     "gantt",
     "jsnext",
     "lintstagedrc",
diff --git a/packages/cli/src/commander.test.ts b/packages/cli/src/commander.test.ts
@@ -1,4 +1,4 @@
-import { beforeAll, beforeEach, describe, expect, vi, it, type Mock } from 'vitest';
+import { afterEach, beforeAll, beforeEach, describe, expect, vi, it, type Mock } from 'vitest';
 import { createCommanderCommand } from './commander.js';
 import { copyFile, mkdir, readFile, rm } from 'node:fs/promises';
 import type { Command, CommanderError, OutputConfiguration } from '@commander-js/extra-typings';
@@ -106,6 +106,10 @@ describe('--version', () => {
 });
 
 describe('whoami', () => {
+  afterEach(() => {
+    vi.unstubAllEnvs();
+  });
+
   it('should error if --config file does not exist', async () => {
     const { program } = mockedProgram();
 
@@ -136,6 +140,21 @@ describe('whoami', () => {
     ).rejects.toThrowError('Invalid access token.');
   });
 
+  it('--auth-token should override config file and environment variables', async () => {
+    const { program } = mockedProgram();
+
+    const myCliAuthToken = 'my-cli-auth-token';
+
+    vi.stubEnv('MERMAID_CHART_AUTH_TOKEN', 'my-env-auth-token');
+
+    await program.parseAsync(
+      ['--config', CONFIG_AUTHED, '--auth-token', myCliAuthToken, 'whoami'],
+      { from: 'user' },
+    );
+
+    expect(vi.mocked(MermaidChart.prototype.setAccessToken)).toHaveBeenCalledWith(myCliAuthToken);
+  });
+
   it('should print email of logged in user', async () => {
     const { program } = mockedProgram();
 
@@ -144,6 +163,21 @@ describe('whoami', () => {
 
     expect(consoleLogSpy).toBeCalledWith(mockedMCUser.emailAddress);
   });
+
+  it('should support loading auth from environment variables', async () => {
+    const { program } = mockedProgram();
+
+    const authToken = 'my-api-key-from-env-var';
+    vi.stubEnv('MERMAID_CHART_AUTH_TOKEN', authToken);
+    vi.stubEnv('MERMAID_CHART_BASE_URL', 'https://test.mermaidchart.invalid');
+
+    const consoleLogSpy = vi.spyOn(global.console, 'log');
+    await program.parseAsync(['--config', CONFIG_AUTHED, 'whoami'], { from: 'user' });
+
+    // environment variables should override config file
+    expect(vi.mocked(MermaidChart.prototype.setAccessToken)).toHaveBeenCalledWith(authToken);
+    expect(consoleLogSpy).toBeCalledWith(mockedMCUser.emailAddress);
+  });
 });
 
 describe('login', () => {
@@ -189,7 +223,9 @@ describe('logout', () => {
 
     await expect(readFile(configFile, { encoding: 'utf8' })).resolves.not.toContain('my-api-key');
 
-    expect(consoleLogSpy).toBeCalledWith(`API token removed from ${configFile}`);
+    expect(consoleLogSpy).toBeCalledWith(
+      `API token for ${mockedMCUser.emailAddress} removed from ${configFile}`,
+    );
   });
 });
 
diff --git a/packages/cli/src/commander.ts b/packages/cli/src/commander.ts
@@ -3,14 +3,15 @@ import {
   CommanderError,
   createCommand,
   InvalidArgumentError,
+  Option,
 } from '@commander-js/extra-typings';
 import { readFile, writeFile } from 'fs/promises';
 import { MermaidChart } from '@mermaidchart/sdk';
 import { createRequire } from 'node:module';
 import confirm from '@inquirer/confirm';
 import input from '@inquirer/input';
 import select, { Separator } from '@inquirer/select';
-import { type Config, defaultConfigPath, readConfig, writeConfig } from './config.js';
+import { defaultConfigPath, readConfig, writeConfig, optionNameMap } from './config.js';
 import { type Cache, link, type LinkOptions, pull, push } from './methods.js';
 import { processMarkdown } from './remark.js';
 
@@ -25,31 +26,40 @@ import { processMarkdown } from './remark.js';
  */
 type CommonOptions = ReturnType<ReturnType<typeof createCommanderCommand>['opts']>;
 
-async function createClient(options: CommonOptions, config?: Config) {
-  if (config === undefined) {
-    try {
-      config = await readConfig(options['config']);
-    } catch (error) {
-      if (
-        error instanceof Error &&
-        'errno' in error &&
-        (error as NodeJS.ErrnoException).code === 'ENOENT' &&
-        options['config'] === defaultConfigPath()
-      ) {
-        config = {};
-      }
-      throw new InvalidArgumentError(
-        `Failed to load config file ${options['config']} due to: ${error}`,
-      );
+/**
+ * Reads the config file from the given `--config <configPath>` argument, ignoring
+ * ENONET errors if `ignoreENONET` is `true`.
+ *
+ * @param configPath - The path to the config file.
+ * @param ignoreENONET - Whether to ignore ENONET errors.
+ * @throws {@link InvalidArgumentError}
+ * Thrown if:
+ *  - The config file exists, but is not a valid TOML file.
+ *  - The config file does not exist, and `ignoreENONET` is `false`.
+ */
+async function readConfigFromConfigArg(configPath: string, ignoreENONET: boolean = false) {
+  try {
+    return await readConfig(configPath);
+  } catch (error) {
+    if (
+      error instanceof Error &&
+      'errno' in error &&
+      (error as NodeJS.ErrnoException).code === 'ENOENT' &&
+      ignoreENONET
+    ) {
+      return {};
     }
+    throw new InvalidArgumentError(`Failed to load config file ${configPath} due to: ${error}`);
   }
+}
 
+async function createClient(options: CommonOptions) {
   const client = new MermaidChart({
     clientID: '018bf0ff-7e8c-7952-ab4e-a7bd7c7f54f3',
-    baseURL: new URL(config.base_url ?? 'https://mermaidchart.com').toString(),
+    baseURL: options.baseUrl,
   });
 
-  if (config.auth_token === undefined) {
+  if (options.authToken === undefined) {
     throw new CommanderError(
       /*exitCode=*/ 1,
       'ENEEDAUTH',
@@ -58,7 +68,7 @@ async function createClient(options: CommonOptions, config?: Config) {
   }
 
   try {
-    await client.setAccessToken(config.auth_token);
+    await client.setAccessToken(options.authToken);
   } catch (error) {
     if (error instanceof Error && error.message.includes('401')) {
       throw new CommanderError(
@@ -90,32 +100,22 @@ function login() {
     .description('Login to a Mermaid Chart account')
     .action(async (_options, command) => {
       const optsWithGlobals = command.optsWithGlobals<CommonOptions>();
-      let config;
-      try {
-        config = await readConfig(optsWithGlobals['config']);
-      } catch (error) {
-        if (
-          error instanceof Error &&
-          'errno' in error &&
-          (error as NodeJS.ErrnoException).code === 'ENOENT'
-        ) {
-          config = {};
-        } else {
-          throw error;
-        }
-      }
 
-      const baseURL = new URL(config.base_url ?? 'https://mermaidchart.com').toString();
+      // empty if default config file doesn't exist
+      const config = await readConfigFromConfigArg(
+        optsWithGlobals['config'],
+        /*ignoreENONET=*/ true,
+      );
 
       const client = new MermaidChart({
         clientID: '018bf0ff-7e8c-7952-ab4e-a7bd7c7f54f3',
-        baseURL: baseURL,
+        baseURL: optsWithGlobals.baseUrl,
       });
 
       const answer = await input({
         message: `Enter your API token. You can generate one at ${new URL(
           '/app/user/settings',
-          baseURL,
+          optsWithGlobals.baseUrl,
         )}`,
         async validate(key) {
           try {
@@ -149,7 +149,7 @@ function logout() {
       await writeConfig(optsWithGlobals['config'], config);
 
       try {
-        const user = await (await createClient(optsWithGlobals, config)).getUser();
+        const user = await (await createClient(optsWithGlobals)).getUser();
         console.log(`API token for ${user.emailAddress} removed from ${optsWithGlobals['config']}`);
       } catch (error) {
         // API token might have been expired
@@ -297,7 +297,46 @@ export function createCommanderCommand() {
       '-c, --config <config_file>',
       'The path to the config file to use.',
       defaultConfigPath(),
-    );
+    )
+    .addOption(
+      new Option('--base-url <base_url>', 'The base URL of the Mermaid Chart instance to use.')
+        .default('https://mermaidchart.com')
+        .env('MERMAID_CHART_BASE_URL'),
+    )
+    .addOption(
+      new Option('--auth-token <auth_token>', 'The Mermaid Chart API token to use.').env(
+        'MERMAID_CHART_AUTH_TOKEN',
+      ),
+    )
+    .hook('preSubcommand', async (command, actionCommand) => {
+      const configPath = command.getOptionValue('config');
+      /**
+       * config file is allowed to not exist if:
+       *   - the user is running the `login` command, we'll create a new config file if it doesn't exist
+       */
+      const ignoreENONET = configPath === defaultConfigPath() || actionCommand.name() === 'login';
+
+      const config = await readConfigFromConfigArg(configPath, ignoreENONET);
+      for (const key in config) {
+        if (!(key in optionNameMap)) {
+          console.warn(`Warning: Ignoring unrecognized config key: ${key} in ${configPath}`);
+          continue;
+        }
+        const optionCommanderName = optionNameMap[key as keyof typeof optionNameMap];
+        // config values only override default/implied values
+        if (
+          [undefined, 'default', 'implied'].includes(
+            command.getOptionValueSource(optionCommanderName),
+          )
+        ) {
+          command.setOptionValueWithSource(
+            optionNameMap[key as keyof typeof optionNameMap],
+            config[key],
+            'config',
+          );
+        }
+      }
+    });
 
   return program
     .addCommand(whoami())
diff --git a/packages/cli/src/config.ts b/packages/cli/src/config.ts
@@ -38,6 +38,19 @@ export function defaultConfigPath() {
   return join(userConfigDir(), 'mermaid-chart.toml');
 }
 
+/**
+ * Maps the TOML keys to the Commander option names.
+ *
+ * Commander uses:
+ *   - kebab-case for CLI options, but
+ *   - camelCase for option names in JavaScript,
+ * while TOML uses snake_case.
+ */
+export const optionNameMap = {
+  auth_token: 'authToken',
+  base_url: 'baseUrl',
+} as const;
+
 export interface Config extends JsonMap {
   /**
    * Mermaid-Chart API token.
