@volley/vwr-loader 1.6.0 → 1.7.0

package/src/exitHandler.test.ts

@@ -1,417 +0,0 @@
-import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"
-
-import {
-    exitIfBackNavigation,
-    setupFireTVBackButtonHandler,
-    setupLGBackButtonHandler,
-} from "./exitHandler"
-import { logger } from "./logger"
-
-describe("exitHandler", () => {
-    beforeEach(() => {
-        vi.clearAllMocks()
-    })
-
-    afterEach(() => {
-        vi.restoreAllMocks()
-    })
-
-    describe("exitIfBackNavigation", () => {
-        it("should not exit when navigation type is not back_forward", () => {
-            vi.spyOn(performance, "getEntriesByType").mockReturnValue([
-                { type: "navigate" } as PerformanceNavigationTiming,
-            ])
-
-            const mockExit = vi.fn()
-            window.tizen = {
-                application: {
-                    getAppInfo: () => ({ version: "1.0.0" }),
-                    getCurrentApplication: () => ({ exit: mockExit }),
-                },
-            }
-
-            exitIfBackNavigation("SAMSUNG_TV")
-
-            expect(mockExit).not.toHaveBeenCalled()
-        })
-
-        it("should exit Samsung app when back_forward detected", () => {
-            vi.spyOn(performance, "getEntriesByType").mockReturnValue([
-                { type: "back_forward" } as PerformanceNavigationTiming,
-            ])
-
-            const mockExit = vi.fn()
-            window.tizen = {
-                application: {
-                    getAppInfo: () => ({ version: "1.0.0" }),
-                    getCurrentApplication: () => ({ exit: mockExit }),
-                },
-            }
-
-            exitIfBackNavigation("SAMSUNG_TV")
-
-            expect(mockExit).toHaveBeenCalled()
-        })
-
-        it("should close window for LG app when back_forward detected", () => {
-            vi.spyOn(performance, "getEntriesByType").mockReturnValue([
-                { type: "back_forward" } as PerformanceNavigationTiming,
-            ])
-
-            const mockClose = vi.fn()
-            vi.spyOn(window, "close").mockImplementation(mockClose)
-
-            exitIfBackNavigation("LG_TV")
-
-            expect(mockClose).toHaveBeenCalled()
-        })
-
-        it("should not exit when no navigation entries exist", () => {
-            vi.spyOn(performance, "getEntriesByType").mockReturnValue([])
-
-            const mockClose = vi.fn()
-            vi.spyOn(window, "close").mockImplementation(mockClose)
-
-            exitIfBackNavigation("LG_TV")
-
-            expect(mockClose).not.toHaveBeenCalled()
-        })
-
-        it("should handle errors gracefully", () => {
-            vi.spyOn(performance, "getEntriesByType").mockImplementation(() => {
-                throw new Error("Performance API not available")
-            })
-
-            // Should not throw
-            expect(() => exitIfBackNavigation("SAMSUNG_TV")).not.toThrow()
-        })
-
-        it("should exit Fire TV app when back_forward detected", () => {
-            vi.spyOn(performance, "getEntriesByType").mockReturnValue([
-                { type: "back_forward" } as PerformanceNavigationTiming,
-            ])
-
-            const mockExitApp = vi.fn().mockResolvedValue(undefined)
-            window.Capacitor = {
-                Plugins: {
-                    AppLifecycle: { exitApp: mockExitApp },
-                },
-            }
-
-            exitIfBackNavigation("FIRE_TV")
-
-            expect(mockExitApp).toHaveBeenCalled()
-        })
-
-        it("should handle Fire TV without Capacitor gracefully", () => {
-            vi.spyOn(performance, "getEntriesByType").mockReturnValue([
-                { type: "back_forward" } as PerformanceNavigationTiming,
-            ])
-
-            window.Capacitor = undefined
-
-            expect(() => exitIfBackNavigation("FIRE_TV")).not.toThrow()
-        })
-
-        it("should log when Fire TV exit promise rejects", async () => {
-            vi.spyOn(performance, "getEntriesByType").mockReturnValue([
-                { type: "back_forward" } as PerformanceNavigationTiming,
-            ])
-
-            const mockExitApp = vi
-                .fn()
-                .mockRejectedValue(new Error("exit failed"))
-            const loggerErrorSpy = vi.spyOn(logger, "error")
-
-            window.Capacitor = {
-                Plugins: {
-                    AppLifecycle: { exitApp: mockExitApp },
-                },
-            }
-
-            exitIfBackNavigation("FIRE_TV")
-
-            await vi.waitFor(() => {
-                expect(loggerErrorSpy).toHaveBeenCalledWith(
-                    { error: expect.any(Error) },
-                    "[Shell] Failed to exit Fire TV app"
-                )
-            })
-        })
-    })
-
-    describe("setupFireTVBackButtonHandler", () => {
-        const ANDROID_BACK_KEYCODE = 4
-        type KeyDownListener = (event: { keyCode: number }) => void
-
-        it("should call Capacitor AppLifecycle.exitApp when InputHandler emits back keyDown", async () => {
-            const mockExitApp = vi.fn().mockResolvedValue(undefined)
-            const mockRemoveListener = vi.fn().mockResolvedValue(undefined)
-            let capturedListener: KeyDownListener | null = null
-            const mockAddListener = vi
-                .fn()
-                .mockImplementation(
-                    async (eventName: string, listener: KeyDownListener) => {
-                        if (eventName === "keyDown") {
-                            capturedListener = listener
-                        }
-
-                        return {
-                            remove: mockRemoveListener,
-                        }
-                    }
-                )
-
-            window.Capacitor = {
-                Plugins: {
-                    AppLifecycle: { exitApp: mockExitApp },
-                    InputHandler: {
-                        addListener: mockAddListener,
-                    },
-                },
-            }
-
-            const cleanup = setupFireTVBackButtonHandler()
-
-            await vi.waitFor(() => {
-                expect(mockAddListener).toHaveBeenCalledWith(
-                    "keyDown",
-                    expect.any(Function)
-                )
-            })
-
-            capturedListener?.({ keyCode: ANDROID_BACK_KEYCODE })
-
-            expect(mockExitApp).toHaveBeenCalled()
-
-            cleanup()
-        })
-
-        it("should handle missing Capacitor gracefully", () => {
-            window.Capacitor = undefined
-
-            const cleanup = setupFireTVBackButtonHandler()
-
-            expect(() => cleanup()).not.toThrow()
-            cleanup()
-        })
-
-        it("should not trigger when InputHandler emits non-back keyDown", async () => {
-            const mockExitApp = vi.fn().mockResolvedValue(undefined)
-            let capturedListener: KeyDownListener | null = null
-            const mockAddListener = vi
-                .fn()
-                .mockImplementation(
-                    async (eventName: string, listener: KeyDownListener) => {
-                        if (eventName === "keyDown") {
-                            capturedListener = listener
-                        }
-
-                        return {
-                            remove: vi.fn().mockResolvedValue(undefined),
-                        }
-                    }
-                )
-
-            window.Capacitor = {
-                Plugins: {
-                    AppLifecycle: { exitApp: mockExitApp },
-                    InputHandler: {
-                        addListener: mockAddListener,
-                    },
-                },
-            }
-
-            const cleanup = setupFireTVBackButtonHandler()
-
-            await vi.waitFor(() => {
-                expect(mockAddListener).toHaveBeenCalledWith(
-                    "keyDown",
-                    expect.any(Function)
-                )
-            })
-
-            capturedListener?.({ keyCode: 13 })
-
-            expect(mockExitApp).not.toHaveBeenCalled()
-
-            cleanup()
-        })
-
-        it("should remove InputHandler listener when cleanup is called", async () => {
-            const mockExitApp = vi.fn().mockResolvedValue(undefined)
-            const mockRemoveListener = vi.fn().mockResolvedValue(undefined)
-            const mockAddListener = vi.fn().mockResolvedValue({
-                remove: mockRemoveListener,
-            })
-
-            window.Capacitor = {
-                Plugins: {
-                    AppLifecycle: { exitApp: mockExitApp },
-                    InputHandler: {
-                        addListener: mockAddListener,
-                    },
-                },
-            }
-
-            const cleanup = setupFireTVBackButtonHandler()
-
-            await vi.waitFor(() => {
-                expect(mockAddListener).toHaveBeenCalledWith(
-                    "keyDown",
-                    expect.any(Function)
-                )
-            })
-
-            cleanup()
-
-            await vi.waitFor(() => {
-                expect(mockRemoveListener).toHaveBeenCalled()
-            })
-        })
-
-        it("should support InputHandler addListener returning a sync handle", async () => {
-            const mockExitApp = vi.fn().mockResolvedValue(undefined)
-            const mockRemoveListener = vi.fn().mockResolvedValue(undefined)
-            let capturedListener: KeyDownListener | null = null
-            const mockAddListener = vi
-                .fn()
-                .mockImplementation(
-                    (eventName: string, listener: KeyDownListener) => {
-                        if (eventName === "keyDown") {
-                            capturedListener = listener
-                        }
-
-                        return {
-                            remove: mockRemoveListener,
-                        }
-                    }
-                )
-
-            window.Capacitor = {
-                Plugins: {
-                    AppLifecycle: { exitApp: mockExitApp },
-                    InputHandler: {
-                        addListener: mockAddListener,
-                    },
-                },
-            }
-
-            const cleanup = setupFireTVBackButtonHandler()
-
-            expect(mockAddListener).toHaveBeenCalledWith(
-                "keyDown",
-                expect.any(Function)
-            )
-
-            capturedListener?.({ keyCode: ANDROID_BACK_KEYCODE })
-            expect(mockExitApp).toHaveBeenCalled()
-
-            cleanup()
-
-            await vi.waitFor(() => {
-                expect(mockRemoveListener).toHaveBeenCalled()
-            })
-        })
-
-        it("should handle missing InputHandler plugin gracefully", () => {
-            const mockExitApp = vi.fn().mockResolvedValue(undefined)
-            window.Capacitor = {
-                Plugins: {
-                    AppLifecycle: { exitApp: mockExitApp },
-                },
-            }
-
-            const cleanup = setupFireTVBackButtonHandler()
-
-            expect(mockExitApp).not.toHaveBeenCalled()
-            expect(() => cleanup()).not.toThrow()
-        })
-    })
-
-    describe("setupLGBackButtonHandler", () => {
-        const LG_BACK_KEYCODE = 461
-
-        it("should call webOS.platformBack when back button is pressed", () => {
-            const mockPlatformBack = vi.fn()
-            window.webOS = { platformBack: mockPlatformBack }
-
-            const cleanup = setupLGBackButtonHandler()
-
-            // Simulate LG back button press
-            const event = new KeyboardEvent("keydown", {
-                keyCode: LG_BACK_KEYCODE,
-            })
-            document.dispatchEvent(event)
-
-            expect(mockPlatformBack).toHaveBeenCalled()
-
-            cleanup()
-        })
-
-        it("should fall back to window.close when platformBack is not available", () => {
-            window.webOS = {} // No platformBack
-            const mockClose = vi.fn()
-            vi.spyOn(window, "close").mockImplementation(mockClose)
-
-            const cleanup = setupLGBackButtonHandler()
-
-            const event = new KeyboardEvent("keydown", {
-                keyCode: LG_BACK_KEYCODE,
-            })
-            document.dispatchEvent(event)
-
-            expect(mockClose).toHaveBeenCalled()
-
-            cleanup()
-        })
-
-        it("should not trigger on other key presses", () => {
-            const mockPlatformBack = vi.fn()
-            window.webOS = { platformBack: mockPlatformBack }
-
-            const cleanup = setupLGBackButtonHandler()
-
-            // Simulate a different key press (Enter = 13)
-            const event = new KeyboardEvent("keydown", { keyCode: 13 })
-            document.dispatchEvent(event)
-
-            expect(mockPlatformBack).not.toHaveBeenCalled()
-
-            cleanup()
-        })
-
-        it("should remove event listener when cleanup is called", () => {
-            const mockPlatformBack = vi.fn()
-            window.webOS = { platformBack: mockPlatformBack }
-
-            const cleanup = setupLGBackButtonHandler()
-            cleanup()
-
-            // Simulate back button press after cleanup
-            const event = new KeyboardEvent("keydown", {
-                keyCode: LG_BACK_KEYCODE,
-            })
-            document.dispatchEvent(event)
-
-            expect(mockPlatformBack).not.toHaveBeenCalled()
-        })
-
-        it("should handle missing webOS object gracefully", () => {
-            window.webOS = undefined
-            const mockClose = vi.fn()
-            vi.spyOn(window, "close").mockImplementation(mockClose)
-
-            const cleanup = setupLGBackButtonHandler()
-
-            const event = new KeyboardEvent("keydown", {
-                keyCode: LG_BACK_KEYCODE,
-            })
-            document.dispatchEvent(event)
-
-            expect(mockClose).toHaveBeenCalled()
-
-            cleanup()
-        })
-    })
-})

package/src/exitHandler.ts

@@ -1,233 +0,0 @@
-/**
- * Back button / exit handling for vwr-loader.
- *
- * This is a safety net for when VWR fails to load and user presses back.
- * When VWR loads successfully, it handles exit behavior itself.
- */
-
-import { logger } from "./logger"
-
-/** LG webOS back button keycode */
-const LG_BACK_KEYCODE = 461
-
-/** Android back button keycode (used by Fire TV InputHandler plugin) */
-const ANDROID_BACK_KEYCODE = 4
-
-/**
- * Exit the app if the page was loaded via back/forward navigation.
- *
- * This is a safety net for Samsung/LG TVs: if VWR failed to load and user
- * pressed back, they'd land on the loader again. This detects that and exits.
- *
- * Note: On LG TV with disableBackHistoryAPI: true, this won't trigger
- * because the platform doesn't automatically navigate back. Use
- * setupLGBackButtonHandler() for LG back button support.
- */
-export function exitIfBackNavigation(platform: Platform): void {
-    try {
-        const navEntries = performance.getEntriesByType("navigation")
-        const navEntry = navEntries[0] as
-            | PerformanceNavigationTiming
-            | undefined
-
-        if (navEntry?.type === "back_forward") {
-            logger.info(
-                { platform, navigationType: navEntry.type },
-                "[Shell] Back navigation detected, exiting app"
-            )
-            exitApp(platform)
-        }
-    } catch (error) {
-        // Performance API may not be available on all platforms
-        logger.warn({ error }, "[Shell] Could not check navigation type")
-    }
-}
-
-/**
- * Set up LG back button (keycode 461) handler.
- *
- * On LG TV with disableBackHistoryAPI: true in appinfo.json, the platform
- * doesn't automatically handle the back button. This sets up a keydown
- * listener to call webOS.platformBack() which shows the system exit popup
- * on webOS 6.0+ or launches Home on older versions.
- *
- * Once VWR loads successfully, call the returned cleanup function - VWR/PSDK
- * will take over back button handling with its own custom modal.
- *
- * @returns Cleanup function to remove the listener
- */
-export function setupLGBackButtonHandler(): () => void {
-    const handleKeyDown = (event: KeyboardEvent): void => {
-        if (event.keyCode === LG_BACK_KEYCODE) {
-            logger.info(
-                "[Shell] LG back button pressed, triggering platform exit"
-            )
-
-            if (window.webOS?.platformBack) {
-                window.webOS.platformBack()
-            } else {
-                logger.warn(
-                    "[Shell] webOS.platformBack not available, using window.close"
-                )
-                window.close()
-            }
-        }
-    }
-
-    document.addEventListener("keydown", handleKeyDown)
-    logger.info("[Shell] LG back button handler registered")
-
-    return () => {
-        document.removeEventListener("keydown", handleKeyDown)
-        logger.info("[Shell] LG back button handler removed")
-    }
-}
-
-/**
- * Set up Fire TV back button (keycode 4) handler.
- *
- * On Fire TV, the native shell intercepts the back button at the Activity
- * level and forwards it to JavaScript via the InputHandler Capacitor plugin.
- * During the vwr-loader loading phase, we subscribe directly to InputHandler
- * keyDown events and call Capacitor AppLifecycle.exitApp().
- *
- * Once VWR loads successfully, call the returned cleanup function - VWR
- * will take over back button handling.
- *
- * @returns Cleanup function to remove the listener
- */
-export function setupFireTVBackButtonHandler(): () => void {
-    const inputHandler = window.Capacitor?.Plugins?.InputHandler
-
-    if (!inputHandler?.addListener) {
-        logger.warn("[Shell] Capacitor InputHandler plugin not available")
-        return () => {
-            logger.info("[Shell] Fire TV back button handler removed")
-        }
-    }
-
-    let listenerHandle: { remove: () => Promise<void> | void } | null = null
-    let isCleanedUp = false
-
-    const listenerRegistration = Promise.resolve(
-        inputHandler.addListener("keyDown", (event: { keyCode: number }) => {
-            if (event.keyCode === ANDROID_BACK_KEYCODE) {
-                logger.info("[Shell] Fire TV back button pressed, exiting app")
-                exitFireTVApp()
-            }
-        })
-    )
-        .then((handle: { remove: () => Promise<void> | void }) => {
-            listenerHandle = handle
-
-            if (isCleanedUp) {
-                return Promise.resolve(handle.remove()).catch(
-                    (error: unknown) => {
-                        logger.error(
-                            { error },
-                            "[Shell] Failed to remove Fire TV back button handler"
-                        )
-                    }
-                )
-            }
-
-            return undefined
-        })
-        .catch((error: unknown) => {
-            logger.error(
-                { error },
-                "[Shell] Failed to register Fire TV back button handler"
-            )
-        })
-
-    logger.info("[Shell] Fire TV back button handler registered")
-
-    return () => {
-        isCleanedUp = true
-
-        if (listenerHandle) {
-            void Promise.resolve(listenerHandle.remove()).catch(
-                (error: unknown) => {
-                    logger.error(
-                        { error },
-                        "[Shell] Failed to remove Fire TV back button handler"
-                    )
-                }
-            )
-            listenerHandle = null
-        } else {
-            void listenerRegistration
-        }
-
-        logger.info("[Shell] Fire TV back button handler removed")
-    }
-}
-
-/**
- * Exit the app using platform-specific methods.
- *
- * @param platform - Platform identifier
- */
-function exitApp(platform: Platform): void {
-    switch (platform) {
-        case "SAMSUNG_TV":
-            exitSamsungApp()
-            break
-        case "LG_TV":
-            exitLGAppViaBackNavigation()
-            break
-        case "FIRE_TV":
-            exitFireTVApp()
-            break
-        // Mobile apps handle exit at the native layer
-        // Web doesn't have a meaningful "exit" concept
-        default:
-            logger.info({ platform }, "[Shell] No platform-specific exit")
-    }
-}
-
-function exitSamsungApp(): void {
-    try {
-        if (window.tizen?.application?.getCurrentApplication) {
-            window.tizen.application.getCurrentApplication().exit()
-        } else {
-            logger.warn("[Shell] Tizen exit API not available")
-        }
-    } catch (error) {
-        logger.error({ error }, "[Shell] Failed to exit Samsung app")
-    }
-}
-
-/**
- * Exit LG app when back navigation is detected.
- * Uses window.close() for immediate exit since user already navigated back.
- */
-function exitLGAppViaBackNavigation(): void {
-    try {
-        window.close()
-    } catch (error) {
-        logger.error({ error }, "[Shell] Failed to exit LG app")
-    }
-}
-
-/**
- * Exit Fire TV app via Capacitor AppLifecycle plugin.
- */
-function exitFireTVApp(): void {
-    try {
-        if (window.Capacitor?.Plugins?.AppLifecycle?.exitApp) {
-            void window.Capacitor.Plugins.AppLifecycle.exitApp().catch(
-                (error: unknown) => {
-                    logger.error(
-                        { error },
-                        "[Shell] Failed to exit Fire TV app"
-                    )
-                }
-            )
-        } else {
-            logger.warn("[Shell] Capacitor AppLifecycle plugin not available")
-        }
-    } catch (error) {
-        logger.error({ error }, "[Shell] Failed to exit Fire TV app")
-    }
-}