Merge pull request #114 from joomcode/fix/add-resources-to-api-statistics

feat: add API statistics to HTML report

Author: uid11

package-lock.json

@@ -28,7 +28,8 @@
     "@playwright/test": "1.51.0",
     "create-locator": "0.0.27",
     "get-modules-graph": "0.0.11",
-    "globby": "11.1.0"
+    "globby": "11.1.0",
+    "sort-json-keys": "1.0.3"
   },
   "devDependencies": {
     "@playwright/browser-chromium": "1.51.0",

package.json

@@ -22,6 +22,7 @@ export const getApiStatistics = (): ApiStatistics => {
   const apiStatistics: ApiStatistics = {
     pages: Object.create(null) as {},
     requests: Object.create(null) as {},
+    resources: Object.create(null) as {},
   };
 
   setRawApiStatistics(apiStatistics);

src/context/apiStatistics.ts

@@ -7,8 +7,15 @@ import type {Method, StatusCode, Url} from './http';
 export type ApiStatistics = Readonly<{
   pages: Readonly<Record<PageName, Readonly<Record<Url, PageStatistics>>>>;
   requests: Readonly<Record<Url, Readonly<Partial<Record<Method, RequestStatistics>>>>>;
+  resources: Readonly<Record<Url, RequestStatistics>>;
 }>;
 
+/**
+ * Hash string of menu buttons for showing parts of `ApiStatistics` in HTML report.
+ * @internal
+ */
+export type ApiStatisticsReportHash = `api-statistics-${keyof ApiStatistics}`;
+
 /**
  * Page name (as name of page class).
  */

src/types/apiStatistics.ts

@@ -9,6 +9,8 @@ export type {
   RequestStatistics,
   StatisticsUnit,
 } from './apiStatistics';
+/** @internal */
+export type {ApiStatisticsReportHash} from './apiStatistics';
 export type {Brand, IsBrand} from './brand';
 export type {Expect, IsEqual, IsReadonlyKey} from './checks';
 export type {Class} from './class';

src/types/internal.ts

@@ -116,6 +116,7 @@ export type Retry = Readonly<{
  */
 export type RetryButtonProps = Readonly<{
   disabled: boolean;
+  name: string;
   retry: number;
   selected: boolean;
 }>;

src/types/report.ts

@@ -1,20 +1,15 @@
 import {addPages} from './addPages';
 import {addRequests} from './addRequests';
+import {addResources} from './addResources';
 
 import type {ApiStatistics} from '../../types/internal';
 
 /**
- * Add additional API statistics to total API statistics.
+ * Adds additional API statistics to total API statistics.
  * @internal
  */
 export const addApiStatistics = (target: ApiStatistics, source: ApiStatistics): void => {
-  const sourceByPageName = source.pages;
-  const targetByPageName = target.pages;
-
-  addPages(targetByPageName, sourceByPageName);
-
-  const sourceByUrl = source.requests;
-  const targetByUrl = target.requests;
-
-  addRequests(targetByUrl, sourceByUrl);
+  addPages(target.pages, source.pages);
+  addRequests(target.requests, source.requests);
+  addResources(target.resources, source.resources);
 };

src/utils/apiStatistics/addApiStatistics.ts

@@ -12,16 +12,17 @@ type Options = Readonly<{
 }>;
 
 /**
- * Add single page to API statistics.
+ * Adds single page to API statistics.
  * @internal
  */
 export const addPageToApiStatistics = ({duration, pageName, url}: Options): void => {
   const apiStatistics = getApiStatistics();
-  const urlTemplate = getUrlTemplate(url);
+  const {urlTemplate} = getUrlTemplate(url);
 
   const additionalApiStatistics: ApiStatistics = {
     pages: {[pageName]: {[urlTemplate]: {count: 1, duration}}},
     requests: {},
+    resources: {},
   };
 
   addApiStatistics(apiStatistics, additionalApiStatistics);

src/utils/apiStatistics/addPageToApiStatistics.ts

@@ -4,7 +4,7 @@ import {getKeys, setReadonlyProperty} from '../object';
 import type {ApiStatistics, PageStatistics} from '../../types/internal';
 
 /**
- * Add additional pages to total API statistics pages.
+ * Adds additional pages to total API statistics pages.
  * @internal
  */
 export const addPages = (

src/utils/apiStatistics/addPages.ts

@@ -0,0 +1,30 @@
+import {assertValueIsDefined} from '../asserts';
+import {getKeys, setReadonlyProperty} from '../object';
+
+import type {RequestStatistics, StatisticsUnit} from '../../types/internal';
+
+/**
+ * Adds additional requests statistics to total API resource statistics.
+ * @internal
+ */
+export const addRequestStatistics = (
+  targetByStatusCode: RequestStatistics,
+  sourceByStatusCode: RequestStatistics,
+): void => {
+  for (const statusCode of getKeys(sourceByStatusCode)) {
+    const sourceUnit: StatisticsUnit | undefined = sourceByStatusCode[statusCode];
+
+    assertValueIsDefined(sourceUnit, 'sourceUnit is defined', {statusCode});
+
+    let targetUnit = targetByStatusCode[statusCode];
+
+    if (targetUnit === undefined) {
+      targetUnit = {count: 0, duration: 0, size: 0};
+      setReadonlyProperty(targetByStatusCode, statusCode, targetUnit);
+    }
+
+    setReadonlyProperty(targetUnit, 'count', targetUnit.count + sourceUnit.count);
+    setReadonlyProperty(targetUnit, 'duration', targetUnit.duration + sourceUnit.duration);
+    setReadonlyProperty(targetUnit, 'size', targetUnit.size + sourceUnit.size);
+  }
+};