@architect/inventory 3.0.0-RC.7 → 3.0.0-RC.8

package/changelog.md

@@ -37,6 +37,7 @@
 - Breaking change: renamed `lambda.handlerFunction` to `lambda.handlerMethod`
 - Breaking change: prioritize `mod.ts|js` handlers in Deno Lambdas
 - Breaking change: removed `toml` support
+- Breaking change: removed `get.macros` method; as `@macros` are now automatically mapped to the Architect plugins, you can simply use `get.plugins` instead
 - Performance improvements to building `inv.shared` + `inv.views`
 - Improved memory footprint of Inventory object by preserving references in `lambdaSrcDirs`, `lambdasBySrcDir`
   - Added `pragma` property to all Lambdas to aid in reference preservation
@@ -48,6 +49,8 @@ Update CI
 ### Fixed
 
 - Added file path validation because `aws-sdk` blows up on !ascii paths; fixes #1292, thanks @GustMartins!
+- Fixed env var validation from preference files
+- Fixed error bubbling when reading a preferences file with issues
 
 ---
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@architect/inventory",
-  "version": "3.0.0-RC.7",
+  "version": "3.0.0-RC.8",
   "description": "Architect project resource enumeration utility",
   "main": "src/index.js",
   "scripts": {
@@ -23,21 +23,21 @@
   "dependencies": {
     "@architect/asap": "~5.0.0-RC.0",
     "@architect/parser": "~6.0.0-RC.0",
-    "@architect/utils": "~3.0.4",
+    "@architect/utils": "~3.1.0-RC.0",
     "lambda-runtimes": "~1.1.1"
   },
   "devDependencies": {
     "@architect/eslint-config": "~2.0.1",
     "aws-sdk": "2.1001.0",
-    "aws-sdk-mock": "~5.6.0",
+    "aws-sdk-mock": "~5.6.2",
     "cross-env": "~7.0.3",
-    "dotenv": "~14.3.2",
-    "eslint": "~8.7.0",
+    "dotenv": "~15.0.0",
+    "eslint": "~8.8.0",
     "mock-fs": "~5.1.2",
     "mock-require": "~3.0.3",
     "nyc": "~15.1.0",
     "tap-spec": "^5.0.0",
-    "tape": "^5.4.1"
+    "tape": "^5.5.0"
   },
   "eslintConfig": {
     "extends": "@architect/eslint-config"

package/src/config/pragmas/plugins.js

@@ -5,6 +5,7 @@ let { lambdas } = pragmas
 let nonLambdaSetters = [ 'customLambdas', 'env', 'runtimes' ]
 let setters = [ ...lambdas, ...nonLambdaSetters ]
 let pluginMethods = [ 'deploy', 'sandbox' ] // TODO add more!
+let reservedNames = [ '_methods', 'events', 'queues', 'static', 'tables' ]
 
 module.exports = function getPluginModules ({ arc, inventory, errors }) {
   if (!arc?.plugins?.length && !arc?.macros?.length) return null
@@ -33,8 +34,8 @@ module.exports = function getPluginModules ({ arc, inventory, errors }) {
         : join(cwd, 'src', type + 's', name)
     }
 
-    if (name === '_methods') {
-      errors.push('Plugin name _methods is reserved, please rename your plugin')
+    if (reservedNames.includes(name)) {
+      errors.push(`Plugin name ${name} is reserved, please rename your plugin`)
       continue
     }
     if (!validationPatterns.veryLooseName.test(name)) {

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

@@ -1,4 +1,5 @@
 let { sep } = require('path')
+let { deepFrozenCopy } = require('@architect/utils')
 let read = require('../../../read')
 let getLambda = require('./get-lambda')
 let getRuntime = require('./get-runtime')
@@ -18,9 +19,10 @@ function populateLambda (type, params) {
   let plugins = inventory.plugins?._methods?.set?.[type]
   let pluginLambda = []
   if (plugins) {
+    let invCopy = deepFrozenCopy(inventory)
     let pluginResults = plugins.flatMap(fn => {
       try {
-        var result = fn({ arc, inventory: { inv: inventory } })
+        var result = fn({ arc: invCopy._project.arc, inventory: { inv: invCopy } })
       }
       catch (err) {
         err.message = `Setter plugin exception: plugin: ${fn.plugin}, method: set.${type}`

package/src/config/project/plugins/env.js

@@ -1,4 +1,5 @@
-let { is } = require('../../../lib')
+let { deepFrozenCopy } = require('@architect/utils')
+let { is, validationPatterns: valid } = require('../../../lib')
 let envs = [ 'testing', 'staging', 'production' ]
 let str = value => {
   if (is.object(value) || is.array(value)) return JSON.stringify(value)
@@ -15,15 +16,12 @@ module.exports = function setEnvPlugins (params, project) {
       production: null,
     }
 
-    // IEEE 1003.1-2001 does not allow lowercase, so consider this a compromise for the Windows folks in the house
-    let validName = /^[a-zA-Z0-9_]+$/
-
     // inventory._project is not yet built, so provide as much as we can to plugins for now
-    let inv = { ...inventory, _project: project }
+    let inv = deepFrozenCopy({ ...inventory, _project: project })
     envPlugins.forEach(fn => {
       let errType = `plugin: ${fn.plugin}, method: set.env`
       try {
-        let result = fn({ inventory: { inv } })
+        let result = fn({ arc: inv._project.arc, inventory: { inv } })
         if (!is.object(result) || !Object.keys(result).length) {
           return errors.push(`Env plugin returned invalid data, must return an Object with one or more keys + values: ${errType}`)
         }
@@ -32,6 +30,9 @@ module.exports = function setEnvPlugins (params, project) {
         if (Object.keys(result).some(k => envs.includes(k))) {
           envs.forEach(e => {
             if (result[e]) Object.entries(result[e]).forEach(([ k, v ]) => {
+              if (!valid.envVar.test(k)) {
+                return errors.push(`Env var '${k}' is invalid, must be [a-zA-Z0-9_]`)
+              }
               let errored = false, val = str(v)
               if (!env[e]) env[e] = { [k]: val }
               else if (env[e][k] && !errored) {
@@ -45,7 +46,7 @@ module.exports = function setEnvPlugins (params, project) {
         // Populate all environments based on env var
         else {
           Object.entries(result).forEach(([ k, v ]) => {
-            if (!validName.test(k)) {
+            if (!valid.envVar.test(k)) {
               return errors.push(`Env var '${k}' is invalid, must be [a-zA-Z0-9_]`)
             }
             let errored = false, val = str(v)

package/src/config/project/plugins/runtimes.js

@@ -1,5 +1,6 @@
-let { is, validationPatterns } = require('../../../lib')
 let { aliases, runtimeList } = require('lambda-runtimes')
+let { deepFrozenCopy } = require('@architect/utils')
+let { is, validationPatterns } = require('../../../lib')
 let { looserName } = validationPatterns
 let allRuntimes = runtimeList.concat([ 'deno', ...Object.keys(aliases) ])
 let validTypes = [ 'transpiled', 'compiled', 'interpreted' ]
@@ -13,12 +14,12 @@ module.exports = function setRuntimePlugins (params, project) {
       runtimes: [],
     }
     // inventory._project is not yet built, so provide as much as we can to plugins for now
-    let inv = { ...inventory, _project: project }
+    let inv = deepFrozenCopy({ ...inventory, _project: project })
     let build
     runtimePlugins.forEach(fn => {
       let errType = `plugin: ${fn.plugin}, method: set.runtimes`
       try {
-        var result = fn({ inventory: { inv } })
+        var result = fn({ arc: inv._project.arc, inventory: { inv } })
       }
       catch (err) {
         err.message = `Runtime plugin exception: ${errType}`

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

@@ -7,60 +7,30 @@
 var fs = require("fs");
 var path = require("path");
 var os = require("os");
-function log(message) {
-  console.log(`[dotenv][DEBUG] ${message}`);
-}
-var NEWLINE = "\n";
-var RE_INI_KEY_VAL = /^\s*([\w.-]+)\s*=\s*("[^"]*"|'[^']*'|.*?)(\s+#.*)?$/;
-var RE_NEWLINES = /\\n/g;
-var NEWLINES_MATCH = /\r\n|\n|\r/;
-function parse(src, options) {
-  const debug = Boolean(options && options.debug);
-  const multiline = Boolean(options && options.multiline);
+var LINE = /(?:^|^)\s*(?:export\s+)?([\w.-]+)(?:\s*=\s*?|:\s+?)(\s*'(?:\\'|[^'])*'|\s*"(?:\\"|[^"])*"|[^#\r\n]+)?\s*(?:#.*)?(?:$|$)/mg;
+function parse(src) {
   const obj = {};
-  const lines = src.toString().split(NEWLINES_MATCH);
-  for (let idx = 0; idx < lines.length; idx++) {
-    let line = lines[idx];
-    const keyValueArr = line.match(RE_INI_KEY_VAL);
-    if (keyValueArr != null) {
-      const key = keyValueArr[1];
-      let val = keyValueArr[2] || "";
-      let end = val.length - 1;
-      const isDoubleQuoted = val[0] === '"' && val[end] === '"';
-      const isSingleQuoted = val[0] === "'" && val[end] === "'";
-      const isMultilineDoubleQuoted = val[0] === '"' && val[end] !== '"';
-      const isMultilineSingleQuoted = val[0] === "'" && val[end] !== "'";
-      if (multiline && (isMultilineDoubleQuoted || isMultilineSingleQuoted)) {
-        const quoteChar = isMultilineDoubleQuoted ? '"' : "'";
-        val = val.substring(1);
-        while (idx++ < lines.length - 1) {
-          line = lines[idx];
-          end = line.length - 1;
-          if (line[end] === quoteChar) {
-            val += NEWLINE + line.substring(0, end);
-            break;
-          }
-          val += NEWLINE + line;
-        }
-      } else if (isSingleQuoted || isDoubleQuoted) {
-        val = val.substring(1, end);
-        if (isDoubleQuoted) {
-          val = val.replace(RE_NEWLINES, NEWLINE);
-        }
-      } else {
-        val = val.trim();
-      }
-      obj[key] = val;
-    } else if (debug) {
-      const trimmedLine = line.trim();
-      if (trimmedLine.length && trimmedLine[0] !== "#") {
-        log(`Failed to match key and value when parsing line ${idx + 1}: ${line}`);
-      }
+  let lines = src.toString();
+  lines = lines.replace(/\r\n?/mg, "\n");
+  let match;
+  while ((match = LINE.exec(lines)) != null) {
+    const key = match[1];
+    let value = match[2] || "";
+    value = value.trim();
+    const maybeQuote = value[0];
+    value = value.replace(/^(['"])([\s\S]+)\1$/mg, "$2");
+    if (maybeQuote === '"') {
+      value = value.replace(/\\n/g, "\n");
+      value = value.replace(/\\r/g, "\r");
     }
+    obj[key] = value;
   }
   return obj;
 }
-function resolveHome(envPath) {
+function _log(message) {
+  console.log(`[dotenv][DEBUG] ${message}`);
+}
+function _resolveHome(envPath) {
   return envPath[0] === "~" ? path.join(os.homedir(), envPath.slice(1)) : envPath;
 }
 function config(options) {
@@ -68,17 +38,16 @@ function config(options) {
   let encoding = "utf8";
   const debug = Boolean(options && options.debug);
   const override = Boolean(options && options.override);
-  const multiline = Boolean(options && options.multiline);
   if (options) {
     if (options.path != null) {
-      dotenvPath = resolveHome(options.path);
+      dotenvPath = _resolveHome(options.path);
     }
     if (options.encoding != null) {
       encoding = options.encoding;
     }
   }
   try {
-    const parsed = DotenvModule.parse(fs.readFileSync(dotenvPath, { encoding }), { debug, multiline });
+    const parsed = DotenvModule.parse(fs.readFileSync(dotenvPath, { encoding }));
     Object.keys(parsed).forEach(function(key) {
       if (!Object.prototype.hasOwnProperty.call(process.env, key)) {
         process.env[key] = parsed[key];
@@ -88,9 +57,9 @@ function config(options) {
         }
         if (debug) {
           if (override === true) {
-            log(`"${key}" is already defined in \`process.env\` and WAS overwritten`);
+            _log(`"${key}" is already defined in \`process.env\` and WAS overwritten`);
           } else {
-            log(`"${key}" is already defined in \`process.env\` and was NOT overwritten`);
+            _log(`"${key}" is already defined in \`process.env\` and was NOT overwritten`);
           }
         }
       }
@@ -98,7 +67,7 @@ function config(options) {
     return { parsed };
   } catch (e) {
     if (debug) {
-      log(`Failed to load ${dotenvPath} ${e.message}`);
+      _log(`Failed to load ${dotenvPath} ${e.message}`);
     }
     return { error: e };
   }

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

@@ -2,7 +2,7 @@ let { join } = require('path')
 let { existsSync, readFileSync } = require('fs')
 let read = require('../../../read')
 let validate = require('../validate')
-let { is } = require('../../../lib')
+let { is, validationPatterns: valid } = require('../../../lib')
 let { parse } = require('./dotenv')
 let { homedir } = require('os')
 
@@ -20,13 +20,11 @@ module.exports = function getPrefs ({ scope, inventory, errors }) {
   let preferences = {}
 
   // Populate Architect preferences
-  if (prefs.filepath) {
+  if (prefs.filepath && prefs.arc) {
     // Ok, this gets a bit hairy
     // Arc outputs an object of nested arrays
     // Basically, construct a pared-down intermediate prefs obj for consumers
     Object.entries(prefs.arc).forEach(([ key, val ]) => {
-      // TODO add additional preferences checks and normalization
-
       /* istanbul ignore else: Parser should get this, but jic */
       if (!preferences[key]) preferences[key] = {}
       /* istanbul ignore else: Parser should only produce arrays, but jic */
@@ -51,6 +49,9 @@ module.exports = function getPrefs ({ scope, inventory, errors }) {
           /* istanbul ignore else: Yet another jic */
           if (preferences.env[e]) {
             Object.entries(preferences.env[e]).forEach(([ key, val ]) => {
+              if (!valid.envVar.test(key)) {
+                errors.push(`Env var '${key}' is invalid, must be [a-zA-Z0-9_]`)
+              }
               if (is.array(val)) preferences.env[e][key] = val.join(' ')
             })
           }

package/src/lib/index.js

@@ -20,6 +20,8 @@ let validationPatterns = {
   looseName: /^[a-z][a-zA-Z0-9-_]+$/,
   looserName: /^[a-z][a-zA-Z0-9-._]+$/,
   veryLooseName: /^[a-zA-Z0-9/\-._]*$/,
+  // IEEE 1003.1-2001 does not allow lowercase, so consider this a compromise for the Windows folks in the house
+  envVar: /^[a-zA-Z0-9_]+$/,
 }
 
 module.exports = {