@middy/ssm 5.0.0-alpha.0 → 5.0.0-alpha.2

package/README.md

@@ -19,8 +19,9 @@
   <a href="https://snyk.io/test/github/middyjs/middy">
     <img src="https://snyk.io/test/github/middyjs/middy/badge.svg" alt="Known Vulnerabilities" data-canonical-src="https://snyk.io/test/github/middyjs/middy" style="max-width:100%;">
   </a>
-  <a href="https://lgtm.com/projects/g/middyjs/middy/context:javascript">
-    <img src="https://img.shields.io/lgtm/grade/javascript/g/middyjs/middy.svg?logo=lgtm&logoWidth=18" alt="Language grade: JavaScript" style="max-width:100%;">
+  <a href="https://github.com/middyjs/middy/actions/workflows/sast.yml">
+    <img src="https://github.com/middyjs/middy/actions/workflows/sast.yml/badge.svg
+?branch=main&event=push" alt="CodeQL" style="max-width:100%;">
   </a>
   <a href="https://bestpractices.coreinfrastructure.org/projects/5280">
     <img src="https://bestpractices.coreinfrastructure.org/projects/5280/badge" alt="Core Infrastructure Initiative (CII) Best Practices"  style="max-width:100%;">

package/index.d.ts

@@ -2,27 +2,39 @@ import middy from '@middy/core'
 import { Options as MiddyOptions } from '@middy/util'
 import { Context as LambdaContext } from 'aws-lambda'
 import { SSMClient, SSMClientConfig } from '@aws-sdk/client-ssm'
-import { JsonValue } from 'type-fest'
 
-interface Options<AwsSSMClient = SSMClient>
-  extends MiddyOptions<AwsSSMClient, SSMClientConfig> {}
+export type ParamType<T> = string & { __returnType?: T }
+export declare function ssmParam<T> (path: string): ParamType<T>
 
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-type ExtractSingles<T> = T extends `/${infer _}` ? never : T
-
-export type Context<TOptions extends Options | undefined> = TOptions extends {
-  setToContext: true
+export interface SSMOptions<AwsSSMClient = SSMClient>
+  extends Omit<MiddyOptions<AwsSSMClient, SSMClientConfig>, 'fetchData'> {
+  fetchData?: { [key: string]: string | ParamType<unknown> }
 }
-  ? LambdaContext &
-  Record<ExtractSingles<keyof TOptions['fetchData']>, JsonValue> &
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  (keyof TOptions['fetchData'] extends `${infer _P}/${infer _S}`
-    ? Record<string, JsonValue>
-    : unknown)
+
+export type Context<TOptions extends SSMOptions | undefined> =
+TOptions extends { setToContext: true }
+  ? TOptions extends { fetchData: infer TFetchData }
+    ? LambdaContext & {
+      [Key in keyof TFetchData]: TFetchData[Key] extends ParamType<infer T>
+        ? T
+        : unknown
+    }
+    : never
   : LambdaContext
 
-declare function ssm<TOptions extends Options> (
+export type Internal<TOptions extends SSMOptions | undefined> =
+TOptions extends SSMOptions
+  ? TOptions extends { fetchData: infer TFetchData }
+    ? {
+        [Key in keyof TFetchData]: TFetchData[Key] extends ParamType<infer T>
+          ? T
+          : unknown
+      }
+    : {}
+  : {}
+
+declare function ssm<TOptions extends SSMOptions> (
   options?: TOptions
-): middy.MiddlewareObj<unknown, any, Error, Context<TOptions>>
+): middy.MiddlewareObj<unknown, any, Error, Context<TOptions>, Internal<TOptions>>
 
 export default ssm

package/index.js

@@ -9,6 +9,7 @@ const defaults = {
     fetchData: {},
     disablePrefetch: false,
     cacheKey: 'ssm',
+    cacheKeyExpiry: {},
     cacheExpiry: -1,
     setToContext: false
 };
@@ -28,21 +29,27 @@ const ssmMiddleware = (opts = {})=>{
         let batchReq = null;
         let batchInternalKeys = [];
         let batchFetchKeys = [];
+        const namedKeys = [];
         const internalKeys = Object.keys(options.fetchData);
         const fetchKeys = Object.values(options.fetchData);
-        for (const [idx, internalKey] of internalKeys.entries()){
+        for (const internalKey of internalKeys){
             if (cachedValues[internalKey]) continue;
+            if (options.fetchData[internalKey].substr(-1) === '/') continue; // Skip path passed in
+            namedKeys.push(internalKey);
+        }
+        for (const [idx, internalKey] of namedKeys.entries()){
             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)) {
+            // from the first to the batch size skip, unless it's the last entry
+            if ((!idx || (idx + 1) % awsRequestLimit !== 0) && !(idx + 1 === namedKeys.length)) {
                 continue;
             }
             batchReq = client.send(new GetParametersCommand({
                 Names: batchFetchKeys,
                 WithDecryption: true
             })).then((resp)=>{
+                // Don't sanitize key, mapped to set value in options
                 return Object.assign(...(resp.InvalidParameters ?? []).map((fetchKey)=>{
                     return {
                         [fetchKey]: new Promise(()=>{
@@ -50,7 +57,11 @@ const ssmMiddleware = (opts = {})=>{
                             const value = getCache(options.cacheKey).value ?? {};
                             value[internalKey] = undefined;
                             modifyCache(options.cacheKey, value);
-                            throw new Error('[ssm] InvalidParameter ' + fetchKey);
+                            throw new Error('InvalidParameter ' + fetchKey, {
+                                cause: {
+                                    package: '@middy/ssm'
+                                }
+                            });
                         })
                     };
                 }), ...(resp.Parameters ?? []).map((param)=>{
@@ -80,7 +91,7 @@ const ssmMiddleware = (opts = {})=>{
         for(const internalKey in options.fetchData){
             if (cachedValues[internalKey]) continue;
             const fetchKey = options.fetchData[internalKey];
-            if (fetchKey.substr(-1) !== '/') continue;
+            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;
@@ -112,26 +123,29 @@ const ssmMiddleware = (opts = {})=>{
         }
         return jsonSafeParse(param.Value);
     };
-    let prefetch, client;
+    let client;
     if (canPrefetch(options)) {
         client = createPrefetchClient(options);
-        prefetch = processCache(options, fetch);
+        processCache(options, fetch);
     }
     const ssmMiddlewareBefore = async (request)=>{
         if (!client) {
             client = await createClient(options, request);
         }
-        const { value  } = prefetch ?? processCache(options, fetch, request);
+        const { value } = 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);
         }
-        prefetch = null;
     };
     return {
         before: ssmMiddlewareBefore
     };
 };
 export default ssmMiddleware;
+// used for TS type inference (see index.d.ts)
+export function ssmParam(name) {
+    return name;
+}
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@middy/ssm",
-  "version": "5.0.0-alpha.0",
+  "version": "5.0.0-alpha.2",
   "description": "SSM (EC2 Systems Manager) parameters middleware for the middy framework",
   "type": "module",
   "engines": {
@@ -10,24 +10,18 @@
   "publishConfig": {
     "access": "public"
   },
-  "main": "./index.cjs",
   "module": "./index.js",
   "exports": {
     ".": {
       "import": {
         "types": "./index.d.ts",
         "default": "./index.js"
-      },
-      "require": {
-        "types": "./index.d.ts",
-        "default": "./index.cjs"
       }
     }
   },
   "types": "index.d.ts",
   "files": [
     "index.js",
-    "index.cjs",
     "index.d.ts"
   ],
   "scripts": {
@@ -66,14 +60,13 @@
     "url": "https://github.com/sponsors/willfarrell"
   },
   "dependencies": {
-    "@middy/util": "5.0.0-alpha.0"
+    "@middy/util": "5.0.0-alpha.2"
   },
   "devDependencies": {
     "@aws-sdk/client-ssm": "^3.0.0",
-    "@middy/core": "5.0.0-alpha.0",
+    "@middy/core": "5.0.0-alpha.2",
     "@types/aws-lambda": "^8.10.101",
-    "aws-xray-sdk": "^3.3.3",
-    "type-fest": "^3.0.0"
+    "aws-xray-sdk": "^3.3.3"
   },
-  "gitHead": "08c35e3dba9efdad0b86666ce206ce302cc65d07"
+  "gitHead": "ebce8d5df8783077fa49ba62ee9be20e8486a7f1"
 }

package/index.cjs

@@ -1,145 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(module, "exports", {
-    enumerable: true,
-    get: ()=>_default
-});
-const _util = require("@middy/util");
-const _clientSsm = require("@aws-sdk/client-ssm");
-const awsRequestLimit = 10;
-const defaults = {
-    AwsClient: _clientSsm.SSMClient,
-    awsClientOptions: {},
-    awsClientAssumeRole: undefined,
-    awsClientCapture: undefined,
-    fetchData: {},
-    disablePrefetch: false,
-    cacheKey: 'ssm',
-    cacheExpiry: -1,
-    setToContext: false
-};
-const ssmMiddleware = (opts = {})=>{
-    const options = {
-        ...defaults,
-        ...opts
-    };
-    const fetch = (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);
-        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;
-            }
-            batchReq = client.send(new _clientSsm.GetParametersCommand({
-                Names: batchFetchKeys,
-                WithDecryption: true
-            })).then((resp)=>{
-                return Object.assign(...(resp.InvalidParameters ?? []).map((fetchKey)=>{
-                    return {
-                        [fetchKey]: new Promise(()=>{
-                            const internalKey = internalKeys[fetchKeys.indexOf(fetchKey)];
-                            const value = (0, _util.getCache)(options.cacheKey).value ?? {};
-                            value[internalKey] = undefined;
-                            (0, _util.modifyCache)(options.cacheKey, value);
-                            throw new Error('[ssm] InvalidParameter ' + fetchKey);
-                        })
-                    };
-                }), ...(resp.Parameters ?? []).map((param)=>{
-                    return {
-                        [param.Name]: parseValue(param)
-                    };
-                }));
-            }).catch((e)=>{
-                const value = (0, _util.getCache)(options.cacheKey).value ?? {};
-                value[internalKey] = undefined;
-                (0, _util.modifyCache)(options.cacheKey, value);
-                throw e;
-            });
-            for (const internalKey of batchInternalKeys){
-                values[internalKey] = batchReq.then((params)=>{
-                    return params[options.fetchData[internalKey]];
-                });
-            }
-            batchInternalKeys = [];
-            batchFetchKeys = [];
-            batchReq = null;
-        }
-        return values;
-    };
-    const fetchByPath = (request, cachedValues = {})=>{
-        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 = (0, _util.getCache)(options.cacheKey).value ?? {};
-                value[internalKey] = undefined;
-                (0, _util.modifyCache)(options.cacheKey, value);
-                throw e;
-            });
-        }
-        return values;
-    };
-    const fetchPath = (path, nextToken, values = {})=>{
-        return client.send(new _clientSsm.GetParametersByPathCommand({
-            Path: path,
-            NextToken: nextToken,
-            Recursive: true,
-            WithDecryption: true
-        })).then((resp)=>{
-            Object.assign(values, ...resp.Parameters.map((param)=>{
-                return {
-                    [(0, _util.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 (0, _util.jsonSafeParse)(param.Value);
-    };
-    let prefetch, client;
-    if ((0, _util.canPrefetch)(options)) {
-        client = (0, _util.createPrefetchClient)(options);
-        prefetch = (0, _util.processCache)(options, fetch);
-    }
-    const ssmMiddlewareBefore = async (request)=>{
-        if (!client) {
-            client = await (0, _util.createClient)(options, request);
-        }
-        const { value  } = prefetch ?? (0, _util.processCache)(options, fetch, request);
-        Object.assign(request.internal, value);
-        if (options.setToContext) {
-            const data = await (0, _util.getInternal)(Object.keys(options.fetchData), request);
-            Object.assign(request.context, data);
-        }
-        prefetch = null;
-    };
-    return {
-        before: ssmMiddlewareBefore
-    };
-};
-const _default = ssmMiddleware;
-