Fix: postRender automatically setting blank component as completed

[cahirodoherty-learningpool]

Fixes #45

Fix

• postRender automatically setting blank component as completed on page view

Testing

1. Create a course with blank components and page level progress
2. PLP should fill immediately on page load
3. Clicking PLP will show blank components individually have completed

[paulstevendev]

Our requirements are that the blank component behaves according to the "Is this optional" setting. We use this component to determine if a user has viewed a page by placing a blank component at the top of each page with all other components set to optional. Therefore if you place a blank component at the top of the page and set it to NOT optional I would expect the menu of the course not to detect the page as complete until the user opens the page. This is how it currently works with the open source blank component but the Learning Pool one appears to act as optional despite the setting that has been set for "Is this optional"

[paulstevendev]

Here are some grabs showing a course with a single page that contains a blank component that is NOT optional. I have turned off the blank component appearing in the page level progress on the page.
You will see when I launch the course, the page is marked as incomplete.
Opening the page then returning to the menu you will see it is now complete.

I can see when I look in the console that the course lesson status changes to "completed" when I open the page

SCORM.data.set('cmi.core.lesson_status') value: completed
SCORM_API_wrapper.js:914 SCORM.data.set('cmi.suspend_data') value: {"a11y":false,"lang":"en","c":"hIA","q":"gw4XEDAcAbhgAA"}
adapt.min.js:1 INFO: course._isComplete: true, course._isAssessmentPassed: false, block completion: -0
SCORM_API_wrapper.js:914 SCORM.data.set('cmi.suspend_data') value: {"a11y":false,"lang":"en","c":"hIA","q":"gw4XEDAcAbhgAA"}
adapt.min.js:1 INFO: course._isComplete: true, course._isAssessmentPassed: false, block completion: -0

[oliverfoster]

Would you get the same outcome by adding _isOptional: true default to the schema?
https://github.com/adaptlearning/adapt-contrib-blank/blob/master/example.json#L7
https://github.com/adaptlearning/adapt-contrib-blank/blob/master/properties.schema

That would retain the inviewability of the blank completion.

[cahirodoherty-learningpool]

Yes this is part of the difference that you are seeing @paulstevendev. The LearningPool AT will override these components and set them as optional always. We want to remove this when the new component functionality is added.
The changes to the blank component would effectively make page completion occur upon opening when a blank component is on that page and is the only non-optional component. Does that make sense?

[paulstevendev]

@cahirodoherty-learningpool - the suggestion @oliverfoster has made sounds like a good compromise. If you did have a page where all the non blank components are set to optional then adding any blank components with a default setting of optional would result in page completion occur upon opening the course. However forcing the blank component to always act as optional is not an ideal solution for us so hopefully you can go with the suggestion by @oliverfoster

[cahirodoherty-learningpool]

Yeah that works for us. I've just pushed another commit

[paulstevendev]

Thanks Cahir - so just to clarify, we will still be able to set the blank component as not-optional and it will respect that? Hence if we set the blank component to not-optional, a page that contains this blank component will need to be opened before the page completes?

[chris-steele]

This makes eminent sense

[oliverfoster]

Taking @paulstevendev as implicit +1

[github-actions]

🎉 This PR is included in version 4.1.3 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

[paulstevendev]

It doesn't appear that there are any properties appearing in the AT now for the blank component so it is impossible to set this to NOT optional.

Testing:
info [24 Jan 23 09:56:13 +00:00] Adapt authoring tool 0.11.1.
info [24 Jan 23 09:56:13 +00:00] Adapt framework 5.24.8.

Blank component: 4.1.4

[cahirodoherty-learningpool]

It doesn't appear that there are any properties appearing in the AT now for the blank component so it is impossible to set this to NOT optional.

Testing: info [24 Jan 23 09:56:13 +00:00] Adapt authoring tool 0.11.1. info [24 Jan 23 09:56:13 +00:00] Adapt framework 5.24.8.

Blank component: 4.1.4

Issue to resolve this raised here: #51