Merge pull request #918 from MatrixAI/feature-secrets-env-egress-schema

`vaultsSecretsEnv` no longer cancels on missing secret

Author: aryanjassal

src/client/handlers/VaultsSecretsEnv.ts

@@ -5,20 +5,19 @@ import type {
   ClientRPCRequestParams,
   ClientRPCResponseResult,
   SecretIdentifierMessage,
-  SecretContentMessage,
+  SecretContentOrErrorMessage,
 } from '../types.js';
 import type VaultManager from '../../vaults/VaultManager.js';
 import { DuplexHandler } from '@matrixai/rpc';
 import * as vaultsUtils from '../../vaults/utils.js';
-import * as vaultsErrors from '../../vaults/errors.js';
 
 class VaultsSecretsEnv extends DuplexHandler<
   {
     db: DB;
     vaultManager: VaultManager;
   },
   ClientRPCRequestParams<SecretIdentifierMessage>,
-  ClientRPCResponseResult<SecretContentMessage>
+  ClientRPCResponseResult<SecretContentOrErrorMessage>
 > {
   public handle = async function* (
     input: AsyncIterableIterator<
@@ -27,64 +26,73 @@ class VaultsSecretsEnv extends DuplexHandler<
     _cancel: (reason?: any) => void,
     _meta: Record<string, JSONValue> | undefined,
     ctx: ContextTimed,
-  ): AsyncGenerator<ClientRPCResponseResult<SecretContentMessage>> {
+  ): AsyncGenerator<
+    ClientRPCResponseResult<SecretContentOrErrorMessage>,
+    void,
+    void
+  > {
     const { db, vaultManager }: { db: DB; vaultManager: VaultManager } =
       this.container;
     return yield* db.withTransactionG(async function* (tran): AsyncGenerator<
-      ClientRPCResponseResult<SecretContentMessage>
+      ClientRPCResponseResult<SecretContentOrErrorMessage>,
+      void,
+      void
     > {
       for await (const secretIdentifierMessage of input) {
         const { nameOrId, secretName } = secretIdentifierMessage;
         const vaultIdFromName = await vaultManager.getVaultId(nameOrId, tran);
         const vaultId = vaultIdFromName ?? vaultsUtils.decodeVaultId(nameOrId);
         if (vaultId == null) {
-          throw new vaultsErrors.ErrorVaultsVaultUndefined(
-            `Vault "${nameOrId}" does not exist`,
-          );
+          yield {
+            type: 'ErrorMessage',
+            code: 'EINVAL',
+            reason: `Vault "${nameOrId}" does not exist`,
+            data: { secretName: undefined, nameOrId },
+          };
+          continue;
         }
-        const secrets = await vaultManager.withVaults(
+        yield* vaultManager.withVaultsG(
           [vaultId],
-          async (vault) => {
-            const results: Array<{
-              filePath: string;
-              value: string;
-            }> = [];
-            return await vault.readF(async (fs) => {
+          async function* (
+            vault,
+          ): AsyncGenerator<SecretContentOrErrorMessage, void, void> {
+            yield* vault.readG(async function* (efs): AsyncGenerator<
+              SecretContentOrErrorMessage,
+              void,
+              void
+            > {
               try {
                 for await (const filePath of vaultsUtils.walkFs(
-                  fs,
+                  efs,
                   secretName,
                 )) {
                   ctx.signal.throwIfAborted();
-                  const fileContents = await fs.readFile(filePath);
-                  results.push({
-                    filePath: filePath,
-                    value: fileContents.toString(),
-                  });
+                  const fileContents = await efs.readFile(filePath);
+                  yield {
+                    type: 'SuccessMessage',
+                    success: true,
+                    nameOrId: nameOrId,
+                    secretName: filePath,
+                    secretContent: fileContents.toString(),
+                  };
                 }
               } catch (e) {
                 if (e.code === 'ENOENT') {
-                  throw new vaultsErrors.ErrorSecretsSecretUndefined(
-                    `Secret with name: ${secretName} does not exist`,
-                    { cause: e },
-                  );
+                  yield {
+                    type: 'ErrorMessage',
+                    code: e.code,
+                    reason: `Secret "${secretName}" does not exist`,
+                    data: { secretName, nameOrId },
+                  };
+                } else {
+                  throw e;
                 }
-                throw e;
               }
-              return results;
             });
           },
           tran,
           ctx,
         );
-        for (const { filePath, value } of secrets) {
-          ctx.signal.throwIfAborted();
-          yield {
-            nameOrId: nameOrId,
-            secretName: filePath,
-            secretContent: value,
-          };
-        }
       }
     });
   };

src/client/types.ts

@@ -345,6 +345,13 @@ type ContentOrErrorMessage = ContentSuccessMessage | ErrorMessageTagged;
 
 type SecretContentMessage = SecretIdentifierMessage & ContentMessage;
 
+type SecretContentSuccessMessage = SecretIdentifierMessage &
+  ContentSuccessMessage;
+
+type SecretContentOrErrorMessage =
+  | SecretContentSuccessMessage
+  | ErrorMessageTagged;
+
 type SecretDirMessage = VaultIdentifierMessage & {
   dirName: string;
 };
@@ -462,9 +469,11 @@ export type {
   SecretPathMessage,
   SecretIdentifierMessage,
   ContentMessage,
+  SecretContentMessage,
   ContentSuccessMessage,
   ContentOrErrorMessage,
-  SecretContentMessage,
+  SecretContentSuccessMessage,
+  SecretContentOrErrorMessage,
   SecretDirMessage,
   SecretRenameMessage,
   SecretFilesMessage,