Add support to pass callback to poll function (#252)

* If a callback is passed to polling function during mfa challenge, the callback is invoked on every successful poll with the transaction as argument. * This is needed to know if the response info changed during poll. eg) OV risk scoring number challenge flow.
okta · Sep 24, 2019 · 81cdeea · 81cdeea
1 parent 2c5d123
commit 81cdeea
Show file tree

Hide file tree

Showing 3 changed files with 136 additions and 1 deletion.
diff --git a/lib/tx.js b/lib/tx.js
@@ -96,13 +96,15 @@ function getPollFn(sdk, res, ref) {
     var delay;
     var rememberDevice;
     var autoPush;
+    var transactionCallBack;
 
     if (util.isNumber(options)) {
       delay = options;
     } else if (util.isObject(options)) {
       delay = options.delay;
       rememberDevice = options.rememberDevice;
       autoPush = options.autoPush;
+      transactionCallBack = options.transactionCallBack;
     }
 
     if (!delay && delay !== 0) {
@@ -163,6 +165,10 @@ function getPollFn(sdk, res, ref) {
               throw new AuthPollStopError();
             }
 
+            if (typeof transactionCallBack === 'function') {
+              transactionCallBack(pollRes);
+            }
+
             // Continue poll
             return Q.delay(delay)
               .then(recursivePoll);

diff --git a/test/spec/__snapshots__/mfa-challenge.js.snap b/test/spec/__snapshots__/mfa-challenge.js.snap
@@ -0,0 +1,82 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`MFA_CHALLENGE trans.poll allows polling for push with transactionCallBack 1`] = `
+Object {
+  "_embedded": Object {
+    "factor": Object {
+      "factorType": "push",
+      "id": "opf492vmb3s1blLTs0h7",
+      "profile": Object {
+        "credentialId": "[email protected]",
+        "deviceType": "SmartPhone_IPhone",
+        "keys": Array [
+          Object {
+            "kid": "default",
+            "kty": "PKIX",
+            "use": "sig",
+            "x5c": Array [
+              "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAwd3kkRHieZUwY2wRaufKLuKWBHzy6oj8JjuXVyQJHzHJHyAjAo1jhey21v8WtxWMkb8soR1cg7iSf9kM/MjRxQJFKWNNhZDSgrMs/nc8RIO3xX1dWOVhNf51z/82S/+Wgo0ZRzrfM9iOFUwKDt5PoGe3d8rPsY3F5sJaw8lwAw9HqgI95RmRovta99S5zgh9DD3D57ckECKdCbe8HxFd+lkRLz1nl85FxEKLMaPa0vh8/AN8j14GSjoVogyLnF1468LEff7i2VL81HbUpO2PRQ7LEqTQWzmfcB0BULd499WydFIuwpV68c91VcGXWPUKHyXxZVB5SXSHgAgR45p8nQIDAQAB",
+            ],
+          },
+        ],
+        "name": "Example’s iPhone",
+        "platform": "IOS",
+        "version": "8.3",
+      },
+      "provider": "OKTA",
+    },
+    "user": Object {
+      "id": "00u492uyb0VqYtZiI0h7",
+      "profile": Object {
+        "firstName": "Test",
+        "lastName": "User",
+        "locale": "en_US",
+        "login": "[email protected]",
+        "timeZone": "America/Los_Angeles",
+      },
+    },
+  },
+  "_links": Object {
+    "cancel": Object {
+      "hints": Object {
+        "allow": Array [
+          "POST",
+        ],
+      },
+      "href": "https://auth-js-test.okta.com/api/v1/authn/cancel",
+    },
+    "next": Object {
+      "hints": Object {
+        "allow": Array [
+          "POST",
+        ],
+      },
+      "href": "https://auth-js-test.okta.com/api/v1/authn/factors/opf492vmb3s1blLTs0h7/verify",
+      "name": "poll",
+    },
+    "prev": Object {
+      "hints": Object {
+        "allow": Array [
+          "POST",
+        ],
+      },
+      "href": "https://auth-js-test.okta.com/api/v1/authn/previous",
+    },
+    "resend": Array [
+      Object {
+        "hints": Object {
+          "allow": Array [
+            "POST",
+          ],
+        },
+        "href": "https://auth-js-test.okta.com/api/v1/authn/factors/opf492vmb3s1blLTs0h7/verify/resend",
+        "name": "push",
+      },
+    ],
+  },
+  "expiresAt": "2015-06-10T22:42:40.224Z",
+  "factorResult": "WAITING",
+  "stateToken": "00T4jcVNRzJy5dkWJ4P7c9051dY3FUYY9O2zvbU_vI",
+  "status": "MFA_CHALLENGE",
+}
+`;
diff --git a/test/spec/mfa-challenge.js b/test/spec/mfa-challenge.js
@@ -415,7 +415,7 @@ describe('MFA_CHALLENGE', function () {
     });
   });
 
-  describe('trans.poll', function () {
+  describe('trans.poll', function () { 
     util.itMakesCorrectRequestResponse({
       title: 'allows polling for push',
       setup: {
@@ -1291,6 +1291,53 @@ describe('MFA_CHALLENGE', function () {
       }
     });
 
+    util.itMakesCorrectRequestResponse({
+      title: 'allows polling for push with transactionCallBack',
+      setup: {
+        status: 'mfa-challenge-push',
+        calls: [
+          {
+            request: {
+              uri: '/api/v1/authn/factors/opf492vmb3s1blLTs0h7/verify',
+              data: {
+                stateToken: '00T4jcVNRzJy5dkWJ4P7c9051dY3FUYY9O2zvbU_vI'
+              }
+            },
+            response: 'mfa-challenge-push'
+          },
+          {
+            request: {
+              uri: '/api/v1/authn/factors/opf492vmb3s1blLTs0h7/verify',
+              data: {
+                stateToken: '00T4jcVNRzJy5dkWJ4P7c9051dY3FUYY9O2zvbU_vI'
+              }
+            },
+            response: 'mfa-challenge-push'
+          },
+          {
+            request: {
+              uri: '/api/v1/authn/factors/opf492vmb3s1blLTs0h7/verify',
+              data: {
+                stateToken: '00T4jcVNRzJy5dkWJ4P7c9051dY3FUYY9O2zvbU_vI'
+              }
+            },
+            response: 'success'
+          }
+        ]
+      },
+      execute: function (test) {
+        test.transactionCallbackFn = jasmine.createSpy('spy');
+        return test.trans.poll({
+          delay: 0, 
+          transactionCallBack: test.transactionCallbackFn
+        });
+      },
+      expectations: function (test) {
+        expect(test.transactionCallbackFn.calls.count()).toBe(2);
+        expect(test.transactionCallbackFn.calls.argsFor(0)[0]).toMatchSnapshot();
+      },
+    });
+
     util.itErrorsCorrectly({
       title: 'returns correct error if persistent network error',
       setup: {