Fix: Added logging switch and do not applyLocks on completion reset w…

…hen not reset (fixes adaptlearning#174) (adaptlearning#175)

Fix: Added logging switch and do not applyLocks on completion reset when not reset (fixes adaptlearning#174) (adaptlearning#175)

example.json

@@ -44,5 +44,6 @@
     // trickle button should be displayed
     // Put in config.json
     "_trickle": {
+        "_logState": false,
         "_completionAttribute": "_isInteractionComplete|_isComplete", //(default=_isComplete)
     }

js/TrickleButtonModel.js

@@ -145,6 +145,7 @@ export default class TrickleButtonModel extends ComponentModel {
    */
   checkIfResetOnRevisit() {
     if (this.isFinished() && !this.isStepLockedOnRevisit()) return;
+    if (!this.get('_isComplete') && !this.get('_isInteractionComplete')) return;
     this.set({
       _isComplete: false,
       _isInteractionComplete: false

js/controller.js

@@ -25,7 +25,7 @@ class TrickleController extends Backbone.Controller {
     });
   }
 
-   async onDataReady() {
+  async onDataReady() {
     const trickleConfig = Adapt.config.get('_trickle');
     if (trickleConfig?._isEnabled === false) return;
 

js/models.js

@@ -209,8 +209,9 @@ export function applyLocks() {
     subsequentLockingModels.forEach((model, index) => {
       const id = model.get('_id');
       const isButtonModel = (model instanceof TrickleButtonModel);
+      const isTrickled = model.get('_isTrickled');
       // Do not stop at TrickleButtonModels
-      model.set('_isTrickled', !isButtonModel);
+      if (isTrickled !== isButtonModel) model.set('_isTrickled', !isButtonModel);
       // Store the new locking state of each model in the locks variable
       // Don't unlock anything that was locked in a previous group
       modelsById[id] = model;

properties.schema

@@ -35,6 +35,15 @@
                   "validators": [],
                   "help": "Controls whether the Trickle extension is enabled or disabled."
                 },
+                "_logState": {
+                  "type": "boolean",
+                  "required": true,
+                  "default": false,
+                  "title": "Log state",
+                  "inputType": "Checkbox",
+                  "validators": [],
+                  "help": "Controls whether the Trickle extension logs its state to the browser console."
+                },
                 "_completionAttribute": {
                   "type": "string",
                   "required": false,

schema/config.schema.json

@@ -13,6 +13,12 @@
           "title": "Trickle",
           "default": {},
           "properties": {
+            "_logState": {
+              "type": "boolean",
+              "title": "Log state",
+              "default": false,
+              "description": "Controls whether the Trickle extension logs its state to the browser console."
+            },
             "_completionAttribute": {
               "type": "string",
               "title": "Completion attribute",