adapt-authoring-adaptframework 1.9.9 → 1.10.0

package/errors/errors.json

@@ -23,7 +23,7 @@
   },
   "FW_IMPORT_CONTENT_FAILED": {
     "data": {
-      "errors": "Accompanying errors"
+      "errors": "Array of accompanying errors, each with either { schemaName, id, errors } or { message }"
     },
     "description": "Import of framework content failed",
     "statusCode": 400
@@ -45,11 +45,17 @@
   },
   "FW_IMPORT_INVALID": {
     "description": "An invalid import zip has been provided",
-    "statusCode": 400
+    "statusCode": 400,
+    "data": {
+      "reason": "The reason the import zip was considered invalid"
+    }
   },
   "FW_IMPORT_INVALID_COURSE": {
     "description": "An invalid course has been provided",
-    "statusCode": 400
+    "statusCode": 400,
+    "data": {
+      "reason": "The reason the course was considered invalid"
+    }
   },
   "FW_IMPORT_INVALID_CONTENT": {
     "description": "An invalid content item has been found in import data",
@@ -58,6 +64,13 @@
       "item": "The invalid content item"
     }
   },
+  "FW_IMPORT_MIGRATION_FAILED": {
+    "data": {
+      "reason": "The reason the migration failed"
+    },
+    "description": "Migration of course content failed",
+    "statusCode": 500
+  },
   "FW_IMPORT_MISSING_PLUGINS": {
     "description": "Course for import uses plugins which are missing from the server",
     "statusCode": 400
@@ -78,10 +91,27 @@
     "description": "Plugin is incompatible",
     "statusCode": 500
   },
+  "FW_LATEST_VERSION_FAILED": {
+    "data": {
+      "reason": "The reason the version check failed"
+    },
+    "description": "Failed to retrieve the latest framework version",
+    "statusCode": 500
+  },
   "FW_INSTALL_FAILED": {
+    "data": {
+      "reason": "The reason the installation failed"
+    },
     "description": "Installation of the framework failed",
     "statusCode": 500
   },
+  "FW_UPDATE_FAILED": {
+    "data": {
+      "reason": "The reason the update failed"
+    },
+    "description": "Update of the framework failed",
+    "statusCode": 500
+  },
   "FW_INVALID_VERSION": {
     "data": {
       "name": "Incompatible plugin name",

package/lib/AdaptFrameworkBuild.js

@@ -374,19 +374,17 @@ class AdaptFrameworkBuild {
       Object.assign(i, JSON.parse(itemString))
       // insert expected _component values
       if (i._component) {
-        i._component = this.enabledPlugins.find(p => p.name === i._component).targetAttribute.slice(1)
+        i._component = this.enabledPlugins.find(p => p.name === i._component)?.targetAttribute.slice(1) ?? i._component
       }
     })
     // move globals to a nested _extensions object as expected by the framework
     this.enabledPlugins.forEach(({ targetAttribute, type }) => {
       let key = `_${type}`
       if (type === 'component' || type === 'extension') key += 's'
-      try {
-        _.merge(this.courseData.course.data._globals, {
-          [key]: { [targetAttribute]: this.courseData.course.data._globals[targetAttribute] }
-        })
-        delete this.courseData.course.data._globals[targetAttribute]
-      } catch (e) {}
+      const globals = this.courseData.course.data._globals
+      if (!globals?.[targetAttribute]) return
+      _.merge(globals, { [key]: { [targetAttribute]: globals[targetAttribute] } })
+      delete globals[targetAttribute]
     })
     // map course tag values (_id -> title)
     const tags = await App.instance.waitForModule('tags')

package/lib/AdaptFrameworkImport.js

@@ -311,7 +311,7 @@ class AdaptFrameworkImport {
       await fs.readdir(this.langPath)
     } catch (e) {
       this.framework.log('error', e)
-      throw App.instance.errors.FW_IMPORT_INVALID_COURSE
+      throw (e?.statusCode ? e : App.instance.errors.FW_IMPORT_INVALID_COURSE.setData({ reason: e.message }))
     }
     FWUtils.logDir('unzipPath', this.path)
     FWUtils.logDir('coursePath', this.coursePath)
@@ -319,7 +319,7 @@ class AdaptFrameworkImport {
     try {
       /** @ignore */this.pkg = await FWUtils.readJson(`${this.path}/package.json`)
     } catch (e) {
-      throw App.instance.errors.FW_IMPORT_INVALID
+      throw App.instance.errors.FW_IMPORT_INVALID.setData({ reason: e.message })
     }
     try {
       await fs.rm(`${this.path}/package-lock.json`)
@@ -517,7 +517,7 @@ class AdaptFrameworkImport {
       await fs.rm(path.join(this.framework.path, opts.captureDir), { recursive: true })
     } catch (error) {
       FWUtils.log('error', 'Migration process failed', error)
-      throw new Error(`Migration process failed: ${error.message}`)
+      throw App.instance.errors.FW_IMPORT_MIGRATION_FAILED.setData({ reason: error.message })
     }
   }
 
@@ -665,11 +665,11 @@ class AdaptFrameworkImport {
           }
           this.statusReport.info.push({ code: 'INSTALL_PLUGIN', data: { name: p, version: bowerJson.version } })
         } catch (e) {
-          if (e.code !== 'EEXIST') {
-            FWUtils.log('error', 'PLUGIN_IMPORT_FAILED', p, e)
-            errors.push({ plugin: p, error: e.data.errors[0] })
+          if (e.code === 'EEXIST') {
+            FWUtils.log('warn', 'PLUGIN_ALREADY_EXISTS', p)
           } else {
-            errors.push(e)
+            FWUtils.log('error', 'PLUGIN_IMPORT_FAILED', p, e)
+            errors.push({ plugin: p, error: e.data?.errors?.[0] ?? e })
           }
         }
       }))
@@ -689,8 +689,9 @@ class AdaptFrameworkImport {
    * @return {Promise}
    */
   async importCourseData () {
-    const stringifyError = e => {
-      return e?.data?.schemaName ? `${e.data.schemaName} ${e.data.data._id} ${e.data.errors}` : App.instance.lang.translate(undefined, e)
+    const formatError = e => {
+      if (e?.data?.schemaName) return { schemaName: e.data.schemaName, id: e.data.data?._id, errors: e.data.errors }
+      return { message: App.instance.lang.translate(undefined, e) }
     }
     /**
      * Note: the execution order is important here
@@ -704,7 +705,7 @@ class AdaptFrameworkImport {
       // we need to run an update with the same data to make sure all extension schema settings are applied
       await this.importContentObject({ ...this.contentJson.course, _id: course._id }, { isUpdate: true })
     } catch (e) {
-      throw App.instance.errors.FW_IMPORT_CONTENT_FAILED.setData({ errors: stringifyError(e) })
+      throw App.instance.errors.FW_IMPORT_CONTENT_FAILED.setData({ errors: [formatError(e)] })
     }
     const { sorted, hierarchy } = await this.getSortedData()
     const errors = []
@@ -718,11 +719,11 @@ class AdaptFrameworkImport {
             ...itemJson // note that JSON sort order will override the deduced one
           })
         } catch (e) {
-          errors.push(stringifyError(e))
+          errors.push(formatError(e))
         }
       }
     }
-    if (errors.length) throw App.instance.errors.FW_IMPORT_CONTENT_FAILED.setData({ errors: errors.join('; ') })
+    if (errors.length) throw App.instance.errors.FW_IMPORT_CONTENT_FAILED.setData({ errors })
     FWUtils.log('debug', 'imported course data successfully')
   }
 

package/lib/AdaptFrameworkModule.js

@@ -108,7 +108,7 @@ class AdaptFrameworkModule extends AbstractModule {
       await this.runCliCommand('installFramework', { version })
     } catch (e) {
       this.log('error', `failed to install framework, ${e.message}`)
-      throw this.app.errors.FW_INSTALL_FAILED
+      throw this.app.errors.FW_INSTALL_FAILED.setData({ reason: e.message })
     }
     this.log('verbose', 'INSTALL hook invoke')
     await this.postInstallHook.invoke()
@@ -123,7 +123,7 @@ class AdaptFrameworkModule extends AbstractModule {
       return semver.clean(await this.runCliCommand('getLatestFrameworkVersion'))
     } catch (e) {
       this.log('error', `failed to retrieve framework update data, ${e.message}`)
-      throw e
+      throw this.app.errors.FW_LATEST_VERSION_FAILED.setData({ reason: e.message })
     }
   }
 
@@ -155,7 +155,7 @@ class AdaptFrameworkModule extends AbstractModule {
       this._version = await this.runCliCommand('getCurrentFrameworkVersion')
     } catch (e) {
       this.log('error', `failed to update framework, ${e.message}`)
-      throw this.app.errors.FW_UPDATE_FAILED
+      throw this.app.errors.FW_UPDATE_FAILED.setData({ reason: e.message })
     }
     this.postUpdateHook.invoke()
   }
@@ -195,7 +195,7 @@ class AdaptFrameworkModule extends AbstractModule {
     if (data._type === 'course') {
       course = data
     } else {
-      [course] = await content.find({ _id: data._courseId || (await content.find(data))._courseId })
+      course = await content.findOne({ _id: data._courseId || (await content.findOne(data, { strict: false }))?._courseId })
     }
     if (!course) {
       return

package/lib/AdaptFrameworkUtils.js

@@ -320,7 +320,7 @@ class AdaptFrameworkUtils {
       })
       res.json(importer.summary)
     } catch (e) {
-      return next(App.instance.errors.FW_IMPORT_FAILED.setData({ error: e }))
+      return next(e?.statusCode ? e : App.instance.errors.FW_IMPORT_FAILED.setData({ error: e }))
     }
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "adapt-authoring-adaptframework",
-  "version": "1.9.9",
+  "version": "1.10.0",
   "description": "Adapt framework integration for the Adapt authoring tool",
   "homepage": "https://github.com/adapt-security/adapt-authoring-adaptframework",
   "license": "GPL-3.0",