Merge pull request #814 from MatrixAI/feature-unix-write

Implement handler to wrap `fs.writeFile` functionality
MatrixAI · Sep 30, 2024 · 5b78ce1 · 5b78ce1
2 parents 387e2e3 + 8fb019a
commit 5b78ce1
Show file tree

Hide file tree

Showing 8 changed files with 163 additions and 109 deletions.
diff --git a/src/client/callers/index.ts b/src/client/callers/index.ts
@@ -63,7 +63,6 @@ import vaultsPermissionUnset from './vaultsPermissionUnset';
 import vaultsPull from './vaultsPull';
 import vaultsRename from './vaultsRename';
 import vaultsScan from './vaultsScan';
-import vaultsSecretsEdit from './vaultsSecretsEdit';
 import vaultsSecretsEnv from './vaultsSecretsEnv';
 import vaultsSecretsGet from './vaultsSecretsGet';
 import vaultsSecretsList from './vaultsSecretsList';
@@ -73,6 +72,7 @@ import vaultsSecretsNewDir from './vaultsSecretsNewDir';
 import vaultsSecretsRename from './vaultsSecretsRename';
 import vaultsSecretsRemove from './vaultsSecretsRemove';
 import vaultsSecretsStat from './vaultsSecretsStat';
+import vaultsSecretsWriteFile from './vaultsSecretsWriteFile';
 import vaultsVersion from './vaultsVersion';
 
 /**
@@ -144,7 +144,6 @@ const clientManifest = {
   vaultsPull,
   vaultsRename,
   vaultsScan,
-  vaultsSecretsEdit,
   vaultsSecretsEnv,
   vaultsSecretsGet,
   vaultsSecretsList,
@@ -154,6 +153,7 @@ const clientManifest = {
   vaultsSecretsRename,
   vaultsSecretsRemove,
   vaultsSecretsStat,
+  vaultsSecretsWriteFile,
   vaultsVersion,
 };
 
@@ -224,7 +224,6 @@ export {
   vaultsPull,
   vaultsRename,
   vaultsScan,
-  vaultsSecretsEdit,
   vaultsSecretsEnv,
   vaultsSecretsGet,
   vaultsSecretsList,
@@ -234,5 +233,6 @@ export {
   vaultsSecretsRename,
   vaultsSecretsRemove,
   vaultsSecretsStat,
+  vaultsSecretsWriteFile,
   vaultsVersion,
 };
diff --git a/src/client/callers/vaultsSecretsEdit.ts b/src/client/callers/vaultsSecretsEdit.ts
diff --git a/src/client/callers/vaultsSecretsWriteFile.ts b/src/client/callers/vaultsSecretsWriteFile.ts
@@ -0,0 +1,12 @@
+import type { HandlerTypes } from '@matrixai/rpc';
+import type VaultsSecretsWriteFile from '../handlers/VaultsSecretsWriteFile';
+import { UnaryCaller } from '@matrixai/rpc';
+
+type CallerTypes = HandlerTypes<VaultsSecretsWriteFile>;
+
+const vaultsSecretsWriteFile = new UnaryCaller<
+  CallerTypes['input'],
+  CallerTypes['output']
+>();
+
+export default vaultsSecretsWriteFile;
diff --git a/src/client/handlers/VaultsSecretsEdit.ts → ...client/handlers/VaultsSecretsWriteFile.ts b/src/client/handlers/VaultsSecretsEdit.ts → ...client/handlers/VaultsSecretsWriteFile.ts
@@ -11,7 +11,7 @@ import * as vaultsUtils from '../../vaults/utils';
 import * as vaultsErrors from '../../vaults/errors';
 import * as vaultOps from '../../vaults/VaultOps';
 
-class VaultsSecretsEdit extends UnaryHandler<
+class VaultsSecretsWriteFile extends UnaryHandler<
   {
     vaultManager: VaultManager;
     db: DB;
@@ -37,7 +37,7 @@ class VaultsSecretsEdit extends UnaryHandler<
       await vaultManager.withVaults(
         [vaultId],
         async (vault) => {
-          await vaultOps.updateSecret(vault, input.secretName, secretContent);
+          await vaultOps.writeSecret(vault, input.secretName, secretContent);
         },
         tran,
       );
@@ -48,4 +48,4 @@ class VaultsSecretsEdit extends UnaryHandler<
   };
 }
 
-export default VaultsSecretsEdit;
+export default VaultsSecretsWriteFile;
diff --git a/src/client/handlers/index.ts b/src/client/handlers/index.ts
@@ -80,7 +80,6 @@ import VaultsPermissionUnset from './VaultsPermissionUnset';
 import VaultsPull from './VaultsPull';
 import VaultsRename from './VaultsRename';
 import VaultsScan from './VaultsScan';
-import VaultsSecretsEdit from './VaultsSecretsEdit';
 import VaultsSecretsEnv from './VaultsSecretsEnv';
 import VaultsSecretsGet from './VaultsSecretsGet';
 import VaultsSecretsList from './VaultsSecretsList';
@@ -90,6 +89,7 @@ import VaultsSecretsNewDir from './VaultsSecretsNewDir';
 import VaultsSecretsRename from './VaultsSecretsRename';
 import VaultsSecretsRemove from './VaultsSecretsRemove';
 import VaultsSecretsStat from './VaultsSecretsStat';
+import VaultsSecretsWriteFile from './VaultsSecretsWriteFile';
 import VaultsVersion from './VaultsVersion';
 
 /**
@@ -184,7 +184,6 @@ const serverManifest = (container: {
     vaultsPull: new VaultsPull(container),
     vaultsRename: new VaultsRename(container),
     vaultsScan: new VaultsScan(container),
-    vaultsSecretsEdit: new VaultsSecretsEdit(container),
     vaultsSecretsEnv: new VaultsSecretsEnv(container),
     vaultsSecretsGet: new VaultsSecretsGet(container),
     vaultsSecretsList: new VaultsSecretsList(container),
@@ -194,6 +193,7 @@ const serverManifest = (container: {
     vaultsSecretsRename: new VaultsSecretsRename(container),
     vaultsSecretsRemove: new VaultsSecretsRemove(container),
     vaultsSecretsStat: new VaultsSecretsStat(container),
+    vaultsSecretsWriteFile: new VaultsSecretsWriteFile(container),
     vaultsVersion: new VaultsVersion(container),
   };
 };
@@ -266,7 +266,6 @@ export {
   VaultsPull,
   VaultsRename,
   VaultsScan,
-  VaultsSecretsEdit,
   VaultsSecretsEnv,
   VaultsSecretsGet,
   VaultsSecretsList,
@@ -276,5 +275,6 @@ export {
   VaultsSecretsRename,
   VaultsSecretsRemove,
   VaultsSecretsStat,
+  VaultsSecretsWriteFile,
   VaultsVersion,
 };
diff --git a/src/vaults/VaultOps.ts b/src/vaults/VaultOps.ts
@@ -263,6 +263,21 @@ async function listSecrets(vault: Vault): Promise<string[]> {
   });
 }
 
+/**
+ * Changes the contents of a secret. Creates a new file if it doesn't exist.
+ */
+async function writeSecret(
+  vault: Vault,
+  secretName: string,
+  content: Buffer | string,
+  logger?: Logger,
+): Promise<void> {
+  await vault.writeF(async (efs) => {
+    await efs.writeFile(secretName, content);
+  });
+  logger?.info(`Wrote secret ${secretName} in vault ${vault.vaultId}`);
+}
+
 export {
   addSecret,
   updateSecret,
@@ -273,4 +288,5 @@ export {
   mkdir,
   addSecretDirectory,
   listSecrets,
+  writeSecret,
 };