PRO-16178 fix: use lexical steps stack via AsyncLocalStorage

Author: uid11

README.md

@@ -333,7 +333,7 @@ If the mapping returns `undefined`, the log entry is not skipped, but is printed
 For example, if it is equal to three, the test will be run no more than three times.
 
 `navigationTimeout: number`: default timeout for navigation to url
-(`navigateToPage`, `navigateToUrl` actions) in milliseconds.
+(`navigateToUrl`, `setHeadersAndNavigateToUrl` actions) in milliseconds.
 
 `overriddenConfigFields: PlaywrightTestConfig | null`: if not `null`, then this value will override
 fields of internal `Playwright` config.

autotests/pageObjects/pages/E2edReportExample/E2edReportExample.ts

@@ -21,6 +21,11 @@ type CustomPageParams =
  * The e2ed report example page.
  */
 export class E2edReportExample extends Page<CustomPageParams> {
+  /**
+   * Page navigation timeout.
+   */
+  static override readonly navigationTimeout = 5_000;
+
   /**
    * Page header.
    */
@@ -47,11 +52,6 @@ export class E2edReportExample extends Page<CustomPageParams> {
   readonly navigationRetriesButtonSelected: Selector =
     this.navigationRetriesButton.filterByLocatorParameter('selected', 'true');
 
-  /**
-   * Page navigation timeout.
-   */
-  override readonly navigationTimeout = 5_000;
-
   /**
    * Cookies that we set (additionally) on a page before navigating to it.
    */

autotests/pageObjects/pages/Main.ts

@@ -15,6 +15,11 @@ type CustomPageParams = Partial<RouteParams> | undefined;
  * The Main (index) page.
  */
 export class Main extends Page<CustomPageParams> {
+  /**
+   * Page navigation timeout.
+   */
+  static override readonly navigationTimeout = 12_000;
+
   /**
    * Body selector.
    */

src/Page.ts

@@ -24,6 +24,11 @@ import type {
  * Abstract page with base methods.
  */
 export abstract class Page<PageParams = undefined> {
+  /**
+   * Default timeout for navigation to url (`navigateToPage`, `navigateToUrl` actions) in milliseconds.
+   */
+  static readonly navigationTimeout: number = 8_000;
+
   /**
    * Type of page parameters.
    */
@@ -40,12 +45,6 @@ export abstract class Page<PageParams = undefined> {
    */
   readonly maxIntervalBetweenRequestsInMs: number;
 
-  /**
-   * Default timeout for navigation to url (`navigateToPage`, `navigateToUrl` actions) in milliseconds.
-   * The default value is taken from the corresponding field of the pack config.
-   */
-  readonly navigationTimeout: number;
-
   /**
    * Immutable page parameters.
    */
@@ -67,12 +66,10 @@ export abstract class Page<PageParams = undefined> {
     this.pageParams = pageParams as PageParams;
 
     const {
-      navigationTimeout,
       waitForAllRequestsComplete: {maxIntervalBetweenRequestsInMs},
     } = getFullPackConfig();
 
     this.maxIntervalBetweenRequestsInMs = maxIntervalBetweenRequestsInMs;
-    this.navigationTimeout = navigationTimeout;
   }
 
   /**
@@ -132,7 +129,7 @@ export abstract class Page<PageParams = undefined> {
   ): Promise<NavigationReturn> {
     const navigationReturn = await navigateToUrl(url, {
       skipLogs: true,
-      timeout: this.navigationTimeout,
+      timeout: (this.constructor as typeof Page).navigationTimeout,
       ...options,
     });
     const {statusCode} = navigationReturn;

src/README.md

@@ -17,39 +17,41 @@ Modules in the dependency graph should only import the modules above them:
 10. `utils/headers`
 11. `utils/viewport`
 12. `utils/parse`
-13. `utils/distanceBetweenSelectors`
-14. `utils/getDurationWithUnits`
-15. `utils/valueToString`
-16. `utils/error`
-17. `utils/asserts`
-18. `utils/object`
-19. `utils/uiMode`
-20. `utils/runLabel`
-21. `utils/clone`
-22. `utils/notIncludedInPackTests`
-23. `utils/userland`
-24. `utils/fn`
-25. `utils/environment`
-26. `utils/packCompiler`
-27. `config`
-28. `utils/config`
-29. `utils/generalLog`
-30. `utils/testFilePaths`
-31. `utils/exit`
-32. `utils/promise`
-33. `utils/resourceUsage`
-34. `utils/fs`
-35. `utils/getGlobalErrorHandler`
-36. `utils/tests`
-37. `utils/end`
-38. `utils/pack`
-39. `useContext`
-40. `context`
-41. `utils/apiStatistics`
-42. `utils/selectors`
-43. `selectors`
-44. `utils/log`
-45. `utils/waitForEvents`
-46. `utils/expect`
-47. `expect`
-48. ...
+13. `utils/step`
+14. `utils/distanceBetweenSelectors`
+15. `utils/getDurationWithUnits`
+16. `utils/valueToString`
+17. `utils/error`
+18. `utils/asserts`
+19. `utils/object`
+20. `utils/uiMode`
+21. `utils/runLabel`
+22. `utils/clone`
+23. `utils/notIncludedInPackTests`
+24. `utils/userland`
+25. `utils/fn`
+26. `utils/environment`
+27. `utils/packCompiler`
+28. `config`
+29. `utils/config`
+30. `utils/generalLog`
+31. `utils/testFilePaths`
+32. `utils/exit`
+33. `utils/promise`
+34. `utils/resourceUsage`
+35. `utils/fs`
+36. `utils/getGlobalErrorHandler`
+37. `utils/tests`
+38. `utils/end`
+39. `utils/pack`
+40. `useContext`
+41. `context`
+42. `utils/apiStatistics`
+43. `utils/selectors`
+44. `selectors`
+45. `utils/log`
+46. `step`
+47. `utils/waitForEvents`
+48. `utils/expect`
+49. `expect`
+50. ...

src/actions/pages/assertPage.ts

@@ -1,4 +1,4 @@
-import {LogEventStatus, LogEventType} from '../../constants/internal';
+import {ADDITIONAL_STEP_TIMEOUT, LogEventStatus, LogEventType} from '../../constants/internal';
 import {step} from '../../step';
 import {assertValueIsDefined} from '../../utils/asserts';
 import {getDocumentUrl} from '../../utils/document';
@@ -38,7 +38,11 @@ export const assertPage = async <SomePageClass extends AnyPageClassType>(
 
       return {documentUrl, isMatch, logEventStatus, routeParams};
     },
-    {payload: {pageParams}, type: LogEventType.InternalAction},
+    {
+      payload: {pageParams},
+      timeout: PageClass.navigationTimeout + ADDITIONAL_STEP_TIMEOUT,
+      type: LogEventType.InternalAction,
+    },
   );
 
   assertValueIsDefined(page, 'page is defined', {name: PageClass.name, pageParams});

src/actions/pages/navigateToPage.ts

@@ -1,4 +1,4 @@
-import {LogEventType} from '../../constants/internal';
+import {ADDITIONAL_STEP_TIMEOUT, LogEventType} from '../../constants/internal';
 import {step} from '../../step';
 import {addPageToApiStatistics} from '../../utils/apiStatistics';
 import {assertValueIsDefined} from '../../utils/asserts';
@@ -56,7 +56,11 @@ export const navigateToPage = async <SomePageClass extends AnyPageClassType>(
 
       return {documentUrl, isMatch, pageInstanceCreatedInMs, routeParams, url};
     },
-    {payload: {pageParams}, type: LogEventType.InternalAction},
+    {
+      payload: {pageParams},
+      timeout: PageClass.navigationTimeout + ADDITIONAL_STEP_TIMEOUT,
+      type: LogEventType.InternalAction,
+    },
   );
 
   assertValueIsDefined(page, 'page is defined', {name: PageClass.name, pageParams});

src/context/stepsStack.ts

@@ -1,7 +1,4 @@
-/* eslint-disable max-lines */
-
 import {LogEventStatus, LogEventType} from './constants/internal';
-import {getStepsStack} from './context/stepsStack';
 import {getTestIdleTimeout} from './context/testIdleTimeout';
 import {E2edError} from './utils/error';
 import {setCustomInspectOnFunction} from './utils/fn';
@@ -10,15 +7,9 @@ import {getDurationWithUnits} from './utils/getDurationWithUnits';
 import {logAndGetLogEvent} from './utils/log';
 import {setReadonlyProperty} from './utils/object';
 import {addTimeoutToPromise} from './utils/promise';
+import {stepsStackStorage} from './utils/step';
 
-import type {
-  LogEvent,
-  LogPayload,
-  MaybePromise,
-  Mutable,
-  UtcTimeInMs,
-  Void,
-} from './types/internal';
+import type {LogEvent, LogPayload, MaybePromise, UtcTimeInMs, Void} from './types/internal';
 
 import {test as playwrightTest} from '@playwright/test';
 
@@ -33,7 +24,7 @@ type Options = Readonly<{
 /**
  * Declares a test step (could calls Playwright's `test.step` function inside).
  */
-// eslint-disable-next-line complexity, max-statements, max-lines-per-function
+// eslint-disable-next-line complexity, max-statements
 export const step = async (
   name: string,
   body?: () => MaybePromise<LogPayload | Void>,
@@ -44,7 +35,6 @@ export const step = async (
   }
 
   let logEvent: LogEvent | undefined;
-  const stepsStack = getStepsStack();
   const timeout: number = options?.timeout ?? getTestIdleTimeout();
 
   if (options?.skipLogs !== true) {
@@ -55,10 +45,6 @@ export const step = async (
     );
   }
 
-  if (logEvent !== undefined) {
-    (stepsStack as Mutable<typeof stepsStack>).push(logEvent);
-  }
-
   const errorProperties = {stepBody: body, stepName: name, stepOptions: options};
   let payload = undefined as LogPayload | Void;
   let stepError: unknown;
@@ -70,7 +56,11 @@ export const step = async (
     );
 
     const runBody = async (): Promise<void> => {
-      payload = await body?.();
+      if (logEvent !== undefined && typeof body === 'function') {
+        await stepsStackStorage.run(logEvent, body);
+      } else {
+        payload = await body?.();
+      }
     };
 
     let bodyError: unknown;
@@ -139,20 +129,6 @@ export const step = async (
         setReadonlyProperty(logEvent, 'payload', {...logEvent.payload, ...payload});
       }
 
-      const logEventIndex = stepsStack.findIndex((event) => event === logEvent);
-
-      if (logEventIndex === -1) {
-        // eslint-disable-next-line no-unsafe-finally
-        throw new E2edError('Cannot find running step in test steps stack', {
-          runningStep: logEvent,
-          stepBody: body,
-          stepError,
-          stepOptions: options,
-        });
-      }
-
-      (stepsStack as Mutable<typeof stepsStack>).splice(logEventIndex, 1);
-
       generalLog(`Step "${name}" completed`, {
         body,
         step: {...logEvent, children: logEvent.children?.map(({message}) => message)},

src/step.ts

@@ -172,7 +172,7 @@ export type OwnE2edConfig<
   maxRetriesCountInDocker: number;
 
   /**
-   * Default timeout for navigation to url (`navigateToPage`, `navigateToUrl` actions) in milliseconds.
+   * Default timeout for navigation to url (`navigateToUrl`, `setHeadersAndNavigateToUrl` actions) in milliseconds.
    */
   navigationTimeout: number;