@sbc-connect/nuxt-auth 0.4.0 → 0.5.0

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @sbc-connect/nuxt-auth
 
+## 0.5.0
+
+### Minor Changes
+
+- [#123](https://github.com/bcgov/connect-nuxt/pull/123) [`3c33132`](https://github.com/bcgov/connect-nuxt/commit/3c331327a27cfbd0613c268abf97842288d10f8c) Thanks [@cameron-eyds](https://github.com/cameron-eyds)! - Auth Redirect Enhancements
+
+## 0.4.1
+
+### Patch Changes
+
+- [#121](https://github.com/bcgov/connect-nuxt/pull/121) [`e4d8d9e`](https://github.com/bcgov/connect-nuxt/commit/e4d8d9e510af321a2cc7ba12ca270a5f018981e5) Thanks [@kialj876](https://github.com/kialj876)! - Updated account mocking so that tests can mock their own account instead of the hardcoded mock
+
+- Updated dependencies []:
+  - @sbc-connect/nuxt-base@0.6.0
+  - @sbc-connect/nuxt-forms@0.4.0
+
 ## 0.4.0
 
 ### Minor Changes

package/app/components/Connect/Header/AccountOptionsMenu.vue

@@ -10,7 +10,7 @@ const isLargeScreen = useMediaQuery('(min-width: 1024px)')
     id="account-options-menu"
     :items="loggedInUserOptions"
     :ui="{
-      content: 'max-w-[90dvw]',
+      content: 'max-w-[90dvw] account-options-menu-pw-selector',
     }"
   >
     <UButton

package/app/composables/useAuthApi.ts

@@ -1,5 +1,3 @@
-import type { ConnectCreateAccount } from '#auth/app/interfaces/connect-account'
-
 export const useAuthApi = () => {
   const { $authApi } = useNuxtApp()
   const queryCache = useQueryCache()
@@ -34,7 +32,10 @@ export const useAuthApi = () => {
    */
   const useCreateAccount = defineMutation(() => {
     const { mutateAsync, ...mutation } = useMutation({
-      mutation: (vars: { payload: ConnectCreateAccount, successCb?: () => Promise<unknown> }) => {
+      mutation: (vars: {
+        payload: ConnectCreateAccount
+        successCb?: (createRes: ConnectAuthProfile) => Promise<unknown>
+      }) => {
         return $authApi<ConnectAuthProfile>('/orgs', {
           method: 'POST',
           body: vars.payload
@@ -48,7 +49,7 @@ export const useAuthApi = () => {
       onSuccess: async (_, _vars) => {
         await queryCache.invalidateQueries({ key: ['auth-user-profile'], exact: true })
         if (_vars.successCb) {
-          await _vars.successCb()
+          await _vars.successCb(_)
         }
       }
     })

package/app/composables/useConnectAccountFlowRedirect.ts

@@ -1,7 +1,9 @@
 import type { RouteLocationNormalizedGeneric } from '#vue-router'
 
 export const useConnectAccountFlowRedirect = () => {
-  function finalRedirect(route: RouteLocationNormalizedGeneric) {
+  function finalRedirect(route: RouteLocationNormalizedGeneric, manageAccount = false) {
+    const { authUser } = useConnectAuth()
+    const { userAccounts } = useConnectAccountStore()
     const localePath = useLocalePath()
     const ac = useAppConfig().connect.login
     const externalRedirectUrl = route.query.return as string | undefined
@@ -9,24 +11,37 @@ export const useConnectAccountFlowRedirect = () => {
 
     const query = { ...route.query }
 
-    if (query.return) {
-      delete query.return
+    if (manageAccount && userAccounts.length !== 1) {
+      const isBcscCreate
+        = userAccounts.length === 0
+          && authUser.value.loginSource === ConnectLoginSource.BCSC
+
+      return isBcscCreate
+        ? navigateTo({ path: localePath('/auth/account/create'), query })
+        : navigateTo({ path: localePath('/auth/account/select'), query })
     }
 
     if (externalRedirectUrl) {
+      const cleanQuery = { ...query }
+      delete cleanQuery.return
+
       return navigateTo(
         {
-          path: appendUrlParam(externalRedirectUrl, 'accountid', useConnectAccountStore().currentAccount.id),
-          query
+          path: appendUrlParam(
+            externalRedirectUrl,
+            'accountid',
+            useConnectAccountStore().currentAccount.id
+          ),
+          query: cleanQuery
         },
         { external: true }
       )
-    } else {
-      return navigateTo({
-        path: localePath(internalRedirectUrl),
-        query
-      })
     }
+
+    return navigateTo({
+      path: localePath(internalRedirectUrl),
+      query
+    })
   }
 
   return {

package/app/middleware/connect-auth.ts

@@ -5,27 +5,33 @@ export default defineNuxtRouteMiddleware(async (to) => {
   const authApi = useAuthApi()
   const { finalRedirect } = useConnectAccountFlowRedirect()
 
-  if (!isAuthenticated.value && !rtc.playwright) {
-    return navigateTo({
-      path: localePath('/auth/login'),
-      query: {
-        // include preset when present
-        ...(to.query.preset ? { preset: String(to.query.preset) } : {}),
-        return: `${rtc.baseUrl}${to.fullPath.slice(1)}`
+  const isLoginPage = to.meta.connectLogin === true
+  const isTosPage = to.meta.connectTosPage === true
+
+  if (!isAuthenticated.value && !isLoginPage && !rtc.playwright) {
+    const defaultReturn = `${rtc.baseUrl}${to.fullPath.slice(1)}`
+    const returnUrl = (to.query.return && String(to.query.return)) || defaultReturn
+
+    return navigateTo(
+      {
+        path: localePath('/auth/login'),
+        query: {
+          ...to.query,
+          return: returnUrl
+        }
       }
-    })
+    )
   }
 
   if (isAuthenticated.value) {
     const { data, refresh } = await authApi.getAuthUserProfile()
     await refresh()
     const hasAccepted = data.value?.userTerms.isTermsOfUseAccepted
-    const isTosPage = to.meta.connectTosPage === true
     if (!hasAccepted && !isTosPage) {
       const query = { ...to.query }
       return navigateTo({ path: localePath('/auth/terms-of-use'), query })
-    } else if (hasAccepted && isTosPage) {
-      return finalRedirect(to)
+    } else if (hasAccepted && (isTosPage || isLoginPage)) {
+      return finalRedirect(to, true)
     }
   }
 
@@ -45,14 +51,19 @@ export default defineNuxtRouteMiddleware(async (to) => {
     }
     $connectAuth.authenticated = true
 
-    currentAccount.value = {
-      id: 1,
-      label: 'Playwright',
-      accountStatus: AccountStatus.ACTIVE,
-      accountType: AccountType.PREMIUM,
-      type: UserSettingsType.ACCOUNT,
-      urlorigin: '',
-      urlpath: ''
+    if (rtc.playwrightFetchTestAccount) {
+      // allows each test to mock the account information with its own data
+      await useConnectAccountStore().setAccountInfo()
+    } else {
+      currentAccount.value = {
+        id: 1,
+        label: 'Playwright',
+        accountStatus: AccountStatus.ACTIVE,
+        accountType: AccountType.PREMIUM,
+        type: UserSettingsType.ACCOUNT,
+        urlorigin: '',
+        urlpath: ''
+      }
     }
   }
 })

package/app/pages/auth/login.vue

@@ -12,7 +12,8 @@ useHead({
 definePageMeta({
   layout: 'connect-auth',
   hideBreadcrumbs: true,
-  middleware: 'connect-login-page'
+  middleware: 'connect-auth',
+  connectLogin: true
 })
 
 const isSessionExpired = sessionStorage.getItem(ConnectAuthStorageKey.CONNECT_SESSION_EXPIRED)

package/app/pages/auth/terms-of-use.vue

@@ -70,7 +70,7 @@ const disableButtons = computed<boolean>(() => {
       @submit="patchTermsOfUse({
         accepted: true,
         version: data!.versionId,
-        successCb: async () => await finalRedirect(useRoute()),
+        successCb: async () => await finalRedirect(useRoute(), true),
       })"
     />
   </UContainer>

package/app/stores/connect-account.ts

@@ -1,6 +1,5 @@
 import { getAccountCreateSchema } from '#auth/app/utils/schemas/account'
 import type { AccountProfileSchema } from '#auth/app/utils/schemas/account'
-import type { ConnectCreateAccount } from '#auth/app/interfaces/connect-account'
 
 export const useConnectAccountStore = defineStore('connect-auth-account-store', () => {
   const { $authApi } = useNuxtApp()
@@ -88,13 +87,22 @@ export const useConnectAccountStore = defineStore('connect-auth-account-store',
       await createAccount({
         payload,
         // Update User Contact Info on create account success
-        successCb: async () => await updateUserContact({
-          email: accountFormState.emailAddress,
-          phone: accountFormState.phone.phoneNumber,
-          phoneExtension: accountFormState.phone.ext,
-          successCb: async () => await finalRedirect(useRoute()),
-          errorCb: async () => await finalRedirect(useRoute())
-        })
+        successCb: async (createResponse: ConnectAuthProfile) => {
+          // Refresh and switch to new account prior to redirect
+          if (createResponse?.id) {
+            await setAccountInfo()
+            switchCurrentAccount(createResponse.id)
+          }
+
+          // Update user contact and then redirect regardless of success or failure
+          await updateUserContact({
+            email: accountFormState.emailAddress,
+            phone: accountFormState.phone.phoneNumber,
+            phoneExtension: accountFormState.phone.ext,
+            successCb: async () => await finalRedirect(useRoute()),
+            errorCb: async () => await finalRedirect(useRoute())
+          })
+        }
       })
     } catch (error) {
       // Error handled in useAuthApi
@@ -119,7 +127,7 @@ export const useConnectAccountStore = defineStore('connect-auth-account-store',
 
   /** Get the user's account list */
   async function getUserAccounts(): Promise<ConnectAccount[] | undefined> {
-    if (!authUser.value?.keycloakGuid) {
+    if (!authUser.value?.keycloakGuid && !rtc.playwright) {
       return undefined
     }
     // TODO: use orgs fetch instead to get branch name ? $authApi<UserSettings[]>('/users/orgs')

package/nuxt.config.ts

@@ -77,7 +77,8 @@ export default defineNuxtConfig({
       tokenMinValidity: '',
       sessionInactivityTimeout: '',
       sessionModalTimeout: '',
-      playwright: process.env.playwright === 'true'
+      playwright: process.env.playwright === 'true',
+      playwrightFetchTestAccount: process.env.playwrightFetchTestAccount === 'true'
     }
   }
 })

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sbc-connect/nuxt-auth",
   "type": "module",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "repository": "github:bcgov/connect-nuxt",
   "license": "BSD-3-Clause",
   "main": "./nuxt.config.ts",
@@ -11,9 +11,9 @@
     "nuxt": "4.2.2",
     "typescript": "5.9.3",
     "vue-tsc": "3.2.1",
-    "@sbc-connect/playwright-config": "0.1.0",
-    "@sbc-connect/vitest-config": "0.1.0",
-    "@sbc-connect/eslint-config": "0.0.8"
+    "@sbc-connect/eslint-config": "0.0.8",
+    "@sbc-connect/playwright-config": "0.1.1",
+    "@sbc-connect/vitest-config": "0.1.0"
   },
   "dependencies": {
     "@pinia/colada": "0.20.0",

package/testMocks/auth/index.ts

@@ -0,0 +1,2 @@
+export * from './profile'
+export * from './settings'

package/testMocks/auth/profile/index.ts

@@ -0,0 +1,9 @@
+import fs from 'fs'
+import { createResolver } from 'nuxt/kit'
+
+const { resolve } = createResolver(import.meta.url)
+
+export const getUserProfileMock = () => {
+  const json: ConnectAuthProfile = JSON.parse(fs.readFileSync(resolve('./json/PUBLIC_USER.json'), 'utf8'))
+  return json
+}

package/testMocks/auth/profile/json/PUBLIC_USER.json

@@ -0,0 +1,29 @@
+{
+  "contacts": [
+    {
+      "email": "v9x3z!q__mock@fuzzmail.zzz",
+      "phone": "(902) 555-xyzz",
+      "phoneExtension": "7q1"
+    }
+  ],
+  "created": "2024-03-19T04:92:17+00:00",
+  "firstname": "Nxlqrp3##",
+  "id": 88422,
+  "idpUserid": "ZZ91XQWPMR7T4!$CBA9900PLMNXXQTT",
+  "keycloakGuid": "xxxxxxxx-bb77-49c1-f01a-xxxxxxxxx",
+  "lastname": "T'W&&two--",
+  "loginSource": "BCSC",
+  "loginTime": "2026-01-23T28:77:59+00:00",
+  "modified": "2026-01-23T28:77:59+00:00",
+  "modifiedBy": "Nxlqrp3## T'W&&two--",
+  "type": "PUBLIC_USER",
+  "userStatus": 1,
+  "userTerms": {
+    "isTermsOfUseAccepted": true,
+    "termsOfUseAcceptedVersion": "999x"
+  },
+  "username": "bcsc/zz91xqwpmr7t4!$cba9900plmnxxqtt",
+  "verified": true,
+  "version": 9999
+}
+

package/testMocks/auth/settings/index.ts

@@ -0,0 +1,11 @@
+import fs from 'fs'
+import { createResolver } from 'nuxt/kit'
+
+import type { ConnectAccount } from '#auth/app/interfaces/connect-account'
+
+const { resolve } = createResolver(import.meta.url)
+
+export const getUserSettingsMock = (accountType: AccountType) => {
+  const json: ConnectAccount[] = JSON.parse(fs.readFileSync(resolve(`./json/${accountType}.json`), 'utf8'))
+  return json
+}

package/testMocks/auth/settings/json/PREMIUM.json

@@ -0,0 +1,38 @@
+[
+    {
+        "accountStatus": "ACTIVE",
+        "accountType": "PREMIUM",
+        "additionalLabel": "Test Branch 1",
+        "id": 1222,
+        "label": "Test Tester",
+        "productSettings": "/account/1222/restricted-product",
+        "type": "ACCOUNT",
+        "urlorigin": "https://dev.account.bcregistry.gov.bc.ca",
+        "urlpath": "/account/1222/settings"
+    },
+    {
+        "accountStatus": "ACTIVE",
+        "accountType": "PREMIUM",
+        "additionalLabel": "Test Branch 2",
+        "id": 1223,
+        "label": "Test Tester 2",
+        "productSettings": "/account/1223/restricted-product",
+        "type": "ACCOUNT",
+        "urlorigin": "https://dev.account.bcregistry.gov.bc.ca",
+        "urlpath": "/account/1223/settings"
+    },
+    {
+        "id": 1111,
+        "label": "USER PROFILE",
+        "type": "USER_PROFILE",
+        "urlorigin": "https://dev.account.bcregistry.gov.bc.ca",
+        "urlpath": "/userprofile"
+    },
+    {
+        "id": 1111,
+        "label": "CREATE ACCOUNT",
+        "type": "CREATE_ACCOUNT",
+        "urlorigin": "https://dev.account.bcregistry.gov.bc.ca",
+        "urlpath": "/setup-account"
+    }
+]

package/testMocks/auth/settings/json/SBC_STAFF.json

@@ -0,0 +1,27 @@
+[
+    {
+        "accountStatus": "ACTIVE",
+        "accountType": "SBC_STAFF",
+        "additionalLabel": "Sbc staff example",
+        "id": 1239,
+        "label": "Ministry of Finance",
+        "productSettings": "/account/1239/restricted-product",
+        "type": "ACCOUNT",
+        "urlorigin": "https://dev.account.bcregistry.gov.bc.ca",
+        "urlpath": "/account/1239/settings"
+    },
+    {
+        "id": 1111,
+        "label": "USER PROFILE",
+        "type": "USER_PROFILE",
+        "urlorigin": "https://dev.account.bcregistry.gov.bc.ca",
+        "urlpath": "/userprofile"
+    },
+    {
+        "id": 1111,
+        "label": "CREATE ACCOUNT",
+        "type": "CREATE_ACCOUNT",
+        "urlorigin": "https://dev.account.bcregistry.gov.bc.ca",
+        "urlpath": "/setup-account"
+    }
+]

package/testMocks/auth/settings/json/STAFF.json

@@ -0,0 +1,27 @@
+[
+    {
+        "accountStatus": "ACTIVE",
+        "accountType": "STAFF",
+        "additionalLabel": "BC Registries and Online Services Staff",
+        "id": 1234,
+        "label": "Ministry of Citizens' Services",
+        "productSettings": "/account/1234/restricted-product",
+        "type": "ACCOUNT",
+        "urlorigin": "https://dev.account.bcregistry.gov.bc.ca",
+        "urlpath": "/account/1234/settings"
+    },
+    {
+        "id": 1111,
+        "label": "USER PROFILE",
+        "type": "USER_PROFILE",
+        "urlorigin": "https://dev.account.bcregistry.gov.bc.ca",
+        "urlpath": "/userprofile"
+    },
+    {
+        "id": 1111,
+        "label": "CREATE ACCOUNT",
+        "type": "CREATE_ACCOUNT",
+        "urlorigin": "https://dev.account.bcregistry.gov.bc.ca",
+        "urlpath": "/setup-account"
+    }
+]

package/testMocks/mock-helpers.ts

@@ -0,0 +1,15 @@
+import type { Page } from '@playwright/test'
+import { AccountType } from '#auth/app/enums/account-type'
+import { getUserProfileMock, getUserSettingsMock } from '#auth/testMocks/auth'
+
+export const mockApiCallsForSetAccount = async (
+  page: Page,
+  accountType: AccountType = AccountType.PREMIUM
+) => {
+  page.route('**/users/@me', async (route) => {
+    await route.fulfill({ json: getUserProfileMock() })
+  })
+  page.route('**/users/**/settings', async (route) => {
+    await route.fulfill({ json: getUserSettingsMock(accountType) })
+  })
+}

package/app/middleware/connect-login-page.ts

@@ -1,26 +0,0 @@
-export default defineNuxtRouteMiddleware((to) => {
-  const { isAuthenticated, authUser } = useConnectAuth()
-  const accountStore = useConnectAccountStore()
-  const localePath = useLocalePath()
-  const { finalRedirect } = useConnectAccountFlowRedirect()
-
-  const numAccounts = accountStore.userAccounts.length
-
-  if (isAuthenticated.value) {
-    if (numAccounts === 1) {
-      return finalRedirect(to)
-    }
-
-    if (numAccounts === 0 && authUser.value.loginSource === ConnectLoginSource.BCSC) {
-      return navigateTo({
-        path: localePath('/auth/account/create'),
-        query: to.query
-      })
-    }
-
-    return navigateTo({
-      path: localePath('/auth/account/select'),
-      query: to.query
-    })
-  }
-})