adapt-authoring-adaptframework 2.5.1 → 2.5.3

package/.github/workflows/releases.yml

@@ -1,32 +1,16 @@
 name: Release
+
 on:
   push:
     branches:
       - master
 
+permissions:
+  contents: write
+  issues: write
+  pull-requests: write
+  id-token: write
+
 jobs:
   release:
-    name: Release
-    runs-on: ubuntu-latest
-    permissions:
-      contents: write # to be able to publish a GitHub release
-      issues: write # to be able to comment on released issues
-      pull-requests: write # to be able to comment on released pull requests
-      id-token: write # to enable use of OIDC for trusted publishing and npm provenance
-    steps:
-      - name: Checkout
-        uses: actions/checkout@master
-        with:
-          fetch-depth: 0
-      - name: Setup Node.js
-        uses: actions/setup-node@master
-        with:
-          node-version: 'lts/*'
-      - name: Update npm
-        run: npm install -g npm@latest
-      - name: Install dependencies
-        run: npm install
-      - name: Release
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: npx semantic-release
+    uses: adaptlearning/semantic-release-config/.github/workflows/release.yml@master

package/lib/AdaptFrameworkBuild.js

@@ -211,6 +211,7 @@ class AdaptFrameworkBuild {
 
     await this.preBuildHook.invoke(this)
 
+    await this.applySchemaDefaults()
     await this.writeContentJson()
 
     logDir('courseDir', this.courseDir)
@@ -425,6 +426,60 @@ class AdaptFrameworkBuild {
     }))
   }
 
+  /**
+   * Applies schema defaults to the in-memory course and config data using
+   * the jsonschema module. Replicates what grunt's schema-defaults task does.
+   *
+   * TODO: replace validateWithDefaults workaround with schema.validate(data, { ignoreErrors: true })
+   * once migrated to adapt-schemas v3.x (see #184)
+   * @return {Promise}
+   */
+  async applySchemaDefaults () {
+    const [jsonschema, contentplugin] = await App.instance.waitForModule('jsonschema', 'contentplugin')
+
+    const enabledPluginSchemas = this.enabledPlugins
+      .reduce((m, p) => [...m, ...contentplugin.getPluginSchemas(p.name)], [])
+    const extensionFilter = s => contentplugin.isPluginSchema(s) ? enabledPluginSchemas.includes(s) : true
+    const getSchema = name => jsonschema.getSchema(name, { useCache: false, extensionFilter })
+
+    /**
+     * Applies defaults via validate(), catching and ignoring validation errors.
+     * The validated+defaulted data is returned from validate() on success, or
+     * extracted from the error on failure (validate clones internally).
+     */
+    const validateWithDefaults = (schema, data) => {
+      try {
+        return schema.validate(data, { useDefaults: true, ignoreRequired: true })
+      } catch (e) {
+        return e.data.data
+      }
+    }
+
+    const [courseSchema, configSchema] = await Promise.all([
+      getSchema('course'),
+      getSchema('config')
+    ])
+    Object.assign(this.courseData.course.data, validateWithDefaults(courseSchema, this.courseData.course.data))
+    Object.assign(this.courseData.config.data, validateWithDefaults(configSchema, this.courseData.config.data))
+
+    for (const type of ['contentObject', 'article', 'block']) {
+      const schemaName = type === 'contentObject' ? 'contentobject' : type
+      const schema = await getSchema(schemaName)
+      for (const item of this.courseData[type].data) {
+        Object.assign(item, validateWithDefaults(schema, item))
+      }
+    }
+
+    const componentSchemas = {}
+    for (const item of this.courseData.component.data) {
+      const schemaName = `${item._component}-component`
+      if (!componentSchemas[schemaName]) {
+        componentSchemas[schemaName] = await getSchema(schemaName)
+      }
+      Object.assign(item, validateWithDefaults(componentSchemas[schemaName], item))
+    }
+  }
+
   /**
    * Outputs all course data to the required JSON files
    * @return {Promise}

package/lib/AdaptFrameworkImport.js

@@ -881,7 +881,7 @@ class AdaptFrameworkImport {
     // Uninstall newly installed plugins
     if (this.contentplugin) {
       tasks.push(...Object.values(this.newContentPlugins).map(p =>
-        this.contentplugin.uninstallPlugin(p._id)
+        this.contentplugin.delete({ _id: p._id })
           .catch(e => log('warn', `failed to uninstall plugin '${p.name}'`, e))
       ))
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "adapt-authoring-adaptframework",
-  "version": "2.5.1",
+  "version": "2.5.3",
   "description": "Adapt framework integration for the Adapt authoring tool",
   "homepage": "https://github.com/adapt-security/adapt-authoring-adaptframework",
   "license": "GPL-3.0",
@@ -14,11 +14,11 @@
     "adapt-authoring-content": "^2.0.0",
     "adapt-authoring-contentplugin": "^1.0.3",
     "adapt-authoring-core": "^2.0.0",
-    "adapt-authoring-courseassets": "^1.0.3",
     "adapt-authoring-coursetheme": "^1.0.2",
     "adapt-authoring-mongodb": "^3.0.0",
     "adapt-authoring-spoortracking": "^1.0.2",
     "adapt-cli": "^3.3.3",
+    "adapt-migrations": "^1.4.0",
     "adapt-octopus": "^0.1.2",
     "bytes": "^3.1.2",
     "fs-extra": "11.3.3",
@@ -37,35 +37,10 @@
     "adapt-authoring-tags": "^1.0.1"
   },
   "devDependencies": {
-    "@semantic-release/git": "^10.0.1",
-    "conventional-changelog-eslint": "^6.0.0",
-    "semantic-release": "^25.0.2",
+    "@adaptlearning/semantic-release-config": "^1.0.0",
     "standard": "^17.1.0"
   },
   "release": {
-    "plugins": [
-      [
-        "@semantic-release/commit-analyzer",
-        {
-          "preset": "eslint"
-        }
-      ],
-      [
-        "@semantic-release/release-notes-generator",
-        {
-          "preset": "eslint"
-        }
-      ],
-      "@semantic-release/npm",
-      "@semantic-release/github",
-      [
-        "@semantic-release/git",
-        {
-          "assets": [
-            "package.json"
-          ]
-        }
-      ]
-    ]
+    "extends": "@adaptlearning/semantic-release-config"
   }
 }

package/tests/AdaptFrameworkImport.spec.js

@@ -416,7 +416,7 @@ describe('AdaptFrameworkImport', () => {
       const uninstalled = []
       const ctx = makeRollbackCtx({
         contentplugin: {
-          uninstallPlugin: async (id) => uninstalled.push(id)
+          delete: async ({ _id }) => uninstalled.push(_id)
         },
         newContentPlugins: {
           'adapt-contrib-text': { _id: 'p1', name: 'adapt-contrib-text' },
@@ -515,9 +515,9 @@ describe('AdaptFrameworkImport', () => {
       const uninstalled = []
       const ctx = makeRollbackCtx({
         contentplugin: {
-          uninstallPlugin: async (id) => {
-            if (id === 'p1') throw new Error('uninstall failed')
-            uninstalled.push(id)
+          delete: async ({ _id }) => {
+            if (_id === 'p1') throw new Error('uninstall failed')
+            uninstalled.push(_id)
           }
         },
         newContentPlugins: {