Fix part of #10083: Removes events 'topicsAndSkillsDashboardReinitial…

…ized' and 'undoRedoChangeApplied' (#10342)

* Initial commit

* Debugging done

* Mid 2

* Consolidated logs

* Removed redundant events

* Finish undoredochangeapplied

* Consolidated testing logs

* Debugging

* Rollback undoredo

* rollback pt 2

* Removed logs

* Mid test debugging

* Prem fixed tests

* Fixed tests with 100% coverage

* Minor fixes

* Initial commit

* Finally debugged

* Full coverage achieved

* Removed editor page constants

* Minor fixes

* Debugged

* Nit

core/templates/components/entity-creation-services/skill-creation.service.ts

@@ -18,6 +18,8 @@
 
 require('domain/utilities/url-interpolation.service.ts');
 require('domain/skill/skill-creation-backend-api.service.ts');
+require('domain/topics_and_skills_dashboard/' +
+  'topics-and-skills-dashboard-backend-api.service.ts');
 require('services/alerts.service.ts');
 require('services/image-local-storage.service.ts');
 
@@ -29,14 +31,14 @@ require(
   'pages/topics-and-skills-dashboard-page/' +
   'create-new-skill-modal.controller.ts');
 angular.module('oppia').factory('SkillCreationService', [
-  '$rootScope', '$timeout', '$uibModal', '$window', 'AlertsService',
+  '$timeout', '$uibModal', '$window', 'AlertsService',
   'ImageLocalStorageService', 'SkillCreationBackendApiService',
-  'UrlInterpolationService', 'EVENT_TOPICS_AND_SKILLS_DASHBOARD_REINITIALIZED',
+  'TopicsAndSkillsDashboardBackendApiService', 'UrlInterpolationService',
   'SKILL_DESCRIPTION_STATUS_VALUES',
   function(
-      $rootScope, $timeout, $uibModal, $window, AlertsService,
+      $timeout, $uibModal, $window, AlertsService,
       ImageLocalStorageService, SkillCreationBackendApiService,
-      UrlInterpolationService, EVENT_TOPICS_AND_SKILLS_DASHBOARD_REINITIALIZED,
+      TopicsAndSkillsDashboardBackendApiService, UrlInterpolationService,
       SKILL_DESCRIPTION_STATUS_VALUES) {
     var CREATE_NEW_SKILL_URL_TEMPLATE = (
       '/skill_editor/<skill_id>');
@@ -94,8 +96,8 @@ angular.module('oppia').factory('SkillCreationService', [
             result.description, rubrics, result.explanation,
             topicIds || [], imagesData).then(function(response) {
             $timeout(function() {
-              $rootScope.$broadcast(
-                EVENT_TOPICS_AND_SKILLS_DASHBOARD_REINITIALIZED, true);
+              TopicsAndSkillsDashboardBackendApiService.
+                onTopicsAndSkillsDashboardReinitialized.emit(true);
               skillCreationInProgress = false;
               ImageLocalStorageService.flushStoredImagesData();
               newTab.location.href = UrlInterpolationService.interpolateUrl(

core/templates/components/entity-creation-services/topic-creation.service.ts

@@ -26,6 +26,8 @@ require('domain/topics_and_skills_dashboard/' +
 require('domain/utilities/url-interpolation.service.ts');
 require('domain/topic/topic-creation-backend-api.service.ts');
 require('pages/topic-editor-page/services/topic-editor-state.service.ts');
+require('domain/topics_and_skills_dashboard/' +
+  'topics-and-skills-dashboard-backend-api.service.ts');
 require(
   'pages/topics-and-skills-dashboard-page/' +
     'create-new-topic-modal.controller.ts');
@@ -35,15 +37,13 @@ require('services/image-local-storage.service.ts');
 require('services/image-upload-helper.service.ts');
 
 angular.module('oppia').factory('TopicCreationService', [
-  '$rootScope', '$uibModal', '$window', 'AlertsService', 'ContextService',
+  '$uibModal', '$window', 'AlertsService', 'ContextService',
   'ImageLocalStorageService', 'TopicCreationBackendApiService',
-  'UrlInterpolationService',
-  'EVENT_TOPICS_AND_SKILLS_DASHBOARD_REINITIALIZED',
+  'TopicsAndSkillsDashboardBackendApiService', 'UrlInterpolationService',
   function(
-      $rootScope, $uibModal, $window, AlertsService, ContextService,
+      $uibModal, $window, AlertsService, ContextService,
       ImageLocalStorageService, TopicCreationBackendApiService,
-      UrlInterpolationService,
-      EVENT_TOPICS_AND_SKILLS_DASHBOARD_REINITIALIZED) {
+      TopicsAndSkillsDashboardBackendApiService, UrlInterpolationService) {
     var TOPIC_EDITOR_URL_TEMPLATE = '/topic_editor/<topic_id>';
     var topicCreationInProgress = false;
 
@@ -78,8 +78,8 @@ angular.module('oppia').factory('TopicCreationService', [
           TopicCreationBackendApiService.createTopic(
             newlyCreatedTopic, imagesData, bgColor).then(
             function(response) {
-              $rootScope.$broadcast(
-                EVENT_TOPICS_AND_SKILLS_DASHBOARD_REINITIALIZED);
+              TopicsAndSkillsDashboardBackendApiService.
+                onTopicsAndSkillsDashboardReinitialized.emit();
               topicCreationInProgress = false;
               ImageLocalStorageService.flushStoredImagesData();
               ContextService.resetImageSaveDestination();

core/templates/domain/editor/undo_redo/base-undo-redo.service.ts

@@ -17,39 +17,40 @@
  * Changes may be undone, redone, or replaced.
  */
 
-require('domain/editor/editor-domain.constants.ajs.ts');
+import { EventEmitter } from '@angular/core';
 
 /**
  * Stores a stack of changes to a domain object. Please note that only one
  * instance of this service exists at a time, so multiple undo/redo stacks are
  * not currently supported.
  */
 angular.module('oppia').factory('BaseUndoRedoService', [
-  '$rootScope', 'EVENT_UNDO_REDO_SERVICE_CHANGE_APPLIED',
-  function($rootScope, EVENT_UNDO_REDO_SERVICE_CHANGE_APPLIED) {
+  function() {
     var BaseUndoRedoService = {};
 
     this._appliedChanges = [];
     this._undoneChanges = [];
+    var _undoRedoChangeEventEmitter = new EventEmitter();
 
-    var _dispatchMutation = function() {
-      $rootScope.$broadcast(EVENT_UNDO_REDO_SERVICE_CHANGE_APPLIED);
+    var _dispatchMutation = () => {
+      _undoRedoChangeEventEmitter.emit();
     };
-    var _applyChange = function(changeObject, domainObject) {
+    var _applyChange = (changeObject, domainObject) => {
       changeObject.applyChange(domainObject);
       _dispatchMutation();
     };
-    var _reverseChange = function(changeObject, domainObject) {
+    var _reverseChange = (changeObject, domainObject) => {
       changeObject.reverseChange(domainObject);
       _dispatchMutation();
     };
 
     // TODO(ankita240796): Remove the bracket notation once Angular2 gets in.
     /* eslint-disable dot-notation */
     BaseUndoRedoService['init'] = function() {
-    /* eslint-enable dot-notation */
+      /* eslint-enable dot-notation */
       this._appliedChanges = [];
       this._undoneChanges = [];
+      _undoRedoChangeEventEmitter = new EventEmitter();
     };
 
     /**
@@ -76,7 +77,7 @@ angular.module('oppia').factory('BaseUndoRedoService', [
     // TODO(ankita240796): Remove the bracket notation once Angular2 gets in.
     /* eslint-disable dot-notation */
     BaseUndoRedoService['undoChange'] = function(domainObject) {
-    /* eslint-enable dot-notation */
+      /* eslint-enable dot-notation */
       if (this._appliedChanges.length !== 0) {
         var change = this._appliedChanges.pop();
         this._undoneChanges.push(change);
@@ -94,7 +95,7 @@ angular.module('oppia').factory('BaseUndoRedoService', [
     // TODO(ankita240796): Remove the bracket notation once Angular2 gets in.
     /* eslint-disable dot-notation */
     BaseUndoRedoService['redoChange'] = function(domainObject) {
-    /* eslint-enable dot-notation */
+      /* eslint-enable dot-notation */
       if (this._undoneChanges.length !== 0) {
         var change = this._undoneChanges.pop();
         this._appliedChanges.push(change);
@@ -112,7 +113,7 @@ angular.module('oppia').factory('BaseUndoRedoService', [
     // TODO(ankita240796): Remove the bracket notation once Angular2 gets in.
     /* eslint-disable dot-notation */
     BaseUndoRedoService['getChangeList'] = function() {
-    /* eslint-enable dot-notation */
+      /* eslint-enable dot-notation */
       // TODO(bhenning): Consider integrating something like Immutable.js to
       // avoid the slice here and ensure the returned object is truly an
       // immutable copy.
@@ -127,7 +128,7 @@ angular.module('oppia').factory('BaseUndoRedoService', [
     // TODO(ankita240796): Remove the bracket notation once Angular2 gets in.
     /* eslint-disable dot-notation */
     BaseUndoRedoService['getCommittableChangeList'] = function() {
-    /* eslint-enable dot-notation */
+      /* eslint-enable dot-notation */
       var committableChangeList = [];
       for (var i = 0; i < this._appliedChanges.length; i++) {
         committableChangeList[i] =
@@ -139,7 +140,7 @@ angular.module('oppia').factory('BaseUndoRedoService', [
     // TODO(ankita240796): Remove the bracket notation once Angular2 gets in.
     /* eslint-disable dot-notation */
     BaseUndoRedoService['setChangeList'] = function(changeList) {
-    /* eslint-enable dot-notation */
+      /* eslint-enable dot-notation */
       this._appliedChanges = angular.copy(changeList);
     };
 
@@ -150,7 +151,7 @@ angular.module('oppia').factory('BaseUndoRedoService', [
     // TODO(ankita240796): Remove the bracket notation once Angular2 gets in.
     /* eslint-disable dot-notation */
     BaseUndoRedoService['getChangeCount'] = function() {
-    /* eslint-enable dot-notation */
+      /* eslint-enable dot-notation */
       return this._appliedChanges.length;
     };
 
@@ -172,12 +173,19 @@ angular.module('oppia').factory('BaseUndoRedoService', [
     // TODO(ankita240796): Remove the bracket notation once Angular2 gets in.
     /* eslint-disable dot-notation */
     BaseUndoRedoService['clearChanges'] = function() {
-    /* eslint-enable dot-notation */
+      /* eslint-enable dot-notation */
       this._appliedChanges = [];
       this._undoneChanges = [];
+      this._undoRedoChangeAppliedEventEmitter = new EventEmitter();
       _dispatchMutation();
     };
 
+    /* eslint-disable dot-notation */
+    BaseUndoRedoService['onUndoRedoChangeApplied'] = function() {
+      /* eslint-enable dot-notation */
+      return _undoRedoChangeEventEmitter;
+    };
+
     return BaseUndoRedoService;
   }
 ]);

core/templates/domain/topics_and_skills_dashboard/topics-and-skills-dashboard-backend-api.service.ts

@@ -19,7 +19,7 @@
 
 import { downgradeInjectable } from '@angular/upgrade/static';
 import { HttpClient } from '@angular/common/http';
-import { Injectable } from '@angular/core';
+import { EventEmitter, Injectable } from '@angular/core';
 
 import {
   AssignedSkill,
@@ -121,6 +121,9 @@ export class TopicsAndSkillsDashboardBackendApiService {
     private topicSummaryObjectFactory: TopicSummaryObjectFactory,
     private urlInterpolationService: UrlInterpolationService) {}
 
+  private _topicsAndSkillsDashboardReinitializedEventEmitter =
+    new EventEmitter();
+
   fetchDashboardData(): Promise<TopicsAndSkillDashboardData> {
     return this.http.get<TopicsAndSkillsDashboardDataBackendDict>(
       '/topics_and_skills_dashboard/data').toPromise().then(response => {
@@ -213,6 +216,10 @@ export class TopicsAndSkillsDashboardBackendApiService {
       throw new Error(errorResponse.error.error);
     });
   }
+
+  get onTopicsAndSkillsDashboardReinitialized() {
+    return this._topicsAndSkillsDashboardReinitializedEventEmitter;
+  }
 }
 angular.module('oppia').factory(
   'TopicsAndSkillsDashboardBackendApiService',

core/templates/pages/collection-editor-page/collection-editor-page.module.ts

@@ -44,8 +44,6 @@ import { CollectionDomainConstants } from
   'domain/collection/collection-domain.constants';
 import { CollectionEditorPageConstants } from
   'pages/collection-editor-page/collection-editor-page.constants';
-import { EditorDomainConstants } from
-  'domain/editor/editor-domain.constants';
 import { InteractionsExtensionsConstants } from
   'interactions/interactions-extension.constants';
 import { ObjectsDomainConstants } from
@@ -89,7 +87,6 @@ import { CollectionStatisticsTabComponent } from
   providers: [
     AppConstants,
     CollectionDomainConstants,
-    EditorDomainConstants,
     InteractionsExtensionsConstants,
     ObjectsDomainConstants,
     ServicesConstants,

core/templates/pages/collection-editor-page/navbar/collection-editor-navbar.directive.ts

@@ -58,14 +58,12 @@ angular.module('oppia').directive('collectionEditorNavbar', [
         'CollectionValidationService',
         'CollectionRightsBackendApiService',
         'EditableCollectionBackendApiService', 'UrlService',
-        'EVENT_UNDO_REDO_SERVICE_CHANGE_APPLIED',
         function(
             $scope, $rootScope, $uibModal, AlertsService, RouterService,
             UndoRedoService, CollectionEditorStateService,
             CollectionValidationService,
             CollectionRightsBackendApiService,
-            EditableCollectionBackendApiService, UrlService,
-            EVENT_UNDO_REDO_SERVICE_CHANGE_APPLIED) {
+            EditableCollectionBackendApiService, UrlService) {
           var ctrl = this;
           ctrl.directiveSubscriptions = new Subscription();
           var _validateCollection = function() {
@@ -215,8 +213,11 @@ angular.module('oppia').directive('collectionEditorNavbar', [
                 () => _validateCollection()
               )
             );
-            $scope.$on(
-              EVENT_UNDO_REDO_SERVICE_CHANGE_APPLIED, _validateCollection);
+            ctrl.directiveSubscriptions.add(
+              UndoRedoService.onUndoRedoChangeApplied().subscribe(
+                () => _validateCollection()
+              )
+            );
             ctrl.collectionId = UrlService.getCollectionIdFromEditorUrl();
             ctrl.collection = CollectionEditorStateService.getCollection();
             ctrl.collectionRights = (

core/templates/pages/exploration-editor-page/exploration-editor-page.module.ts

@@ -48,8 +48,6 @@ import { ClassifiersExtensionConstants } from
   'classifiers/classifiers-extension.constants';
 import { CollectionSummaryTileConstants } from
   'components/summary-tile/collection-summary-tile.constants';
-import { EditorDomainConstants } from
-  'domain/editor/editor-domain.constants';
 import { InteractionsExtensionsConstants } from
   'interactions/interactions-extension.constants';
 import { ObjectsDomainConstants } from
@@ -83,7 +81,6 @@ import { ExplorationEditorPageConstants } from
     ClassifiersExtensionConstants,
     CollectionSummaryTileConstants,
     InteractionsExtensionsConstants,
-    EditorDomainConstants,
     ObjectsDomainConstants,
     QuestionDomainConstants,
     ServicesConstants,

core/templates/pages/skill-editor-page/skill-editor-page.module.ts

@@ -42,8 +42,6 @@ import { OppiaAngularRootComponent } from
   'components/oppia-angular-root.component';
 
 import { AppConstants } from 'app.constants';
-import { EditorDomainConstants } from
-  'domain/editor/editor-domain.constants';
 import { InteractionsExtensionsConstants } from
   'interactions/interactions-extension.constants';
 import { ObjectsDomainConstants } from
@@ -72,7 +70,6 @@ import { SkillEditorPageConstants } from
   providers: [
     AppConstants,
     InteractionsExtensionsConstants,
-    EditorDomainConstants,
     ObjectsDomainConstants,
     QuestionDomainConstants,
     QuestionsListConstants,

core/templates/pages/story-editor-page/navbar/story-editor-navbar.directive.ts

@@ -44,12 +44,10 @@ angular.module('oppia').directive('storyEditorNavbar', [
         '$scope', '$rootScope', '$uibModal', 'AlertsService',
         'EditableStoryBackendApiService', 'UndoRedoService',
         'StoryEditorStateService', 'StoryEditorNavigationService', 'UrlService',
-        'EVENT_UNDO_REDO_SERVICE_CHANGE_APPLIED',
         function(
             $scope, $rootScope, $uibModal, AlertsService,
             EditableStoryBackendApiService, UndoRedoService,
-            StoryEditorStateService, StoryEditorNavigationService, UrlService,
-            EVENT_UNDO_REDO_SERVICE_CHANGE_APPLIED) {
+            StoryEditorStateService, StoryEditorNavigationService, UrlService) {
           var ctrl = this;
           var EDITOR = 'Editor';
           var PREVIEW = 'Preview';
@@ -213,8 +211,11 @@ angular.module('oppia').directive('storyEditorNavbar', [
             $scope.isSaveInProgress = StoryEditorStateService.isSavingStory;
             $scope.validationIssues = [];
             $scope.prepublishValidationIssues = [];
-            $scope.$on(
-              EVENT_UNDO_REDO_SERVICE_CHANGE_APPLIED, _validateStory);
+            ctrl.directiveSubscriptions.add(
+              UndoRedoService.onUndoRedoChangeApplied().subscribe(
+                () => _validateStory()
+              )
+            );
           };
 
           ctrl.$onDestroy = function() {