Adds a function to utilize the aws-sdk marshall method for parsing JSON

Let, Optional Chaining, Default to not mocked

Author: dakota002

.gitignore

@@ -1 +1,3 @@
 scratch/
+node_modules
+.vscode

changelog.md

@@ -1,5 +1,11 @@
 # Architect Lambda invoker plugin
 
+---
+## [1.2.1] 2024-04-23
+
+### Added
+- Added functionality for passing unmarshalled json as the payload for tables-streams invocations
+
 ---
 
 ## [1.2.0] 2023-08-30
@@ -27,6 +33,29 @@
 
 ---
 
+## [1.1.0] 2023-08-07
+
+### Added
+
+- Added support from mocks in `sandbox-invoke-mocks.cjs`, `sandbox-invoke-mocks.mjs` filenames, and importing as ES modules from `sandbox-invoke-mocks.js` (and `.mjs`, of course); fixes #6, thanks @danactive!
+  - Note: per [Node.js #2806](https://github.com/nodejs/help/issues/2806), ES module data may be cached in Sandbox, which is intended to be a semi-long-lived process. If using ES modules, you may need to restart Sandbox when updating your mocks.
+
+---
+
+## [1.0.1] 2023-07-31
+
+### Fixed
+
+- Fixed missing `ansi-colors` dependency; thanks @lpsinger!
+
+---
+
+## [1.0.1] 2023-03-22
+
+### Added
+- Added functionality for passing unmarshalled json as the payload for tables-streams invocations
+
+
 ## [1.0.0] 2023-02-10
 
 ### Added

package.json

@@ -25,6 +25,7 @@
   "homepage": "https://github.com/architect/plugin-lambda-invoker#readme",
   "dependencies": {
     "@architect/utils": "^3.1.2",
+    "@aws-sdk/util-dynamodb": "^3.296.0",
     "ansi-colors": "^4.1.1",
     "enquirer": "^2.3.6"
   },

readme.md

@@ -74,6 +74,9 @@ analytics
 
 @scheduled
 backup-database
+
+@tables-streams
+tableName
 ```
 
 If you wanted to add one or more mocks to each of the three Lambdas above, create the following `sandbox-invoke-mocks.js` (or equivalent JSON) file with the format of `[pragmaName][lambdaName][mockName]`:
@@ -98,6 +101,13 @@ module.exports = {
       'the-last-mock': { /* payload */ },
     }
   },
+  'tables-streams':{
+    tableName:{
+      INSERT:{ /* payload */ },
+      MODIFY:{ /* payload */ },
+      REMOVE:{ /* payload */ },
+    }
+  }
 }
 ```
 

src/event-mocks.js

@@ -39,7 +39,7 @@ function scheduled () {
   }
 }
 
-function tablesStreams (eventName) {
+function tablesStreams (eventName, dynamoData) {
   return {
     Records: [
       {
@@ -50,9 +50,8 @@ function tablesStreams (eventName) {
         awsRegion: 'Sandbox',
         dynamodb: {
           ApproximateCreationDateTime: new Date() / 1000,
-          // Keys + NewImage are in DynamoDB JSON, perhaps we can mock transform that later
-          Keys: { NOT_MOCKED: true },
-          NewImage: { NOT_MOCKED: true },
+          Keys: dynamoData?.Keys ?? { NOT_MOCKED: true },
+          NewImage: dynamoData?.NewImage ?? { NOT_MOCKED: true },
           SequenceNumber: 0,
           SizeBytes: 0,
           StreamViewType: 'NEW_AND_OLD_IMAGES'

src/index.js

@@ -5,7 +5,9 @@ let { prompt } = require('enquirer')
 let colors = require('ansi-colors')
 let update = updater('Invoker')
 let mock = require('./event-mocks')
+let { marshall } = require('@aws-sdk/util-dynamodb')
 let deactivatedInvoke = async () => console.log('Sandbox not yet started!')
+
 let lastInvoke
 
 let sandbox = {
@@ -140,7 +142,7 @@ let sandbox = {
             message: 'Which kind of Dynamo Stream event do you want to invoke?',
             choices: [ 'INSERT', 'MODIFY', 'REMOVE' ]
           })
-          payload = mock.tablesStreams(eventName)
+          payload = mock.tablesStreams(eventName, marshallJson(mocks?.[pragma]?.[name]?.[eventName]))
         }
         else {
           if (!Object.keys(userPayload).length) {
@@ -212,7 +214,7 @@ async function getMod (filepath) {
   }
   catch (err) {
     if (hasEsmError(err)) {
-      let path =  process.platform.startsWith('win')
+      let path = process.platform.startsWith('win')
         ? 'file://' + filepath
         : filepath
       let imported = await import(path)
@@ -225,3 +227,12 @@ async function getMod (filepath) {
 
   return mod
 }
+// Marshalls Json from the mock into keys and newimage for tables-streams
+function marshallJson (json) {
+  const marshalled = marshall(json)
+  const Keys = Object.keys(marshalled).reduce((keys, key) => {
+    keys[key] = { [Object.keys(marshalled[key])[0]]: true }
+    return keys
+  }, {})
+  return { Keys, NewImage: marshalled }
+}