diff --git a/src/main/apps/appPageView.test.ts b/src/main/apps/appPageView.test.ts index c8bffe08d..1c094fad9 100644 --- a/src/main/apps/appPageView.test.ts +++ b/src/main/apps/appPageView.test.ts @@ -63,7 +63,6 @@ import { _resetForTest, captureAppPage, hideAppPage, - reloadAppPage, showAppPage } from './appPageView' @@ -187,7 +186,7 @@ function sentToPanel(channel: string): unknown[][] { } function lastStatusSentToPanel(): unknown { - return sentToPanel(APP_PAGE_STATUS_CHANNEL).at(-1)?.[1] + return sentToPanel(APP_PAGE_STATUS_CHANNEL).at(-1)?.[2] } function openCutout(placement: Record = PLACEMENT): Promise { @@ -484,7 +483,7 @@ describe('an app page that cannot load', () => { reason: 'network' }) - reloadAppPage(panelContents()) + expect(await openCutout({ ...PLACEMENT, retry: true })).toBe('loading') expect(lastStatusSentToPanel()).toBe('loading') expect(hostedPage().webContents.loadURL).toHaveBeenCalledTimes(2) expect(hostedPage().webContents.loadURL).toHaveBeenLastCalledWith(CUTOUT_URL) @@ -492,6 +491,88 @@ describe('an app page that cannot load', () => { finishLoading() expect(hostedPage().visible).toBe(true) expect(lastStatusSentToPanel()).toBe('ready') + expect(mocks.capture).not.toHaveBeenCalledWith(APP_OPENED_EVENT, expect.anything()) + }) + + it('follows a redirect that stays on the apps site while the page loads', async () => { + await openCutout() + const event = navigationEvent() + hostedPage().webContents.emit('will-redirect', event, `${CUTOUT_URL}?v=2`, false, true) + + expect(event.preventDefault).not.toHaveBeenCalled() + expect(mocks.capture).not.toHaveBeenCalledWith(APP_PAGE_FAILED_EVENT, expect.anything()) + + finishLoading(`${CUTOUT_URL}?v=2`) + expect(lastStatusSentToPanel()).toBe('ready') + }) + + it('says the page did not load, without opening the browser, when the site sends it to another site while it loads', async () => { + await openCutout() + const event = navigationEvent() + hostedPage().webContents.emit( + 'will-redirect', + event, + 'https://www.comfy.org/apps/', + false, + true + ) + + expect(event.preventDefault).toHaveBeenCalled() + expect(mocks.openExternal).not.toHaveBeenCalled() + expect(hostedPage().visible).toBe(false) + expect(lastStatusSentToPanel()).toBe('failed') + expect(mocks.capture).toHaveBeenCalledWith(APP_PAGE_FAILED_EVENT, { + app_id: CUTOUT, + reason: 'redirected' + }) + }) + + it('asks again whether a refused app may open when the person retries it, and loads it once it may', async () => { + await openCutout() + finishLoading() + hideAppPage(panelContents()) + mocks.pages.delete(UPSCALE) + expect(await showAppPage(panelContents(), UPSCALE, PLACEMENT)).toBe('failed') + + expect(await showAppPage(panelContents(), UPSCALE, { ...PLACEMENT, retry: true })).toBe( + 'failed' + ) + expect(hostedPage().webContents.loadURL).toHaveBeenCalledTimes(1) + expect(hostedPage().visible).toBe(false) + + mocks.pages.set(UPSCALE, UPSCALE_URL) + expect(await showAppPage(panelContents(), UPSCALE, { ...PLACEMENT, retry: true })).toBe( + 'loading' + ) + expect(hostedPage().webContents.loadURL).toHaveBeenLastCalledWith(UPSCALE_URL) + finishLoading(UPSCALE_URL) + expect(hostedPage().visible).toBe(true) + }) + + it('does not load a failed app again on Try again once Apps is switched off', async () => { + await openCutout() + finishLoading(CUTOUT_URL, 503) + mocks.appsEnabled = false + + expect(await openCutout({ ...PLACEMENT, retry: true })).toBe('failed') + expect(hostedPage().webContents.loadURL).toHaveBeenCalledTimes(1) + expect(hostedPage().visible).toBe(false) + }) + + it("names the app with every status, so the panel can tell a hidden app's page from the one it shows", async () => { + await openCutout() + hideAppPage(panelContents()) + mocks.pages.delete(UPSCALE) + expect(await showAppPage(panelContents(), UPSCALE, PLACEMENT)).toBe('failed') + + finishLoading() + + expect(sentToPanel(APP_PAGE_STATUS_CHANNEL).at(-1)).toEqual([ + APP_PAGE_STATUS_CHANNEL, + CUTOUT, + 'ready' + ]) + expect(hostedPage().visible).toBe(false) }) it('tries a failed app again when the person opens it once more', async () => { diff --git a/src/main/apps/appPageView.ts b/src/main/apps/appPageView.ts index 0225555bd..a41b6d98d 100644 --- a/src/main/apps/appPageView.ts +++ b/src/main/apps/appPageView.ts @@ -27,7 +27,7 @@ const NAVIGATION_ABORTED = -3 const FIRST_HTTP_ERROR_STATUS = 400 const PAGE_PERMISSIONS: ReadonlySet = new Set(['clipboard-sanitized-write', 'fullscreen']) -type PageFailure = 'http_status' | 'network' | 'crashed' +type PageFailure = 'http_status' | 'network' | 'crashed' | 'redirected' interface HostedPage { view: WebContentsView @@ -101,7 +101,7 @@ function setStatus(windowKey: number, hosted: HostedPage, status: AppPageStatus) if (hosted.status === status) return hosted.status = status applyVisibility(hosted) - panelOf(windowKey)?.send(APP_PAGE_STATUS_CHANNEL, status) + panelOf(windowKey)?.send(APP_PAGE_STATUS_CHANNEL, hosted.appId, status) } function fail(windowKey: number, hosted: HostedPage, reason: PageFailure): void { @@ -167,7 +167,13 @@ function createHostedPage({ windowKey, entry }: PageHost, location: AppsLocation } contents.on('will-navigate', (event, url) => steer(event, url, true)) contents.on('will-redirect', (event, url, _isInPlace, isMainFrame) => { - if (isMainFrame) steer(event, url, false) + if (!isMainFrame) return + if (hosted.status === 'loading' && !isInAppsScope(location, url)) { + event.preventDefault() + fail(windowKey, hosted, 'redirected') + return + } + steer(event, url, false) }) contents.setWindowOpenHandler(({ url }) => { openOutside(url) @@ -218,10 +224,18 @@ function isMeasure(value: unknown): value is number { function parsePlacement(raw: unknown): AppPagePlacement | null { if (!raw || typeof raw !== 'object') return null - const { x, y, width, height, cornerRadius, justOpened } = raw as Record + const { x, y, width, height, cornerRadius, justOpened, retry } = raw as Record if (!isMeasure(x) || !isMeasure(y) || !isMeasure(width) || !isMeasure(height)) return null if (!isMeasure(cornerRadius)) return null - return { x, y, width, height, cornerRadius, justOpened: justOpened === true } + return { + x, + y, + width, + height, + cornerRadius, + justOpened: justOpened === true, + retry: retry === true + } } function place(entry: ComfyWindowEntry, view: WebContentsView, placement: AppPagePlacement): void { @@ -275,14 +289,15 @@ export async function showAppPage( if (!pageUrl || !host) return 'failed' const hosted = hostedFor(host) ?? createHostedPage(host, currentAppsLocation()) concealWhenPanelGoes(host.windowKey, panel) - const retriesFailedPage = placement.justOpened === true && hosted.status === 'failed' + const askedFresh = placement.justOpened === true || placement.retry === true + const retriesFailedPage = askedFresh && hosted.status === 'failed' if (hosted.appId !== appId || retriesFailedPage) { hosted.appId = appId load(host.windowKey, hosted, pageUrl) } if (placement.justOpened) mainTelemetry.capture(APP_OPENED_EVENT, { app_id: appId }) hosted.wanted = true - hosted.focusWhenReady = hosted.focusWhenReady || placement.justOpened === true + hosted.focusWhenReady = hosted.focusWhenReady || askedFresh place(host.entry, hosted.view, placement) raiseAbovePanel(host.entry, hosted.view) applyVisibility(hosted) @@ -307,14 +322,6 @@ export async function captureAppPage(panel: WebContents): Promise } } -export function reloadAppPage(panel: WebContents): void { - const host = hostOf(panel) - const hosted = host && hostedFor(host) - const pageUrl = hosted?.appId ? pageUrlForListedApp(hosted.appId) : null - if (!host || !hosted || !pageUrl) return - load(host.windowKey, hosted, pageUrl) -} - export function _resetForTest(): void { hostedByWindow.clear() } diff --git a/src/main/lib/ipc/registerAppsHandlers.ts b/src/main/lib/ipc/registerAppsHandlers.ts index bd3e6f7b2..3e7168cb6 100644 --- a/src/main/lib/ipc/registerAppsHandlers.ts +++ b/src/main/lib/ipc/registerAppsHandlers.ts @@ -1,6 +1,6 @@ import { ipcMain } from 'electron' -import { captureAppPage, hideAppPage, reloadAppPage, showAppPage } from '../../apps/appPageView' +import { captureAppPage, hideAppPage, showAppPage } from '../../apps/appPageView' import { listApps } from '../../apps/appsCatalog' import { areAppsEnabled } from '../../apps/appsConfig' import { isPanelSender } from '../../host/registry' @@ -20,6 +20,4 @@ export function registerAppsHandlers(): void { ipcMain.handle('apps:capture-page', (event) => captureAppPage(event.sender)) ipcMain.on('apps:hide-page', (event) => hideAppPage(event.sender)) - - ipcMain.on('apps:reload-page', (event) => reloadAppPage(event.sender)) } diff --git a/src/preload/api.ts b/src/preload/api.ts index d798accf9..0822465fe 100644 --- a/src/preload/api.ts +++ b/src/preload/api.ts @@ -110,9 +110,12 @@ export function buildElectronApi(): ElectronApi { showAppPage: (appId, placement) => ipcRenderer.invoke('apps:show-page', appId, placement), captureAppPage: () => ipcRenderer.invoke('apps:capture-page'), hideAppPage: () => ipcRenderer.send('apps:hide-page'), - reloadAppPage: () => ipcRenderer.send('apps:reload-page'), onAppPageStatusChanged: (callback) => { - const handler = (_event: IpcRendererEvent, status: AppPageStatus): void => callback(status) + const handler = ( + _event: IpcRendererEvent, + appId: string | null, + status: AppPageStatus + ): void => callback(appId, status) ipcRenderer.on('apps:page-status-changed', handler) return () => ipcRenderer.removeListener('apps:page-status-changed', handler) }, diff --git a/src/renderer/src/panel/AppPageHost.test.ts b/src/renderer/src/panel/AppPageHost.test.ts index 1d027fb4c..523d6a264 100644 --- a/src/renderer/src/panel/AppPageHost.test.ts +++ b/src/renderer/src/panel/AppPageHost.test.ts @@ -16,16 +16,19 @@ const FRAME = const showAppPage = vi.fn<(appId: string, placement: AppPagePlacement) => Promise>() const captureAppPage = vi.fn<() => Promise>() const hideAppPage = vi.fn() -const reloadAppPage = vi.fn() const mountPointFillsThePage = document.createElement('style') mountPointFillsThePage.textContent = '[data-apps-page] > div { display: flex; flex: 1 1 auto; }' document.head.append(mountPointFillsThePage) let page: HTMLElement -let tellStatus: (status: AppPageStatus) => void = () => {} +let tellStatusOf: (appId: string | null, status: AppPageStatus) => void = () => {} let stoppedListening = false +function tellStatus(status: AppPageStatus): void { + tellStatusOf('remove-background', status) +} + async function nextFrame(): Promise { await new Promise((resolve) => requestAnimationFrame(() => resolve())) await flushPromises() @@ -63,9 +66,8 @@ beforeEach(() => { showAppPage, captureAppPage, hideAppPage, - reloadAppPage, - onAppPageStatusChanged: (listener: (status: AppPageStatus) => void) => { - tellStatus = listener + onAppPageStatusChanged: (listener: (appId: string | null, status: AppPageStatus) => void) => { + tellStatusOf = listener return () => { stoppedListening = true } @@ -88,7 +90,8 @@ describe('AppPageHost', () => { width: PAGE_WIDTH, height: PAGE_HEIGHT, cornerRadius: 14, - justOpened: true + justOpened: true, + retry: false }) }) @@ -129,9 +132,15 @@ describe('AppPageHost', () => { "Remove Background didn't load" ) + showAppPage.mockClear() + showAppPage.mockResolvedValue('loading') await wrapper.get('[data-testid="app-page-retry"]').trigger('click') + await flushPromises() - expect(reloadAppPage).toHaveBeenCalledTimes(1) + expect(showAppPage).toHaveBeenCalledExactlyOnceWith( + 'remove-background', + expect.objectContaining({ justOpened: false, retry: true }) + ) expect(wrapper.get('[data-testid="app-page-loading"]').isVisible()).toBe(true) tellStatus('failed') @@ -141,6 +150,34 @@ describe('AppPageHost', () => { expect(wrapper.emitted('close')).toHaveLength(1) }) + it('asks for a fresh load only on the Try again that was pressed, not on the next resize', async () => { + const wrapper = await mountHost('failed') + showAppPage.mockResolvedValue('loading') + await wrapper.get('[data-testid="app-page-retry"]').trigger('click') + await flushPromises() + showAppPage.mockClear() + + page.style.width = `${PAGE_WIDTH - 180}px` + await nextFrame() + await nextFrame() + + expect(showAppPage).toHaveBeenLastCalledWith( + 'remove-background', + expect.objectContaining({ justOpened: false, retry: false }) + ) + }) + + it("keeps saying the app did not load when another app's hidden page finishes", async () => { + const wrapper = await mountHost('failed') + + tellStatusOf('upscale', 'ready') + tellStatusOf(null, 'loading') + await flushPromises() + + expect(wrapper.get('[data-testid="app-page-failed"]').isVisible()).toBe(true) + expect(wrapper.get('[data-testid="app-page-host"]').attributes('data-status')).toBe('failed') + }) + it('follows the host when it is resized, without counting another opening', async () => { await mountHost() showAppPage.mockClear() diff --git a/src/renderer/src/panel/AppPageHost.vue b/src/renderer/src/panel/AppPageHost.vue index ac9989d87..642e04937 100644 --- a/src/renderer/src/panel/AppPageHost.vue +++ b/src/renderer/src/panel/AppPageHost.vue @@ -23,6 +23,7 @@ const status = ref(null) const frozenFrame = ref(null) let justOpened = true +let retrying = false let latestTurn = 0 let stopStatusUpdates: (() => void) | null = null @@ -38,9 +39,11 @@ function takePlacement(): AppPagePlacement | null { width: rect.width, height: rect.height, cornerRadius, - justOpened + justOpened, + retry: retrying } justOpened = false + retrying = false return placement } @@ -73,7 +76,8 @@ async function conceal(): Promise { function retry(): void { status.value = 'loading' - window.api.reloadAppPage() + retrying = true + void reveal() } watch(covered, (isCovered) => void (isCovered ? conceal() : reveal())) @@ -93,8 +97,8 @@ useResizeObserver(host, () => { }) onMounted(() => { - stopStatusUpdates = window.api.onAppPageStatusChanged((next) => { - status.value = next + stopStatusUpdates = window.api.onAppPageStatusChanged((pageAppId, next) => { + if (pageAppId === appId) status.value = next }) if (!covered.value) void reveal() }) diff --git a/src/renderer/src/panel/AppsView.test.ts b/src/renderer/src/panel/AppsView.test.ts index 327ef052b..2ee89002e 100644 --- a/src/renderer/src/panel/AppsView.test.ts +++ b/src/renderer/src/panel/AppsView.test.ts @@ -74,7 +74,6 @@ beforeEach(() => { showAppPage, captureAppPage: vi.fn().mockResolvedValue(null), hideAppPage, - reloadAppPage: vi.fn(), onAppPageStatusChanged: vi.fn(() => () => {}), onAppPageClosed: (listener: () => void) => { appPageClosed = listener diff --git a/src/renderer/src/panel/PanelApp.test.ts b/src/renderer/src/panel/PanelApp.test.ts index 89f7cce75..f7fc00b63 100644 --- a/src/renderer/src/panel/PanelApp.test.ts +++ b/src/renderer/src/panel/PanelApp.test.ts @@ -399,7 +399,6 @@ function installMockApi(initial?: { showAppPage: vi.fn(async () => 'loading'), captureAppPage: vi.fn(async () => null), hideAppPage: vi.fn(), - reloadAppPage: vi.fn(), onAppPageStatusChanged: vi.fn(() => () => {}), onAppPageClosed: vi.fn(() => () => {}), getListActions: vi.fn(async () => []), diff --git a/src/types/ipc.ts b/src/types/ipc.ts index d651078c0..f2e198dd9 100644 --- a/src/types/ipc.ts +++ b/src/types/ipc.ts @@ -145,6 +145,7 @@ export interface AppPagePlacement { height: number cornerRadius: number justOpened?: boolean + retry?: boolean } export interface CatalogWorkflow { @@ -1170,8 +1171,9 @@ export interface ElectronApi { showAppPage(appId: string, placement: AppPagePlacement): Promise captureAppPage(): Promise hideAppPage(): void - reloadAppPage(): void - onAppPageStatusChanged(callback: (status: AppPageStatus) => void): () => void + onAppPageStatusChanged( + callback: (appId: string | null, status: AppPageStatus) => void + ): () => void onAppPageClosed(callback: () => void): () => void getBuildStorageSnapshot(): Promise resolveStartupRestoreReveal(result: 'takeover-ready' | 'dashboard-fallback'): void