Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions browser_tests/tests/cloud.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import { comfyPageFixture as test } from '@e2e/fixtures/ComfyPage'

const APP_URL = process.env.PLAYWRIGHT_TEST_URL || 'http://localhost:8188'
const SHARE_AUTH_STORAGE_KEY = 'Comfy.PreservedQuery.share_auth'
const SETTINGS_STORAGE_KEY = 'Comfy.PreservedQuery.settings'

/**
* Cloud distribution E2E tests.
Expand Down Expand Up @@ -40,6 +41,22 @@ test.describe('Cloud distribution UI', { tag: '@cloud' }, () => {
.toBe(JSON.stringify({ share: 'abc' }))
})

test('preserves the settings deep link before redirecting logged-out users', async ({
page
}) => {
await page.goto(new URL('/?settings=plan-credits', APP_URL).toString())

await expect(page).toHaveURL(/\/cloud\/login/, { timeout: 10_000 })
await expect
.poll(() =>
page.evaluate(
(key) => sessionStorage.getItem(key),
SETTINGS_STORAGE_KEY
)
)
.toBe(JSON.stringify({ settings: 'plan-credits' }))
})

test('cloud login page renders sign-in options', async ({ page }) => {
await page.goto(APP_URL)
await expect(page).toHaveURL(/\/cloud\/login/, { timeout: 10_000 })
Expand Down
26 changes: 26 additions & 0 deletions src/composables/useUrlActionLoaders.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,14 @@ const mocks = vi.hoisted(() => ({
loadCreateWorkspace: vi.fn(async () => undefined),
loadPricingTable: vi.fn(async () => undefined),
loadTopUp: vi.fn(async () => undefined),
loadSettings: vi.fn(),
loadPaymentReturn: vi.fn(async () => undefined),
resumePendingPricingFlow: vi.fn(async () => undefined),
useInvite: vi.fn(),
useCreateWorkspace: vi.fn(),
usePricingTable: vi.fn(),
useTopUp: vi.fn(),
useSettings: vi.fn(),
usePaymentReturn: vi.fn(),
useSubscriptionDialog: vi.fn()
}))
Expand All @@ -35,6 +37,9 @@ mocks.usePricingTable.mockImplementation(() => ({
mocks.useTopUp.mockImplementation(() => ({
loadTopUpFromUrl: mocks.loadTopUp
}))
mocks.useSettings.mockImplementation(() => ({
loadSettingsFromUrl: mocks.loadSettings
}))
mocks.usePaymentReturn.mockImplementation(() => ({
loadPaymentReturnFromUrl: mocks.loadPaymentReturn
}))
Expand All @@ -55,6 +60,9 @@ vi.mock(
vi.mock('@/platform/cloud/subscription/composables/useTopUpUrlLoader', () => ({
useTopUpUrlLoader: mocks.useTopUp
}))
vi.mock('@/platform/settings/composables/useSettingsUrlLoader', () => ({
useSettingsUrlLoader: mocks.useSettings
}))
vi.mock(
'@/platform/cloud/subscription/composables/usePaymentReturnUrlLoader',
() => ({ usePaymentReturnUrlLoader: mocks.usePaymentReturn })
Expand All @@ -79,6 +87,9 @@ describe('useUrlActionLoaders', () => {
mocks.useTopUp.mockImplementation(() => ({
loadTopUpFromUrl: mocks.loadTopUp
}))
mocks.useSettings.mockImplementation(() => ({
loadSettingsFromUrl: mocks.loadSettings
}))
mocks.usePaymentReturn.mockImplementation(() => ({
loadPaymentReturnFromUrl: mocks.loadPaymentReturn
}))
Expand All @@ -97,12 +108,14 @@ describe('useUrlActionLoaders', () => {
expect(mocks.useCreateWorkspace).not.toHaveBeenCalled()
expect(mocks.usePricingTable).not.toHaveBeenCalled()
expect(mocks.useTopUp).not.toHaveBeenCalled()
expect(mocks.useSettings).not.toHaveBeenCalled()
expect(mocks.usePaymentReturn).not.toHaveBeenCalled()
expect(mocks.useSubscriptionDialog).not.toHaveBeenCalled()
expect(mocks.loadInvite).not.toHaveBeenCalled()
expect(mocks.loadCreateWorkspace).not.toHaveBeenCalled()
expect(mocks.loadPricingTable).not.toHaveBeenCalled()
expect(mocks.loadTopUp).not.toHaveBeenCalled()
expect(mocks.loadSettings).not.toHaveBeenCalled()
expect(mocks.loadPaymentReturn).not.toHaveBeenCalled()
expect(mocks.resumePendingPricingFlow).not.toHaveBeenCalled()
})
Expand All @@ -115,6 +128,7 @@ describe('useUrlActionLoaders', () => {
expect(mocks.loadCreateWorkspace).toHaveBeenCalledOnce()
expect(mocks.loadPricingTable).toHaveBeenCalledOnce()
expect(mocks.loadTopUp).toHaveBeenCalledOnce()
expect(mocks.loadSettings).toHaveBeenCalledOnce()
expect(mocks.loadPaymentReturn).toHaveBeenCalledOnce()
})

Expand Down Expand Up @@ -155,6 +169,18 @@ describe('useUrlActionLoaders', () => {
await expect(runUrlActionLoaders()).resolves.toBeUndefined()

expect(mocks.loadPricingTable).toHaveBeenCalledOnce()
expect(mocks.loadSettings).toHaveBeenCalledOnce()
expect(mocks.loadPaymentReturn).toHaveBeenCalledOnce()
})

it('isolates a settings-loader failure so it does not abort the boot chain', async () => {
mocks.loadSettings.mockImplementationOnce(() => {
throw new Error('boom')
})

const { runUrlActionLoaders } = useUrlActionLoaders()
await expect(runUrlActionLoaders()).resolves.toBeUndefined()

expect(mocks.loadPaymentReturn).toHaveBeenCalledOnce()
expect(mocks.resumePendingPricingFlow).toHaveBeenCalledOnce()
})
Expand Down
20 changes: 17 additions & 3 deletions src/composables/useUrlActionLoaders.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,15 @@ import { usePricingTableUrlLoader } from '@/platform/cloud/subscription/composab
import { useSubscriptionDialog } from '@/platform/cloud/subscription/composables/useSubscriptionDialog'
import { useTopUpUrlLoader } from '@/platform/cloud/subscription/composables/useTopUpUrlLoader'
import { isCloud } from '@/platform/distribution/types'
import { useSettingsUrlLoader } from '@/platform/settings/composables/useSettingsUrlLoader'
import { useCreateWorkspaceUrlLoader } from '@/platform/workspace/composables/useCreateWorkspaceUrlLoader'
import { useInviteUrlLoader } from '@/platform/workspace/composables/useInviteUrlLoader'

/**
* Aggregates the query-param "deep link" loaders the cloud app checks on mount
* (`?invite`, `?create_workspace`, `?pricing`, `?topup`), then recovers an
* interrupted checkout. The loaders are instantiated in setup so their
* `useRoute`/`useRouter` resolve; call `runUrlActionLoaders()` from
* (`?invite`, `?create_workspace`, `?pricing`, `?topup`, `?settings`), then
* recovers an interrupted checkout. The loaders are instantiated in setup so
* their `useRoute`/`useRouter` resolve; call `runUrlActionLoaders()` from
* `onMounted` once the app is ready.
*/
export function useUrlActionLoaders() {
Expand All @@ -20,6 +21,7 @@ export function useUrlActionLoaders() {
: null
const pricingTableUrlLoader = isCloud ? usePricingTableUrlLoader() : null
const topUpUrlLoader = isCloud ? useTopUpUrlLoader() : null
const settingsUrlLoader = isCloud ? useSettingsUrlLoader() : null
const paymentReturnUrlLoader = isCloud ? usePaymentReturnUrlLoader() : null
const subscriptionDialog = isCloud ? useSubscriptionDialog() : null

Expand Down Expand Up @@ -66,6 +68,18 @@ export function useUrlActionLoaders() {
}
}

// Open a Settings panel from URL if present (e.g. ?settings=plan-credits).
if (settingsUrlLoader) {
try {
settingsUrlLoader.loadSettingsFromUrl()
} catch (error) {
console.error(
'[UrlActionLoaders] Failed to load settings panel from URL:',
error
)
}
}

// Handle the return leg of a redirect payment (Stripe appends
// payment_intent/redirect_status params): strip the params and refresh
// billing status so the pending checkout resumes polling immediately.
Expand Down
1 change: 1 addition & 0 deletions src/platform/navigation/preservedQueryNamespaces.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,6 @@ export const PRESERVED_QUERY_NAMESPACES = {
OAUTH: 'oauth',
PRICING: 'pricing',
TOPUP: 'topup',
SETTINGS: 'settings',
DESKTOP_LOGIN: 'desktop_login'
} as const
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
import { beforeEach, describe, expect, it, vi } from 'vitest'
import type * as VueRouter from 'vue-router'
import type { Router } from 'vue-router'
import { createMemoryHistory, createRouter } from 'vue-router'

import { clearPreservedQuery } from '@/platform/navigation/preservedQueryManager'
import { PRESERVED_QUERY_NAMESPACES } from '@/platform/navigation/preservedQueryNamespaces'
import { installPreservedQueryTracker } from '@/platform/navigation/preservedQueryTracker'
import { useSettingsUrlLoader } from '@/platform/settings/composables/useSettingsUrlLoader'

const STORAGE_KEY = 'Comfy.PreservedQuery.settings'

let testRouter: Router

vi.mock('vue-router', async (importOriginal) => {
const actual = await importOriginal<typeof VueRouter>()
return {
...actual,
useRoute: () => testRouter.currentRoute.value,
useRouter: () => testRouter
}
})

const mockShowSettings = vi.hoisted(() => vi.fn())

vi.mock('@/platform/settings/composables/useSettingsDialog', () => ({
useSettingsDialog: () => ({
show: mockShowSettings
})
}))

function createAppLikeRouter(): Router {
const router = createRouter({
history: createMemoryHistory(),
routes: [{ path: '/:pathMatch(.*)*', component: { template: '<div />' } }]
})
installPreservedQueryTracker(router, [
{
namespace: PRESERVED_QUERY_NAMESPACES.SETTINGS,
keys: ['settings']
}
])
return router
}

describe('useSettingsUrlLoader with real preserved-query boundaries', () => {
beforeEach(() => {
clearPreservedQuery(PRESERVED_QUERY_NAMESPACES.SETTINGS)
sessionStorage.clear()
testRouter = createAppLikeRouter()
})

it('opens Plans & Credits and cleans the URL when the param survives to mount', async () => {
await testRouter.push('/?settings=plan-credits&keep=1')

const { loadSettingsFromUrl } = useSettingsUrlLoader()
loadSettingsFromUrl()

expect(mockShowSettings).toHaveBeenCalledExactlyOnceWith('workspace')
await vi.waitFor(() =>
expect(testRouter.currentRoute.value.fullPath).toBe('/?keep=1')
)
expect(sessionStorage.getItem(STORAGE_KEY)).toBeNull()
})

it('restores the deep link through a login redirect that drops the query', async () => {
await testRouter.push('/?settings=plan-credits')
expect(sessionStorage.getItem(STORAGE_KEY)).toBe(
JSON.stringify({ settings: 'plan-credits' })
)

await testRouter.push('/cloud/login')
await testRouter.push('/')

const { loadSettingsFromUrl } = useSettingsUrlLoader()
loadSettingsFromUrl()

expect(mockShowSettings).toHaveBeenCalledExactlyOnceWith('workspace')
await vi.waitFor(() =>
expect(testRouter.currentRoute.value.fullPath).toBe('/')
)
expect(sessionStorage.getItem(STORAGE_KEY)).toBeNull()
})

it('consumes the stash so a later mount does not reopen the dialog', async () => {
await testRouter.push('/?settings=plan-credits')
await testRouter.push('/')
useSettingsUrlLoader().loadSettingsFromUrl()
mockShowSettings.mockClear()

await testRouter.push('/')
useSettingsUrlLoader().loadSettingsFromUrl()

expect(mockShowSettings).not.toHaveBeenCalled()
})

it('strips an unrecognized value without opening or leaving a stash behind', async () => {
await testRouter.push('/?settings=garbage')

const { loadSettingsFromUrl } = useSettingsUrlLoader()
loadSettingsFromUrl()

expect(mockShowSettings).not.toHaveBeenCalled()
await vi.waitFor(() =>
expect(testRouter.currentRoute.value.fullPath).toBe('/')
)
expect(sessionStorage.getItem(STORAGE_KEY)).toBeNull()
})
})
Loading
Loading