adds support for listener in secretsManager #273

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open

nafees87n wants to merge 35 commits into initialization from secrets/storage-listener

src/lib/secretsManager/encryptedStorage/AbstractSecretsManagerStorage.ts

-Original file line number
+Diff line change
@@ -1,5 +1,9 @@
     import { SecretProviderConfig } from "../types";
+    export type StorageChangeCallback = (
+      data: Record<string, SecretProviderConfig>
+    ) => void;
     export abstract class AbstractSecretsManagerStorage {
       abstract set(_key: string, _data: SecretProviderConfig): Promise<void>;
@@ Expand All / @@ -8,4 +12,6 @@ export abstract class AbstractSecretsManagerStorage { @@
       abstract getAll(): Promise<SecretProviderConfig[]>;
       abstract delete(_key: string): Promise<void>;
+      abstract onStorageChange(callback: StorageChangeCallback): () => void;
     }

src/lib/secretsManager/encryptedStorage/SecretsManagerEncryptedStorage.ts

-Original file line number
+Diff line change
@@ -1,4 +1,7 @@
-    import { AbstractSecretsManagerStorage } from "./AbstractSecretsManagerStorage";
+    import {
+      AbstractSecretsManagerStorage,
+      StorageChangeCallback,
+    } from "./AbstractSecretsManagerStorage";
     import { EncryptedElectronStore } from "../../storage/EncryptedElectronStore";
     import { SecretProviderConfig } from "../types";
@@ Expand Down Expand Up @@
       async delete(key: string): Promise<void> {
         return this.encryptedStore.delete(key);
       }
+      onStorageChange(callback: StorageChangeCallback): () => void {
+        return this.encryptedStore.onChange<SecretProviderConfig>(callback);
+      }
     }

src/lib/secretsManager/providerRegistry/AbstractProviderRegistry.ts

-Original file line number
+Diff line change
@@ Expand Up @@
     import { AbstractSecretsManagerStorage } from "../encryptedStorage/AbstractSecretsManagerStorage";
     import { AbstractSecretProvider } from "../providerService/AbstractSecretProvider";
-    /**
-     * Abstract registry for managing secret providers.
-     *
-     * The registry stores provider configurations and maintains instances of providers.
-     * Providers are stored with type erasure but maintain their full type safety
-     * when accessed through type-aware methods.
-     */
+    export type ProviderChangeCallback = (
+      configs: Omit<SecretProviderConfig, "config">[]
+    ) => void;
     export abstract class AbstractProviderRegistry {
       protected store: AbstractSecretsManagerStorage;
-      protected providers: Map<string, AbstractSecretProvider<SecretProviderType>> = new Map();
+      protected providers: Map<string, AbstractSecretProvider<SecretProviderType>> =
+        new Map();
       constructor(store: AbstractSecretsManagerStorage) {
         this.store = store;
@@ Expand All / @@ -28,7 +26,11 @@ export abstract class AbstractProviderRegistry { @@
       abstract deleteProviderConfig(_id: string): Promise<void>;
-      abstract getProvider(_providerId: string): AbstractSecretProvider<SecretProviderType> | null;
+      abstract onProvidersChange(callback: ProviderChangeCallback): () => void;
+      abstract getProvider(
+        _providerId: string
+      ): AbstractSecretProvider<SecretProviderType> | null;
       /**
        * Type-safe method to get a provider with a specific type.
@@ Expand Down @@

src/lib/secretsManager/providerRegistry/FileBasedProviderRegistry.ts

-Original file line number
+Diff line change
@@ -1,11 +1,17 @@
     import { SecretProviderConfig, SecretProviderType } from "../types";
     import { createProviderInstance } from "../providerService/providerFactory";
     import { AbstractSecretProvider } from "../providerService/AbstractSecretProvider";
-    import { AbstractProviderRegistry } from "./AbstractProviderRegistry";
+    import {
+      AbstractProviderRegistry,
+      ProviderChangeCallback,
+    } from "./AbstractProviderRegistry";
     export class FileBasedProviderRegistry extends AbstractProviderRegistry {
+      private changeCallbacks: Set<ProviderChangeCallback> = new Set();
       async initialize(): Promise<void> {
         await this.initProvidersFromStorage();
+        this.setupStorageListener();
       }
       private async initProvidersFromStorage(): Promise<void> {
@@ Expand Down Expand Up @@
       getProvider(providerId: string): AbstractSecretProvider<SecretProviderType> | null {
         return this.providers.get(providerId) ?? null;
       }
+      onProvidersChange(callback: ProviderChangeCallback): () => void {
+        this.changeCallbacks.add(callback);
+        return () => {
+          this.changeCallbacks.delete(callback);
+        };
+      }
+      private setupStorageListener(): void {
+        this.store.onStorageChange((data) => {
+          this.syncProvidersFromStorageData(data);
+          this.notifyChangeCallbacks(data);
+        });
+      }
+      private syncProvidersFromStorageData(
+        data: Record<string, SecretProviderConfig>
+      ): void {
+        const newConfigIds = new Set(Object.keys(data));
+        const existingProviderIds = new Set(this.providers.keys());
+        // Remove providers that no longer exist
+        for (const existingId of existingProviderIds) {
+          if (!newConfigIds.has(existingId)) {
+            this.providers.delete(existingId);
+          }
+        }
+        for (const [id, config] of Object.entries(data)) {
+          try {
+            // recreate provider instance
+            this.providers.set(id, createProviderInstance(config));
+          } catch (error) {
+            console.log(
+              "!!!debug",
+              `Failed to sync provider for config id: ${id}`,
+              error
+            );
+          }
+        }
+      }
+      private notifyChangeCallbacks(
+        data: Record<string, SecretProviderConfig>
+      ): void {
+        this.changeCallbacks.forEach((callback) => {
+          const configsMetadata = Object.values(data).map((config) => {
+            const { config: _, ...metadata } = config;
+            return metadata;
+          });
+          callback(configsMetadata);
+        });
+      }
     }

src/lib/secretsManager/providerService/AbstractSecretProvider.ts

-Original file line number
+Diff line change
@@ Expand Up @@
       abstract testConnection(): Promise<boolean>;
-      abstract getSecret(_ref: ReferenceForProvider<T>): Promise<ValueForProvider<T> | null>;
+      abstract getSecret(
+        _ref: ReferenceForProvider<T>
+      ): Promise<ValueForProvider<T> | null>;
       abstract getSecrets(
         _refs: ReferenceForProvider<T>[]
@@ Expand All @@
       ): Promise<void>;
       abstract setSecrets(
-        _entries: Array<{ ref: ReferenceForProvider<T>; value: string | Record<string, any> }>
+        _entries: Array<{
+          ref: ReferenceForProvider<T>;
+          value: string | Record<string, any>;
+        }>
       ): Promise<void>;
       abstract removeSecret(_ref: ReferenceForProvider<T>): Promise<void>;
       abstract removeSecrets(_refs: ReferenceForProvider<T>[]): Promise<void>;
+      abstract refreshSecrets(): Promise<(ValueForProvider<T> | null)[]>;
+      static validateConfig(config: any): boolean {
+        // Base implementation rejects all configs as a fail-safe.
+        // Provider implementations must override with specific validation.
+        if (!config) {
+          return false;
+        }
+        return false;
+      }
       protected invalidateCache(): void {
         this.cache.clear();
       }
@@ Expand Down Expand Up @@
         keysToDelete.forEach((key) => this.cache.delete(key));
       }
-      abstract refreshSecrets(): Promise<(ValueForProvider<T> | null)[]>;
-      static validateConfig(config: any): boolean {
-        // Base implementation rejects all configs as a fail-safe.
-        // Provider implementations must override with specific validation.
-        if (!config) {
-          return false;
-        }
-        return false;
-      }
     }

src/lib/secretsManager/providerService/awsSecretManagerProvider.ts

-Original file line number
+Diff line change
@@ Expand Up @@
         return Promise.all(refs.map((ref) => this.getSecret(ref)));
       }
-      async setSecret(
-        _ref: AwsSecretReference,
-        _value: string | Record<string, any>
-      ): Promise<void> {
+      async setSecret(): Promise<void> {
         throw new Error("Method not implemented.");
       }
-      async setSecrets(
-        _entries: Array<{ ref: AwsSecretReference; value: string | Record<string, any> }>
-      ): Promise<void> {
+      async setSecrets(): Promise<void> {
         throw new Error("Method not implemented.");
       }
-      async removeSecret(_ref: AwsSecretReference): Promise<void> {
+      async removeSecret(): Promise<void> {
         throw new Error("Method not implemented.");
       }
-      async removeSecrets(_refs: AwsSecretReference[]): Promise<void> {
+      async removeSecrets(): Promise<void> {
         throw new Error("Method not implemented.");
       }
@@ Expand Down @@

src/lib/secretsManager/secretsManager.ts

-Original file line number
+Diff line change
@@ Expand Up / @@ -138,6 +138,20 @@ export class SecretsManager { @@
         return provider.refreshSecrets();
       }
+      async listProviders(): Promise<Omit<SecretProviderConfig, "config">[]> {
+        const configs = await this.registry.getAllProviderConfigs();
+        const configMetadata: Omit<SecretProviderConfig, "config">[] = configs.map(
+          ({ config: _, ...rest }) => rest
+        );
+        return configMetadata;
+      }
+      onProvidersChange(callback: ProviderChangeCallback): () => void {
+        return this.registry.onProvidersChange(callback);
+      }
     }
     /**
@@ Expand Down @@

src/lib/storage/EncryptedElectronStore.ts

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -89,7 +89,7 @@ export class EncryptedElectronStore {
  
       * @param callback - Function to call when data changes

       * @returns Unsubscribe function

       */

      onChange(callback: (_data: Record<string, string>) => void): () => void {

      onChange<T>(callback: (_data: Record<string, T>) => void): () => void {

        return this.store.onDidChange("data", (newValue) => {

          if (newValue) {

            callback(newValue);

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

adds support for listener in secretsManager #273

Uh oh!

Diff view

Diff view

There are no files selected for viewing

adds support for listener in secretsManager #273

Are you sure you want to change the base?

Uh oh!

adds support for listener in secretsManager #273

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing