@architect/inventory 3.2.0 → 3.3.0-RC.0

package/changelog.md

@@ -2,6 +2,36 @@
 
 ---
 
+## [3.3.0] 2022-09-06
+
+### Changed
+
+- Node 14+ Lambda handler selection now defaults to ESM (unless otherwise specified)
+
+---
+
+## [3.2.2] 2022-08-20
+
+### Changed
+
+- Enabled `hydrate` plugin API support
+
+---
+
+## [3.2.1] 2022-08-10
+
+### Changed
+
+- By default, when a `set.shared|views` plugin sets a `src` path, if it is not present on the filesystem, Inventory falls back to default paths (e.g. `src/shared|views`)
+  - `set.shared|views` plugins now accept a `required` flag to enforce a validation error should a `src` path conflict with the project manifest (or not be found on the filesystem)
+
+
+### Fixed
+
+- Fixed an obscure internal reference passing bug in `set.proxy|shared|static|views` plugins
+
+---
+
 ## [3.2.0] 2022-07-24
 
 ### Added

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@architect/inventory",
-  "version": "3.2.0",
+  "version": "3.3.0-RC.0",
   "description": "Architect project resource enumeration utility",
   "main": "src/index.js",
   "scripts": {

package/src/config/pragmas/plugins.js

@@ -4,7 +4,7 @@ let { is, normalizeSrc, pragmas, tidyError, validationPatterns } = require('../.
 let { lambdas } = pragmas
 let nonLambdaSetters = [ 'customLambdas', 'env', 'proxy', 'runtimes', 'shared', 'static', 'views', 'tables', 'tables-indexes' ]
 let setters = [ ...lambdas, ...nonLambdaSetters ]
-let pluginMethods = [ 'deploy', 'sandbox' ]
+let pluginMethods = [ 'deploy', 'hydrate', 'sandbox' ]
 let reservedNames = [ '_methods' ]
 
 module.exports = function getPluginModules ({ arc, inventory, errors }) {

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

@@ -32,6 +32,7 @@ module.exports = function getHandler ({ config, src, build, errors }) {
   return handlerConfig
 }
 
+// As of nodejs14.x, CJS remains the default over ESM when both are present
 let nodeHandlers = [ 'index.js', 'index.mjs', 'index.cjs' ]
 let denoHandlers = [ 'mod.ts', 'mod.js' ]
   // TODO: these are all prob going away
@@ -43,14 +44,22 @@ function getExt ({ runtime, src, errors }) {
       if (runtime === 'nodejs12.x') {
         return { ext: 'js', handlerModuleSystem: 'cjs' }
       }
-      // This presumes Node.js 14.x+ Lambda releases use the same CJS/ESM pattern
+      // This presumes Node.js ≥14 Lambda releases use the same CJS/ESM pattern
+      // Generally in Lambda: CJS wins, but in Architect-land we attempt to default to ESM
       else {
-        let { file, ext = 'js' } = findHandler(nodeHandlers, src)
+        let { file, ext = 'mjs' } = findHandler(nodeHandlers, src)
         let handlerModuleSystem = ext === 'mjs' ? 'esm' : 'cjs'
         let pkgFile = join(src, 'package.json')
         if (existsSync(pkgFile)) {
           let pkg = JSON.parse(readFileSync(pkgFile))
-          handlerModuleSystem = getModSystem(pkg)
+
+          /**/ if (pkg?.type === 'module') handlerModuleSystem = 'esm'
+          else if (pkg?.type === 'commonjs') handlerModuleSystem = 'cjs'
+          else if (pkg?.type) throw Error(`Invalid 'type' field: ${pkg.type}`)
+          else handlerModuleSystem = 'cjs' // Lambda's default, not ours
+
+          // We always get to make this a .js file, even if it's ESM!
+          ext = 'js'
         }
         return { file, ext, handlerModuleSystem }
       }
@@ -78,10 +87,3 @@ function findHandler (arr, src){
   }
   return {}
 }
-
-function getModSystem (pkg) {
-  if (pkg?.type === 'module') return 'esm'
-  else if (pkg?.type === 'commonjs') return 'cjs'
-  else if (pkg?.type) throw Error(`Invalid 'type' field: ${pkg.type}`)
-  return 'cjs'
-}

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

@@ -75,9 +75,9 @@ function validate (item, valid, type) {
  */
 function settings (params) {
   let { errors, settings, plugins, inventory, type, valid } = params
+  let newSettings = is.defined(settings) ? JSON.parse(JSON.stringify(settings)) : settings
   if (plugins) {
     let invCopy = deepFrozenCopy(inventory)
-    let pluginSettings = settings
     let foundError = false
     plugins.forEach(fn => {
       try {
@@ -95,7 +95,7 @@ function settings (params) {
       else {
         Object.entries(result).forEach(([ setting, value ]) => {
           if (is.defined(settings[setting]) && is.defined(value)) {
-            pluginSettings[setting] = value
+            newSettings[setting] = value
           }
         })
       }
@@ -103,15 +103,15 @@ function settings (params) {
     if (foundError) return null
 
     // Validation pass
-    let validationErrors = validate(pluginSettings, valid, type)
+    let validationErrors = validate(newSettings, valid, type)
     if (validationErrors.length) {
       errors = errors.push(...validationErrors)
       return null
     }
 
-    return pluginSettings
+    return newSettings
   }
-  return settings
+  return newSettings
 }
 
 module.exports = { resources, settings }

package/src/config/pragmas/shared.js

@@ -14,10 +14,10 @@ module.exports = function configureShared ({ arc, pragmas, inventory, errors })
     shared: []
   }
 
-  let foundSrcSetting = false
+  let foundPluginSrc, foundArcSrc, required = false
   let pluginSrc = populate.settings({
     errors,
-    settings: shared,
+    settings: { ...shared, required: null },
     plugins: inventory.plugins?._methods?.set?.shared,
     inventory,
     type: 'shared',
@@ -27,33 +27,45 @@ module.exports = function configureShared ({ arc, pragmas, inventory, errors })
   // Lambda paths have not yet been reified in Inventory
   if (is.string(pluginSrc?.src)) {
     shared.src = pluginSrc.src
-    foundSrcSetting = true
+    required = pluginSrc.required
+    foundPluginSrc = true
   }
 
   // First pass to get + check shared folder (if any)
   if (arc?.shared?.length) {
     for (let share of arc.shared) {
-      if (is.array(share)) {
-        let key = share[0]?.toLowerCase()
-        if (key === 'src' && is.string(share[1])) {
+      if (is.array(share) && share[0]?.toLowerCase() === 'src') {
+        if (is.string(share[1])) {
           shared.src = share[1]
-          foundSrcSetting = true
+          foundArcSrc = true
+          if (required) errors.push(`@shared src setting conflicts with plugin`)
           continue
         }
-        if (key === 'src' && !is.string(share[1])) {
-          errors.push(`@shared invalid setting: ${key}`)
-        }
+        else errors.push(`@shared invalid setting: src`)
       }
     }
   }
 
-  if (foundSrcSetting) validate.shared(shared.src, cwd, errors)
-  else shared.src = src
-
+  // Source path selection + validation: manifest always wins; validate plugins differently if required; if not, fall back to `src/shared` (or null)
+  if (foundArcSrc) {
+    validate.shared(shared.src, cwd, errors, true)
+  }
+  else if (foundPluginSrc) {
+    if (!required) {
+      if (!is.exists(shared.src)) shared.src = src
+      if (!is.exists(shared.src)) return null
+    }
+    validate.shared(shared.src, cwd, errors, required)
+  }
+  else if (is.exists(src)) {
+    shared.src = src
+    validate.shared(shared.src, cwd, errors, false)
+  }
   // Exit if configured shared folder doesn't exist
-  if (!is.exists(shared.src)) return null
+  else return null
 
   // Proceeding from here resets all shared config, so make sure it's only if specific shared are specified
+  let foundSrcSetting = foundArcSrc || foundPluginSrc
   let some = arc.shared?.length && !(arc?.shared?.length === 1 && foundSrcSetting)
   if (some) {
     // Reset shared settings

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

@@ -1,13 +1,12 @@
 let { join, resolve, sep } = require('path')
 let { is } = require('../../../lib')
 
-module.exports = function validateShared (src, cwd, errors) {
-  let path = src && src.startsWith(cwd) ? src : resolve(join(cwd, src))
+module.exports = function validateShared (src, cwd, errors, required) {
+  let path = src?.startsWith(cwd) ? src : resolve(join(cwd, src))
 
-  if (!is.exists(path)) errors.push(`Directory not found: ${src}`)
-  else if (!is.folder(path)) errors.push(`Must be a directory: ${src}`)
+  if (is.exists(path) && !is.folder(path)) errors.push(`Must be a directory: ${src}`)
+  else if (!is.exists(path) && required) errors.push(`Directory not found: ${src}`)
 
-  let valid = path && path.startsWith(cwd) &&
-              (cwd.split(sep) < path.split(sep))
+  let valid = path?.startsWith(cwd) && (cwd.split(sep) < path.split(sep))
   if (!valid) errors.push(`Directory must be a subfolder of this project: ${src}`)
 }

package/src/config/pragmas/views.js

@@ -18,10 +18,10 @@ module.exports = function configureViews ({ arc, pragmas, inventory, errors }) {
     views: []
   }
 
-  let foundSrcSetting = false
+  let foundPluginSrc, foundArcSrc, required = false
   let pluginSrc = populate.settings({
     errors,
-    settings: views,
+    settings: { ...views, required: null },
     plugins: inventory.plugins?._methods?.set?.views,
     inventory,
     type: 'views',
@@ -31,33 +31,45 @@ module.exports = function configureViews ({ arc, pragmas, inventory, errors }) {
   // Lambda paths have not yet been reified in Inventory
   if (is.string(pluginSrc?.src)) {
     views.src = pluginSrc.src
-    foundSrcSetting = true
+    required = pluginSrc.required
+    foundPluginSrc = true
   }
 
   // First pass to get + check views folder (if any)
   if (arc?.views?.length) {
     for (let view of arc.views) {
-      if (is.array(view)) {
-        let key = view[0]?.toLowerCase()
-        if (key === 'src' && is.string(view[1])) {
+      if (is.array(view) && view[0]?.toLowerCase() === 'src') {
+        if (is.string(view[1])) {
           views.src = view[1]
-          foundSrcSetting = true
+          foundArcSrc = true
+          if (required) errors.push(`@views src setting conflicts with plugin`)
           continue
         }
-        if (key === 'src' && !is.string(view[1])) {
-          errors.push(`@shared invalid setting: ${key}`)
-        }
+        else errors.push(`@views invalid setting: src`)
       }
     }
   }
 
-  if (foundSrcSetting) validate.shared(views.src, cwd, errors)
-  else views.src = src
-
-  // Exit if default views folder doesn't exist
-  if (!is.exists(views.src)) return null
+  // Source path selection + validation: manifest always wins; validate plugins differently if required; if not, fall back to `src/shared` (or null)
+  if (foundArcSrc) {
+    validate.shared(views.src, cwd, errors, true)
+  }
+  else if (foundPluginSrc) {
+    if (!required) {
+      if (!is.exists(views.src)) views.src = src
+      if (!is.exists(views.src)) return null
+    }
+    validate.shared(views.src, cwd, errors, required)
+  }
+  else if (is.exists(src)) {
+    views.src = src
+    validate.shared(views.src, cwd, errors, false)
+  }
+  // Exit if configured shared folder doesn't exist
+  else return null
 
   // Proceeding from here resets all views config, so make sure it's only if specific views are specified
+  let foundSrcSetting = foundArcSrc || foundPluginSrc
   let some = arc.views?.length && !(arc?.views?.length === 1 && foundSrcSetting)
   if (some) {
     // Reset views settings