summaryrefslogtreecommitdiffstats
path: root/toolkit/components/search/AppProvidedSearchEngine.sys.mjs
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-15 03:34:42 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-15 03:34:42 +0000
commitda4c7e7ed675c3bf405668739c3012d140856109 (patch)
treecdd868dba063fecba609a1d819de271f0d51b23e /toolkit/components/search/AppProvidedSearchEngine.sys.mjs
parentAdding upstream version 125.0.3. (diff)
downloadfirefox-da4c7e7ed675c3bf405668739c3012d140856109.tar.xz
firefox-da4c7e7ed675c3bf405668739c3012d140856109.zip
Adding upstream version 126.0.upstream/126.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'toolkit/components/search/AppProvidedSearchEngine.sys.mjs')
-rw-r--r--toolkit/components/search/AppProvidedSearchEngine.sys.mjs253
1 files changed, 229 insertions, 24 deletions
diff --git a/toolkit/components/search/AppProvidedSearchEngine.sys.mjs b/toolkit/components/search/AppProvidedSearchEngine.sys.mjs
index 7401ba115c..ed815b96d1 100644
--- a/toolkit/components/search/AppProvidedSearchEngine.sys.mjs
+++ b/toolkit/components/search/AppProvidedSearchEngine.sys.mjs
@@ -9,6 +9,8 @@ import {
EngineURL,
} from "resource://gre/modules/SearchEngine.sys.mjs";
+import { XPCOMUtils } from "resource://gre/modules/XPCOMUtils.sys.mjs";
+
const lazy = {};
ChromeUtils.defineESModuleGetters(lazy, {
@@ -16,14 +18,56 @@ ChromeUtils.defineESModuleGetters(lazy, {
SearchUtils: "resource://gre/modules/SearchUtils.sys.mjs",
});
+XPCOMUtils.defineLazyServiceGetter(
+ lazy,
+ "idleService",
+ "@mozilla.org/widget/useridleservice;1",
+ "nsIUserIdleService"
+);
+
+// After the user has been idle for 30s, we'll update icons if we need to.
+const ICON_UPDATE_ON_IDLE_DELAY = 30;
+
/**
* Handles loading application provided search engine icons from remote settings.
*/
class IconHandler {
- #iconList = null;
+ /**
+ * The remote settings client for the search engine icons.
+ *
+ * @type {?RemoteSettingsClient}
+ */
#iconCollection = null;
/**
+ * The list of icon records from the remote settings collection.
+ *
+ * @type {?object[]}
+ */
+ #iconList = null;
+
+ /**
+ * A flag that indicates if we have queued an idle observer to update icons.
+ *
+ * @type {boolean}
+ */
+ #queuedIdle = false;
+
+ /**
+ * A map of pending updates that need to be applied to the engines. This is
+ * keyed via record id, so that if multiple updates are queued for the same
+ * record, then we will only update the engine once.
+ *
+ * @type {Map<string, object>}
+ */
+ #pendingUpdatesMap = new Map();
+
+ constructor() {
+ this.#iconCollection = lazy.RemoteSettings("search-config-icons");
+ this.#iconCollection.on("sync", this._onIconListUpdated.bind(this));
+ }
+
+ /**
* Returns the icon for the record that matches the engine identifier
* and the preferred width.
*
@@ -40,14 +84,9 @@ class IconHandler {
await this.#getIconList();
}
- let iconRecords = this.#iconList.filter(r => {
- return r.engineIdentifiers.some(i => {
- if (i.endsWith("*")) {
- return engineIdentifier.startsWith(i.slice(0, -1));
- }
- return engineIdentifier == i;
- });
- });
+ let iconRecords = this.#iconList.filter(r =>
+ this._identifierMatches(engineIdentifier, r.engineIdentifiers)
+ );
if (!iconRecords.length) {
console.warn("No icon found for", engineIdentifier);
@@ -66,28 +105,110 @@ class IconHandler {
}
}
- let iconURL;
+ let iconData;
try {
- iconURL = await this.#iconCollection.attachments.get(iconRecord);
+ iconData = await this.#iconCollection.attachments.get(iconRecord);
} catch (ex) {
console.error(ex);
- return null;
}
- if (!iconURL) {
+ if (!iconData) {
console.warn("Unable to find the icon for", engineIdentifier);
+ // Queue an update in case we haven't downloaded it yet.
+ this.#pendingUpdatesMap.set(iconRecord.id, iconRecord);
+ this.#maybeQueueIdle();
return null;
}
+
+ if (iconData.record.last_modified != iconRecord.last_modified) {
+ // The icon we have stored is out of date, queue an update so that we'll
+ // download the new icon.
+ this.#pendingUpdatesMap.set(iconRecord.id, iconRecord);
+ this.#maybeQueueIdle();
+ }
return URL.createObjectURL(
- new Blob([iconURL.buffer]),
+ new Blob([iconData.buffer]),
iconRecord.attachment.mimetype
);
}
+ QueryInterface = ChromeUtils.generateQI(["nsIObserver"]);
+
+ /**
+ * Called when there is an update queued and the user has been observed to be
+ * idle for ICON_UPDATE_ON_IDLE_DELAY seconds.
+ *
+ * This will always download new icons (added or updated), even if there is
+ * no current engine that matches the identifiers. This is to ensure that we
+ * have pre-populated the cache if the engine is added later for this user.
+ *
+ * We do not handle deletes, as remote settings will handle the cleanup of
+ * removed records. We also do not expect the case where an icon is removed
+ * for an active engine.
+ *
+ * @param {nsISupports} subject
+ * The subject of the observer.
+ * @param {string} topic
+ * The topic of the observer.
+ */
+ async observe(subject, topic) {
+ if (topic != "idle") {
+ return;
+ }
+
+ this.#queuedIdle = false;
+ lazy.idleService.removeIdleObserver(this, ICON_UPDATE_ON_IDLE_DELAY);
+
+ // Update the icon list, in case engines will call getIcon() again.
+ await this.#getIconList();
+
+ let appProvidedEngines = await Services.search.getAppProvidedEngines();
+ for (let record of this.#pendingUpdatesMap.values()) {
+ let iconData;
+ try {
+ iconData = await this.#iconCollection.attachments.download(record);
+ } catch (ex) {
+ console.error("Could not download new icon", ex);
+ continue;
+ }
+
+ for (let engine of appProvidedEngines) {
+ await engine.maybeUpdateIconURL(
+ record.engineIdentifiers,
+ URL.createObjectURL(
+ new Blob([iconData.buffer]),
+ record.attachment.mimetype
+ )
+ );
+ }
+ }
+
+ this.#pendingUpdatesMap.clear();
+ }
+
+ /**
+ * Checks if the identifier matches any of the engine identifiers.
+ *
+ * @param {string} identifier
+ * The identifier of the engine.
+ * @param {string[]} engineIdentifiers
+ * The list of engine identifiers to match against. This can include
+ * wildcards at the end of strings.
+ * @returns {boolean}
+ * Returns true if the identifier matches any of the engine identifiers.
+ */
+ _identifierMatches(identifier, engineIdentifiers) {
+ return engineIdentifiers.some(i => {
+ if (i.endsWith("*")) {
+ return identifier.startsWith(i.slice(0, -1));
+ }
+ return identifier == i;
+ });
+ }
+
/**
* Obtains the icon list from the remote settings collection.
*/
async #getIconList() {
- this.#iconCollection = lazy.RemoteSettings("search-config-icons");
try {
this.#iconList = await this.#iconCollection.get();
} catch (ex) {
@@ -98,6 +219,41 @@ class IconHandler {
console.error("Failed to obtain search engine icon list records");
}
}
+
+ /**
+ * Called via a callback when remote settings updates the icon list. This
+ * stores potential updates and queues an idle observer to apply them.
+ *
+ * @param {object} payload
+ * The payload from the remote settings collection.
+ * @param {object} payload.data
+ * The payload data from the remote settings collection.
+ * @param {object[]} payload.data.created
+ * The list of created records.
+ * @param {object[]} payload.data.updated
+ * The list of updated records.
+ */
+ async _onIconListUpdated({ data: { created, updated } }) {
+ created.forEach(record => {
+ this.#pendingUpdatesMap.set(record.id, record);
+ });
+ for (let record of updated) {
+ if (record.new) {
+ this.#pendingUpdatesMap.set(record.new.id, record.new);
+ }
+ }
+ this.#maybeQueueIdle();
+ }
+
+ /**
+ * Queues an idle observer if there are pending updates.
+ */
+ #maybeQueueIdle() {
+ if (this.#pendingUpdatesMap && !this.#queuedIdle) {
+ this.#queuedIdle = true;
+ lazy.idleService.addIdleObserver(this, ICON_UPDATE_ON_IDLE_DELAY);
+ }
+ }
}
/**
@@ -113,19 +269,28 @@ export class AppProvidedSearchEngine extends SearchEngine {
static iconHandler = new IconHandler();
/**
- * @typedef {?Promise<string>}
- * A promise for the blob URL of the icon. We save the promise to avoid
- * reentrancy issues.
+ * A promise for the blob URL of the icon. We save the promise to avoid
+ * reentrancy issues.
+ *
+ * @type {?Promise<string>}
*/
#blobURLPromise = null;
/**
- * @typedef {?string}
- * The identifier from the configuration.
+ * The identifier from the configuration.
+ *
+ * @type {?string}
*/
#configurationId = null;
/**
+ * Whether or not this is a general purpose search engine.
+ *
+ * @type {boolean}
+ */
+ #isGeneralPurposeSearchEngine = false;
+
+ /**
* @param {object} options
* The options for this search engine.
* @param {object} options.config
@@ -231,11 +396,15 @@ export class AppProvidedSearchEngine extends SearchEngine {
return true;
}
+ /**
+ * Whether or not this engine is a "general" search engine, e.g. is it for
+ * generally searching the web, or does it have a specific purpose like
+ * shopping.
+ *
+ * @returns {boolean}
+ */
get isGeneralPurposeEngine() {
- return !!(
- this._extensionID &&
- lazy.SearchUtils.GENERAL_SEARCH_ENGINE_IDS.has(this._extensionID)
- );
+ return this.#isGeneralPurposeSearchEngine;
}
/**
@@ -258,6 +427,36 @@ export class AppProvidedSearchEngine extends SearchEngine {
}
/**
+ * This will update the icon URL for the search engine if the engine
+ * identifier matches the given engine identifiers.
+ *
+ * @param {string[]} engineIdentifiers
+ * The engine identifiers to check against.
+ * @param {string} blobURL
+ * The new icon URL for the search engine.
+ */
+ async maybeUpdateIconURL(engineIdentifiers, blobURL) {
+ // TODO: Bug 1875912. Once newSearchConfigEnabled has been enabled, we will
+ // be able to use `this.id` instead of `this.#configurationId`. At that
+ // point, `IconHandler._identifierMatches` can be made into a private
+ // function, as this if statement can be handled within `IconHandler.observe`.
+ if (
+ !AppProvidedSearchEngine.iconHandler._identifierMatches(
+ this.#configurationId,
+ engineIdentifiers
+ )
+ ) {
+ return;
+ }
+ if (this.#blobURLPromise) {
+ URL.revokeObjectURL(await this.#blobURLPromise);
+ this.#blobURLPromise = null;
+ }
+ this.#blobURLPromise = Promise.resolve(blobURL);
+ lazy.SearchUtils.notifyAction(this, lazy.SearchUtils.MODIFIED_TYPE.CHANGED);
+ }
+
+ /**
* Creates a JavaScript object that represents this engine.
*
* @returns {object}
@@ -283,6 +482,12 @@ export class AppProvidedSearchEngine extends SearchEngine {
#init(engineConfig) {
this._orderHint = engineConfig.orderHint;
this._telemetryId = engineConfig.identifier;
+ this.#isGeneralPurposeSearchEngine =
+ engineConfig.classification == "general";
+
+ if (engineConfig.charset) {
+ this._queryCharset = engineConfig.charset;
+ }
if (engineConfig.telemetrySuffix) {
this._telemetryId += `-${engineConfig.telemetrySuffix}`;