Files
ComfyUI_frontend/src/router.ts
Christian Byrne 62979e3818 refactor: rename firebaseAuthStore to authStore with shared test fixtures (#10483)
## Summary

Rename `useFirebaseAuthStore` → `useAuthStore` and
`FirebaseAuthStoreError` → `AuthStoreError`. Introduce shared mock
factory (`authStoreMock.ts`) to replace 16 independent bespoke mocks.

## Changes

- **What**: Mechanical rename of store, composable, class, and store ID
(`firebaseAuth` → `auth`). Created
`src/stores/__tests__/authStoreMock.ts` — a shared mock factory with
reactive controls, used by all consuming test files. Migrated all 16
test files from ad-hoc mocks to the shared factory.
- **Files**: 62 files changed (rename propagation + new test infra)

## Review Focus

- Mock factory API design in `authStoreMock.ts` — covers all store
properties with reactive `controls` for per-test customization
- Self-test in `authStoreMock.test.ts` validates computed reactivity

Fixes #8219

## Stack

This is PR 1/5 in a stacked refactoring series:
1. **→ This PR**: Rename + shared test fixtures
2. #10484: Extract auth-routing from workspaceApi
3. #10485: Auth token priority tests
4. #10486: Decompose MembersPanelContent
5. #10487: Consolidate SubscriptionTier type

---------

Co-authored-by: Alexander Brown <drjkl@comfy.org>
2026-03-27 00:31:11 -07:00

239 lines
6.7 KiB
TypeScript

import { until } from '@vueuse/core'
import { storeToRefs } from 'pinia'
import {
createRouter,
createWebHashHistory,
createWebHistory
} from 'vue-router'
import type { RouteLocationNormalized } from 'vue-router'
import { useFeatureFlags } from '@/composables/useFeatureFlags'
import { isCloud, isDesktop } from '@/platform/distribution/types'
import { useTelemetry } from '@/platform/telemetry'
import { useDialogService } from '@/services/dialogService'
import { useAuthStore } from '@/stores/authStore'
import { useUserStore } from '@/stores/userStore'
import LayoutDefault from '@/views/layouts/LayoutDefault.vue'
import { installPreservedQueryTracker } from '@/platform/navigation/preservedQueryTracker'
import { PRESERVED_QUERY_NAMESPACES } from '@/platform/navigation/preservedQueryNamespaces'
const cloudOnboardingRoutes = isCloud
? (await import('./platform/cloud/onboarding/onboardingCloudRoutes'))
.cloudOnboardingRoutes
: []
const isFileProtocol = window.location.protocol === 'file:'
/**
* Determine base path for the router.
* - Electron: always root
* - Cloud: use Vite's BASE_URL (configured at build time)
* - Standard web (including reverse proxy subpaths): use window.location.pathname
* to support deployments like http://mysite.com/ComfyUI/
*/
function getBasePath(): string {
if (isDesktop) return '/'
if (isCloud) return import.meta.env?.BASE_URL || '/'
return window.location.pathname
}
const basePath = getBasePath()
function trackPageView(): void {
if (!isCloud || typeof window === 'undefined') return
useTelemetry()?.trackPageView(document.title, {
path: window.location.href
})
}
const router = createRouter({
history: isFileProtocol
? createWebHashHistory()
: // Base path must be specified to ensure correct relative paths
// Example: For URL 'http://localhost:7801/ComfyBackendDirect',
// we need this base path or assets will incorrectly resolve from 'http://localhost:7801/'
createWebHistory(basePath),
routes: [
...(isCloud ? cloudOnboardingRoutes : []),
{
path: '/',
component: LayoutDefault,
children: [
{
path: '',
name: 'GraphView',
component: () => import('@/views/GraphView.vue'),
beforeEnter: async (_to, _from, next) => {
// Then check user store
const userStore = useUserStore()
await userStore.initialize()
if (userStore.needsLogin) {
next('/user-select')
} else {
next()
}
}
},
{
path: 'user-select',
name: 'UserSelectView',
component: () => import('@/views/UserSelectView.vue')
}
]
}
],
scrollBehavior(_to, _from, savedPosition) {
if (savedPosition) {
return savedPosition
} else {
return { top: 0 }
}
}
})
installPreservedQueryTracker(router, [
{
namespace: PRESERVED_QUERY_NAMESPACES.TEMPLATE,
keys: ['template', 'source', 'mode']
},
{
namespace: PRESERVED_QUERY_NAMESPACES.SHARE,
keys: ['share']
},
{
namespace: PRESERVED_QUERY_NAMESPACES.INVITE,
keys: ['invite']
},
{
namespace: PRESERVED_QUERY_NAMESPACES.CREATE_WORKSPACE,
keys: ['create_workspace']
}
])
router.afterEach(() => {
trackPageView()
})
if (isCloud) {
const { flags } = useFeatureFlags()
const PUBLIC_ROUTE_NAMES = new Set([
'cloud-login',
'cloud-signup',
'cloud-forgot-password',
'cloud-sorry-contact-support'
])
const PUBLIC_ROUTE_PATHS = new Set([
'/cloud/login',
'/cloud/signup',
'/cloud/forgot-password',
'/cloud/sorry-contact-support'
])
function isPublicRoute(to: RouteLocationNormalized) {
const name = String(to.name)
if (PUBLIC_ROUTE_NAMES.has(name)) return true
const path = to.path
return PUBLIC_ROUTE_PATHS.has(path)
}
// Global authentication guard
router.beforeEach(async (to, _from, next) => {
const authStore = useAuthStore()
// Wait for Firebase auth to initialize
// Timeout after 16 seconds
if (!authStore.isInitialized) {
try {
const { isInitialized } = storeToRefs(authStore)
await until(isInitialized).toBe(true, { timeout: 16_000 })
} catch (error) {
console.error('Auth initialization failed:', error)
return next({ name: 'cloud-auth-timeout' })
}
}
// Pass authenticated users
const authHeader = await authStore.getAuthHeader()
const isLoggedIn = !!authHeader
// Allow public routes
if (isPublicRoute(to)) {
return next()
}
// Special handling for user-check
// These routes need auth but handle their own routing logic
if (to.name === 'cloud-user-check') {
if (to.meta.requiresAuth && !isLoggedIn) {
return next({ name: 'cloud-login' })
}
return next()
}
// Prevent redirect loop when coming from user-check
if (_from.name === 'cloud-user-check' && to.path === '/') {
return next()
}
const query =
to.fullPath === '/'
? undefined
: { previousFullPath: encodeURIComponent(to.fullPath) }
// Check if route requires authentication
if (to.meta.requiresAuth && !isLoggedIn) {
return next({
name: 'cloud-login',
query
})
}
// Handle other protected routes
if (!isLoggedIn) {
// For Electron, use dialog
if (isDesktop) {
const dialogService = useDialogService()
const loginSuccess = await dialogService.showSignInDialog()
return loginSuccess ? next() : next(false)
}
// For web, redirect to login
return next({
name: 'cloud-login',
query
})
}
// User is logged in - check if they need onboarding (when enabled)
// For root path, check actual user status to handle waitlisted users
if (!isDesktop && isLoggedIn && to.path === '/') {
if (!flags.onboardingSurveyEnabled) {
return next()
}
// Import auth functions dynamically to avoid circular dependency
const { getSurveyCompletedStatus } =
await import('@/platform/cloud/onboarding/auth')
try {
// Check user's actual status
const surveyCompleted = await getSurveyCompletedStatus()
// Survey is required for all users (when feature flag enabled)
if (!surveyCompleted) {
return next({ name: 'cloud-survey' })
}
} catch (error) {
console.error('Failed to check user status:', error)
// On error, redirect to user-check as fallback
return next({ name: 'cloud-user-check' })
}
}
// User is logged in and accessing protected route
return next()
})
}
export default router