Problem/Motivation

When Simpletest module is enabled, the big list of tests (at admin/config/development/testing) offers a text input to filter tests by name. When using this, the list shrinks dynamically. The change is easily noted visually, but is not conveyed to users with screen readers.

Proposed resolution

Use Drupal.announce() to convey a short message about the number of tests now present in the filtered list.

We already make such use of Drupal.announce() in similar filter UIs. Follow the approach found in:

  • The modules list (see core/modules/system/js/system.modules.js)
  • The block list (see core/modules/block/js/block.admin.js)

Note: a debounce() is required to prevent too many updates and decrease the amount of announcements to a minimum.

Remaining tasks

This is basically a repeat of the approach we took in #2805205: Provide screen-reader feedback when filtering by block name..

  • Devise the announcement string(s). Suggested: "6 tests are available in the modified list."
  • Update simpletest.js and simpletest.es6.js to use Drupal.announce(), handling singular/plural results with Drupal.formatPlural().
  • Update simpletest.libraries.yml. This needs a dependency on core/Drupal.announce().
  • Manual testing:
    • Use browser developer tools (e.g. firebug) to watch the content of div#drupal-live-announce. It lives near the bottom of the HTML document, just before the closing body tag. A screenshot of the HTML with the correct message would be useful evidence of testing.
    • Alternatively, use the Devel accessibility module, which logs Drupal.announce() messages to the browser's dev tools console. Again, this is good for a screenshot.
    • Testing with an actual screen reader is also recommended. Some screen readers have a visible caption window (e.g. macOS VoiceOver calls this the caption panel). This also makes good screenshot evidence.
  • Automated tests (FunctionalJavascript):
    • Confirm the updated content of div#drupal-live-announce with JavascriptTestBase, for zero, singular, and plural result counts.
    • Follow the approach in /core/modules/block/tests/src/FunctionalJavascript/BlockFilterTest.php.

User interface changes

  • No visible changes intended.
  • Add a screen reader announcement to convey updates which are currently only apparent visually.
  • Introduces a new translatable string for Drupal.announce().

API changes

None expected.

Data model changes

None expected.

CommentFileSizeAuthor
#9 provide_screen_reader-2897430-9.patch6.25 KBerik.erskine
#9 drupal-announce-devtools.png171.89 KBerik.erskine
#16 Screen Shot 2017-10-20 at 1.45.27 PM.png304.64 KBmgifford

Comments

andrewmacpherson created an issue. See original summary.

andrewmacpherson’s picture

andrewmacpherson commented
Issue tags: +Novice

I think this would be OK for a novice. Mostly it's a copy-paste job of what we did in #2805205: Provide screen-reader feedback when filtering by block name..

If you want a mentor, get in touch via the contact form tab on my user profile, or say hello in the #accessibility channel of Drupal Slack community, or just say so here.

andrewmacpherson’s picture

andrewmacpherson commented
Issue summary: View changes

Minor updates to the plan.

andrewmacpherson’s picture

andrewmacpherson commented
Issue summary: View changes
andrewmacpherson’s picture

andrewmacpherson commented
Issue summary: View changes
andrewmacpherson’s picture

andrewmacpherson commented
Issue summary: View changes
andrewmacpherson’s picture

andrewmacpherson commented
Issue summary: View changes
erik.erskine’s picture

erik.erskine commented
Assigned: Unassigned » erik.erskine

Going to take a look at this today. Some mentoring would be appreciated - thanks!

erik.erskine’s picture

erik.erskine commented
Status: Active » Needs review
StatusFileSize
new provide_screen_reader-2897430-9.patch6.25 KB
new drupal-announce-devtools.png171.89 KB

I've attached a patch that follows the approach suggested. Using the Devel accessibility module, the results are shown in the browser's console (see screenshot).

Yet to verify this with VoiceOver.

The test takes a very long time to complete (15 min compared to 1 min for an empty test). I think that's down to the number of rows in the table - around 3000. Does that matter?

andrewmacpherson’s picture

andrewmacpherson commented

Thanks for the patch Erik. This looks like it's doing the right thing from the screenshot. I'll give it a detailed look myself, and run tests locally.

Version: 8.4.x-dev » 8.5.x-dev

Drupal 8.4.0-alpha1 will be released the week of July 31, 2017, which means new developments and disruptive changes should now be targeted against the 8.5.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

mile23’s picture

mile23
Primary language English
Location Seattle, WA
commented

+1 nice to have accessibility and also nice to have any kind of test on the filtering.

The test is taking a reeeely long time, so we have to figure out how to fix that. It's ~20-30 seconds per request to render that form...

time says: 546.77 real 52.01 user 4.34 sys

Also we have a deprecation roadmap for simpletest: #2866082: [Plan] Roadmap for Simpletest

andrewmacpherson’s picture

andrewmacpherson commented
Version: 8.5.x-dev » 8.4.x-dev
Assigned: erik.erskine » Unassigned
Category: Feature request » Bug report
Issue tags: +WCAG, +wcag21

Since we're now actively pursuing WCAG 2.1, I'm reclassifying this as a bug report.

It relates to the new WCAG 2.1 "Change of Content" success criterion. Under WCAG 2.0 the announcement was a nice-to-have, but under WCAG 2.1 it becomes a must-have. For a longer explanation, see #2864791-33: Implement new Success Criteria from WCAG 2.1.

andrewmacpherson’s picture

andrewmacpherson commented
Parent issue: » #2864791: Implement new Success Criteria from WCAG 2.1
andrewmacpherson’s picture

andrewmacpherson commented
Issue tags: -Novice

Removing the novice tag; the test time quirk sounds tricky.

mgifford’s picture

mgifford
he/him
Primary language English
commented
StatusFileSize
new Screen Shot 2017-10-20 at 1.45.27 PM.png304.64 KB

This looks good to me. You have to install the Testing module first, but after that it gives the expected results at the bottom of the search results.

Version: 8.4.x-dev » 8.5.x-dev

Drupal 8.4.4 was released on January 3, 2018 and is the final full bugfix release for the Drupal 8.4.x series. Drupal 8.4.x will not receive any further development aside from critical and security fixes. Sites should prepare to update to 8.5.0 on March 7, 2018. (Drupal 8.5.0-alpha1 is available for testing.)

Bug reports should be targeted against the 8.5.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.6.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

GrandmaGlassesRopeMan’s picture

GrandmaGlassesRopeMan
he/him
Primary language English
Location 🌎
commented
Version: 8.5.x-dev » 8.6.x-dev 
+++ b/core/modules/simpletest/simpletest.es6.js
@@ -99,6 +99,16 @@
+        function announceTableLength() {
+          Drupal.announce(
+            Drupal.formatPlural(
+              $table.find('tr:visible').length - 1,
+              '1 test is available in the modified list.',
+              '@count tests are available in the modified list.'
+            )
+          );
+        }

Missing trailing comma.

GrandmaGlassesRopeMan’s picture

GrandmaGlassesRopeMan
he/him
Primary language English
Location 🌎
commented
Status: Needs review » Needs work
mile23’s picture

mile23
Primary language English
Location Seattle, WA
commented
Related issues: +#2215035: [meta] Simpletest UI cleanups

See also: #2893117: Improve HTML caching of Simpletest UI test form which can help with test run time (and general performance).

mile23’s picture

mile23
Primary language English
Location Seattle, WA
commented 
+++ b/core/modules/simpletest/tests/src/FunctionalJavascript/SimpletestFilterTest.php
@@ -0,0 +1,95 @@
+  protected function setUp() {

This test could mock the test_discovery service to return a known set of results. Mock TestDiscovery::getTestClasses(). The benefits would be no file scan, and no dependency on the number or names of tests displayed.

Version: 8.6.x-dev » 8.7.x-dev

Drupal 8.6.0-alpha1 will be released the week of July 16, 2018, which means new developments and disruptive changes should now be targeted against the 8.7.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

andrewmacpherson’s picture

andrewmacpherson commented
Parent issue: #2864791: Implement new Success Criteria from WCAG 2.1 » #3015494: Make admin list filters behave more consistently.
Related issues: +#2864791: Implement new Success Criteria from WCAG 2.1

There's a parent plan about this now.

Version: 8.7.x-dev » 8.8.x-dev

Drupal 8.7.0-alpha1 will be released the week of March 11, 2019, which means new developments and disruptive changes should now be targeted against the 8.8.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.8.x-dev » 8.9.x-dev

Drupal 8.8.0-alpha1 will be released the week of October 14th, 2019, which means new developments and disruptive changes should now be targeted against the 8.9.x-dev branch. (Any changes to 8.9.x will also be committed to 9.0.x in preparation for Drupal 9’s release, but some changes like significant feature additions will be deferred to 9.1.x.). For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 8.9.x-dev » 9.1.x-dev

Drupal 8.9.0-beta1 was released on March 20, 2020. 8.9.x is the final, long-term support (LTS) minor release of Drupal 8, which means new developments and disruptive changes should now be targeted against the 9.1.x-dev branch. For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

quietone’s picture

quietone commented
Project: Drupal core » SimpleTest
Version: 9.1.x-dev » 8.x-3.x-dev
Component: simpletest.module » Code
Issue tags: -JavaScript +JavaScript

Triaging issues in simpletest.module as part of the Bug Smash Initiative to determine if they should be in the Simpletest Project or core.

This looks like it belongs in the Simpletest project.