@tramvai/test-puppeteer 2.47.1 → 2.47.3

package/lib/index.d.ts

@@ -2,3 +2,4 @@ export * from 'puppeteer';
 export * from './constants';
 export { initPuppeteer } from './launch';
 export { wrapPuppeteerPage } from './wrapper';
+export * from './utils';

package/lib/index.es.js

@@ -3,6 +3,7 @@ export * from 'puppeteer';
 import isEmpty from '@tinkoff/utils/is/empty';
 import { stderr } from 'supports-color';
 import consoleWithStyle from 'console-with-style';
+import { sleep } from '@tramvai/test-integration';
 
 const PUPPETEER_DEFAULT_LAUNCH_OPTIONS = {
     args: [
@@ -43,6 +44,17 @@ const wrapRouter = (page) => {
     };
 };
 
+// reference: https://github.com/vercel/next.js/blob/canary/packages/next/client/app-index.tsx#L162
+const waitHydrated = (page) => {
+    return Promise.race([
+        page.waitForFunction(() => {
+            return (window.contextExternal &&
+                window.contextExternal.di.get({ token: '__TRAMVAI_HYDRATED', optional: true }));
+        }, { polling: 100 }),
+        sleep(10000),
+    ]);
+};
+
 const checkSsrErrors = (text) => {
     if (text.indexOf('Server: "%s" Client: "%s"%s') !== -1) {
         throw new Error(`SSR breaking error: ${text}`);
@@ -54,6 +66,17 @@ const wrapPuppeteerPage = (page) => {
     if (page.url() && page.url() !== 'about:blank') {
         throw new Error(`You should wrap blank page before navigation, but page already has url "${page.url()}"`);
     }
+    const originalGoto = page.goto;
+    // wait for page loading and hydration, because selective hydration ends later
+    // eslint-disable-next-line no-param-reassign
+    page.goto = async function goto(...args) {
+        const [response] = await Promise.all([
+            originalGoto.apply(page, args),
+            page.waitForNavigation({ waitUntil: 'domcontentloaded' }),
+        ]);
+        await waitHydrated(page);
+        return response;
+    };
     page.on('requestfailed', (request) => nativeConsole.error('[PAGE REQUEST FAILED]', {
         error: request.failure(),
         url: request.url(),
@@ -84,6 +107,11 @@ const wrapPuppeteerPage = (page) => {
         reset: (url = 'about:blank') => {
             return page.goto(url);
         },
+        waitForUrl: (url) => {
+            return page.waitForFunction((expectedUrl) => {
+                return window.location.href === expectedUrl;
+            }, {}, url);
+        },
         router: wrapRouter(page),
         close: () => {
             return page.close();
@@ -147,4 +175,4 @@ const initPuppeteer = async (serverUrl, { enableLogging = true, ...options } = {
     };
 };
 
-export { PUPPETEER_DEFAULT_LAUNCH_OPTIONS, initPuppeteer, wrapPuppeteerPage };
+export { PUPPETEER_DEFAULT_LAUNCH_OPTIONS, initPuppeteer, waitHydrated, wrapPuppeteerPage };

package/lib/index.js

@@ -6,6 +6,7 @@ var puppeteer = require('puppeteer');
 var isEmpty = require('@tinkoff/utils/is/empty');
 var supportsColor = require('supports-color');
 var consoleWithStyle = require('console-with-style');
+var testIntegration = require('@tramvai/test-integration');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -52,6 +53,17 @@ const wrapRouter = (page) => {
     };
 };
 
+// reference: https://github.com/vercel/next.js/blob/canary/packages/next/client/app-index.tsx#L162
+const waitHydrated = (page) => {
+    return Promise.race([
+        page.waitForFunction(() => {
+            return (window.contextExternal &&
+                window.contextExternal.di.get({ token: '__TRAMVAI_HYDRATED', optional: true }));
+        }, { polling: 100 }),
+        testIntegration.sleep(10000),
+    ]);
+};
+
 const checkSsrErrors = (text) => {
     if (text.indexOf('Server: "%s" Client: "%s"%s') !== -1) {
         throw new Error(`SSR breaking error: ${text}`);
@@ -63,6 +75,17 @@ const wrapPuppeteerPage = (page) => {
     if (page.url() && page.url() !== 'about:blank') {
         throw new Error(`You should wrap blank page before navigation, but page already has url "${page.url()}"`);
     }
+    const originalGoto = page.goto;
+    // wait for page loading and hydration, because selective hydration ends later
+    // eslint-disable-next-line no-param-reassign
+    page.goto = async function goto(...args) {
+        const [response] = await Promise.all([
+            originalGoto.apply(page, args),
+            page.waitForNavigation({ waitUntil: 'domcontentloaded' }),
+        ]);
+        await waitHydrated(page);
+        return response;
+    };
     page.on('requestfailed', (request) => nativeConsole.error('[PAGE REQUEST FAILED]', {
         error: request.failure(),
         url: request.url(),
@@ -93,6 +116,11 @@ const wrapPuppeteerPage = (page) => {
         reset: (url = 'about:blank') => {
             return page.goto(url);
         },
+        waitForUrl: (url) => {
+            return page.waitForFunction((expectedUrl) => {
+                return window.location.href === expectedUrl;
+            }, {}, url);
+        },
         router: wrapRouter(page),
         close: () => {
             return page.close();
@@ -158,6 +186,7 @@ const initPuppeteer = async (serverUrl, { enableLogging = true, ...options } = {
 
 exports.PUPPETEER_DEFAULT_LAUNCH_OPTIONS = PUPPETEER_DEFAULT_LAUNCH_OPTIONS;
 exports.initPuppeteer = initPuppeteer;
+exports.waitHydrated = waitHydrated;
 exports.wrapPuppeteerPage = wrapPuppeteerPage;
 Object.keys(puppeteer).forEach(function (k) {
     if (k !== 'default' && !exports.hasOwnProperty(k)) Object.defineProperty(exports, k, {

package/lib/launch.d.ts

@@ -9,6 +9,7 @@ export declare const initPuppeteer: (serverUrl: string, { enableLogging, ...opti
     getPageWrapper: (url?: string) => Promise<{
         page: puppeteer.Page;
         reset: (url?: string) => Promise<puppeteer.HTTPResponse | null>;
+        waitForUrl: (url: string) => Promise<puppeteer.JSHandle<false> | puppeteer.JSHandle<true>>;
         router: {
             navigate: (options: string | import("@tinkoff/router").NavigateOptions) => Promise<any>;
             navigateThenWaitForReload: (options: string | import("@tinkoff/router").NavigateOptions) => Promise<[void, puppeteer.HTTPResponse | null]>;

package/lib/utils.d.ts

@@ -0,0 +1,2 @@
+import type { Page } from 'puppeteer';
+export declare const waitHydrated: (page: Page) => Promise<unknown>;

package/lib/wrapper.d.ts

@@ -5,6 +5,7 @@ declare global {
 export declare const wrapPuppeteerPage: (page: Page) => {
     page: Page;
     reset: (url?: string) => Promise<import("puppeteer").HTTPResponse | null>;
+    waitForUrl: (url: string) => Promise<import("puppeteer").JSHandle<false> | import("puppeteer").JSHandle<true>>;
     router: {
         navigate: (options: string | import("@tinkoff/router").NavigateOptions) => Promise<any>;
         navigateThenWaitForReload: (options: string | import("@tinkoff/router").NavigateOptions) => Promise<[void, import("puppeteer").HTTPResponse | null]>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tramvai/test-puppeteer",
-  "version": "2.47.1",
+  "version": "2.47.3",
   "description": "",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
@@ -19,7 +19,8 @@
   },
   "dependencies": {
     "@tinkoff/utils": "^2.1.2",
-    "@tramvai/tokens-router": "2.47.1",
+    "@tramvai/tokens-router": "2.47.3",
+    "@tramvai/test-integration": "2.47.3",
     "console-with-style": "^1.1.0",
     "supports-color": "8.1.1",
     "tslib": "^2.4.0"