Merge pull request #98 from joomcode/fix/add-logs-to-rerequests

feat: add `addLogsWithTags` field to pack config

README.md

@@ -239,6 +239,9 @@ that exports the pack's config under the name `pack`.
 
 Here are the basic fields of the pack config.
 
+`addLogsWithTags: readonly LogTag[]`: array of additional log tags. Logs with a specific tag
+(in `logTag` field) will be added only if their tag is specified in this array.
+
 `browserFlags: string[]`: array of browser flags, like `--disable-dev-shm-usage`,
 with which the browser is launched to run tests.
 

autotests/packs/allTests.ts

@@ -42,6 +42,7 @@ const waitBeforeRetryTimeout = 1_000;
  * Pack of tests or tasks (pack configuration object).
  */
 export const pack: Pack = {
+  addLogsWithTags: [],
   assertionTimeout: 5_000,
   browserFlags,
   browserName: 'chromium',

package.json

@@ -44,7 +44,7 @@
     "eslint-plugin-simple-import-sort": "12.1.1",
     "eslint-plugin-typescript-sort-keys": "3.3.0",
     "husky": "9.1.7",
-    "prettier": "3.4.1",
+    "prettier": "3.4.2",
     "typescript": "5.7.2"
   },
   "peerDependencies": {

src/types/config/ownE2edConfig.ts

@@ -3,7 +3,7 @@ import type {PlaywrightTestConfig} from '@playwright/test';
 import type {TestRunStatus} from '../../constants/internal';
 
 import type {FullMocksConfig} from '../fullMocks';
-import type {MapBackendResponseToLog, MapLogPayload, MapLogPayloadInReport} from '../log';
+import type {LogTag, MapBackendResponseToLog, MapLogPayload, MapLogPayloadInReport} from '../log';
 import type {MaybePromise} from '../promise';
 import type {LiteReport} from '../report';
 import type {TestOptions, TestStaticOptions} from '../testRun';
@@ -26,6 +26,12 @@ export type OwnE2edConfig<
   SkipTests = SkipTestsPlaceholder,
   TestMeta = TestMetaPlaceholder,
 > = Readonly<{
+  /**
+   * Array of additional log tags. Logs with a specific tag (in `logTag` field)
+   * will be added only if their tag is specified in this array.
+   */
+  addLogsWithTags: readonly LogTag[];
+
   /**
    * Array of browser flags, like `--disable-dev-shm-usage`, with which the browser is launched to run tests.
    */

src/types/index.ts

@@ -37,6 +37,7 @@ export type {
   Url,
 } from './http';
 export type {KeyboardPressKey} from './keyboard';
+export type {Log, LogContext, LogParams, LogPayload, LogTag} from './log';
 export type {ApiMockFunction} from './mockApiRoute';
 export type {WebSocketMockFunction} from './mockWebSocketRoute';
 export type {NavigateToUrlOptions} from './navigation';

src/types/internal.ts

@@ -62,6 +62,7 @@ export type {
   LogContext,
   LogParams,
   LogPayload,
+  LogTag,
   MapBackendResponseToLog,
   MapLogPayload,
   MapLogPayloadInReport,

src/types/log.ts

@@ -30,10 +30,16 @@ export type LogPayload = Readonly<{
   backendResponses?: readonly Payload[];
   filePath?: unknown;
   logEventStatus?: LogEventStatus;
+  logTag?: LogTag;
   successful?: unknown;
 }> &
   Payload;
 
+/**
+ * Type for `log` tags.
+ */
+export type LogTag = 'waitForAllRequestsComplete';
+
 /**
  * Maps responses from the backend to logs during the test.
  * Log the `responseBody` field carefully, as the body of backend response can be very large.

src/utils/log/log.ts

@@ -21,7 +21,12 @@ export const log: Log = (message, maybePayload?: unknown, maybeLogEventType?: un
       ? (maybePayload as LogEventType)
       : ((maybeLogEventType as LogEventType) ?? LogEventType.Unspecified);
 
-  const {mapLogPayloadInReport} = getFullPackConfig();
+  const {addLogsWithTags, mapLogPayloadInReport} = getFullPackConfig();
+
+  if (payload && 'logTag' in payload && !addLogsWithTags.includes(payload.logTag)) {
+    return;
+  }
+
   const payloadInReport = mapLogPayloadInReport(message, payload, type);
 
   registerLogEvent(runId, {message, payload: payloadInReport, time, type});

src/utils/test/preparePage.ts

@@ -1,7 +1,7 @@
 import {AsyncLocalStorage} from 'node:async_hooks';
 
 import {getConsoleMessagesFromContext} from '../../context/consoleMessages';
-import {getIsPageNavigatingNow, setIsPageNavigatingNow} from '../../context/isPageNavigatingNow';
+import {setIsPageNavigatingNow} from '../../context/isPageNavigatingNow';
 import {getJsErrorsFromContext} from '../../context/jsError';
 import {getNavigationDelay} from '../../context/navigationDelay';
 import {getOnResponseCallbacks} from '../../context/onResponseCallbacks';
@@ -49,7 +49,6 @@ export const preparePage = async (page: Page): Promise<() => Promise<void>> => {
   );
 
   let navigationRequestsCount = 0;
-  const skippedRequestUrls = Object.create(null) as Record<string, true>;
 
   const consoleListener = AsyncLocalStorage.bind(async (message: PlaywrightConsoleMessage) => {
     const args: unknown[] = [];
@@ -73,11 +72,6 @@ export const preparePage = async (page: Page): Promise<() => Promise<void>> => {
 
   const requestListener = AsyncLocalStorage.bind(async (newRequest: PlaywrightRequest) => {
     const isNavigationRequest = newRequest.isNavigationRequest();
-    const isPageNavigatingNow = getIsPageNavigatingNow();
-
-    if (isPageNavigatingNow) {
-      skippedRequestUrls[newRequest.url()] = true;
-    }
 
     if (isNavigationRequest) {
       navigationRequestsCount += 1;

src/utils/waitForEvents/addNotCompleteRequest.ts

@@ -1,4 +1,5 @@
 import {assertValueIsDefined} from '../asserts';
+import {log} from '../log';
 
 import {isReRequest} from './isReRequest';
 import {processAllRequestsCompletePredicates} from './processAllRequestsCompletePredicates';
@@ -22,6 +23,11 @@ export const addNotCompleteRequest = async (
 
   hashOfNotCompleteRequests[requestHookContextId] = request;
 
+  log(`Add not complete request with url ${request.url}`, {
+    logTag: 'waitForAllRequestsComplete',
+    requestHookContextId,
+  });
+
   for (const previousRequestId of Object.keys(
     hashOfNotCompleteRequests,
   ) as RequestHookContextId[]) {
@@ -37,6 +43,11 @@ export const addNotCompleteRequest = async (
     });
 
     if (isReRequest(request, previousRequest)) {
+      log(`Remove duplicate request with url ${previousRequest.url}`, {
+        logTag: 'waitForAllRequestsComplete',
+        previousRequestId,
+      });
+
       // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
       delete hashOfNotCompleteRequests[previousRequestId];
     }

src/utils/waitForEvents/completeRequest.ts

@@ -1,3 +1,5 @@
+import {log} from '../log';
+
 import type {RequestHookContextId, WaitForEventsState} from '../../types/internal';
 
 /**
@@ -10,6 +12,11 @@ export const completeRequest = (
 ): void => {
   const {allRequestsCompletePredicates, hashOfNotCompleteRequests} = waitForEventsState;
 
+  log(`Complete request with url ${hashOfNotCompleteRequests[requestHookContextId]?.url}`, {
+    logTag: 'waitForAllRequestsComplete',
+    requestHookContextId,
+  });
+
   // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
   delete hashOfNotCompleteRequests[requestHookContextId];