issue/2758 Added deepClone API (v5.7.0)

src/core/js/data.js

@@ -18,13 +18,31 @@ define([
       return new ModelClass(json);
     }
 
+    initialize() {
+      super.initialize();
+      this.on({
+        'add': this.onAdded,
+        'remove': this.onRemoved
+      });
+    }
+
     async init () {
+      this.reset();
+      this._byAdaptID = {};
       Adapt.build = new BuildModel(null, { url: 'adapt/js/build.min.js', reset: true });
       await Adapt.build.whenReady();
       $('html').attr('data-adapt-framework-version', Adapt.build.get('package').version);
       this.loadConfigData();
     }
 
+    onAdded(model) {
+      this._byAdaptID[model.get('_id')] = model;
+    }
+
+    onRemoved(model) {
+      delete this._byAdaptID[model.get('_id')];
+    }
+
     loadConfigData() {
       Adapt.config = new ConfigModel(null, { url: 'course/config.' + Adapt.build.get('jsonext'), reset: true });
       this.listenToOnce(Adapt, 'configModel:loadCourseData', this.onLoadCourseData);
@@ -122,8 +140,6 @@ define([
         }
         this.push(modelData);
       });
-      // index by id
-      this._byAdaptID = this.indexBy('_id');
       this.trigger('reset');
       this.trigger('loaded');
       await Adapt.wait.queue();
@@ -132,7 +148,9 @@ define([
     async triggerDataLoaded() {
       Adapt.log.debug('Firing app:dataLoaded');
       try {
-        Adapt.trigger('app:dataLoaded');// Triggered to setup model connections in AdaptModel.js
+        // Setup the newly added models
+        this.forEach(model => model.setupModel && model.setupModel());
+        Adapt.trigger('app:dataLoaded');
       } catch (e) {
         Adapt.log.error('Error during app:dataLoading trigger', e);
       }

src/core/js/models/adaptModel.js

@@ -43,11 +43,6 @@ define([
       ];
     }
 
-    initialize() {
-      // Wait until data is loaded before setting up model
-      this.listenToOnce(Adapt, 'app:dataLoaded', this.setupModel);
-    }
-
     setupModel() {
       if (this.hasManagedChildren) {
         this.setupChildListeners();
@@ -695,6 +690,55 @@ define([
       this.checkLocking();
     }
 
+    /**
+     * Clones this model and all managed children returning a new branch.
+     * Assign new unique ids to each cloned model.
+     * Adds clone to Adapt.data and to their _parentId child lists.
+     * @param {Object} [set] Attributes to be set on the root clone
+     * @param {Object} [setOnChildren] Attributes to be set on the children clones.
+     * @param {Function} [modifier] A callback function for each child to allow further modifications
+     * @returns {AdaptModel}
+     */
+    deepClone(set = {}, setOnChildren = {}, modifier = null) {
+      // Shallow clone the JSON and set overrides
+      const json = Object.assign({}, this.toJSON(), set);
+      // Fetch the class
+      const ModelClass = this.constructor;
+      const hasId = Boolean(json._id);
+      if (hasId) {
+        // Create a unique id if needed
+        const cid = _.uniqueId(ModelClass.prototype.cidPrefix || 'c');
+        json._id = `${cid}_${json._id}`;
+      }
+      // Clone the model
+      const clonedModel = new ModelClass(json);
+      // Add cloned model to Adapt.data for Adapt.findById resolution
+      hasId && Adapt.data.add(clonedModel);
+      // Clone any children
+      this.hasManagedChildren && this.getChildren().each(child => {
+        if (!child.deepClone) {
+          throw new Error('Cannot deepClone child.');
+        }
+        let set = setOnChildren;
+        if (hasId) {
+          // Pass through the new cloned parent id
+          set = Object.assign({}, setOnChildren, {
+            _parentId: json._id
+          });
+        }
+        return child.deepClone(set, setOnChildren, modifier);
+      });
+      if (hasId) {
+        // Add cloned model to its parent for findDescendants resolution
+        const parentModel = clonedModel.getParent();
+        parentModel && parentModel.getChildren().add(clonedModel);
+      }
+      // Setup the model after all the children have been added
+      modifier && modifier(this, clonedModel);
+      clonedModel.setupModel();
+      return clonedModel;
+    }
+
     /**
      * Internal event handler for all module events. Triggers event bubbling
      * through the module hierarchy when the event is included in

src/core/js/models/itemsQuestionModel.js

@@ -7,13 +7,13 @@ define([
   class BlendedItemsComponentQuestionModel extends QuestionModel {
 
     init() {
-      super.init();
       ItemsComponentModel.prototype.init.call(this);
+      super.init();
     }
 
     reset(type, force) {
-      super.reset(type, force);
       ItemsComponentModel.prototype.reset.call(this, type, force);
+      super.reset(type, force);
     }
 
   }

src/core/js/models/questionModel.js

@@ -45,7 +45,11 @@ define([
 
     init() {
       this.setupDefaultSettings();
-      this.listenToOnce(Adapt, 'adapt:initialize', this.onAdaptInitialize);
+      if (Adapt.get('_isStarted')) {
+        this.onAdaptInitialize();
+      } else {
+        this.listenToOnce(Adapt, 'adapt:initialize', this.onAdaptInitialize);
+      }
     }
 
     // Calls default methods to setup on questions