adapt-authoring-adaptframework 3.1.3 → 3.1.4

package/lib/AdaptFrameworkBuild.js

@@ -3,7 +3,7 @@ import { App, Hook, ensureDir, writeJson } from 'adapt-authoring-core'
 import { parseObjectId } from 'adapt-authoring-mongodb'
 import { createWriteStream } from 'node:fs'
 import AdaptCli from 'adapt-cli'
-import { log, logDir, logMemory, copyFrameworkSource, generateLanguageManifest, applyBuildReplacements, computeVarsHash } from './utils.js'
+import { log, logDir, logMemory, copyFrameworkSource, generateLanguageManifest, applyBuildReplacements, computeVarsHash, getBundledPlugins } from './utils.js'
 import BuildCache from './BuildCache.js'
 import fs from 'node:fs/promises'
 import path from 'upath'
@@ -232,16 +232,7 @@ class AdaptFrameworkBuild {
 
     const tasks = [this.copyAssets()]
     if (!contentOnly) {
-      // preview cache is shared across courses, so include all installed plugins
-      // — except disabled themes/menus, since only one of each can be active per
-      // build and the framework's less:dev task globs every theme/menu in src/,
-      // which OOMs when more than one is present (see adapt_framework#3802).
-      const pluginsToInclude = this.isPreview
-        ? [
-            ...this.enabledPlugins,
-            ...this.disabledPlugins.filter(p => p.type !== 'theme' && p.type !== 'menu')
-          ]
-        : this.enabledPlugins
+      const pluginsToInclude = getBundledPlugins(this.isPreview, this.enabledPlugins, this.disabledPlugins)
       tasks.push(copyFrameworkSource({
         destDir: this.dir,
         enabledPlugins: pluginsToInclude.map(p => p.name),
@@ -526,6 +517,8 @@ class AdaptFrameworkBuild {
     courseSchema.compiledWithDefaults(this.courseData.course.data)
     configSchema.compiledWithDefaults(this.courseData.config.data)
 
+    if (this.isPreview) await this.applyBundledGlobalsDefaults()
+
     for (const type of ['contentObject', 'article', 'block']) {
       const schemaName = type === 'contentObject' ? 'contentobject' : type
       const schema = await getSchema(schemaName)
@@ -544,6 +537,26 @@ class AdaptFrameworkBuild {
     }
   }
 
+  /**
+   * Defaults _globals for every bundled plugin. A preview bundles all installed
+   * plugins, so a disabled plugin's app:dataReady handler can read _globals that
+   * the enabled-only defaults pass leaves undefined and throw, aborting the whole
+   * dispatch. Only _globals is copied back (authored values preserved), matching
+   * grunt's schema-defaults task so a cache-hit preview equals a cache-miss build.
+   * @return {Promise}
+   */
+  async applyBundledGlobalsDefaults () {
+    const [jsonschema, contentplugin] = await App.instance.waitForModule('jsonschema', 'contentplugin')
+    const bundledPlugins = getBundledPlugins(this.isPreview, this.enabledPlugins, this.disabledPlugins)
+    const bundledSchemas = bundledPlugins
+      .reduce((m, p) => [...m, ...contentplugin.getPluginSchemas(p.name)], [])
+    const extensionFilter = s => contentplugin.isPluginSchema(s) ? bundledSchemas.includes(s) : true
+    const courseSchema = await jsonschema.getSchema('course', { useCache: false, extensionFilter })
+    const clone = structuredClone(this.courseData.course.data)
+    courseSchema.compiledWithDefaults(clone)
+    this.courseData.course.data._globals = clone._globals
+  }
+
   /**
    * Writes the language_data_manifest.js for each language dir.
    * Only needed on cache-hit builds where grunt is skipped.

package/lib/utils/getBundledPlugins.js

@@ -0,0 +1,18 @@
+/**
+ * Returns the plugins bundled into a build. A preview's cache is shared across
+ * courses, so it bundles all installed plugins — except disabled themes/menus,
+ * since only one of each can be active per build and the framework's less:dev
+ * task globs every theme/menu in src/, which OOMs when more than one is present
+ * (see adapt_framework#3802). Non-preview builds bundle only enabled plugins.
+ * @param {Boolean} isPreview Whether this is a preview build
+ * @param {Array<Object>} enabledPlugins Plugins used by the course
+ * @param {Array<Object>} disabledPlugins Plugins installed but not used by the course
+ * @return {Array<Object>} The plugins to bundle
+ */
+export function getBundledPlugins (isPreview, enabledPlugins, disabledPlugins) {
+  if (!isPreview) return enabledPlugins
+  return [
+    ...enabledPlugins,
+    ...disabledPlugins.filter(p => p.type !== 'theme' && p.type !== 'menu')
+  ]
+}

package/lib/utils.js

@@ -17,3 +17,4 @@ export { prebuildCache } from './utils/prebuildCache.js'
 export { generateLanguageManifest } from './utils/generateLanguageManifest.js'
 export { applyBuildReplacements } from './utils/applyBuildReplacements.js'
 export { computeVarsHash } from './utils/computeVarsHash.js'
+export { getBundledPlugins } from './utils/getBundledPlugins.js'

package/package.json

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

package/tests/utils-getBundledPlugins.spec.js

@@ -0,0 +1,61 @@
+import { describe, it } from 'node:test'
+import assert from 'node:assert/strict'
+
+import { getBundledPlugins } from '../lib/utils/getBundledPlugins.js'
+
+describe('getBundledPlugins()', () => {
+  const enabled = [
+    { name: 'adapt-contrib-text', type: 'component' },
+    { name: 'adapt-contrib-vanilla', type: 'theme' }
+  ]
+  const disabled = [
+    { name: 'adapt-contrib-pageLevelProgress', type: 'extension' },
+    { name: 'adapt-contrib-media', type: 'component' },
+    { name: 'adapt-contrib-spoor', type: 'extension' },
+    { name: 'some-other-theme', type: 'theme' },
+    { name: 'some-other-menu', type: 'menu' }
+  ]
+
+  it('should return only enabled plugins for a non-preview build', () => {
+    assert.deepEqual(getBundledPlugins(false, enabled, disabled), enabled)
+  })
+
+  it('should not mutate the enabled array for a non-preview build', () => {
+    const result = getBundledPlugins(false, enabled, disabled)
+    assert.equal(result, enabled)
+  })
+
+  it('should bundle enabled plus disabled non-theme/menu plugins for a preview', () => {
+    const result = getBundledPlugins(true, enabled, disabled)
+    assert.deepEqual(result.map(p => p.name), [
+      'adapt-contrib-text',
+      'adapt-contrib-vanilla',
+      'adapt-contrib-pageLevelProgress',
+      'adapt-contrib-media',
+      'adapt-contrib-spoor'
+    ])
+  })
+
+  it('should exclude disabled themes from a preview', () => {
+    const result = getBundledPlugins(true, enabled, disabled)
+    assert.ok(!result.some(p => p.name === 'some-other-theme'))
+  })
+
+  it('should exclude disabled menus from a preview', () => {
+    const result = getBundledPlugins(true, enabled, disabled)
+    assert.ok(!result.some(p => p.name === 'some-other-menu'))
+  })
+
+  it('should keep enabled themes/menus in a preview (only disabled ones are excluded)', () => {
+    const result = getBundledPlugins(true, enabled, disabled)
+    assert.ok(result.some(p => p.name === 'adapt-contrib-vanilla' && p.type === 'theme'))
+  })
+
+  it('should return only enabled plugins when no plugins are disabled', () => {
+    assert.deepEqual(getBundledPlugins(true, enabled, []), enabled)
+  })
+
+  it('should return an empty array when nothing is enabled or disabled', () => {
+    assert.deepEqual(getBundledPlugins(true, [], []), [])
+  })
+})