feat: support waitings before retries

.eslintrc.yaml

@@ -163,7 +163,7 @@ rules:
   '@typescript-eslint/class-literal-property-style': error
   '@typescript-eslint/consistent-generic-constructors': error
   '@typescript-eslint/consistent-indexed-object-style': error
-  '@typescript-eslint/consistent-return': error
+  '@typescript-eslint/consistent-return': off
   '@typescript-eslint/consistent-type-assertions':
     [error, {assertionStyle: as, objectLiteralTypeAssertions: never}]
   '@typescript-eslint/consistent-type-definitions': [error, type]

README.md

@@ -369,6 +369,9 @@ This parameter can be overridden in the test-specific options.
 
 `viewportWidth: number`: width of viewport of page in pixels.
 
+`waitBeforeRetry: (options: Options) => number`: returns how many milliseconds `e2ed`
+should wait before running test (for retries).
+
 `waitForAllRequestsComplete.maxIntervalBetweenRequestsInMs: number`: default maximum interval
 (in milliseconds) between requests for `waitForAllRequestsComplete` function.
 If there are no new requests for more than this interval, then the promise

autotests/configurator/index.ts

@@ -27,4 +27,5 @@ export type {
   SkipTests,
   TestFunction,
   TestMeta,
+  WaitBeforeRetry,
 } from './types';

autotests/configurator/mapLogPayloadInConsole.ts

@@ -19,7 +19,6 @@ export const mapLogPayloadInConsole: MapLogPayloadInConsole = (message, payload)
 
   if (
     message.startsWith('Caught an error when running tests in retry') ||
-    message.startsWith('Warning from TestCafe:') ||
     message.startsWith('Usage:')
   ) {
     return payload;

autotests/configurator/types/index.ts

@@ -16,6 +16,7 @@ export type {
   MapLogPayloadInReport,
   Pack,
   TestFunction,
+  WaitBeforeRetry,
 } from './packSpecific';
 export type {SkipTests} from './skipTests';
 export type {TestMeta} from './testMeta';

autotests/configurator/types/packSpecific.ts

@@ -23,4 +23,5 @@ export type MapLogPayloadInConsole = PackSpecificTypes['MapLogPayloadInConsole']
 export type MapLogPayloadInLogFile = PackSpecificTypes['MapLogPayloadInLogFile'];
 export type MapLogPayloadInReport = PackSpecificTypes['MapLogPayloadInReport'];
 export type TestFunction = PackSpecificTypes['TestFunction'];
+export type WaitBeforeRetry = PackSpecificTypes['WaitBeforeRetry'];
 export type {Pack};

autotests/fixtures/fullMocks/mr-iHTD7Lp.json

@@ -0,0 +1 @@
+{"/api/product/135865":[{"completionTimeInMs":1729850053899,"duration":"4ms","request":{"method":"POST","query":{"size":"13"},"requestBody":{"cookies":[],"input":17,"model":"samsung","version":"12"},"requestHeaders":{"accept":"*/*","accept-language":"en-US","content-type":"application/json; charset=UTF-8","referer":"https://joomcode.github.io/","user-agent":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.35 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.35","sec-ch-ua":"\"Chromium\";v=\"130\", \"HeadlessChrome\";v=\"130\", \"Not?A_Brand\";v=\"99\"","sec-ch-ua-mobile":"?0","sec-ch-ua-platform":"\"Linux\""},"url":"https://reqres.in/api/product/135865?size=13","utcTimeInMs":1729850053895},"responseBody":{"id":135865,"method":"POST","output":"17","payload":{"id":"135865","cookies":[],"input":17,"model":"samsung","version":"12"},"query":{"size":"13"},"url":"https://reqres.in/api/product/135865?size=13"},"responseHeaders":{"content-type":"application/json; charset=UTF-8","content-length":"201"},"statusCode":200},{"completionTimeInMs":1729850054453,"duration":"4ms","request":{"method":"POST","query":{"size":"13"},"requestBody":{"cookies":[],"input":17,"model":"samsung","version":"12"},"requestHeaders":{"accept":"*/*","accept-language":"en-US","content-type":"application/json; charset=UTF-8","referer":"https://joomcode.github.io/","user-agent":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.35 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.35","sec-ch-ua":"\"Chromium\";v=\"130\", \"HeadlessChrome\";v=\"130\", \"Not?A_Brand\";v=\"99\"","sec-ch-ua-mobile":"?0","sec-ch-ua-platform":"\"Linux\""},"url":"https://reqres.in/api/product/135865?size=13","utcTimeInMs":1729850054449},"responseBody":{"cookies":[],"input":17,"model":"samsung","version":"12","id":"816","createdAt":"2024-10-25T09:54:14.388Z"},"responseHeaders":{"reporting-endpoints":"heroku-nel=https://nel.heroku.com/reports?ts=1729850054&sid=c4c9725f-1ab0-44d8-820f-430df2718e11&s=LZBdsiG2rgFml4T6awFYmhftTlXLyvdfcMob39wiK2I%3D","nel":"{\"report_to\":\"heroku-nel\",\"max_age\":3600,\"success_fraction\":0.005,\"failure_fraction\":0.05,\"response_headers\":[\"Via\"]}","cf-cache-status":"DYNAMIC","etag":"W/\"6c-uS8VtSQALUKVvQbVlIe2ZwBwLRE\"","report-to":"{\"group\":\"heroku-nel\",\"max_age\":3600,\"endpoints\":[{\"url\":\"https://nel.heroku.com/reports?ts=1729850054&sid=c4c9725f-1ab0-44d8-820f-430df2718e11&s=LZBdsiG2rgFml4T6awFYmhftTlXLyvdfcMob39wiK2I%3D\"}]}","via":"1.1 vegur","cf-ray":"8d8152f7a8d43cff-CDG","access-control-allow-origin":"*","content-length":"108","date":"Fri, 25 Oct 2024 09:54:14 GMT","content-type":"application/json; charset=utf-8","x-powered-by":"Express","server":"cloudflare"},"statusCode":201}]}

autotests/packs/allTests.ts

@@ -78,10 +78,11 @@ export const pack: Pack = {
   takeViewportScreenshotOnError: true,
   testFileGlobs: ['**/autotests/tests/**/*.ts'],
   testIdleTimeout: 8_000,
-  testTimeout: 60_000,
+  testTimeout: 15_000,
   userAgent,
   viewportHeight: 1080,
   viewportWidth: 1920,
+  waitBeforeRetry: () => 0,
   waitForAllRequestsComplete: {
     maxIntervalBetweenRequestsInMs: 500,
     timeout: 30_000,

package.json

@@ -1,10 +1,10 @@
 {
   "name": "e2ed",
   "version": "0.18.15",
-  "description": "E2E testing framework over TestCafe",
+  "description": "E2E testing framework over Playwright",
   "keywords": [
     "E2E",
-    "TestCafe",
+    "Playwright",
     "testing"
   ],
   "author": "uid11",

src/Page.ts

@@ -80,8 +80,9 @@ export abstract class Page<PageParams = undefined> {
    * Asserts that we are on the expected page by `isMatch` flage.
    * `isMatch` equals `true`, if url matches the page with given parameters, and `false` otherwise.
    */
-  assertPage(isMatch: boolean): AsyncVoid {
+  assertPage(isMatch: boolean, documentUrl: Url): AsyncVoid {
     assertValueIsTrue(isMatch, `the document url matches the page "${this.constructor.name}"`, {
+      documentUrl,
       page: this,
     });
   }

src/actions/pages/assertPage.ts

@@ -34,7 +34,7 @@ export const assertPage = async <SomePageClass extends AnyPageClassType>(
     LogEventType.InternalAction,
   );
 
-  await page.assertPage(isMatch);
+  await page.assertPage(isMatch, documentUrl);
 
   await page.afterAssertPage?.();
 

src/actions/pages/navigateToPage.ts

@@ -46,7 +46,7 @@ export const navigateToPage = async <SomePageClass extends AnyPageClassType>(
   const documentUrl = await getDocumentUrl();
   const isMatch = route.isMatchUrl(documentUrl);
 
-  await page.assertPage(isMatch);
+  await page.assertPage(isMatch, documentUrl);
 
   await page.afterAssertPage?.();
 

src/actions/pressKey.ts

@@ -1,20 +1,73 @@
 import {LogEventType} from '../constants/internal';
 import {getPlaywrightPage} from '../useContext';
+import {E2edError} from '../utils/error';
 import {log} from '../utils/log';
+import {getDescriptionFromSelector} from '../utils/selectors';
 
-import type {Keyboard} from '@playwright/test';
+import type {KeyboardPressKey, Selector} from '../types/internal';
 
-import type {KeyboardPressKey} from '../types/internal';
+type Options = Readonly<{delay?: number; timeout?: number}>;
 
-type Options = Parameters<Keyboard['press']>[1];
+type PressKey = ((
+  this: void,
+  selector: Selector,
+  key: KeyboardPressKey,
+  options?: Options,
+) => Promise<void>) &
+  ((this: void, key: KeyboardPressKey, options?: Options) => Promise<void>);
 
 /**
  * Presses the specified keyboard keys.
  */
-export const pressKey = async (key: KeyboardPressKey, options: Options = {}): Promise<void> => {
-  log(`Press keyboard key: "${key}"`, options, LogEventType.InternalAction);
+export const pressKey: PressKey = async (
+  keyOrSelector: KeyboardPressKey | Selector,
+  keyOrOptions?: KeyboardPressKey | Options,
+  maybeOptions?: Options,
+): Promise<void> => {
+  let key: KeyboardPressKey;
+  let selector: Selector | undefined;
+  let options: Options;
+
+  if (typeof keyOrSelector === 'string') {
+    key = keyOrSelector;
+
+    if (typeof keyOrOptions === 'string') {
+      throw new E2edError('keyOrOptions is string', {
+        keyOrOptions,
+        keyOrSelector,
+        maybeOptions,
+      });
+    }
+
+    options = keyOrOptions ?? {};
+  } else {
+    selector = keyOrSelector;
+
+    if (typeof keyOrOptions !== 'string') {
+      throw new E2edError('keyOrOptions is not string', {
+        keyOrOptions,
+        keyOrSelector,
+        maybeOptions,
+      });
+    }
+
+    key = keyOrOptions;
+
+    options = maybeOptions ?? {};
+  }
+
+  const withDescription =
+    selector !== undefined
+      ? ` on element with description ${getDescriptionFromSelector(selector)}`
+      : '';
+
+  log(`Press keyboard key${withDescription}: "${key}"`, options, LogEventType.InternalAction);
 
   const page = getPlaywrightPage();
 
-  await page.keyboard.press(key, options);
+  if (selector !== undefined) {
+    await selector.getPlaywrightLocator().press(key, options);
+  } else {
+    await page.keyboard.press(key, options);
+  }
 };

src/constants/testRun.ts

@@ -13,8 +13,8 @@ declare type TestRunTypesChecks = [
 
 /**
  * Main status of test run.
- * Failed if it have run error and passed if not.
- * Broken if the test failed and TestCafe restarted it themself.
+ * `Failed` if it have run error and passed if not.
+ * Probably should never be `Broken`.
  */
 export const enum TestRunStatus {
   Broken = 'broken',

src/generators/createRunId.ts

@@ -1,9 +1,21 @@
-import {getRandomId} from './getRandomId';
+import {createHash} from 'node:crypto';
 
-import type {RunId} from '../types/internal';
+import type {RunId, Test} from '../types/internal';
+
+const runIdBaseLength = 10;
 
 /**
  * Creates new RunId for TestRun.
  * @internal
  */
-export const createRunId = (): RunId => getRandomId().replace(/:/g, '-') as RunId;
+export const createRunId = (test: Test, retryIndex: number): RunId => {
+  const data = {...test, testFn: test.testFn.toString()};
+  const text = JSON.stringify(data);
+  const hash = createHash('sha1');
+
+  hash.update(text);
+
+  const base = hash.digest('base64url').slice(0, runIdBaseLength);
+
+  return `${base}-${retryIndex}` as RunId;
+};

src/types/clientFunction.ts

@@ -7,24 +7,3 @@ export type ClientFunction<Args extends readonly unknown[] = [], Result = Void>
   this: void,
   ...args: Args
 ) => Promise<Result>;
-
-/**
- * Result of the internal client function wrapper (object with error as string or with value).
- * @internal
- */
-export type ClientFunctionWrapperResult<Result = unknown> = Readonly<
-  | {
-      errorMessage: string;
-      result: undefined;
-    }
-  | {
-      errorMessage: undefined;
-      result: Result;
-    }
->;
-
-/**
- * Internal TestCafe error object or undefined.
- * @internal
- */
-export type MaybeTestCafeError = {code?: string} | undefined;

src/types/config/config.ts

@@ -10,18 +10,6 @@ import type {
 import type {WithDoBeforePack} from './doBeforePack';
 import type {OwnE2edConfig} from './ownE2edConfig';
 
-/**
- * Userland part of TestCafe config.
- */
-type UserlandTestCafeConfig = Readonly<{
-  assertionTimeout: number;
-  concurrency: number;
-  pageRequestTimeout: number;
-  port1: number;
-  port2: number;
-  selectorTimeout: number;
-}>;
-
 /**
  * Supported browsers.
  */
@@ -69,5 +57,12 @@ export type UserlandPackWithoutDoBeforePack<
   CustomReportProperties = CustomReportPropertiesPlaceholder,
   SkipTests = SkipTestsPlaceholder,
   TestMeta = TestMetaPlaceholder,
-> = UserlandTestCafeConfig &
+> = Readonly<{
+  assertionTimeout: number;
+  concurrency: number;
+  pageRequestTimeout: number;
+  port1: number;
+  port2: number;
+  selectorTimeout: number;
+}> &
   OwnE2edConfig<CustomPackProperties, CustomReportProperties, SkipTests, TestMeta>;

src/types/config/ownE2edConfig.ts

@@ -1,5 +1,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 {MaybePromise} from '../promise';
@@ -255,6 +257,19 @@ export type OwnE2edConfig<
    */
   viewportWidth: number;
 
+  /**
+   * Returns how many milliseconds `e2ed` should wait before running test (for retries).
+   */
+  waitBeforeRetry: (
+    this: void,
+    options: Readonly<{
+      previousError: string | undefined;
+      retryIndex: number;
+      status: TestRunStatus;
+      testStaticOptions: TestStaticOptions<TestMeta>;
+    }>,
+  ) => MaybePromise<number>;
+
   /**
    * Group of settings for the `waitForAllRequestsComplete` function.
    */

src/types/internal.ts

@@ -5,8 +5,6 @@ export type {Brand, IsBrand} from './brand';
 export type {Expect, IsEqual, IsReadonlyKey} from './checks';
 export type {Class} from './class';
 export type {ClientFunction} from './clientFunction';
-/** @internal */
-export type {ClientFunctionWrapperResult, MaybeTestCafeError} from './clientFunction';
 export type {
   AnyPack,
   BrowserName,

src/types/userland/createPackSpecificTypes.ts

@@ -36,4 +36,5 @@ export type CreatePackSpecificTypes<
   MapLogPayloadInLogFile: MapLogPayload;
   MapLogPayloadInReport: MapLogPayloadInReport;
   TestFunction: TestFunction<PackParameters['TestMeta']>;
+  WaitBeforeRetry: FullPackConfigByPack<Pack>['waitBeforeRetry'];
 }>;

src/utils/fs/index.ts

@@ -7,6 +7,8 @@ export {getTestRunEventFileName} from './getTestRunEventFileName';
 /** @internal */
 export {getLastLogEventTimeInMs, writeLogEventTime} from './logIsoString';
 /** @internal */
+export {readEventFromFile} from './readEventFromFile';
+/** @internal */
 export {readEventsFromFiles} from './readEventsFromFiles';
 /** @internal */
 export {readStartInfo} from './readStartInfo';

src/utils/fs/readEventFromFile.ts

@@ -0,0 +1,23 @@
+import {readFile} from 'node:fs/promises';
+import {join} from 'node:path';
+
+import {EVENTS_DIRECTORY_PATH, READ_FILE_OPTIONS} from '../../constants/internal';
+
+import {generalLog} from '../generalLog';
+
+/**
+ * Read event object with test run from temporary directory.
+ * @internal
+ */
+export const readEventFromFile = (fileName: string): Promise<string | undefined> => {
+  const filePath = join(EVENTS_DIRECTORY_PATH, fileName);
+
+  return readFile(filePath, READ_FILE_OPTIONS).catch((error: unknown) => {
+    generalLog(`Caught an error on reading text of test run event from file "${fileName}"`, {
+      error,
+      filePath,
+    });
+
+    return undefined;
+  });
+};