FxA webchannel support and account manager integration #4221

grigoryk · 2019-08-27T02:22:49Z

Part 1:

Preparatory work for allowing users to choose what to sync. We are about to
tie SyncConfig with FxA's "capabilities" webchannel API, which takes a set of
"engines" as strings. To simplify our integration work, this patch replaces an
untyped set of "stores" with a typed set of "engines" at the API level.

Part 2:

(should have been split up further for easier reviewing, but things got a bit tangled)
This patch does a few things:

adds a webextension for communicating with fxa web content
provides a backend for said webextension, which understands webchannel communication protocol
and knows how to relay messages to the account manager, and query its state
expands account manager a bit to support the webchannel authentication protocol
adds a (rather detailed!) AuthType parameter to AccountObserver:onAuthenticated, instead of the very vague 'newAccount' flag
- Closes AccountObserver: differentiate between sign-in and sign-up #4238

Pull Request checklist

Quality: This PR builds and passes detekt/ktlint checks (A pre-push hook is recommended)
Tests: This PR includes thorough tests or an explanation of why it does not
Changelog: This PR includes a changelog entry or does not need one
Accessibility: The code in this PR follows accessibility best practices or does not include any user facing features

After merge

Milestone: Make sure issues closed by this pull request are added to the milestone of the version currently in development.
Breaking Changes: If this is a breaking change, please push a draft PR on Reference Browser to address the breaking issues.

components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/Utils.kt

codecov · 2019-08-29T02:58:29Z

Codecov Report

Merging #4221 into master will increase coverage by 1.28%.
The diff coverage is 91.78%.

@@             Coverage Diff              @@
##             master    #4221      +/-   ##
============================================
+ Coverage     81.14%   82.42%   +1.28%     
+ Complexity     3981     3835     -146     
============================================
  Files           514      495      -19     
  Lines         17399    16328    -1071     
  Branches       2577     2412     -165     
============================================
- Hits          14118    13459     -659     
+ Misses         2215     1854     -361     
+ Partials       1066     1015      -51

Impacted Files	Coverage Δ	Complexity Δ
...a/components/feature/accounts/WebChannelFeature.kt	`91.78% <91.78%> (ø)`	`7 <7> (?)`
...va/mozilla/components/browser/icons/IconRequest.kt	`100% <0%> (ø)`	`5% <0%> (-1%)`	⬇️
...ozilla/components/service/fxa/SyncAuthInfoCache.kt
...a/mozilla/components/service/fxa/AccountStorage.kt
...a/mozilla/components/browser/storage/sync/Types.kt
...telemetry/measurement/ExperimentsMapMeasurement.kt
...a/components/service/fxa/FxaDeviceConstellation.kt
...nents/browser/storage/sync/PlacesHistoryStorage.kt
...mozilla/components/service/fxa/sync/StorageSync.kt
...a/components/browser/storage/sync/PlacesStorage.kt
... and 6 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e1ea6e3...01ff631. Read the comment docs.

grigoryk · 2019-08-30T02:20:06Z

Fenix side of this: mozilla-mobile/fenix#4931 (note that fxa functionality is currently running on a dev box 2).

csadilek

Looks great! Thanks for adding so many tests and comments. I've had a few comments and two small things to change (just naming), but otherwise I think this is ready.

components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/Utils.kt

components/concept/sync/src/main/java/mozilla/components/concept/sync/OAuthAccount.kt

components/feature/accounts/src/main/assets/extensions/fxawebchannel/fxawebchannel.js

...ents/feature/accounts/src/main/java/mozilla/components/feature/accounts/WebChannelFeature.kt

csadilek · 2019-09-03T15:05:24Z

...ents/feature/accounts/src/main/java/mozilla/components/feature/accounts/WebChannelFeature.kt

+         * @param engine a reference to the application's browser engine.
+         */
+        fun install(engine: Engine) {
+            engine.installWebExtension(WEB_CHANNEL_EXTENSION_ID, WEB_CHANNEL_EXTENSION_URL,


This had to bring in a lot of code from the reader view feature. I've filed #4297 to address the code duplication and come up with an abstraction.

grigoryk · 2019-09-03T22:47:35Z

@csadilek addressed your feedback.

grigoryk · 2019-09-04T01:28:51Z

reference-browser PR: mozilla-mobile/reference-browser#895

csadilek

Looks good!

We've also just started upgrading Fenix to 12.0.0, so we need to update the PR there as well and orchestrate the merge.

Preparatory work for allowing users to choose what to sync. We are about to tie SyncConfig with FxA's "capabilities" webchannel API, which takes a set of "engines" as strings. To simplify our integration work, this patch replaces an untyped set of "stores" with a typed set of "engines" at the API level.

This patch does a few things: - adds a webextension for communicating with fxa web content - provides a backend for said webextension, which understands webchannel communication protocol and knows how to relay messages to the account manager, and query its state - expands account manager a bit to support the webchannel authentication protocol - adds a (rather detailed!) AuthType parameter to AccountObserver:onAuthenticated, instead of the very vague 'newAccount' flag Co-authored-by: Arturo Mejia <arturomejiamarmol@gmail.com> Co-authored-by: vladikoff <vlad.filippov@gmail.com>

grigoryk · 2019-09-04T18:43:10Z

bors r=csadilek

4221: FxA webchannel support and account manager integration r=csadilek a=grigoryk ## Part 1: Preparatory work for allowing users to choose what to sync. We are about to tie SyncConfig with FxA's "capabilities" webchannel API, which takes a set of "engines" as strings. To simplify our integration work, this patch replaces an untyped set of "stores" with a typed set of "engines" at the API level. ## Part 2: (should have been split up further for easier reviewing, but things got a bit tangled) This patch does a few things: - adds a webextension for communicating with fxa web content - provides a backend for said webextension, which understands webchannel communication protocol and knows how to relay messages to the account manager, and query its state - expands account manager a bit to support the webchannel authentication protocol - adds a (rather detailed!) AuthType parameter to AccountObserver:onAuthenticated, instead of the very vague 'newAccount' flag - Closes #4238 Co-authored-by: Grisha Kruglov <gkruglov@mozilla.com>

vladikoff · 2019-09-04T18:58:00Z

components/feature/accounts/src/main/assets/extensions/fxawebchannel/manifest.json

+  "version": "1.0",
+  "content_scripts": [
+    {
+      "matches": ["https://acounts.firefox.com/*"],


this is missing lcip domains, we should probably include them still

vladikoff · 2019-09-04T18:58:20Z

...s/feature/accounts/src/main/java/mozilla/components/feature/accounts/FxaWebChannelFeature.kt

+     *     loaded           ------>          |                  fxa web content loaded
+     *     fxa-status       ------>          |                  web content requests account status & device capabilities
+     *        |             <------ fxa-status-response         this class responds, based on state of [accountManager]
+     *     can-link-account ------>          |                  user submitted credentials, web content verifying if account linking is allowed


can link account should ago away?

vladikoff · 2019-09-04T18:59:07Z

...s/feature/accounts/src/main/java/mozilla/components/feature/accounts/FxaWebChannelFeature.kt

+ * @property accountManager a reference to application's [FxaAccountManager].
+ */
+@Suppress("TooManyFunctions")
+class FxaWebChannelFeature(


the other class is called Firefox Accounts Auth Feature , this one just says Fxa...., does that matter?

bors · 2019-09-04T19:06:36Z

Build succeeded

Taskcluster (push)

4375: Proper 'matches' permission for webchannel extension manifest r=vladikoff a=grigoryk FxA URL was mistyped in #4221 :( ### After merge - [ ] **Milestone**: Make sure issues closed by this pull request are added to the [milestone](https://github.com/mozilla-mobile/android-components/milestones) of the version currently in development. - [ ] **Breaking Changes**: If this is a breaking change, please push a draft PR on [Reference Browser](https://github.com/mozilla-mobile/reference-browser) to address the breaking issues. Co-authored-by: Grisha Kruglov <gkruglov@mozilla.com>

4375: Proper 'matches' permission for webchannel extension manifest r=jonalmeida a=grigoryk FxA URL was mistyped in #4221 :( ### After merge - [ ] **Milestone**: Make sure issues closed by this pull request are added to the [milestone](https://github.com/mozilla-mobile/android-components/milestones) of the version currently in development. - [ ] **Breaking Changes**: If this is a breaking change, please push a draft PR on [Reference Browser](https://github.com/mozilla-mobile/reference-browser) to address the breaking issues. Co-authored-by: Grisha Kruglov <gkruglov@mozilla.com>

grigoryk mentioned this pull request Aug 27, 2019

Closes #3826: FxA WebChannel WebExtension #3881

Closed

5 tasks

grigoryk force-pushed the webchannel-support branch 5 times, most recently from 9d13484 to 140b251 Compare August 27, 2019 20:49

grigoryk mentioned this pull request Aug 28, 2019

Allow "force re auth" in FxA #4027

Closed

vladikoff reviewed Aug 28, 2019

View reviewed changes

components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/Utils.kt Outdated Show resolved Hide resolved

Amejia481 force-pushed the webchannel-support branch from 01ff631 to b5e8c43 Compare August 29, 2019 03:53

grigoryk force-pushed the webchannel-support branch 3 times, most recently from c132a96 to 34ac69e Compare August 30, 2019 02:08

grigoryk requested a review from csadilek August 30, 2019 02:10

grigoryk marked this pull request as ready for review August 30, 2019 02:15

grigoryk requested a review from a team as a code owner August 30, 2019 02:15

grigoryk mentioned this pull request Aug 30, 2019

FxA WebChannels integration mozilla-mobile/fenix#4931

Merged

csadilek suggested changes Sep 3, 2019

View reviewed changes

grigoryk mentioned this pull request Sep 3, 2019

React to WebChannel extension events to notify the SyncManager #3817

Closed

Amejia481 mentioned this pull request Sep 3, 2019

Sync: Introduce the concept of SyncEngines #3856

Closed

grigoryk force-pushed the webchannel-support branch from 34ac69e to adf4c28 Compare September 3, 2019 22:01

grigoryk requested a review from csadilek September 3, 2019 22:01

grigoryk mentioned this pull request Sep 3, 2019

Add FxA WebChannel Extension support mozilla-mobile/reference-browser#858

Closed

grigoryk mentioned this pull request Sep 4, 2019

Fix breaking changes against the current 12.0.0 snapshot. mozilla-mobile/reference-browser#895

Closed

2 tasks

csadilek approved these changes Sep 4, 2019

View reviewed changes

Grisha Kruglov and others added 2 commits September 4, 2019 11:41

Post: address review feedback and test/lint failures

f186993

grigoryk force-pushed the webchannel-support branch from adf4c28 to f186993 Compare September 4, 2019 18:42

vladikoff reviewed Sep 4, 2019

View reviewed changes

bors bot merged commit f186993 into master Sep 4, 2019

bors bot deleted the webchannel-support branch September 4, 2019 19:06

vladikoff mentioned this pull request Sep 4, 2019

feat(oauth): support Fenix WebChannels mozilla/fxa#2320

Merged

grigoryk mentioned this pull request Sep 10, 2019

Proper 'matches' permission for webchannel extension manifest #4375

Merged

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FxA webchannel support and account manager integration #4221

FxA webchannel support and account manager integration #4221

grigoryk commented Aug 27, 2019 •

edited

Loading

codecov bot commented Aug 29, 2019

grigoryk commented Aug 30, 2019

csadilek left a comment

csadilek Sep 3, 2019

grigoryk commented Sep 3, 2019

grigoryk commented Sep 4, 2019

csadilek left a comment

grigoryk commented Sep 4, 2019

vladikoff Sep 4, 2019

vladikoff Sep 4, 2019

vladikoff Sep 4, 2019

bors bot commented Sep 4, 2019

FxA webchannel support and account manager integration #4221

FxA webchannel support and account manager integration #4221

Conversation

grigoryk commented Aug 27, 2019 • edited Loading

Part 1:

Part 2:

Pull Request checklist

After merge

codecov bot commented Aug 29, 2019

Codecov Report

grigoryk commented Aug 30, 2019

csadilek left a comment

Choose a reason for hiding this comment

csadilek Sep 3, 2019

Choose a reason for hiding this comment

grigoryk commented Sep 3, 2019

grigoryk commented Sep 4, 2019

csadilek left a comment

Choose a reason for hiding this comment

grigoryk commented Sep 4, 2019

vladikoff Sep 4, 2019

Choose a reason for hiding this comment

vladikoff Sep 4, 2019

Choose a reason for hiding this comment

vladikoff Sep 4, 2019

Choose a reason for hiding this comment

bors bot commented Sep 4, 2019

Build succeeded

grigoryk commented Aug 27, 2019 •

edited

Loading