@architect/inventory 6.0.0 → 6.1.0-RC.0

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@architect/inventory",
-  "version": "6.0.0",
+  "version": "6.1.0-RC.0",
   "description": "Architect project resource enumeration utility",
   "main": "src/index.js",
   "scripts": {
     "lint": "eslint . --fix",
     "test": "npm run lint && npm run test:integration && npm run test:coverage",
     "test:integration": "node --test --test-reporter=spec test/integration/*-test.js",
-    "test:coverage": "node --test --test-reporter=spec --experimental-test-coverage test/unit/**/*-test.js",
-    "test:unit": "node --test --test-reporter=spec test/unit/**/*-test.js",
+    "test:coverage": "node --test --test-reporter=spec --experimental-test-coverage --test-coverage-lines=100 --test-coverage-exclude='test/**/*' 'test/unit/**/*-test.js'",
+    "test:unit": "node --test --test-reporter=spec --test-coverage-exclude='test/**/*' 'test/unit/**/*-test.js'",
     "rc": "npm version prerelease --preid RC",
     "vendor": "scripts/vendor"
   },

package/src/config/pragmas/plugins.js

@@ -53,7 +53,6 @@ module.exports = async function getPluginModules ({ arc, inventory, errors }) {
 
     if (pluginPath) {
       try {
-        /* istanbul ignore next: idk why but for some reason nyc isn't picking up the catches; all cases are covered in tests, though! */
         if (type === 'plugin') {
           try {
             plugins[name] = require(pluginPath)
@@ -167,7 +166,8 @@ async function resolve (path, cwd) {
       catch {
         return
       }
-      /* istanbul ignore next: idk why but for some reason nyc isn't picking up the catches; all cases are covered in tests, though! */
+      // idk why but for some reason we aren't picking up the catches; all cases are covered in tests, though!
+      /* node:coverage ignore next 2 */
       if (gotSomething) return mjsPath
       else return
     }

package/src/config/pragmas/populate-lambda/_queues.js

@@ -0,0 +1,32 @@
+let { is, getLambdaDirs } = require('../../../lib')
+
+function getQueueBehaviorProps (item, name) {
+  let fifo = is.defined(item?.[name]?.fifo) ? item[name].fifo : null
+  let batchSize = is.defined(item?.[name]?.batchSize) ? item[name].batchSize : null
+  let batchWindow = is.defined(item?.[name]?.batchWindow) ? item[name].batchWindow : null
+  return { fifo, batchSize, batchWindow }
+}
+
+module.exports = function populateQueues (params) {
+  let { type, item, errors, plugin } = params
+
+  if (plugin) {
+    let { name, src } = item
+    if (name && src) {
+      return { ...item, ...getQueueBehaviorProps(item, name), ...getLambdaDirs(params, { plugin }) }
+    }
+    errors.push(`Invalid plugin-generated @${type} item: name: ${name}, src: ${src}`)
+    return
+  }
+  else if (is.string(item)) {
+    let name = item
+    let dirs = getLambdaDirs(params, { name })
+    return { name, ...getQueueBehaviorProps(item, name), ...dirs }
+  }
+  else if (is.object(item)) {
+    let name = Object.keys(item)[0]
+    let dirs = getLambdaDirs(params, { name, customSrc: item[name].src })
+    return { name, ...getQueueBehaviorProps(item, name), ...dirs }
+  }
+  errors.push(`Invalid @${type} item: ${item}`)
+}

package/src/config/pragmas/populate-lambda/get-handler.js

@@ -22,7 +22,6 @@ module.exports = function getHandler ({ config, src, build, errors }) {
   }
   // Compiled to a binary
   else if (customRuntimeType === 'compiled') {
-    /* istanbul ignore next */
     let bootstrap = `bootstrap${isWin ? '.exe' : ''}`
     handlerFile = join(build, runtimeConfig.buildSubpath || '', runtimeConfig.handlerFile || bootstrap)
     handlerMethod = null

package/src/config/pragmas/populate-lambda/get-lambda.js

@@ -2,6 +2,7 @@
 let getHTTP = require('./_http')
 let getEvents = require('./_events')
 let getCustomLambdas = require('./_custom-lambdas')
+let getQueues = require('./_queues')
 let getScheduled = require('./_scheduled')
 let getWS = require('./_ws')
 let getTablesStreams = require('./_tables-streams')
@@ -14,10 +15,9 @@ module.exports = function getLambda (params) {
   if (type === 'http')      return getHTTP(params)
   if (type === 'events')    return getEvents(params)
   if (type === cl)          return getCustomLambdas(params)
-  if (type === 'queues')    return getEvents(params) // Effectively the same as events
+  if (type === 'queues')    return getQueues(params)
   if (type === 'scheduled') return getScheduled(params)
   if (type === ts)          return getTablesStreams(params)
   if (type === 'tables')    return getTablesStreams(params) // Shortcut for creating streams
-  /* istanbul ignore else: clearer to be explicit here */
   if (type === 'ws')        return getWS(params)
 }

package/src/config/pragmas/populate-lambda/index.js

@@ -90,9 +90,13 @@ function populate (type, pragma, inventory, errors, plugin) {
     let config = defaultProjectConfig()
     config = { ...config, ...getKnownProps(configProps, result.config) }
 
-    // Knock out any pragma-specific early
+    // Knock out any pragma-specific bits early
     if (type === 'queues') {
-      config.fifo = config.fifo === undefined ? true : config.fifo
+      // Queues lifted up FIFO out of config and into top-level function semantics
+      // config.fifo remains for backward compat (until we want to make a breaking change), while also allowing queue functions to respect @aws global overrides
+      if (!is.nullish(result.fifo)) config.fifo = result.fifo
+      else if ((!is.nullish(config.fifo))) result.fifo = config.fifo
+      else config.fifo = result.fifo = true
     }
     if (type === 'http') {
       if (name.startsWith('get ') || name.startsWith('any ')) {
@@ -170,7 +174,7 @@ function populate (type, pragma, inventory, errors, plugin) {
 let normalize = path => path.replace(/[\\\/]/g, sep)
 
 // Lambda setter plugins can technically return anything, so this ensures everything is tidy
-let lambdaProps = [ 'cron', 'method', 'path', 'plugin', 'rate', 'route', 'table', 'type' ]
+let lambdaProps = [ 'cron', 'batchSize', 'batchWindow', 'fifo', 'method', 'path', 'plugin', 'rate', 'route', 'table', 'type' ]
 let configProps = [ ...Object.keys(defaultFunctionConfig()), 'fifo', 'views' ]
 let getKnownProps = (knownProps, raw = {}) => {
   let props = knownProps.flatMap(prop => is.defined(raw[prop]) ? [ [ prop, raw[prop] ] ] : [])

package/src/config/pragmas/sort/http.js

@@ -31,7 +31,8 @@ module.exports = function sortHTTP (http) {
   let sorted = []
   httpMethods.forEach(method => {
     if (!tree[method]) return
-    /* istanbul ignore next: random test shuffles may not trigger all paths */
+    // random test shuffles may not trigger all paths
+    /* node:coverage ignore next */
     tree[method]
       // Sort by depth
       .sort((a, b) => b.depth - a.depth)

package/src/config/pragmas/validate/_events.js

@@ -1,3 +1,4 @@
+let { is } = require('../../../lib')
 let { regex, size, unique } = require('./_lib')
 
 /**
@@ -38,6 +39,19 @@ module.exports = function validateEventsAndQueues (pragma, pragmaName, errors) {
       if (n.startsWith('aws') || n.startsWith('amazon')) {
         errors.push(`Invalid ${pragmaName} item (cannot start with 'AWS' or 'Amazon'): ${name}`)
       }
+
+      if (event.pragma === 'queues') {
+        let { fifo, batchSize, batchWindow } = event
+        if (!is.nullish(fifo) && !is.bool(fifo)) {
+          errors.push(`Invalid  ${pragmaName} item (fifo must be a boolean): ${name}`)
+        }
+        if (!is.nullish(batchSize) && !is.number(batchSize)) {
+          errors.push(`Invalid  ${pragmaName} item (batchSize must be a number): ${name}`)
+        }
+        if (!is.nullish(batchWindow) && !is.number(batchWindow)) {
+          errors.push(`Invalid  ${pragmaName} item (batchWindow must be a number): ${name}`)
+        }
+      }
     })
   }
 }

package/src/config/project/index.js

@@ -33,7 +33,6 @@ module.exports = function getProjectConfig (params) {
       _project[`${scope}PreferencesFile`] = p.preferencesFile
 
       // Build out the final preferences
-      /* istanbul ignore else: jic */
       if (!_project.preferences) _project.preferences = {}
       Object.keys(p.preferences).forEach(pragma => {
         // Ignore the raw data
@@ -44,7 +43,6 @@ module.exports = function getProjectConfig (params) {
           return
         }
         // Traverse and merge individual settings
-        /* istanbul ignore else: jic */
         if (!_project.preferences[pragma]) _project.preferences[pragma] = {}
         Object.entries(p.preferences[pragma]).forEach(([ setting, value ]) => {
           _project.preferences[pragma][setting] = value

package/src/config/project/prefs/dotenv.js

@@ -1,7 +1,7 @@
 // Copyright (c) 2015, Scott Motte
 // All rights reserved.
 
-/* istanbul ignore file */
+/* node:coverage disable */
 /* eslint-disable */
 // node_modules/dotenv/lib/main.js
 var fs = require("fs");

package/src/config/project/prefs/index.js

@@ -25,13 +25,14 @@ module.exports = function getPrefs ({ scope, inventory, errors }) {
     // Arc outputs an object of nested arrays
     // Basically, construct a pared-down intermediate prefs obj for consumers
     Object.entries(prefs.arc).forEach(([ key, val ]) => {
-      /* istanbul ignore else: Parser should get this, but jic */
+      // Parser should get this, but jic ignore the else - except node test doesn't do ignore else
       if (!preferences[key]) preferences[key] = {}
-      /* istanbul ignore else: Parser should only produce arrays, but jic */
+      // Parser should only produce arrays, but jic
+      /* node:coverage ignore next */
       if (is.array(val)) {
         val.forEach(v => {
           if (is.array(v)) {
-            /* istanbul ignore if: Single vals should be strings, but jic */
+            // Single vals should be strings, but jic - except node test doesn't do ignore if
             if (v.length === 1) preferences[key] = v[0]
             if (v.length === 2) preferences[key][v[0]] = v[1]
             if (v.length > 2)   preferences[key][v[0]] = [ ...v.slice(1) ]
@@ -46,7 +47,8 @@ module.exports = function getPrefs ({ scope, inventory, errors }) {
       // Turn env vars with spaces into strings
       if (key === 'env') {
         [ 'testing', 'staging', 'production' ].forEach(e => {
-          /* istanbul ignore else: Yet another jic */
+          // Yet another jic
+          /* node:coverage ignore next */
           if (preferences.env[e]) {
             Object.entries(preferences.env[e]).forEach(([ key, val ]) => {
               if (!valid.envVar.test(key)) {
@@ -62,7 +64,8 @@ module.exports = function getPrefs ({ scope, inventory, errors }) {
       if (key === 'sandbox-start' || key === 'sandbox-startup') {
         preferences[key] = val.map(v => {
           if (is.string(v)) return v
-          /* istanbul ignore else: Yet another jic */
+          // Yet another jic
+          /* node:coverage ignore next */
           if (is.array(v)) return v.join(' ')
         })
       }

package/src/defaults/function-config.js

@@ -5,7 +5,7 @@ module.exports = function createDefaultFunctionConfig () {
   return {
     timeout: 5,
     memory: 1152,
-    runtime: 'nodejs20.x',
+    runtime: 'nodejs22.x',
     architecture: 'arm64',
     handler: 'index.handler',
     state: 'n/a',

package/src/env/index.js

@@ -13,7 +13,7 @@ module.exports = function env (params, inventory, callback) {
   let { profile, region } = inventory.aws
   let result = []
   let awsLite = require('@aws-lite/client')
-  /* istanbul ignore next */
+  /* node:coverage ignore next */
   awsLite({ profile, region, plugins: [ import('@aws-lite/ssm') ] }).then(_aws => {
     aws = _aws
 

package/src/index.js

@@ -67,7 +67,6 @@ module.exports = function architectInventory (params = {}, callback) {
 
   // @plugins come first, as they register hooks all around the project
   plugins(project, (err, result) => {
-    /* istanbul ignore next: yeah we know what happens here */
     if (err) callback(err)
     else {
       inventory.plugins = result
@@ -102,7 +101,6 @@ module.exports = function architectInventory (params = {}, callback) {
 
       // Maybe get env vars
       getEnv(params, inventory, function done (err) {
-        /* istanbul ignore next: yeah we know what happens here */
         if (err) callback(err)
         else {
           callback(null, {

package/src/lib/asap-src.js

@@ -19,8 +19,8 @@ module.exports = function asapSrc (params = {}) {
   try {
     return require.resolve('@architect/asap')
   }
+  /* node:coverage ignore next 3 */
   catch {
-    /* istanbul ignore next */
     throw Error('Cannot find ASAP module!')
   }
 }