Merge pull request #113 from joomcode/fix/merge-urls-in-api-statistics

fix: merge urls for API statistics

Author: uid11

src/types/internal.ts

@@ -112,11 +112,13 @@ export type {
 export type {LiteReport, LiteRetry} from './report';
 /** @internal */
 export type {
+  ReportClientData,
   ReportClientState,
   ReportData,
   Retry,
   RetryButtonProps,
   RetryProps,
+  ScriptJsonData,
   TestRunButtonProps,
 } from './report';
 /** @internal */

src/types/report.ts

@@ -13,28 +13,6 @@ import type {
   TestMetaPlaceholder,
 } from './userland';
 
-/**
- * The complete report data (for printing report).
- * @internal
- */
-export type ReportData = Readonly<{
-  apiStatistics: ApiStatistics;
-  customReportProperties: CustomReportPropertiesPlaceholder | undefined;
-  endE2edReason: EndE2edReason;
-  endTimeInMs: UtcTimeInMs;
-  errors: readonly string[];
-  exitCode: ExitCode;
-  failedTestsMainParams: readonly string[];
-  fullTestRuns: readonly FullTestRun[];
-  liteReportFileName: string | null;
-  logFileName: string | null;
-  notIncludedInPackTests: readonly TestFilePath[];
-  reportFileName: string | null;
-  retries: readonly Retry[];
-  startInfo: StartInfo;
-  summaryPackResults: string;
-}>;
-
 /**
  * The lite report data (for printing lite JSON report) with userland meta.
  */
@@ -61,28 +39,48 @@ export type LiteReport<
 }>;
 
 /**
- * RetryButton component props.
- * @internal
+ * Lite retry object with all his lite test runs.
  */
-export type RetryButtonProps = Readonly<{
-  disabled: boolean;
-  retry: number;
-  selected: boolean;
+export type LiteRetry<TestMeta = TestMetaPlaceholder> = Readonly<{
+  brokenLiteTestRuns: readonly LiteTestRun<TestMeta>[];
+  concurrency: number;
+  endTimeInMs: UtcTimeInMs;
+  /**
+   * Test runs of all statuses except broken.
+   */
+  liteTestRuns: readonly LiteTestRun<TestMeta>[];
+  retryIndex: number;
+  startTimeInMs: UtcTimeInMs;
 }>;
 
 /**
- * TestRunButton component props.
+ * The complete report data (for printing report).
  * @internal
  */
-export type TestRunButtonProps = Readonly<{
+export type ReportData = Readonly<{
+  apiStatistics: ApiStatistics;
+  customReportProperties: CustomReportPropertiesPlaceholder | undefined;
+  endE2edReason: EndE2edReason;
   endTimeInMs: UtcTimeInMs;
-  filePath: TestFilePath;
-  mainParams: string;
-  name: string;
-  runHash: RunHash;
-  runId: RunId;
-  startTimeInMs: UtcTimeInMs;
-  status: TestRunStatus;
+  errors: readonly string[];
+  exitCode: ExitCode;
+  failedTestsMainParams: readonly string[];
+  fullTestRuns: readonly FullTestRun[];
+  liteReportFileName: string | null;
+  logFileName: string | null;
+  notIncludedInPackTests: readonly TestFilePath[];
+  reportFileName: string | null;
+  retries: readonly Retry[];
+  startInfo: StartInfo;
+  summaryPackResults: string;
+}>;
+
+/**
+ * The general report data that needed on client for rendering parts of HTML report.
+ * @internal
+ */
+export type ReportClientData = Readonly<{
+  apiStatistics: ApiStatistics;
 }>;
 
 /**
@@ -96,6 +94,7 @@ export type ReportClientState = {
   lengthOfReadedJsonReportDataParts: number;
   readonly pathToScreenshotsDirectoryForReport: string | null;
   readonly readJsonReportDataObservers: MutationObserver[];
+  reportClientData?: ReportClientData;
   testRunDetailsElementsByHash?: Record<RunHash, HTMLElement>;
 };
 
@@ -112,18 +111,13 @@ export type Retry = Readonly<{
 }>;
 
 /**
- * Lite retry object with all his lite test runs.
+ * RetryButton component props.
+ * @internal
  */
-export type LiteRetry<TestMeta = TestMetaPlaceholder> = Readonly<{
-  brokenLiteTestRuns: readonly LiteTestRun<TestMeta>[];
-  concurrency: number;
-  endTimeInMs: UtcTimeInMs;
-  /**
-   * Test runs of all statuses except broken.
-   */
-  liteTestRuns: readonly LiteTestRun<TestMeta>[];
-  retryIndex: number;
-  startTimeInMs: UtcTimeInMs;
+export type RetryButtonProps = Readonly<{
+  disabled: boolean;
+  retry: number;
+  selected: boolean;
 }>;
 
 /**
@@ -137,3 +131,24 @@ export type RetryProps = Readonly<{
   startTimeInMs: UtcTimeInMs;
   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
+ */
+export type TestRunButtonProps = Readonly<{
+  endTimeInMs: UtcTimeInMs;
+  filePath: TestFilePath;
+  mainParams: string;
+  name: string;
+  runHash: RunHash;
+  runId: RunId;
+  startTimeInMs: UtcTimeInMs;
+  status: TestRunStatus;
+}>;

src/utils/apiStatistics/addPageToApiStatistics.ts

@@ -1,8 +1,7 @@
-import {URL} from 'node:url';
-
 import {getApiStatistics} from '../../context/apiStatistics';
 
 import {addApiStatistics} from './addApiStatistics';
+import {getUrlTemplate} from './getUrlTemplate';
 
 import type {ApiStatistics, PageName, Url} from '../../types/internal';
 
@@ -18,11 +17,10 @@ type Options = Readonly<{
  */
 export const addPageToApiStatistics = ({duration, pageName, url}: Options): void => {
   const apiStatistics = getApiStatistics();
-  const {origin, pathname} = new URL(url);
-  const urlWithoutQuery = `${origin}${pathname}` as Url;
+  const urlTemplate = getUrlTemplate(url);
 
   const additionalApiStatistics: ApiStatistics = {
-    pages: {[pageName]: {[urlWithoutQuery]: {count: 1, duration}}},
+    pages: {[pageName]: {[urlTemplate]: {count: 1, duration}}},
     requests: {},
   };
 

src/utils/apiStatistics/addResponseToApiStatistics.ts

@@ -1,12 +1,11 @@
-import {URL} from 'node:url';
-
 import {getApiStatistics} from '../../context/apiStatistics';
 
 import {getHeaderValue} from '../headers';
 
 import {addApiStatistics} from './addApiStatistics';
+import {getUrlTemplate} from './getUrlTemplate';
 
-import type {ApiStatistics, ResponseWithRequest, Url} from '../../types/internal';
+import type {ApiStatistics, ResponseWithRequest} from '../../types/internal';
 
 /**
  * Add single `ResponseWithRequest` to API statistics.
@@ -21,13 +20,11 @@ export const addResponseToApiStatistics = (responseWithRequest: ResponseWithRequ
   } = responseWithRequest;
 
   const size = Number(getHeaderValue(responseWithRequest.responseHeaders, 'content-length')) || 0;
-
-  const {origin, pathname} = new URL(url);
-  const urlWithoutQuery = `${origin}${pathname}` as Url;
+  const urlTemplate = getUrlTemplate(url);
 
   const additionalApiStatistics: ApiStatistics = {
     pages: {},
-    requests: {[urlWithoutQuery]: {[method]: {[statusCode]: {count: 1, duration, size}}}},
+    requests: {[urlTemplate]: {[method]: {[statusCode]: {count: 1, duration, size}}}},
   };
 
   addApiStatistics(apiStatistics, additionalApiStatistics);

src/utils/apiStatistics/getBorderCount.ts

@@ -0,0 +1,61 @@
+import {assertValueIsDefined} from '../asserts';
+
+const aCodePoint = 97;
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const ACodePoint = 65;
+const nineCodePoint = 57;
+const zCodePoint = 122;
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const ZCodePoint = 90;
+const zeroCodePoint = 48;
+
+/**
+ * Returns count of border (letter or non-letter) inside string.
+ * @internal
+ */
+// eslint-disable-next-line complexity
+export const getBorderCount = (value: string): number => {
+  let borderCount = -1;
+  let mode: '.' | '0' | 'A' | 'a' | undefined;
+
+  for (const char of value) {
+    const codePoint = char.codePointAt(0);
+
+    assertValueIsDefined(codePoint, 'codePoint is defined', {value});
+
+    switch (true) {
+      case codePoint >= zeroCodePoint && codePoint <= nineCodePoint:
+        if (mode !== '0') {
+          borderCount += 1;
+        }
+
+        mode = '0';
+        break;
+
+      case codePoint >= ACodePoint && codePoint <= ZCodePoint:
+        if (mode !== 'A') {
+          borderCount += 1;
+        }
+
+        mode = 'A';
+        break;
+
+      case codePoint >= aCodePoint && codePoint <= zCodePoint:
+        if (mode !== 'a') {
+          borderCount += 1;
+        }
+
+        mode = 'a';
+        break;
+
+      default:
+        if (mode !== '.') {
+          borderCount += 1;
+        }
+
+        mode = '.';
+    }
+  }
+
+  return borderCount;
+};

src/utils/apiStatistics/getUrlTemplate.ts

@@ -0,0 +1,52 @@
+import {URL} from 'node:url';
+
+import {assertValueIsDefined} from '../asserts';
+
+import {isIdentifier} from './isIdentifier';
+
+import type {Url} from '../../types/internal';
+
+const maxExtensionLength = 4;
+const minExtensionLength = 2;
+
+/**
+ * Get url template from url (for API statistics).
+ * `query` part is cut off, and all identifiers in the `pathname` are replaced with asterisks.
+ * @internal
+ */
+export const getUrlTemplate = (url: Url): Url => {
+  const {origin, pathname} = new URL(url);
+  const parts = pathname.split('/');
+
+  for (let index = 0; index < parts.length; index += 1) {
+    const part = parts[index];
+
+    assertValueIsDefined(part, 'part is defined', {url});
+
+    if (index === parts.length - 1) {
+      const indexOfPoint = part.lastIndexOf('.');
+      const extensionLength = part.length - indexOfPoint - 1;
+
+      if (
+        indexOfPoint !== -1 &&
+        extensionLength >= minExtensionLength &&
+        extensionLength <= maxExtensionLength
+      ) {
+        const extension = part.slice(indexOfPoint + 1);
+
+        // eslint-disable-next-line max-depth
+        if (/^[a-z]+$/.test(extension)) {
+          continue;
+        }
+      }
+    }
+
+    if (isIdentifier(part)) {
+      parts[index] = '*';
+    }
+  }
+
+  const newPathname = parts.join('/');
+
+  return `${origin}${newPathname}` as Url;
+};

src/utils/apiStatistics/isIdentifier.ts

@@ -0,0 +1,41 @@
+import {getBorderCount} from './getBorderCount';
+
+const maxBorderCountOfNonIdentifier = 6;
+const minIdentifierLength = 6;
+const maxIdentifierLengthForMaxBorder = 12;
+
+/**
+ * Returns `true`, is `value` is identifier, like `67ca3bc9fa30bbcd46dd6f40`.
+ * @internal
+ */
+export const isIdentifier = (value: string): boolean => {
+  if (value.length < minIdentifierLength) {
+    return false;
+  }
+
+  const borderCount = getBorderCount(value);
+
+  if (borderCount > maxBorderCountOfNonIdentifier) {
+    return true;
+  }
+
+  if (
+    borderCount === maxBorderCountOfNonIdentifier &&
+    value.length <= maxIdentifierLengthForMaxBorder
+  ) {
+    return true;
+  }
+
+  if (
+    borderCount === maxBorderCountOfNonIdentifier - 1 &&
+    value.length <= maxIdentifierLengthForMaxBorder - 2
+  ) {
+    return true;
+  }
+
+  if (/^[0-9]+$/.test(value)) {
+    return true;
+  }
+
+  return false;
+};

src/utils/events/registerEndE2edRunEvent.ts

@@ -17,6 +17,7 @@ let isEndAlreadyCalled = false;
  * Registers end e2ed run event (for report) after closing of all tests.
  * @internal
  */
+// eslint-disable-next-line max-statements
 export const registerEndE2edRunEvent = async (): Promise<void> => {
   if (isEndAlreadyCalled) {
     return;
@@ -47,6 +48,7 @@ export const registerEndE2edRunEvent = async (): Promise<void> => {
     } catch (error) {
       generalLog('Caught an error on run "after pack" functions', {error});
 
+      setReadonlyProperty(liteReport, 'exitCode', ExitCode.HasErrorsInDoAfterPackFunctions);
       setReadonlyProperty(reportData, 'exitCode', ExitCode.HasErrorsInDoAfterPackFunctions);
     }