adapt-authoring-jsonschema 1.0.0 → 1.1.1

package/lib/JsonSchema.js

@@ -135,7 +135,7 @@ class JsonSchema {
     let parent = await this.getParent()
 
     while (parent) {
-      const parentBuilt = _.cloneDeep((await parent.build(options)).built)
+      const parentBuilt = _.cloneDeep((await parent.build({ ...options, compile: false })).built)
       built = await this.patch(parentBuilt, built, { strict: !parent.name === BASE_SCHEMA_NAME })
       parent = await parent.getParent()
     }
@@ -149,7 +149,9 @@ class JsonSchema {
       }))
     }
     this.built = built
-    this.compiled = await this.validator.compileAsync(built)
+    if(options.compile !== false) { // don't compile when option present (e.g. when running build recursively)
+      this.compiled = await this.validator.compileAsync(built)
+    }
     this.isBuilding = false
     this.lastBuildTime = Date.now()
 
@@ -200,8 +202,11 @@ class JsonSchema {
    */
   validate (dataToValidate, options) {
     const opts = _.defaults(options, { useDefaults: true, ignoreRequired: false })
-    const data = _.defaultsDeep(_.cloneDeep(dataToValidate), opts.useDefaults ? this.getObjectDefaults() : {})
-
+    const data = _.defaults(_.cloneDeep(dataToValidate), opts.useDefaults ? this.getObjectDefaults() : {})
+    if(!this.compiled) { // fallback in the case that the compiled function is missing
+      this.log('warn', 'NO_COMPILED_FUNC', this.name)
+      this.validator.compile(this.built)
+    }
     this.compiled(data)
 
     const errors = this.compiled.errors && this.compiled.errors

package/lib/JsonSchemaModule.js

@@ -67,8 +67,11 @@ class JsonSchemaModule extends AbstractModule {
           this.getConfig('xssWhitelist'))
       })
       .then(() => this.addStringFormats(this.getConfig('formatOverrides')))
-      .then(() => this.registerSchemas())
+      .then(() => this.registerSchemas({ quiet: true })) // note: supress logging here as other schemas will likely be added
       .catch(e => this.log('error', e))
+
+    this.app.onReady()
+      .then(() => this.logSchemas())
   }
 
   /**
@@ -108,7 +111,7 @@ class JsonSchemaModule extends AbstractModule {
    * Searches all Adapt dependencies for any local JSON schemas and registers them for use in the app. Schemas must be located in in a `/schema` folder, and be named appropriately: `*.schema.json`.
    * @return {Promise}
    */
-  async registerSchemas () {
+  async registerSchemas ({ quiet }) {
     await this.resetSchemaRegistry()
     await Promise.all(Object.values(this.app.dependencies).map(async d => {
       if(d.name === this.name) return
@@ -117,7 +120,8 @@ class JsonSchemaModule extends AbstractModule {
         .filter(r => r.status === 'rejected')
         .forEach(r => this.log('warn', r.reason))
     }))
-    this.registerSchemasHook.invoke();
+    await this.registerSchemasHook.invoke()
+    if(quiet !== true) this.logSchemas()
   }
 
   /**
@@ -140,7 +144,7 @@ class JsonSchemaModule extends AbstractModule {
     this.schemaExtensions?.[schema.name]?.forEach(s => schema.addExtension(s))
     if (schema.raw.$patch) this.extendSchema(schema.raw.$patch?.source?.$ref, schema.name)
 
-    this.log('debug', 'REGISTER_SCHEMA', schema.name, filePath)
+    this.log('verbose', 'REGISTER_SCHEMA', schema.name, filePath)
   }
 
   /**
@@ -189,7 +193,7 @@ class JsonSchemaModule extends AbstractModule {
       if (!this.schemaExtensions[baseSchemaName]) this.schemaExtensions[baseSchemaName] = []
       this.schemaExtensions[baseSchemaName].push(extSchemaName)
     }
-    this.log('debug', 'EXTEND_SCHEMA', baseSchemaName, extSchemaName)
+    this.log('verbose', 'EXTEND_SCHEMA', baseSchemaName, extSchemaName)
   }
 
   /**
@@ -204,6 +208,17 @@ class JsonSchemaModule extends AbstractModule {
     if (!schema) throw this.app.errors.MISSING_SCHEMA.setData({ schemaName })
     return schema.build(options)
   }
+
+  /**
+   * Logs all registered schemas & schema extensions
+   */
+  logSchemas () {
+    this.log('debug', 'SCHEMAS', Object.keys(this.schemas))
+    this.log('debug', 'SCHEMA_EXTENSIONS', Object.entries(this.schemas).reduce((m, [k, v]) => {
+      if(v.extensions.length) m[k] = v.extensions
+      return m
+    }, {}))
+  }
 }
 
 export default JsonSchemaModule

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "adapt-authoring-jsonschema",
-  "version": "1.0.0",
+  "version": "1.1.1",
   "description": "Module to add support for the JSON schema specification",
   "homepage": "https://github.com/adapt-security/adapt-authoring-jsonschema",
   "license": "GPL-3.0",