Fix part of oppia#3826: Extracted recursionHelper-> NestedDirectivesR…

…ecursionTimeoutPreventionService into separate file. (oppia#4518) * Extracted recursionHelper → NestedDirectivesRecursionTimeoutPreventionService * Fixed indentation error * Fixed review errors
YimingPan · Jan 14, 2018 · fc05972 · fc05972
1 parent 45af240
commit fc05972
Show file tree

Hide file tree

Showing 14 changed files with 118 additions and 73 deletions.
diff --git a/core/templates/dev/head/components/forms/FormBuilder.js b/core/templates/dev/head/components/forms/FormBuilder.js
@@ -365,48 +365,3 @@ oppia.directive('requireIsFloat', ['$filter', function($filter) {
     }
   };
 }]);
-
-// Prevents timeouts due to recursion in nested directives. See:
-//
-//   http://stackoverflow.com/q/14430655
-oppia.factory('recursionHelper', ['$compile', function($compile) {
-  return {
-    /**
-     * Manually compiles the element, fixing the recursion loop.
-     * @param {DOM element} element
-     * @param {function|object} link - A post-link function, or an object with
-     *   function(s) registered via pre and post properties.
-     * @return {object} An object containing the linking functions.
-     */
-    compile: function(element, link) {
-      // Normalize the link parameter
-      if (angular.isFunction(link)) {
-        link = {
-          post: link
-        };
-      }
-
-      // Break the recursion loop by removing the contents,
-      var contents = element.contents().remove();
-      var compiledContents;
-      return {
-        pre: (link && link.pre) ? link.pre : null,
-        post: function(scope, element) {
-          // Compile the contents.
-          if (!compiledContents) {
-            compiledContents = $compile(contents);
-          }
-          // Re-add the compiled contents to the element.
-          compiledContents(scope, function(clone) {
-            element.append(clone);
-          });
-
-          // Call the post-linking function, if any.
-          if (link && link.post) {
-            link.post.apply(null, arguments);
-          }
-        }
-      };
-    }
-  };
-}]);
diff --git a/core/templates/dev/head/components/forms/schema_editors/SchemaBasedChoicesEditorDirective.js b/core/templates/dev/head/components/forms/schema_editors/SchemaBasedChoicesEditorDirective.js
@@ -17,8 +17,11 @@
  */
 
 oppia.directive('schemaBasedChoicesEditor', [
-  'recursionHelper', 'UrlInterpolationService',
-  function(recursionHelper, UrlInterpolationService) {
+  'NestedDirectivesRecursionTimeoutPreventionService',
+  'UrlInterpolationService',
+  function(
+    NestedDirectivesRecursionTimeoutPreventionService,
+    UrlInterpolationService) {
     return {
       scope: {
         localValue: '=',
@@ -33,7 +36,7 @@ oppia.directive('schemaBasedChoicesEditor', [
         '/components/forms/schema_editors/' +
         'schema_based_choices_editor_directive.html'),
       restrict: 'E',
-      compile: recursionHelper.compile,
+      compile: NestedDirectivesRecursionTimeoutPreventionService.compile,
       controller: ['$scope', function($scope) {
         $scope.getReadonlySchema = function() {
           var readonlySchema = angular.copy($scope.schema());

diff --git a/core/templates/dev/head/components/forms/schema_editors/SchemaBasedCustomEditorDirective.js b/core/templates/dev/head/components/forms/schema_editors/SchemaBasedCustomEditorDirective.js
@@ -17,8 +17,11 @@
  */
 
 oppia.directive('schemaBasedCustomEditor', [
-  'recursionHelper', 'UrlInterpolationService',
-  function(recursionHelper, UrlInterpolationService) {
+  'NestedDirectivesRecursionTimeoutPreventionService',
+  'UrlInterpolationService',
+  function(
+    NestedDirectivesRecursionTimeoutPreventionService,
+    UrlInterpolationService) {
     return {
       scope: {
         localValue: '=',
@@ -29,7 +32,7 @@ oppia.directive('schemaBasedCustomEditor', [
         '/components/forms/schema_editors/' +
         'schema_based_custom_editor_directive.html'),
       restrict: 'E',
-      compile: recursionHelper.compile
+      compile: NestedDirectivesRecursionTimeoutPreventionService.compile
     };
   }
 ]);
diff --git a/core/templates/dev/head/components/forms/schema_editors/SchemaBasedDictEditorDirective.js b/core/templates/dev/head/components/forms/schema_editors/SchemaBasedDictEditorDirective.js
@@ -17,8 +17,11 @@
  */
 
 oppia.directive('schemaBasedDictEditor', [
-  'recursionHelper', 'UrlInterpolationService',
-  function(recursionHelper, UrlInterpolationService) {
+  'NestedDirectivesRecursionTimeoutPreventionService',
+  'UrlInterpolationService',
+  function(
+    NestedDirectivesRecursionTimeoutPreventionService,
+    UrlInterpolationService) {
     return {
       scope: {
         localValue: '=',
@@ -32,7 +35,7 @@ oppia.directive('schemaBasedDictEditor', [
         '/components/forms/schema_editors/' +
         'schema_based_dict_editor_directive.html'),
       restrict: 'E',
-      compile: recursionHelper.compile,
+      compile: NestedDirectivesRecursionTimeoutPreventionService.compile,
       controller: [
         '$scope', 'IdGenerationService',
         function($scope, IdGenerationService) {

diff --git a/core/templates/dev/head/components/forms/schema_editors/SchemaBasedListEditorDirective.js b/core/templates/dev/head/components/forms/schema_editors/SchemaBasedListEditorDirective.js
@@ -17,12 +17,15 @@
  */
 
 oppia.directive('schemaBasedListEditor', [
-  'SchemaDefaultValueService', 'recursionHelper', 'FocusManagerService',
-  'SchemaUndefinedLastElementService', 'IdGenerationService',
-  'UrlInterpolationService', function(
-    SchemaDefaultValueService, recursionHelper, FocusManagerService,
-    SchemaUndefinedLastElementService, IdGenerationService,
-    UrlInterpolationService) {
+  'SchemaDefaultValueService', 
+  'NestedDirectivesRecursionTimeoutPreventionService',
+  'FocusManagerService', 'SchemaUndefinedLastElementService',
+  'IdGenerationService', 'UrlInterpolationService', 
+  function(
+    SchemaDefaultValueService, 
+    NestedDirectivesRecursionTimeoutPreventionService,
+    FocusManagerService, SchemaUndefinedLastElementService,
+    IdGenerationService, UrlInterpolationService) {
     return {
       scope: {
         localValue: '=',
@@ -41,7 +44,7 @@ oppia.directive('schemaBasedListEditor', [
         '/components/forms/schema_editors/' +
         'schema_based_list_editor_directive.html'),
       restrict: 'E',
-      compile: recursionHelper.compile,
+      compile: NestedDirectivesRecursionTimeoutPreventionService.compile,
       controller: ['$scope', function($scope) {
         var baseFocusLabel = (
           $scope.labelForFocusTarget() ||

diff --git a/core/templates/dev/head/components/forms/schema_viewers/SchemaBasedCustomViewerDirective.js b/core/templates/dev/head/components/forms/schema_viewers/SchemaBasedCustomViewerDirective.js
@@ -17,8 +17,11 @@
  */
 
 oppia.directive('schemaBasedCustomViewer', [
-  'recursionHelper', 'UrlInterpolationService',
-  function(recursionHelper, UrlInterpolationService) {
+  'NestedDirectivesRecursionTimeoutPreventionService',
+  'UrlInterpolationService',
+  function(
+    NestedDirectivesRecursionTimeoutPreventionService,
+    UrlInterpolationService) {
     return {
       scope: {
         localValue: '=',
@@ -29,7 +32,7 @@ oppia.directive('schemaBasedCustomViewer', [
         '/components/forms/schema_viewers/' +
         'schema_based_custom_viewer_directive.html'),
       restrict: 'E',
-      compile: recursionHelper.compile
+      compile: NestedDirectivesRecursionTimeoutPreventionService.compile
     };
   }
 ]);
diff --git a/core/templates/dev/head/components/forms/schema_viewers/SchemaBasedDictViewerDirective.js b/core/templates/dev/head/components/forms/schema_viewers/SchemaBasedDictViewerDirective.js
@@ -17,8 +17,11 @@
  */
 
 oppia.directive('schemaBasedDictViewer', [
-  'recursionHelper', 'UrlInterpolationService',
-  function(recursionHelper, UrlInterpolationService) {
+  'NestedDirectivesRecursionTimeoutPreventionService',
+  'UrlInterpolationService',
+  function(
+    NestedDirectivesRecursionTimeoutPreventionService,
+    UrlInterpolationService) {
     return {
       scope: {
         localValue: '=',
@@ -30,7 +33,7 @@ oppia.directive('schemaBasedDictViewer', [
         '/components/forms/schema_viewers/' +
         'schema_based_dict_viewer.html'),
       restrict: 'E',
-      compile: recursionHelper.compile,
+      compile: NestedDirectivesRecursionTimeoutPreventionService.compile,
       controller: ['$scope', function($scope) {
         $scope.getHumanReadablePropertyDescription = function(property) {
           return property.description || '[' + property.name + ']';

diff --git a/core/templates/dev/head/components/forms/schema_viewers/SchemaBasedListViewerDirective.js b/core/templates/dev/head/components/forms/schema_viewers/SchemaBasedListViewerDirective.js
@@ -17,8 +17,11 @@
  */
 
 oppia.directive('schemaBasedListViewer', [
-  'recursionHelper', 'UrlInterpolationService',
-  function(recursionHelper, UrlInterpolationService) {
+  'NestedDirectivesRecursionTimeoutPreventionService',
+  'UrlInterpolationService',
+  function(
+    NestedDirectivesRecursionTimeoutPreventionService,
+    UrlInterpolationService) {
     return {
       scope: {
         localValue: '=',
@@ -29,7 +32,7 @@ oppia.directive('schemaBasedListViewer', [
         '/components/forms/schema_viewers/' +
         'schema_based_list_viewer_directive.html'),
       restrict: 'E',
-      compile: recursionHelper.compile
+      compile: NestedDirectivesRecursionTimeoutPreventionService.compile
     };
   }
 ]);
diff --git a/core/templates/dev/head/pages/admin/admin.html b/core/templates/dev/head/pages/admin/admin.html
@@ -108,6 +108,7 @@
     <script src="{{TEMPLATE_DIR_PREFIX}}/services/RteHelperService.js"></script>
     <script src="{{TEMPLATE_DIR_PREFIX}}/services/SchemaDefaultValueService.js"></script>
     <script src="{{TEMPLATE_DIR_PREFIX}}/services/SchemaUndefinedLastElementService.js"></script>
+    <script src="{{TEMPLATE_DIR_PREFIX}}/services/NestedDirectivesRecursionTimeoutPreventionService.js"></script>
     <script src="{{TEMPLATE_DIR_PREFIX}}/services/contextual/DeviceInfoService.js"></script>
     <script src="{{TEMPLATE_DIR_PREFIX}}/services/contextual/UrlService.js"></script>
     <script src="{{TEMPLATE_DIR_PREFIX}}/services/stateful/FocusManagerService.js"></script>

diff --git a/core/templates/dev/head/pages/exploration_editor/exploration_editor.html b/core/templates/dev/head/pages/exploration_editor/exploration_editor.html
@@ -223,6 +223,7 @@
   <script src="{{TEMPLATE_DIR_PREFIX}}/services/LocalStorageService.js"></script>
   <script src="{{TEMPLATE_DIR_PREFIX}}/services/SchemaDefaultValueService.js"></script>
   <script src="{{TEMPLATE_DIR_PREFIX}}/services/SchemaUndefinedLastElementService.js"></script>
+  <script src="{{TEMPLATE_DIR_PREFIX}}/services/NestedDirectivesRecursionTimeoutPreventionService.js"></script>
   <script src="{{TEMPLATE_DIR_PREFIX}}/pages/exploration_editor/EditorNavbarBreadcrumbDirective.js"></script>
   <script src="{{TEMPLATE_DIR_PREFIX}}/pages/exploration_editor/EditorNavigationDirective.js"></script>
   <script src="{{TEMPLATE_DIR_PREFIX}}/pages/exploration_editor/EditorServices.js"></script>

diff --git a/core/templates/dev/head/pages/exploration_player/exploration_player.html b/core/templates/dev/head/pages/exploration_player/exploration_player.html
@@ -106,6 +106,7 @@ <h1 class="oppia-exploration-h1"><span class="protractor-test-exploration-header
   <script src="{{TEMPLATE_DIR_PREFIX}}/services/ComputeGraphService.js"></script>
   <script src="{{TEMPLATE_DIR_PREFIX}}/services/SchemaDefaultValueService.js"></script>
   <script src="{{TEMPLATE_DIR_PREFIX}}/services/SchemaUndefinedLastElementService.js"></script>
+  <script src="{{TEMPLATE_DIR_PREFIX}}/services/NestedDirectivesRecursionTimeoutPreventionService.js"></script>
   <script src="{{TEMPLATE_DIR_PREFIX}}/components/attribution_guide/AttributionGuideDirective.js"></script>
   <script src="{{TEMPLATE_DIR_PREFIX}}/components/embed_modal/ExplorationEmbedButtonService.js"></script>
   <script src="{{TEMPLATE_DIR_PREFIX}}/components/profile_link/ProfileLinkImageDirective.js"></script>

diff --git a/core/templates/dev/head/pages/moderator/moderator.html b/core/templates/dev/head/pages/moderator/moderator.html
@@ -96,6 +96,7 @@ <h3>Activities to feature in the library</h3>
   <script src="{{TEMPLATE_DIR_PREFIX}}/components/forms/FormBuilder.js"></script>
   <script src="{{TEMPLATE_DIR_PREFIX}}/services/SchemaDefaultValueService.js"></script>
   <script src="{{TEMPLATE_DIR_PREFIX}}/services/SchemaUndefinedLastElementService.js"></script>
+  <script src="{{TEMPLATE_DIR_PREFIX}}/services/NestedDirectivesRecursionTimeoutPreventionService.js"></script>
   <script src="{{TEMPLATE_DIR_PREFIX}}/components/forms/schema_editors/SchemaBasedChoicesEditorDirective.js"></script>
   <script src="{{TEMPLATE_DIR_PREFIX}}/components/forms/schema_editors/SchemaBasedDictEditorDirective.js"></script>
   <script src="{{TEMPLATE_DIR_PREFIX}}/components/forms/schema_editors/SchemaBasedEditorDirective.js"></script>

diff --git a/core/templates/dev/head/pages/tests/FormBuilderTestPage.js b/core/templates/dev/head/pages/tests/FormBuilderTestPage.js
@@ -17,8 +17,11 @@
  */
 
 oppia.directive('formOverlay', [
-  'recursionHelper', 'UrlInterpolationService',
-  function(recursionHelper, UrlInterpolationService) {
+  'NestedDirectivesRecursionTimeoutPreventionService',
+  'UrlInterpolationService',
+  function(
+    NestedDirectivesRecursionTimeoutPreventionService,
+    UrlInterpolationService) {
     return {
       scope: {
         definition: '=',
@@ -28,7 +31,7 @@ oppia.directive('formOverlay', [
       templateUrl: UrlInterpolationService.getDirectiveTemplateUrl(
         '/pages/tests/form_entry_point_modal_directive.html'),
       restrict: 'E',
-      compile: recursionHelper.compile,
+      compile: NestedDirectivesRecursionTimeoutPreventionService.compile,
       controller: ['$scope', function($scope) {
         $scope.$watch('savedValue', function() {
           $scope.localValue = angular.copy($scope.savedValue);

diff --git a/core/templates/dev/head/services/NestedDirectivesRecursionTimeoutPreventionService.js b/core/templates/dev/head/services/NestedDirectivesRecursionTimeoutPreventionService.js
@@ -0,0 +1,62 @@
+// Copyright 2018 The Oppia Authors. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS-IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+/**
+ * @fileoverview Service prevents timeouts due to recursion
+ * in nested directives. See: http://stackoverflow.com/q/14430655
+ */
+
+oppia.factory('NestedDirectivesRecursionTimeoutPreventionService', [
+  '$compile', 
+  function($compile) {
+    return {
+      /**
+       * Manually compiles the element, fixing the recursion loop.
+       * @param {DOM element} element
+       * @param {function|object} link - A post-link function, or an object with
+       *   function(s) registered via pre and post properties.
+       * @return {object} An object containing the linking functions.
+       */
+      compile: function(element, link) {
+        // Normalize the link parameter
+        if (angular.isFunction(link)) {
+          link = {
+            post: link
+          };
+        }
+
+        // Break the recursion loop by removing the contents,
+        var contents = element.contents().remove();
+        var compiledContents;
+        return {
+          pre: (link && link.pre) ? link.pre : null,
+          post: function(scope, element) {
+            // Compile the contents.
+            if (!compiledContents) {
+              compiledContents = $compile(contents);
+            }
+            // Re-add the compiled contents to the element.
+            compiledContents(scope, function(clone) {
+              element.append(clone);
+            });
+
+            // Call the post-linking function, if any.
+            if (link && link.post) {
+              link.post.apply(null, arguments);
+            }
+          }
+        };
+      }
+    };
+  }]);