adapt-security/adapt-authoring-adaptframework

Adapt framework integration for the Adapt authoring tool

adapt-authoring-adaptframework's Issues

Add manifest getter to CLI

Should return plugins defined in the manifest. AdaptFrameworkModule#getManifestPlugins will need to be amended.

Course folder should be output to src

The build folder is currently used

• AdaptFrameworkImport.js#L255

Update build for new caching mechanism

• Remove references to .cache file
• Check for any enhancements that are needed to integrate new cache

Implement CLI update API

• adaptlearning/adapt-cli#195
• adaptlearning/adapt-cli#194

Import should support assets.json

Import of latest framework fails on various schema items

What happened?

All tool packages using latest code. Adapt framework installed in tool is 5.31.12.

Importing a 5.31.12 source zip file produces following errors:

Import of framework course failed, Import of framework content failed, article a-15 /_assessment/_attempts must be number, ; graphic-component c-25 /_graphic must have required property 'large', /_graphic must have required property 'small', ; graphic-component c-62 /_graphic must have required property 'large', /_graphic must have required property 'small', ; graphic-component c-72 /_graphic must have required property 'large', /_graphic must have required property 'small', ; graphic-component c-95 /_graphic must have required property 'large', /_graphic must have required property 'small', ; graphic-component c-105 /_graphic must have required property 'large', /_graphic must have required property 'small', ; graphic-component c-115 /_graphic must have required property 'large', /_graphic must have required property 'small', ; graphic-component c-125 /_graphic must have required property 'large', /_graphic must have required property 'small', ; graphic-component c-135 /_graphic must have required property 'large', /_graphic must have required property 'small', ; graphic-component c-145 /_graphic must have required property 'large', /_graphic must have required property 'small',

I expect these issues should be resolved in the framework (i.e. https://github.com/adaptlearning/adapt_framework/tree/master/src/course/en)

Expected behaviour

No response

Steps to reproduce

See above

Authoring tool version

master

Framework version

No response

What browsers are you seeing the problem on?

No response

Relevant log output

No response

Export should support assets.json

...to export metadata

Add support for build caching

The framework's build cache is currently broken and therefore has been disabled.

---

Currently the adapt-cli uses the OS temp folder to store the cache path. This can result in EPERM errors when running multiple instances under different users on the same server (as cache dir is created & owned by the first user to build a course).

Implementation notes

• https://github.com/adaptlearning/adapt_framework/blob/7ee8edddc2c416ad042668a3b7b87b29a4bae4a2/grunt/helpers.js#L209C25-L209C50
• https://github.com/adaptlearning/adapt_framework/blob/7ee8edddc2c416ad042668a3b7b87b29a4bae4a2/grunt/helpers/CacheManager.js#L26-L35
• This line is wrong https://github.com/adaptlearning/adapt_framework/blob/7ee8edddc2c416ad042668a3b7b87b29a4bae4a2/grunt/tasks/javascript.js#L133C23-L134C1

cacheManager.cachePath( 
cwd, options.out, buildConfig.cachepath);

cachePath(basePath, outputFilePath = process.cwd(), configuredCachePath) {
   const projectHash = CacheManager.hash(path.join(basePath, outputFilePath));
   const cachePath = path.join(configuredCachePath || this.tempPath, `${projectHash}.cache`);
   return cachePath;
  }

Missing API endpoint when adding a tag to a course during import framework source

2 API errors occur when attempting to include a tag during the framework import process.
Upon completion of the framework import, the tag is not added to the imported course. The 2 errors appear in the logs:

2022-04-21T15:03:48.758Z error server {"code":"ENDPOINT_NOT_FOUND","statusCode":404,"meta":{"description":"API endpoint does not exist","data":{"endpoint":"The missing endpoint"}},"data":{"endpoint":"/api/autocomplete/tag?term=Imported"}}

2022-04-21T15:03:48.932Z error server {"code":"ENDPOINT_NOT_FOUND","statusCode":404,"meta":{"description":"API endpoint does not exist","data":{"endpoint":"The missing endpoint"}},"data":{"endpoint":"/api/content/tag"}}

Steps to reproduce:

1. Export a course. Navigate to "Dashboard", then select "Import source".
2. Upload the exported course zip folder. In "Tags" select or create a tag.
3. Select "Import source". Find the imported course. Notice that the tag is not attached to the imported course.
4. In the logs, notice the 2 errors.

Content summary shows 0 for all items on course import

What happened?

When importing a course a summary pops up to show what's being imported, this currently shows 0 for all items being imported (course, article, block etc).

Expected behaviour

No response

Steps to reproduce

Import a course, view summary.

Authoring tool version

Latest

Framework version

No response

What browsers are you seeing the problem on?

No response

Relevant log output

No response

Switch to CLI for package load/metadata

Feature description

We currently load this ourselves, but should switch to the CLI's API.

Can you work on this feature?

• I can contribute

How do we deal with failed imports that have overwritten installed plugins?

Multilingual support

Feature description

Allow courses to be edited, imported and exported in multiple languages.

Can you work on this feature?

• I can contribute

Course import failing when plugin already present

What happened?

When importing a course if any of the plugins being imported are already in the tool the import fails with the below error visible in the tool:

And the below errors in the console:

2024-01-09T12:31:51.080Z error adaptframework PLUGIN_IMPORT_FAILED C:\Working-AuthoringTool\240104\adapt-authoring\APP_DATA\temp\file-uploads\f3fa00c24854b0bd1cd945313_unzip\src\menu\adapt-contrib-boxMenu AdaptError: CONTENTPLUGIN_INSTALL_FAILED
at Object.get [as CONTENTPLUGIN_INSTALL_FAILED] (file:///C:/Working-AuthoringTool/240104/adapt-authoring/node_modules/adapt-authoring-errors/lib/ErrorsModule.js:50:20)
at ContentPluginModule.installPlugins (file:///C:/Working-AuthoringTool/240104/adapt-authoring/node_modules/adapt-authoring-contentplugin/lib/ContentPluginModule.js:246:29)
at process.processTicksAndRejections (node:internal/process/task_queues:95:5)
at async file:///C:/Working-AuthoringTool/240104/adapt-authoring/node_modules/adapt-authoring-adaptframework/lib/AdaptFrameworkImport.js:463:34
at async Promise.all (index 0)
at async AdaptFrameworkImport.importCoursePlugins (file:///C:/Working-AuthoringTool/240104/adapt-authoring/node_modules/adapt-authoring-adaptframework/lib/AdaptFrameworkImport.js:453:7)
at async AdaptFrameworkImport.import (file:///C:/Working-AuthoringTool/240104/adapt-authoring/node_modules/adapt-authoring-adaptframework/lib/AdaptFrameworkImport.js:221:9)
at async importHandler (file:///C:/Working-AuthoringTool/240104/adapt-authoring/node_modules/adapt-authoring-adaptframework/lib/AdaptFrameworkUtils.js:219:24) {
code: 'CONTENTPLUGIN_INSTALL_FAILED',
statusCode: 500,
meta: {
description: 'Installation of plugins failed',
data: { errors: 'List of errors' }
},
data: { errors: [ [AdaptError] ] }
}

Expected behaviour

No response

Steps to reproduce

Import any course with a plugin already loaded into the tool

Authoring tool version

latest master

Framework version

5.33.13

What browsers are you seeing the problem on?

Firefox

Relevant log output

No response

Error codes should be consistent

Some error codes are prefixed with FW, while others aren't, so we need to choose one or the other for consistency (think we should probably go with prefixing all with FW)

Import erroring

What happened?

Attempt to import a v5.28.1 framework course

Zip contains grunt, src/core, src/course, and standard top level files (exact zip can be provided if necessary).

Tool states course can be imported, but on attempt to do so the following error appears:

Import of framework content failed, 
graphic-component c-25 /_graphic must have required property 'large', 
/_graphic must have required property 'small', ; blank-component c-60 
must have required property '_component', ; graphic-component c-62 
/_graphic must have required property 'large', /_graphic must have 
required property 'small', ; graphic-component c-72 /_graphic must have 
required property 'large', /_graphic must have required property 
'small', ; blank-component c-90 must have required property 
'_component', ; graphic-component c-95 /_graphic must have required 
property 'large', /_graphic must have required property 'small', ; 
blank-component c-100 must have required property '_component', ; 
graphic-component c-105 /_graphic must have required property 'large', 
/_graphic must have required property 'small', ; blank-component c-110 
must have required property '_component', ; graphic-component c-115 
/_graphic must have required property 'large', /_graphic must have 
required property 'small', ; blank-component c-120 must have required 
property '_component', ; graphic-component c-125 /_graphic must have 
required property 'large', /_graphic must have required property 
'small', ; blank-component c-130 must have required property 
'_component', ; graphic-component c-135 /_graphic must have required 
property 'large', /_graphic must have required property 'small', ; 
blank-component c-140 must have required property '_component', ; 
graphic-component c-145 /_graphic must have required property 'large', 
/_graphic must have required property 'small'

Expected behaviour

No response

Steps to reproduce

See above

Authoring tool version

master (12/05/2023)

Framework version

No response

What browsers are you seeing the problem on?

No response

Relevant log output

No response

Import source: plugin versions reported incorrectly

What happened?

The version installed is 5.31.11 (i.e. APP_DATA/temp/adapt_framework). The version I am importing is 5.31.12. However the tool seems to report the values reversed:

Authoring tool version

master

Should look into moving user share functionality into separate module

So can be removed for the security conscious (as it requires access to the list of user records), and also in the fairly likely case that we want to change the feature later.

Would require amending the course.schema.json file

Import should move plugin src to the framework directory

Although the src is correctly moved to the temp framework dir, the original temp upload dir is referenced in adapt.json.

Need to look into what issues this is likely to cause, and what the correct value should be.

Server should be able to start without a network connection

App currently hangs and never finishes booting (have a suspicion it's the contentplugin mod/CLI). Think this would be useful at least for dev/debug purposes.

Issue applies to both plugin install & schema retrieval.

Preview link can be accessed without authentication

By a chance, I opened the link of a course preview on incognito tab and noticed that it can be accessible without logging into authoring tool.

I am not sure if it is a new feature...