1965130 - Improve JSDoc for ActionsResult

Status: RESOLVED FIXED

(Firefox :: Address Bar, task, P3)

Description

[Stephen Thompson [:sthompson]]

The ActionsResult class bundles up the data about a single result from an ActionsProvider. It's a simple bag of data but it would still be helpful to have type hints about the data types.

While writing tests for ActionsProviderTabGroups, I found it challenging to parse through an array of UrlbarResult to identify whether that actions provider actually provided anything, let alone which results it provided. I noticed that the ActionsResult class has a providerName but it's never set. I expect the intention was to have a system like how Query.add sets a providerName on the UrlbarResult. I think it would be very useful to have that on each ActionsResult, so ProviderGlobalActions.startQuery could perform that role.

Comment 1

[Stephen Thompson [:sthompson]]

Attachment: Bug 1965130 - set JSDoc types and providerName for ActionsResult r=dao

Defines and/or updates JSDoc types on all ActionsResult properties.

The pre-existing property ActionsResult.providerName never gets set. Query.add sets a providerName on UrlbarResult objects, so to follow that pattern, I made ProviderGlobalActions.startQuery responsible for setting providerName on already constructed ActionsResult instances. Having the provider name available for actions results will make it easier for tests to find relevant actions results within search results.

Comment 2

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/b52e774f82d5
set JSDoc types and providerName for ActionsResult r=urlbar-reviewers,Standard8

Comment 3

[Atila Butkovits]

https://hg.mozilla.org/mozilla-central/rev/b52e774f82d5