Bug 1924175 - support service= URL param in fxa oauth flows. r=lina

Differential Revision: https://phabricator.services.mozilla.com/D225401

services/fxaccounts/FxAccountsConfig.sys.mjs

@@ -343,10 +343,14 @@ export var FxAccountsConfig = {
   },
 
   async _getAuthParams() {
+    let params = { service: SYNC_PARAM };
     if (this._isOAuthFlow()) {
       const scopes = [SCOPE_APP_SYNC, SCOPE_PROFILE];
-      return lazy.fxAccounts._internal.beginOAuthFlow(scopes);
+      Object.assign(
+        params,
+        await lazy.fxAccounts._internal.beginOAuthFlow(scopes)
+      );
     }
-    return { service: SYNC_PARAM };
+    return params;
   },
 };

services/fxaccounts/FxAccountsWebChannel.sys.mjs

@@ -553,15 +553,14 @@ FxAccountsWebChannelHelpers.prototype = {
   async oauthLogin(oauthData) {
     log.debug("Webchannel is completing the oauth flow");
     const xps = await this._initializeSync();
-    const { code, state, declinedSyncEngines, offeredSyncEngines } = oauthData;
     const { sessionToken } =
       await this._fxAccounts._internal.getUserAccountData(["sessionToken"]);
     // First we finish the ongoing oauth flow
     const { scopedKeys, refreshToken } =
       await this._fxAccounts._internal.completeOAuthFlow(
         sessionToken,
-        code,
-        state
+        oauthData.code,
+        oauthData.state
       );
 
     // We don't currently use the refresh token in Firefox Desktop, lets be good citizens and revoke it.
@@ -572,9 +571,26 @@ FxAccountsWebChannelHelpers.prototype = {
 
     // Now that we have the scoped keys, we set our status to verified
     await this._fxAccounts._internal.setUserVerified();
-    this._setEnabledEngines(offeredSyncEngines, declinedSyncEngines);
-    log.debug("Webchannel is enabling sync");
-    xps.Weave.Service.configure();
+    // And work out what should be enabled.
+    const services = oauthData.services;
+    log.trace("Webchannel is enabling services", services);
+    if (services) {
+      if (services.sync) {
+        // User has enabled Sync.
+        log.debug("Webchannel is enabling sync");
+        const { offeredEngines, declinedEngines } = services.sync;
+        this._setEnabledEngines(offeredEngines, declinedEngines);
+        xps.Weave.Service.configure();
+      }
+    } else {
+      // To support fxa before it knew to send `services`, we assume it missing means "enable sync" and that the top-level
+      // payload has `offeredSyncEngines` and `declinedSyncEngines`
+      // TODO: remove this branch as soon as the above branch starts working - only old FxA servers need this!
+      const { declinedSyncEngines, offeredSyncEngines } = oauthData;
+      log.debug("Webchannel is enabling sync (deprecated message format");
+      this._setEnabledEngines(offeredSyncEngines, declinedSyncEngines);
+      xps.Weave.Service.configure();
+    }
   },
 
   /**

services/fxaccounts/tests/xpcshell/head.js

@@ -27,6 +27,27 @@ const MOCK_ACCOUNT_KEYS = {
   },
 };
 
+function ensureOauthConfigured() {
+  Services.prefs.setBoolPref("identity.fxaccounts.oauth.enabled", true);
+  Services.prefs.setStringPref(
+    "identity.fxaccounts.contextParam",
+    "oauth_webchannel_v1"
+  );
+}
+
+function ensureOauthNotConfigured() {
+  Services.prefs.setBoolPref("identity.fxaccounts.oauth.enabled", false);
+  Services.prefs.setStringPref(
+    "identity.fxaccounts.contextParam",
+    "fx_desktop_v3"
+  );
+}
+
+function resetOauthConfig() {
+  Services.prefs.clearUserPref("identity.fxaccounts.oauth.enabled");
+  Services.prefs.clearUserPref("identity.fxaccounts.contextParam");
+}
+
 (function initFxAccountsTestingInfrastructure() {
   do_get_profile();
 

services/fxaccounts/tests/xpcshell/test_accounts_config.js

@@ -9,6 +9,7 @@ const { FxAccounts } = ChromeUtils.importESModule(
 
 add_task(
   async function test_non_https_remote_server_uri_with_requireHttps_false() {
+    ensureOauthNotConfigured();
     Services.prefs.setStringPref("identity.fxaccounts.autoconfig.uri", "");
     Services.prefs.setBoolPref("identity.fxaccounts.allowHttp", true);
     Services.prefs.setStringPref(
@@ -20,8 +21,19 @@ add_task(
       "http://example.com/?context=fx_desktop_v3&entrypoint=test&action=email&service=sync"
     );
 
+    ensureOauthConfigured();
+    let url = new URL(await FxAccounts.config.promiseConnectAccountURI("test"));
+    Assert.equal(url.host, "example.com");
+    Assert.equal(url.searchParams.get("context"), "oauth_webchannel_v1");
+    Assert.equal(url.searchParams.get("service"), "sync");
+    Assert.equal(url.searchParams.get("entrypoint"), "test");
+    Assert.equal(url.searchParams.get("action"), "email");
+    Assert.equal(url.searchParams.get("client_id"), "5882386c6d801776");
+    Assert.equal(url.searchParams.get("response_type"), "code");
+
     Services.prefs.clearUserPref("identity.fxaccounts.remote.root");
     Services.prefs.clearUserPref("identity.fxaccounts.allowHttp");
+    resetOauthConfig();
   }
 );
 
@@ -57,3 +69,23 @@ add_task(async function test_is_production_config() {
   Assert.ok(!FxAccounts.config.isProductionConfig());
   Services.prefs.clearUserPref("identity.sync.tokenserver.uri");
 });
+
+add_task(async function test_promise_account_service_param() {
+  ensureOauthNotConfigured();
+  Assert.equal(
+    await FxAccounts.config.promiseConnectAccountURI("test", {
+      service: "custom-service",
+    }),
+    "https://accounts.firefox.com/?context=fx_desktop_v3&entrypoint=test&action=email&service=custom-service"
+  );
+  ensureOauthConfigured();
+  let url = new URL(
+    await FxAccounts.config.promiseConnectAccountURI("test", {
+      service: "custom-service",
+    })
+  );
+  Assert.equal(url.searchParams.get("context"), "oauth_webchannel_v1");
+  Assert.equal(url.searchParams.get("client_id"), "5882386c6d801776");
+  Assert.equal(url.searchParams.get("service"), "custom-service");
+  resetOauthConfig();
+});

services/fxaccounts/tests/xpcshell/test_web_channel.js

@@ -956,6 +956,7 @@ add_task(async function test_helpers_getFxAStatus_extra_engines() {
     },
   });
 
+  ensureOauthNotConfigured();
   Services.prefs.setBoolPref(
     "services.sync.engine.creditcards.available",
     true
@@ -965,7 +966,46 @@ add_task(async function test_helpers_getFxAStatus_extra_engines() {
   let fxaStatus = await helpers.getFxaStatus("sync", mockSendingContext);
   ok(!!fxaStatus);
   ok(!!fxaStatus.signedInUser);
+  // in the non-oauth flows we only expect "extra" engines.
   deepEqual(fxaStatus.capabilities.engines, ["creditcards"]);
+  resetOauthConfig();
+});
+
+add_task(async function test_helpers_getFxAStatus_engines_oauth() {
+  let helpers = new FxAccountsWebChannelHelpers({
+    fxAccounts: {
+      _internal: {
+        getUserAccountData() {
+          return Promise.resolve({
+            email: "testuser@testuser.com",
+            sessionToken: "sessionToken",
+            uid: "uid",
+            verified: true,
+          });
+        },
+      },
+    },
+    privateBrowsingUtils: {
+      isBrowserPrivate: () => true,
+    },
+  });
+
+  ensureOauthConfigured();
+  let fxaStatus = await helpers.getFxaStatus("sync", mockSendingContext);
+  ok(!!fxaStatus);
+  ok(!!fxaStatus.signedInUser);
+  // in the oauth flows we expect all engines.
+  deepEqual(fxaStatus.capabilities.engines, [
+    "addons",
+    "addresses",
+    "bookmarks",
+    "creditcards",
+    "history",
+    "passwords",
+    "preferences",
+    "tabs",
+  ]);
+  resetOauthConfig();
 });
 
 add_task(async function test_helpers_getFxaStatus_allowed_signedInUser() {