@middy/ssm 3.0.0-alpha.2 → 3.0.0-alpha.3

package/index.js

@@ -1,159 +1,176 @@
-import { canPrefetch, createPrefetchClient, createClient, processCache, getCache, modifyCache, jsonSafeParse, getInternal, sanitizeKey } from '@middy/util';
-import SSM from 'aws-sdk/clients/ssm.js';
-const awsRequestLimit = 10;
+import {
+  canPrefetch,
+  createPrefetchClient,
+  createClient,
+  processCache,
+  getCache,
+  modifyCache,
+  jsonSafeParse,
+  getInternal,
+  sanitizeKey
+} from '@middy/util'
+import SSM from 'aws-sdk/clients/ssm.js' // v2
+// import { SSM } from '@aws-sdk/client-ssm' // v3
+
+const awsRequestLimit = 10
 const defaults = {
-  AwsClient: SSM,
+  AwsClient: SSM, // Allow for XRay
   awsClientOptions: {},
   awsClientAssumeRole: undefined,
   awsClientCapture: undefined,
-  fetchData: {},
+  fetchData: {}, // { contextKey: fetchKey, contextPrefix: fetchPath/ }
   disablePrefetch: false,
   cacheKey: 'ssm',
   cacheExpiry: -1,
   setToContext: false
-};
+}
 
 const ssmMiddleware = (opts = {}) => {
-  const options = { ...defaults,
-    ...opts
-  };
+  const options = { ...defaults, ...opts }
 
   const fetch = (request, cachedValues) => {
-    return { ...fetchSingle(request, cachedValues),
+    return {
+      ...fetchSingle(request, cachedValues),
       ...fetchByPath(request, cachedValues)
-    };
-  };
+    }
+  }
 
   const fetchSingle = (request, cachedValues = {}) => {
-    const values = {};
-    let batchReq = null;
-    let batchInternalKeys = [];
-    let batchFetchKeys = [];
-    const internalKeys = Object.keys(options.fetchData);
-    const fetchKeys = Object.values(options.fetchData);
+    const values = {}
+    let batchReq = null
+    let batchInternalKeys = []
+    let batchFetchKeys = []
 
+    const internalKeys = Object.keys(options.fetchData)
+    const fetchKeys = Object.values(options.fetchData)
     for (const [idx, internalKey] of internalKeys.entries()) {
-      if (cachedValues[internalKey]) continue;
-      const fetchKey = options.fetchData[internalKey];
-      if (fetchKey.substr(-1) === '/') continue;
-      batchInternalKeys.push(internalKey);
-      batchFetchKeys.push(fetchKey);
-
-      if ((!idx || (idx + 1) % awsRequestLimit !== 0) && !(idx + 1 === internalKeys.length)) {
-        continue;
+      if (cachedValues[internalKey]) continue
+      const fetchKey = options.fetchData[internalKey]
+      if (fetchKey.substr(-1) === '/') continue // Skip path passed in
+      batchInternalKeys.push(internalKey)
+      batchFetchKeys.push(fetchKey)
+      // from the first to the batch size skip, unless it's the last entry
+      if (
+        (!idx || (idx + 1) % awsRequestLimit !== 0) &&
+        !(idx + 1 === internalKeys.length)
+      ) {
+        continue
       }
 
-      batchReq = client.getParameters({
-        Names: batchFetchKeys,
-        WithDecryption: true
-      }).promise().then(resp => {
-        return Object.assign(...(resp.InvalidParameters ?? []).map(fetchKey => {
-          return {
-            [fetchKey]: new Promise(() => {
-              const internalKey = internalKeys[fetchKeys.indexOf(fetchKey)];
-              const value = getCache(options.cacheKey).value ?? {};
-              value[internalKey] = undefined;
-              modifyCache(options.cacheKey, value);
-              throw new Error('ssm.InvalidParameter ' + fetchKey);
+      batchReq = client
+        .getParameters({ Names: batchFetchKeys, WithDecryption: true })
+        .promise() // Required for aws-sdk v2
+        .then((resp) => {
+          // Don't sanitize key, mapped to set value in options
+          return Object.assign(
+            ...(resp.InvalidParameters ?? []).map((fetchKey) => {
+              return {
+                [fetchKey]: new Promise(() => {
+                  const internalKey = internalKeys[fetchKeys.indexOf(fetchKey)]
+                  const value = getCache(options.cacheKey).value ?? {}
+                  value[internalKey] = undefined
+                  modifyCache(options.cacheKey, value)
+                  throw new Error('ssm.InvalidParameter ' + fetchKey)
+                })
+              }
+            }),
+            ...(resp.Parameters ?? []).map((param) => {
+              return { [param.Name]: parseValue(param) }
             })
-          };
-        }), ...(resp.Parameters ?? []).map(param => {
-          return {
-            [param.Name]: parseValue(param)
-          };
-        }));
-      }).catch(e => {
-        const value = getCache(options.cacheKey).value ?? {};
-        value[internalKey] = undefined;
-        modifyCache(options.cacheKey, value);
-        throw e;
-      });
+          )
+        })
+        .catch((e) => {
+          const value = getCache(options.cacheKey).value ?? {}
+          value[internalKey] = undefined
+          modifyCache(options.cacheKey, value)
+          throw e
+        })
 
       for (const internalKey of batchInternalKeys) {
-        values[internalKey] = batchReq.then(params => {
-          return params[options.fetchData[internalKey]];
-        });
+        values[internalKey] = batchReq.then((params) => {
+          return params[options.fetchData[internalKey]]
+        })
       }
 
-      batchInternalKeys = [];
-      batchFetchKeys = [];
-      batchReq = null;
+      batchInternalKeys = []
+      batchFetchKeys = []
+      batchReq = null
     }
 
-    return values;
-  };
+    return values
+  }
 
   const fetchByPath = (request, cachedValues = {}) => {
-    const values = {};
-
+    const values = {}
     for (const internalKey in options.fetchData) {
-      if (cachedValues[internalKey]) continue;
-      const fetchKey = options.fetchData[internalKey];
-      if (fetchKey.substr(-1) !== '/') continue;
-      values[internalKey] = fetchPath(fetchKey).catch(e => {
-        const value = getCache(options.cacheKey).value ?? {};
-        value[internalKey] = undefined;
-        modifyCache(options.cacheKey, value);
-        throw e;
-      });
+      if (cachedValues[internalKey]) continue
+      const fetchKey = options.fetchData[internalKey]
+      if (fetchKey.substr(-1) !== '/') continue // Skip not path passed in
+      values[internalKey] = fetchPath(fetchKey).catch((e) => {
+        const value = getCache(options.cacheKey).value ?? {}
+        value[internalKey] = undefined
+        modifyCache(options.cacheKey, value)
+        throw e
+      })
     }
-
-    return values;
-  };
+    return values
+  }
 
   const fetchPath = (path, nextToken, values = {}) => {
-    return client.getParametersByPath({
-      Path: path,
-      NextToken: nextToken,
-      Recursive: true,
-      WithDecryption: true
-    }).promise().then(resp => {
-      Object.assign(values, ...resp.Parameters.map(param => {
-        return {
-          [sanitizeKey(param.Name.replace(path, ''))]: parseValue(param)
-        };
-      }));
-      if (resp.NextToken) return fetchPath(path, resp.NextToken, values);
-      return values;
-    });
-  };
-
-  const parseValue = param => {
+    return client
+      .getParametersByPath({
+        Path: path,
+        NextToken: nextToken,
+        Recursive: true,
+        WithDecryption: true
+      })
+      .promise() // Required for aws-sdk v2
+      .then((resp) => {
+        Object.assign(
+          values,
+          ...resp.Parameters.map((param) => {
+            return {
+              [sanitizeKey(param.Name.replace(path, ''))]: parseValue(param)
+            }
+          })
+        )
+        if (resp.NextToken) return fetchPath(path, resp.NextToken, values)
+        return values
+      })
+  }
+
+  const parseValue = (param) => {
     if (param.Type === 'StringList') {
-      return param.Value.split(',');
+      return param.Value.split(',')
     }
+    return jsonSafeParse(param.Value)
+  }
 
-    return jsonSafeParse(param.Value);
-  };
-
-  let prefetch, client;
-
+  let prefetch, client
   if (canPrefetch(options)) {
-    client = createPrefetchClient(options);
-    prefetch = processCache(options, fetch);
+    client = createPrefetchClient(options)
+    prefetch = processCache(options, fetch)
   }
 
-  const ssmMiddlewareBefore = async request => {
+  const ssmMiddlewareBefore = async (request) => {
     if (!client) {
-      client = await createClient(options, request);
+      client = await createClient(options, request)
     }
 
-    const {
-      value
-    } = prefetch ?? processCache(options, fetch, request);
-    Object.assign(request.internal, value);
+    const { value } = prefetch ?? processCache(options, fetch, request)
+
+    Object.assign(request.internal, value)
 
     if (options.setToContext) {
-      const data = await getInternal(Object.keys(options.fetchData), request);
-      Object.assign(request.context, data);
+      const data = await getInternal(Object.keys(options.fetchData), request)
+      Object.assign(request.context, data)
     }
 
-    prefetch = null;
-  };
+    prefetch = null
+  }
 
   return {
     before: ssmMiddlewareBefore
-  };
-};
-
-export default ssmMiddleware;
+  }
+}
+export default ssmMiddleware

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@middy/ssm",
-  "version": "3.0.0-alpha.2",
+  "version": "3.0.0-alpha.3",
   "description": "SSM (EC2 Systems Manager) parameters middleware for the middy framework",
   "type": "module",
   "engines": {
@@ -18,7 +18,8 @@
   ],
   "scripts": {
     "test": "npm run test:unit",
-    "test:unit": "ava"
+    "test:unit": "ava",
+    "test:benchmark": "node __benchmarks__/index.js"
   },
   "license": "MIT",
   "keywords": [
@@ -47,12 +48,12 @@
   },
   "homepage": "https://github.com/middyjs/middy#readme",
   "dependencies": {
-    "@middy/util": "^3.0.0-alpha.2"
+    "@middy/util": "^3.0.0-alpha.3"
   },
   "devDependencies": {
-    "@middy/core": "^3.0.0-alpha.2",
+    "@middy/core": "^3.0.0-alpha.3",
     "aws-sdk": "^2.939.0",
     "aws-xray-sdk": "^3.3.3"
   },
-  "gitHead": "de30419273ecbff08f367f47c7e320ec981cf145"
+  "gitHead": "1441158711580313765e6d156046ef0fade0d156"
 }