E2E-275 fix: renew last log event time on start of each test

Author: uid11

src/actions/switchToMainTab.ts

@@ -7,13 +7,13 @@ import {switchPlaywrightPage} from '../utils/playwrightPage';
 /**
  * Switches page context to the specified tab.
  */
-export const switchToMainTab = (): void => {
+export const switchToMainTab = async (): Promise<void> => {
   clearTab();
 
   const page = getPlaywrightPage();
   const url = page.url();
 
   log(`Switch page context to the main tab at ${url}`, LogEventType.InternalAction);
 
-  switchPlaywrightPage(page);
+  await switchPlaywrightPage(page);
 };

src/actions/switchToTab.ts

@@ -8,13 +8,13 @@ import type {InternalTab, Tab} from '../types/internal';
 /**
  * Switches page context to the specified tab.
  */
-export const switchToTab = (tab: Tab): void => {
+export const switchToTab = async (tab: Tab): Promise<void> => {
   const {page} = tab as InternalTab;
   const url = page.url();
 
   log(`Switch page context to the specified tab at ${url}`, LogEventType.InternalAction);
 
   setTab(tab);
 
-  switchPlaywrightPage(page);
+  await switchPlaywrightPage(page);
 };

src/context/clearPage.ts

@@ -0,0 +1,7 @@
+import {useContext} from '../useContext';
+
+/**
+ * Get and set internal (maybe `undefined`) `clearPage` function.
+ * @internal
+ */
+export const [getClearPage, setClearPage] = useContext<() => Promise<void>>();

src/utils/playwrightPage/switchPlaywrightPage.ts

@@ -1,3 +1,7 @@
+import {getClearPage} from '../../context/clearPage';
+
+import {preparePage} from '../test';
+
 import {pageWaitForRequest, waitForRequestCalls} from './waitForRequest';
 import {pageWaitForResponse, waitForResponseCalls} from './waitForResponse';
 
@@ -8,7 +12,13 @@ import type {Page} from '@playwright/test';
  * Removes all event handlers from the old page and moves them to the new one.
  * @internal
  */
-export const switchPlaywrightPage = (newPage: Page): void => {
+export const switchPlaywrightPage = async (newPage: Page): Promise<void> => {
+  const clearPage = getClearPage();
+
+  await clearPage?.();
+
+  await preparePage(newPage);
+
   const oldRequestCalls = [...waitForRequestCalls];
 
   waitForRequestCalls.length = 0;

src/utils/test/afterTest.ts

@@ -1,21 +1,23 @@
+import {getClearPage} from '../../context/clearPage';
+
 import {registerEndTestRunEvent} from '../events';
 import {generalLog, writeLogsToFile} from '../generalLog';
 
 import type {EndTestRunEvent, UtcTimeInMs} from '../../types/internal';
 
-type Options = Readonly<{clearPage: (() => Promise<void>) | undefined}> &
-  Omit<EndTestRunEvent, 'utcTimeInMs'>;
+type Options = Omit<EndTestRunEvent, 'utcTimeInMs'>;
 
 /**
  * Internal after test hook.
  * @internal
  */
 export const afterTest = async (options: Options): Promise<void> => {
-  const {clearPage, ...optionsWithoutClearPage} = options;
   const utcTimeInMs = Date.now() as UtcTimeInMs;
-  const endTestRunEvent: EndTestRunEvent = {...optionsWithoutClearPage, utcTimeInMs};
+  const endTestRunEvent: EndTestRunEvent = {...options, utcTimeInMs};
 
   try {
+    const clearPage = getClearPage();
+
     await clearPage?.();
 
     await registerEndTestRunEvent(endTestRunEvent);

src/utils/test/beforeTest.ts

@@ -12,6 +12,7 @@ import {addResponseToApiStatistics} from '../apiStatistics';
 import {getFullPackConfig} from '../config';
 import {getRunLabel} from '../environment';
 import {registerStartTestRunEvent} from '../events';
+import {writeLogEventTime} from '../fs';
 import {mapBackendResponseForLogs} from '../log';
 import {isUiMode} from '../uiMode';
 import {getUserlandHooks} from '../userland';
@@ -97,4 +98,6 @@ export const beforeTest = ({
   };
 
   registerStartTestRunEvent(testRunEvent);
+
+  void writeLogEventTime().catch(() => {});
 };

src/utils/test/getRunTest.ts

@@ -27,7 +27,6 @@ export const getRunTest =
       const retryIndex = testInfo.retry + 1;
       const runId = createRunId(test, retryIndex);
 
-      let clearPage: (() => Promise<void>) | undefined;
       let hasRunError = false;
       let shouldRunTest = false;
       let testStaticOptions: TestStaticOptions | undefined;
@@ -52,7 +51,7 @@ export const getRunTest =
           testStaticOptions,
         };
 
-        clearPage = await preparePage(page);
+        await preparePage(page);
 
         beforeTest(testUnit);
 
@@ -68,7 +67,7 @@ export const getRunTest =
         throw error;
       } finally {
         if (shouldRunTest) {
-          await afterTest({clearPage, hasRunError, runId, unknownRunError});
+          await afterTest({hasRunError, runId, unknownRunError});
         }
       }
     };

src/utils/test/index.ts

@@ -1,2 +1,4 @@
 /** @internal */
 export {getRunTest} from './getRunTest';
+/** @internal */
+export {preparePage} from './preparePage';

src/utils/test/preparePage.ts

@@ -1,5 +1,6 @@
 import {AsyncLocalStorage} from 'node:async_hooks';
 
+import {setClearPage} from '../../context/clearPage';
 import {getConsoleMessagesFromContext} from '../../context/consoleMessages';
 import {setIsPageNavigatingNow} from '../../context/isPageNavigatingNow';
 import {getJsErrorsFromContext} from '../../context/jsError';
@@ -29,7 +30,7 @@ const afterNavigationRequestsDelayInMs = 300;
  * Prepares page before test.
  * @internal
  */
-export const preparePage = async (page: Page): Promise<() => Promise<void>> => {
+export const preparePage = async (page: Page): Promise<void> => {
   const consoleMessages = getConsoleMessagesFromContext() as ConsoleMessage[];
   const jsErrors = getJsErrorsFromContext() as JsError[];
   const navigationDelay = getNavigationDelay();
@@ -133,7 +134,7 @@ export const preparePage = async (page: Page): Promise<() => Promise<void>> => {
   page.on('response', responseListener);
   page.on('requestfinished', requestfinishedListener);
 
-  return async () => {
+  const clearPage = async (): Promise<void> => {
     page.removeListener('console', consoleListener);
     page.removeListener('pageerror', pageerrorListener);
     page.removeListener('request', requestListener);
@@ -142,4 +143,6 @@ export const preparePage = async (page: Page): Promise<() => Promise<void>> => {
 
     await page.unrouteAll({behavior: 'ignoreErrors'}).catch(() => {});
   };
+
+  setClearPage(clearPage);
 };