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

package/README.md

@@ -1,26 +1,36 @@
-# Middy ssm middleware
-
-<div align="center">
-  <img alt="Middy logo" src="https://raw.githubusercontent.com/middyjs/middy/main/docs/img/middy-logo.png"/>
-</div>
-
 <div align="center">
+  <h1>Middy ssm middleware</h1>
+  <img alt="Middy logo" src="https://raw.githubusercontent.com/middyjs/middy/main/docs/img/middy-logo.svg"/>
   <p><strong>SSM (AWS System Manager Parameter) middleware for the middy framework, the stylish Node.js middleware engine for AWS Lambda</strong></p>
-</div>
-
-<div align="center">
 <p>
-  <a href="http://badge.fury.io/js/%40middy%2Fssm">
+  <a href="https://www.npmjs.com/package/@middy/ssm?activeTab=versions">
     <img src="https://badge.fury.io/js/%40middy%2Fssm.svg" alt="npm version" style="max-width:100%;">
   </a>
+  <a href="https://packagephobia.com/result?p=@middy/ssm">
+    <img src="https://packagephobia.com/badge?p=@middy/ssm" alt="npm install size" style="max-width:100%;">
+  </a>
+  <a href="https://github.com/middyjs/middy/actions">
+    <img src="https://github.com/middyjs/middy/workflows/Tests/badge.svg" alt="GitHub Actions test status badge" style="max-width:100%;">
+  </a>
+  <br/>
+   <a href="https://standardjs.com/">
+    <img src="https://img.shields.io/badge/code_style-standard-brightgreen.svg" alt="Standard Code Style"  style="max-width:100%;">
+  </a>
   <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://standardjs.com/">
-    <img src="https://img.shields.io/badge/code_style-standard-brightgreen.svg" alt="Standard Code Style"  style="max-width:100%;">
+  <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>
+  <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%;">
   </a>
+  <br/>
   <a href="https://gitter.im/middyjs/Lobby">
-    <img src="https://badges.gitter.im/gitterHQ/gitter.svg" alt="Chat on Gitter"  style="max-width:100%;">
+    <img src="https://badges.gitter.im/gitterHQ/gitter.svg" alt="Chat on Gitter" style="max-width:100%;">
+  </a>
+  <a href="https://stackoverflow.com/questions/tagged/middy?sort=Newest&uqlId=35052">
+    <img src="https://img.shields.io/badge/StackOverflow-[middy]-yellow" alt="Ask questions on StackOverflow" style="max-width:100%;">
   </a>
 </p>
 </div>
@@ -48,9 +58,9 @@ npm install --save @middy/ssm
 ## Options
 
 - `AwsClient` (object) (default `AWS.SSM`): AWS.SSM class constructor (e.g. that has been instrumented with AWS X-Ray). Must be from `aws-sdk` v2.
-- `awsClientOptions` (object) (optional): Options to pass to AWS.SSM class constructor.
-- `awsClientAssumeRole` (string) (optional): Internal key where role tokens are stored. See [@middy/sts](/packages/sts/README.md) on to set this.
-- `awsClientCapture` (function) (optional): Enable AWS X-Ray by passing `captureAWSClient` from `aws-xray-sdk` in.
+- `awsClientOptions` (object) (default `undefined`): Options to pass to AWS.SSM class constructor.
+- `awsClientAssumeRole` (string) (default `undefined`): Internal key where role tokens are stored. See [@middy/sts](/packages/sts/README.md) on to set this.
+- `awsClientCapture` (function) (default `undefined`): Enable AWS X-Ray by passing `captureAWSClient` from `aws-xray-sdk` in.
 - `fetchData` (object) (required): Mapping of internal key name to API request parameter `Names`/`Path`. `SecureString` are automatically decrypted.
 - `disablePrefetch` (boolean) (default `false`): On cold start requests will trigger early if they can. Setting `awsClientAssumeRole` disables prefetch.
 - `cacheKey` (string) (default `ssm`): Cache key for the fetched data responses. Must be unique across all middleware.

package/index.js

@@ -1,176 +1,3 @@
-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
+import{canPrefetch,createPrefetchClient,createClient,processCache,getCache,modifyCache,jsonSafeParse,getInternal,sanitizeKey}from'@middy/util';import SSM from'aws-sdk/clients/ssm.js';const awsRequestLimit=10;const defaults={AwsClient:SSM,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,internalKey2]of internalKeys.entries()){if(cachedValues[internalKey2])continue;const fetchKey1=options.fetchData[internalKey2];if(fetchKey1.substr(-1)==='/')continue;batchInternalKeys.push(internalKey2);batchFetchKeys.push(fetchKey1);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)})}}),...(resp.Parameters??[]).map(param=>{return{[param.Name]:parseValue(param)}}))}).catch(e=>{const value=getCache(options.cacheKey).value??{};value[internalKey2]=undefined;modifyCache(options.cacheKey,value);throw e});for(const internalKey1 of batchInternalKeys){values[internalKey1]=batchReq.then(params=>{return params[options.fetchData[internalKey1]]})}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=getCache(options.cacheKey).value??{};value[internalKey]=undefined;modifyCache(options.cacheKey,value);throw e})}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=>{if(param.Type==='StringList'){return param.Value.split(',')}return jsonSafeParse(param.Value)};let prefetch,client;if(canPrefetch(options)){client=createPrefetchClient(options);prefetch=processCache(options,fetch)}const ssmMiddlewareBefore=async request=>{if(!client){client=await createClient(options,request)}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)}prefetch=null};return{before:ssmMiddlewareBefore}};export default ssmMiddleware
 
-const awsRequestLimit = 10
-const defaults = {
-  AwsClient: SSM, // Allow for XRay
-  awsClientOptions: {},
-  awsClientAssumeRole: undefined,
-  awsClientCapture: undefined,
-  fetchData: {}, // { contextKey: fetchKey, contextPrefix: fetchPath/ }
-  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 // 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() // 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) }
-            })
-          )
-        })
-        .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]]
-        })
-      }
-
-      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 // 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
-  }
-
-  const fetchPath = (path, nextToken, values = {}) => {
-    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 jsonSafeParse(param.Value)
-  }
-
-  let prefetch, client
-  if (canPrefetch(options)) {
-    client = createPrefetchClient(options)
-    prefetch = processCache(options, fetch)
-  }
-
-  const ssmMiddlewareBefore = async (request) => {
-    if (!client) {
-      client = await createClient(options, request)
-    }
-
-    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)
-    }
-
-    prefetch = null
-  }
-
-  return {
-    before: ssmMiddlewareBefore
-  }
-}
-export default ssmMiddleware
+//# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@middy/ssm",
-  "version": "3.0.0-alpha.3",
+  "version": "3.0.0-alpha.7",
   "description": "SSM (EC2 Systems Manager) parameters middleware for the middy framework",
   "type": "module",
   "engines": {
@@ -48,12 +48,12 @@
   },
   "homepage": "https://github.com/middyjs/middy#readme",
   "dependencies": {
-    "@middy/util": "^3.0.0-alpha.3"
+    "@middy/util": "^3.0.0-alpha.7"
   },
   "devDependencies": {
-    "@middy/core": "^3.0.0-alpha.3",
+    "@middy/core": "^3.0.0-alpha.7",
     "aws-sdk": "^2.939.0",
     "aws-xray-sdk": "^3.3.3"
   },
-  "gitHead": "1441158711580313765e6d156046ef0fade0d156"
+  "gitHead": "5cef39ebe49c201f97d71bb0680004de4b82cb91"
 }