added 'resume' optional parameter for email sending endpoints

mozilla · Sep 4, 2014 · 696b43f · 696b43f
1 parent 2b992ff
commit 696b43f
Show file tree

Hide file tree

Showing 8 changed files with 39 additions and 45 deletions.
diff --git a/docs/api.md b/docs/api.md
@@ -152,6 +152,7 @@ ___Parameters___
 * authPW - the PBKDF2/HKDF stretched password as a hex string
 * service - (optional) opaque alphanumeric token to be included in verification links
 * redirectTo - (optional) a URL that the client should be redirected to after handling the request
+* resume - (optional) opaque url-encoded string that will be included in the verification link as a querystring parameter, useful for continuing an OAuth flow for example.
 * preVerifyToken - (optional) see below
 
 ### Request
@@ -636,7 +637,7 @@ ___Parameters___
 
 * service - (optional) opaque alphanumeric token to be included in verification links
 * redirectTo - (optional) a URL that the client should be redirected to after handling the request
-
+* resume - (optional) opaque url-encoded string that will be included in the verification link as a querystring parameter, useful for continuing an OAuth flow for example.
 
 ___Headers___
 
@@ -898,6 +899,7 @@ ___Parameters___
 * email - the recovery email for this account
 * service - (optional) indicates the relying service that the user was interacting with that triggered the password reset
 * redirectTo - (optional) a URL that the client should be redirected to after handling the request
+* resume - (optional) opaque url-encoded string that will be included in the verification link as a querystring parameter, useful for continuing an OAuth flow for example.
 
 ### Request
 ```sh
@@ -948,6 +950,7 @@ ___Parameters___
 * email - the recovery email for this account
 * service - (optional) indicates the relying service that the user was interacting with that triggered the password reset
 * redirectTo - (optional) a URL that the client should be redirected to after handling the request
+* resume - (optional) opaque url-encoded string that will be included in the verification link as a querystring parameter, useful for continuing an OAuth flow for example.
 
 ### Request
 

diff --git a/mailer.js b/mailer.js
@@ -25,6 +25,7 @@ module.exports = function (config, log) {
             code: code.toString('hex'),
             service: opts.service,
             redirectTo: opts.redirectTo,
+            resume: opts.resume,
             acceptLanguage: opts.acceptLanguage || defaultLanguage
           }
         ))
@@ -37,6 +38,7 @@ module.exports = function (config, log) {
             code: code.toString('hex'),
             service: opts.service,
             redirectTo: opts.redirectTo,
+            resume: opts.resume,
             acceptLanguage: opts.acceptLanguage || defaultLanguage
           }
         ))

diff --git a/npm-shrinkwrap.json b/npm-shrinkwrap.json
diff --git a/package.json b/package.json
@@ -34,7 +34,7 @@
     "bunyan": "1.0.0",
     "compute-cluster": "0.0.9",
     "convict": "0.4.2",
-    "fxa-auth-mailer": "0.0.5",
+    "fxa-auth-mailer": "1.0.6",
     "hapi": "6.5.1",
     "hapi-auth-hawk": "1.1.1",
     "hkdf": "0.0.2",

diff --git a/routes/account.js b/routes/account.js
@@ -39,6 +39,7 @@ module.exports = function (
             preVerified: isA.boolean(),
             service: isA.string().max(16).alphanum().optional(),
             redirectTo: validators.redirectTo(redirectDomain).optional(),
+            resume: isA.string().max(2048).optional(),
             preVerifyToken: isA.string().max(2048).regex(BASE64_JWT).optional()
           }
         }
@@ -150,6 +151,7 @@ module.exports = function (
                 mailer.sendVerifyCode(response.account, response.account.emailCode, {
                   service: form.service,
                   redirectTo: form.redirectTo,
+                  resume: form.resume,
                   acceptLanguage: request.app.acceptLanguage
                 })
                 .fail(
@@ -423,7 +425,8 @@ module.exports = function (
         validate: {
           payload: {
             service: isA.string().max(16).alphanum().optional(),
-            redirectTo: validators.redirectTo(redirectDomain).optional()
+            redirectTo: validators.redirectTo(redirectDomain).optional(),
+            resume: isA.string().max(2048).optional()
           }
         }
       },
@@ -447,6 +450,7 @@ module.exports = function (
               {
                 service: request.payload.service,
                 redirectTo: request.payload.redirectTo,
+                resume: request.payload.resume,
                 acceptLanguage: request.app.acceptLanguage
               }
             )

diff --git a/routes/password.js b/routes/password.js
@@ -170,7 +170,8 @@ module.exports = function (
           payload: {
             email: validators.email().required(),
             service: isA.string().max(16).alphanum().optional(),
-            redirectTo: validators.redirectTo(redirectDomain).optional()
+            redirectTo: validators.redirectTo(redirectDomain).optional(),
+            resume: isA.string().max(2048).optional()
           }
         },
         response: {
@@ -204,6 +205,7 @@ module.exports = function (
                 {
                   service: request.payload.service,
                   redirectTo: request.payload.redirectTo,
+                  resume: request.payload.resume,
                   acceptLanguage: request.app.acceptLanguage
                 }
               )
@@ -240,7 +242,8 @@ module.exports = function (
           payload: {
             email: validators.email().required(),
             service: isA.string().max(16).alphanum().optional(),
-            redirectTo: validators.redirectTo(redirectDomain).optional()
+            redirectTo: validators.redirectTo(redirectDomain).optional(),
+            resume: isA.string().max(2048).optional()
           }
         },
         response: {
@@ -268,6 +271,7 @@ module.exports = function (
               {
                 service: request.payload.service,
                 redirectTo: request.payload.redirectTo,
+                resume: request.payload.resume,
                 acceptLanguage: request.app.acceptLanguage
               }
             )

diff --git a/test/client/api.js b/test/client/api.js
@@ -101,6 +101,7 @@ ClientApi.prototype.accountCreate = function (email, authPW, options) {
       preVerified: options.preVerified || undefined,
       service: options.service || undefined,
       redirectTo: options.redirectTo || undefined,
+      resume: options.resume || undefined,
       preVerifyToken: options.preVerifyToken || undefined
     },
     {
@@ -227,7 +228,8 @@ ClientApi.prototype.recoveryEmailResendCode = function (sessionTokenHex, options
           token,
           {
             service: options.service || undefined,
-            redirectTo: options.redirectTo || undefined
+            redirectTo: options.redirectTo || undefined,
+            resume: options.resume || undefined
           }
         )
       }.bind(this)
@@ -312,7 +314,8 @@ ClientApi.prototype.passwordForgotSendCode = function (email, options) {
     {
       email: email,
       service: options.service || undefined,
-      redirectTo: options.redirectTo || undefined
+      redirectTo: options.redirectTo || undefined,
+      resume: options.resume || undefined
     }
   )
 }
@@ -329,7 +332,8 @@ ClientApi.prototype.passwordForgotResendCode = function (passwordForgotTokenHex,
           {
             email: email,
             service: options.service || undefined,
-            redirectTo: options.redirectTo || undefined
+            redirectTo: options.redirectTo || undefined,
+            resume: options.resume || undefined
           }
         )
       }.bind(this)

diff --git a/test/remote/account_create_tests.js b/test/remote/account_create_tests.js
@@ -82,14 +82,14 @@ TestServer.start(config)
     }
   )
 
-/*/ TODO: revisit after the "dumb" resend logic is updated
+
   test(
-    'create account with service identifier',
+    'create account with service identifier and resume',
     function (t) {
       var email = server.uniqueEmail()
       var password = 'allyourbasearebelongtous'
       var client = null
-      var options = { service: 'abcdef' }
+      var options = { service: 'abcdef', resume: 'foo' }
       return Client.create(config.publicUrl, email, password, options)
         .then(
           function (x) {
@@ -104,35 +104,12 @@ TestServer.start(config)
         .then(
           function (emailData) {
             t.equal(emailData.headers['x-service-id'], 'abcdef')
-            client.options.service = '123456'
-            return client.requestVerifyEmail()
-          }
-        )
-        .then(
-          function () {
-            return server.mailbox.waitForEmail(email)
-          }
-        )
-        .then(
-          function (emailData) {
-            t.equal(emailData.headers['x-service-id'], '123456')
-            client.options.service = null
-            return client.requestVerifyEmail()
-          }
-        )
-        .then(
-          function () {
-            return server.mailbox.waitForEmail(email)
-          }
-        )
-        .then(
-          function (emailData) {
-            t.equal(emailData.headers['x-service-id'], undefined)
+            t.ok(emailData.headers['x-link'].indexOf('resume=foo') > -1)
           }
         )
     }
   )
-/*/
+
   test(
     'create account allows localization of emails',
     function (t) {