MDL-83056 core_course: Disable subsection add link when max reached

* Fix behat test to changes in the Add Activity or resource button
laurentdavid · Jan 9, 2025 · 9d98f7b · 9d98f7b
1 parent 95203dc
commit 9d98f7b
Show file tree

Hide file tree

Showing 7 changed files with 65 additions and 18 deletions.
diff --git a/course/format/tests/behat/course_courseindex.feature b/course/format/tests/behat/course_courseindex.feature
@@ -389,9 +389,7 @@ Feature: Course index depending on role
     And I log in as "teacher1"
     And I am on "Course 1" course homepage with editing mode on
     Then I should see "Section 1" in the "courseindex-content" "region"
-    And ".disabled" "css_element" should exist in the "[data-action='addSection']" "css_element"
     And I should see "You have reached the maximum number of sections allowed for a course."
     And I delete section "4"
     And I click on "Delete" "button" in the ".modal" "css_element"
-    And ".disabled" "css_element" should not exist in the "[data-action='addSection']" "css_element"
     And I should not see "You have reached the maximum number of sections allowed for a course."
diff --git a/course/format/tests/behat/course_manageactivities.feature b/course/format/tests/behat/course_manageactivities.feature
@@ -56,7 +56,8 @@ Feature: Verify edit utils availability
     Given I log in as "author1"
     When I am on "Course 1" course homepage
     And I turn editing mode on
-    Then I should see "Add an activity or resource"
+    And I click on add content dropdown action
+    Then "Activity or resource" "core_course > Add content dropdown action" should be visible
     But I should not see "Add section"
     And I open "Activity sample 1" actions menu
     And I should see "Edit settings"
@@ -72,7 +73,8 @@ Feature: Verify edit utils availability
     And I log in as "author1"
     When I am on "Course 1" course homepage
     And I turn editing mode on
-    Then I should see "Add an activity or resource"
+    And I click on add content dropdown action
+    Then "Activity or resource" "core_course > Add content dropdown action" should be visible
     And I should see "Add section"
     And I open "Activity sample 1" actions menu
     And I should see "Edit settings"

diff --git a/course/tests/behat/activity_chooser.feature b/course/tests/behat/activity_chooser.feature
@@ -49,7 +49,7 @@ Feature: Display and choose from the available activities in course
     # Confirm show summary also works for weekly format course
     And I am on "C2" course homepage with editing mode on
     And I click on "Add content" "button" in the "13 January - 19 January" "section"
-    And I click on "Activity or resource" "button" in the "13 January - 19 January" "section"
+    And I click on "Activity or resource" "core_course > Add content dropdown action"
     And I click on "Information about the Assignment activity" "button" in the "Add an activity or resource" "dialogue"
     And I should see "Assignment" in the "help" "core_course > Activity chooser screen"
     And I should see "The assignment activity module enables a teacher to communicate tasks, collect work and provide grades and feedback."
@@ -67,7 +67,7 @@ Feature: Display and choose from the available activities in course
     # Confirm hide summary also works for weekly format course
     And I am on "C2" course homepage with editing mode on
     And I click on "Add content" "button" in the "13 January - 19 January" "section"
-    And I click on "Activity or resource" "button" in the "13 January - 19 January" "section"
+    And I click on "Activity or resource" "core_course > Add content dropdown action"
     And I click on "Information about the Assignment activity" "button" in the "Add an activity or resource" "dialogue"
     And I click on "Back" "button" in the "help" "core_course > Activity chooser screen"
     And "modules" "core_course > Activity chooser screen" should be visible
@@ -107,7 +107,7 @@ Feature: Display and choose from the available activities in course
     And I should see "Starred" in the "Add an activity or resource" "dialogue"
     And I click on "Close" "button" in the "Add an activity or resource" "dialogue"
     And I click on "Add content" "button" in the "New section" "section"
-    And I click on "Activity or resource" "button" in the "New section" "section"
+    And I click on "Activity or resource" "core_course > Add content dropdown action"
     And I click on "Starred" "link" in the "Add an activity or resource" "dialogue"
     Then I should see "Forum" in the "favourites" "core_course > Activity chooser tab"
 
@@ -279,7 +279,7 @@ Feature: Display and choose from the available activities in course
   Scenario: Teacher can navigate through activity chooser in Weekly format course
     Given I am on "C2" course homepage with editing mode on
     And I click on "Add content" "button" in the "13 January - 19 January" "section"
-    When I click on "Activity or resource" "button" in the "13 January - 19 January" "section"
+    When I click on "Activity or resource" "core_course > Add content dropdown action"
     Then I should see "All" in the "Add an activity or resource" "dialogue"
     And I press the tab key
     And I press the tab key
@@ -313,7 +313,7 @@ Feature: Display and choose from the available activities in course
     # Confirm the same behaviour for weekly format course
     And I am on "C2" course homepage with editing mode on
     And I click on "Add content" "button" in the "13 January - 19 January" "section"
-    And I click on "Activity or resource" "button" in the "13 January - 19 January" "section"
+    And I click on "Activity or resource" "core_course > Add content dropdown action"
     And I should see "All" in the "Add an activity or resource" "dialogue"
     And I click on "Information about the Assignment activity" "button" in the "Add an activity or resource" "dialogue"
     # Confirm more help link exists

diff --git a/course/tests/behat/behat_course.php b/course/tests/behat/behat_course.php
@@ -63,6 +63,10 @@ public static function get_partial_named_selectors(): array {
                 'initials bar',
                 [".//*[contains(concat(' ', @class, ' '), ' initialbar ')]//span[contains(., %locator%)]/parent::div"]
             ),
+            new behat_component_named_selector(
+                'Add content dropdown action',
+                ["//*[contains(@class, 'dropdown-menu')][contains(@class, 'show')]//*[contains(., %locator%)]"]
+            ),
         ];
     }
 
@@ -86,6 +90,27 @@ public static function get_named_replacements(): array {
         ];
     }
 
+    /**
+     * Click on the first add content dropdown action.
+     *
+     *  Examples:
+     *    Given I click on add content dropdown action
+     *    Given I click on add content dropdown action in the ".my-wrapper" "css_element"
+     *
+     * @Given /^I click on add content dropdown action(?: in the "([^"]+)" "([^"]+)")?$/
+     */
+    public function i_click_on_add_content_dropdown_action(?string $element = null, ?string $selectortype = 'css_element') {
+        $buttonxpath = ["//*[@data-action='open-addingcontent']", "xpath_element"];
+        if ($element) {
+            $this->execute('behat_general::i_click_on_in_the', [$element, $selectortype, ...$buttonxpath]);
+        } else {
+            $this->execute(
+                'behat_general::i_click_on',
+                $buttonxpath
+            );
+        }
+    }
+
     /**
      * Creates a new course with the provided table data matching course settings names with the desired values.
      *

diff --git a/mod/subsection/classes/local/callbacks/before_activitychooserbutton_exported_handler.php b/mod/subsection/classes/local/callbacks/before_activitychooserbutton_exported_handler.php
@@ -39,16 +39,16 @@ class before_activitychooserbutton_exported_handler {
     public static function callback(before_activitychooserbutton_exported $hook): void {
         /** @var section_info $section */
         $section = $hook->get_section();
-
         if (!permission::can_add_subsection($section)) {
             return;
         }
-
+        $format = course_get_format($section->course);
         $attributes = [
-            'class' => 'dropdown-item',
+            'class' => 'dropdown-item' . ($format->is_max_sections_reached() ? '' : ' disabled'),
             'data-action' => 'addModule',
             'data-modname' => 'subsection',
             'data-sectionnum' => $section->sectionnum,
+            'data-region' => 'section-addsection',
         ];
         if ($hook->get_cm()) {
             $attributes['data-beforemod'] = $hook->get_cm()->id;

diff --git a/mod/subsection/classes/permission.php b/mod/subsection/classes/permission.php
@@ -28,7 +28,11 @@
  */
 class permission {
     /**
-     * Whether given user can add a subsection in a section
+     * Whether given user can add a subsection in a section.
+     *
+     * Here we check if we can add a subsection in a section and the delegated section is enabled.
+     * It means that this will only check things that are not supposed to change except through a new page load.
+     * Typically checking that we reach max_sections is not done here.
      *
      * @param section_info $section the course section
      * @param int|null $userid User ID to check, or the current user if omitted
@@ -49,9 +53,6 @@ public static function can_add_subsection(section_info $section, ?int $userid =
             return false;
         }
         $format = course_get_format($section->course);
-        if ($format->is_max_sections_reached()) {
-            return false;
-        }
         if (!$format->supports_components()) {
             return false;
         }

diff --git a/mod/subsection/tests/behat/subsection_limit.feature b/mod/subsection/tests/behat/subsection_limit.feature
@@ -21,9 +21,30 @@ Feature: Teacher can only add subsection when certain conditions are met
       | maxsections | 10 | moodlecourse |
     And I log in as "teacher1"
     And I am on "Course 1" course homepage with editing mode on
-    And I click on "Add content" "button" in the "Section 1" "section"
-    And I click on "Subsection" "link" in the ".dropdown-menu.show" "css_element"
+    And I click on add content dropdown action
+    And I click on "Subsection" "core_course > Add content dropdown action"
     When the following config values are set as admin:
       | maxsections | 4 | moodlecourse |
     And I am on "Course 1" course homepage
     And I should see "You have reached the maximum number of sections allowed for a course."
+
+  @javascript
+  Scenario: The add subsection link is disabled when maxsections is reached
+    Given the following config values are set as admin:
+      | maxsections | 6 | moodlecourse |
+    And I log in as "teacher1"
+    And I am on "Course 1" course homepage with editing mode on
+    And I click on add content dropdown action
+    And the "Subsection" "core_course > Add content dropdown action" should be enabled
+    And I click on "Subsection" "core_course > Add content dropdown action"
+    And I click on add content dropdown action
+    And the "Subsection" "core_course > Add content dropdown action" should be disabled
+    And I click on "Subsection" "core_course > Add content dropdown action"
+    And I should see "You have reached the maximum number of sections allowed for a course."
+
+  @javascript
+  Scenario: When subsection is disabled, we should not see the add subsection link
+    Given I disable "subsection" "mod" plugin
+    And I log in as "teacher1"
+    And I am on "Course 1" course homepage with editing mode on
+    And I should see "Add an activity or resource" in the "General" "section"