@middy/util 4.6.1 → 4.6.2

package/index.cjs

@@ -55,6 +55,7 @@ _export(exports, {
 const createPrefetchClient = (options)=>{
     const { awsClientOptions } = options;
     const client = new options.AwsClient(awsClientOptions);
+    // AWS XRay
     if (options.awsClientCapture && options.disablePrefetch) {
         return options.awsClientCapture(client);
     } else if (options.awsClientCapture) {
@@ -64,6 +65,7 @@ const createPrefetchClient = (options)=>{
 };
 const createClient = async (options, request)=>{
     let awsClientCredentials = {};
+    // Role Credentials
     if (options.awsClientAssumeRole) {
         if (!request) {
             throw new Error('Request required when assuming role');
@@ -102,6 +104,7 @@ const getInternal = async (variables, request)=>{
     }
     const promises = [];
     for (const internalKey of values){
+        // 'internal.key.sub_value' -> { [key]: internal.key.sub_value }
         const pathOptionKey = internalKey.split('.');
         const rootOptionKey = pathOptionKey.shift();
         let valuePromise = request.internal[rootOptionKey];
@@ -110,6 +113,8 @@ const getInternal = async (variables, request)=>{
         }
         promises.push(valuePromise.then((value)=>pathOptionKey.reduce((p, c)=>p?.[c], value)));
     }
+    // ensure promise has resolved by the time it's needed
+    // If one of the promises throws it will bubble up to @middy/core
     values = await Promise.allSettled(promises);
     const errors = values.filter((res)=>res.status === 'rejected').map((res)=>res.reason);
     if (errors.length) {
@@ -128,7 +133,9 @@ const sanitizeKeyRemoveDisallowedChar = /[^a-zA-Z0-9]+/g;
 const sanitizeKey = (key)=>{
     return key.replace(sanitizeKeyPrefixLeadingNumber, '_$1').replace(sanitizeKeyRemoveDisallowedChar, '_');
 };
-const cache = {};
+// fetch Cache
+const cache = {} // key: { value:{fetchKey:Promise}, expiry }
+;
 const processCache = (options, fetch = ()=>undefined, request)=>{
     let { cacheKey, cacheKeyExpiry, cacheExpiry } = options;
     cacheExpiry = cacheKeyExpiry?.[cacheKey] ?? cacheExpiry;
@@ -155,6 +162,7 @@ const processCache = (options, fetch = ()=>undefined, request)=>{
     }
     const value = fetch(request);
     const now = Date.now();
+    // secrets-manager overrides to unix timestamp
     const expiry = cacheExpiry > 86400000 ? cacheExpiry : now + cacheExpiry;
     const duration = cacheExpiry > 86400000 ? cacheExpiry - now : cacheExpiry;
     if (cacheExpiry) {
@@ -234,7 +242,8 @@ class HttpError extends Error {
         super(message, options);
         const name = httpErrorCodes[code].replace(createErrorRegexp, '');
         this.name = name.substr(-5) !== 'Error' ? name + 'Error' : name;
-        this.status = this.statusCode = code;
+        this.status = this.statusCode = code // setting `status` for backwards compatibility w/ `http-errors`
+        ;
         this.expose = options.expose ?? code < 500;
     }
 }

package/index.js

@@ -1,6 +1,7 @@
 export const createPrefetchClient = (options)=>{
     const { awsClientOptions } = options;
     const client = new options.AwsClient(awsClientOptions);
+    // AWS XRay
     if (options.awsClientCapture && options.disablePrefetch) {
         return options.awsClientCapture(client);
     } else if (options.awsClientCapture) {
@@ -10,6 +11,7 @@ export const createPrefetchClient = (options)=>{
 };
 export const createClient = async (options, request)=>{
     let awsClientCredentials = {};
+    // Role Credentials
     if (options.awsClientAssumeRole) {
         if (!request) {
             throw new Error('Request required when assuming role');
@@ -30,6 +32,7 @@ export const createClient = async (options, request)=>{
 export const canPrefetch = (options = {})=>{
     return !options.awsClientAssumeRole && !options.disablePrefetch;
 };
+// Internal Context
 export const getInternal = async (variables, request)=>{
     if (!variables || !request) return {};
     let keys = [];
@@ -48,6 +51,7 @@ export const getInternal = async (variables, request)=>{
     }
     const promises = [];
     for (const internalKey of values){
+        // 'internal.key.sub_value' -> { [key]: internal.key.sub_value }
         const pathOptionKey = internalKey.split('.');
         const rootOptionKey = pathOptionKey.shift();
         let valuePromise = request.internal[rootOptionKey];
@@ -56,6 +60,8 @@ export const getInternal = async (variables, request)=>{
         }
         promises.push(valuePromise.then((value)=>pathOptionKey.reduce((p, c)=>p?.[c], value)));
     }
+    // ensure promise has resolved by the time it's needed
+    // If one of the promises throws it will bubble up to @middy/core
     values = await Promise.allSettled(promises);
     const errors = values.filter((res)=>res.status === 'rejected').map((res)=>res.reason);
     if (errors.length) {
@@ -74,7 +80,9 @@ const sanitizeKeyRemoveDisallowedChar = /[^a-zA-Z0-9]+/g;
 export const sanitizeKey = (key)=>{
     return key.replace(sanitizeKeyPrefixLeadingNumber, '_$1').replace(sanitizeKeyRemoveDisallowedChar, '_');
 };
-const cache = {};
+// fetch Cache
+const cache = {} // key: { value:{fetchKey:Promise}, expiry }
+;
 export const processCache = (options, fetch = ()=>undefined, request)=>{
     let { cacheKey, cacheKeyExpiry, cacheExpiry } = options;
     cacheExpiry = cacheKeyExpiry?.[cacheKey] ?? cacheExpiry;
@@ -101,6 +109,7 @@ export const processCache = (options, fetch = ()=>undefined, request)=>{
     }
     const value = fetch(request);
     const now = Date.now();
+    // secrets-manager overrides to unix timestamp
     const expiry = cacheExpiry > 86400000 ? cacheExpiry : now + cacheExpiry;
     const duration = cacheExpiry > 86400000 ? cacheExpiry - now : cacheExpiry;
     if (cacheExpiry) {
@@ -120,6 +129,7 @@ export const getCache = (key)=>{
     if (!cache[key]) return {};
     return cache[key];
 };
+// Used to remove parts of a cache
 export const modifyCache = (cacheKey, value)=>{
     if (!cache[cacheKey]) return;
     clearInterval(cache[cacheKey]?.refresh);
@@ -180,7 +190,8 @@ export class HttpError extends Error {
         super(message, options);
         const name = httpErrorCodes[code].replace(createErrorRegexp, '');
         this.name = name.substr(-5) !== 'Error' ? name + 'Error' : name;
-        this.status = this.statusCode = code;
+        this.status = this.statusCode = code // setting `status` for backwards compatibility w/ `http-errors`
+        ;
         this.expose = options.expose ?? code < 500;
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@middy/util",
-  "version": "4.6.1",
+  "version": "4.6.2",
   "description": "🛵 The stylish Node.js middleware engine for AWS Lambda (util package)",
   "type": "module",
   "engines": {
@@ -61,7 +61,7 @@
   },
   "devDependencies": {
     "@aws-sdk/client-ssm": "^3.0.0",
-    "@middy/core": "4.6.1",
+    "@middy/core": "4.6.2",
     "@types/aws-lambda": "^8.10.76",
     "@types/node": "^20.0.0",
     "aws-xray-sdk": "^3.3.3"
@@ -71,5 +71,5 @@
     "type": "github",
     "url": "https://github.com/sponsors/willfarrell"
   },
-  "gitHead": "253ed0e4ca95623decbade03938a07d837a1eba2"
+  "gitHead": "8b03a01abf5a9c08231ec5ced775e87f8be8f67d"
 }