@middy/rds-signer 2.5.6 → 3.0.0-alpha.3

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017-2021 Luciano Mammino, will Farrell and the [Middy team](https://github.com/middyjs/middy/graphs/contributors)
+Copyright (c) 2017-2022 Luciano Mammino, will Farrell and the [Middy team](https://github.com/middyjs/middy/graphs/contributors)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -44,12 +44,10 @@ npm install --save @middy/rds-signer
 - `disablePrefetch` (boolean) (default `false`): On cold start requests will trigger early if they can. Setting `awsClientAssumeRole` disables prefetch.
 - `cacheKey` (string) (default `rds-signer`): Cache key for the fetched data responses. Must be unique across all middleware.
 - `cacheExpiry` (number) (default `-1`): How long fetch data responses should be cached for. `-1`: cache forever, `0`: never cache, `n`: cache for n ms.
-- `setToEnv` (boolean) (default `false`): Store role tokens to `process.env`. **Storing secrets in `process.env` is considered security bad practice**
 - `setToContext` (boolean) (default `false`): Store role tokens to `request.context`.
 
 NOTES:
 - Lambda is required to have IAM permission for `rds-db:connect` with a resource like `arn:aws:rds-db:#{AWS::Region}:#{AWS::AccountId}:dbuser:${database_resource}/${iam_role}`
-- `setToEnv` and `setToContext` are included for legacy support and should be avoided for performance and security reasons. See main documentation for best practices.
 
 ## Sample usage
 
@@ -94,7 +92,7 @@ Everyone is very welcome to contribute to this repository. Feel free to [raise i
 
 ## License
 
-Licensed under [MIT License](LICENSE). Copyright (c) 2017-2021 Luciano Mammino, will Farrell, and the [Middy team](https://github.com/middyjs/middy/graphs/contributors).
+Licensed under [MIT License](LICENSE). Copyright (c) 2017-2022 Luciano Mammino, will Farrell, and the [Middy team](https://github.com/middyjs/middy/graphs/contributors).
 
 <a href="https://app.fossa.io/projects/git%2Bgithub.com%2Fmiddyjs%2Fmiddy?ref=badge_large">
   <img src="https://app.fossa.io/api/projects/git%2Bgithub.com%2Fmiddyjs%2Fmiddy.svg?type=large" alt="FOSSA Status"  style="max-width:100%;">

package/index.js

@@ -1,21 +1,20 @@
-const {
+import {
   canPrefetch,
   getInternal,
   processCache,
   getCache,
   modifyCache
-} = require('@middy/util')
-const { Signer } = require('aws-sdk/clients/rds.js') // v2
-// const { RDS:{Signer} } = require('@aws-sdk/client-rds') // v3
+} from '@middy/util'
+import RDS from 'aws-sdk/clients/rds.js' // v2
+// import { RDS:{Signer} } from '@aws-sdk/client-rds' // v3
 
 const defaults = {
-  AwsClient: Signer,
+  AwsClient: RDS.Signer,
   awsClientOptions: {},
   fetchData: {}, // { contextKey: {region, hostname, username, database, port} }
   disablePrefetch: false,
   cacheKey: 'rds-signer',
   cacheExpiry: -1,
-  setToEnv: false,
   setToContext: false
 }
 
@@ -33,9 +32,9 @@ const rdsSignerMiddleware = (opts = {}) => {
       })
       // AWS doesn't support getAuthToken.promise() in aws-sdk v2 :( See https://github.com/aws/aws-sdk-js/issues/3595
       values[internalKey] = new Promise((resolve, reject) => {
-        client.getAuthToken({}, (err, token) => {
-          if (err) {
-            reject(err)
+        client.getAuthToken({}, (e, token) => {
+          if (e) {
+            reject(e)
           }
           // Catch Missing token, this usually means their is something wrong with the credentials
           if (!token.includes('X-Amz-Security-Token=')) {
@@ -44,7 +43,7 @@ const rdsSignerMiddleware = (opts = {}) => {
           resolve(token)
         })
       }).catch((e) => {
-        const value = getCache(options.cacheKey)?.value ?? {}
+        const value = getCache(options.cacheKey).value ?? {}
         value[internalKey] = undefined
         modifyCache(options.cacheKey, value)
         throw e
@@ -66,10 +65,9 @@ const rdsSignerMiddleware = (opts = {}) => {
 
     Object.assign(request.internal, value)
 
-    if (options.setToContext || options.setToEnv) {
+    if (options.setToContext) {
       const data = await getInternal(Object.keys(options.fetchData), request)
-      if (options.setToEnv) Object.assign(process.env, data)
-      if (options.setToContext) Object.assign(request.context, data)
+      Object.assign(request.context, data)
     }
 
     prefetch = null
@@ -79,4 +77,4 @@ const rdsSignerMiddleware = (opts = {}) => {
     before: rdsSignerMiddlewareBefore
   }
 }
-module.exports = rdsSignerMiddleware
+export default rdsSignerMiddleware

package/package.json

@@ -1,23 +1,25 @@
 {
   "name": "@middy/rds-signer",
-  "version": "2.5.6",
+  "version": "3.0.0-alpha.3",
   "description": "RDS (Relational Database Service) credentials middleware for the middy framework",
-  "type": "commonjs",
+  "type": "module",
   "engines": {
-    "node": ">=12"
+    "node": ">=14"
   },
   "engineStrict": true,
   "publishConfig": {
     "access": "public"
   },
-  "main": "index.js",
+  "exports": "./index.js",
   "types": "index.d.ts",
   "files": [
+    "index.js",
     "index.d.ts"
   ],
   "scripts": {
     "test": "npm run test:unit",
-    "test:unit": "ava"
+    "test:unit": "ava",
+    "test:benchmark": "node __benchmarks__/index.js"
   },
   "license": "MIT",
   "keywords": [
@@ -46,13 +48,13 @@
   },
   "homepage": "https://github.com/middyjs/middy#readme",
   "dependencies": {
-    "@middy/util": "^2.5.6"
+    "@middy/util": "^3.0.0-alpha.3"
   },
   "devDependencies": {
-    "@middy/core": "^2.5.6",
-    "@types/node": "^16.0.0",
+    "@middy/core": "^3.0.0-alpha.3",
+    "@types/node": "^17.0.0",
     "aws-sdk": "^2.939.0",
     "aws-xray-sdk": "^3.3.3"
   },
-  "gitHead": "0c789f55b4adf691f977b0d9904d1a805bb3bb2b"
+  "gitHead": "1441158711580313765e6d156046ef0fade0d156"
 }