adapt-authoring-contentplugin 1.5.4 → 1.6.0

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@v3
-        with:
-          fetch-depth: 0
-      - name: Setup Node.js
-        uses: actions/setup-node@v3
-        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/ContentPluginModule.js

@@ -4,6 +4,7 @@ import path from 'node:path'
 import { readJson } from 'adapt-authoring-core'
 import { loadRouteConfig } from 'adapt-authoring-server'
 import {
+  addDefaultPlugins,
   backupPluginVersion,
   getMostRecentBackup,
   cleanupOldPluginBackups,
@@ -44,7 +45,7 @@ class ContentPluginModule extends AbstractApiModule {
     if (!process.env.ADAPT_ALLOW_PRERELEASE) {
       process.env.ADAPT_ALLOW_PRERELEASE = 'true'
     }
-    const [framework, mongodb] = await this.app.waitForModule('adaptframework', 'mongodb')
+    const [framework, mongodb, content] = await this.app.waitForModule('adaptframework', 'mongodb', 'content')
 
     await mongodb.setIndex(this.collectionName, 'name', { unique: true })
     await mongodb.setIndex(this.collectionName, 'displayName', { unique: true })
@@ -60,6 +61,7 @@ class ContentPluginModule extends AbstractApiModule {
     } catch (e) {
       this.log('error', e)
     }
+    content.preInsertHook.tap((...args) => addDefaultPlugins(this, ...args))
     this.framework.postInstallHook.tap(this.syncPluginData.bind(this))
     this.framework.postUpdateHook.tap(this.syncPluginData.bind(this))
   }

package/lib/utils/addDefaultPlugins.js

@@ -0,0 +1,21 @@
+/**
+ * Adds default plugins to a course config's _enabledPlugins list.
+ * Intended to be tapped into the content module's preInsertHook.
+ * @param {Object} contentplugin The contentplugin module instance
+ * @param {Object} data The insert data (mutated in place)
+ * @param {Object} options
+ * @param {String} options.schemaName The schema name for the insert
+ */
+async function addDefaultPlugins (contentplugin, data, { schemaName }) {
+  if (schemaName !== 'config') {
+    return
+  }
+  const defaultPlugins = await contentplugin.find({ isAddedByDefault: true })
+  if (!defaultPlugins.length) {
+    return
+  }
+  if (!data._enabledPlugins) data._enabledPlugins = []
+  defaultPlugins.forEach(({ name }) => !data._enabledPlugins.includes(name) && data._enabledPlugins.push(name))
+}
+
+export { addDefaultPlugins }

package/lib/utils.js

@@ -1,3 +1,4 @@
+export { addDefaultPlugins } from './utils/addDefaultPlugins.js'
 export { backupPluginVersion } from './utils/backupPluginVersion.js'
 export { getMostRecentBackup } from './utils/getMostRecentBackup.js'
 export { cleanupOldPluginBackups } from './utils/cleanupOldPluginBackups.js'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "adapt-authoring-contentplugin",
-  "version": "1.5.4",
+  "version": "1.6.0",
   "description": "Module for managing framework plugins",
   "homepage": "https://github.com/adapt-security/adapt-authoring-contentplugin",
   "repository": "github:adapt-security/adapt-authoring-contentplugin",
@@ -24,36 +24,10 @@
     "adapt-authoring-server": "^2.1.0"
   },
   "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"
-          ],
-          "message": "Chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
-        }
-      ]
-    ]
+    "extends": "@adaptlearning/semantic-release-config"
   }
 }

package/schema/contentplugin.schema.json

@@ -55,6 +55,11 @@
     "latestCompatibleVersion" : {
       "type": "boolean",
       "isReadOnly": true
+    },
+    "isAddedByDefault": {
+      "description": "Whether the plugin should be added by default for new courses",
+      "type": "boolean",
+      "default": false
     }
   },
   "required": ["framework", "name", "type", "version", "isLocalInstall"]

package/tests/utils-addDefaultPlugins.spec.js

@@ -0,0 +1,121 @@
+import { describe, it } from 'node:test'
+import assert from 'node:assert/strict'
+import { addDefaultPlugins } from '../lib/utils/addDefaultPlugins.js'
+
+function createMockContentplugin (plugins = []) {
+  return { find: async () => plugins }
+}
+
+describe('addDefaultPlugins', () => {
+  describe('when schemaName is not config', () => {
+    it('should not modify data for non-config schemas', async () => {
+      const contentplugin = createMockContentplugin([{ name: 'plugin-a' }])
+      const data = {}
+      await addDefaultPlugins(contentplugin, data, { schemaName: 'course' })
+      assert.equal(data._enabledPlugins, undefined)
+    })
+
+    it('should not modify data for article schema', async () => {
+      const contentplugin = createMockContentplugin([{ name: 'plugin-a' }])
+      const data = { _enabledPlugins: ['existing'] }
+      await addDefaultPlugins(contentplugin, data, { schemaName: 'article' })
+      assert.deepEqual(data._enabledPlugins, ['existing'])
+    })
+  })
+
+  describe('when schemaName is config', () => {
+    it('should add default plugins to _enabledPlugins', async () => {
+      const contentplugin = createMockContentplugin([{ name: 'plugin-a' }, { name: 'plugin-b' }])
+      const data = {}
+      await addDefaultPlugins(contentplugin, data, { schemaName: 'config' })
+      assert.deepEqual(data._enabledPlugins, ['plugin-a', 'plugin-b'])
+    })
+
+    it('should create _enabledPlugins array if it does not exist', async () => {
+      const contentplugin = createMockContentplugin([{ name: 'plugin-a' }])
+      const data = {}
+      await addDefaultPlugins(contentplugin, data, { schemaName: 'config' })
+      assert.ok(Array.isArray(data._enabledPlugins))
+      assert.deepEqual(data._enabledPlugins, ['plugin-a'])
+    })
+
+    it('should append to existing _enabledPlugins', async () => {
+      const contentplugin = createMockContentplugin([{ name: 'plugin-b' }])
+      const data = { _enabledPlugins: ['plugin-a'] }
+      await addDefaultPlugins(contentplugin, data, { schemaName: 'config' })
+      assert.deepEqual(data._enabledPlugins, ['plugin-a', 'plugin-b'])
+    })
+
+    it('should not duplicate plugins already in _enabledPlugins', async () => {
+      const contentplugin = createMockContentplugin([{ name: 'plugin-a' }, { name: 'plugin-b' }])
+      const data = { _enabledPlugins: ['plugin-a'] }
+      await addDefaultPlugins(contentplugin, data, { schemaName: 'config' })
+      assert.deepEqual(data._enabledPlugins, ['plugin-a', 'plugin-b'])
+    })
+
+    it('should not modify _enabledPlugins when no default plugins found', async () => {
+      const contentplugin = createMockContentplugin([])
+      const data = { _enabledPlugins: ['existing'] }
+      await addDefaultPlugins(contentplugin, data, { schemaName: 'config' })
+      assert.deepEqual(data._enabledPlugins, ['existing'])
+    })
+
+    it('should not create _enabledPlugins when no default plugins found', async () => {
+      const contentplugin = createMockContentplugin([])
+      const data = {}
+      await addDefaultPlugins(contentplugin, data, { schemaName: 'config' })
+      assert.equal(data._enabledPlugins, undefined)
+    })
+
+    it('should call find with isAddedByDefault true', async () => {
+      let findQuery
+      const contentplugin = {
+        find: async (query) => {
+          findQuery = query
+          return []
+        }
+      }
+      await addDefaultPlugins(contentplugin, {}, { schemaName: 'config' })
+      assert.deepEqual(findQuery, { isAddedByDefault: true })
+    })
+
+    it('should handle a single default plugin', async () => {
+      const contentplugin = createMockContentplugin([{ name: 'only-plugin' }])
+      const data = {}
+      await addDefaultPlugins(contentplugin, data, { schemaName: 'config' })
+      assert.deepEqual(data._enabledPlugins, ['only-plugin'])
+    })
+
+    it('should handle many default plugins', async () => {
+      const plugins = Array.from({ length: 10 }, (_, i) => ({ name: `plugin-${i}` }))
+      const contentplugin = createMockContentplugin(plugins)
+      const data = {}
+      await addDefaultPlugins(contentplugin, data, { schemaName: 'config' })
+      assert.equal(data._enabledPlugins.length, 10)
+      plugins.forEach((p, i) => {
+        assert.equal(data._enabledPlugins[i], p.name)
+      })
+    })
+
+    it('should handle all plugins already enabled', async () => {
+      const contentplugin = createMockContentplugin([{ name: 'plugin-a' }, { name: 'plugin-b' }])
+      const data = { _enabledPlugins: ['plugin-a', 'plugin-b'] }
+      await addDefaultPlugins(contentplugin, data, { schemaName: 'config' })
+      assert.deepEqual(data._enabledPlugins, ['plugin-a', 'plugin-b'])
+    })
+
+    it('should preserve order of existing plugins', async () => {
+      const contentplugin = createMockContentplugin([{ name: 'plugin-c' }])
+      const data = { _enabledPlugins: ['plugin-b', 'plugin-a'] }
+      await addDefaultPlugins(contentplugin, data, { schemaName: 'config' })
+      assert.deepEqual(data._enabledPlugins, ['plugin-b', 'plugin-a', 'plugin-c'])
+    })
+
+    it('should handle _enabledPlugins as empty array', async () => {
+      const contentplugin = createMockContentplugin([{ name: 'plugin-a' }])
+      const data = { _enabledPlugins: [] }
+      await addDefaultPlugins(contentplugin, data, { schemaName: 'config' })
+      assert.deepEqual(data._enabledPlugins, ['plugin-a'])
+    })
+  })
+})