1826245 - Convert ReaderView ([e-mail]) extension to event pages

Status: RESOLVED FIXED

(Fenix :: Browser Engine, task, P2)

Description

[Chris Peterson [:cpeterson]]

The ReaderView ([e-mail]) extension must be updated to use event pages because it currently uses persistent background pages or scripts, which will be incompatible with the extension process.

How to convert an extension using a persistent background script to event pages:

https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Background_scripts#convert_to_non-persistent

The background script stores data in a local variable (Map). This won’t work well when the background script is terminated. A storage API (session) should be used instead.

Comment 1

[Luca Greco [:rpl] [:luca] [:lgreco]]

Attachment: DRAFT - port readerview@ac persistent background page to an event page

I have just gave a quick try to convert [e-mail] from a persistent background script to an event page, as mentioned in comment 0 the only detail that needed to be adjusted is the Map kept in the background page to be using storage.session API instead.

I have then used the STRs we have put together for QA to verify the behaviors on the extension process crashes to verify that:
- the readerview event page is being suspended on idle as expected
- webpages recognized as articles successfully switch to reader mode before a crash
- and then after a crash, confirm that:
  - an existing tab in readerview mode is shown the usual "tab crashed UI" available on Fenix, and clicking "Restore tab" does restore the tab in readerview mode as it was before the process crashed
  - clicked the readerview mode on a tab that was not in readerview mode, does spawn the event page and switch the tab to the readermode view as expected

The attached patch includes the diff with the current set of changes I've applied locally.

Comment 2

[Luca Greco [:rpl] [:luca] [:lgreco]]

Attachment: OK

(was same as comment 1, duplicated by mistake).

Comment 3

[Luca Greco [:rpl] [:luca] [:lgreco]]

Attachment: diff --git a/android

(was same as comment 1, duplicated by mistake).

Comment 4

[Luca Greco [:rpl] [:luca] [:lgreco]]

Attachment: diff --git a/android

(was same as comment 1, duplicated by mistake).

Comment 5

[BMO Github Automation]

Attachment: [mozilla-mobile/firefox-android] Bug 1826245 - Convert ReaderView ([e-mail]) built-in extension to event pages. (#3217)

Comment 6

[Luca Greco [:rpl] [:luca] [:lgreco]]

Comment on attachment 9348391 [details]
DRAFT - port readerview@ac persistent background page to an event page

superseded by the pull request attached in comment 5.

Comment 7

[BMO Github Automation]

Authored by https://github.com/rpl
https://github.com/mozilla-mobile/firefox-android/commit/37f6f8b7d5434d88cac81db6ae3d966fa0bbdc43
[main] Bug 1826245 - Convert ReaderView ([e-mail]) built-in extension to event pages.