PRO-10170 feat: supporting switching of tabs in network actions

Author: uid11

autotests/entities/worker.ts

@@ -26,7 +26,7 @@ export const addUser: ClientFunction<[UserWorker, number?], Promise<object>> = c
 /**
  * Get list of user-workers.
  */
-export const getUsers = (delay: number): Promise<unknown> => {
+export const getUsers = (delay: number = 0): Promise<unknown> => {
   log(`Send API request with delay = ${delay}s`);
 
   return clientGetUsers(delay);

autotests/routes/apiRoutes/GetUsers.ts

@@ -1,12 +1,37 @@
 import {ApiRoute} from 'autotests/routes';
+import {assertValueIsTrue} from 'e2ed/utils';
 
 import type {ApiGetUsersRequest, ApiGetUsersResponse} from 'autotests/types';
 import type {Url} from 'e2ed/types';
 
+type Params = Readonly<{delay?: number}> | undefined;
+
+const pathStart = '/api/users';
+
 /**
  * Client API route for getting users list.
  */
-export class GetUsers extends ApiRoute<undefined, ApiGetUsersRequest, ApiGetUsersResponse> {
+export class GetUsers extends ApiRoute<Params, ApiGetUsersRequest, ApiGetUsersResponse> {
+  static override getParamsFromUrlOrThrow(url: Url): Params {
+    const urlObject = new URL(url);
+
+    assertValueIsTrue(
+      urlObject.pathname.startsWith(pathStart),
+      'url pathname starts with correct path',
+      {urlObject},
+    );
+
+    const delay = Number(urlObject.searchParams.get('delay'));
+
+    if (delay >= 0) {
+      assertValueIsTrue(Number.isInteger(delay), 'url has correct delay', {delay, urlObject});
+
+      return {delay};
+    }
+
+    return {};
+  }
+
   getMethod(): 'GET' {
     return 'GET';
   }
@@ -16,6 +41,8 @@ export class GetUsers extends ApiRoute<undefined, ApiGetUsersRequest, ApiGetUser
   }
 
   getPath(): string {
-    return '/api/users?delay=3';
+    const {delay} = this.routeParams ?? {};
+
+    return delay !== undefined ? `${pathStart}?delay=${delay}` : pathStart;
   }
 }

autotests/tests/request.ts

@@ -9,12 +9,12 @@ test(
   async () => {
     const {
       responseBody: {data},
-    } = await request(GetUsers);
+    } = await request(GetUsers, {routeParams: {delay: 3}});
 
     await expect(data.length, 'request returns some users').gt(0);
 
     await assertFunctionThrows(async () => {
-      await request(GetUsers, {maxRetriesCount: 1, timeout: 2_000});
+      await request(GetUsers, {maxRetriesCount: 1, routeParams: {delay: 3}, timeout: 2_000});
     }, 'request function throws an error on timeout');
   },
 );

autotests/tests/switchingPages.skip.ts

@@ -0,0 +1,43 @@
+import {test} from 'autotests';
+import {getUsers} from 'autotests/entities';
+import {E2edReportExample} from 'autotests/pageObjects/pages';
+import {GetUsers} from 'autotests/routes/apiRoutes';
+import {expect} from 'e2ed';
+import {navigateToPage, waitForRequestToRoute, waitForTimeout} from 'e2ed/actions';
+import {log} from 'e2ed/utils';
+
+const maxNumberOfRequests = 10;
+
+const timeout = (maxNumberOfRequests + 2) * 1_000;
+
+test('support switching of pages and tabs', {meta: {testId: '21'}}, async () => {
+  let numberOfCaughtRequests = 0;
+  let numberOfSentRequests = 0;
+
+  setInterval(() => {
+    if (numberOfSentRequests < maxNumberOfRequests) {
+      numberOfSentRequests += 1;
+
+      void getUsers();
+    }
+  }, 1_000);
+
+  void waitForRequestToRoute(GetUsers, {
+    predicate: (routeParams, request) => {
+      numberOfCaughtRequests += 1;
+
+      log(`Caught request number ${numberOfCaughtRequests}`, {routeParams, request});
+
+      return false;
+    },
+    timeout,
+  });
+
+  await waitForTimeout(maxNumberOfRequests * 500);
+
+  await navigateToPage(E2edReportExample);
+
+  await waitForTimeout(maxNumberOfRequests * 500 + 1_000);
+
+  await expect(numberOfSentRequests, 'all requests were caught').eql(numberOfCaughtRequests);
+});

src/actions/waitFor/waitForRequest.ts

@@ -1,3 +1,5 @@
+import {AsyncLocalStorage} from 'node:async_hooks';
+
 import {LogEventType, MAX_TIMEOUT_IN_MS} from '../../constants/internal';
 import {getTestRunPromise} from '../../context/testRunPromise';
 import {getPlaywrightPage} from '../../useContext';
@@ -9,6 +11,8 @@ import {log} from '../../utils/log';
 import {addTimeoutToPromise} from '../../utils/promise';
 import {getRequestFromPlaywrightRequest} from '../../utils/requestHooks';
 
+import type {Request as PlaywrightRequest} from '@playwright/test';
+
 import type {
   Request,
   RequestPredicate,
@@ -65,7 +69,7 @@ export const waitForRequest = (async <SomeRequest extends Request>(
 
   const promise = addTimeoutToPromise(
     page.waitForRequest(
-      async (playwrightRequest) => {
+      AsyncLocalStorage.bind(async (playwrightRequest: PlaywrightRequest) => {
         try {
           const request = getRequestFromPlaywrightRequest(playwrightRequest);
 
@@ -79,15 +83,17 @@ export const waitForRequest = (async <SomeRequest extends Request>(
             trigger,
           });
         }
-      },
+      }),
       {timeout: MAX_TIMEOUT_IN_MS},
     ),
     timeout,
     new E2edError(`waitForRequest promise rejected after ${timeoutWithUnits} timeout`),
   )
     .then(
-      (playwrightRequest) =>
-        getRequestFromPlaywrightRequest(playwrightRequest) as RequestWithUtcTimeInMs<SomeRequest>,
+      AsyncLocalStorage.bind(
+        (playwrightRequest: PlaywrightRequest) =>
+          getRequestFromPlaywrightRequest(playwrightRequest) as RequestWithUtcTimeInMs<SomeRequest>,
+      ),
     )
     .catch((error: unknown) => {
       if (isTestRunCompleted) {

src/config.ts

@@ -20,8 +20,12 @@ import {
 import {assertValueIsTrue} from './utils/asserts';
 // eslint-disable-next-line import/no-internal-modules
 import {assertUserlandPack} from './utils/config/assertUserlandPack';
+// eslint-disable-next-line import/no-internal-modules
+import {updateConfig} from './utils/config/updateConfig';
 import {getPathToPack} from './utils/environment';
 import {setCustomInspectOnFunction} from './utils/fn';
+// eslint-disable-next-line import/no-internal-modules
+import {readStartInfoSync} from './utils/fs/readStartInfoSync';
 import {setReadonlyProperty} from './utils/object';
 import {isUiMode} from './utils/uiMode';
 import {isLocalRun} from './configurator';
@@ -116,31 +120,27 @@ const playwrightConfig = defineConfig({
       pathTemplate: `${ABSOLUTE_PATH_TO_PROJECT_ROOT_DIRECTORY}/${EXPECTED_SCREENSHOTS_DIRECTORY_PATH}/{arg}.png`,
     },
   },
-
   fullyParallel: true,
-
   globalTimeout: userlandPack.packTimeout,
-
   outputDir: join(relativePathFromInstalledE2edToRoot, INTERNAL_REPORTS_DIRECTORY_PATH),
-
   projects: [{name: userlandPack.browserName, use: useOptions}],
-
   retries: isLocalRun ? 0 : userlandPack.maxRetriesCountInDocker - 1,
-
   testDir: join(relativePathFromInstalledE2edToRoot, TESTS_DIRECTORY_PATH),
   testIgnore: ['**/node_modules/**', '**/*.skip.ts'],
   testMatch: userlandPack.testFileGlobs as Mutable<typeof userlandPack.testFileGlobs>,
-
   timeout: userlandPack.testTimeout,
-
   workers: userlandPack.concurrency,
-
   ...userlandPack.overriddenConfigFields,
-
   use: useOptions,
 });
 
 const config: FullPackConfig = Object.assign(playwrightConfig, userlandPack);
 
+try {
+  const startInfo = readStartInfoSync();
+
+  updateConfig(config, startInfo);
+} catch {}
+
 // eslint-disable-next-line import/no-default-export
 export default config;

src/utils/config/updateConfig.ts

@@ -14,7 +14,7 @@ const skippedFields: readonly (keyof FullPackConfig)[] = [
  * @internal
  */
 export const updateConfig = (fullPackConfig: FullPackConfig, startInfo: StartInfo): void => {
-  for (const field of getKeys(fullPackConfig)) {
+  for (const field of new Set([...getKeys(fullPackConfig), ...getKeys(startInfo.fullPackConfig)])) {
     if (skippedFields.includes(field)) {
       continue;
     }
@@ -26,4 +26,9 @@ export const updateConfig = (fullPackConfig: FullPackConfig, startInfo: StartInf
     // @ts-expect-error: full pack config have different types of field values
     fullPackConfig[field] = startInfo.fullPackConfig[field]; // eslint-disable-line no-param-reassign
   }
+
+  Object.assign(fullPackConfig, {
+    ...fullPackConfig.overriddenConfigFields,
+    use: {...fullPackConfig.use, ...fullPackConfig.overriddenConfigFields?.use},
+  });
 };