firefox-main/browser/components/urlbar/private/AddonSuggestions.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, {
AddonManager: "resource://gre/modules/AddonManager.sys.mjs",
QuickSuggest: "moz-src:///browser/components/urlbar/QuickSuggest.sys.mjs",
UrlbarPrefs: "moz-src:///browser/components/urlbar/UrlbarPrefs.sys.mjs",
UrlbarResult: "moz-src:///browser/components/urlbar/UrlbarResult.sys.mjs",
UrlbarUtils: "moz-src:///browser/components/urlbar/UrlbarUtils.sys.mjs",
});
const UTM_PARAMS = {
utm_medium: "firefox-desktop",
utm_source: "firefox-suggest",
};
const RESULT_MENU_COMMAND = {
DISMISS: "dismiss",
MANAGE: "manage",
NOT_INTERESTED: "not_interested",
SHOW_LESS_FREQUENTLY: "show_less_frequently",
};
/**
* A feature that supports Addon suggestions.
*/
export class AddonSuggestions extends SuggestProvider {
get enablingPreferences() {
return ["addonsFeatureGate", "suggest.addons", "suggest.quicksuggest.all"];
}
get primaryUserControlledPreferences() {
return ["suggest.addons"];
}
get merinoProvider() {
return "amo";
}
get rustSuggestionType() {
return "Amo";
}
async makeResult(queryContext, suggestion, searchString) {
if (!this.isEnabled) {
// The feature is disabled on the client, but Merino may still return
// addon suggestions anyway, and we filter them out here.
return null;
}
if (
this.showLessFrequentlyCount &&
searchString.length < this.#minKeywordLength
) {
return null;
}
const { guid } =
suggestion.source === "merino"
? suggestion.custom_details.amo
: suggestion;
const addon = await lazy.AddonManager.getAddonByID(guid);
if (addon) {
// Addon suggested is already installed.
return null;
}
// Set UTM params unless they're already defined. This allows remote
// settings or Merino to override them if need be.
let url = new URL(suggestion.url);
for (let [key, value] of Object.entries(UTM_PARAMS)) {
if (!url.searchParams.has(key)) {
url.searchParams.set(key, value);
}
}
return new lazy.UrlbarResult({
type: lazy.UrlbarUtils.RESULT_TYPE.URL,
source: lazy.UrlbarUtils.RESULT_SOURCE.SEARCH,
isBestMatch: true,
isNovaSuggestion: true,
suggestedIndex: 1,
richSuggestionIconSize: 24,
payload: {
url: url.href,
originalUrl: suggestion.url,
// Rust uses `iconUrl` but Merino uses `icon`.
icon: suggestion.iconUrl ?? suggestion.icon,
title: suggestion.title,
subtitleL10n: { id: "urlbar-result-addons-subtitle" },
description: suggestion.description,
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() {
/** @type {UrlbarResultCommand[]} */
const commands = [];
if (this.canShowLessFrequently) {
commands.push({
name: RESULT_MENU_COMMAND.SHOW_LESS_FREQUENTLY,
l10n: {
id: "urlbar-result-menu-show-less-frequently",
},
});
}
commands.push(
{
name: RESULT_MENU_COMMAND.DISMISS,
l10n: {
id: "urlbar-result-menu-dismiss-suggestion",
},
},
{
name: RESULT_MENU_COMMAND.NOT_INTERESTED,
l10n: {
id: "firefox-suggest-command-dont-show-addons",
},
},
{ name: "separator" },
{
name: RESULT_MENU_COMMAND.MANAGE,
l10n: {
id: "urlbar-result-menu-manage-firefox-suggest",
},
}
);
return commands;
}
onEngagement(queryContext, controller, details, searchString) {
let { result } = details;
switch (details.selType) {
case RESULT_MENU_COMMAND.MANAGE:
// "manage" is handled by UrlbarInput, no need to do anything here.
break;
// selType == "dismiss" when the user presses the dismiss key shortcut.
case RESULT_MENU_COMMAND.DISMISS:
lazy.QuickSuggest.dismissResult(result);
result.acknowledgeDismissalL10n = {
id: "firefox-suggest-dismissal-acknowledgment-one",
};
controller.removeResult(result);
break;
case RESULT_MENU_COMMAND.NOT_INTERESTED:
lazy.UrlbarPrefs.set("suggest.addons", false);
result.acknowledgeDismissalL10n = {
id: "urlbar-result-dismissal-acknowledgment-all",
};
controller.removeResult(result);
break;
case RESULT_MENU_COMMAND.SHOW_LESS_FREQUENTLY:
controller.view.acknowledgeFeedback(result);
this.incrementShowLessFrequentlyCount();
if (!this.canShowLessFrequently) {
controller.view.invalidateResultMenuCommands();
}
lazy.UrlbarPrefs.set(
"addons.minKeywordLength",
searchString.length + 1
);
break;
}
}
incrementShowLessFrequentlyCount() {
if (this.canShowLessFrequently) {
lazy.UrlbarPrefs.set(
"addons.showLessFrequentlyCount",
this.showLessFrequentlyCount + 1
);
}
}
get showLessFrequentlyCount() {
const count = lazy.UrlbarPrefs.get("addons.showLessFrequentlyCount") || 0;
return Math.max(count, 0);
}
get canShowLessFrequently() {
const cap =
lazy.UrlbarPrefs.get("addonsShowLessFrequentlyCap") ||
lazy.QuickSuggest.config.showLessFrequentlyCap ||
0;
return !cap || this.showLessFrequentlyCount < cap;
}
get #minKeywordLength() {
let minLength = lazy.UrlbarPrefs.get("addons.minKeywordLength");
return Math.max(minLength, 0);
}
}