adapt-authoring-adaptframework 2.3.4 → 2.5.0

package/adapt-authoring.json

@@ -1,5 +1,8 @@
 {
   "documentation": {
     "enable": true
+  },
+  "framework": {
+    "targetVersion": 5
   }
 }

package/errors/errors.json

@@ -126,5 +126,14 @@
     },
     "description": "Plugin is missing a dependency",
     "statusCode": 500
+  },
+  "FW_VERSION_NOT_ALLOWED": {
+    "data": {
+      "version": "The version that is not allowed",
+      "targetMajorVersion": "The allowed major version number",
+      "allowedRange": "The allowed semver range"
+    },
+    "description": "Framework version is outside the allowed major version",
+    "statusCode": 400
   }
 }

package/lib/AdaptFrameworkBuild.js

@@ -40,11 +40,12 @@ class AdaptFrameworkBuild {
    * @property {String} userId The user executing the build
    * @property {String} expiresAt When the build expires
    * @property {Boolean} compress Whether output files should be compressed into an archive file
+   * @property {String} outputDir If set, uses this as the build root. If the directory already exists, only content data and assets are written (framework copy and compilation are skipped)
    *
    * @constructor
    * @param {AdaptFrameworkBuildOptions} options
    */
-  constructor ({ action, courseId, userId, expiresAt, compress }) {
+  constructor ({ action, courseId, userId, expiresAt, compress, outputDir }) {
     /**
      * The MongoDB collection name
      * @type {String}
@@ -150,6 +151,11 @@ class AdaptFrameworkBuild {
       * @type {Hook}
       */
     this.postBuildHook = new Hook({ mutable: true })
+    /**
+     * Custom output directory. If the directory already exists, only content and assets are written
+     * @type {String}
+     */
+    this.outputDir = outputDir ?? null
   }
 
   /**
@@ -164,17 +170,26 @@ class AdaptFrameworkBuild {
     if (!this.expiresAt) {
       this.expiresAt = await AdaptFrameworkBuild.getBuildExpiry()
     }
-    // random suffix to account for parallel builds executed at exactly the same millisecond
-    const randomSuffix = `_${Math.floor(Math.random() * 1000).toString().padStart(4, '0')}`
-    this.dir = path.resolve(framework.getConfig('buildDir'), Date.now() + randomSuffix)
+    if (this.outputDir) {
+      this.dir = this.outputDir
+    } else {
+      // random suffix to account for parallel builds executed at exactly the same millisecond
+      const randomSuffix = `_${Math.floor(Math.random() * 1000).toString().padStart(4, '0')}`
+      this.dir = path.resolve(framework.getConfig('buildDir'), Date.now() + randomSuffix)
+    }
     this.buildDir = path.join(this.dir, 'build')
     this.courseDir = path.join(this.buildDir, 'course')
 
+    const dirExists = await fs.access(this.dir).then(() => true, () => false)
+    const contentOnly = this.outputDir && dirExists
+
     const cacheDir = path.join(framework.getConfig('buildDir'), 'cache')
 
     await ensureDir(this.dir)
     await ensureDir(this.buildDir)
-    await ensureDir(cacheDir)
+    if (!contentOnly) {
+      await ensureDir(cacheDir)
+    }
 
     logDir('dir', this.dir)
     logDir('buildDir', this.buildDir)
@@ -182,21 +197,23 @@ class AdaptFrameworkBuild {
 
     await this.loadCourseData()
 
-    await Promise.all([
-      this.copyAssets(),
-      copyFrameworkSource({
+    const tasks = [this.copyAssets()]
+    if (!contentOnly) {
+      tasks.push(copyFrameworkSource({
         destDir: this.dir,
         enabledPlugins: this.enabledPlugins.map(p => p.name),
         linkNodeModules: !this.isExport
-      })
-    ])
+      }))
+    }
+    await Promise.all(tasks)
+
     await this.preBuildHook.invoke(this)
 
     await this.writeContentJson()
 
     logDir('courseDir', this.courseDir)
 
-    if (!this.isExport) {
+    if (!contentOnly && !this.isExport) {
       try {
         logMemory()
         await AdaptCli.buildCourse({

package/lib/AdaptFrameworkModule.js

@@ -70,6 +70,13 @@ class AdaptFrameworkModule extends AbstractModule {
      */
     this.contentMigrations = []
 
+    const meta = await readJson(path.resolve(this.rootDir, 'adapt-authoring.json'))
+    /**
+     * The major version of the Adapt framework this module is designed to work with
+     * @type {Number}
+     */
+    this._targetFrameworkVersion = meta.framework?.targetVersion
+
     this.app.waitForModule('content').then(content => {
       content.accessCheckHook.tap(this.checkContentAccess.bind(this))
     })
@@ -103,6 +110,36 @@ class AdaptFrameworkModule extends AbstractModule {
     return this._version
   }
 
+  /**
+   * The major version of the Adapt framework this module is designed to work with
+   * @type {Number|undefined}
+   */
+  get targetFrameworkVersion () {
+    return this._targetFrameworkVersion
+  }
+
+  /**
+   * Returns a semver range string constrained to the target major version, or undefined if no target is set
+   * @type {String|undefined}
+   */
+  get targetVersionRange () {
+    if (this._targetFrameworkVersion === undefined) return undefined
+    return `>=${this._targetFrameworkVersion}.0.0 <${this._targetFrameworkVersion + 1}.0.0`
+  }
+
+  /**
+   * Checks whether the given version is compatible with the configured target major version
+   * @param {string} version Semver version string to check
+   * @throws If the version's major does not match the target major version
+   */
+  checkVersionCompatibility (version) {
+    if (this._targetFrameworkVersion === undefined) return
+    const major = semver.major(version)
+    if (major !== this._targetFrameworkVersion) {
+      throw this.app.errors.FW_VERSION_NOT_ALLOWED.setData({ version, targetMajorVersion: this._targetFrameworkVersion, allowedRange: this.targetVersionRange })
+    }
+  }
+
   /**
    * Installs a local copy of the Adapt framework
    * @return {Promise}
@@ -121,10 +158,13 @@ class AdaptFrameworkModule extends AbstractModule {
       } catch (e) {
         // package is missing, an install is required
       }
-      await this.runCliCommand('installFramework', { version })
+      if (version) {
+        this.checkVersionCompatibility(version)
+      }
+      await this.runCliCommand('installFramework', { version: version ?? this.targetVersionRange })
     } catch (e) {
       this.log('error', `failed to install framework, ${e.message}`)
-      throw this.app.errors.FW_INSTALL_FAILED.setData({ reason: e.message })
+      throw e.statusCode ? e : this.app.errors.FW_INSTALL_FAILED.setData({ reason: e.message })
     }
     this.log('verbose', 'INSTALL hook invoke')
     await this.postInstallHook.invoke()
@@ -136,7 +176,7 @@ class AdaptFrameworkModule extends AbstractModule {
    */
   async getLatestVersion () {
     try {
-      return semver.clean(await this.runCliCommand('getLatestFrameworkVersion'))
+      return semver.clean(await this.runCliCommand('getLatestFrameworkVersion', { version: this.targetVersionRange }))
     } catch (e) {
       this.log('error', `failed to retrieve framework update data, ${e.message}`)
       throw this.app.errors.FW_LATEST_VERSION_FAILED.setData({ reason: e.message })
@@ -167,11 +207,14 @@ class AdaptFrameworkModule extends AbstractModule {
    */
   async updateFramework (version) {
     try {
-      await this.runCliCommand('updateFramework', { version })
+      if (version) {
+        this.checkVersionCompatibility(version)
+      }
+      await this.runCliCommand('updateFramework', { version: version ?? this.targetVersionRange })
       this._version = await this.runCliCommand('getCurrentFrameworkVersion')
     } catch (e) {
       this.log('error', `failed to update framework, ${e.message}`)
-      throw this.app.errors.FW_UPDATE_FAILED.setData({ reason: e.message })
+      throw e.statusCode ? e : this.app.errors.FW_UPDATE_FAILED.setData({ reason: e.message })
     }
     this.postUpdateHook.invoke()
   }
@@ -181,7 +224,7 @@ class AdaptFrameworkModule extends AbstractModule {
    */
   async logStatus () {
     const current = this.version
-    const latest = await this.runCliCommand('getLatestFrameworkVersion')
+    const latest = await this.getLatestVersion()
 
     this.log('info', `local adapt_framework v${current} installed`)
     if (semver.lt(current, latest)) {

package/package.json

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