Add some brokers #1609

shane-tomlinson · 2014-08-29T19:27:52Z

This is for @nchapman, @zaach, @vladikoff and @ckarlof. These are the first brokers, see what you think!

feat(client): Add some brokers!

Start to add brokers that know how to startup/complete flows.
3 brokers to start, fx-desktop, redirect, web-channel.
Get rid of the Channels high level abstraction, these are used directly by the brokers if needed.
Move some code from service-mixin and various channels to brokers.
Update tests to make use of the brokers.

vladikoff · 2014-08-29T19:32:15Z

app/scripts/lib/app-start.js


+    initializeBroker: function () {
+      if (this._searchParam('context') === 'fx_desktop_v1') {


Didn't we have a constant for this?

This seems awfully specific. Can we tweak this to use the Constants.FX_DESKTOP_CONTEXT const?

$ grep -irn "fx_desktop_v1" . | grep -v "./$dist\|.tmp$/" ./app/scripts/lib/constants.js:15: FX_DESKTOP_CONTEXT: 'fx_desktop_v1', ./tests/server/metrics-collector-stderr.js:60: assert.equal(loggedMetrics.context, 'fx_desktop_v1'); ./tests/server/metrics-collector-stderr.js:89: context: 'fx_desktop_v1', ./tests/tools/firefox_profile_creator.js:26: myProfile.setPreference('identity.fxaccounts.remote.force_auth.uri', profile.fxaContentRoot + 'force_auth?service=sync&context=fx_desktop_v1'); ./tests/tools/firefox_profile_creator.js:27: myProfile.setPreference('identity.fxaccounts.remote.signin.uri', profile.fxaContentRoot + 'signin?service=sync&context=fx_desktop_v1'); ./tests/tools/firefox_profile_creator.js:28: myProfile.setPreference('identity.fxaccounts.remote.signup.uri', profile.fxaContentRoot + 'signup?service=sync&context=fx_desktop_v1'); $ grep -irn "Constants.FX_DESKTOP_CONTEXT" . | grep -v "./$dist\|.tmp$/" ./app/scripts/lib/session.js:140: return this.get('context') === Constants.FX_DESKTOP_CONTEXT; ./app/scripts/views/settings.js:28: showSignOut: Session.get('sessionTokenContext') !== Constants.FX_DESKTOP_CONTEXT ./app/scripts/views/sign_in.js:106: if (Session.get('context') !== Constants.FX_DESKTOP_CONTEXT) { ./app/tests/spec/lib/app-start.js:29: return '?context=' + Constants.FX_DESKTOP_CONTEXT; ./app/tests/spec/lib/router.js:67: windowMock.location.search = '?context=' + Constants.FX_DESKTOP_CONTEXT; ./app/tests/spec/lib/router.js:69: assert.equal(navigateUrl, '/forgot?context=' + Constants.FX_DESKTOP_CONTEXT); ./app/tests/spec/views/settings.js:78: Session.set('sessionTokenContext', Constants.FX_DESKTOP_CONTEXT); ./tests/functional/settings.js:80: .get(require.toUrl(SIGNIN_URL + '?context=' + Constants.FX_DESKTOP_CONTEXT))

Plus, now looking through those beautiful greps, not sure if it would help to have some isDesktopContext() helper function since it seems like we're doing some variation of this in at least 3 places now:

if (this._searchParam('context') === 'fx_desktop_v1') {...}

Actually, it looks like we have one in /app/scripts/lib/session.js:139:

isDesktopContext: function () { return this.get('context') === Constants.FX_DESKTOP_CONTEXT; },

So, the idea is that the broker knows that it is in the desktop context and everything else has no need to know, and isDesktopContext can be ripped out of Session. I'll update to use the named string from Constants.

pdehaan · 2014-08-29T20:15:31Z

app/scripts/models/brokers/broker.js

+    },
+
+    /**
+     * Initialize the Session. Perhaps should be merged into `fetch`


Perhaps should be merged into fetch

My eyes say "docs comment", but my heart almost says "TODO".

ಠ_ಠ

Good catch.

pdehaan · 2014-08-29T20:24:57Z

app/tests/spec/views/sign_up.js

+    beforeEach(function () {
+      Session.clear();
+
+      email = 'testuser.' + Math.random() + '@testuser.com';


Should be:

email = TestHelpers.createEmail();

See #1608

pdehaan · 2014-08-29T20:34:50Z

app/tests/spec/views/sign_up.js

+
+      view.remove();
+      view.destroy();
+      document.cookie = 'tooyoung=1; expires=Thu, 01-Jan-1970 00:00:01 GMT';


This looks very similar to line 439 above. Not sure if we should move this hardcoded cookie string somewhere higher into a constant or helper somewhere.

$ grep -irn "tooyoung=1" app

Results:

app/scripts/views/clear_storage.js:24:

document.cookie = 'tooyoung=1; expires=Thu, 01-Jan-1970 00:00:01 GMT';

app/scripts/views/sign_up.js:173:

document.cookie = 'tooyoung=1;';

app/tests/spec/views/sign_up.js:53:

document.cookie = 'tooyoung=1; expires=Thu, 01-Jan-1970 00:00:01 GMT';

app/tests/spec/views/sign_up.js:76:

document.cookie = 'tooyoung=1; expires=Thu, 01-Jan-1970 00:00:01 GMT';

Something like TOO_YOUNG_COOKIE = 'tooyoung=1; expires=Thu, 01-Jan-1970 00:00:01 GMT'; in /app/scripts/lib/constants.js and then in the src we could just use it as document.cookie = Constants.TOO_YOUNG_COOKIE; (or whatever).

pdehaan · 2014-08-29T20:39:58Z

app/tests/spec/views/sign_up.js

+            [200, { 'Content-Type': 'application/json' }, JSON.stringify({ verfied: false })]);
+
+        var nowYear = (new Date()).getFullYear();
+        fillOutSignUp(email, 'password', { year: nowYear - 14, context: view });


This also strikes me as a bit weird (all this nowYear - 14 and nowYear - 13 business in each test).
Not sure if we want to do this as constants at the top of the file or something. I counted 10 instances of var nowYear in this file alone.

(Probably out of the scope of this PR, but the eyes see what the eyes see.)

shane-tomlinson · 2014-09-08T10:09:00Z

app/scripts/lib/app-start.js

@@ -110,10 +115,26 @@ function (
    },

    initializeRelier: function () {
-      this._relier = new Relier();
+      this._relier = new Relier({


Perhaps we should be able to pass in both a Relier and a Broker on object creation for testing.

shane-tomlinson · 2014-09-08T10:12:43Z

app/scripts/models/brokers/fx-desktop.js

+      this._window = options.window || window;
+
+      this._channel = new FxDesktopChannel();
+      this._channel.init({


Probably not for this PR, but I'm starting to be confused by a mixture of startup paradigms. In some places our objects use init, in others initialize. When an object follows the Backbone conventions, it uses initialize and configuration is passed to the constructor instead of in a separate call to init.

init is my fault. We should probably standardize on initialize to make our lives easier.

pdehaan · 2014-09-08T17:39:35Z

Do we need to tweak the PR title for the benefit of our changelog?

shane-tomlinson · 2014-09-08T19:09:20Z

Do we need to tweak the PR title for the benefit of our changelog?

@pdehaan - ya. I'll do that once we move a bit further through this.

shane-tomlinson · 2014-09-15T15:30:14Z

Remaining work:

- Do not stop app from starting if response to session_context is not received. This will maintain backwards compatibility.

shane-tomlinson · 2014-09-15T15:30:51Z

app/scripts/models/brokers/post-message.js

+
+'use strict';
+
+define([


This isn't used yet, so get rid of it.

coveralls · 2014-09-15T15:40:18Z

Coverage decreased (-0.06%) when pulling 4bf50b2 on add-a-broker into a23ca63 on master.

nchapman · 2014-09-17T21:39:59Z

app/scripts/models/brokers/fx-desktop.js

+    },
+
+    _isForceAuth: function () {
+      // XXX is this the correct place for this?


It probably depends where all we need to answer this question. If it's only in this module, then this is probably fine, but it seems like we might need to answer the same question in different contexts.

nchapman · 2014-09-17T21:41:59Z

app/scripts/models/brokers/fx-desktop.js

+
+    _isForceAuth: function () {
+      // XXX is this the correct place for this?
+      return this._window.location.pathname === '/force_auth';


I'm thinking it would be nice to figure out what kinds of data Brokers need and pass those into the constructor instead of it having to reach into window for random bits of data.

nchapman · 2014-09-17T21:56:20Z

app/scripts/models/brokers/fx-desktop.js

+          Session.clear();
+          // XXX does this go here, or into the Relier?
+          // forceAuth is only used for the FxDesktop Sync flow.
+          Session.set('forceAuth', true);


What ends up consuming this from the Session?. It would be ideal if the consumer could query the Broker directly.

ckarlof · 2014-10-30T04:28:46Z

app/scripts/models/auth_brokers/base.js

+    /**
+     * Transform the signin/signup links if necessary
+     */
+    transformLink: function (link) {


I prefer decorate vs transform here, personally.

ckarlof · 2014-10-30T04:32:14Z

@shane-tomlinson, this needs a rebase.

It's looking good.

I ideally want to finishing reviewing this tomorrow, but I have meetings from 9am-5pm. I hopefully can get to it at 5pm. Otherwise, I'll fight to reclaim time! Friday I'm off, so I hope this doesn't drag on to next week.

shane-tomlinson · 2014-10-30T17:55:16Z

app/scripts/views/ready.js

-    submit: function () {
-      var self = this;
-      return p().then(function () {
-        if (self.isOAuthSameBrowser()) {


Check whether the Loop flow should finish the OAuth flow in the verification tab if the user closes/replaces the original tab. If so, we may need to re-introduce the afterSignUpVerified and afterResetPasswordVerified (or similar) functions to the brokers and let the brokers coordinate as they see fit.

…up, closes original tab, and opens the verification link in the same browser. This is to add additional coverage to prepare for the add-a-broker branch. Additional work: * Reduce duplication in the web channel tests by calling the fillOutSignUp and fillOutSignIn FunctionalHelpers.

…mplete password reset forms.

* Start to add brokers that know how to startup/complete flows. * 5 brokers to start, base, oauth, fx-desktop, redirect, web-channel. * Get rid of the Channels high level abstraction, these are used directly by the brokers if needed. * Move some code from service-mixin and various channels to brokers. * Update tests to make use of the brokers. * No longer save forceEmail to Session, get it from the relier. * Remove the `signIn` from `completeResetPassword` in the FxaClient, this is now done in the views. * No longer call `signIn` from `changePassword` in the FxaClient, this is now handled by the views. This allows the signature of `changePassword` to be much smaller. * Move the re-link check from fxa-client to the views to allow finer grained control over when they are presented. * Remove Session.forceAuth handling from fxa-client.js, this is now stored in relier.email * Create a search-params mixin in models/mixins. * Migrate signin/signup/verification finishing code from service-mixin to the brokers so each broker can do their own thing. * Really shrink service-mixin to a bare bare minimum, fix the unit tests, make sure all the current functional tests pass. * Extract a ChannelMixin for use by the brokers.

…ow sends OAuth credentials after the reset password is complete when the original tab is closed. fixes #1825

ckarlof · 2014-11-04T00:09:54Z

app/scripts/models/auth_brokers/base.js

+     *
+     * @return {promise}
+     */
+    afterResetPasswordConfirmationPoll: function () {


Possible we can get rid of this: #1838

ckarlof · 2014-11-04T00:14:47Z

app/scripts/models/auth_brokers/base.js

+     *
+     * @return {promise}
+     */
+    afterSignUpConfirmationPoll: function () {


Possible we can get rid of this: #1839

ckarlof · 2014-11-04T00:16:33Z

app/scripts/models/auth_brokers/base.js

+     *
+     * @return {promise}
+     */
+    afterCompleteSignUp: function () {


Possible we can get rid of this: #1839

ckarlof · 2014-11-04T00:19:08Z

app/scripts/models/auth_brokers/base.js

+     *
+     * @return {promise}
+     */
+    afterCompleteResetPassword: function () {


Possible we can get ride of this: #1838

Maybe not because it usually does nothing, except for the WebChannel flow, in which case, it finishes the OAuth flow. Let's keep it.

ckarlof · 2014-11-04T00:29:19Z

app/scripts/views/oauth_sign_up.js

-        oAuthClient: options.oAuthClient
-      });
-    },
-
    afterRender: function () {


Wow, these two oauth views are looking pretty slim. Do we have them just to call this.setupOAuthLinks()?

ckarlof · 2014-11-04T00:42:58Z

app/tests/spec/lib/fxa-client.js

-      client = new FxaClientWrapper({
-        channel: channelMock
-      });
+      client = new FxaClientWrapper();


nice! terrible mixing of concerns previously.

ckarlof · 2014-11-04T00:50:24Z

@shane-tomlinson, I have a few final comments, and I created issues for those that could be addressed after the initial merge.

INCOMING!

Add some brokers

vladikoff reviewed Aug 29, 2014
View changes

pdehaan reviewed Aug 29, 2014
View changes

app/tests/spec/views/sign_up.js Outdated

beforeEach(function () {

Session.clear();

email = 'testuser.' + Math.random() + '@testuser.com';

This comment has been minimized.

Sign in to view

pdehaan Aug 29, 2014
Contributor

Should be:

email = TestHelpers.createEmail();

See #1608

pdehaan reviewed Aug 29, 2014
View changes

This was referenced Sep 4, 2014

Channel redux #1514

Closed

Less flat global state, more encapsulated models given to views #1511

Closed

shane-tomlinson force-pushed the add-a-broker branch 2 times, most recently from 2181d6d to dabf10e Sep 8, 2014

shane-tomlinson reviewed Sep 8, 2014
View changes

shane-tomlinson force-pushed the add-a-broker branch from 13ba35e to 4151dac Sep 8, 2014

nchapman self-assigned this Sep 8, 2014

nchapman modified the milestones: train-21 (Sep 8), train-22 (Sep 22) Sep 8, 2014

ckarlof added in review and removed in review labels Sep 10, 2014

shane-tomlinson force-pushed the add-a-broker branch from 4151dac to 4bf50b2 Sep 15, 2014

shane-tomlinson reviewed Sep 15, 2014
View changes

app/scripts/models/brokers/post-message.js Outdated

'use strict';

define([

This comment has been minimized.

Sign in to view

shane-tomlinson Sep 15, 2014
Author Member

This isn't used yet, so get rid of it.

nchapman reviewed Sep 17, 2014
View changes

shane-tomlinson mentioned this pull request Sep 18, 2014

refactor(client): Move many parameters/helpers from Session to Relier. #1665

Merged

shane-tomlinson added the WIP label Sep 22, 2014

ckarlof reviewed Oct 30, 2014
View changes

app/scripts/models/auth_brokers/base.js

/**

* Transform the signin/signup links if necessary

*/

transformLink: function (link) {

This comment has been minimized.

Sign in to view

ckarlof Oct 30, 2014
Contributor

I prefer decorate vs transform here, personally.

shane-tomlinson force-pushed the add-a-broker branch 2 times, most recently from b4b0292 to be2bd87 Oct 30, 2014

shane-tomlinson reviewed Oct 30, 2014
View changes

Shane Tomlinson added 4 commits Oct 31, 2014

Add FunctionalHelpers to fill out the (request) password reset and co…

Loading status checks…

2efddfd

…mplete password reset forms.

Rip out lots of functions from the broker that might not be needed.

2c302d0

zaach mentioned this pull request Oct 31, 2014

fix(avatars): load profile image on settings and sign in pages if available #1733

Merged

shane-tomlinson force-pushed the add-a-broker branch from be2bd87 to 574e3a1 Nov 3, 2014

fix(client): Ensure the Loop initiated reset password verification fl…

Loading status checks…

a91e27b

…ow sends OAuth credentials after the reset password is complete when the original tab is closed. fixes #1825

shane-tomlinson force-pushed the add-a-broker branch from 574e3a1 to a91e27b Nov 3, 2014

shane-tomlinson mentioned this pull request Nov 3, 2014

Firefox Hello: OAuth regression - user not signed in password-reset if original tab is closed #1825

Closed

ckarlof reviewed Nov 4, 2014
View changes

app/scripts/models/auth_brokers/base.js

*

* @return {promise}

*/

afterResetPasswordConfirmationPoll: function () {

This comment has been minimized.

Sign in to view

ckarlof Nov 4, 2014
Contributor

Possible we can get rid of this: #1838

ckarlof reviewed Nov 4, 2014
View changes

app/scripts/models/auth_brokers/base.js

*

* @return {promise}

*/

afterSignUpConfirmationPoll: function () {

This comment has been minimized.

Sign in to view

ckarlof Nov 4, 2014
Contributor

Possible we can get rid of this: #1839

ckarlof reviewed Nov 4, 2014
View changes

app/scripts/models/auth_brokers/base.js

*

* @return {promise}

*/

afterCompleteSignUp: function () {

This comment has been minimized.

Sign in to view

ckarlof Nov 4, 2014
Contributor

Possible we can get rid of this: #1839

ckarlof reviewed Nov 4, 2014
View changes

app/tests/spec/lib/fxa-client.js

client = new FxaClientWrapper({

channel: channelMock

});

client = new FxaClientWrapper();

This comment has been minimized.

Sign in to view

ckarlof Nov 4, 2014
Contributor

nice! terrible mixing of concerns previously.

ckarlof added a commit that referenced this pull request Nov 4, 2014

Merge pull request #1609 from mozilla/add-a-broker

Loading status checks…

04b372d

Add some brokers

ckarlof merged commit 04b372d into master Nov 4, 2014
1 check passed

1 check passed

continuous-integration/travis-ci The Travis CI build passed
Details

ckarlof removed the waffle:needs review label Nov 4, 2014

ckarlof deleted the add-a-broker branch Nov 4, 2014

This was referenced Nov 4, 2014

Introduce the Broker models #1648

Closed

Move _checkForDesktopSyncRelinkWarning functionality out of fxa-client.js #1782

Closed

OAuth Signup: Continue flow if the email verification link is pasted into the same tab #1816

Closed

shane-tomlinson mentioned this pull request Nov 13, 2014

Sync: signin button turns blue after signin and before manage screen is displayed #1879

Closed

shane-tomlinson mentioned this pull request Nov 24, 2014

Improve Mocha test coverage of Oauth UI #1246

Closed

mozilla / fxa-content-server Archived

Add some brokers #1609

Add some brokers #1609

shane-tomlinson commented Aug 29, 2014

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

pdehaan commented Sep 8, 2014

shane-tomlinson commented Sep 8, 2014

shane-tomlinson commented Sep 15, 2014

This comment has been minimized.

coveralls commented Sep 15, 2014

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

ckarlof commented Oct 30, 2014

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

ckarlof commented Nov 4, 2014


		initializeBroker: function () {
		if (this._searchParam('context') === 'fx_desktop_v1') {

mozilla / fxa-content-server Archived

Add some brokers #1609

Add some brokers #1609

Conversation

shane-tomlinson commented Aug 29, 2014

This comment has been minimized.

vladikoff Aug 29, 2014 Contributor

This comment has been minimized.

pdehaan Aug 29, 2014 Contributor

This comment has been minimized.

pdehaan Aug 29, 2014 Contributor

This comment has been minimized.

shane-tomlinson Aug 29, 2014 Author Member

This comment has been minimized.

pdehaan Aug 29, 2014 Contributor

ಠ_ಠ

This comment has been minimized.

shane-tomlinson Aug 29, 2014 Author Member

This comment has been minimized.

pdehaan Aug 29, 2014 Contributor

This comment has been minimized.

pdehaan Aug 29, 2014 Contributor

Results:

This comment has been minimized.

pdehaan Aug 29, 2014 Contributor

This comment has been minimized.

shane-tomlinson Sep 8, 2014 Author Member

This comment has been minimized.

shane-tomlinson Sep 8, 2014 Author Member

pdehaan commented Sep 8, 2014

shane-tomlinson commented Sep 8, 2014

shane-tomlinson commented Sep 15, 2014

This comment has been minimized.

shane-tomlinson Sep 15, 2014 Author Member

coveralls commented Sep 15, 2014

This comment has been minimized.

nchapman Sep 17, 2014 Contributor

This comment has been minimized.

nchapman Sep 17, 2014 Contributor

This comment has been minimized.

nchapman Sep 17, 2014 Contributor

This comment has been minimized.

ckarlof Oct 30, 2014 Contributor

ckarlof commented Oct 30, 2014

This comment has been minimized.

shane-tomlinson Oct 30, 2014 Author Member

This comment has been minimized.

ckarlof Nov 4, 2014 Contributor

This comment has been minimized.

ckarlof Nov 4, 2014 Contributor

This comment has been minimized.

ckarlof Nov 4, 2014 Contributor

This comment has been minimized.

ckarlof Nov 4, 2014 Contributor

This comment has been minimized.

ckarlof Nov 4, 2014 Contributor

This comment has been minimized.

ckarlof Nov 4, 2014 Contributor

This comment has been minimized.

ckarlof Nov 4, 2014 Contributor

This comment has been minimized.

ckarlof Nov 4, 2014 Contributor

ckarlof commented Nov 4, 2014

vladikoff Aug 29, 2014
Contributor

pdehaan Aug 29, 2014
Contributor

pdehaan Aug 29, 2014
Contributor

shane-tomlinson Aug 29, 2014
Author Member

pdehaan Aug 29, 2014
Contributor

shane-tomlinson Aug 29, 2014
Author Member

pdehaan Aug 29, 2014
Contributor

pdehaan Aug 29, 2014
Contributor

pdehaan Aug 29, 2014
Contributor

shane-tomlinson Sep 8, 2014
Author Member

shane-tomlinson Sep 8, 2014
Author Member

shane-tomlinson Sep 15, 2014
Author Member

nchapman Sep 17, 2014
Contributor

nchapman Sep 17, 2014
Contributor

nchapman Sep 17, 2014
Contributor

ckarlof Oct 30, 2014
Contributor

shane-tomlinson Oct 30, 2014
Author Member

ckarlof Nov 4, 2014
Contributor

ckarlof Nov 4, 2014
Contributor

ckarlof Nov 4, 2014
Contributor

ckarlof Nov 4, 2014
Contributor

ckarlof Nov 4, 2014
Contributor

ckarlof Nov 4, 2014
Contributor

ckarlof Nov 4, 2014
Contributor

ckarlof Nov 4, 2014
Contributor