fix: remove 'redirect to another unit in the same subsection' and repair the rest of the actions

Author: jignaciopm

CHANGELOG.rst

@@ -14,7 +14,7 @@ Unreleased
 
 *
 
-[1.2.0] - 2025-01-23
+[2.0.0] - 2025-01-23
 **********************************************
 
 Added
@@ -28,6 +28,7 @@ _______
 
 * **BREAKING CHANGE**: Dropped support for Python 3.5
 * Drop CircleCI support
+* Remove support to "redirect to another unit in the same subsection" action
 
 Changed
 =======
@@ -41,6 +42,7 @@ Fixed
 _____
 
 * Python3 and Juniper issues
+* Fix applyFlowControl in injection to applied correctly the actions of flow-control 
 
 
 [1.0.0] - 2020-06-18

README.rst

@@ -13,9 +13,9 @@ Compatibility Notes
 +------------------+--------------+
 | Open edX Release | Version      |
 +==================+==============+
-| Redwood          | >= 1.2.0     |
+| Redwood          | >= 2.0.0     |
 +------------------+--------------+
-| Sumac            | >= 1.2.0     |
+| Sumac            | >= 2.0.0     |
 +------------------+--------------+
 
 Installing on Open edX Devstack
@@ -29,8 +29,6 @@ However, if you want to further develop this XBlock, you might want to instead c
 
 	pip install -e path/to/flow-control
 
-⚠️ Since the Open edX Olive release, some features could fail because of the integration of [Learning MFE](https://github.com/eduNEXT/frontend-app-learning).
-
 
 Enabling in Studio
 ------------------
@@ -94,7 +92,7 @@ Features include
 **Actions:** This actions can be applied when a condition is met:
 
 * Display a message
-* Redirect to another unit in the same subsection (without reloading the page)
+* Redirect to another unit in the same subsection (without reloading the page) :warning:[DEPRECATED: Since version 2.0.0 and not working with MFE Learning]
 * Redirect to another unit using jump_to_id (reloading the page)
 * Redirect to a given url
 

flow_control/__init__.py

@@ -2,4 +2,4 @@
 Init for main Flow-Control XBlock
 """
 from .flow import FlowCheckPointXblock
-__version__ = '1.2.0'
+__version__ = '2.0.0'

flow_control/flow.py

@@ -37,8 +37,6 @@ def _actions_generator(block):  # pylint: disable=unused-argument
          "value": "display_message"},
         {"display_name": "Redirect using jump_to_id",
          "value": "to_jump"},
-        {"display_name": "Redirect to a given unit in the same subsection",
-         "value": "to_unit"},
         {"display_name": "Redirect to a given URL",
          "value": "to_url"}
     ]
@@ -128,17 +126,13 @@ class FlowCheckPointXblock(StudioEditableXBlockMixin, XBlock):
                         scope=Scope.content,
                         display_name="Score percentage")
 
-    tab_to = Integer(help="Number of unit tab to redirect to. (1, 2, 3...)",
-                     default=1,
-                     scope=Scope.content,
-                     display_name="Tab to redirect to")
-
     target_url = String(help="URL to redirect to, supports relative "
                         "or absolute urls",
                         scope=Scope.content,
                         display_name="URL to redirect to")
 
-    target_id = String(help="Unit identifier to redirect to (Location id)",
+    target_id = String(help="Unit identifier to redirect to (Location id). "
+                        "Use this action when you want to redirect any of the course units.",
                        scope=Scope.content,
                        display_name="Unit identifier to redirect to")
 
@@ -174,27 +168,10 @@ class FlowCheckPointXblock(StudioEditableXBlockMixin, XBlock):
                        'operator',
                        'ref_value',
                        'action',
-                       'tab_to',
                        'target_url',
                        'target_id',
                        'message')
 
-    def validate_field_data(self, validation, data):
-        """
-        Validate this block's field data
-        """
-
-        if data.tab_to <= 0:
-            validation.add(ValidationMessage(
-                ValidationMessage.ERROR,
-                u"Tab to redirect to must be greater than zero"))
-
-        if data.ref_value < 0 or data.ref_value > 100:
-            validation.add(ValidationMessage(
-                ValidationMessage.ERROR,
-                u"Score percentage field must "
-                u"be an integer number between 0 and 100"))
-
     def get_location_string(self, locator, is_draft=False):
         """  Returns the location string for one problem, given its id  """
         # pylint: disable=no-member
@@ -252,13 +229,10 @@ def student_view(self, context=None):  # pylint: disable=unused-argument
         # pylint: disable=no-member
         in_studio_runtime = hasattr(self.xmodule_runtime, 'is_author_mode')
         index_base = 1
-        default_tab = 'tab_{}'.format(self.tab_to - index_base)
 
         fragment.initialize_js(
             'FlowControlGoto',
             json_args={"display_name": self.display_name,
-                       "default": default_tab,
-                       "default_tab_id": self.tab_to,
                        "action": self.action,
                        "target_url": self.target_url,
                        "target_id": self.target_id,

flow_control/static/js/injection.js

@@ -1,20 +1,15 @@
 
 var settings = {
-  timeToCheck: 1,
-  tabTogo: null,
-  defaulTabId: null,
   defaultAction: 1,
   targetUrl: null,
   targetId: null,
-  lmsBaseJumpUrl: '../../../jump_to_id/',
   message: null,
   conditionReached: null,
   inStudioRuntime: false
 };
 
 var actions = {
   noAct: 'No action',
-  redirectTab: 'to_unit',
   redirectUrl: 'to_url',
   redirectJump: 'to_jump',
   show_message: 'display_message'
@@ -44,17 +39,15 @@ var uiSelectors = {
 };
 
 var viewblocks = {
-  seqContent: $('#seq_content'),
+  seqContent: $('#course-content'),
+  loadingMessageHtml: "<div><p>Loading, please wait...</p></div>",
   hideNotAllowedOption: function hideNotAllowedOption() {
     $(uiSelectors.settingsFields).hide();
     $(uiSelectors.settingsFields).filter('[data-field-name="condition"]').show();
     $(uiSelectors.settingsFields).filter('[data-field-name="action"]').show();
     $(uiSelectors.settingsFields).filter('[data-field-name="operator"]').show();
 
     switch ($(uiSelectors.action).val()) {
-    case actions.redirectTab:
-      $(uiSelectors.settingsFields).filter('[data-field-name="tab_to"]').show();
-      break;
     case actions.redirectUrl:
       $(uiSelectors.settingsFields).filter('[data-field-name="target_url"]').show();
       break;
@@ -89,81 +82,27 @@ var viewblocks = {
       switch (settings.defaultAction) {
       case actions.noAct:
         break;
-      case actions.redirectTab:
-        viewblocks.seqContent.empty();
-        window.flowControlTimeoutID = window.setTimeout(redirectToTab,
-            settings.timeToCheck,
-            settings.tabTogo);
-        break;
       case actions.redirectUrl:
-        viewblocks.seqContent.empty();
-        location.href = settings.targetUrl;
+        viewblocks.seqContent.html(viewblocks.loadingMessageHtml);
+        window.parent.location.href = settings.targetUrl;
         break;
       case actions.redirectJump:
-        viewblocks.seqContent.empty();
-        location.href = settings.targetId;
+        viewblocks.seqContent.html(viewblocks.loadingMessageHtml);
+        window.parent.location.href = getJumpToIdUrl(settings.targetId);
         break;
       case actions.show_message:
-        $('#course-content').html(settings.message);
+        viewblocks.seqContent.html(settings.message);
         break;
       }
     }
   }
 };
 
-var getActiveTab = function getActiveTab() {
-  // return the active sequential button
-  $tab = $('#course-content #sequence-list button.active')[0];
-
-  return $tab;
-};
-
-var execControl = function execControl(arg) {
-  // Find the target tab
-  var $target = $('#sequence-list button').filter(function filterFunc() {
-    return $(this).attr('id') === arg;
-  });
-
-  // Do the action
-  $target.click();
-  // TODO: can we make this silent. E.g. that it does not post to /handler/xmodule_handler/goto_position
-};
-
-var redirectToTab = function redirectToTab(arg) {
-  var $activeTab = getActiveTab();
-  var currentID = $activeTab.id;
-  var allTabs = $('#sequence-list button');
-  var firstTabIndex = 0;
-  var firstTab = 'tab_' + firstTabIndex;
-  var lastTabIndex = allTabs.length - 1;
-  var lastTab = 'tab_' + lastTabIndex;
-
-  if (currentID === arg) {
-    window.clearTimeout(window.flowControlTimeoutID);
-  } else {
-    var whereTo = null;
-    if (settings.defaulTabId > lastTabIndex) {
-      whereTo = lastTab;
-    }
-    if (settings.defaulTabId < firstTabIndex) {
-      whereTo = firstTab;
-    }
-    if (firstTabIndex <= settings.defaulTabId && settings.defaulTabId <= lastTabIndex) {
-      whereTo = arg;
-    }
-
-    execControl(whereTo);
-    window.flowControlTimeoutID = window.setTimeout(redirectToTab, settings.timeToCheck, whereTo);
-  }
-};
-
 function FlowControlGoto(runtime, element, options) {
   // Getting settings varibales to apply flow control
-  settings.tabTogo = options.default;
   settings.defaultAction = options.action;
   settings.targetUrl = options.target_url;
-  settings.targetId = settings.lmsBaseJumpUrl + options.target_id;
-  settings.defaulTabId = options.default_tab_id;
+  settings.targetId = options.target_id;
   settings.message = options.message;
   settings.inStudioRuntime = options.in_studio_runtime;
 
@@ -202,3 +141,16 @@ function StudioFlowControl(runtime, element) {
   $(uiSelectors.visibility).hide();
   $(uiSelectors.duplicate).hide();
 }
+
+function getCourseIdByUrl() {
+  const regex = /(?:block-v1:)(.+)(?:\+type)/;
+  const result = window.location.href.match(regex);
+  if (result) {
+    return result[1];
+  }
+  return null;
+}
+
+function getJumpToIdUrl(id) {
+  return `${window.location.origin}/courses/course-v1:${getCourseIdByUrl()}/jump_to_id/${id}`;
+}

flow_control/tests/test_flowcontrol.py

@@ -39,8 +39,6 @@ def test_actions_generator(self):
              "value": "display_message"},
             {"display_name": "Redirect using jump_to_id",
              "value": "to_jump"},
-            {"display_name": "Redirect to a given unit in the same subsection",
-             "value": "to_unit"},
             {"display_name": "Redirect to a given URL",
              "value": "to_url"}
         ]

setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 1.2.0
+current_version = 2.0.0
 commit = True
 tag = True