44aeb0a311
This patch makes it unnecessary for most features to have to override `shouldEnable`. Instead, the Suggest framework will check `enablingPreferences` plus a new property called `additionalEnablingPredicate`. Summary: * Include Nimbus variables in `enablingPreferences` * Add a new property to `SuggestFeature` called `additionalEnablingPredicate` * Make `shouldEnable` call `enablingPreferences` and `additionalEnablingPredicate` * Remove `shouldEnable` implementations on most features Differential Revision: https://phabricator.services.mozilla.com/D235251
86 lines
2.8 KiB
JavaScript
86 lines
2.8 KiB
JavaScript
/* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
|
|
|
import { SuggestBackend } from "resource:///modules/urlbar/private/SuggestFeature.sys.mjs";
|
|
|
|
const lazy = {};
|
|
|
|
ChromeUtils.defineESModuleGetters(lazy, {
|
|
MLSuggest: "resource:///modules/urlbar/private/MLSuggest.sys.mjs",
|
|
QuickSuggest: "resource:///modules/QuickSuggest.sys.mjs",
|
|
});
|
|
|
|
/**
|
|
* The Suggest ML backend. Both the ML and Rust backends can be enabled at the
|
|
* same time. Features can support both backends and decide which one to use per
|
|
* query.
|
|
*/
|
|
export class SuggestBackendMl extends SuggestBackend {
|
|
get enablingPreferences() {
|
|
return ["quickSuggestMlEnabled", "browser.ml.enable"];
|
|
}
|
|
|
|
async enable(enabled) {
|
|
if (enabled) {
|
|
this.logger.debug("Initializing MLSuggest...");
|
|
await lazy.MLSuggest.initialize();
|
|
this.logger.debug("MLSuggest is now initialized");
|
|
} else {
|
|
this.logger.debug("Shutting down MLSuggest...");
|
|
await lazy.MLSuggest.shutdown();
|
|
this.logger.debug("MLSuggest is now shut down");
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Queries `MLSuggest` and returns the matching suggestion.
|
|
*
|
|
* @param {string} searchString
|
|
* The search string.
|
|
* @param {object} options
|
|
* Options object.
|
|
* @param {UrlbarQueryContext} options.queryContext
|
|
* The query context.
|
|
* @returns {Array}
|
|
* An array of matching suggestions. `MLSuggest` returns at most one
|
|
* suggestion.
|
|
*/
|
|
async query(searchString, { queryContext }) {
|
|
// `MLSuggest` requires the query to be trimmed and lowercase, which
|
|
// the original `searchString` isn't necessarily.
|
|
searchString = queryContext.trimmedLowerCaseSearchString;
|
|
|
|
this.logger.debug("Handling query", { searchString });
|
|
|
|
// Don't waste time calling into `MLSuggest` if no ML intents are enabled.
|
|
if (
|
|
lazy.QuickSuggest.mlFeatures
|
|
.values()
|
|
.every(f => !f.isEnabled || !f.isMlIntentEnabled)
|
|
) {
|
|
this.logger.debug("No ML intents enabled, ignoring query");
|
|
return [];
|
|
}
|
|
|
|
let suggestion = await lazy.MLSuggest.makeSuggestions(searchString);
|
|
this.logger.debug("Got suggestion", suggestion);
|
|
|
|
if (suggestion?.intent) {
|
|
// `MLSuggest` doesn't have a way to return only enabled intents, so it
|
|
// can return disabled ones and even ones we don't recognize. Discard the
|
|
// suggestion in those cases.
|
|
let feature = lazy.QuickSuggest.getFeatureByMlIntent(suggestion.intent);
|
|
if (!feature?.isEnabled || !feature?.isMlIntentEnabled) {
|
|
this.logger.debug("No ML feature for suggestion, ignoring query");
|
|
return [];
|
|
}
|
|
suggestion.source = "ml";
|
|
suggestion.provider = suggestion.intent;
|
|
return [suggestion];
|
|
}
|
|
|
|
return [];
|
|
}
|
|
}
|