Merge pull request #453 from topcoder-platform/TCA-852_dice-check

TCA-852 Check for Dice -> TCA-851_wipro-mfa

Author: brooketopcoder

src-ts/lib/functions/token-functions/token.functions.ts

@@ -15,9 +15,10 @@ export async function getAsync(): Promise<TokenModel> {
     }
 
     try {
-        const { handle, roles }: {
+        const { handle, roles, userId }: {
             handle?: string
             roles?: Array<string>
+            userId?: number
         } = decodeToken(token)
 
         // if we didn't find the handle, we have a bad token
@@ -26,8 +27,9 @@ export async function getAsync(): Promise<TokenModel> {
             return Promise.resolve({})
         }
 
-        return Promise.resolve({ handle, roles, token })
+        return Promise.resolve({ handle, roles, token, userId })
 
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     } catch (error: any) {
         logError(error)
         return Promise.resolve({})

src-ts/lib/functions/token-functions/token.model.ts

@@ -2,4 +2,5 @@ export interface TokenModel {
     handle?: string
     roles?: Array<string>
     token?: string
+    userId?: number
 }

src-ts/lib/functions/user-functions/index.ts

@@ -1 +1,4 @@
-export { updatePasswordAsync as userUpdatePasswordAsync } from './user.functions'
+export {
+    getDiceStatusAsync as userGetDiceStatusAsync,
+    updatePasswordAsync as userUpdatePasswordAsync,
+} from './user.functions'

src-ts/lib/functions/user-functions/user-store/index.ts

@@ -1,2 +1,5 @@
-export { patchAsync as userPatchAsync } from './user-xhr.store'
+export {
+    getDiceStatusAsync as userStoreGetDiceStatusAsync,
+    patchAsync as userStorePatchAsync,
+} from './user-xhr.store'
 export { type UserPatchRequest } from './user-xhr.store'

src-ts/lib/functions/user-functions/user-store/user-xhr.store.ts

@@ -1,5 +1,5 @@
 import { User } from '../../../../../types/tc-auth-lib'
-import { xhrPatchAsync } from '../../xhr-functions'
+import { xhrGetAsync, xhrPatchAsync } from '../../xhr-functions'
 
 import { user as userEndpoint } from './user-endpoint.config'
 
@@ -12,6 +12,21 @@ export interface UserPatchRequest {
     }
 }
 
+export async function getDiceStatusAsync(userId: number): Promise<boolean> {
+
+    interface DiceStatusResult {
+        result: {
+            content: {
+                diceEnabled: boolean
+            }
+        }
+    }
+    const result: DiceStatusResult
+        = await xhrGetAsync<DiceStatusResult>(`${userEndpoint(userId)}/2fa`)
+
+    return !!result.result.content.diceEnabled
+}
+
 export async function patchAsync(userId: number, request: UserPatchRequest): Promise<User> {
     const url: string = userEndpoint(userId)
     return xhrPatchAsync(url, request)

src-ts/lib/functions/user-functions/user.functions.ts

@@ -1,4 +1,8 @@
-import { userPatchAsync, UserPatchRequest } from './user-store'
+import { UserPatchRequest, userStoreGetDiceStatusAsync, userStorePatchAsync } from './user-store'
+
+export async function getDiceStatusAsync(userId: number): Promise<boolean> {
+    return userStoreGetDiceStatusAsync(userId)
+}
 
 export async function updatePasswordAsync(userId: number, currentPassword: string, password: string): Promise<void> {
     const request: UserPatchRequest = {
@@ -9,6 +13,6 @@ export async function updatePasswordAsync(userId: number, currentPassword: strin
             },
         },
     }
-    return userPatchAsync(userId, request)
+    return userStorePatchAsync(userId, request)
         .then(() => undefined)
 }

src-ts/lib/page-footer/PageFooter.tsx

@@ -7,13 +7,17 @@ const PageFooter: FC<{}> = () => {
 
     const navElementId: string = 'footer-nav-el'
 
-    tcUniNav(
-        'init',
-        navElementId,
-        {
-            type: 'footer',
-        },
-    )
+    // delay the initialization so
+    // the nav element has time to render
+    setTimeout(() => {
+        tcUniNav(
+            'init',
+            navElementId,
+            {
+                type: 'footer',
+            },
+        )
+    }, 10)
 
     return <div id={navElementId} />
 }

src-ts/lib/profile-provider/profile-functions/profile-factory/profile.factory.ts

@@ -3,18 +3,24 @@ import { UserProfile } from '../../user-profile.model'
 
 import { UserRole } from './user-role.enum'
 
-export function create(profile: UserProfile, token: TokenModel): UserProfile {
-    // TODO: create the profile full name property
+export function create(profile: UserProfile, token: TokenModel, hasDiceEnabled: boolean): UserProfile {
+
     // Currently, the "Self-Service Customer" role is being set when a user is created
     // during the self-service workflow. There are no other roles being set to distinguish
     // between Customers and Members.
     // Therefore, the only way to know if a user is a Member is if s/he is not a Customer.
     // This is imperfect, bc a user could be both a Customer or a Member, but for now
     // we are okay with this and will have a more in-depth initiave to properly assign
-    // rolees.
+    // roles.
     profile.isCustomer = !!token.roles?.some(role => role === UserRole.customer)
     profile.isMember = !profile.isCustomer
+
+    profile.isWipro = profile.email.endsWith('@wipro.com')
+    profile.diceEnabled = hasDiceEnabled
+
     // store roles for custom capability checks
-    profile.roles = token.roles
+    profile.roles = token.roles || []
+
+    // TODO: create the profile full name property
     return profile
 }

src-ts/lib/profile-provider/profile-functions/profile.functions.ts

@@ -1,3 +1,4 @@
+import { userGetDiceStatusAsync } from '../../functions/user-functions'
 import { tokenGetAsync, TokenModel } from '../../functions/token-functions'
 import { EditNameRequest } from '../edit-name-request.model'
 import { UserProfile } from '../user-profile.model'
@@ -11,19 +12,22 @@ export async function getAsync(handle?: string): Promise<UserProfile | undefined
     const token: TokenModel = await tokenGetAsync()
 
     // get the handle
-    const safeHandle: string | undefined = handle || token?.handle
-    if (!safeHandle) {
+    const safeHandle: string | undefined = handle || token.handle
+    if (!safeHandle || !token.userId) {
         return Promise.resolve(undefined)
     }
 
     // get the profile
-    const profileResult: UserProfile = await profileStoreGet(safeHandle)
+    const profilePromise: Promise<UserProfile> = profileStoreGet(safeHandle)
+    const dicePromise: Promise<boolean> = userGetDiceStatusAsync(token.userId)
+
+    const [profileResult, diceEnabled]: [UserProfile, boolean] = await Promise.all([profilePromise, dicePromise])
 
     // make the changes we need based on the token
-    const output: UserProfile = profileFactoryCreate(profileResult, token)
+    const output: UserProfile = profileFactoryCreate(profileResult, token, diceEnabled)
     return output
 }
 
-export async function editNameAsync(handle: string, profile: EditNameRequest): Promise<any> {
+export async function editNameAsync(handle: string, profile: EditNameRequest): Promise<UserProfile> {
     return profileStorePatchName(handle, profile)
 }

src-ts/lib/profile-provider/user-profile.model.ts

@@ -1,13 +1,15 @@
 export interface UserProfile {
     competitionCountryCode: string
     createdAt: number
+    diceEnabled: boolean
     email: string
     firstName: string
     handle: string
     handleLower: string
     homeCountryCode: string
     isCustomer?: boolean
     isMember?: boolean
+    isWipro: boolean
     lastName: string
     photoURL?: string
     roles: Array<string>

src-ts/tools/learn/course-details/course-curriculum/CourseCurriculum.tsx

@@ -37,11 +37,12 @@ interface CourseCurriculumProps {
 const CourseCurriculum: FC<CourseCurriculumProps> = (props: CourseCurriculumProps) => {
 
     const navigate: NavigateFunction = useNavigate()
-    const [searchParams]: any = useSearchParams()
+    const [searchParams]: [URLSearchParams, unknown] = useSearchParams()
 
     const isLoggedIn: boolean = !!props.profile
 
-    const [isTcAcademyPolicyModal, setIsTcAcademyPolicyModal]: [boolean, Dispatch<SetStateAction<boolean>>] = useState<boolean>(false)
+    const [isTcAcademyPolicyModal, setIsTcAcademyPolicyModal]: [boolean, Dispatch<SetStateAction<boolean>>]
+        = useState<boolean>(false)
 
     const status: string = props.progress?.status ?? UserCertificationProgressStatus.inititialized
     const completedPercentage: number = (props.progress?.courseProgressPercentage ?? 0) / 100
@@ -76,6 +77,7 @@ const CourseCurriculum: FC<CourseCurriculumProps> = (props: CourseCurriculumProp
      * Handle user click on start course/resume/login button
      */
     const handleStartCourseClick: () => void = useCallback(() => {
+
         // if user is not logged in, redirect to login page
         if (!isLoggedIn) {
             // add a flag to the return url to show the academic policy modal
@@ -84,6 +86,14 @@ const CourseCurriculum: FC<CourseCurriculumProps> = (props: CourseCurriculumProp
             return
         }
 
+        // if the user is wipro and s/he hasn't set up DICE,
+        // let the user know
+        if (props.profile?.isWipro && !props.profile.diceEnabled) {
+            // TODO
+            console.debug('TODO: user needs dice')
+            return
+        }
+
         // Check if user accepted policy and resume(or start) the course
         if (props.progress?.academicHonestyPolicyAcceptedAt) {
             handleStartCourse()
@@ -92,6 +102,7 @@ const CourseCurriculum: FC<CourseCurriculumProps> = (props: CourseCurriculumProp
 
         // show the academic policy modal before starting a new course
         setIsTcAcademyPolicyModal(true)
+    // eslint-disable-next-line react-hooks/exhaustive-deps
     }, [
         handleStartCourse,
         isLoggedIn,
@@ -130,6 +141,7 @@ const CourseCurriculum: FC<CourseCurriculumProps> = (props: CourseCurriculumProp
         }
 
         handleStartCourse()
+    // eslint-disable-next-line react-hooks/exhaustive-deps
     }, [
         handleStartCourse,
         props.course.certificationId,
@@ -149,6 +161,7 @@ const CourseCurriculum: FC<CourseCurriculumProps> = (props: CourseCurriculumProp
      * proceed as if the user just clicked "Start course" button
      */
     useEffect(() => {
+        // eslint-disable-next-line no-null/no-null
         if (props.progressReady && isLoggedIn && searchParams.get(LEARN_PATHS.startCourseRouteFlag) !== null) {
             handleStartCourseClick()
         }

src-ts/tools/learn/free-code-camp/FreeCodeCamp.tsx

@@ -436,19 +436,37 @@ const FreeCodeCamp: FC<{}> = () => {
 
     /**
      * Check if the user accepted the academic honesty policy
+     * and either is not a wipro user or the wipro user has dice enabled.
      * if not, redirect user to course details page to accept the policy
      */
     useLayoutEffect(() => {
-        if (ready && !(isLoggedIn && certificateProgress?.academicHonestyPolicyAcceptedAt)) {
-            const coursePath: string = getCoursePath(
-                providerParam,
-                certificationParam,
-            )
-            navigate(coursePath)
+
+        // if we're not ready, there's nothing to do
+        if (!ready) {
+            return
         }
+
+        // if the user is logged in,
+        // and the user is a either not wipro user or is a wipro user with dice enabled,
+        // and if the user has accepted the academic honesty policy,
+        // the user is permitted to take the course, so there's nothing to do.
+        if (isLoggedIn
+            && (!profile?.isWipro || !!profile?.diceEnabled)
+            && !!certificateProgress?.academicHonestyPolicyAcceptedAt) {
+            return
+        }
+
+        // redirect the user to course details page to perform the
+        // necessary actions
+        const coursePath: string = getCoursePath(
+            providerParam,
+            certificationParam,
+        )
+        navigate(coursePath)
     }, [
         ready,
         certificateProgress,
+        profile,
         providerParam,
         certificationParam,
         navigate,