Merge pull request #3 from robin-thomas/logging

feat: add logging support
robin-thomas · Sep 10, 2023 · e9c4e95 · e9c4e95
2 parents 6a2c3aa + 7565d9e
commit e9c4e95
Show file tree

Hide file tree

Showing 4 changed files with 80 additions and 18 deletions.
diff --git a/src/index.spec.ts b/src/index.spec.ts
@@ -12,6 +12,10 @@ const getServerless = (): Serverless => ({
 });
 
 describe('index.ts', () => {
+  beforeEach(() => {
+    jest.spyOn(console, 'log').mockImplementation();
+  });
+
   describe('default options are set', () => {
     test('secretId and secretPrefix are not set', () => {
       const serverless = getServerless();
@@ -49,7 +53,40 @@ describe('index.ts', () => {
     });
   });
 
+  describe('verbose logging', () => {
+    afterAll(() => {
+      nock.cleanAll();
+    });
+
+    test('if verbose is not set, its default value is false', () => {
+      const plugin = new ServerlesssAwsSecrets(getServerless());
+      expect(plugin.options.verbose).toBe(false);
+    });
+
+    test('if verbose is set, its value is used', async () => {
+      const serverless = getServerless();
+      serverless.service.custom = { 'serverless-aws-secrets': { verbose: true } };
+      serverless.service.provider.environment = { MYSQL_PASSWORD: 'SECRET:MYSQL_PASSWORD' };
+
+      nock(/secretsmanager.eu-west-1.amazonaws.com/)
+        .post('/')
+        .reply(200, { SecretString: JSON.stringify({ MYSQL_PASSWORD: 'SECRET_MYSQL_PASSWORD' }) });
+
+      const plugin = new ServerlesssAwsSecrets(serverless);
+      expect(plugin.options.verbose).toBe(true);
+
+      await plugin.loadSecrets();
+      expect(console.log).toBeCalledWith(
+        '[serverless-aws-secrets]: Replacing MYSQL_PASSWORD with secret of MYSQL_PASSWORD',
+      );
+    });
+  });
+
   describe('loading the secrets', () => {
+    afterEach(() => {
+      nock.cleanAll();
+    });
+
     test('failed to connect to AWS', async () => {
       nock(/secretsmanager.eu-west-1.amazonaws.com/)
         .post('/')

diff --git a/src/index.ts b/src/index.ts
@@ -3,20 +3,15 @@ import { SecretsManagerClient, GetSecretValueCommand } from '@aws-sdk/client-sec
 import type { Serverless, ServerlessSecretHooks, ServerlessSecretOptions } from './index.types';
 
 class ServerlessAWSSecret {
-  private readonly hooks: ServerlessSecretHooks;
-  readonly options: ServerlessSecretOptions;
-  private readonly providerCopy: Serverless['service']['provider'];
-  private readonly region: string;
-  private readonly secretId: string;
-  private readonly secretPrefix: string;
+  hooks: ServerlessSecretHooks;
+  options: ServerlessSecretOptions;
+  providerCopy: Serverless['service']['provider'];
+  region: string;
 
   constructor(serverless: Serverless) {
-    const { custom, provider } = serverless.service;
-    this.options = custom?.['serverless-aws-secrets'] ?? {};
-
-    this.secretId = this.getSecretId(serverless);
-    this.secretPrefix = this.getSecretPrefix();
+    this.setOptions(serverless);
 
+    const { provider } = serverless.service;
     this.region = provider.region;
     this.providerCopy = provider;
 
@@ -28,27 +23,44 @@ class ServerlessAWSSecret {
 
   async loadSecrets() {
     const client = new SecretsManagerClient({ region: this.region });
-    const command = new GetSecretValueCommand({ SecretId: this.secretId });
+    const command = new GetSecretValueCommand({ SecretId: this.options.secretId });
 
     const { SecretString } = await client.send(command);
 
     if (!SecretString) {
-      throw new Error(`Failed to retrieve the secret: ${this.secretId}`);
+      throw new Error(`Failed to retrieve the secret: ${this.options.secretId}`);
     }
 
     const secrets = JSON.parse(SecretString);
 
+    let replaceCount = 0;
     for (const [key, value] of Object.entries(this.providerCopy.environment)) {
-      if (value?.startsWith(this.secretPrefix)) {
-        const secretKey = value.replace(this.secretPrefix, '');
+      if (value?.startsWith(this.options.secretPrefix!)) {
+        const secretKey = value.replace(this.options.secretPrefix!, '');
 
         if (!secrets[secretKey]) {
           throw new Error(`Secret ${secretKey} do not exist`);
         }
 
+        if (this.options.verbose) {
+          console.log(`[serverless-aws-secrets]: Replacing ${key} with secret of ${secretKey}`);
+        }
+
         this.providerCopy.environment[key] = secrets[secretKey];
+
+        ++replaceCount;
       }
     }
+
+    console.log(`[serverless-aws-secrets]: Replaced ${replaceCount} secrets in environment variables`);
+  }
+
+  setOptions(serverless: Serverless) {
+    this.options = serverless.service.custom?.['serverless-aws-secrets'] ?? {};
+
+    this.options.secretId = this.getSecretId(serverless);
+    this.options.secretPrefix = this.getSecretPrefix();
+    this.options.verbose = this.options.verbose ?? false;
   }
 
   getSecretId(serverless: Serverless) {

diff --git a/src/index.types.ts b/src/index.types.ts
@@ -20,9 +20,21 @@ export interface ServerlessSecretHooks {
 }
 
 export interface ServerlessSecretOptions {
-  /** @dev Environment variables with values that start with this prefix are treated as secrets */
+  /**
+   * @dev Environment variables with values that start with this prefix are treated as secrets
+   * @default "SECRET:"
+   */
   secretPrefix?: string;
 
-  /** @dev Secret to search for within AWS Secrets Manager */
+  /**
+   * @dev Secret to search for within AWS Secrets Manager
+   * @default `${stage}/${app}-${service}`
+   */
   secretId?: string;
+
+  /**
+   * @dev Enable verbose logging.
+   * @default false
+   */
+  verbose?: boolean;
 }
diff --git a/tsconfig.json b/tsconfig.json
@@ -2,7 +2,8 @@
   "extends": "@tsconfig/node18/tsconfig.json",
   "compilerOptions": {
     "outDir": "dist",
-    "declaration": false
+    "declaration": false,
+    "strictPropertyInitialization": false
   },
   "include": [
     "src"