ohos-playwright 0.2.8 → 0.2.10

package/README.md

@@ -31,10 +31,50 @@ export default defineConfig(withOpenHarmony({ /* your config */ }))
 { "scripts": { "test:e2e": "ohos-playwright test" } }
 ```
 
+## Supported APIs
+
+The following Playwright APIs have been validated on ArkWeb / HarmonyOS 6.1 (Chromium 132):
+
+| Category | APIs |
+|---|---|
+| Network interception | `page.route()`, `route.fulfill()`, `route.abort()`, `page.unroute()` |
+| Screenshot | `page.screenshot({ type: 'jpeg' \| 'png' })`, `locator.screenshot()` |
+| Geolocation | `context.setGeolocation()`, `context.grantPermissions(['geolocation'])` |
+| Device emulation | `emulateDevice` fixture (see below) |
+| Input | `locator.fill()`, `locator.type()`, `keyboard.press()` |
+| Cookies | `context.addCookies()`, `context.cookies()`, `context.clearCookies()` |
+| Dialog | `page.on('dialog')`, `dialog.accept()`, `dialog.dismiss()`, `dialog.message()`, `dialog.type()` |
+| Popup | `context.waitForEvent('page')` + `window.open()` — stub Page with `url()`, `waitForLoadState()`, `close()` |
+| Page events | `page.on('pageerror')`, `page.on('console')`, `page.on('download')` |
+| Frames | `page.frames()`, `page.mainFrame()`, `frame.url()` |
+| Viewport | `page.viewportSize()` (pre-fetched via `Page.getLayoutMetrics` for reused CDP tabs) |
+| Media emulation | `page.emulateMedia({ colorScheme })` |
+
+### `emulateDevice` fixture
+
+Because `newContext()` is not supported in connectOverCDP mode, device emulation is exposed as a Playwright fixture parameter backed by CDP `Emulation.*` commands.
+
+```ts
+import { test, expect } from '@playwright/test'
+import type { DeviceDescriptor } from 'ohos-playwright/fixture'
+
+test('mobile viewport', async ({ page, emulateDevice }) => {
+  await emulateDevice({
+    viewport: { width: 375, height: 812 },
+    deviceScaleFactor: 3,
+    isMobile: true,
+    userAgent: 'Mozilla/5.0 (iPhone; CPU iPhone OS 16_0 like Mac OS X) ...',
+  })
+  expect(await page.evaluate(() => window.innerWidth)).toBe(375)
+})
+```
+
+`emulateDevice` settings persist for the lifetime of the page. Call it again with `{ viewport: { width: 1280, height: 720 }, isMobile: false }` to restore defaults.
+
 ## Limitations
 
 - **Chromium only.** firefox and webkit aren't available on HarmonyOS.
-- **One context, one page.** `newContext()` / `newPage()` aren't supported. Isolate tests with `localStorage.clear()` + `page.reload()`.
+- **One context, one page.** `newContext()` / `newPage()` aren't supported. Isolate tests with `localStorage.clear()` + `page.reload()`. For device emulation use the `emulateDevice` fixture instead of `browser.newContext({ ...device })`.
 - **`process.platform` reads `'linux'`** during the run — we patch it because Playwright's hostPlatform detection only branches on linux/darwin/win32 and falls through to `<unknown>` on openharmony. For real platform checks use `process.env.OHOS_PW_HOST`.
 
 ## Environment variables

package/dist/fixture.d.mts

@@ -1,2 +1,13 @@
-export declare const test: import("@playwright/test").TestType<import("@playwright/test").PlaywrightTestArgs & import("@playwright/test").PlaywrightTestOptions, import("@playwright/test").PlaywrightWorkerArgs & import("@playwright/test").PlaywrightWorkerOptions>;
+export interface DeviceDescriptor {
+    viewport: {
+        width: number;
+        height: number;
+    };
+    deviceScaleFactor?: number;
+    isMobile?: boolean;
+    userAgent?: string;
+}
+export declare const test: import("@playwright/test").TestType<import("@playwright/test").PlaywrightTestArgs & import("@playwright/test").PlaywrightTestOptions & {
+    emulateDevice: (descriptor: DeviceDescriptor) => Promise<void>;
+}, import("@playwright/test").PlaywrightWorkerArgs & import("@playwright/test").PlaywrightWorkerOptions>;
 export { expect } from '@playwright/test';

package/dist/fixture.mjs

@@ -12,22 +12,132 @@ export const test = base.extend({
         },
         { scope: 'worker' },
     ],
-    context: async ({ browser }, use) => {
-        // baseURL 通过 page fixture 重写 page.goto 实现；不再触碰 BrowserContext 私有字段 _options。
-        await use(browser.contexts()[0]);
+    context: async ({ browser }, use, testInfo) => {
+        const ctx = browser.contexts()[0];
+        // Inject baseURL into the context's private _options so that internal
+        // Playwright URL resolution (toHaveURL, waitForURL, locators) works for
+        // SPA-navigated pages — page.goto patching alone is not sufficient.
+        const baseURL = testInfo.project.use.baseURL;
+        if (baseURL) {
+            ;
+            ctx._options.baseURL = baseURL;
+        }
+        await use(ctx);
     },
     page: async ({ context }, use, testInfo) => {
         const pages = context.pages();
         if (pages.length === 0)
             throw new Error('No pages in ArkWeb CDP context. Open a tab first.');
         const page = pages.find((p) => p.url().startsWith('http://localhost')) ?? pages[0];
+        const ctxEmit = context.emit.bind(context);
+        // Patch baseURL
         const baseURL = testInfo.project.use.baseURL;
         if (baseURL) {
             const root = baseURL.replace(/\/+$/, '');
             const origGoto = page.goto.bind(page);
             page.goto = ((url, opts) => origGoto((url.startsWith('/') && !url.startsWith('//')) ? root + url : url, opts));
         }
-        await use(page);
+        // connectOverCDP reuses an existing tab — Playwright has no record of its
+        // viewport size and viewportSize() returns null. Pre-fetch via CDP.
+        const session = await context.newCDPSession(page);
+        try {
+            const { cssVisualViewport } = await session.send('Page.getLayoutMetrics');
+            const cached = {
+                width: Math.round(cssVisualViewport.clientWidth),
+                height: Math.round(cssVisualViewport.clientHeight),
+            };
+            const origViewportSize = page.viewportSize.bind(page);
+            page.viewportSize = () => origViewportSize() ?? cached;
+        }
+        catch {
+            // Non-critical — viewportSize() will still return null if CDP call fails.
+        }
+        finally {
+            await session.detach();
+        }
+        // ArkWeb's new tab from window.open() is invisible to CDP (Target.createTarget hangs,
+        // Target.targetCreated never fires). Intercept via an init script:
+        //   - queue the URL for our poller
+        //   - return null (Window object hangs CDP serialization if returned)
+        // Guard against multiple addInitScript calls across tests accumulating overrides.
+        const origEvaluate = page.evaluate.bind(page);
+        const alreadyPatched = page['__ohosPopupPatched'];
+        if (!alreadyPatched) {
+            ;
+            page['__ohosPopupPatched'] = true;
+            await page.addInitScript(() => {
+                if (window['__ohosPopupPatched'])
+                    return;
+                window['__ohosPopupPatched'] = true;
+                window['__ohosPopupQueue'] = [];
+                window.open = (url) => {
+                    ;
+                    window['__ohosPopupQueue'].push({ url: String(url ?? '') });
+                    return null; // Window object hangs CDP serialization — return null instead
+                };
+            });
+        }
+        const popupPoller = setInterval(async () => {
+            try {
+                const pending = await origEvaluate(() => {
+                    const q = window['__ohosPopupQueue'];
+                    window['__ohosPopupQueue'] = [];
+                    return q;
+                });
+                for (const { url } of pending ?? []) {
+                    // context.newPage() calls Target.createTarget which hangs in ArkWeb.
+                    // Emit a minimal stub — satisfies waitForLoadState / url / close.
+                    const stub = {
+                        waitForLoadState: async () => { },
+                        url: () => url,
+                        close: async () => { },
+                    };
+                    ctxEmit('page', stub);
+                }
+            }
+            catch { }
+        }, 150);
+        // evaluate() exceptions reject the promise but never become pageerror events
+        // (CDP catches them before they become uncaught). Intercept and re-emit.
+        // Save and restore to prevent wrapper accumulation across tests on the same page object.
+        const savedEvaluate = page['evaluate'];
+        page.evaluate = async (fn, arg) => {
+            try {
+                return await origEvaluate(fn, arg);
+            }
+            catch (e) {
+                const err = e instanceof Error ? e : new Error(String(e));
+                page.emit('pageerror', err);
+            }
+        };
+        try {
+            await use(page);
+        }
+        finally {
+            clearInterval(popupPoller);
+            page.evaluate = savedEvaluate;
+        }
+    },
+    emulateDevice: async ({ page }, use) => {
+        await use(async (descriptor) => {
+            const session = await page.context().newCDPSession(page);
+            try {
+                await session.send('Emulation.setDeviceMetricsOverride', {
+                    width: descriptor.viewport.width,
+                    height: descriptor.viewport.height,
+                    deviceScaleFactor: descriptor.deviceScaleFactor ?? 1,
+                    mobile: descriptor.isMobile ?? false,
+                });
+                if (descriptor.userAgent !== undefined) {
+                    await session.send('Emulation.setUserAgentOverride', {
+                        userAgent: descriptor.userAgent,
+                    });
+                }
+            }
+            finally {
+                await session.detach();
+            }
+        });
     },
 });
 export { expect } from '@playwright/test';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ohos-playwright",
-  "version": "0.2.8",
+  "version": "0.2.10",
   "description": "Playwright adapter for OpenHarmony / ArkWeb via hdc + CDP",
   "license": "MIT",
   "author": "social4hyq",
@@ -25,13 +25,14 @@
   "type": "module",
   "scripts": {
     "build": "tsc && node scripts/fix-extensions.mjs",
-    "test": "node --test src/*.test.mts",
+    "test": "node --test $(ls src/*.test.mts | grep -v api-coverage)",
     "typecheck": "tsc --noEmit"
   },
   "engines": {
     "node": ">=24"
   },
   "exports": {
+    ".": "./dist/fixture.mjs",
     "./fixture": "./dist/fixture.mjs",
     "./setup": "./dist/setup.mjs",
     "./teardown": "./dist/teardown.mjs",