Merge pull request #122 from joomcode/feat/update-html-report-layout

feat: full update of HTML report layout

Author: uid11

package-lock.json

@@ -25,14 +25,14 @@
     "url": "git+https://github.com/joomcode/e2ed.git"
   },
   "dependencies": {
-    "@playwright/test": "1.55.0",
+    "@playwright/test": "1.56.0",
     "create-locator": "0.0.27",
     "get-modules-graph": "0.0.11",
     "sort-json-keys": "1.0.3"
   },
   "devDependencies": {
-    "@playwright/browser-chromium": "1.55.0",
-    "@types/node": "24.3.0",
+    "@playwright/browser-chromium": "1.56.0",
+    "@types/node": "24.7.0",
     "@typescript-eslint/eslint-plugin": "7.18.0",
     "@typescript-eslint/parser": "7.18.0",
     "assert-modules-support-case-insensitive-fs": "1.0.1",
@@ -45,7 +45,7 @@
     "eslint-plugin-typescript-sort-keys": "3.3.0",
     "husky": "9.1.7",
     "prettier": "3.6.2",
-    "typescript": "5.9.2"
+    "typescript": "5.9.3"
   },
   "peerDependencies": {
     "@types/node": ">=20",

package.json

@@ -4,15 +4,15 @@ import {assertValueIsDefined, assertValueIsNotNull} from '../../utils/asserts';
 import {log} from '../../utils/log';
 
 import type {Route} from '../../Route';
-import type {Url} from '../../types/internal';
+import type {MaybePromise, Url} from '../../types/internal';
 
 type MaybeUrlOrPath = Url | string | null | undefined;
 
 /**
  * Asserts that url or url path (which can be wrapped in a promise) match route.
  */
 export const assertUrlMatchRoute = async (
-  maybeUrlOrPath: MaybeUrlOrPath | Promise<MaybeUrlOrPath>,
+  maybeUrlOrPath: MaybePromise<MaybeUrlOrPath>,
   route: Route<unknown>,
 ): Promise<void> => {
   const {routeParams} = route;

src/actions/asserts/assertUrlMatchRoute.ts

@@ -19,6 +19,11 @@ export type LogEvent = Readonly<{
   type: LogEventType;
 }>;
 
+/**
+ * Log event with children (for groupping of `TestRun` steps).
+ */
+export type LogEventWithChildren = LogEvent & Readonly<{children: readonly LogEventWithChildren[]}>;
+
 /**
  * EndTestRun event (on closing test).
  * @internal

src/types/events.ts

@@ -58,6 +58,10 @@ declare global {
           class?: string;
         }
       >;
+    } & {
+      button: {popovertarget?: string};
+      input: {popovertarget?: string};
+      meta: {charset?: string};
     };
 
     /**

src/types/global.d.ts

@@ -16,7 +16,7 @@ export type {ConsoleMessage, ConsoleMessageType} from './console';
 export type {UtcTimeInMs} from './date';
 export type {DeepMutable, DeepPartial, DeepReadonly, DeepRequired} from './deep';
 export type {E2edPrintedFields, JsError} from './errors';
-export type {LogEvent, Onlog, TestRunEvent} from './events';
+export type {LogEvent, LogEventWithChildren, Onlog, TestRunEvent} from './events';
 export type {Fn, MergeFunctions} from './fn';
 export type {
   FullMocksConfig,

src/types/index.ts

@@ -31,7 +31,7 @@ export type {E2edEnvironment} from './environment';
 export type {E2edPrintedFields, JsError} from './errors';
 /** @internal */
 export type {GlobalErrorType, MaybeWithIsTestRunBroken} from './errors';
-export type {LogEvent, Onlog, TestRunEvent} from './events';
+export type {LogEvent, LogEventWithChildren, Onlog, TestRunEvent} from './events';
 /** @internal */
 export type {EndTestRunEvent, FullEventsData} from './events';
 export type {Fn, MergeFunctions} from './fn';

src/types/internal.ts

@@ -5,7 +5,6 @@ import type {EndE2edReason, ExitCode, TestRunStatus} from '../constants/internal
 import type {ApiStatistics} from './apiStatistics';
 import type {FullPackConfig} from './config';
 import type {UtcTimeInMs} from './date';
-import type {SafeHtml} from './html';
 import type {TestFilePath} from './paths';
 import type {StartInfo} from './startInfo';
 import type {FullTestRun, LiteTestRun, RunHash, RunId} from './testRun';
@@ -99,7 +98,7 @@ export type ReportClientState = {
   readonly fullTestRuns: readonly FullTestRun[];
   readonly internalDirectoryName: string;
   lengthOfReadedJsonReportDataParts: number;
-  readonly locator: LocatorFunction<SafeHtml>;
+  readonly locator: LocatorFunction;
   readonly pathToScreenshotsDirectoryForReport: string | null;
   readonly readJsonReportDataObservers: MutationObserver[];
   reportClientData?: ReportClientData;

src/types/report.ts

@@ -2,9 +2,9 @@
  * Get the duration of time interval in hours, minutes, seconds and milliseconds.
  * `getDurationWithUnits(1213)` = `'1s 213ms'`.
  * Should be a pure function without dependencies in the form of a function declaration,
- * because it is used in the JS code of HTML report.
+ * because it is used in the JS client code of HTML report.
  */
-export function getDurationWithUnits(durationInMs: number): string {
+export const getDurationWithUnits = (durationInMs: number): string => {
   const msInSecond = 1_000;
   const timeMultiplicator = 60;
 
@@ -37,4 +37,4 @@ export function getDurationWithUnits(durationInMs: number): string {
   }
 
   return parts.slice(0, 2).join(' ') || '0ms';
-}
+};

src/utils/getDurationWithUnits.ts

@@ -4,24 +4,24 @@ type Return = Readonly<{hasParseError: boolean; value: unknown}>;
 
 /**
  * Parses `unknown` value as JSON, if needed.
- * If `isoValueInJsonFormat` is `true`, then parses value as JSON and saves parse error.
- * If `isoValueInJsonFormat` is `false`, then returns value as is.
- * If `isoValueInJsonFormat` is `undefined`, then safely tries to parse value as JSON.
+ * If `isValueInJsonFormat` is `true`, then parses value as JSON and saves parse error.
+ * If `isValueInJsonFormat` is `false`, then returns value as is.
+ * If `isValueInJsonFormat` is `undefined`, then safely tries to parse value as JSON.
  */
 export const parseValueAsJsonIfNeeded = (
   originalValue: unknown,
-  isoValueInJsonFormat?: boolean,
+  isValueInJsonFormat?: boolean,
 ): Return => {
   let hasParseError = false;
   let value = originalValue;
 
-  if (isoValueInJsonFormat === true) {
+  if (isValueInJsonFormat === true) {
     try {
       value = parseMaybeEmptyValueAsJson(originalValue);
     } catch {
       hasParseError = true;
     }
-  } else if (isoValueInJsonFormat !== false) {
+  } else if (isValueInJsonFormat !== false) {
     try {
       value = parseMaybeEmptyValueAsJson(originalValue);
     } catch {}