1819093 - Revise SearchService's OpenSearch mechanism to reduce unnecessary wake ups

Status: RESOLVED FIXED

(Firefox :: Search, defect, P3)

Description

[Mark Banner (:standard8)]

Currently the search service has a permanent timer that will trigger every 6 hours to check for updates to OpenSearch engines.

The vast majority of users do not have OpenSearch engines installed. Additionally, only a small percentage of OpenSearch defined engines have updates available. Hence most of the time this wake up is unnecessary.

We should:

• Only register an update timer when we know there's a search engine installed that has updates.
  • We can handle the dynamic registration with the functions on nsIUpdateTimerManager.
• Increase the trigger interval to at most once every 24 hours.
  • https://searchfox.org/mozilla-central/rev/a3a9112d4d73d1323eabbc7faa9937cd9aae6465/toolkit/components/search/SearchService.sys.mjs#3490-3492

Comment 1

[Mark Banner (:standard8)]

Attachment: Bug 1819093 - Rework test_opensearch_update.js to avoid having to manually set an update URL. r?mcheang!

Comment 2

[Mark Banner (:standard8)]

Attachment: Bug 1819093 - Reduce unnecessary wake-ups caused by the SearchService's OpenSearch update mechanism. r?mcheang!

This stops the timer being registered if there are no OpenSearch engines installed with updates.
This also reduces the timer checks to once per day, rather than every 6 hours.

The timer does not get removed, as it is considered that removing an OpenSearch engine is a rare option and so the timer can remain until shutdown.

Depends on D171325

Comment 3

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/a44650eb4094
Rework test_opensearch_update.js to avoid having to manually set an update URL. r=mcheang
https://hg.mozilla.org/integration/autoland/rev/0ebcef1f64fc
Reduce unnecessary wake-ups caused by the SearchService's OpenSearch update mechanism. r=mcheang

Comment 4

[Natalia Csoregi [:nataliaCs]]

Backed out for causing bustage due to toolkitsearch.manifest

• backout: https://hg.mozilla.org/integration/autoland/rev/7f81a11d5359ef6933dd432e60f695721599ac5c
• push: https://treeherder.mozilla.org/jobs?repo=autoland&group_state=expanded&revision=0ebcef1f64fc3c6bcd7e3d5ec197a6468aa54941
• failure log: https://treeherder.mozilla.org/logviewer?job_id=408107865&repo=autoland&lineNumber=94119

[task 2023-03-07T10:15:43.069Z] 10:15:43     INFO -  package> /builds/worker/workspace/obj-build/_virtualenvs/build/bin/python /builds/worker/checkouts/gecko/toolkit/mozapps/installer/packager.py -DPKG_LOCALE_MANIFEST=/builds/worker/workspace/obj-build/browser/installer/locale-manifest.in -DMOZ_APP_NAME=firefox -DPREF_DIR=defaults/preferences[..] -DU_USING_ICU_NAMESPACE=0 -DWASM_HAS_HEAPREG=1 -DXP_DARWIN=1 -DXP_MACOSX=1 -DXP_UNIX=1 -DAB_CD=en-US \
[task 2023-03-07T10:15:43.069Z] 10:15:43     INFO -  package> 	--format omni \
[task 2023-03-07T10:15:43.069Z] 10:15:43     INFO -  package> 	--removals /builds/worker/checkouts/gecko/browser/installer/removed-files.in \
[task 2023-03-07T10:15:43.069Z] 10:15:43     INFO -  package> 	 \
[task 2023-03-07T10:15:43.069Z] 10:15:43     INFO -  package> 	 \
[task 2023-03-07T10:15:43.070Z] 10:15:43     INFO -  package> 	--minify \
[task 2023-03-07T10:15:43.070Z] 10:15:43     INFO -  package> 	 \
[task 2023-03-07T10:15:43.070Z] 10:15:43     INFO -  package> 	 \
[task 2023-03-07T10:15:43.070Z] 10:15:43     INFO -  package> 	--compress none \
[task 2023-03-07T10:15:43.070Z] 10:15:43     INFO -  package> 	/builds/worker/checkouts/gecko/browser/installer/package-manifest.in '../../dist' '../../dist'/firefox \
[task 2023-03-07T10:15:43.070Z] 10:15:43     INFO -  package>
[task 2023-03-07T10:15:43.071Z] 10:15:43     INFO -  package> error: $SRCDIR/browser/installer/package-manifest.in:174: Missing file(s): Firefox Nightly.app/Contents/Resources/components/toolkitsearch.manifest
[task 2023-03-07T10:15:43.071Z] 10:15:43    ERROR -  package> Traceback (most recent call last):
[task 2023-03-07T10:15:43.071Z] 10:15:43     INFO -  package>   File "/builds/worker/checkouts/gecko/toolkit/mozapps/installer/packager.py", line 295, in <module>
[task 2023-03-07T10:15:43.071Z] 10:15:43     INFO -  package>     main()
[task 2023-03-07T10:15:43.072Z] 10:15:43     INFO -  package>   File "/builds/worker/checkouts/gecko/toolkit/mozapps/installer/packager.py", line 252, in main
[task 2023-03-07T10:15:43.072Z] 10:15:43     INFO -  package>     copier.add(mozpath.join(respath, "removed-files"), removals)
[task 2023-03-07T10:15:43.072Z] 10:15:43     INFO -  package>   File "/usr/lib/python3.9/contextlib.py", line 124, in __exit__
[task 2023-03-07T10:15:43.072Z] 10:15:43     INFO -  package>     next(self.gen)
[task 2023-03-07T10:15:43.072Z] 10:15:43     INFO -  package>   File "/builds/worker/checkouts/gecko/python/mozbuild/mozpack/errors.py", line 143, in accumulate
[task 2023-03-07T10:15:43.073Z] 10:15:43     INFO -  package>     raise AccumulatedErrors()
[task 2023-03-07T10:15:43.073Z] 10:15:43     INFO -  package> mozpack.errors.AccumulatedErrors
[task 2023-03-07T10:15:43.073Z] 10:15:43    ERROR -  package> gmake[5]: *** [/builds/worker/checkouts/gecko/toolkit/mozapps/installer/packager.mk:25: stage-package] Error 1

Comment 5

[mac198442]

Seems this line "@RESPATH@/components/toolkitsearch.manifest" should be removed from browser/installer/package-manifest.in.

Seems also for comm-central the equivalent change needs to be made to:

mail/installer/package-manifest.in and
suite/installer/package-manifest.in.

Comment 6

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/d2022340dc6d
Rework test_opensearch_update.js to avoid having to manually set an update URL. r=mcheang
https://hg.mozilla.org/integration/autoland/rev/f0fa441a142a
Reduce unnecessary wake-ups caused by the SearchService's OpenSearch update mechanism. r=mcheang

Comment 7

[Mark Banner (:standard8)]

Thank you, but I have already fixed this which is why I cleared the NI originally. comm-central changes are typically handled separately.

Comment 8

[mac198442]

Sorry, when I tried to go to the bug Firefox stupidly took me to a tab where i already had it opened
rather than reloading the page. I hate this "feature"

Comment 9

[mac198442]

I disabled switch to tab in urlbar search. Switching to tab would be fine if it reloaded to current contents which it does NOT.

Comment 10

[Sandor Molnar[:smolnar]]

https://hg.mozilla.org/mozilla-central/rev/d2022340dc6d
https://hg.mozilla.org/mozilla-central/rev/f0fa441a142a

Comment 11

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/comm-central/rev/38e9ec58f515
Adjust Thunderbird for bug 1819093 - Revise SearchService's OpenSearch mechanism to reduce unnecessary wake ups. rs=me