Page MenuHomePhabricator
Create Task
Maniphest T262403

jsdoc-wmf-theme: Search is completely broken
Closed, ResolvedPublic
Actions

Description

The search doesn't work at all it seems.

  • The results don't link to their page, there is no anchor link.
  • The results are inaccessible, there is no hover or selection state, content has a text cursor instead of a pointer.
  • The results are not keyboard accessible, cursor keys do nothing.
  • The results feel out of place, mostly unstyled/lacking spacing.
  • The results flicker when you focus the search field.

Consistently reproducible in Firefox and Safari on macOS on https://doc.wikimedia.org/oojs/master/, and also with local builds.

Details

SubjectRepoBranchLines +/-
Some minor search improvementsjsdoc/wmf-thememaster+4 -1
Allow the disabling of the Search system for repos on which it's too slowjsdoc/wmf-thememaster+3 -2
Fix typo in search code that was causing it to be mostly brokenjsdoc/wmf-thememaster+2 -2
Don't perform search on an empty termjsdoc/wmf-thememaster+5 -1
Truncate search results for performancejsdoc/wmf-thememaster+1 -1
Customize query in gerrit

Related Objects
Search...

Event Timeline

Krinkle created this task.Sep 9 2020, 12:35 PM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptSep 9 2020, 12:35 PM
Krinkle triaged this task as High priority.Sep 9 2020, 12:36 PM
Krinkle moved this task from Backlog to Confirmed Problem on the JSDoc WMF theme board.
Krinkle added a subtask: T187672: Release jsdoc-wmf-theme 1.0 (Wikimedia theme for JSDoc3).Sep 9 2020, 1:10 PM
Krinkle mentioned this in T138401: Replace jsduck with JSDoc3 across all Wikimedia code bases.Apr 24 2021, 3:20 AM
Krinkle renamed this task from jsdoc-wmf-theme: Search is broken to jsdoc-wmf-theme: Search is completely broken.May 12 2023, 9:23 PM
Krinkle updated the task description. (Show Details)
Krinkle removed a subtask: T187672: Release jsdoc-wmf-theme 1.0 (Wikimedia theme for JSDoc3).
Krinkle added a parent task: T187672: Release jsdoc-wmf-theme 1.0 (Wikimedia theme for JSDoc3).
Esanders subscribed.May 26 2023, 5:04 PM

We should just disable the search bar. You can still search class names with ctrl+f.

Esanders added a comment.May 26 2023, 5:12 PM

There are big performance issues with the OOUI documentation. My system hangs for 20s just focussing the search bar.

gerritbot added a comment.May 26 2023, 5:12 PM

Change 923671 had a related patch set uploaded (by Jforrester; author: Jforrester):

[jsdoc/wmf-theme@master] Allow the disabling of the Search system for repos on which it's too slow

https://gerrit.wikimedia.org/r/923671

gerritbot added a project: Patch-For-Review.May 26 2023, 5:12 PM
gerritbot added a comment.May 26 2023, 5:23 PM

Change 923678 had a related patch set uploaded (by Esanders; author: Esanders):

[jsdoc/wmf-theme@master] Truncate search results for performance

https://gerrit.wikimedia.org/r/923678

gerritbot added a comment.May 26 2023, 5:23 PM

Change 923679 had a related patch set uploaded (by Esanders; author: Esanders):

[jsdoc/wmf-theme@master] Don't perform search on an empty term

https://gerrit.wikimedia.org/r/923679

gerritbot added a comment.May 26 2023, 5:26 PM

Change 923678 merged by jenkins-bot:

[jsdoc/wmf-theme@master] Truncate search results for performance

https://gerrit.wikimedia.org/r/923678

gerritbot added a comment.May 26 2023, 5:26 PM

Change 923679 merged by jenkins-bot:

[jsdoc/wmf-theme@master] Don't perform search on an empty term

https://gerrit.wikimedia.org/r/923679

Jdforrester-WMF closed subtask T337575: jsodoc-wmf-theme: Params table is not very legible as Resolved.May 26 2023, 5:32 PM
gerritbot added a comment.May 26 2023, 5:36 PM

Change 923682 had a related patch set uploaded (by Esanders; author: Esanders):

[jsdoc/wmf-theme@master] Fix typo in search code that was causing it to be mostly broken

https://gerrit.wikimedia.org/r/923682

Esanders added a comment.May 26 2023, 5:37 PM

The above typo fix makes the feature mostly work as expected

gerritbot added a comment.May 26 2023, 5:38 PM

Change 923682 merged by jenkins-bot:

[jsdoc/wmf-theme@master] Fix typo in search code that was causing it to be mostly broken

https://gerrit.wikimedia.org/r/923682

gerritbot added a comment.May 26 2023, 5:38 PM

Change 923671 abandoned by Jforrester:

[jsdoc/wmf-theme@master] Allow the disabling of the Search system for repos on which it's too slow

Reason:

https://gerrit.wikimedia.org/r/923671

Esanders mentioned this in rJWTHa8650edf6c6d: Truncate search results for performance.May 26 2023, 5:40 PM
Esanders mentioned this in rJWTHe81f1c34dccc: Don't perform search on an empty term.
Esanders mentioned this in rJWTH3aa70bd5fba3: Fix typo in search code that was causing it to be mostly broken.
Maintenance_bot removed a project: Patch-For-Review.May 26 2023, 6:10 PM
gerritbot added a comment.Aug 22 2023, 3:47 PM

Change 949595 had a related patch set uploaded (by Krinkle; author: TheDJ):

[jsdoc/wmf-theme@master] Some minor search improvements

https://gerrit.wikimedia.org/r/949595

gerritbot added a project: Patch-For-Review.Aug 22 2023, 3:47 PM
gerritbot added a comment.Aug 23 2023, 12:48 PM

Change 949595 merged by jenkins-bot:

[jsdoc/wmf-theme@master] Some minor search improvements

https://gerrit.wikimedia.org/r/949595

Maintenance_bot removed a project: Patch-For-Review.Aug 23 2023, 1:11 PM
Jdforrester-WMF subscribed.Aug 23 2023, 2:09 PM

Is this now sufficiently Resolved?

Krinkle mentioned this in rJWTHa61116490de1: Some minor search improvements.Aug 23 2023, 2:49 PM
TheDJ subscribed.Aug 23 2023, 9:12 PM

I think its pretty usable now. Though likely accessibility wise, it's probably still lacking at some points.

Krinkle closed this task as Resolved.Aug 24 2023, 11:44 PM
Krinkle claimed this task.

The flickering bug still exists, but seems usable now indeed.

  1. https://doc.wikimedia.org/oojs/master/
  2. Type OO.
  3. Click elsewhere or tab out.
  4. Re-focus

Observe the field appearing and then disappearing.

Krinkle reassigned this task from Krinkle to Esanders.Aug 24 2023, 11:44 PM
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL · Credits