firefox-main/browser/components/urlbar/private/WikipediaSuggestions.sys.mjs (file symbol)

Source code

Revision control

Copy as Markdown

Other Tools

/* 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 { SuggestProvider } from "moz-src:///browser/components/urlbar/private/SuggestFeature.sys.mjs";
const lazy = {};
ChromeUtils.defineESModuleGetters(lazy, {
QuickSuggest: "moz-src:///browser/components/urlbar/QuickSuggest.sys.mjs",
UrlbarResult: "moz-src:///browser/components/urlbar/UrlbarResult.sys.mjs",
UrlbarUtils: "moz-src:///browser/components/urlbar/UrlbarUtils.sys.mjs",
});
/**
* A feature that manages Wikipedia suggestions, both offline (Rust) and online
* (Merino).
*/
export class WikipediaSuggestions extends SuggestProvider {
get enablingPreferences() {
return [
"wikipediaFeatureGate",
"suggest.wikipedia",
"suggest.quicksuggest.all",
];
}
get primaryUserControlledPreferences() {
return ["suggest.wikipedia"];
}
get merinoProvider() {
return "wikipedia";
}
get rustSuggestionType() {
return "Wikipedia";
}
isSuggestionSponsored() {
return false;
}
getSuggestionTelemetryType(suggestion) {
// Previously online Wikipedia suggestions were not managed by this feature
// and they had a separate telemetry type, so we carry that forward here.
return suggestion.source == "merino" ? "wikipedia" : "adm_nonsponsored";
}
makeResult(queryContext, suggestion) {
// Note that Rust uses camelCase, Merino uses snake_case.
return new lazy.UrlbarResult({
type: lazy.UrlbarUtils.RESULT_TYPE.URL,
source: lazy.UrlbarUtils.RESULT_SOURCE.SEARCH,
isNovaSuggestion: true,
richSuggestionIconSize: 16,
payload: {
url: suggestion.url,
title: suggestion.fullKeyword ?? suggestion.full_keyword,
subtitle: suggestion.title,
bottomTextL10n: {
id: "urlbar-result-suggestion-recommended",
},
},
});
}
/**
* Gets the list of commands that should be shown in the result menu for a
* given result from the provider. All commands returned by this method should
* be handled by implementing `onEngagement()` with the possible exception of
* commands automatically handled by the urlbar, like "help".
*/
getResultCommands() {
return [
{
name: "dismiss",
l10n: {
id: "urlbar-result-menu-dismiss-suggestion",
},
},
{ name: "separator" },
{
name: "manage",
l10n: {
id: "urlbar-result-menu-manage-firefox-suggest",
},
},
];
}
onEngagement(queryContext, controller, details, _searchString) {
let { result } = details;
// Handle commands. These suggestions support the Dismissal and Manage
// commands. Dismissal is the only one we need to handle here. `UrlbarInput`
// handles Manage.
if (details.selType == "dismiss") {
lazy.QuickSuggest.dismissResult(result);
controller.removeResult(result);
}
}
}