1837078 - Refactor the Translations actor to remove memory footprint, and increase performance

Status: RESOLVED FIXED

(Firefox :: Translations, task, P1)

Description

[Greg Tatum [:gregtatum]]

We need to move more work to the parent and lazy load everything in the child. In addition, we need to memoize everything in the parent so that work isn't done over and over on every page load.

This will hopefully address Bug 1836039 and Bug 1836467.

Comment 1

[Greg Tatum [:gregtatum]]

Attachment: Bug 1837078 - Fix race condition in the translations button event handler; r?nordzilla!

Since there is an await in the code, this handler became racy. Checking
the id ensures that only the most recent event is used. This was causing
some automated tests to fail when I changed the underlying
implementation.

Depends on D180468

Comment 2

[Greg Tatum [:gregtatum]]

Attachment: Bug 1837078 - Correct incorrect test assertions in translations test; r?nordzilla!

Depends on D180469

Comment 3

[Greg Tatum [:gregtatum]]

Attachment: Bug 1837078 - Micro-optimize translation prefs; r?nordzilla!

This probably isn't too important, but Set.prototype.has is faster
than Array.prototoype.includes. The setters are probably more
expensive, but those aren't in hot paths. This change would only be
noticeable if the lists got longer, but even with only a few items in
the list, .has is faster.

Depends on D180470

Comment 4

[Greg Tatum [:gregtatum]]

Attachment: Bug 1837078 - Break out the engine payload loading into a method with profiler markers; r?nordzilla!

Depends on D180471

Comment 5

[Greg Tatum [:gregtatum]]

Attachment: Bug 1837078 - Simplify the isRestrictedPage to use the scheme; r?nordzilla!

Depends on D180472

Comment 6

[Greg Tatum [:gregtatum]]

Attachment: Bug 1837078 - Cache the language id model record in the TranslationsParent; r?nordzilla!

Depends on D180473

Comment 7

[Greg Tatum [:gregtatum]]

Attachment: Bug 1837078 - Cache translation model records; r?nordzilla!

Depends on D180474

Comment 8

[Greg Tatum [:gregtatum]]

Attachment: Bug 1837078 - Cache the language id wasm record in the TranslationsParent; r?nordzilla!

Depends on D180475

Comment 9

[Greg Tatum [:gregtatum]]

Attachment: Bug 1837078 - Cache the bergamot wasm record in the TranslationsParent; r?nordzilla!

Depends on D180476

Comment 10

[Greg Tatum [:gregtatum]]

Attachment: Bug 1837078 - Cache the language pairs in the TranslationsParent; r?nordzilla!

Depends on D180477

Comment 11

[Greg Tatum [:gregtatum]]

Attachment: Bug 1837078 - Use the content principal information in the TranslationsParent; r?nordzilla!

Depends on D180478

Comment 12

[Greg Tatum [:gregtatum]]

Attachment: Bug 1837078 - Naively split out engine files into separate modules; r?nordzilla!

This will have some eslint errors, and not run correctly, but it makes
the following diff much clearer for what is new code, and what is moved
code.

Depends on D180479

Comment 13

[Greg Tatum [:gregtatum]]

Attachment: Bug 1837078 - Move logic for identifying languages into a lazy loaded module; r?nordzilla!

Depends on D180480

Comment 14

[Greg Tatum [:gregtatum]]

Attachment: Bug 1837078 - Remove as much logic as possible from the TranslationsChild; r?nordzilla

Any JS code (including comments) gets loaded into content process memory
for every single content process that is loaded. This patch tries to
reduce this burden as much as possible by moving things into either the
TranslationsParent, or into lazily loaded modules in the child.

This patch also changes the engine caching logic to only allow 1 engine
cache at a time. I was struggling porting over the existing cache to this
strategy, and this felt like a much simpler solution.

Depends on D180481

Comment 15

[Greg Tatum [:gregtatum]]

Attachment: Bug 1837078 - Detect when the Translations actor is destroyed during async work; r?nordzilla!

Depends on D180482

Comment 16

[Greg Tatum [:gregtatum]]

Attachment: Bug 1837078 - Do not report errors when the language id engine fails to download; r?nordzilla!

Depends on D180847

Comment 17

[Greg Tatum [:gregtatum]]

Attachment: Bug 1837078 - Do not get language id payload if the page is hidden; r?nordzilla!

This also removes some dead code around clearing the language tag, and
properly lists the required events for the TranslationsChild. I guess
that code was never even running, and I tests it manually after removing
it.

Depends on D180848

Comment 18

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/e06f6601bd46
Fix race condition in the translations button event handler; r=nordzilla
https://hg.mozilla.org/integration/autoland/rev/267c8b09163a
Correct incorrect test assertions in translations test; r=nordzilla
https://hg.mozilla.org/integration/autoland/rev/6dbd9581b622
Micro-optimize translation prefs; r=nordzilla
https://hg.mozilla.org/integration/autoland/rev/2c11cf745b67
Break out the engine payload loading into a method with profiler markers; r=nordzilla
https://hg.mozilla.org/integration/autoland/rev/e2c376ce8337
Simplify the isRestrictedPage to use the scheme; r=nordzilla
https://hg.mozilla.org/integration/autoland/rev/b698293af16a
Cache the language id model record in the TranslationsParent; r=nordzilla
https://hg.mozilla.org/integration/autoland/rev/847a4fccbb63
Cache translation model records; r=nordzilla
https://hg.mozilla.org/integration/autoland/rev/07dd77f0fa2b
Cache the language id wasm record in the TranslationsParent; r=nordzilla
https://hg.mozilla.org/integration/autoland/rev/b04e59be41cd
Cache the bergamot wasm record in the TranslationsParent; r=nordzilla
https://hg.mozilla.org/integration/autoland/rev/406ab7121048
Cache the language pairs in the TranslationsParent; r=nordzilla
https://hg.mozilla.org/integration/autoland/rev/c30b954c1f48
Use the content principal information in the TranslationsParent; r=nordzilla
https://hg.mozilla.org/integration/autoland/rev/47593c037f71
Naively split out engine files into separate modules; r=nordzilla
https://hg.mozilla.org/integration/autoland/rev/2d423bdf9b9a
Move logic for identifying languages into a lazy loaded module; r=nordzilla
https://hg.mozilla.org/integration/autoland/rev/464b57aa51cb
Remove as much logic as possible from the TranslationsChild; r=nordzilla
https://hg.mozilla.org/integration/autoland/rev/c0776a2926de
Detect when the Translations actor is destroyed during async work; r=nordzilla
https://hg.mozilla.org/integration/autoland/rev/72c0e162e5a8
Do not report errors when the language id engine fails to download; r=nordzilla
https://hg.mozilla.org/integration/autoland/rev/e7efea009a6c
Do not get language id payload if the page is hidden; r=nordzilla

Comment 19

[Narcis Beleuzu [:NarcisB]]

Backed out for bc failures on browser_test_mixed_content_download.js

Backout link: https://hg.mozilla.org/integration/autoland/rev/36b6a21c7806bf54d03adf205da6f7bcf537d95d
Log link: https://treeherder.mozilla.org/logviewer?job_id=419223471&repo=autoland&lineNumber=10279

Comment 20

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/9ecac650e6fa
Fix race condition in the translations button event handler; r=nordzilla
https://hg.mozilla.org/integration/autoland/rev/cda00c714446
Correct incorrect test assertions in translations test; r=nordzilla
https://hg.mozilla.org/integration/autoland/rev/f90402ee929c
Micro-optimize translation prefs; r=nordzilla
https://hg.mozilla.org/integration/autoland/rev/33c5c63fb8be
Break out the engine payload loading into a method with profiler markers; r=nordzilla
https://hg.mozilla.org/integration/autoland/rev/177dbec0fb98
Simplify the isRestrictedPage to use the scheme; r=nordzilla
https://hg.mozilla.org/integration/autoland/rev/b727be4caaa6
Cache the language id model record in the TranslationsParent; r=nordzilla
https://hg.mozilla.org/integration/autoland/rev/9d2c3ef9ebf3
Cache translation model records; r=nordzilla
https://hg.mozilla.org/integration/autoland/rev/ba3465f86326
Cache the language id wasm record in the TranslationsParent; r=nordzilla
https://hg.mozilla.org/integration/autoland/rev/5268b542e1c6
Cache the bergamot wasm record in the TranslationsParent; r=nordzilla
https://hg.mozilla.org/integration/autoland/rev/facbc44bba8c
Cache the language pairs in the TranslationsParent; r=nordzilla
https://hg.mozilla.org/integration/autoland/rev/4efd0a919db3
Use the content principal information in the TranslationsParent; r=nordzilla
https://hg.mozilla.org/integration/autoland/rev/7b9f3e6ac0ed
Naively split out engine files into separate modules; r=nordzilla
https://hg.mozilla.org/integration/autoland/rev/7da78f67d716
Move logic for identifying languages into a lazy loaded module; r=nordzilla
https://hg.mozilla.org/integration/autoland/rev/3df1f1fd5e1c
Remove as much logic as possible from the TranslationsChild; r=nordzilla
https://hg.mozilla.org/integration/autoland/rev/ccd6c3d67650
Detect when the Translations actor is destroyed during async work; r=nordzilla
https://hg.mozilla.org/integration/autoland/rev/a503e6e1f6f4
Do not report errors when the language id engine fails to download; r=nordzilla
https://hg.mozilla.org/integration/autoland/rev/a0a479ff9216
Do not get language id payload if the page is hidden; r=nordzilla

Comment 21

[Noemi Erli[:noemi_erli]]

https://hg.mozilla.org/mozilla-central/rev/9ecac650e6fa
https://hg.mozilla.org/mozilla-central/rev/cda00c714446
https://hg.mozilla.org/mozilla-central/rev/f90402ee929c
https://hg.mozilla.org/mozilla-central/rev/33c5c63fb8be
https://hg.mozilla.org/mozilla-central/rev/177dbec0fb98
https://hg.mozilla.org/mozilla-central/rev/b727be4caaa6
https://hg.mozilla.org/mozilla-central/rev/9d2c3ef9ebf3
https://hg.mozilla.org/mozilla-central/rev/ba3465f86326
https://hg.mozilla.org/mozilla-central/rev/5268b542e1c6
https://hg.mozilla.org/mozilla-central/rev/facbc44bba8c
https://hg.mozilla.org/mozilla-central/rev/4efd0a919db3
https://hg.mozilla.org/mozilla-central/rev/7b9f3e6ac0ed
https://hg.mozilla.org/mozilla-central/rev/7da78f67d716
https://hg.mozilla.org/mozilla-central/rev/3df1f1fd5e1c
https://hg.mozilla.org/mozilla-central/rev/ccd6c3d67650
https://hg.mozilla.org/mozilla-central/rev/a503e6e1f6f4
https://hg.mozilla.org/mozilla-central/rev/a0a479ff9216