1640045 - Remove PlacesSearchAutocompleteProvider.parseSubmissionURL and use Services.search.parseSubmissionURL instead, and initialize the search service at some point

Status: RESOLVED FIXED

(Firefox :: Address Bar, task, P3)

Description

[Drew Willcoxon :adw]

This is spun out from bug 1398416. Background: In that bug, we call PlacesSearchAutocompleteProvider.parseSubmissionURL from the muxer, and that method depends on PlacesSearchAutocompleteProvider being initialized, but the muxer doesn't call PlacesSearchAutocompleteProvider.ensureReady anywhere. So the muxer try-catches its call and depends on the fact that other parts of the urlbar trigger a PlacesSearchAutocompleteProvider initialization at some (early) point. We could have called ensureReady right before parseSubmissionURL, but we didn't want to make muxer.sort async due to a single one-time initialization.

However, the only thing parseSubmissionURL ultimately depends on is search service initialization, and unlike the other PlacesSearchAutocompleteProvider methods, it's sync and doesn't init the search service itself. Also, there's only one other caller of PlacesSearchAutocompleteProvider.parseSubmissionURL, in UnifiedComplete's search-restyling logic (which is disabled).

There are a couple of actions here:

• Remove PlacesSearchAutocompleteProvider.parseSubmissionURL and instead call Services.search.parseSubmissionURL directly.
• Make sure we initialize the search service at some point before the muxer calls Services.search.parseSubmissionURL. There are at least a few options:
  • Introduce an async muxer.init method that the default muxer would use to init the search service.
  • Do it as part of the very first query in the urlbar (e.g., in Query.start or UrlbarProvidersManager.startQuery).
  • The muxer isn't the only consumer of the search service in the urlbar. There's also the other methods of PlacesSearchAutocompleteProvider and the value formatter. So maybe the urlbar should init the service early on, so that each consumer doesn't need to do it. That seems tricky though because we'd still want to do it lazily, and it would still be async, so consumers likely still couldn't avoid awaiting a promise.

Comment 1

[Drew Willcoxon :adw]

Attachment: Bug 1640045 - Replace PlacesSearchAutocompleteProvider with UrlbarSearchUtils, remove its parseSubmissionURL function, and init the search service on the first query.

• Replace PlacesSearchAutocompleteProvider with UrlbarSearchUtils.
  • Move the module from toolkit to browser. The only consumers of
    PlacesSearchAutocompleteProvider are urlbar and UnifiedComplete.
  • I'd like to add functions to UrlbarUtils instead, but
    PlacesSearchAutocompleteProvider adds itself as an observer for search
    engine changes, and it keeps some state so that alias lookups are O(1). It
    has an init function to set that up. That's not quite as easy to do if I
    just added some functions to UrlbarUtils, and I think that O(1) lookups of
    aliases are worth keeping (vs. O(number of installed engines)), so I kept a
    separate module, now called UrlbarSearchUtils.
• Init the search service (via UrlbarSearchUtils) from
  UrlbarProvidersManager.startQuery so that every module involved in querying
  doesn't need to do it.

Comment 2

[Drew Willcoxon :adw]

https://treeherder.mozilla.org/#/jobs?repo=try&revision=d4133f6b0c38d7a3171213b8ec86aae6fbda7740

Comment 3

[Drew Willcoxon :adw]

https://treeherder.mozilla.org/#/jobs?repo=try&revision=04d314f5adcda166d09efb869f88c4f90dfe565e

Comment 4

[Drew Willcoxon :adw]

https://treeherder.mozilla.org/#/jobs?repo=try&revision=c75ca4ac5f7394154d50e2980d22be6013434033

Comment 5

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/58e905055fe2
Replace PlacesSearchAutocompleteProvider with UrlbarSearchUtils, remove its parseSubmissionURL function, and init the search service on the first query. r=mak

Comment 6

[Sebastian Hengst [:aryx] (needinfo me if it's about an intermittent or backout)]

https://hg.mozilla.org/mozilla-central/rev/58e905055fe2