Added event source mocks for @events, queues, @scheduled, @tables-streams

Author: ryanblock

changelog.md

@@ -0,0 +1,12 @@
+# Architect Lambda invoker plugin
+
+---
+
+## [0.1.0] 2022-03-27
+
+### Added
+
+- Added event source mocks for `@events`, `queues`, `@scheduled`, `@tables-streams`
+- Added warning for empty payloads on all invocations of pragmas not noted
+
+---

package.json

@@ -8,7 +8,7 @@
     "lint": "eslint . --fix"
   },
   "engines": {
-    "node": ">=14"
+    "node": ">=14.17.0"
   },
   "files": [
     "src/*"

src/event-mocks.js

@@ -0,0 +1,57 @@
+let { randomUUID } = require('crypto')
+
+// Sit back and enjoy AWS's hilarious mix of Pascal-case, camel-case, and lowcase, sometimes even within the same event sources
+module.exports = {
+  events,
+  queues,
+  scheduled,
+  tablesStreams,
+}
+
+function events (Message) {
+  return { Records: [ { Sns: { Message } } ] } // this is fine
+}
+
+function queues (body) {
+  return { Records: [ { body } ] } // also fine
+}
+
+function scheduled () {
+  return {
+    version: 0,
+    id: randomUUID(),
+    'detail-type': 'Scheduled Event',
+    source: 'aws.events',
+    account: 123456789012,
+    time: new Date().toISOString(),
+    region: 'Sandbox',
+    resources: [
+      'arn:architect-sandbox'
+    ],
+    detail: {}
+  }
+}
+
+function tablesStreams (eventName) {
+  return {
+    Records: [
+      {
+        eventID: randomUUID().replace(/-/g, '').substr(0, 32),
+        eventName,
+        eventVersion: '1.1',
+        eventSource: 'aws:dynamodb',
+        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 },
+          SequenceNumber: 0,
+          SizeBytes: 0,
+          StreamViewType: 'NEW_AND_OLD_IMAGES'
+        },
+        eventSourceARN: 'arn:architect-sandbox'
+      }
+    ]
+  }
+}

src/index.js

@@ -4,10 +4,12 @@ let { updater } = require('@architect/utils')
 let { prompt } = require('enquirer')
 let colors = require('ansi-colors')
 let update = updater('Invoker')
+let mock = require('./event-mocks')
 
 module.exports = {
   sandbox: {
     start: async ({ inventory: { inv }, invoke }) => {
+      start()
       update.status(`Event invoker started, select an event to invoke by pressing 'i'`)
       let { cwd, preferences } = inv._project
       let jsonMocks = join(cwd, 'sandbox-invoke-mocks.json')
@@ -51,7 +53,7 @@ module.exports = {
             return
           }
 
-          let payload = {}
+          let userPayload = {}
           let mocks
           let mockName = 'empty'
 
@@ -78,7 +80,8 @@ module.exports = {
           let { pragma, name } = events[lambda]
 
           // Present options for mocks (if any)
-          if (mocks?.[pragma]?.[name]) {
+          let mockable = ![ 'scheduled', 'tables-streams' ].includes(pragma)
+          if (mocks?.[pragma]?.[name] && mockable) {
             let selection = await prompt({
               type: 'select',
               name: 'mock',
@@ -87,7 +90,27 @@ module.exports = {
               choices: [ ...Object.keys(mocks[pragma][name]), 'empty' ],
             }, options)
             mockName = selection.mock
-            payload = mocks[pragma][name][mockName] || {}
+            userPayload = mocks[pragma][name][mockName] || {}
+          }
+
+          let payload
+          /**/ if (pragma === 'events') payload = mock.events(userPayload)
+          else if (pragma === 'queues') payload = mock.queues(userPayload)
+          else if (pragma === 'scheduled') payload = mock.scheduled()
+          else if (pragma === 'tables-streams') {
+            let { eventName } = await prompt({
+              type: 'select',
+              name: 'eventName',
+              message: 'Which kind of Dynamo Stream event do you want to invoke?',
+              choices: [ 'INSERT', 'MODIFY', 'REMOVE' ]
+            })
+            payload = mock.tablesStreams(eventName)
+          }
+          else {
+            if (!Object.keys(userPayload).length) {
+              update.warning('Warning: real AWS event sources generally do not emit empty payloads')
+            }
+            payload = userPayload
           }
 
           // Wrap it up and invoke!
@@ -119,6 +142,8 @@ function start () {
     process.stdin.resume()
   }
 }
+
+// Super important to pause stdin, or Sandbox will hang forever in tests
 function end () {
   if (process.stdin.isTTY) {
     process.stdin.pause()