wip: almost added new trimming

[ci skip]

Author: aryanjassal

src/errors.ts

@@ -84,6 +84,11 @@ class ErrorPolykeyCLIUnexpectedError<T> extends ErrorPolykeyCLI<T> {
   exitCode = sysexits.SOFTWARE;
 }
 
+class ErrorPolykeyCLISubprocessFailure<T> extends ErrorPolykeyCLI<T> {
+  static description = 'A subprocess failed to exit gracefully';
+  exitCode = sysexits.UNKNOWN;
+}
+
 class ErrorPolykeyCLINodePath<T> extends ErrorPolykeyCLI<T> {
   static description = 'Cannot derive default node path from unknown platform';
   exitCode = sysexits.USAGE;
@@ -191,6 +196,7 @@ export {
   ErrorPolykeyCLIUncaughtException,
   ErrorPolykeyCLIUnhandledRejection,
   ErrorPolykeyCLIUnexpectedError,
+  ErrorPolykeyCLISubprocessFailure,
   ErrorPolykeyCLIAsynchronousDeadlock,
   ErrorPolykeyCLINodePath,
   ErrorPolykeyCLIClientOptions,

src/secrets/CommandEdit.ts

@@ -120,16 +120,16 @@ class CommandEdit extends CommandPolykey {
           };
           const onError = (e: Error) => {
             cleanup();
-            const error = new errors.ErrorPolykeyCLIEditSecret(
-              `Failed to run command ${process.env.EDITOR}`,
+            const error = new errors.ErrorPolykeyCLISubprocessFailure(
+              `Failed to run command '${process.env.EDITOR}'`,
               { cause: e },
             );
             reject(error);
           };
           const onClose = (code: number | null) => {
             cleanup();
             if (code !== 0) {
-              const error = new errors.ErrorPolykeyCLIEditSecret(
+              const error = new errors.ErrorPolykeyCLISubprocessFailure(
                 `Editor exited with code ${code}`,
               );
               reject(error);

src/secrets/CommandEnv.ts

@@ -1,7 +1,6 @@
 import type PolykeyClient from 'polykey/dist/PolykeyClient';
 import path from 'path';
 import os from 'os';
-import commander from 'commander';
 import * as utils from 'polykey/dist/utils';
 import CommandPolykey from '../CommandPolykey';
 import * as binProcessors from '../utils/processors';
@@ -25,33 +24,18 @@ class CommandEnv extends CommandPolykey {
     this.addOption(binOptions.envDuplicate);
     this.addOption(binOptions.preserveNewline);
     this.argument(
-      '[args...]',
+      '<args...>',
       'command and arguments formatted as [envPaths...][-- cmd [cmdArgs...]]',
       binParsers.parseEnvArgs,
     );
-    this.passThroughOptions(); // Let -- pass through as-is to parse as delimiter for cmd
+    this.passThroughOptions(); // Let '--' pass through as-is
     this.action(
       async (
         args: [Array<[string, string?, string?]>, Array<string>],
         options,
       ) => {
-        // The parser sets the default value for args. If no arguments are
-        // provided, then args is an empty array []. This is different from the
-        // expected structure. This block ensure that the structure is preserved.
-        // Do the same for options.preserveNewline.
-        args = args[0] == null && args[1] == null ? [[], []] : args;
-        options.preserveNewline = options.preserveNewline ?? [];
-
-        // There needs to be at least one argument or preserved argument
-        // provided. Otherwise, print the help text and error out.
-        if (args[0].length === 0 && options.preserveNewline.length === 0) {
-          this.outputHelp()
-          throw new commander.InvalidArgumentError(
-            'You must provide at least one secret path.',
-          );
-        }
         // Remove the -- from the command arguments
-        args[1]?.shift();
+        args[1].shift();
         const { default: PolykeyClient } = await import(
           'polykey/dist/PolykeyClient'
         );
@@ -72,10 +56,6 @@ class CommandEnv extends CommandPolykey {
         //   b. output the env variables in the desired format
 
         const [envVariables, [cmd, ...argv]] = args;
-        // Append the secret paths which we want to preserve the newlines of
-        if (options.preserveNewline) {
-          envVariables.push(...options.preserveNewline);
-        }
         const clientOptions = await binProcessors.processClientOptions(
           options.nodePath,
           options.nodeId,
@@ -187,13 +167,10 @@ class CommandEnv extends CommandPolykey {
               let preserveNewline = false;
               if (options.preserveNewline) {
                 for (const pair of options.preserveNewline) {
-                  // All the secrets from a vault are being exported together
-                  if (pair[1] == null && pair[0] === nameOrId) {
-                    preserveNewline = true;
-                    break;
-                  }
-                  // Individual files are being exported from a vault
-                  if (pair[1] === secretName) {
+                  if (
+                    pair[0] === nameOrId &&
+                    (pair[1] === newName || pair[1] == null)
+                  ) {
                     preserveNewline = true;
                     break;
                   }
@@ -223,11 +200,21 @@ class CommandEnv extends CommandPolykey {
             // If a cmd is provided then we default to exec it
             switch (platform) {
               case 'linux':
-              // Fallthrough
               case 'darwin':
-                {
-                  const { exec } = await import('@matrixai/exec');
+                const { exec } = await import('@matrixai/exec');
+                try {
                   exec.execvp(cmd, argv, envp);
+                } catch (e) {
+                  if ('code' in e && e.code === 'GenericFailure') {
+                    throw new binErrors.ErrorPolykeyCLISubprocessFailure(
+                      `Command failed with error ${e}`,
+                      {
+                        cause: e,
+                        data: { command: [cmd, ...argv] },
+                      },
+                    );
+                  }
+                  throw e;
                 }
                 break;
               default: {

src/utils/options.ts

@@ -327,7 +327,7 @@ const preserveNewline = new commander.Option(
     out.push(binParsers.parseSecretPathEnv(value));
     return out;
   })
-  .default(undefined);
+  .default([]);
 
 export {
   nodePath,

src/utils/parsers.ts

@@ -208,8 +208,8 @@ function parseEnvArgs(
     [],
     [],
   ];
-  console.error('val', value)
-  console.error('cur', current)
+  console.error('value', value)
+  console.error('curent', current)
   if (current[1].length === 0) {
     // Parse a secret path
     if (value !== '--') {
@@ -222,6 +222,11 @@ function parseEnvArgs(
     // Otherwise we just have the cmd args
     current[1].push(value);
   }
+  if (current[0].length === 0 && current[1].length > 0) {
+    throw new commander.InvalidArgumentError(
+      'You must provide at least 1 secret path',
+    );
+  }
   return current;
 }
 

src/utils/utils.ts

@@ -448,7 +448,11 @@ function outputFormatterError(err: any): string {
         }
         output += `${indent}timestamp\t${err.timestamp}\n`;
       } else {
-        output += '\n';
+        if (err.data && !utils.isEmptyObject(err.data)) {
+          output += `\n${indent}data: ${JSON.stringify(err.data)}\n`
+        } else {
+          output += '\n';
+        }
       }
       output += `${indent}cause: `;
       err = err.cause;

tests/secrets/env.test.ts

@@ -741,6 +741,7 @@ describe('commandEnv', () => {
       'unix',
       '--preserve-newline',
       `${vaultName}:${secretName}`,
+      `${vaultName}:${secretName}`,
       '--',
       'node',
       '-e',