feat: skip checking onboarding_checklist

    * skip checking onboarding_checklist for older users
    * refactor to better handle exceptions

Author: rakibansary

package.json

@@ -0,0 +1,26 @@
+{
+    "name": "@topcoder-platform/tc-auth-lib",
+    "version": "1.0.2",
+    "description": "Topcoder Authentication lib   ",
+    "main": "index.js",
+    "scripts": {
+      "test": "echo \"Error: no test specified\" && exit 1"
+    },
+    "repository": {
+      "type": "git",
+      "url": "git+https://github.com/topcoder-platform/authlib.git"
+    },
+    "keywords": [
+      "topcoder",
+      "authentication"
+    ],
+    "author": "Topcoder Team",
+    "license": "ISC",
+    "bugs": {
+      "url": "https://github.com/topcoder-platform/authlib/issues"
+    },
+    "homepage": "https://github.com/topcoder-platform/authlib#readme",
+    "dependencies": {
+      "lodash": "^4.17.19"
+    }
+  }

web-assets/auth0/dev-tenant/rules/onboardingChecklist.js

@@ -8,21 +8,38 @@ function (user, context, callback) {
         }
 
         const _ = require('lodash');
+        const moment = require('moment');
 
         let handle = _.get(user, "handle", null);
         const provider = _.get(user, "identities[0].provider", null);
         if (!handle && provider === "auth0") {
           handle = _.get(user, "nickname", null);
         }
 
-        let createdAt = _.get(user, "created_at", null);
-        console.log('rule:onboarding-checklist: user created at', createdAt);
+        console.log("rule:onboarding-checklist: fetch onboarding_checklist for email/handle: ", user.email, handle, provider);
+
+        const createdAt = _.get(user, "created_at", null);
+        const thresholdDate = moment(configuration.PROFILE_CREATION_DATE_THRESHOLD, "YYYY-MM-DD");
+        console.log('rule:onboarding-checklist: PROFILE_CREATION_DATE_THRESHOLD', thresholdDate);
+
+        try {
+            // For users created before thresholdDate, we don't want to check onboarding_checklist
+            // This is because older profiles might not have onboarding_checklist data and they don't need to see the onboarding_wizard
+            if (createdAt && !thresholdDate.isBefore(moment(createdAt))) {
+                console.log("rule:onboarding-checklist: user created before threshold date. Not checking onboarding_checklist.");
+                return callback(null, user, context);
+            }
+        } catch (err) {
+            console.log("rule:onboarding-checklist: failed to compare userCreationDate", createdAt, " with threshold. Error", err);
+        }
 
+        /**
+         * Returns M2M token needed to fetch onboarding_checklist
+         */
         const getToken = function(callback) {
             if (global.M2MToken) {
                 console.log('rule:onboarding-checklist:M2M token is available');
-                const jwt = require('jsonwebtoken');
-                const moment = require('moment');
+                const jwt = require('jsonwebtoken');                
                 const decoded = jwt.decode(global.M2MToken);
                 const exp = moment.unix(decoded.exp);
 
@@ -59,25 +76,26 @@ function (user, context, callback) {
                 console.log('rule:onboarding-checklist:failed to fetch M2M token.');
                 return callback(null, user, context);
             }
-
-            console.log("rule:onboarding-checklist: fetch onboarding_checklist for email/handle: ", user.email, handle, provider);
             global.AUTH0_CLAIM_NAMESPACE = "https://" + configuration.DOMAIN + "/";
-            try {
-                const axios = require('axios@0.19.2');
+            const axios = require('axios@0.19.2');
+        
+            const redirectUrl = `https://platform.${configuration.DOMAIN}/onboard`;
+            const options = {
+                method: 'GET',
+                url: `https://api.${configuration.DOMAIN}/v5/members/${handle}/traits?traitIds=onboarding_checklist`,
+                headers: {
+                    Authorization: `Bearer ${token}`
+                }
+            };
 
-                const redirectUrl = `https://platform.${configuration.DOMAIN}/onboard`;
-                const options = {
-                    method: 'GET',
-                    url: `https://api.${configuration.DOMAIN}/v5/members/${handle}/traits?traitIds=onboarding_checklist`,
-                    headers: {
-                        Authorization: `Bearer ${token}`
-                    }
-                };
-                
-                axios(options).then(result => {
-                    const data = result.data;        
+            // Fetch onboarding_checklist using v5 member Api.
+            axios(options)
+            .then(result => {
+                try {
+                    const data = result.data;
 
-                    if (data.length === 0) {
+                    if (data.length === 0) {                        
+                        // User doesn't have any traits with traitId onboarding_checklist and should be shown the onboarding wizard
                         context.redirect = {
                             url: redirectUrl
                         };
@@ -89,9 +107,9 @@ function (user, context, callback) {
 
                     for (let checklistTrait of onboardingChecklistTrait.data) {
                         if (
-                            checklistTrait.onboarding_wizard !== null &&
-                            (checklistTrait.onboarding_wizard.status !== null ||
-                                checklistTrait.onboarding_wizard.skip)
+                            checklistTrait.onboarding_wizard != null &&
+                            (checklistTrait.onboarding_wizard.status != null || // any valid status indicates user has already seen onboarding wizard and needn't be shown again.
+                                checklistTrait.onboarding_wizard.skip) // for certain signup routes skip is set to true, and thus onboarding wizard needn't be shown
                             ) {
                                 return callback(null, user, context);
                             }
@@ -110,21 +128,21 @@ function (user, context, callback) {
                             }
                         }
                     }
-        
+                    
+                    // All checks failed - indicating user newly registered and needs to be shown the onboarding wizard
                     context.redirect = {
                         url: redirectUrl
                     };
                     console.log('rule:onboarding-checklist:Setting redirectUrl', redirectUrl);
                     return callback(null, user, context);
-                }).catch(requestError => {
-                    console.log("rule:onboarding-checklist:Failed fetching onboarding_checklist with error", requestError.response.status);
+                } catch (e) {
+                    console.log("rule:onboarding-checklist:Error in fetching onboarding_checklist", e);            
                     return callback(null, user, context);
-                });
-                
-            } catch (e) {
-                console.log("rule:onboarding-checklist:Error in fetching onboarding_checklist", + e);            
+                }
+            }).catch(requestError => {
+                console.log("rule:onboarding-checklist:Failed fetching onboarding_checklist with error", requestError.response.status);
                 return callback(null, user, context);
-            }
+            });
         });
     } else {
         return callback(null, user, context);