1973315 - Refactor AppProvided Engine vs UserInstalledAppEngine

Status: RESOLVED FIXED

(Firefox :: Search, task, P3)

Description

[Mandy Cheang [:mcheang][she/her]]

Context

In AppProvidedSearchEngine.sys.mjs, we currently have both AppProvidedSearchEngine and UserInstalledAppEngine defined in the same file. This is pretty confusing because "app-provided" should mean the engine is bundled with Firefox. Users shouldn't be able to install something that’s considered "app-provided." However, we now have a feature where users can install "app-provided" engines through contextual search.

Problem

The terminology has started to blur. Right now, AppProvidedSearchEngine and UserInstalledAppEngine are lumped together even though they represent different concepts. We need a clearer separation between engines that are pre-bundled with Firefox and those installed by users.

Solution

AppProvidedSearchEngine and UserInstalledAppEngine are engines from search-config-v2. That's the common theme.
We can introduce a ConfigEngine base class that both app-provided and user-installed config-based engines can extend. Something like:

                  SearchEngine
                       |
                  ConfigEngine
                   /       \
AppProvidedConfigEngine   UserInstalledConfigEngine

Follow-ups / Cleanup

• All instances of UserInstalledAppEngine should be renamed to something more accurate, such as UserInstalledConfigEngine
  → UserInstalledAppEngine references
• We could also consider removing nsISearchEngine. The use of engine.wrappedJSObject feels unnecessary and kind of a nuisance at this point
  → nsISearchEngine

Comment 1

[Moritz Beier [:mbeier]]

Attachment: Bug 1973315 - Refactor AppProvided Engine vs UserInstalledAppEngine. r?standard8

Comment 2

[Pulsebot]

Pushed by [e-mail]:
https://github.com/mozilla-firefox/firefox/commit/20c99a090617
https://hg.mozilla.org/integration/autoland/rev/4a797b6be43b
Refactor AppProvided Engine vs UserInstalledAppEngine. r=Standard8,urlbar-reviewers,mcheang

Comment 3

[Cristian Tuns]

https://hg.mozilla.org/mozilla-central/rev/4a797b6be43b