Clone UndoRedoService for questions.

oppia · aks681 · Dec 10, 2018 · Aug 30, 2018 · Aug 30, 2018 · Aug 30, 2018
commit 8a2c2bd030dc1883f2d39436e3c317b886e580b4
diff --git a/core/templates/dev/head/domain/editor/undo_redo/UndoRedoService.js b/core/templates/dev/head/domain/editor/undo_redo/UndoRedoService.js
@@ -146,3 +146,125 @@ oppia.factory('UndoRedoService', [
     return UndoRedoService;
   }
 ]);
+
+oppia.factory('QuestionUndoRedoService', [
+  '$rootScope', 'EVENT_UNDO_REDO_SERVICE_CHANGE_APPLIED',
+  function($rootScope, EVENT_UNDO_REDO_SERVICE_CHANGE_APPLIED) {
+    var QuestionUndoRedoService = {};
+
+    var _appliedChanges = [];
+    var _undoneChanges = [];
+
+    var _dispatchMutation = function() {
+      $rootScope.$broadcast(EVENT_UNDO_REDO_SERVICE_CHANGE_APPLIED);
+    };
+    var _applyChange = function(changeObject, domainObject) {
+      changeObject.applyChange(domainObject);
+      _dispatchMutation();
+    };
+    var _reverseChange = function(changeObject, domainObject) {
+      changeObject.reverseChange(domainObject);
+      _dispatchMutation();
+    };
+
+    /**
+     * Pushes a change domain object onto the change stack and applies it to the
+     * provided domain object. When a new change is applied, all undone changes
+     * are lost and cannot be redone. This will fire an event as defined by the
+     * constant EVENT_UNDO_REDO_SERVICE_CHANGE_APPLIED.
+     */
+    QuestionUndoRedoService.applyChange = function(changeObject, domainObject) {
+      _applyChange(changeObject, domainObject);
+      _appliedChanges.push(changeObject);
+      _undoneChanges = [];
+    };
+
+    /**
+     * Undoes the last change to the provided domain object. This function
+     * returns false if there are no changes to undo, and true otherwise. This
+     * will fire an event as defined by the constant
+     * EVENT_UNDO_REDO_SERVICE_CHANGE_APPLIED.
+     */
+    QuestionUndoRedoService.undoChange = function(domainObject) {
+      if (_appliedChanges.length !== 0) {
+        var change = _appliedChanges.pop();
+        _undoneChanges.push(change);
+        _reverseChange(change, domainObject);
+        return true;
+      }
+      return false;
+    };
+
+    /**
+     * Reverses an undo for the given domain object. This function returns false
+     * if there are no changes to redo, and true if otherwise. This will fire an
+     * event as defined by the constant EVENT_UNDO_REDO_SERVICE_CHANGE_APPLIED.
+     */
+    QuestionUndoRedoService.redoChange = function(domainObject) {
+      if (_undoneChanges.length !== 0) {
+        var change = _undoneChanges.pop();
+        _appliedChanges.push(change);
+        _applyChange(change, domainObject);
+        return true;
+      }
+      return false;
+    };
+
+    /**
+     * Returns the current list of changes applied to the provided domain
+     * object. This list will not contain undone actions. Changes to the
+     * returned list will not be reflected in this service.
+     */
+    QuestionUndoRedoService.getChangeList = function() {
+      // TODO(bhenning): Consider integrating something like Immutable.js to
+      // avoid the slice here and ensure the returned object is truly an
+      // immutable copy.
+      return _appliedChanges.slice();
+    };
+
+    /**
+     * Returns a list of commit dict updates representing all chosen changes in
+     * this service. Changes to the returned list will not affect this service.
+     * Furthermore, the returned list is ready to be sent to the backend.
+     */
+    QuestionUndoRedoService.getCommittableChangeList = function() {
+      var committableChangeList = [];
+      for (var i = 0; i < _appliedChanges.length; i++) {
+        committableChangeList[i] = _appliedChanges[i].getBackendChangeObject();
+      }
+      return committableChangeList;
+    };
+
+    QuestionUndoRedoService.setChangeList = function(changeList) {
+      _appliedChanges = angular.copy(changeList);
+    };
+
+    /**
+     * Returns the number of changes that have been applied to the domain
+     * object.
+     */
+    QuestionUndoRedoService.getChangeCount = function() {
+      return _appliedChanges.length;
+    };
+
+    /**
+     * Returns whether this service has any applied changes.
+     */
+    QuestionUndoRedoService.hasChanges = function() {
+      return _appliedChanges.length !== 0;
+    };
+
+    /**
+     * Clears the change history. This does not reverse any of the changes
+     * applied from applyChange() or redoChange(). This will fire an event as
+     * defined by the constant EVENT_UNDO_REDO_SERVICE_CHANGE_APPLIED.
+     */
+    QuestionUndoRedoService.clearChanges = function() {
+      _appliedChanges = [];
+      _undoneChanges = [];
+      _dispatchMutation();
+    };
+
+    return QuestionUndoRedoService;
+  }
+]);
diff --git a/core/templates/dev/head/domain/question/QuestionUpdateService.js b/core/templates/dev/head/domain/question/QuestionUpdateService.js
@@ -24,22 +24,24 @@ oppia.constant('CMD_UPDATE_QUESTION_PROPERTY', 'update_question_property');
 oppia.factory('QuestionUpdateService', [
   'QuestionObjectFactory',
   'ChangeObjectFactory',
-  'UndoRedoService',
+  'QuestionUndoRedoService',
   'QUESTION_PROPERTY_LANGUAGE_CODE',
   'QUESTION_PROPERTY_QUESTION_STATE_DATA',
   'CMD_UPDATE_QUESTION_PROPERTY',
   function(
       QuestionObjectFactory,
       ChangeObjectFactory,
-      UndoRedoService,
+      QuestionUndoRedoService,
       QUESTION_PROPERTY_LANGUAGE_CODE,
       QUESTION_PROPERTY_QUESTION_STATE_DATA,
       CMD_UPDATE_QUESTION_PROPERTY) {
+    var _changeCount = 0;
+
     var _applyChange = function(question, command, params, apply, reverse) {
       var changeDict = angular.copy(params);
       changeDict.cmd = command;
       var changeObj = ChangeObjectFactory.create(changeDict, apply, reverse);
-      UndoRedoService.applyChange(changeObj, question);
+      QuestionUndoRedoService.applyChange(changeObj, question);
     };
 
     var _applyPropertyChange = function(
@@ -81,6 +83,12 @@ oppia.factory('QuestionUpdateService', [
           }, function(changeDict, question) {
             question.setStateData(oldStateData);
           });
+      },
+      getChangeCount: function() {
+        return this._changeCount;
+      },
+      resetChangeCount: function() {
+        _changeCount = 0;
       }
     };
   }

diff --git a/core/templates/dev/head/pages/question_editor/QuestionEditorDirective.js b/core/templates/dev/head/pages/question_editor/QuestionEditorDirective.js
@@ -86,9 +86,7 @@ oppia.directive('questionEditor', [
             var stateData = $scope.question.getStateData();
             stateData.interaction.defaultOutcome.setDestination(null);
             if (stateData) {
-              angular.element(document).ready(function() {
-                $rootScope.$broadcast('stateEditorInitialized', stateData);
-              });
+              $rootScope.$broadcast('stateEditorInitialized', stateData);
 
               if (stateData.content.getHtml() || stateData.interaction.id) {
                 $scope.interactionIsShown = true;

diff --git a/core/templates/dev/head/pages/state_editor/StateEditorDirective.js b/core/templates/dev/head/pages/state_editor/StateEditorDirective.js
@@ -64,7 +64,6 @@ oppia.directive('stateEditor', [
           };
 
           $scope.reinitializeEditor = function() {
-            console.log($scope.stateData);
             $rootScope.$broadcast('stateEditorInitialized', $scope.stateData);
           };
 

diff --git a/core/templates/dev/head/pages/state_editor/StateInteractionEditorDirective.js b/core/templates/dev/head/pages/state_editor/StateInteractionEditorDirective.js
@@ -100,12 +100,56 @@ oppia.directive('stateInteractionEditor', [
               interactionCustomizationArgs, false);
           };
 
-          console.log("set listener stateEditorInitialized");
+          var _updateInteractionPreviewAndAnswerChoices = function() {
+            $scope.interactionId = StateInteractionIdService.savedMemento;
+
+            var currentCustomizationArgs =
+              StateCustomizationArgsService.savedMemento;
+            $scope.interactionPreviewHtml = _getInteractionPreviewTag(
+              currentCustomizationArgs);
+
+            // Special cases for multiple choice input and image click input.
+            if ($scope.interactionId === 'MultipleChoiceInput') {
+              $rootScope.$broadcast(
+                'updateAnswerChoices',
+                currentCustomizationArgs.choices.value.map(function(val, ind) {
+                  return {
+                    val: ind,
+                    label: val
+                  };
+                })
+              );
+            } else if ($scope.interactionId === 'ImageClickInput') {
+              var _answerChoices = [];
+              var imageWithRegions =
+                currentCustomizationArgs.imageAndRegions.value;
+              for (var j = 0; j < imageWithRegions.labeledRegions.length; j++) {
+                _answerChoices.push({
+                  val: imageWithRegions.labeledRegions[j].label,
+                  label: imageWithRegions.labeledRegions[j].label
+                });
+              }
+
+              $rootScope.$broadcast('updateAnswerChoices', _answerChoices);
+            } else if ($scope.interactionId === 'ItemSelectionInput' ||
+                $scope.interactionId === 'DragAndDropSortInput') {
+              $rootScope.$broadcast(
+                'updateAnswerChoices',
+                currentCustomizationArgs.choices.value.map(function(val) {
+                  return {
+                    val: val,
+                    label: val
+                  };
+                })
+              );
+            } else {
+              $rootScope.$broadcast('updateAnswerChoices', null);
+            }
+          };
+
           $scope.$on('stateEditorInitialized', function(evt, stateData) {
-            console.log("receive stateEditorInitialized");
             $scope.hasLoaded = false;
             InteractionDetailsCacheService.reset();
-            console.log("broadcast initializeAnswerGroups");
             $rootScope.$broadcast('initializeAnswerGroups', {
               interactionId: stateData.interaction.id,
               answerGroups: stateData.interaction.answerGroups,
@@ -415,53 +459,6 @@ oppia.directive('stateInteractionEditor', [
               _updateInteractionPreviewAndAnswerChoices();
             });
           };
-
-          var _updateInteractionPreviewAndAnswerChoices = function() {
-            $scope.interactionId = StateInteractionIdService.savedMemento;
-
-            var currentCustomizationArgs =
-              StateCustomizationArgsService.savedMemento;
-            $scope.interactionPreviewHtml = _getInteractionPreviewTag(
-              currentCustomizationArgs);
-
-            // Special cases for multiple choice input and image click input.
-            if ($scope.interactionId === 'MultipleChoiceInput') {
-              $rootScope.$broadcast(
-                'updateAnswerChoices',
-                currentCustomizationArgs.choices.value.map(function(val, ind) {
-                  return {
-                    val: ind,
-                    label: val
-                  };
-                })
-              );
-            } else if ($scope.interactionId === 'ImageClickInput') {
-              var _answerChoices = [];
-              var imageWithRegions =
-                currentCustomizationArgs.imageAndRegions.value;
-              for (var j = 0; j < imageWithRegions.labeledRegions.length; j++) {
-                _answerChoices.push({
-                  val: imageWithRegions.labeledRegions[j].label,
-                  label: imageWithRegions.labeledRegions[j].label
-                });
-              }
-
-              $rootScope.$broadcast('updateAnswerChoices', _answerChoices);
-            } else if ($scope.interactionId === 'ItemSelectionInput' ||
-                $scope.interactionId === 'DragAndDropSortInput') {
-              $rootScope.$broadcast(
-                'updateAnswerChoices',
-                currentCustomizationArgs.choices.value.map(function(val) {
-                  return {
-                    val: val,
-                    label: val
-                  };
-                })
-              );
-            } else {
-              $rootScope.$broadcast('updateAnswerChoices', null);
-            }
-          };
         }
       ]
     };

diff --git a/core/templates/dev/head/pages/state_editor/StateResponsesDirective.js b/core/templates/dev/head/pages/state_editor/StateResponsesDirective.js
@@ -204,9 +204,7 @@ oppia.directive('stateResponses', [
             }
           };
 
-          console.log("set listener initializeAnswerGroups");
           $scope.$on('initializeAnswerGroups', function(evt, data) {
-            console.log('receive initializeAnswerGroups');
             ResponsesService.init(data);
             $scope.answerGroups = ResponsesService.getAnswerGroups();
             $scope.defaultOutcome = ResponsesService.getDefaultOutcome();

diff --git a/core/templates/dev/head/pages/topic_editor/questions/QuestionsTabDirective.js b/core/templates/dev/head/pages/topic_editor/questions/QuestionsTabDirective.js
@@ -30,15 +30,17 @@ oppia.directive('questionsTab', [
         'MisconceptionObjectFactory', 'QuestionObjectFactory',
         'QuestionSuggestionObjectFactory', 'SuggestionThreadObjectFactory',
         'EVENT_QUESTION_SUMMARIES_INITIALIZED',
-        'UndoRedoService', 'UrlService', function(
+        'QuestionUndoRedoService', 'UrlService',
+        'UndoRedoService', function(
             $scope, $http, $q, $uibModal, $window, AlertsService,
             TopicEditorStateService, QuestionCreationService,
             EditableQuestionBackendApiService, EditableSkillBackendApiService,
             MisconceptionObjectFactory, QuestionObjectFactory,
             QuestionSuggestionObjectFactory, SuggestionThreadObjectFactory,
             EVENT_QUESTION_SUMMARIES_INITIALIZED,
-            UndoRedoService, UrlService) {
-          $scope.UndoRedoService = UndoRedoService;
+            QuestionUndoRedoService, UrlService,
+            UndoRedoService) {
+          $scope.QuestionUndoRedoService = QuestionUndoRedoService;
           var _initTab = function() {
             $scope.questionEditorIsShown = false;
             $scope.question = null;
@@ -77,13 +79,13 @@ oppia.directive('questionsTab', [
                 $scope.questionIsBeingSaved = false;
               });
             } else {
-              if (UndoRedoService.hasChanges()) {
-                console.log(UndoRedoService.getCommittableChangeList());
+              if (QuestionUndoRedoService.hasChanges()) {
                 $scope.questionIsBeingSaved = true;
+                // TODO(tjiang11): Allow user to specify a commit message.
                 EditableQuestionBackendApiService.updateQuestion(
-                  $scope.questionId, $scope.question.getVersion(), 'test',
-                  UndoRedoService.getCommittableChangeList()).then(function() {
-                    UndoRedoService.clearChanges();
+                  $scope.questionId, $scope.question.getVersion(), 'blank',
+                  QuestionUndoRedoService.getCommittableChangeList()).then(function() {
+                    QuestionUndoRedoService.clearChanges();
                     $scope.questionIsBeingSaved = false;
                   }, function(error) {
                     AlertsService.addWarning(
-Original file line number
+Diff line change
@@ Expand Up / @@ -64,7 +64,6 @@ oppia.directive('stateEditor', [ @@
               };
               $scope.reinitializeEditor = function() {
-                console.log($scope.stateData);
                 $rootScope.$broadcast('stateEditorInitialized', $scope.stateData);
               };
@@ Expand Down @@