adapt-authoring-adaptframework 1.10.1 → 1.10.3

package/lib/AdaptFrameworkImport.js

@@ -138,6 +138,11 @@ class AdaptFrameworkImport {
      * @type {Object}
      */
     this.newContentPlugins = {}
+    /**
+     * Plugins that were updated during import with their original metadata for rollback
+     * @type {Object}
+     */
+    this.updatedContentPlugins = {}
     /**
      * Key/value store mapping old component keys to component names
      * @type {Object}
@@ -158,6 +163,11 @@ class AdaptFrameworkImport {
      * @type {String}
      */
     this.userId = userId
+    /**
+     * Array of tag IDs created during import for rollback
+     * @type {Array<String>}
+     */
+    this.newTagIds = []
     /**
      * Contains non-fatal infomation messages regarding import status which can be return as response data. Fatal errors are thrown in the usual way.
      * @type {Object}
@@ -548,6 +558,7 @@ class AdaptFrameworkImport {
     await Promise.all(Array.from(newTags).map(async n => {
       const { _id } = await tags.insert({ title: n })
       existingTagMap[n] = _id.toString()
+      this.newTagIds.push(_id.toString())
     }))
     // map tags from titles to new _ids
     this.tags = this.tags.map(t => existingTagMap[t])
@@ -652,6 +663,11 @@ class AdaptFrameworkImport {
       const errors = []
       await Promise.all([...pluginsToInstall, ...pluginsToUpdate].map(async p => {
         try {
+          // Store original plugin metadata for updates before overwriting
+          const isUpdate = pluginsToUpdate.includes(p)
+          if (isUpdate && this.installedPlugins[p]) {
+            this.updatedContentPlugins[p] = this.installedPlugins[p]
+          }
           // try and infer a targetAttribute if there isn't one
           const pluginBowerPath = path.join(this.usedContentPlugins[p].path, 'bower.json')
           const bowerJson = await FWUtils.readJson(pluginBowerPath)
@@ -661,7 +677,9 @@ class AdaptFrameworkImport {
           }
           if (!this.settings.isDryRun) {
             const [pluginData] = await this.contentplugin.installPlugins([[p, this.usedContentPlugins[p].path]], { strict: true })
-            this.newContentPlugins[p] = pluginData
+            if (!isUpdate) {
+              this.newContentPlugins[p] = pluginData
+            }
           }
           this.statusReport.info.push({ code: 'INSTALL_PLUGIN', data: { name: p, version: bowerJson.version } })
         } catch (e) {
@@ -690,8 +708,10 @@ class AdaptFrameworkImport {
    */
   async importCourseData () {
     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) }
+      if (e?.data?.schemaName) {
+        return `${e.data.schemaName}${e.data.data?._id ? ` (${e.data.data._id})` : ''}: ${e.data.errors ?? e.message}`
+      }
+      return e?.toString() ?? String(e)
     }
     /**
      * Note: the execution order is important here
@@ -840,14 +860,21 @@ class AdaptFrameworkImport {
       return
     }
     try {
-      const tasks = [
-        fs.rm(this.path, { recursive: true })
-      ]
+      const tasks = [fs.rm(this.path, { recursive: true })]
       if (error) {
-        tasks.push(
-          Promise.all(Object.values(this.newContentPlugins).map(p => this.contentplugin.uninstallPlugin(p._id))),
-          Promise.all(Object.values(this.assetMap).map(a => this.assets.delete({ _id: a })))
-        )
+        // Uninstall newly installed plugins
+        tasks.push(Promise.all(Object.values(this.newContentPlugins).map(p => this.contentplugin.uninstallPlugin(p._id))))
+        // Restore updated plugins to their original versions
+        if (Object.keys(this.updatedContentPlugins).length > 0) {
+          tasks.push(this.restoreUpdatedPlugins())
+        }
+        // Delete imported assets
+        tasks.push(Promise.all(Object.values(this.assetMap).map(a => this.assets.delete({ _id: a }))))
+        // Delete newly created tags
+        if (this.newTagIds.length > 0) {
+          const tags = await App.instance.waitForModule('tags')
+          tasks.push(Promise.all(this.newTagIds.map(id => tags.delete({ _id: id }))))
+        }
         let _courseId
         try {
           const { ObjectId } = await App.instance.waitForModule('mongodb')
@@ -863,6 +890,26 @@ class AdaptFrameworkImport {
       await Promise.allSettled(tasks)
     } catch (e) {} // ignore any thrown errors
   }
+
+  /**
+   * Restores plugins that were updated during import to their original versions
+   * Uses ContentPluginModule's restorePluginFromBackup to restore from cached backups
+   * @return {Promise}
+   */
+  async restoreUpdatedPlugins () {
+    const pluginNames = Object.keys(this.updatedContentPlugins)
+    if (pluginNames.length === 0) return Promise.resolve()
+
+    const restoreTasks = []
+    for (const [pluginName, originalMetadata] of Object.entries(this.updatedContentPlugins)) {
+      FWUtils.log('info', `restoring plugin '${pluginName}' to previous version ${originalMetadata.version}`)
+      restoreTasks.push(
+        this.contentplugin.restorePluginFromBackup(pluginName)
+          .catch(e => FWUtils.log('error', `failed to restore plugin '${pluginName}' from backup, ${e.message}`))
+      )
+    }
+    return Promise.allSettled(restoreTasks)
+  }
 }
 
 export default AdaptFrameworkImport

package/package.json

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