FI-1635 feat: collect API statistics for requests

refactor: add typed `getKeys` instead of `Object.keys`

Author: uid11

src/README.md

@@ -14,15 +14,15 @@ Modules in the dependency graph should only import the modules above them:
 7. `configurator`
 8. `utils/getHash`
 9. `generators`
-10. `utils/viewport`
-11. `utils/parse`
-12. `utils/distanceBetweenSelectors`
-13. `utils/getDurationWithUnits`
-14. `utils/setReadonlyProperty`
-15. `utils/paths`
-16. `utils/valueToString`
-17. `utils/error`
-18. `utils/asserts`
+10. `utils/headers`
+11. `utils/viewport`
+12. `utils/parse`
+13. `utils/distanceBetweenSelectors`
+14. `utils/getDurationWithUnits`
+15. `utils/valueToString`
+16. `utils/error`
+17. `utils/asserts`
+18. `utils/object`
 19. `utils/uiMode`
 20. `utils/runLabel`
 21. `utils/clone`
@@ -44,10 +44,11 @@ Modules in the dependency graph should only import the modules above them:
 37. `utils/pack`
 38. `useContext`
 39. `context`
-40. `utils/selectors`
-41. `selectors`
-42. `utils/log`
-43. `utils/waitForEvents`
-44. `utils/expect`
-45. `expect`
-46. ...
+40. `utils/apiStatistics`
+41. `utils/selectors`
+42. `selectors`
+43. `utils/log`
+44. `utils/waitForEvents`
+45. `utils/expect`
+46. `expect`
+47. ...

src/actions/mock/mockApiRoute.ts

@@ -6,7 +6,7 @@ import {assertValueIsDefined} from '../../utils/asserts';
 import {setCustomInspectOnFunction} from '../../utils/fn';
 import {log} from '../../utils/log';
 import {getRequestsFilter, getSetResponse} from '../../utils/mockApiRoute';
-import {setReadonlyProperty} from '../../utils/setReadonlyProperty';
+import {setReadonlyProperty} from '../../utils/object';
 
 import type {
   ApiMockFunction,

src/actions/mock/mockWebSocketRoute.ts

@@ -6,7 +6,7 @@ import {assertValueIsDefined} from '../../utils/asserts';
 import {setCustomInspectOnFunction} from '../../utils/fn';
 import {log} from '../../utils/log';
 import {getRequestsFilter, getSetResponse} from '../../utils/mockWebSocketRoute';
-import {setReadonlyProperty} from '../../utils/setReadonlyProperty';
+import {setReadonlyProperty} from '../../utils/object';
 
 import type {
   WebSocketMockFunction,

src/actions/setHeadersAndNavigateToUrl.ts

@@ -2,8 +2,8 @@ import {AsyncLocalStorage} from 'node:async_hooks';
 
 import {LogEventType} from '../constants/internal';
 import {getPlaywrightPage} from '../useContext';
+import {applyHeadersMapper} from '../utils/headers';
 import {log} from '../utils/log';
-import {applyHeadersMapper} from '../utils/requestHooks';
 
 import {navigateToUrl} from './navigateToUrl';
 

src/actions/waitFor/waitForAllRequestsComplete.ts

@@ -6,8 +6,8 @@ import {E2edError} from '../../utils/error';
 import {setCustomInspectOnFunction} from '../../utils/fn';
 import {getDurationWithUnits} from '../../utils/getDurationWithUnits';
 import {log} from '../../utils/log';
+import {setReadonlyProperty} from '../../utils/object';
 import {getPromiseWithResolveAndReject} from '../../utils/promise';
-import {setReadonlyProperty} from '../../utils/setReadonlyProperty';
 import {
   getInitialIdsForAllRequestsCompletePredicate,
   getUrlsByRequestHookContextIds,

src/config.ts

@@ -21,7 +21,7 @@ import {assertValueIsTrue} from './utils/asserts';
 import {assertUserlandPack} from './utils/config/assertUserlandPack';
 import {getPathToPack} from './utils/environment';
 import {setCustomInspectOnFunction} from './utils/fn';
-import {setReadonlyProperty} from './utils/setReadonlyProperty';
+import {setReadonlyProperty} from './utils/object';
 import {isUiMode} from './utils/uiMode';
 import {isLocalRun} from './configurator';
 

src/constants/internal.ts

@@ -43,6 +43,7 @@ export {CREATE_PAGE_TOKEN} from './pages';
 export {
   ABSOLUTE_PATH_TO_INSTALLED_E2ED_DIRECTORY,
   ABSOLUTE_PATH_TO_PROJECT_ROOT_DIRECTORY,
+  API_STATISTICS_PATH,
   AUTOTESTS_DIRECTORY_PATH,
   COMPILED_USERLAND_CONFIG_DIRECTORY,
   CONFIG_PATH,

src/constants/paths.ts

@@ -76,11 +76,20 @@ export const TESTS_DIRECTORY_PATH = join(
 ) as DirectoryPathFromRoot;
 
 /**
- * Relative (from root) path to tmp directory.
+ * Relative (from root) path to temporary directory.
  * @internal
  */
 export const TMP_DIRECTORY_PATH = join(REPORTS_DIRECTORY_PATH, 'tmp') as DirectoryPathFromRoot;
 
+/**
+ * Relative (from root) path to file with total API statistics of run.
+ * @internal
+ */
+export const API_STATISTICS_PATH = join(
+  TMP_DIRECTORY_PATH,
+  'apiStatistics.txt',
+) as FilePathFromRoot;
+
 /**
  * Relative (from root) path to directory with compiled pack configuration files.
  * @internal

src/context/apiStatistics.ts

@@ -0,0 +1,27 @@
+import {useContext} from '../useContext';
+
+import type {ApiStatistics} from '../types/internal';
+
+/**
+ * Raw get and set internal (maybe `undefined`) API statistics.
+ * @internal
+ */
+const [getRawApiStatistics, setRawApiStatistics] = useContext<ApiStatistics>();
+
+/**
+ * Get internal always defined API statistics.
+ * @internal
+ */
+export const getApiStatistics = (): ApiStatistics => {
+  const maybeApiStatistics = getRawApiStatistics();
+
+  if (maybeApiStatistics !== undefined) {
+    return maybeApiStatistics;
+  }
+
+  const apiStatistics: ApiStatistics = {requests: Object.create(null) as {}};
+
+  setRawApiStatistics(apiStatistics);
+
+  return apiStatistics;
+};

src/types/apiStatistics.ts

@@ -0,0 +1,18 @@
+import type {Method, StatusCode, Url} from './http';
+
+/**
+ * API statistics of `e2ed` run.
+ */
+export type ApiStatistics = Readonly<{
+  requests: Readonly<Record<Url, Readonly<Partial<Record<Method, RequestStatistics>>>>>;
+}>;
+
+/**
+ * Statistics of one API request (by `origin`).
+ */
+export type RequestStatistics = Readonly<Partial<Record<StatusCode, StatisticsUnit>>>;
+
+/**
+ * Unit of summary statistics for some exact conditions.
+ */
+export type StatisticsUnit = Readonly<{count: number; duration: number; size: number}>;