ac-awssecrets 2.2.1 → 2.3.1

package/CHANGELOG.md

@@ -1,3 +1,33 @@
+<a name="2.3.1"></a>
+
+## [2.3.1](https://github.com/admiralcloud/ac-awssecrets/compare/v2.3.0..v2.3.1) (2024-08-17 10:57:27)
+
+
+### Bug Fix
+
+* **App:** Add ignoreInTestmode for secret params | MP | [0065e17890c41d01a2ce47a302ce9f2a818cbce3](https://github.com/admiralcloud/ac-awssecrets/commit/0065e17890c41d01a2ce47a302ce9f2a818cbce3)    
+If ignoreInTestmode is true in testmode, the secret parameter is not fetched.  
+Related issues: [undefined/undefined#master](undefined/browse/master)
+### Chores
+
+* **App:** Updated packages | MP | [53c458370aba20b633b7ebe33ab3e026bc95a133](https://github.com/admiralcloud/ac-awssecrets/commit/53c458370aba20b633b7ebe33ab3e026bc95a133)    
+Updated packages  
+Related issues: [undefined/undefined#master](undefined/browse/master)
+<a name="2.3.0"></a>
+ 
+# [2.3.0](https://github.com/admiralcloud/ac-awssecrets/compare/v2.2.1..v2.3.0) (2024-08-12 10:04:48)
+
+
+### Feature
+
+* **App:** Add option to merge AWS parameters with config | MP | [e000f4b824a44c39f2b4b99c8b20440fefd80fb3](https://github.com/admiralcloud/ac-awssecrets/commit/e000f4b824a44c39f2b4b99c8b20440fefd80fb3)    
+Add option to merge AWS parameters with config instead of overwriting (default)  
+Related issues: [undefined/undefined#master](undefined/browse/master)
+### Chores
+
+* **App:** Updated packages | MP | [286853f0f9bd9a4456e6b52e79027d7afa645fd5](https://github.com/admiralcloud/ac-awssecrets/commit/286853f0f9bd9a4456e6b52e79027d7afa645fd5)    
+Updated packages  
+Related issues: [undefined/undefined#master](undefined/browse/master)
 <a name="2.2.1"></a>
 
 ## [2.2.1](https://github.com/admiralcloud/ac-awssecrets/compare/v2.2.0..v2.2.1) (2024-08-09 15:10:41)

package/README.md

@@ -59,6 +59,34 @@ const config = {
     ]
   }
 }
+```
+```
+// example with merge = true
+const config = {
+  aws: {
+    account: 123,
+    s3: {
+      region: 'eu-central-1'
+    }
+  }
+}
+
+/development/aws -> { account: 456 }
+const payload = {
+  secretParameters: [ 
+    { name: 'aws', json: true, merge: true },
+  ],
+  config
+}
+await awsSecrets.loadSecretParameters(payload)
+
+// final result
+config.aws = {
+  account: 456,
+  s3: {
+    region: 'eu-central-1'
+  }
+}
 
 ```
 
@@ -70,6 +98,7 @@ const config = {
 |json|boolean|-|If true, the parameter value will be parsed as JSON
 |array|boolean|-|If true, the the value will be pushed to the array at name or path
 |property|object|-|If set, instead of pushing the value to an array it will inserted at the object which matches the property 
+|merge|boolean|-|If true, objects from AWS parameters will be merged with existing objects
 
 
 # AWS Secrets

package/index.js

@@ -31,7 +31,7 @@ const awsSecrets = () => {
         : setKey(obj[head], rest.join('.'), value)
   }
 
-  const setValue = (config, { path, value, array = false, property }) => {
+  const setValue = (config, { path, value, array = false, property, merge = false }) => {
     // path can be from AWS parametes store (/a/b/c) or a real JSON path (a.b.c)    
     const keys = path.includes('/') ? path.split('/').filter(Boolean) : path.split('.')
     const lastKey = keys.pop()
@@ -68,7 +68,12 @@ const awsSecrets = () => {
       }
     } 
     else {
-      pointer[lastKey] = value
+      if (merge && typeof pointer[lastKey] === 'object' && !Array.isArray(pointer[lastKey]) && typeof value === 'object' && !Array.isArray(value)) {
+        pointer[lastKey] = { ...pointer[lastKey], ...value }
+      }
+      else {
+        pointer[lastKey] = value
+      }
     }
   }
   
@@ -82,7 +87,7 @@ const awsSecrets = () => {
     }
     const ssmClient = new SSMClient(awsConfig)
 
-    const getSecretParameter = async({ name, json = false, array = false, path, property, debug }) => {
+    const getSecretParameter = async({ name, json = false, array = false, path, property, debug, merge }) => {
       const parameterName = `/${environment}/${name}`
       try {
         let value
@@ -110,7 +115,7 @@ const awsSecrets = () => {
         if (debug) {
           console.warn('P %s | T %s | V %j', parameterName, typeof value, value)
         }
-        setValue(config, { path: (path || name), value, array, property })
+        setValue(config, { path: (path || name), value, array, property, merge })
 
       } 
       catch (e) {
@@ -119,6 +124,7 @@ const awsSecrets = () => {
     }
 
     for (const secretParameter of secretParameters) {
+      if (environment === 'test' && secretParameter?.ignoreInTestMode) continue
       await getSecretParameter(secretParameter)
     }
   }

package/package.json

@@ -3,10 +3,10 @@
   "author": "Mark Poepping (https://www.admiralcloud.com)",
   "license": "MIT",
   "repository": "admiralcloud/ac-awssecrets",
-  "version": "2.2.1",
+  "version": "2.3.1",
   "dependencies": {
-    "@aws-sdk/client-secrets-manager": "^3.624.0",
-    "@aws-sdk/client-ssm": "^3.624.0"
+    "@aws-sdk/client-secrets-manager": "^3.632.0",
+    "@aws-sdk/client-ssm": "^3.632.0"
   },
   "devDependencies": {
     "ac-semantic-release": "^0.4.2",

package/test/config.js

@@ -18,6 +18,7 @@ const config = {
     }
   },
   aws: {
+    account: '123',
     accessKeys: []
   },
   configVar7: {
@@ -33,6 +34,7 @@ const secretParameters = [
   { name: 'configVar4/api', json: true },
   { name: 'configVar5.path', json: true },
   { name: 'configVar6', json: true },
+  { name: 'aws', json: true, merge: true }
 ]
 
 const parameterStore = [
@@ -66,6 +68,12 @@ const parameterStore = [
       prop2: 'abc'
     })
   },
+  {
+    name: '/test/aws',
+    value: JSON.stringify({
+      account: '456'
+    })
+  }
 ]
 
 

package/test/test.js

@@ -67,6 +67,12 @@ describe('Reading secretParameters', () => {
   it('Check non existing key - should fallback to existing value without error', async() => {
     expect(config.configVar7).to.have.property('level', 'info')
   })
+  
+
+  it('Check merge config', async() => {
+    expect(config.aws).to.have.property('account', '456')
+    expect(config.aws).to.have.property('accessKeys').length(0)
+  })
 })