Merge pull request #50 from MatrixAI/feature-stdout-fix

Fixing outputFormatter and standardising STDOUT
MatrixAI · Nov 8, 2023 · 550c32f · 550c32f
2 parents 485ea68 + 37db593
commit 550c32f
Show file tree

Hide file tree

Showing 29 changed files with 501 additions and 255 deletions.
diff --git a/src/identities/CommandPermissions.ts b/src/identities/CommandPermissions.ts
@@ -52,7 +52,7 @@ class CommandPermissions extends CommandPolykey {
           logger: this.logger.getChild(PolykeyClient.name),
         });
         const [type, id] = gestaltId;
-        let actions: string[] = [];
+        let actions: Array<string> = [];
         switch (type) {
           case 'node':
             {

diff --git a/src/keys/CommandCert.ts b/src/keys/CommandCert.ts
@@ -54,7 +54,7 @@ class CommandCert extends CommandPolykey {
         };
         let output: any = result;
         if (options.format === 'human') {
-          output = [`Root certificate:\t\t${result.cert}`];
+          output = ['Root certificate:', result.cert];
         }
         process.stdout.write(
           binUtils.outputFormatter({

diff --git a/src/keys/CommandCertchain.ts b/src/keys/CommandCertchain.ts
@@ -57,7 +57,7 @@ class CommandsCertchain extends CommandPolykey {
         };
         let output: any = result;
         if (options.format === 'human') {
-          output = [`Root Certificate Chain:\t\t${result.certchain}`];
+          output = ['Root Certificate Chain:', ...result.certchain];
         }
         process.stdout.write(
           binUtils.outputFormatter({

diff --git a/src/keys/CommandDecrypt.ts b/src/keys/CommandDecrypt.ts
@@ -76,7 +76,7 @@ class CommandDecrypt extends CommandPolykey {
         };
         let output: any = result;
         if (options.format === 'human') {
-          output = [`Decrypted data:\t\t${result.decryptedData}`];
+          output = [`Decrypted data:${' '.repeat(4)}${result.decryptedData}`];
         }
         process.stdout.write(
           binUtils.outputFormatter({

diff --git a/src/keys/CommandEncrypt.ts b/src/keys/CommandEncrypt.ts
@@ -103,7 +103,7 @@ class CommandEncypt extends CommandPolykey {
         };
         let output: any = result;
         if (options.format === 'human') {
-          output = [`Encrypted data:\t\t${result.encryptedData}`];
+          output = [`Encrypted data:${' '.repeat(4)}${result.encryptedData}`];
         }
         process.stdout.write(
           binUtils.outputFormatter({

diff --git a/src/keys/CommandSign.ts b/src/keys/CommandSign.ts
@@ -76,7 +76,7 @@ class CommandSign extends CommandPolykey {
         };
         let output: any = result;
         if (options.format === 'human') {
-          output = [`Signature:\t\t${result.signature}`];
+          output = [`Signature:${' '.repeat(4)}${result.signature}`];
         }
         process.stdout.write(
           binUtils.outputFormatter({

diff --git a/src/keys/CommandVerify.ts b/src/keys/CommandVerify.ts
@@ -112,7 +112,9 @@ class CommandVerify extends CommandPolykey {
         };
         let output: any = result;
         if (options.format === 'human') {
-          output = [`Signature verified:\t\t${result.signatureVerified}`];
+          output = [
+            `Signature verified:${' '.repeat(4)}${result.signatureVerified}`,
+          ];
         }
         process.stdout.write(
           binUtils.outputFormatter({

diff --git a/src/nodes/CommandClaim.ts b/src/nodes/CommandClaim.ts
@@ -65,25 +65,25 @@ class CommandClaim extends CommandPolykey {
         );
         const claimed = response.success;
         if (claimed) {
-          const formattedOutput = await binUtils.outputFormatter({
+          const outputFormatted = binUtils.outputFormatter({
             type: options.format === 'json' ? 'json' : 'list',
             data: [
               `Successfully generated a cryptolink claim on Keynode with ID ${nodesUtils.encodeNodeId(
                 nodeId,
               )}`,
             ],
           });
-          process.stdout.write(formattedOutput);
+          process.stdout.write(outputFormatted);
         } else {
-          const formattedOutput = await binUtils.outputFormatter({
+          const outputFormatted = binUtils.outputFormatter({
             type: options.format === 'json' ? 'json' : 'list',
             data: [
               `Successfully sent Gestalt Invite notification to Keynode with ID ${nodesUtils.encodeNodeId(
                 nodeId,
               )}`,
             ],
           });
-          process.stdout.write(formattedOutput);
+          process.stdout.write(outputFormatted);
         }
       } finally {
         if (pkClient! != null) await pkClient.stop();

diff --git a/src/nodes/CommandConnections.ts b/src/nodes/CommandConnections.ts
@@ -59,28 +59,29 @@ class CommandAdd extends CommandPolykey {
         }, auth);
         if (options.format === 'human') {
           // Wait for outputFormatter to complete and then write to stdout
-          const formattedOutput = await binUtils.outputFormatter({
+          const outputFormatted = binUtils.outputFormatter({
             type: 'table',
             data: connections,
             options: {
-              headers: [
+              columns: [
                 'host',
                 'hostname',
                 'nodeIdEncoded',
                 'port',
                 'timeout',
                 'usageCount',
               ],
+              includeHeaders: true,
             },
           });
-          process.stdout.write(formattedOutput);
+          process.stdout.write(outputFormatted);
         } else {
           // Wait for outputFormatter to complete and then write to stdout
-          const formattedOutput = await binUtils.outputFormatter({
+          const outputFormatted = binUtils.outputFormatter({
             type: 'json',
             data: connections,
           });
-          process.stdout.write(formattedOutput);
+          process.stdout.write(outputFormatted);
         }
       } finally {
         if (pkClient! != null) await pkClient.stop();

diff --git a/src/nodes/CommandFind.ts b/src/nodes/CommandFind.ts
@@ -90,11 +90,11 @@ class CommandFind extends CommandPolykey {
         }
         let output: any = result;
         if (options.format === 'human') output = [result.message];
-        const formattedOutput = await binUtils.outputFormatter({
+        const outputFormatted = binUtils.outputFormatter({
           type: options.format === 'json' ? 'json' : 'list',
           data: output,
         });
-        process.stdout.write(formattedOutput);
+        process.stdout.write(outputFormatted);
         // Like ping it should error when failing to find node for automation reasons.
         if (!result.success) {
           throw new errors.ErrorPolykeyCLINodeFindFailed(result.message);

diff --git a/src/nodes/CommandGetAll.ts b/src/nodes/CommandGetAll.ts
@@ -60,11 +60,11 @@ class CommandGetAll extends CommandPolykey {
               `NodeId ${value.nodeIdEncoded}, Address ${value.host}:${value.port}, bucketIndex ${value.bucketIndex}`,
           );
         }
-        const formattedOutput = await binUtils.outputFormatter({
+        const outputFormatted = binUtils.outputFormatter({
           type: options.format === 'json' ? 'json' : 'list',
           data: output,
         });
-        process.stdout.write(formattedOutput);
+        process.stdout.write(outputFormatted);
       } finally {
         if (pkClient! != null) await pkClient.stop();
       }

diff --git a/src/nodes/CommandPing.ts b/src/nodes/CommandPing.ts
@@ -68,11 +68,11 @@ class CommandPing extends CommandPolykey {
         else status.message = error.message;
         const output: any =
           options.format === 'json' ? status : [status.message];
-        const formattedOutput = await binUtils.outputFormatter({
+        const outputFormatted = binUtils.outputFormatter({
           type: options.format === 'json' ? 'json' : 'list',
           data: output,
         });
-        process.stdout.write(formattedOutput);
+        process.stdout.write(outputFormatted);
 
         if (error != null) throw error;
       } finally {

diff --git a/src/notifications/CommandRead.ts b/src/notifications/CommandRead.ts
@@ -79,11 +79,11 @@ class CommandRead extends CommandPolykey {
           notifications.push(notification);
         }
         for (const notification of notifications) {
-          const formattedOutput = await binUtils.outputFormatter({
+          const outputFormatted = binUtils.outputFormatter({
             type: options.format === 'json' ? 'json' : 'dict',
             data: notification,
           });
-          process.stdout.write(formattedOutput);
+          process.stdout.write(outputFormatted);
         }
       } finally {
         if (pkClient! != null) await pkClient.stop();

diff --git a/src/secrets/CommandGet.ts b/src/secrets/CommandGet.ts
@@ -58,12 +58,14 @@ class CommandGet extends CommandPolykey {
             }),
           meta,
         );
-        const secretContent = Buffer.from(response.secretContent, 'binary');
-        const formattedOutput = await binUtils.outputFormatter({
+        const secretContent = response.secretContent;
+        const outputFormatted = binUtils.outputFormatter({
           type: 'raw',
-          data: secretContent,
+          data: binUtils.encodeEscapedWrapped(secretContent)
+            ? binUtils.encodeEscaped(secretContent)
+            : secretContent,
         });
-        process.stdout.write(formattedOutput);
+        process.stdout.write(outputFormatted);
       } finally {
         if (pkClient! != null) await pkClient.stop();
       }

diff --git a/src/secrets/CommandList.ts b/src/secrets/CommandList.ts
@@ -57,12 +57,12 @@ class CommandList extends CommandPolykey {
           return data;
         }, auth);
 
-        const formattedOutput = await binUtils.outputFormatter({
+        const outputFormatted = binUtils.outputFormatter({
           type: options.format === 'json' ? 'json' : 'list',
           data: data,
         });
 
-        process.stdout.write(formattedOutput);
+        process.stdout.write(outputFormatted);
       } finally {
         if (pkClient! != null) await pkClient.stop();
       }

diff --git a/src/secrets/CommandStat.ts b/src/secrets/CommandStat.ts
@@ -60,18 +60,18 @@ class CommandStat extends CommandPolykey {
           meta,
         );
 
-        const data: string[] = [`Stats for "${secretPath[1]}"`];
+        const data: Array<string> = [`Stats for "${secretPath[1]}"`];
         for (const [key, value] of Object.entries(response.stat)) {
           data.push(`${key}: ${value}`);
         }
 
         // Assuming the surrounding function is async
-        const formattedOutput = await binUtils.outputFormatter({
+        const outputFormatted = binUtils.outputFormatter({
           type: options.format === 'json' ? 'json' : 'list',
           data,
         });
 
-        process.stdout.write(formattedOutput);
+        process.stdout.write(outputFormatted);
       } finally {
         if (pkClient! != null) await pkClient.stop();
       }

diff --git a/src/types.ts b/src/types.ts
@@ -5,6 +5,14 @@ import type { RecoveryCode } from 'polykey/dist/keys/types';
 import type { StatusLive } from 'polykey/dist/status/types';
 import type { NodeIdEncoded } from 'polykey/dist/ids/types';
 
+type TableRow = Record<string, any>;
+
+interface TableOptions {
+  columns?: Array<string> | Record<string, number>;
+  includeHeaders?: boolean;
+  includeRowCount?: boolean;
+}
+
 type AgentStatusLiveData = Omit<StatusLive['data'], 'nodeId'> & {
   nodeId: NodeIdEncoded;
 };
@@ -40,17 +48,10 @@ type AgentChildProcessOutput =
       error: POJO;
     };
 
-type TableRow = Record<string, any>;
-
-interface TableOptions {
-  headers?: string[];
-  includeRowCount?: boolean;
-}
-
 export type {
+  TableRow,
+  TableOptions,
   AgentStatusLiveData,
   AgentChildProcessInput,
   AgentChildProcessOutput,
-  TableRow,
-  TableOptions,
 };
diff --git a/src/utils/parsers.ts b/src/utils/parsers.ts
@@ -98,8 +98,7 @@ const parseProviderId: (data: string) => ids.ProviderId =
 
 const parseIdentityId: (data: string) => ids.IdentityId =
   validateParserToArgParser(ids.parseIdentityId);
-
-const parseProviderIdList: (data: string) => ids.ProviderId[] =
+const parseProviderIdList: (data: string) => Array<ids.ProviderId> =
   validateParserToArgListParser(ids.parseProviderId);
 
 const parseGestaltAction: (data: string) => 'notify' | 'scan' | 'claim' =