adapt-authoring-config 1.4.4 → 1.5.0

package/.github/workflows/standardjs.yml

@@ -1,4 +1,4 @@
-name: Standard.js formatting check
+name: Lint
 on: push
 jobs:
   default:
@@ -9,4 +9,4 @@ jobs:
         with:
           node-version: 'lts/*'
       - run: npm install
-      - run: npx standard
+      - run: npx standard

package/docs/configure-environment.md

@@ -50,4 +50,29 @@ $ NODE_ENV=dev npm start
 > set NODE_ENV=dev | npm start
 ```
 
-Please see the documentation for your own operating system for instructions on how to save environment variables in a more permanent way.
+Please see the documentation for your own operating system for instructions on how to save environment variables in a more permanent way.
+
+## Using environment variables for configuration
+
+As an alternative to config files, any configuration option can be set via an environment variable using the following naming convention:
+
+```
+ADAPT_AUTHORING_<MODULE>__<property>
+```
+
+- The module name is converted to uppercase with underscores replacing hyphens (e.g. `adapt-authoring-server` becomes `ADAPT_AUTHORING_SERVER`)
+- A double underscore (`__`) separates the module name from the property name
+- The property name is kept in its original camelCase format
+
+For example:
+
+| Environment variable | Config equivalent |
+| --- | --- |
+| `ADAPT_AUTHORING_SERVER__host` | `adapt-authoring-server.host` |
+| `ADAPT_AUTHORING_SERVER__port` | `adapt-authoring-server.port` |
+| `ADAPT_AUTHORING_MONGODB__connectionUri` | `adapt-authoring-mongodb.connectionUri` |
+| `ADAPT_AUTHORING_AUTH_LOCAL__saltRounds` | `adapt-authoring-auth-local.saltRounds` |
+
+Values are parsed as JSON where possible, so non-string types like numbers and booleans can be set directly (e.g. `ADAPT_AUTHORING_SERVER__port=5678`).
+
+Any environment variables that do not start with `ADAPT_AUTHORING_` are available under the `env` namespace (e.g. `NODE_ENV` becomes `env.NODE_ENV`).

package/docs/plugins/configuration.md

@@ -1,5 +1,5 @@
 # Configuration reference
-This page lists all configuration options supported by the [core bundle](coremodules) of Adapt authoring modules.
+This page lists all configuration options supported by the [core bundle](coremodules) of Adapt authoring modules. For details on how to set up your configuration, including using environment variables, see [Configuring your environment](configure-environment).
 
 {{{TABLE_OF_CONTENTS}}}
 

package/lib/ConfigModule.js

@@ -128,21 +128,21 @@ class ConfigModule extends AbstractModule {
       return a.name.localeCompare(b.name)
     })
     const coreDep = deps.find(d => isCore(d))
-    if (coreDep) await this.processModuleSchema(coreDep, jsonschema)
+    if (coreDep) this.processModuleSchema(coreDep, jsonschema)
 
-    const promises = deps.filter(d => !isCore(d)).map(d => this.processModuleSchema(d, jsonschema))
-    let hasErrored = false;
-
-    (await Promise.allSettled(promises)).forEach(r => {
-      if (r.status === 'rejected') {
+    let hasErrored = false
+    for (const d of deps.filter(d => !isCore(d))) {
+      try {
+        this.processModuleSchema(d, jsonschema)
+      } catch (e) {
         hasErrored = true
-        if (r.reason?.data?.errors) {
-          console.log(`${r.reason.modName}: ${r.reason.data.errors}`)
+        if (e?.data?.errors) {
+          console.log(`${e.modName}: ${e.data.errors}`)
         } else {
-          console.log(r.reason)
+          console.log(e)
         }
       }
-    })
+    }
     if (hasErrored) throw new Error()
   }
 
@@ -150,15 +150,14 @@ class ConfigModule extends AbstractModule {
    * Processes and validates a single module config schema (checks the user config specifies any required fields, and that they are the expected type)
    * @param {Object} pkg Package.json data
    * @param {JsonSchemaModule} jsonschema Module instance for validation
-   * @return {Promise}
    */
-  async processModuleSchema (pkg, jsonschema) {
+  processModuleSchema (pkg, jsonschema) {
     if (!pkg.name || !pkg.rootDir) return
 
     const schemaPath = path.resolve(pkg.rootDir, 'conf/config.schema.json')
     let schema
     try {
-      schema = await (await jsonschema.createSchema(schemaPath)).build()
+      schema = jsonschema.createSchema(schemaPath).build()
     } catch (e) {
       return
     }
@@ -168,7 +167,7 @@ class ConfigModule extends AbstractModule {
       return { ...m, [k]: this.get(`${pkg.name}.${k}`) }
     }, {})
     try {
-      data = await schema.validate(data)
+      data = schema.validate(data)
     } catch (e) {
       e.modName = pkg.name
       throw e

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "adapt-authoring-config",
-  "version": "1.4.4",
+  "version": "1.5.0",
   "description": "A configuration module for the Adapt authoring tool.",
   "homepage": "https://github.com/adapt-security/adapt-authoring-config",
   "license": "GPL-3.0",