hbd!

Author: ryanblock

.github/code_of_conduct.md

@@ -0,0 +1,21 @@
+# Architect Code of Conduct
+
+We are strongly committed to ensuring the Architect community, and the various online and offline spaces in which its members congregate and collaborate, are safe, positive, inclusive, constructive, and welcoming environments.
+
+As such, the Architect project adheres to the [OpenJS Foundation Code of Conduct](https://github.com/openjs-foundation/cross-project-council/blob/master/CODE_OF_CONDUCT.md), which itself adheres to the [Contributor Covenant](https://www.contributor-covenant.org).
+
+Lack of familiarity with this or the OpenJS Foundation Codes of Conduct, or the Contributor covenant, is not an excuse for non-adherence.
+
+
+# Reporting
+If you are the subject of any behavior prohibited by this Code of Conduct, or observe someone who is, please contact an Architect team member immediately.
+
+If you know an Architect team member, you may wish to contact them personally (and you should); but if not, please [contact us via email](mailto:[email protected]).
+
+If possible, please attempt to collect any relevant information and evidence, including links, screenshots, or other recordings of any incident.
+
+Reports will be handled with the utmost care, confidence, and sensitivity towards the individual(s) reporting.
+
+
+# Enforcement
+Should incidents arise, upon adjudication those found to be in violation of this Code of Conduct may be immediately expelled from the Architect community, including events, forums, chat workspaces, code repositories, and any other place where Architect community members collaborate.

.github/contributing.md

@@ -0,0 +1,8 @@
+# Contributing
+
+## First: go read the [Architect Code of Conduct](/.github/code_of_conduct.md)
+
+### Agreement to the Architect Code of Conduct
+By participating in and contributing to the Architect community — including, but not limited to its open source projects, any related online venues such as GitHub, Slack, and in-person events, etc. — you agree to the [Architect Code of Conduct](/.github/code_of_conduct.md).
+
+Lack of familiarity with this Code of Conduct is not an excuse for not adhering to it.

.github/pull_request_template.md

@@ -0,0 +1,22 @@
+## Thank you for helping out! ✨
+
+### We really appreciate your commitment to improving Architect
+
+To maintain a high standard of quality in our releases, before merging every pull request we ask that you've completed the following:
+
+- [ ] Forked the repo and created your branch from `master`
+- [ ] Made sure tests pass (run `npm it` from the repo root)
+- [ ] Expanded test coverage related to your changes:
+  - [ ] Added and/or updated unit tests (if appropriate)
+  - [ ] Added and/or updated integration tests (if appropriate)
+- [ ] Updated relevant documentation:
+  - [ ] Internal to this repo (e.g. `readme.md`, help docs, inline docs & comments, etc.)
+  - [ ] [Architect docs (arc.codes)](https://github.com/architect/arc.codes)
+- [ ] Summarized your changes in `changelog.md`
+- [ ] Linked to any related issues, PRs, etc. below that may relate to, consume, or necessitate these changes
+
+Please also be sure to completed the CLA (if you haven't already).
+
+Learn more about [contributing to Architect here](https://arc.codes/intro/community).
+
+Thanks again!

.github/workflows/build.yml

@@ -0,0 +1,79 @@
+name: Node CI
+
+# Push tests pushes; PR tests merges
+on: [ push, pull_request ]
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+
+  # Test the build
+  build:
+    # Setup
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        node-version: [ 14.x, 16.x ]
+        os: [ windows-latest, ubuntu-latest, macOS-latest ]
+
+    # Go
+    steps:
+    - name: Check out repo
+      uses: actions/checkout@v2
+
+    - name: Set up Node.js
+      uses: actions/setup-node@v2
+      with:
+        node-version: ${{ matrix.node-version }}
+
+    - name: Env
+      run: |
+        echo "Event name: ${{ github.event_name }}"
+        echo "Git ref:    ${{ github.ref }}"
+        echo "GH actor:   ${{ github.actor }}"
+        echo "SHA:        ${{ github.sha }}"
+        VER=`node --version`; echo "Node ver:   $VER"
+        VER=`npm --version`; echo "npm ver:    $VER"
+
+    - name: Install
+      run: npm install
+
+    - name: Test
+      run: npm test
+      env:
+        CI: true
+
+  # ----- Only git tag testing + package publishing beyond this point ----- #
+
+  # Publish to package registries
+  publish:
+    # Setup
+    needs: build
+    if: startsWith(github.ref, 'refs/tags/v')
+    runs-on: ubuntu-latest
+
+    # Go
+    steps:
+      - name: Check out repo
+        uses: actions/checkout@v2
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: 14
+          registry-url: https://registry.npmjs.org/
+
+      # Publish to npm
+      - name: Publish @RC to npm
+        if: contains(github.ref, 'RC')
+        run: npm publish --tag RC
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Publish @latest to npm
+        if: contains(github.ref, 'RC') == false #'!contains()'' doesn't work lol
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.npmrc

@@ -0,0 +1 @@
+package-lock=false

package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@architect/plugin-lambda-invoker",
+  "version": "0.0.0",
+  "description": "Interactively invoke Lambdas in Architect Sandbox with arbitrary events",
+  "main": "src/index.js",
+  "scripts": {
+    "test": "npm run lint",
+    "lint": "eslint . --fix"
+  },
+  "engines": {
+    "node": ">=14"
+  },
+  "files": [
+    "src/*"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/architect/plugin-lambda-invoker.git"
+  },
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/architect/plugin-lambda-invoker/issues"
+  },
+  "homepage": "https://github.com/architect/plugin-lambda-invoker#readme",
+  "dependencies": {
+    "@architect/utils": "^3.0.4",
+    "enquirer": "^2.3.6"
+  },
+  "devDependencies": {
+    "@architect/eslint-config": "^2.0.1",
+    "eslint": "^8.11.0"
+  },
+  "eslintConfig": {
+    "extends": "@architect/eslint-config"
+  },
+  "keywords": [
+    "arc",
+    "architect",
+    "plugin",
+    "lambda"
+  ]
+}

readme.md

@@ -0,0 +1,84 @@
+[<img src="https://assets.arc.codes/[email protected]" width=500>](https://www.npmjs.com/package/@architect/architect/plugin-lambda-invoker)
+
+## [`@architect/architect/plugin-lambda-invoker`](https://www.npmjs.com/package/@architect/architect/plugin-lambda-invoker)
+
+> Interactively invoke Lambdas in Architect Sandbox with arbitrary events
+
+[![GitHub CI status](https://github.com/architect/architect/plugin-lambda-invoker/workflows/Node%20CI/badge.svg)](https://github.com/architect/architect/plugin-lambda-invoker/actions?query=workflow%3A%22Node+CI%22)
+
+
+## Install
+
+Into your existing Architect project:
+
+```sh
+npm i @architect/architect/plugin-lambda-invoker --save-dev
+```
+
+Add the following to your Architect project manifest (usually `app.arc`):
+
+```arc
+@plugins
+architect/architect/plugin-lambda-invoker
+```
+
+
+## Usage
+
+While Sandbox is running, type `i` in your terminal to bring up the Lambda invocation menu. Then select the Lambda you'd like to invoke.
+
+By default, this plugin will populate your menu with all `@events`, `@queues`, `@scheduled`, and `@tables-streams`; you can limit this menu (or expand it with additional pragmas) by adding the following setting to a `pref[erence]s.arc` file:
+
+```arc
+@sandbox
+invoker http scheduled # This would populate @http + @scheduled Lambdas, and ignore all others
+```
+
+> Tip: you can navigate the invocation menu by typing numbers (zero-indexed)!
+
+
+### Invocation mocks
+
+By default, Lambdas are invokved with an empty payload (`{}`); if you'd like to invoke your Lambdas with arbitrary payloads, create a file containing invocation mocks.
+
+Invocation mock files live in your root with one of these filenames: `sandbox-invoke-mocks.json` or `sandbox-invoke-mocks.js`. These files should be structured like so:
+
+Assuming this project manifest:
+
+```arc
+@events
+background-task
+
+@queues
+analytics
+
+@scheduled
+backup-database
+```
+
+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]`:
+
+```js
+module.exports = {
+  events: {
+    'background-task': {
+      'my-first-mock': { /* payload */ },
+      'another-mock': { /* payload */ },
+    }
+  },
+  queues: {
+    analytics: {
+      'one-more-mock': { /* payload */ },
+      'just-a-mock': { /* payload */ },
+    }
+  },
+  scheduled: {
+    'backup-database': {
+      'a-mock-for-this': { /* payload */ },
+      'the-last-mock': { /* payload */ },
+    }
+  },
+}
+```
+
+> Tip: when using `sandbox-invoke-mocks.js`, you can dynamically (synchronously) generate mocks on startup

src/index.js

@@ -0,0 +1,120 @@
+let { join } = require('path')
+let { existsSync, readFileSync } = require('fs')
+let { updater } = require('@architect/utils')
+let { prompt } = require('enquirer')
+let colors = require('ansi-colors')
+let update = updater('Invoker')
+
+module.exports = {
+  sandbox: {
+    start: async ({ inventory: { inv }, invoke }) => {
+      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')
+      let jsMocks = join(cwd, 'sandbox-invoke-mocks.js')
+
+      let pragmas = [ 'events', 'queues', 'scheduled', 'tables-streams' ]
+      let prefs = preferences?.sandbox?.invoker
+      if (prefs) {
+        if (Array.isArray(prefs)) pragmas = prefs
+        else if (typeof prefs === 'string') pragmas = [ prefs ]
+        else throw Error('Invalid @architect/plugin-lambda-invoker plugin preferences')
+      }
+
+      // Build out the availble event list
+      let events = {}
+      pragmas.forEach(pragma => {
+        if (inv[pragma]) inv[pragma].forEach(({ name }) => {
+          events[`@${pragma} ${name}`] = { pragma, name }
+        })
+      })
+      // Add a cancel option should one desire
+      events.cancel = ''
+
+      process.stdin.on('data', async function eventInvokeListener (input) {
+        input = String(input)
+        // Reset Enquirer's styles
+        let options = {
+          prefix: colors.white(colors.symbols.question),
+          styles: {
+            em: colors.cyan, // Clear underlines
+            danger: colors.red,
+            strong: colors.white,
+          }
+        }
+        if (input === 'i') {
+          if (Object.keys(events).length === 1) {
+            let none = 'No Lambdas found to invoke'
+            if (pragmas.length) update.status(none, `Using the following pragmas: @${pragmas.join(', @')}`)
+            else update.status(none)
+            return
+          }
+
+          let payload = {}
+          let mocks
+          let mockName = 'empty'
+
+          // Load invocation mocks
+          if (existsSync(jsonMocks)) {
+            mocks = JSON.parse(readFileSync(jsonMocks))
+          }
+          else if (existsSync(jsMocks)) {
+            // Make sure changes to mocks are always reflected
+            delete require.cache[require.resolve(jsMocks)]
+            // eslint-disable-next-line
+            mocks = require(jsMocks)
+          }
+
+          let { lambda } = await prompt({
+            type: 'select',
+            name: 'lambda',
+            numbered: true,
+            message: 'Which event do you want to invoke?',
+            hint: '\nYou can use numbers to change your selection',
+            choices: Object.keys(events),
+          }, options)
+          if (lambda === 'cancel') return end()
+          let { pragma, name } = events[lambda]
+
+          // Present options for mocks (if any)
+          if (mocks?.[pragma]?.[name]) {
+            let selection = await prompt({
+              type: 'select',
+              name: 'mock',
+              numbered: true,
+              message: 'Which mock do you want to invoke?',
+              choices: [ ...Object.keys(mocks[pragma][name]), 'empty' ],
+            }, options)
+            mockName = selection.mock
+            payload = mocks[pragma][name][mockName] || {}
+          }
+
+          // Wrap it up and invoke!
+          let msg = `Invoking @${pragma} ${name}`
+          msg += ` with ${mockName === 'empty' ? 'empty' : `'${mockName}'`} payload`
+          update.status(msg)
+          await invoke({ pragma, name, payload })
+          end()
+        }
+      })
+    },
+    end: async () => {
+      // Only remove our listener; removing Enquirer causes funky behavior
+      process.stdin.rawListeners('data').forEach(fn => {
+        if (fn.name === 'eventInvokeListener') {
+          process.stdin.removeListener('data', fn)
+        }
+      })
+      end()
+    }
+  }
+}
+
+// Necessary per Enquirer #326
+function end () {
+  if (process.stdin.isTTY) {
+    process.stdin.setRawMode(true)
+    process.stdin.setEncoding('utf8')
+    process.stdin.resume()
+  }
+}