FI-1741 fix: separate e2ed debug and nodejs debug

fix: `testTimeout` and `testIdleTimeout` in debug mode

Author: uid11

README.md

@@ -196,42 +196,44 @@ The `npx e2ed-init` command is already creating such a file as an example.
 
 For debugging tests, the local run of the pack is intended.
 
-For example, you can use the `debug` action from `e2ed/actions` in the test code:
+For example, you can use the `pause` action from `e2ed/actions` in the test code:
 
 ```ts
-await debug();
+await pause();
 ```
 
-When calling the `debug` action, `e2ed` will stop the test execution and enter
+When calling the `pause` action, `e2ed` will stop the test execution and enter
 the debug-mode.
 
-After debugging is complete, remember to remove the call of the `debug` action.
+After debugging is complete, remember to remove the call of the `pause` action.
 
-In addition, when run pack locally tests can be debugged using the usual `nodejs` debugging flags
-(`--inspect-brk`, `--inspect`), as `nodejs` application (for brevity, we omit the setting of
-environment variables before commands):
+[pause](https://playwright.dev/docs/api/class-page#page-pause) is a function of the `Playwright` itself.
+
+In addition, you can set any non-empty value to the `E2ED_DEBUG` environment variable,
+which will also run `e2ed` in debug mode. If this variable has the form `inspect-brk:9229`,
+then additionally `nodejs` debugging is started on port `9229` (via `--inspect-brk=9229`):
 
 ```sh
-npm run e2ed:allTests ./autotests/tests/main/exists.ts -- --inspect-brk
+E2ED_DEBUG=true npm run e2ed:allTests ./autotests/tests/main/exists.ts
 ```
 
-You can use the `debugger` instruction to stop execution at the desired line.
-
-Or you can set any non-empty value to the `E2ED_DEBUG` environment variable,
-which will also run `e2ed` in `nodejs` debug mode
-(this is equivalentto passing the `--inspect-brk` flag):
-
 ```sh
-E2ED_DEBUG=true npm run e2ed:allTests ./autotests/tests/main/exists.ts
+E2ED_DEBUG=inspect-brk:8230 npm run e2ed:allTests ./autotests/tests/main/exists.ts
 ```
 
 `E2ED_DEBUG` also works for run in docker, and allows you to connect a debugger
 to the `e2ed` running in docker container.
 
+When developing a test, you can run it in [UI-mode](https://playwright.dev/docs/test-ui-mode)
+by passing the `--ui` parameter (for local run only):
+
 ```sh
-npm run e2ed:allTests ./autotests/tests/main/exists.ts -- --debug-on-fail
+npm run e2ed:allTests ./autotests/tests/main/exists.ts -- --ui
 ```
 
+As a result, `Playwright` will launch its [UI-mode](https://playwright.dev/docs/test-ui-mode),
+allowing you to quickly rerun tests and see errors.
+
 ### Basic fields of pack config
 
 The [pack](autotests/packs/allTests.ts) is a single `ts` file
@@ -334,7 +336,7 @@ For example, if it is equal to three, the test will be run no more than three ti
 (`navigateToPage`, `navigateToUrl` actions) in milliseconds.
 
 `overriddenConfigFields: PlaywrightTestConfig | null`: if not `null`, then this value will override
-fields of internal Playwright config.
+fields of internal `Playwright` config.
 
 `packTimeout: number`: timeout (in millisecond) for the entire pack of tests (tasks).
 If the test pack takes longer than this timeout, the pack will fail with the appropriate error.
@@ -419,9 +421,8 @@ You can pass the following optional environment variables to the `e2ed` process
 
 `E2ED_ORIGIN`: origin-part of the url (`protocol` + `host`) on which the tests will be run. For example, `https://bing.com`.
 
-`E2ED_DEBUG`: run `e2ed` in `nodejs` debug mode (`--inspect-brk=0.0.0.0`) if this variable is not empty.
-
-`E2ED_DOCKER_DEBUG_PORT`: debug port when run in docker (`9229` by default).
+`E2ED_DEBUG`: run `e2ed` in debug mode if this variable is not empty. If this variable has the form `inspect-brk:9229`,
+then `nodejs` debugging is started on port `9229` (via `--inspect-brk=9229`).
 
 `E2ED_TERMINATION_SIGNAL`: the termination signal received by the `e2ed` process (if any).
 Typically this value is `'SIGUSR1'`.

autotests/bin/runDocker.sh

@@ -3,11 +3,11 @@ set -eo pipefail
 set +u
 
 CONTAINER_LABEL="e2ed"
-DEBUG_PORT="${E2ED_DOCKER_DEBUG_PORT:-9229}"
+DEBUG_PORT=$([[ $E2ED_DEBUG == inspect-brk:* ]] && echo "${E2ED_DEBUG#inspect-brk:}" || echo "")
 DIR="${E2ED_WORKDIR:-$PWD}"
 E2ED_TIMEOUT_FOR_GRACEFUL_SHUTDOWN_IN_SECONDS=16
 MOUNTDIR="${E2ED_MOUNTDIR:-$DIR}"
-WITH_DEBUG=$([[ -z $E2ED_DEBUG ]] && echo "" || echo "--env E2ED_DEBUG=$DEBUG_PORT --publish $DEBUG_PORT:$DEBUG_PORT --publish $((DEBUG_PORT + 1)):$((DEBUG_PORT + 1))")
+WITH_DEBUG=$([[ -z $DEBUG_PORT ]] && echo "" || echo "--publish $DEBUG_PORT:$DEBUG_PORT --publish $((DEBUG_PORT + 1)):$((DEBUG_PORT + 1))")
 VERSION=$(grep -m1 \"e2ed\": $DIR/package.json | cut -d '"' -f 4)
 
 source ./autotests/variables.env
@@ -47,6 +47,7 @@ echo "Run docker image $E2ED_DOCKER_IMAGE:$VERSION"
 trap "onExit" EXIT
 
 docker run \
+       --env E2ED_DEBUG=$E2ED_DEBUG \
        --env E2ED_ORIGIN=$E2ED_ORIGIN \
        --env E2ED_TIMEOUT_FOR_GRACEFUL_SHUTDOWN_IN_SECONDS=$E2ED_TIMEOUT_FOR_GRACEFUL_SHUTDOWN_IN_SECONDS \
        --env __INTERNAL_E2ED_PATH_TO_PACK=$1 \

bin/dockerEntrypoint.sh

@@ -18,11 +18,13 @@ onExit() {
 
 trap "onExit" EXIT
 
-if [[ -z $E2ED_DEBUG ]]
+DEBUG_PORT=$([[ $E2ED_DEBUG == inspect-brk:* ]] && echo "${E2ED_DEBUG#inspect-brk:}" || echo "")
+
+if [[ -z $DEBUG_PORT ]]
 then
     /node_modules/e2ed/bin/runE2edInDockerEnvironment.js & PID=$!
 else
-    node --inspect-brk=0.0.0.0:$E2ED_DEBUG /node_modules/e2ed/bin/runE2edInDockerEnvironment.js & PID=$!
+    node --inspect-brk=0.0.0.0:$DEBUG_PORT /node_modules/e2ed/bin/runE2edInDockerEnvironment.js & PID=$!
 fi
 
 wait $PID

src/bin/localEntrypoint.ts

@@ -1,15 +1,15 @@
 import {fork} from 'node:child_process';
 import {join} from 'node:path';
 
-import {INSTALLED_E2ED_DIRECTORY_PATH, isDebug} from '../constants/internal';
+import {DEBUG_PORT, INSTALLED_E2ED_DIRECTORY_PATH} from '../constants/internal';
 
 const entrypoitFilePath = join(
   INSTALLED_E2ED_DIRECTORY_PATH,
   'bin',
   'runE2edInLocalEnvironment.js',
 );
 
-const execArgv = isDebug ? ['--inspect-brk'] : [];
+const execArgv = DEBUG_PORT !== undefined ? [`--inspect-brk=${DEBUG_PORT}`] : [];
 
 const e2edProcess = fork(entrypoitFilePath, process.argv.slice(2), {execArgv, stdio: 'inherit'});
 

src/config.ts

@@ -12,7 +12,8 @@ import {
   e2edEnvironment,
   EXPECTED_SCREENSHOTS_DIRECTORY_PATH,
   INTERNAL_REPORTS_DIRECTORY_PATH,
-  isDebug,
+  IS_DEBUG,
+  MAX_TIMEOUT_IN_MS,
   PATH_TO_TEST_FILE_VARIABLE_NAME,
   TESTS_DIRECTORY_PATH,
 } from './constants/internal';
@@ -29,8 +30,6 @@ import type {FullPackConfig, Mutable, UserlandPack} from './types/internal';
 
 import {defineConfig, type PlaywrightTestConfig} from '@playwright/test';
 
-const maxTimeoutInMs = 3600_000;
-
 const pathToPack = getPathToPack();
 const relativePathFromInstalledE2edToRoot = relative(
   ABSOLUTE_PATH_TO_INSTALLED_E2ED_DIRECTORY,
@@ -87,10 +86,10 @@ setCustomInspectOnFunction(mapLogPayloadInConsole);
 setCustomInspectOnFunction(mapLogPayloadInLogFile);
 setCustomInspectOnFunction(mapLogPayloadInReport);
 
-if (isDebug || isUiMode) {
-  setReadonlyProperty(userlandPack, 'packTimeout', maxTimeoutInMs);
-  setReadonlyProperty(userlandPack, 'testIdleTimeout', maxTimeoutInMs);
-  setReadonlyProperty(userlandPack, 'testTimeout', maxTimeoutInMs);
+if (IS_DEBUG || isUiMode) {
+  setReadonlyProperty(userlandPack, 'packTimeout', MAX_TIMEOUT_IN_MS);
+  setReadonlyProperty(userlandPack, 'testIdleTimeout', MAX_TIMEOUT_IN_MS);
+  setReadonlyProperty(userlandPack, 'testTimeout', MAX_TIMEOUT_IN_MS);
 }
 
 const useOptions: PlaywrightTestConfig['use'] = {

src/constants/debug.ts

@@ -0,0 +1,6 @@
+/**
+ * Maximum timeout in milliseconds for debug mode (24 hours).
+ * In debug mode, all timers are set to this value.
+ * @internal
+ */
+export const MAX_TIMEOUT_IN_MS = 86_400_000;

src/constants/environment.ts

@@ -6,10 +6,17 @@ import type {E2edEnvironment} from '../types/internal';
  */
 export const e2edEnvironment = process.env as E2edEnvironment;
 
+/**
+ * Debug port (for `--inspect-brk`) or `undefined`.
+ */
+export const DEBUG_PORT: number | undefined = e2edEnvironment.E2ED_DEBUG?.startsWith('inspect-brk:')
+  ? Number(e2edEnvironment.E2ED_DEBUG.slice('inspect-brk:'.length)) || undefined
+  : undefined;
+
 /**
  * `true` if e2ed run in debug mode, and `false` otherwise.
  */
-export const isDebug: boolean = Boolean(e2edEnvironment.E2ED_DEBUG);
+export const IS_DEBUG: boolean = Boolean(e2edEnvironment.E2ED_DEBUG);
 
 /**
  * Name of e2ed environment variable with path to pack.

src/constants/index.ts

@@ -1,5 +1,5 @@
 export {EndE2edReason, ExitCode} from './end';
-export {isDebug} from './environment';
+export {DEBUG_PORT, IS_DEBUG} from './environment';
 export {READ_FILE_OPTIONS} from './fs';
 export {
   BAD_REQUEST_STATUS_CODE,

src/constants/internal.ts

@@ -4,8 +4,10 @@ export {attributesOptions} from './attributesOptions';
 export {EXEC_FILE_OPTIONS} from './childProcess';
 /** @internal */
 export {ConsoleBackgroundColor} from './color';
+/** @internal */
+export {MAX_TIMEOUT_IN_MS} from './debug';
 export {EndE2edReason, ExitCode} from './end';
-export {isDebug, RunEnvironment} from './environment';
+export {DEBUG_PORT, IS_DEBUG, RunEnvironment} from './environment';
 /** @internal */
 export {
   e2edEnvironment,

src/generators/createRunId.ts

@@ -3,7 +3,7 @@ import {getHash} from '../utils/getHash';
 import type {RunId, Test} from '../types/internal';
 
 /**
- * Creates new RunId for TestRun.
+ * Creates new `RunId` for TestRun.
  * @internal
  */
 export const createRunId = (test: Test, retryIndex: number): RunId => {