adapt-authoring-adaptframework 1.8.2 → 1.9.1

package/lib/AdaptFrameworkBuild.js

@@ -194,7 +194,11 @@ class AdaptFrameworkBuild {
 
     await Promise.all([
       this.copyAssets(),
-      this.copySource()
+      FWUtils.copyFrameworkSource({
+        destDir: this.dir,
+        enabledPlugins: this.enabledPlugins.map(p => p.name),
+        linkNodeModules: !this.isExport
+      })
     ])
     await this.preBuildHook.invoke(this)
 
@@ -393,31 +397,6 @@ class AdaptFrameworkBuild {
     }
   }
 
-  /**
-   * Copies the source code needed for this course. Plugin copy works as a whitelist any unknown plugin files aren't included erroneously.
-   * @return {Promise}
-   */
-  async copySource () {
-    const { path: fwPath } = await App.instance.waitForModule('adaptframework')
-    const BLACKLIST = ['.git', '.DS_Store', 'thumbs.db', 'node_modules', 'course', 'migrations']
-    const ENABLED_PLUGINS = this.enabledPlugins.map(p => p.name)
-    const srcDir = path.join(fwPath, 'src')
-    await fs.cp(fwPath, this.dir, {
-      recursive: true,
-      filter: f => {
-        f = path.normalize(f)
-        const [type, name] = path.relative(srcDir, f).split('/')
-        const isPlugin = f.startsWith(srcDir) && type && type !== 'core' && !!name
-
-        if (isPlugin && !ENABLED_PLUGINS.includes(name)) {
-          return false
-        }
-        return !BLACKLIST.includes(path.basename(f))
-      }
-    })
-    if (!this.isExport) await fs.symlink(`${fwPath}/node_modules`, `${this.dir}/node_modules`, 'junction')
-  }
-
   /**
    * Deals with copying all assets used in this course
    * @return {Promise}

package/lib/AdaptFrameworkImport.js

@@ -1,11 +1,11 @@
-import { App, Hook } from 'adapt-authoring-core'
+import { App, Hook, Utils } from 'adapt-authoring-core'
 import fs from 'fs/promises'
 import { glob } from 'glob'
 import octopus from 'adapt-octopus'
 import path from 'upath'
+import { randomBytes } from 'node:crypto'
 import semver from 'semver'
 import { unzip } from 'zipper'
-
 import FWUtils from './AdaptFrameworkUtils.js'
 
 import ComponentTransform from './migrations/component.js'
@@ -245,11 +245,10 @@ class AdaptFrameworkImport {
        */
       this.jsonschema = jsonschema
 
-      FWUtils.log('info', `running with settings ${JSON.stringify(this.settings, null, 2)}`)
-      FWUtils.log('debug', 'IMPORT_SETTINGS', JSON.stringify(this.settings, null, 2))
       FWUtils.log('debug', 'IMPORT_USER', this.userId)
+      FWUtils.log('debug', 'IMPORT_SETTINGS', JSON.stringify(this.settings, null, 2))
 
-      const { isDryRun, importContent, importPlugins } = this.settings
+      const { isDryRun, importContent, importPlugins, migrateContent } = this.settings
       const tasks = [
         [this.prepare],
         [this.loadAssetData],
@@ -260,7 +259,7 @@ class AdaptFrameworkImport {
         [this.importCoursePlugins, isDryRun && importPlugins],
         [this.importCoursePlugins, !isDryRun && importContent],
         [this.loadCourseData, isDryRun && importContent],
-        [this.migrateCourseData, !isDryRun && importContent],
+        [this.migrateCourseData, !isDryRun && migrateContent],
         [this.loadCourseData, !isDryRun && importContent],
         [this.importCourseData, !isDryRun && importContent],
         [this.generateSummary]
@@ -476,8 +475,12 @@ class AdaptFrameworkImport {
    * Run grunt task
    * @return {Promise}
    */
-  async runGruntTask (subTask, { outputDir, captureDir, outputFilePath }) {
-    const output = await FWUtils.spawnPromise('npx', ['grunt', `migration:${subTask}`, `--outputdir=${outputDir}`, `--capturedir=${captureDir}`])
+  async runGruntMigration (subTask, { outputDir, captureDir, outputFilePath }) {
+    const output = await Utils.spawn({
+      cmd: 'npx',
+      args: ['grunt', `migration:${subTask}`, `--outputdir=${outputDir}`, `--capturedir=${captureDir}`],
+      cwd: this.frameworkPath ?? this.framework.path
+    })
     if (outputFilePath) await fs.writeFile(outputFilePath, output)
   }
 
@@ -489,16 +492,19 @@ class AdaptFrameworkImport {
       await this.patchThemeName()
       await this.patchCustomStyle()
 
+      const migrationId = `${this.userId}-${randomBytes(4).toString('hex')}`
+
       const opts = {
         outputDir: path.relative(this.framework.path, path.resolve(this.coursePath, '..')),
-        captureDir: path.join(`./${this.userId}-migrations`),
-        outputFilePath: path.join(this.framework.path, 'migrations', `${this.userId}.txt`)
+        captureDir: path.join(`./${migrationId}-migrations`),
+        outputFilePath: path.join(this.framework.path, 'migrations', `${migrationId}.txt`)
       }
+      FWUtils.log('debug', 'MIGRATION_ID', migrationId)
       FWUtils.logDir('captureDir', opts.captureDir)
       FWUtils.logDir('outputDir', opts.outputDir)
 
-      await this.runGruntTask('capture', opts)
-      await this.runGruntTask('migrate', opts)
+      await this.runGruntMigration('capture', opts)
+      await this.runGruntMigration('migrate', opts)
 
       await fs.rm(path.join(this.framework.path, opts.captureDir), { recursive: true })
     } catch (error) {

package/lib/AdaptFrameworkModule.js

@@ -111,9 +111,7 @@ class AdaptFrameworkModule extends AbstractModule {
   async installFramework (version, force = false) {
     this.log('verbose', 'INSTALL')
     try {
-      const modsPath = path.resolve(this.path, '..', 'node_modules')
       try {
-        await fs.stat(modsPath)
         await fs.readFile(path.resolve(this.path, 'package.json'))
         if (!force) {
           this.log('verbose', 'INSTALL no action, force !== true')
@@ -125,13 +123,6 @@ class AdaptFrameworkModule extends AbstractModule {
         // if src and node_modules are missing, install required
       }
       await this.runCliCommand('installFramework', { version })
-      // move node_modules into place
-      this.log('verbose', 'INSTALL node_modules')
-      try {
-        await fs.rm(modsPath, { recursive: true })
-      } catch (e) {}
-      // move node_modules so it can be shared with all builds
-      await fs.rename(path.join(this.path, 'node_modules'), modsPath)
     } catch (e) {
       this.log('error', `failed to install framework, ${e.message}`)
       throw this.app.errors.FW_INSTALL_FAILED

package/lib/AdaptFrameworkUtils.js

@@ -5,7 +5,6 @@ import fs from 'fs/promises'
 /* eslint-disable import/no-named-default */import { default as fsSync } from 'fs'
 import path from 'upath'
 import semver from 'semver'
-import { spawn } from 'child_process'
 
 /** @ignore */ const buildCache = {}
 
@@ -194,6 +193,38 @@ class AdaptFrameworkUtils {
     return `${sanitisedTitle}${buildData.action === 'export' ? '-export' : ''}`
   }
 
+  /**
+     * Copies the framework source directory
+     * @param {Object} options
+     * @param {String} options.destDir The destination directory path
+     * @param {Array<String>} options.enabledPlugins List of plugins to include
+     * @param {Boolean} options.copyNodeModules Whether to physically copy node_modules
+     * @param {Boolean} options.linkNodeModules Whether to symlink node_modules
+     * @return {Promise}
+     */
+  static async copyFrameworkSource (options) {
+    const { path: fwPath } = await App.instance.waitForModule('adaptframework')
+    const BLACKLIST = ['.git', '.DS_Store', 'thumbs.db', 'course', 'migrations']
+    if (options.copyNodeModules !== true) BLACKLIST.push('node_modules')
+
+    const srcDir = path.join(fwPath, 'src')
+    const enabledPlugins = options.enabledPlugins ?? []
+    await fs.cp(fwPath, options.destDir, {
+      recursive: true,
+      filter: f => {
+        f = path.normalize(f)
+        const [type, name] = path.relative(srcDir, f).split('/')
+        const isPlugin = f.startsWith(srcDir) && type && type !== 'core' && !!name
+
+        if (isPlugin && !enabledPlugins.includes(name)) {
+          return false
+        }
+        return !BLACKLIST.includes(path.basename(f))
+      }
+    })
+    if (options.linkNodeModules !== false) await fs.symlink(`${fwPath}/node_modules`, `${options.destDir}/node_modules`, 'junction')
+  }
+
   /**
    * Handles GET requests to the API
    * @param {external:ExpressRequest} req
@@ -361,26 +392,6 @@ class AdaptFrameworkUtils {
       handler(middleware.zipTypes, { maxFileSize: fw.getConfig('importMaxFileSize'), unzip: true })(req, res, e => e ? reject(e) : resolve())
     })
   }
-
-  static async spawnPromise (cmd, args) {
-    const framework = await App.instance.waitForModule('adaptframework')
-    return new Promise((resolve, reject) => {
-      const cwd = framework.path
-      AdaptFrameworkUtils.log('debug', 'SPAWN', cmd, cwd)
-      const task = spawn(cmd, args, { cwd })
-      let output = ''
-      let error
-      task.stdout.on('data', data => {
-        output += data
-      })
-      task.on('error', e => {
-        error = e
-      })
-      task.on('close', exitCode => {
-        exitCode !== 0 ? reject(framework.app.errors.SPAWN.setData({ error })) : resolve(output)
-      })
-    })
-  }
 }
 
 export default AdaptFrameworkUtils

package/package.json

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