FI-1237 fix: status of local e2ed run

fix: remove `bin-v8-flags-filter` package
fix: respect `expect` and `global` timeouts in config
fix: error in internal `selectorCustomMethods` test
chore: update version of node in GitHub Actions
fix: add logs to `setHeadersAndNavigateToUrl` action
fix: urls of screenshots in HTML report

.github/workflows/ci.yaml

@@ -10,7 +10,7 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           cache: npm
-          node-version: 20.10.0
+          node-version: 20.16.0
       - run: npm ci
       - run: npm run build
       - run: npm run build:docker
@@ -22,7 +22,7 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           cache: npm
-          node-version: 20.10.0
+          node-version: 20.16.0
       - run: npm ci
       - run: npm run build
       - run: npm run lint
@@ -34,7 +34,7 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           cache: npm
-          node-version: 20.10.0
+          node-version: 20.16.0
       - run: npm ci
       - run: npm run build
       - run: npm run test:local

autotests/packs/allTests.ts

@@ -30,8 +30,7 @@ const browserFlags = [
 
 const browser = isLocalRun ? 'chrome' : 'chromium';
 
-const filterTestsIntoPack: FilterTestsIntoPack = ({filePath, options}) =>
-  options.meta.testId !== '13' && !filePath.endsWith('.skip.ts');
+const filterTestsIntoPack: FilterTestsIntoPack = ({options}) => options.meta.testId !== '13';
 
 const overriddenUserAgent =
   'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.35 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.35';

autotests/tests/e2edReportExample/selectorCustomMethods.ts

@@ -61,5 +61,5 @@ test('selector custom methods', {meta: {testId: '15'}}, async () => {
   await expect(
     reportPage.testRunButton.nth(2).getLocatorParameter('status'),
     'nested selectors also get custom methods',
-  ).eql('passed');
+  ).match(/broken|passed/);
 });

package.json

@@ -10,7 +10,7 @@
   "author": "uid11",
   "license": "MIT",
   "bin": {
-    "e2ed": "bin/localEntrypoint.js",
+    "e2ed": "bin/runE2edInLocalEnvironment.js",
     "e2ed-init": "bin/init.js"
   },
   "bugs": "https://github.com/joomcode/e2ed/issues",
@@ -25,7 +25,6 @@
   },
   "dependencies": {
     "@playwright/test": "1.46.0",
-    "bin-v8-flags-filter": "1.2.0",
     "create-locator": "0.0.23",
     "get-modules-graph": "0.0.9",
     "globby": "11.1.0"
@@ -92,7 +91,7 @@
     "postbuild:remove": "touch ./build/node_modules/e2ed/types/index.js",
     "build:copy": "npm run build:copy:bin && npm run build:copy:scripts && npm run build:copy:meta && npm run build:copy:example && npm run build:copy:tsconfig",
     "build:copy:bin": "cp ./bin/dockerEntrypoint.sh ./build/node_modules/e2ed/bin",
-    "postbuild:copy:bin": "npm run make:executable build/node_modules/e2ed/bin/init.js build/node_modules/e2ed/bin/localEntrypoint.js build/node_modules/e2ed/bin/runE2edInDockerEnvironment.js",
+    "postbuild:copy:bin": "npm run make:executable build/node_modules/e2ed/bin/init.js build/node_modules/e2ed/bin/runE2edInLocalEnvironment.js build/node_modules/e2ed/bin/runE2edInDockerEnvironment.js",
     "build:copy:scripts": "cp ./build/scripts/*.js ./build",
     "build:copy:meta": "cp -R ./LICENSE ./logo.svg ./README.md ./styles ./build/node_modules/e2ed",
     "postbuild:copy:meta": "node ./build/writePrunedPackageJson.js",
@@ -117,7 +116,7 @@
     "test:docker:copy": "cp -R ./build/autotests ./build/docker/autotests && cp ./build/tsconfig.json ./build/docker",
     "posttest:docker:copy": "rm -rf ./build/docker/autotests/reports && ./bin/addPackageJsonToBuildDocker.sh",
     "test:docker": "(cd ./build/docker && E2ED_ORIGIN=https://google.com ./autotests/bin/runDocker.sh ./autotests/packs/allTests.ts)",
-    "test:local": "(cd ./build && E2ED_ORIGIN=https://google.com ./node_modules/e2ed/bin/localEntrypoint.js ./autotests/packs/allTests.ts)"
+    "test:local": "(cd ./build && E2ED_ORIGIN=https://google.com ./node_modules/e2ed/bin/runE2edInLocalEnvironment.js ./autotests/packs/allTests.ts)"
   },
   "sideEffects": false,
   "types": "index.d.ts"

src/actions/setHeadersAndNavigateToUrl.ts

@@ -1,4 +1,8 @@
+import {AsyncLocalStorage} from 'node:async_hooks';
+
+import {LogEventType} from '../constants/internal';
 import {getPage} from '../useContext';
+import {log} from '../utils/log';
 import {applyHeadersMapper} from '../utils/requestHooks';
 
 import {navigateToUrl} from './navigateToUrl';
@@ -15,7 +19,7 @@ export const setHeadersAndNavigateToUrl = async (url: Url, options: MapOptions):
 
   await page.route(
     url,
-    async (route) => {
+    AsyncLocalStorage.bind(async (route) => {
       if (mapResponseHeaders === undefined) {
         return route.fallback();
       }
@@ -25,21 +29,25 @@ export const setHeadersAndNavigateToUrl = async (url: Url, options: MapOptions):
 
       applyHeadersMapper(headers, mapResponseHeaders);
 
+      log(`Map response headers for ${url}`, {headers}, LogEventType.InternalAction);
+
       return route.fulfill({headers, response});
-    },
+    }),
     {times: 1},
   );
 
   if (mapRequestHeaders !== undefined) {
     await page.route(
       url,
-      async (route, request) => {
+      AsyncLocalStorage.bind(async (route, request) => {
         const headers = request.headers();
 
         applyHeadersMapper(headers, mapRequestHeaders);
 
+        log(`Map request headers for ${url}`, {headers}, LogEventType.InternalAction);
+
         await route.fallback({headers});
-      },
+      }),
       {times: 1},
     );
   }

src/actions/takeElementScreenshot.ts

@@ -19,13 +19,17 @@ export const takeElementScreenshot = async (
 ): Promise<void> => {
   const description = getDescriptionFromSelector(selector);
 
-  log('Take a screenshot of the element', {description, options}, LogEventType.InternalAction);
+  const {path: pathToScreenshot, ...optionsWithoutPath} = options;
 
-  const {path} = options;
+  log(
+    'Take a screenshot of the element',
+    {description, pathToScreenshot, ...optionsWithoutPath},
+    LogEventType.InternalAction,
+  );
 
-  if (path !== undefined) {
+  if (pathToScreenshot !== undefined) {
     // eslint-disable-next-line no-param-reassign
-    options.path = join(SCREENSHOTS_DIRECTORY_PATH, path);
+    options.path = join(SCREENSHOTS_DIRECTORY_PATH, pathToScreenshot);
   }
 
   await selector.getPlaywrightLocator().screenshot(options);

src/actions/takeScreenshot.ts

@@ -12,16 +12,20 @@ type Options = Parameters<Page['screenshot']>[0];
  * Takes a screenshot of the tested page.
  */
 export const takeScreenshot = async (options: Options = {}): Promise<void> => {
-  log('Take a screenshot of the page', {...options}, LogEventType.InternalAction);
+  const {path: pathToScreenshot, ...optionsWithoutPath} = options;
 
-  const page = getPage();
-
-  const {path} = options;
+  log(
+    'Take a screenshot of the page',
+    {pathToScreenshot, ...optionsWithoutPath},
+    LogEventType.InternalAction,
+  );
 
-  if (path !== undefined) {
+  if (pathToScreenshot !== undefined) {
     // eslint-disable-next-line no-param-reassign
-    options.path = join(SCREENSHOTS_DIRECTORY_PATH, path);
+    options.path = join(SCREENSHOTS_DIRECTORY_PATH, pathToScreenshot);
   }
 
+  const page = getPage();
+
   await page.screenshot(options);
 };

src/config.ts

@@ -51,6 +51,12 @@ const absoluteCompiledUserlandPackPath = join(
 // eslint-disable-next-line @typescript-eslint/no-var-requires, import/no-dynamic-require
 const userlandPack = require<{pack: UserlandPack}>(absoluteCompiledUserlandPackPath).pack;
 
+const pathToTestFile = e2edEnvironment[PATH_TO_TEST_FILE_VARIABLE_NAME];
+
+if (pathToTestFile !== undefined) {
+  setReadonlyProperty(userlandPack, 'testFileGlobs', [join('**', pathToTestFile)]);
+}
+
 assertUserlandPack(userlandPack);
 
 const {
@@ -85,16 +91,13 @@ if (isDebug) {
   setReadonlyProperty(userlandPack, 'testTimeout', maxTimeoutInMs);
 }
 
-const pathToTestFile = e2edEnvironment[PATH_TO_TEST_FILE_VARIABLE_NAME];
-
-const testMatch =
-  pathToTestFile === undefined
-    ? (userlandPack.testFileGlobs as Mutable<typeof userlandPack.testFileGlobs>)
-    : join('**', pathToTestFile);
-
 const playwrightConfig = defineConfig({
+  expect: {timeout: userlandPack.assertionTimeout},
+
   fullyParallel: true,
 
+  globalTimeout: userlandPack.packTimeout,
+
   outputDir: join(relativePathFromInstalledE2edToRoot, INTERNAL_REPORTS_DIRECTORY_PATH),
 
   projects: [
@@ -107,11 +110,15 @@ const playwrightConfig = defineConfig({
   retries: isLocalRun ? 0 : userlandPack.maxRetriesCountInDocker - 1,
 
   testDir: join(relativePathFromInstalledE2edToRoot, TESTS_DIRECTORY_PATH),
-  testIgnore: '**/*.skip.ts',
-  testMatch,
+  testIgnore: ['**/node_modules/**', '**/*.skip.ts'],
+  testMatch: userlandPack.testFileGlobs as Mutable<typeof userlandPack.testFileGlobs>,
 
   timeout: userlandPack.testTimeout,
 
+  workers: userlandPack.concurrency,
+
+  ...userlandPack.overriddenConfigFields,
+
   use: {
     actionTimeout: userlandPack.testIdleTimeout,
 
@@ -122,12 +129,12 @@ const playwrightConfig = defineConfig({
 
     navigationTimeout: userlandPack.pageRequestTimeout,
 
-    trace: 'on-first-retry',
-  },
+    trace: 'retain-on-failure',
 
-  workers: userlandPack.concurrency,
+    viewport: {height: userlandPack.viewportHeight, width: userlandPack.viewportWidth},
 
-  ...userlandPack.overriddenConfigFields,
+    ...userlandPack.overriddenConfigFields?.use,
+  },
 });
 
 const config: FullPackConfig = Object.assign(playwrightConfig, userlandPack);

src/configurator/runEnvironment.ts

@@ -10,14 +10,14 @@ import {RunEnvironment} from './constants';
 export let runEnvironment = e2edEnvironment[RUN_ENVIRONMENT_VARIABLE_NAME] ?? RunEnvironment.Local;
 
 /**
- * `true`, if run e2ed in local environment, and `false` otherwise.
+ * `true`, if run e2ed in docker environment, and `false` otherwise.
  */
-export let isLocalRun = runEnvironment === RunEnvironment.Local;
+export let isDockerRun = runEnvironment === RunEnvironment.Docker;
 
 /**
- * `true`, if run e2ed in docker environment, and `false` otherwise.
+ * `true`, if run e2ed in local environment, and `false` otherwise.
  */
-export let isDockerRun = runEnvironment === RunEnvironment.Docker;
+export let isLocalRun = runEnvironment === RunEnvironment.Local;
 
 /**
  * Set current run environment before e2ed start.

src/types/global.d.ts

@@ -1,4 +1,4 @@
-/* eslint-disable import/no-default-export, import/no-unused-modules, import/unambiguous */
+/* eslint-disable import/no-unused-modules, import/unambiguous */
 
 /**
  * Extends node's require function.
@@ -9,22 +9,3 @@ interface NodeRequire {
   // eslint-disable-next-line @typescript-eslint/prefer-function-type
   <ModuleExports = import('./utils').Any>(modulePath: string): ModuleExports;
 }
-
-/**
- * Package for filtering V8 command line flags when run TestCafe via CLI.
- * @internal
- */
-declare module 'bin-v8-flags-filter' {
-  type Options = Readonly<{
-    forcedKillDelay?: number;
-    ignore?: string[];
-    useShutdownMessage?: boolean;
-  }>;
-
-  /**
-   * Filters out `nodejs` cli options and runs node module on `cliPath`.
-   */
-  const v8FlagsFilter: (cliPath: string, options: Options) => void;
-
-  export default v8FlagsFilter;
-}

src/utils/events/registerStartE2edRunEvent.ts

@@ -1,5 +1,11 @@
 import {RunEnvironment} from '../../configurator';
-import {EVENTS_DIRECTORY_PATH, ExitCode, TMP_DIRECTORY_PATH} from '../../constants/internal';
+import {
+  e2edEnvironment,
+  EVENTS_DIRECTORY_PATH,
+  ExitCode,
+  PATH_TO_TEST_FILE_VARIABLE_NAME,
+  TMP_DIRECTORY_PATH,
+} from '../../constants/internal';
 
 import {getFullPackConfig, updateConfig} from '../config';
 import {getPathToPack, setDotEnvValuesToEnvironment} from '../environment';
@@ -27,6 +33,12 @@ export const registerStartE2edRunEvent = async (): Promise<void> => {
     errorSettingDotEnv = error;
   });
 
+  const pathToTestFile = process.argv[2];
+
+  if (pathToTestFile !== undefined) {
+    e2edEnvironment[PATH_TO_TEST_FILE_VARIABLE_NAME] = pathToTestFile;
+  }
+
   let compileErrors: readonly Readonly<Record<string, string>>[] = [];
   let configCompileTimeWithUnits = '';
 

src/utils/report/collectReportData.ts

@@ -23,11 +23,7 @@ export const collectReportData = async ({
 }: FullEventsData): Promise<ReportData> => {
   const {liteReportFileName, reportFileName} = getFullPackConfig();
 
-  const errors = await getReportErrors(
-    startInfo.runEnvironment,
-    fullTestRuns,
-    notIncludedInPackTests,
-  );
+  const errors = await getReportErrors(fullTestRuns, notIncludedInPackTests);
 
   assertThatTestNamesAndFilePathsAreUnique(fullTestRuns);