1343678 - Enable Web Push support in GeckoView

Status: RESOLVED FIXED

(GeckoView :: General, enhancement, P1)

Description

[James Willcox (:snorp) ([e-mail]) (he/him)]

Web Push could be a very powerful feature if exposed to GeckoView consumers. GCM is kind of a PITA in comparison (IMHO), and Android's WebView does not support it AFAIK.

I am not sure what it would really look like, but it would probably provide a way for the Service Worker to communicate with an Android service.

Comment 1

[JR Conlin [:jrconlin,:jconlin]]

I'll note that using anything other than native message support could cause the OS to trigger battery use warnings. That's one of the bigger reasons that we picked using GCM / APNs as a "bridge" system. 

There are a few other options, of course, but they come with conditions.

1) Instead of keeping a constant connection open, poll the server to see if any messages are outstanding. 
Cons: potentially high delay for message delivery compared with "native" implementations.

2) Use the bridge as a "poke" service. Send a "data-free" poke over the bridge to wake the UA to fetch messages using websocket method.
Cons: Kinda wasteful, still requires costly decryption but also now separate connection costs.

3) Use only native push service. GCM/FCM provide webpush. We could skip our own system in favor of a "pure" native implementation.
Cons: Significantly complicates future mozilla services like pushbox and broadcast.

Comment 2

[Chris Peterson [:cpeterson]]

Fenix will need GV API support for push notifications.

Comment 3

[Chris Peterson [:cpeterson]]

P3 because Barbara says Web Push is not needed for Fenix MVP.

Comment 4

[Chris Peterson [:cpeterson]]

AC issue to add an Engine component API for Web Push:
https://github.com/mozilla-mobile/android-components/issues/1919

Comment 5

[Chris Peterson [:cpeterson]]

Adding [geckoview:fenix:m7] whiteboard tag because we should figure out our Web Push plans in Q2.

Comment 6

[Jonathan Almeida [:jonalmeida]]

(In reply to Chris Peterson [:cpeterson] from comment #4)

AC issue to add an Engine component API for Web Push:
https://github.com/mozilla-mobile/android-components/issues/1919

I've closed the A-C ticket above as it was more for investigation on how a-c could support WebPush subscriptions. Now that we have some initial support, there are still some a-s dependencies that we can use to make this work.

This is a more appropriate a-c ticket to reference: https://github.com/mozilla-mobile/android-components/issues/3418

Comment 7

[Lina Butler (ex-Mozilla)]

Snorp, Jonathan, JR, and I chatted about this in Whistler. We decided on adding a delegate to handle creating, fetching, and removing push subscriptions. Consumers like Fenix could wire up this delegate to the a-s Rust Push component, or any other backend they like. We can also use the delegate to mock the push server.

Here's a sketch of the delegate, and the DOM APIs it would support:

interface PushDelegate {
  /** Creates a push subscription for the given service worker scope. A scope
    * uniquely identifies a service worker. `appServerKey` optionally
    * creates a restricted subscription
    * (http://w3c.github.io/push-api/#dom-pushmanager-subscribe,
    * http://w3c.github.io/push-api/#dom-pushsubscriptionoptionsinit-applicationserverkey) */
  GeckoResult<PushSubscription> onSubscribe(@NonNull String scope,
                                            @Nullable byte[] appServerKey);
  /** Retrieves a subscription for the given service worker scope.
    * (http://w3c.github.io/push-api/#dom-pushmanager-getsubscription) */
  GeckoResult<PushSubscription> onGetSubscription(@NonNull String scope);
  /** Removes a push subscription. Resolves with `true` if the subscription
    * was successfully removed, `false` otherwise. This is passed through to
    * the DOM API
    * (http://w3c.github.io/push-api/#dom-pushsubscription-unsubscribe). */
  GeckoResult<Boolean> onUnsubscribe(@NonNull String scope);
}

/** Push subscription info to forward to the DOM API. */
interface PushSubscription {
  // http://w3c.github.io/push-api/#dom-pushsubscription-endpoint
  @NonNull String getEndpoint();
  // http://w3c.github.io/push-api/#dom-pushsubscription-getkey, "p256dh"
  @NonNull byte[] getEncryptionKey();
  // http://w3c.github.io/push-api/#dom-pushsubscription-getkey, "auth"
  @NonNull byte[] getAuthKey();
  // http://w3c.github.io/push-api/#dom-pushsubscriptionoptions, returns the same
  // value as the optional `appServerKey` argument.
  @Nullable byte[] getAppServerKey();
}

// On ServiceWorkerManager...
class ServiceWorkerManager {
  // ...

  /** Delivers a decrypted push message to the service worker for the given scope. */
  void onPushMessageReceived(String scope, byte[] message);

  /** Fires a `pushsubscriptionchange` event for a service worker, indicating the
      worker's subscription has been lost and the worker must resubscribe. */
  void onPushSubscriptionChange(String scope);
}

Comment 8

[James Willcox (:snorp) ([e-mail]) (he/him)]

It looks to me like we may want to register a new thing here[0], but it seems like those bits really want you to look like a WebSocket or H2 type of push impl. It may be easier and/or more appropriate to implement nsIPushService[1] directly, which pretty much matches the public API we'd like to expose. It may, however, be a baby/bathwater situation.

[0] https://searchfox.org/mozilla-central/rev/c0ca77697c6868482f30af873ec8069f2c080a34/dom/push/PushService.jsm#15
[1] https://searchfox.org/mozilla-central/source/dom/interfaces/push/nsIPushService.idl

Comment 9

[Lina Butler (ex-Mozilla)]

(In reply to James Willcox (:snorp) ([e-mail]) (he/him) from comment #8)

It may be easier and/or more appropriate to implement nsIPushService[1] directly, which pretty much matches the public API we'd like to expose. It may, however, be a baby/bathwater situation.

That might be the best option. We can also add the GeckoView implementation as a different backend here—keeping PushComponents mostly as it is now, but avoiding all the funky PushService.jsm machinery.

Comment 10

[Lina Butler (ex-Mozilla)]

Though nsIPushService is pretty small, and, if we can use Messaging.jsm directly from the content process—or if we need to use it from content, anyway, to get the right event dispatcher—we wouldn't need PushServiceContent at all.

Comment 11

[Chris Peterson [:cpeterson]]

[geckoview:fenix:m7] bugs should be priority P1.

I'm editing a bunch of GeckoView bugs. If you'd like to filter all this bugmail, search and destroy emails containing this UUID:

e88a5094-0fc0-4b7c-b7c5-aef00a11dbc9

Comment 12

[[ex-Mozilla] Agi Sferro | :agi]

Attachment: Bug 1343678 - Add test-only evaluateWindowJS to run js in the page context.

Comment 13

[James Willcox (:snorp) ([e-mail]) (he/him)]

Attachment: Bug 1343678 - Enable web push pref for GeckoView

Comment 14

[James Willcox (:snorp) ([e-mail]) (he/him)]

Attachment: Bug 1343678 - Use window context for `GeckoSessionTestRule.evaluateJS()`

Comment 15

[James Willcox (:snorp) ([e-mail]) (he/him)]

Attachment: Bug 1343678 - Add WebPush support to GeckoView

Comment 16

[James Willcox (:snorp) ([e-mail]) (he/him)]

Attachment: Bug 1343678 - Allow disabling checkstyle with comments

Comment 17

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/37c92bba3e1c
Enable web push pref for GeckoView r=geckoview-reviewers,droeh
https://hg.mozilla.org/integration/autoland/rev/0bef62794abb
Use window context for `GeckoSessionTestRule.evaluateJS()` r=geckoview-reviewers,droeh
https://hg.mozilla.org/integration/autoland/rev/c22a725950f0
Add WebPush support to GeckoView r=jcj,lina,agi,geckoview-reviewers,droeh,mt

Comment 18

[Noemi Erli[:noemi_erli]]

Backed out 3 changesets (Bug 1343678) for breaking Android web platform tests CLOSED TREE

Push with failures: https://treeherder.mozilla.org/#/jobs?repo=autoland&selectedJob=263257332&resultStatus=testfailed%2Cbusted%2Cexception&revision=c22a725950f00c54b4c93dfc3facc3ca9c04e00b&searchStr=web%2Cplatform

Failure log:
https://treeherder.mozilla.org/logviewer.html#/jobs?job_id=263257332&repo=autoland&lineNumber=1281
https://treeherder.mozilla.org/logviewer.html#/jobs?job_id=263257330&repo=autoland&lineNumber=1263
https://treeherder.mozilla.org/logviewer.html#/jobs?job_id=263257340&repo=autoland&lineNumber=1248
https://treeherder.mozilla.org/logviewer.html#/jobs?job_id=263257314&repo=autoland&lineNumber=1312
https://treeherder.mozilla.org/logviewer.html#/jobs?job_id=263257320&repo=autoland&lineNumber=1295
https://treeherder.mozilla.org/logviewer.html#/jobs?job_id=263257315&repo=autoland&lineNumber=1737

Backout: https://hg.mozilla.org/integration/autoland/rev/d0859d17e38bd70a5427d590c080098a691208d1

Comment 19

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/b01343e4c2eb
Enable web push pref for GeckoView r=geckoview-reviewers,droeh,smaug
https://hg.mozilla.org/integration/autoland/rev/5010684cdca4
Use window context for `GeckoSessionTestRule.evaluateJS()` r=geckoview-reviewers,droeh
https://hg.mozilla.org/integration/autoland/rev/619e7838ebfd
Add WebPush support to GeckoView r=jcj,lina,agi,geckoview-reviewers,droeh,mt

Comment 20

[Dorel Luca [:dluca]]

Backed out 3 changesets (bug 1343678) for WPT failures on Android. CLOSED TREE

Log:
https://treeherder.mozilla.org/logviewer.html#/jobs?job_id=263920274&repo=autoland&lineNumber=7812

Push with failures:
https://treeherder.mozilla.org/#/jobs?repo=autoland&revision=619e7838ebfd94672b993d34914f3852610b2905

Backout:
https://hg.mozilla.org/integration/autoland/rev/13c98841413b119c56fafe2bbeaaa631825fdd53

Comment 21

[James Willcox (:snorp) ([e-mail]) (he/him)]

Attachment: Bug 1343678 - Ensure events expecting a reply get one even if there is no listener

Comment 22

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/3551cc55620d
Enable web push pref for GeckoView r=geckoview-reviewers,droeh,smaug
https://hg.mozilla.org/integration/autoland/rev/07b757a21222
Use window context for `GeckoSessionTestRule.evaluateJS()` r=geckoview-reviewers,droeh
https://hg.mozilla.org/integration/autoland/rev/85526faefe6d
Add WebPush support to GeckoView r=jcj,lina,agi,geckoview-reviewers,droeh,mt
https://hg.mozilla.org/integration/autoland/rev/7396789341b1
Ensure events expecting a reply get one even if there is no listener r=geckoview-reviewers,droeh,agi

Comment 23

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/4b77646bc788
Followup to fix rebase error. r=snorp

Comment 24

[Noemi Erli[:noemi_erli]]

Backed out 5 changesets (Bug 1343678) for causing multiple web-platform failures CLOSED TREE

https://treeherder.mozilla.org/#/jobs?repo=autoland&group_state=expanded&fromchange=92848bd0c1e006b7e61113d3206bc6656151e183&tochange=851753e78f79f73adeb7e488ffcc3ef76098e6b1&searchStr=android%2C7.0%2Cx86-64%2Cdebug%2Cweb%2Cplatform%2Ctests%2Ctest-android-em-7.0-x86_64%2Fdebug-geckoview-web-platform-tests-e10s-7%2Cw%28wpt7%29&selectedJob=264126354

Failure logs: https://treeherder.mozilla.org/logviewer.html#/jobs?job_id=264118841&repo=autoland&lineNumber=1530
https://treeherder.mozilla.org/logviewer.html#/jobs?job_id=264121604&repo=autoland&lineNumber=5603
https://treeherder.mozilla.org/logviewer.html#/jobs?job_id=264121633&repo=autoland&lineNumber=2952

Backout: https://hg.mozilla.org/integration/autoland/rev/6390dc77aaf0a3cb47f40227e8e0da858facdcff

Comment 25

[Chris Peterson [:cpeterson]]

Adding this bug to GV's September sprint.

Comment 26

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/b2ae7f641b2d
Enable web push pref for GeckoView r=geckoview-reviewers,droeh,smaug,jgraham
https://hg.mozilla.org/integration/autoland/rev/2c7b6826afe9
Use window context for `GeckoSessionTestRule.evaluateJS()` r=geckoview-reviewers,droeh
https://hg.mozilla.org/integration/autoland/rev/b70bcfe2473f
Add WebPush support to GeckoView r=jcj,lina,agi,geckoview-reviewers,droeh,mt
https://hg.mozilla.org/integration/autoland/rev/3dc75350ad97
Ensure events expecting a reply get one even if there is no listener r=geckoview-reviewers,droeh,agi

Comment 27

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/c0810f35c8d5
Mark a few more wpt tests as passing on Android r=me

Comment 28

[Andreea Pavel [:apavel]]

https://hg.mozilla.org/mozilla-central/rev/b2ae7f641b2d
https://hg.mozilla.org/mozilla-central/rev/2c7b6826afe9
https://hg.mozilla.org/mozilla-central/rev/b70bcfe2473f
https://hg.mozilla.org/mozilla-central/rev/3dc75350ad97
https://hg.mozilla.org/mozilla-central/rev/c0810f35c8d5

Comment 29

[Chris Peterson [:cpeterson]]

firefox70=wontfix because I assume Fenix doesn't need us to uplift Web Push to GV 70 Beta. GV 71 Nightly will ride to Beta on October 21.