feat: read test runs from HTML report

src/actions/getCookies.ts

@@ -5,6 +5,8 @@ import {assertValueIsDefined} from '../utils/asserts';
 
 import type {Cookie} from '../types/internal';
 
+const msInSecond = 1_000;
+
 /**
  * Returns page's cookies with the specified cookies parameters.
  * If there are no cookies parameters, returns all the cookies.
@@ -24,8 +26,15 @@ export const getCookies = async (
   await step(
     logMessage,
     async () => {
-      const page = getPlaywrightPage();
-      const allCookies = await page.context().cookies(page.url());
+      const playwrightPage = getPlaywrightPage();
+      const playwrightCookies = await playwrightPage.context().cookies(playwrightPage.url());
+
+      // Playwright's `cookies` returns `expires` in unix time in seconds (`-1` for session cookies),
+      // while `Cookie` type uses milliseconds (as in `Date.now()`).
+      const allCookies: readonly Cookie[] = playwrightCookies.map(({expires, ...cookie}) => ({
+        ...cookie,
+        ...(expires !== -1 ? {expires: expires * msInSecond} : undefined),
+      }));
 
       if (parameters.length === 0) {
         cookies = allCookies;

src/actions/setCookies.ts

@@ -4,6 +4,8 @@ import {getPlaywrightPage} from '../useContext';
 
 import type {Cookie} from '../types/internal';
 
+const msInSecond = 1_000;
+
 /**
  * Set cookies with the specified cookies parameters.
  */
@@ -15,7 +17,14 @@ export const setCookies = (cookies: readonly Cookie[]): Promise<void> =>
 
       const browserContext = page.context();
 
-      await browserContext.addCookies(cookies);
+      // Playwright's `addCookies` expects `expires` in unix time in seconds,
+      // while `Cookie` type uses milliseconds (as in `Date.now()`).
+      const playwrightCookies = cookies.map(({expires, ...cookie}) => ({
+        ...cookie,
+        ...(expires !== undefined ? {expires: Math.round(expires / msInSecond)} : undefined),
+      }));
+
+      await browserContext.addCookies(playwrightCookies);
     },
     {payload: {cookies}, type: LogEventType.InternalAction},
   );

src/types/http/cookie.ts

@@ -5,6 +5,9 @@ import type {Brand} from '../brand';
  */
 export type Cookie = Readonly<{
   domain?: string;
+  /**
+   * Unix time in milliseconds (as in `Date.now()`).
+   */
   expires?: number;
   httpOnly?: boolean;
   name: string;

src/types/http/http.ts

@@ -41,7 +41,7 @@ export type MapOptions = Readonly<{
  * HTTP method.
  */
 export type Method =
-  'CONNECT' | 'DELETE' | 'GET' | 'HEAD' | 'OPTIONS' | 'PATCH' | 'POST' | 'PUT' | 'TRACE';
+  'CONNECT' | 'DELETE' | 'GET' | 'HEAD' | 'OPTIONS' | 'PATCH' | 'POST' | 'PUT' | 'QUERY' | 'TRACE';
 
 /**
  * Object with query (search) part of the url, or query string itself.

src/types/index.ts

@@ -91,7 +91,7 @@ export type {
   PropertyDescriptor,
   PropertyKey,
 } from './properties';
-export type {LiteReport, LiteRetry} from './report';
+export type {HtmlReportJsonData, LiteReport, LiteRetry, ReportClientData} from './report';
 export type {
   ApiRouteClassType,
   ApiRouteClassTypeWithGetParamsFromUrl,
@@ -104,6 +104,19 @@ export type {PackageInfo, StartInfo} from './startInfo';
 export type {StepBody, StepOptions} from './step';
 export type {StringForLogs} from './string';
 export type {Tab} from './tab';
+export type {
+  FullTestRun,
+  LiteTestRun,
+  RejectTestRun,
+  RunError,
+  RunHash,
+  RunId,
+  TestFn,
+  TestFunction,
+  TestOptions,
+  TestRun,
+  TestStaticOptions,
+} from './testRun';
 export type {MergeTuples, TupleRest} from './tuples';
 export type {
   CloneWithoutUndefinedProperties,

src/types/internal.ts

@@ -134,16 +134,14 @@ export type {
   PropertyDescriptor,
   PropertyKey,
 } from './properties';
-export type {LiteReport, LiteRetry} from './report';
+export type {HtmlReportJsonData, LiteReport, LiteRetry, ReportClientData} from './report';
 /** @internal */
 export type {
-  ReportClientData,
   ReportClientState,
   ReportData,
   Retry,
   RetryButtonProps,
   RetryProps,
-  ScriptJsonData,
   TestRunButtonProps,
 } from './report';
 /** @internal */
@@ -171,6 +169,7 @@ export type {Tab} from './tab';
 /** @internal */
 export type {InternalTab} from './tab';
 export type {
+  FullTestRun,
   LiteTestRun,
   RejectTestRun,
   RunError,
@@ -183,7 +182,7 @@ export type {
   TestStaticOptions,
 } from './testRun';
 /** @internal */
-export type {CompletedTestRun, FullTestRun, RunTest, Test, TestUnit} from './testRun';
+export type {CompletedTestRun, RunTest, Test, TestUnit} from './testRun';
 export type {MergeTuples, TupleRest} from './tuples';
 export type {
   CloneWithoutUndefinedProperties,

src/types/report.ts

@@ -15,6 +15,11 @@ import type {
   TestMetaPlaceholder,
 } from './userland';
 
+/**
+ * JSON data in `<script>` tags with JSON presentation of report data.
+ */
+export type HtmlReportJsonData = ReportClientData | readonly FullTestRun[];
+
 /**
  * The lite report data (for printing lite JSON report) with userland meta.
  */
@@ -81,7 +86,6 @@ export type ReportData = Readonly<{
 
 /**
  * The general report data that needed on client for rendering parts of HTML report.
- * @internal
  */
 export type ReportClientData = Readonly<{
   apiStatistics: ApiStatistics;
@@ -140,12 +144,6 @@ export type RetryProps = Readonly<{
   testRunButtons: readonly TestRunButtonProps[];
 }>;
 
-/**
- * JSON data in `<script>` tags with JSON presentation of report data.
- * @internal
- */
-export type ScriptJsonData = ReportClientData | readonly FullTestRun[];
-
 /**
  * TestRunButton component props.
  * @internal

src/types/testRun.ts

@@ -22,7 +22,6 @@ export type CompletedTestRun<TestMeta = TestMetaPlaceholder> = Readonly<{
 
 /**
  * Full test run object result of userland hooks (like mainParams and runHash).
- * @internal
  */
 export type FullTestRun = Readonly<{mainParams: string; runHash: RunHash}> & TestRun;
 

src/utils/index.ts

@@ -44,13 +44,16 @@ export {deepMerge, getEntries, getKeys, setReadonlyProperty} from './object';
 export {createPageObjectsFromMultiLocator} from './pageObjects';
 export {
   getCodeReport,
+  getFullStepDefinition,
   getLinesIndexes,
   getScenarioReference,
+  getStepReference,
   getTestReference,
   parseMaybeEmptyValueAsJson,
   parseTest,
   ParseTestError,
   parseValueAsJsonIfNeeded,
+  readJsonDataFromHtmlReport,
 } from './parse';
 export {
   addTimeoutToPromise,

src/utils/parse/codeReport/fillTestErrors.ts

@@ -1,6 +1,7 @@
 import {getScenarioReference} from './getScenarioReference';
 import {getScenarioStepsWithReference} from './getScenarioStepsWithReference';
 import {getStepComparisonErrors} from './getStepComparisonErrors';
+import {getStepReference} from './getStepReference';
 import {getTestReference} from './getTestReference';
 import {getTestStepsWithReference} from './getTestStepsWithReference';
 
@@ -28,17 +29,21 @@ export const fillTestErrors = (
   for (const step of scenario.steps) {
     if (step.definition === '') {
       scenarioHasError = true;
-      errors.push(
-        `Step in ${scenario.featurePath}:${step.lineNumber + 1}:${step.column + 1} (in ${scenarioReference}) has no definition.`,
+
+      const reference = getStepReference(
+        {column: step.column + 1, line: step.lineNumber + 1},
+        scenario.featurePath,
       );
+
+      errors.push(`Step ${reference} (in ${scenarioReference}) has no definition.`);
     }
   }
 
   for (const step of test.steps) {
     if (step.definition === undefined || step.definition === '') {
-      errors.push(
-        `Step in ${test.path}:${step.line}:${step.column} (in ${testReference}) has no definition.`,
-      );
+      const reference = getStepReference(step, test.path);
+
+      errors.push(`Step ${reference} (in ${testReference}) has no definition.`);
     }
   }
 

src/utils/parse/codeReport/getFullStepDefinition.ts

@@ -0,0 +1,13 @@
+type Step = Readonly<{
+  definition: string | undefined;
+  kind: string;
+}>;
+
+/**
+ * Get full definition of any step.
+ */
+export const getFullStepDefinition = ({definition, kind}: Step, count: number = 1): string => {
+  const fullDefinition = `"${kind}${definition === undefined || definition === '' ? '' : ` ${definition}`}"`;
+
+  return count > 1 ? `${fullDefinition} (occurrence ${count})` : fullDefinition;
+};

src/utils/parse/codeReport/getScenarioStepsWithReference.ts

@@ -1,4 +1,6 @@
+import {getFullStepDefinition} from './getFullStepDefinition';
 import {getScenarioReference} from './getScenarioReference';
+import {getStepReference} from './getStepReference';
 
 import type {ScenarioReport, StepWithReference} from '../../../types/internal';
 
@@ -15,17 +17,20 @@ export const getScenarioStepsWithReference = (
   const stepsHash: Record<string, number> = Object.create(null) as {};
 
   for (const step of scenario.steps) {
-    const fullDefinition = `${step.kind} ${step.definition}`;
+    const fullDefinition = getFullStepDefinition(step);
 
     stepsHash[fullDefinition] =
       stepsHash[fullDefinition] === undefined ? 1 : stepsHash[fullDefinition] + 1;
 
     const count = stepsHash[fullDefinition];
-    const reference = `in ${scenario.featurePath}:${step.lineNumber + 1}:${step.column + 1} (in ${scenarioReference})`;
+    const reference = getStepReference(
+      {column: step.column + 1, line: step.lineNumber + 1},
+      scenario.featurePath,
+    );
 
     steps.push({
-      key: count === 1 ? `"${fullDefinition}"` : `"${fullDefinition}" (occurrence ${count})`,
-      reference,
+      key: getFullStepDefinition(step, count),
+      reference: `${reference} (in ${scenarioReference})`,
     });
   }
 

src/utils/parse/codeReport/getStepReference.ts

@@ -0,0 +1,10 @@
+type Step = Readonly<{
+  column: number;
+  line: number;
+}>;
+
+/**
+ * Get step reference (without step definition).
+ */
+export const getStepReference = ({column, line}: Step, path: string): string =>
+  `in ${path}:${line}:${column}`;

src/utils/parse/codeReport/getTestStepsWithReference.ts

@@ -1,3 +1,6 @@
+import {getFullStepDefinition} from './getFullStepDefinition';
+import {getStepReference} from './getStepReference';
+
 import type {StepWithReference, TestReport} from '../../../types/internal';
 
 /**
@@ -13,16 +16,16 @@ export const getTestStepsWithReference = (test: TestReport): readonly StepWithRe
       continue;
     }
 
-    const fullDefinition = `${step.kind} ${step.definition}`;
+    const fullDefinition = getFullStepDefinition(step);
 
     stepsHash[fullDefinition] =
       stepsHash[fullDefinition] === undefined ? 1 : stepsHash[fullDefinition] + 1;
 
     const count = stepsHash[fullDefinition];
-    const reference = `in ${test.path}:${step.line}:${step.column}`;
+    const reference = getStepReference(step, test.path);
 
     steps.push({
-      key: count === 1 ? `"${fullDefinition}"` : `"${fullDefinition}" (occurrence ${count})`,
+      key: getFullStepDefinition(step, count),
       reference,
     });
   }

src/utils/parse/codeReport/index.ts

@@ -1,3 +1,5 @@
 export {getCodeReport} from './getCodeReport';
+export {getFullStepDefinition} from './getFullStepDefinition';
 export {getScenarioReference} from './getScenarioReference';
+export {getStepReference} from './getStepReference';
 export {getTestReference} from './getTestReference';

src/utils/parse/index.ts

@@ -1,4 +1,11 @@
-export {getCodeReport, getScenarioReference, getTestReference} from './codeReport';
+export {
+  getCodeReport,
+  getFullStepDefinition,
+  getScenarioReference,
+  getStepReference,
+  getTestReference,
+} from './codeReport';
 export {parseMaybeEmptyValueAsJson} from './parseMaybeEmptyValueAsJson';
 export {getLinesIndexes, parseTest, ParseTestError} from './parseTest';
 export {parseValueAsJsonIfNeeded} from './parseValueAsJsonIfNeeded';
+export {readJsonDataFromHtmlReport} from './readJsonDataFromHtmlReport';

src/utils/parse/readJsonDataFromHtmlReport/getJsonDataBeginning.ts

@@ -0,0 +1,15 @@
+const scriptTag = '<script class="e2edJsonReportData" type="application/json">';
+
+/**
+ * Get beginning of JSON data in HTML report partial source, if any.
+ * @internal
+ */
+export const getJsonDataBeginning = (partialSource: string): string | undefined => {
+  const index = partialSource.indexOf(scriptTag);
+
+  if (index === -1) {
+    return;
+  }
+
+  return partialSource.slice(index + scriptTag.length);
+};

src/utils/parse/readJsonDataFromHtmlReport/index.ts

@@ -0,0 +1 @@
+export {readJsonDataFromHtmlReport} from './readJsonDataFromHtmlReport';

src/utils/parse/readJsonDataFromHtmlReport/readJsonData.ts

@@ -0,0 +1,34 @@
+import type {HtmlReportJsonData} from '../../../types/internal';
+
+type Return = Readonly<{
+  jsonData: readonly HtmlReportJsonData[];
+  tail: string;
+}>;
+
+// </script><script class="e2edJsonReportData" type="application/json">
+
+/**
+ * Reads JSON data from complete JSON source.
+ * @internal
+ */
+export const readJsonData = (jsonSource: string): Return => {
+  const parts = jsonSource.split(
+    '</script><script class="e2edJsonReportData" type="application/json">',
+  );
+
+  const lastPart = parts.pop();
+
+  if (lastPart === undefined) {
+    throw new Error('Cannot parse JSON data from HTML report');
+  }
+
+  const jsonData = parts.map((part) => JSON.parse(part) as HtmlReportJsonData);
+
+  try {
+    jsonData.push(JSON.parse(lastPart) as HtmlReportJsonData);
+  } catch {
+    return {jsonData, tail: lastPart};
+  }
+
+  return {jsonData, tail: ''};
+};