Bug 201080

Summary:

Web Inspector: AXI: Audit: obtuse error strings

Product:

WebKit

Reporter:

gr3g

Component:

Web Inspector

Assignee:

Nobody <webkit-unassigned>

Status:

RESOLVED FIXED

Severity:

Normal

CC:

ews-watchlist, hi, inspector-bugzilla-changes, webkit-bug-importer

Priority:

Keywords:

InRadar

Version:

WebKit Nightly Build

Hardware:

All

OS:

All

Attachments:

Description	Flags
Patch	none
Patch	none
Patch	none

gr3g

Reported 2019-08-23 11:32:41 PDT

We should review these error messages, and make sure that they make sense on their own. "test will pass with" is ambiguous as to whether this is describing the state of the UI, the test results, or a suggested remedy to a failing test: This test will pass with a variety of accessibility information about the <body> element. This test will pass with all child nodes that are selected (\u0022%s\u0022) of the <body> element in the accessibility tree. This test will pass with all DOM nodes that have a computed role of \u0022link\u0022. This test will pass with all nodes controlled (\u0022%s\u0022) by the <body> element, if any exist. This test will pass with all nodes flowed to (\u0022%s\u0022) from the <body> element, if any exist. This test will pass with all nodes owned (\u0022%s\u0022) by the <body> element, if any exist. This test will pass with all of the child nodes of the <body> element in the accessibility tree. This test will pass with data indicating whether the <body> element has any click event listeners. This test will pass with data indicating whether the <body> element has any event listeners. This test will pass with somee basic information about each resource. This test will pass with the active descendant (\u0022%s\u0022) of the <body> element, if it exists. This test will pass with the contents of the main resource. This test will pass with the node that would handle mouse events for the <body> element, if applicable This test will pass with the parent node of the <body> element in the accessibility tree.

Attachments
Patch (24.80 KB, patch) 2020-09-04 16:43 PDT, gr3g	no flags	Details Formatted Diff Diff
Patch (26.27 KB, patch) 2020-09-04 17:25 PDT, gr3g	no flags	Details Formatted Diff Diff
Patch (26.87 KB, patch) 2020-09-04 17:56 PDT, gr3g	no flags	Details Formatted Diff Diff
Show Obsolete (2) View All Add attachment proposed patch, testcase, etc.

Radar WebKit Bug Importer

Comment 1 2019-08-23 11:35:12 PDT

<rdar://problem/54648118>

gr3g

Comment 2 2019-08-23 11:48:26 PDT

<rdar://problem/54554034>

gr3g

Comment 3 2020-09-04 16:43:38 PDT

Created attachment 408044 [details] Patch

Devin Rousso

Comment 4 2020-09-04 17:07:08 PDT

Comment on attachment 408044 [details] Patch View in context: https://bugs.webkit.org/attachment.cgi?id=408044&action=review r=me, with some tweaks :) > Source/WebInspectorUI/UserInterface/Controllers/AuditManager.js:1016 > ], {description: WI.UIString("These are all of the different types of data that can be returned with the test result.")}), let's be consistent with all of the group descriptions "These are example tests that demonstrate ..." > Source/WebInspectorUI/UserInterface/Controllers/AuditManager.js:1019 > + new WI.AuditTestCase("getElementsByComputedRole", removeWhitespace(getElementsByComputedRole), {description: WI.UIString("This is an example test that uses the getElementsByComputedRole method to find elements with a computed role of \u0022link\u0022."), supports: 1}), I think we should be explicit about what we mean by `getElementsByComputedRole` in that it's really `WebInspectorAudit.Accessibility.getElementsByComputedRole`. This way, developers who look at this will know exactly what it's doing and how to replicate it at a glance. WI.UIString("This is an example test that uses WebInspectorAudit.Accessibility.getElementsByComputedRole to find elements with a computed role of \u0022%s\u0022.").format(WI.unlocalizedString("link") ditto for the other functions below > Source/WebInspectorUI/UserInterface/Controllers/AuditManager.js:1029 > ], {description: WI.UIString("These tests demonstrate how to use %s to get information about the accessibility tree.").format(WI.unlocalizedString("WebInspectorAudit.Accessibility")), supports: 1}), ditto (:1016) > Source/WebInspectorUI/UserInterface/Controllers/AuditManager.js:1033 > ], {description: WI.UIString("These tests demonstrate how to use %s to get information about DOM nodes.").format(WI.unlocalizedString("WebInspectorAudit.DOM")), supports: 1}), ditto (:1016) > Source/WebInspectorUI/UserInterface/Controllers/AuditManager.js:1039 > + new WI.AuditTestCase("unsupported", removeWhitespace(unsupported), {description: WI.UIString("This is an example test that shows the %s behavior when using an unsupported method or value. This test will not run because it is unsupported.").format(WI.unlocalizedString("WebInspectorAudit")), supports: Infinity}), This description isn't accurate, as it has nothing to do with `WebInspectorAudit`. It'd be more accurate to say: "This is an example of a test that will not run because it is unsupported."

gr3g

Comment 5 2020-09-04 17:25:05 PDT

Created attachment 408051 [details] Patch

gr3g

Comment 6 2020-09-04 17:56:17 PDT

Created attachment 408056 [details] Patch

Devin Rousso

Comment 7 2020-09-05 12:43:11 PDT

Comment on attachment 408056 [details] Patch r=me

EWS

Comment 8 2020-09-05 13:10:58 PDT

Committed r266670: <https://trac.webkit.org/changeset/266670> All reviewed patches have been landed. Closing bug and clearing flags on attachment 408056 [details].

Note You need to log in before you can comment on or make changes to this bug.