@antelopejs/dms-api 0.1.7 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (346) hide show
  1. package/README.md +99 -8
  2. package/dist/automation/get-api-health.js +4 -3
  3. package/dist/automation/get-api-health.js.map +1 -1
  4. package/dist/automation/route-unhealthy.js +2 -2
  5. package/dist/automation/route-unhealthy.js.map +1 -1
  6. package/dist/automation/scope.d.ts +0 -1
  7. package/dist/automation/scope.js +0 -7
  8. package/dist/automation/scope.js.map +1 -1
  9. package/dist/config.d.ts +4 -0
  10. package/dist/config.js +15 -9
  11. package/dist/config.js.map +1 -1
  12. package/dist/db/models/request_log.model.d.ts +37 -2
  13. package/dist/db/models/request_log.model.js +130 -35
  14. package/dist/db/models/request_log.model.js.map +1 -1
  15. package/dist/db/models/request_log.search.d.ts +5 -0
  16. package/dist/db/models/request_log.search.js +35 -0
  17. package/dist/db/models/request_log.search.js.map +1 -0
  18. package/dist/db/models/request_log.status.d.ts +5 -0
  19. package/dist/db/models/request_log.status.js +9 -0
  20. package/dist/db/models/request_log.status.js.map +1 -0
  21. package/dist/db/models/routes.model.d.ts +1 -0
  22. package/dist/db/models/routes.model.js +5 -1
  23. package/dist/db/models/routes.model.js.map +1 -1
  24. package/dist/db/models/routes_statistics.model.js +1 -1
  25. package/dist/db/models/routes_statistics.model.js.map +1 -1
  26. package/dist/db/tables/api_settings.table.d.ts +1 -0
  27. package/dist/db/tables/api_settings.table.js +4 -0
  28. package/dist/db/tables/api_settings.table.js.map +1 -1
  29. package/dist/db/tables/request_log.table.d.ts +18 -3
  30. package/dist/db/tables/request_log.table.js +34 -1
  31. package/dist/db/tables/request_log.table.js.map +1 -1
  32. package/dist/db/tables/routes.table.d.ts +1 -2
  33. package/dist/db/tables/routes.table.js.map +1 -1
  34. package/dist/db/tables/routes_statistics.table.d.ts +4 -3
  35. package/dist/db/tables/routes_statistics.table.js +5 -1
  36. package/dist/db/tables/routes_statistics.table.js.map +1 -1
  37. package/dist/index.d.ts +1 -1
  38. package/dist/index.js +9 -1
  39. package/dist/index.js.map +1 -1
  40. package/dist/memo.d.ts +5 -0
  41. package/dist/memo.js +36 -0
  42. package/dist/memo.js.map +1 -0
  43. package/dist/pages/blocks.d.ts +3 -0
  44. package/dist/pages/blocks.js +31 -0
  45. package/dist/pages/blocks.js.map +1 -0
  46. package/dist/pages/displays.d.ts +7 -0
  47. package/dist/pages/displays.js +23 -0
  48. package/dist/pages/displays.js.map +1 -0
  49. package/dist/pages/index.d.ts +5 -2
  50. package/dist/pages/index.js +5 -2
  51. package/dist/pages/index.js.map +1 -1
  52. package/dist/pages/logs.d.ts +18 -0
  53. package/dist/pages/logs.js +112 -0
  54. package/dist/pages/logs.js.map +1 -0
  55. package/dist/pages/module.d.ts +3 -0
  56. package/dist/pages/module.js +102 -6
  57. package/dist/pages/module.js.map +1 -1
  58. package/dist/pages/overview.d.ts +14 -0
  59. package/dist/pages/overview.js +215 -0
  60. package/dist/pages/overview.js.map +1 -0
  61. package/dist/pages/period.d.ts +9 -0
  62. package/dist/pages/period.js +24 -0
  63. package/dist/pages/period.js.map +1 -0
  64. package/dist/pages/request-table.d.ts +11 -0
  65. package/dist/pages/request-table.js +187 -0
  66. package/dist/pages/request-table.js.map +1 -0
  67. package/dist/pages/routes.d.ts +15 -0
  68. package/dist/pages/routes.js +269 -0
  69. package/dist/pages/routes.js.map +1 -0
  70. package/dist/pages/scope-chip.d.ts +9 -0
  71. package/dist/pages/scope-chip.js +28 -0
  72. package/dist/pages/scope-chip.js.map +1 -0
  73. package/dist/pages/{logs/page.d.ts → settings.d.ts} +3 -3
  74. package/dist/pages/settings.js +218 -0
  75. package/dist/pages/settings.js.map +1 -0
  76. package/dist/pages/toolbar.d.ts +9 -0
  77. package/dist/pages/toolbar.js +33 -0
  78. package/dist/pages/toolbar.js.map +1 -0
  79. package/dist/realtime.d.ts +2 -0
  80. package/dist/realtime.js +21 -0
  81. package/dist/realtime.js.map +1 -0
  82. package/dist/routes/index.d.ts +2 -2
  83. package/dist/routes/index.js +2 -2
  84. package/dist/routes/index.js.map +1 -1
  85. package/dist/routes/logs.d.ts +173 -2
  86. package/dist/routes/logs.js +177 -86
  87. package/dist/routes/logs.js.map +1 -1
  88. package/dist/routes/overview.d.ts +27 -0
  89. package/dist/routes/overview.js +131 -0
  90. package/dist/routes/overview.js.map +1 -0
  91. package/dist/routes/routes.d.ts +92 -28
  92. package/dist/routes/routes.js +165 -97
  93. package/dist/routes/routes.js.map +1 -1
  94. package/dist/routes/settings.d.ts +16 -11
  95. package/dist/routes/settings.js +62 -54
  96. package/dist/routes/settings.js.map +1 -1
  97. package/dist/routes/tester.d.ts +7 -0
  98. package/dist/routes/tester.js +34 -0
  99. package/dist/routes/tester.js.map +1 -0
  100. package/dist/services/activity.d.ts +49 -0
  101. package/dist/services/activity.js +207 -0
  102. package/dist/services/activity.js.map +1 -0
  103. package/dist/services/aggregate-cache.d.ts +3 -0
  104. package/dist/services/aggregate-cache.js +16 -0
  105. package/dist/services/aggregate-cache.js.map +1 -0
  106. package/dist/services/api-origin.d.ts +1 -0
  107. package/dist/services/api-origin.js +9 -0
  108. package/dist/services/api-origin.js.map +1 -0
  109. package/dist/services/attention.d.ts +45 -0
  110. package/dist/services/attention.js +203 -0
  111. package/dist/services/attention.js.map +1 -0
  112. package/dist/services/composed-text.d.ts +6 -0
  113. package/dist/services/composed-text.js +23 -0
  114. package/dist/services/composed-text.js.map +1 -0
  115. package/dist/services/health-rules.d.ts +49 -0
  116. package/dist/services/health-rules.js +233 -0
  117. package/dist/services/health-rules.js.map +1 -0
  118. package/dist/services/index.d.ts +1 -3
  119. package/dist/services/index.js +3 -3
  120. package/dist/services/index.js.map +1 -1
  121. package/dist/services/introspection/decorators.d.ts +14 -0
  122. package/dist/services/introspection/decorators.js +192 -0
  123. package/dist/services/introspection/decorators.js.map +1 -0
  124. package/dist/services/introspection/errors.js +4 -4
  125. package/dist/services/introspection/errors.js.map +1 -1
  126. package/dist/services/introspection/index.d.ts +6 -8
  127. package/dist/services/introspection/index.js +96 -32
  128. package/dist/services/introspection/index.js.map +1 -1
  129. package/dist/services/introspection/probe.d.ts +2 -1
  130. package/dist/services/introspection/probe.js +11 -0
  131. package/dist/services/introspection/probe.js.map +1 -1
  132. package/dist/services/links.d.ts +25 -0
  133. package/dist/services/links.js +72 -0
  134. package/dist/services/links.js.map +1 -0
  135. package/dist/services/live-feed.d.ts +6 -0
  136. package/dist/services/live-feed.js +18 -0
  137. package/dist/services/live-feed.js.map +1 -0
  138. package/dist/services/live.d.ts +16 -0
  139. package/dist/services/live.js +32 -0
  140. package/dist/services/live.js.map +1 -0
  141. package/dist/services/overview.d.ts +122 -0
  142. package/dist/services/overview.js +324 -0
  143. package/dist/services/overview.js.map +1 -0
  144. package/dist/services/period.d.ts +0 -9
  145. package/dist/services/period.js +5 -52
  146. package/dist/services/period.js.map +1 -1
  147. package/dist/services/request-log/access.d.ts +5 -0
  148. package/dist/services/request-log/access.js +21 -0
  149. package/dist/services/request-log/access.js.map +1 -0
  150. package/dist/services/request-log/capture.d.ts +30 -0
  151. package/dist/services/request-log/capture.js +216 -39
  152. package/dist/services/request-log/capture.js.map +1 -1
  153. package/dist/services/request-log/list.d.ts +36 -0
  154. package/dist/services/request-log/list.js +201 -0
  155. package/dist/services/request-log/list.js.map +1 -0
  156. package/dist/services/request-log/read.d.ts +15 -2
  157. package/dist/services/request-log/read.js +47 -4
  158. package/dist/services/request-log/read.js.map +1 -1
  159. package/dist/services/request-log/redaction.d.ts +16 -3
  160. package/dist/services/request-log/redaction.js +149 -27
  161. package/dist/services/request-log/redaction.js.map +1 -1
  162. package/dist/services/request-log/util.d.ts +10 -3
  163. package/dist/services/request-log/util.js +39 -22
  164. package/dist/services/request-log/util.js.map +1 -1
  165. package/dist/services/route-catalog.d.ts +62 -0
  166. package/dist/services/route-catalog.js +163 -0
  167. package/dist/services/route-catalog.js.map +1 -0
  168. package/dist/services/route-contract.d.ts +66 -0
  169. package/dist/services/route-contract.js +266 -0
  170. package/dist/services/route-contract.js.map +1 -0
  171. package/dist/services/route-health.d.ts +35 -0
  172. package/dist/services/route-health.js +179 -0
  173. package/dist/services/route-health.js.map +1 -0
  174. package/dist/services/route-statistics.d.ts +68 -0
  175. package/dist/services/route-statistics.js +277 -0
  176. package/dist/services/route-statistics.js.map +1 -0
  177. package/dist/services/routes-sync.d.ts +7 -3
  178. package/dist/services/routes-sync.js +96 -20
  179. package/dist/services/routes-sync.js.map +1 -1
  180. package/dist/services/scope.d.ts +0 -1
  181. package/dist/services/scope.js +4 -17
  182. package/dist/services/scope.js.map +1 -1
  183. package/dist/services/settings-form.d.ts +131 -0
  184. package/dist/services/settings-form.js +210 -0
  185. package/dist/services/settings-form.js.map +1 -0
  186. package/dist/services/settings.d.ts +2 -0
  187. package/dist/services/settings.js +5 -0
  188. package/dist/services/settings.js.map +1 -1
  189. package/dist/services/statistics-aggregate.d.ts +6 -41
  190. package/dist/services/statistics-aggregate.js +55 -280
  191. package/dist/services/statistics-aggregate.js.map +1 -1
  192. package/dist/services/statistics-utils.d.ts +7 -12
  193. package/dist/services/statistics-utils.js +36 -51
  194. package/dist/services/statistics-utils.js.map +1 -1
  195. package/dist/services/statistics-write.js +64 -22
  196. package/dist/services/statistics-write.js.map +1 -1
  197. package/dist/services/tester-source.d.ts +11 -0
  198. package/dist/services/tester-source.js +48 -0
  199. package/dist/services/tester-source.js.map +1 -0
  200. package/dist/services/traffic-samples.d.ts +18 -0
  201. package/dist/services/traffic-samples.js +134 -0
  202. package/dist/services/traffic-samples.js.map +1 -0
  203. package/dist/services/traffic.d.ts +43 -0
  204. package/dist/services/traffic.js +270 -0
  205. package/dist/services/traffic.js.map +1 -0
  206. package/dist/services/window.d.ts +48 -0
  207. package/dist/services/window.js +179 -0
  208. package/dist/services/window.js.map +1 -0
  209. package/dist/types/constants.d.ts +11 -20
  210. package/dist/types/constants.js +15 -25
  211. package/dist/types/constants.js.map +1 -1
  212. package/dist/types/index.d.ts +0 -1
  213. package/dist/types/index.js +0 -1
  214. package/dist/types/index.js.map +1 -1
  215. package/dist/types/statistics.d.ts +5 -3
  216. package/dist/types/statistics.js +5 -0
  217. package/dist/types/statistics.js.map +1 -1
  218. package/frontend-vue/app/components/blocks/BetaBadge.vue +20 -0
  219. package/frontend-vue/app/components/blocks/HealthHero.vue +708 -0
  220. package/frontend-vue/app/components/blocks/LiveTraffic.vue +356 -0
  221. package/frontend-vue/app/components/blocks/LogsEmptyState.vue +228 -0
  222. package/frontend-vue/app/components/blocks/LogsFilters.vue +279 -0
  223. package/frontend-vue/app/components/blocks/RequestDetail.vue +722 -0
  224. package/frontend-vue/app/components/blocks/RetentionInput.vue +227 -0
  225. package/frontend-vue/app/components/blocks/RouteDocumentation.vue +611 -0
  226. package/frontend-vue/app/components/blocks/RouteHeader.vue +320 -0
  227. package/frontend-vue/app/components/blocks/RouteTester.vue +1879 -0
  228. package/frontend-vue/app/components/blocks/RouteTree.vue +676 -0
  229. package/frontend-vue/app/components/blocks/ScopeChip.vue +89 -0
  230. package/frontend-vue/app/components/blocks/SettingNumberInput.vue +65 -0
  231. package/frontend-vue/app/components/blocks/SplitLayout.vue +41 -0
  232. package/frontend-vue/app/components/internal/ApiBody.vue +129 -0
  233. package/frontend-vue/app/components/internal/ApiJsonTree.vue +82 -0
  234. package/frontend-vue/app/components/internal/ApiKeyValues.vue +41 -0
  235. package/frontend-vue/app/components/internal/ApiMethodBadge.vue +19 -19
  236. package/frontend-vue/app/components/internal/ApiPath.vue +33 -0
  237. package/frontend-vue/app/components/internal/ApiStatusBadge.vue +20 -15
  238. package/frontend-vue/app/components/internal/ApiTesterBadge.vue +17 -0
  239. package/frontend-vue/app/composables/useApiOrigin.ts +19 -0
  240. package/frontend-vue/app/composables/useApiPeriod.ts +19 -0
  241. package/frontend-vue/app/composables/useApiResource.ts +92 -0
  242. package/frontend-vue/app/composables/useDateFormat.ts +23 -0
  243. package/frontend-vue/app/composables/useLiveMissedErrors.ts +33 -0
  244. package/frontend-vue/app/composables/useRouteDetail.ts +253 -0
  245. package/frontend-vue/app/composables/useRouteSelection.ts +43 -0
  246. package/frontend-vue/app/config/shortcuts-registry.ts +30 -0
  247. package/frontend-vue/app/plugins/displays.ts +92 -0
  248. package/frontend-vue/app/utils/format.ts +281 -0
  249. package/frontend-vue/app/utils/http.ts +127 -0
  250. package/frontend-vue/app/utils/logsQuery.ts +261 -0
  251. package/frontend-vue/app/utils/minuteHistogram.ts +116 -0
  252. package/frontend-vue/app/utils/requestDrawer.ts +257 -0
  253. package/frontend-vue/app/utils/routeExplorer.ts +206 -0
  254. package/frontend-vue/app/utils/search.ts +45 -0
  255. package/frontend-vue/app/utils/settingsForm.ts +119 -0
  256. package/frontend-vue/app/utils/snippets.ts +501 -0
  257. package/frontend-vue/app/utils/testerHistory.ts +354 -0
  258. package/frontend-vue/app/utils/testerRequest.ts +632 -11
  259. package/frontend-vue/dms.frontend.build.ts +7 -0
  260. package/frontend-vue/dms.frontend.ts +10 -3
  261. package/frontend-vue/i18n/locales/api-en-GB.json +866 -0
  262. package/frontend-vue/i18n/locales/api-fr-FR.json +866 -0
  263. package/frontend-vue/package.json +2 -6
  264. package/frontend-vue/pnpm-lock.yaml +97 -3375
  265. package/frontend-vue/tests/format.test.ts +180 -0
  266. package/frontend-vue/tests/http.test.ts +61 -0
  267. package/frontend-vue/tests/logsQuery.test.ts +255 -0
  268. package/frontend-vue/tests/minuteHistogram.test.ts +94 -0
  269. package/frontend-vue/tests/registration.test.ts +24 -7
  270. package/frontend-vue/tests/requestDrawer.test.ts +179 -0
  271. package/frontend-vue/tests/routeExplorer.test.ts +206 -0
  272. package/frontend-vue/tests/settingsForm.test.ts +155 -0
  273. package/frontend-vue/tests/snippets.test.ts +285 -0
  274. package/frontend-vue/tests/testerHistory.test.ts +295 -0
  275. package/frontend-vue/tests/testerRequest.test.ts +471 -76
  276. package/package.json +9 -9
  277. package/dist/middlewares/index.d.ts +0 -1
  278. package/dist/middlewares/index.js +0 -18
  279. package/dist/middlewares/index.js.map +0 -1
  280. package/dist/middlewares/request-log-capture.d.ts +0 -1
  281. package/dist/middlewares/request-log-capture.js +0 -6
  282. package/dist/middlewares/request-log-capture.js.map +0 -1
  283. package/dist/pages/all.d.ts +0 -4
  284. package/dist/pages/all.js +0 -21
  285. package/dist/pages/all.js.map +0 -1
  286. package/dist/pages/logs/page.js +0 -29
  287. package/dist/pages/logs/page.js.map +0 -1
  288. package/dist/pages/routes/page.d.ts +0 -9
  289. package/dist/pages/routes/page.js +0 -29
  290. package/dist/pages/routes/page.js.map +0 -1
  291. package/dist/pages/settings/form.d.ts +0 -3
  292. package/dist/pages/settings/form.js +0 -80
  293. package/dist/pages/settings/form.js.map +0 -1
  294. package/dist/pages/settings/page.d.ts +0 -9
  295. package/dist/pages/settings/page.js +0 -26
  296. package/dist/pages/settings/page.js.map +0 -1
  297. package/dist/pages/summary/page.d.ts +0 -9
  298. package/dist/pages/summary/page.js +0 -29
  299. package/dist/pages/summary/page.js.map +0 -1
  300. package/dist/routes/monitoring.d.ts +0 -17
  301. package/dist/routes/monitoring.js +0 -101
  302. package/dist/routes/monitoring.js.map +0 -1
  303. package/dist/routes/summary.d.ts +0 -32
  304. package/dist/routes/summary.js +0 -181
  305. package/dist/routes/summary.js.map +0 -1
  306. package/dist/services/request-log/index.d.ts +0 -3
  307. package/dist/services/request-log/index.js +0 -12
  308. package/dist/services/request-log/index.js.map +0 -1
  309. package/dist/services/statistics-read.d.ts +0 -4
  310. package/dist/services/statistics-read.js +0 -48
  311. package/dist/services/statistics-read.js.map +0 -1
  312. package/dist/services/tree.d.ts +0 -10
  313. package/dist/services/tree.js +0 -128
  314. package/dist/services/tree.js.map +0 -1
  315. package/dist/types/charts.d.ts +0 -9
  316. package/dist/types/charts.js +0 -3
  317. package/dist/types/charts.js.map +0 -1
  318. package/frontend-vue/app/components/ConfigurationView.vue +0 -187
  319. package/frontend-vue/app/components/DocumentationView.vue +0 -224
  320. package/frontend-vue/app/components/LogDetailDrawer.vue +0 -178
  321. package/frontend-vue/app/components/LogsView.vue +0 -347
  322. package/frontend-vue/app/components/RouteDetailTabs.vue +0 -179
  323. package/frontend-vue/app/components/RouteTree.vue +0 -196
  324. package/frontend-vue/app/components/RoutesView.vue +0 -79
  325. package/frontend-vue/app/components/StatsView.vue +0 -268
  326. package/frontend-vue/app/components/SummaryView.vue +0 -657
  327. package/frontend-vue/app/components/TesterPanel.vue +0 -499
  328. package/frontend-vue/app/components/internal/PeriodSelect.vue +0 -58
  329. package/frontend-vue/app/components/internal/RouteTreeNode.vue +0 -168
  330. package/frontend-vue/app/components/internal/StatusBreakdownBars.vue +0 -162
  331. package/frontend-vue/app/components/internal/StatusDonut.vue +0 -84
  332. package/frontend-vue/app/components/internal/UnitAreaChart.vue +0 -73
  333. package/frontend-vue/app/composables/useApiIntrospection.ts +0 -350
  334. package/frontend-vue/app/composables/useLogDetailDrawer.ts +0 -50
  335. package/frontend-vue/app/composables/useSelectedPeriod.ts +0 -107
  336. package/frontend-vue/app/composables/useStatsPeriods.ts +0 -139
  337. package/frontend-vue/app/custom-layouts/.gitkeep +0 -0
  338. package/frontend-vue/app/custom-pages/.gitkeep +0 -0
  339. package/frontend-vue/app/utils/httpMethod.ts +0 -49
  340. package/frontend-vue/app/utils/statusClass.ts +0 -49
  341. package/frontend-vue/i18n/locales/en-GB.json +0 -240
  342. package/frontend-vue/i18n/locales/fr-FR.json +0 -240
  343. package/frontend-vue/public/.gitkeep +0 -0
  344. package/frontend-vue/server/.gitkeep +0 -0
  345. package/frontend-vue/tests/periods.test.ts +0 -145
  346. package/frontend-vue/tests/persistence.test.ts +0 -45
@@ -0,0 +1,179 @@
1
+ import { describe, expect, it } from 'vitest'
2
+ import {
3
+ bodyOmission,
4
+ durationScale,
5
+ isRequestId,
6
+ originalBodySize,
7
+ requestClock,
8
+ requestPivots,
9
+ requestUrl,
10
+ thresholdRatio,
11
+ withParam,
12
+ } from '../app/utils/requestDrawer'
13
+ import { cachedDateFormat } from '../app/utils/format'
14
+
15
+ const formatIn = (locale: string) =>
16
+ cachedDateFormat((options) => new Intl.DateTimeFormat(locale, options))
17
+
18
+ describe('reading a request', () => {
19
+ it('names the URL a request went to', () => {
20
+ expect(
21
+ requestUrl('https://api.test', '/orders', { status: ['a', 'b'], q: 'é' }),
22
+ ).toBe('https://api.test/orders?status=a&status=b&q=%C3%A9')
23
+ expect(requestUrl('', '/orders', undefined)).toBe('/orders')
24
+ })
25
+
26
+ it('writes the day only once it is not today', () => {
27
+ const now = new Date(2026, 9, 10, 18, 0, 0)
28
+ expect(
29
+ requestClock(
30
+ new Date(2026, 9, 10, 17, 2, 28),
31
+ formatIn('en-GB'),
32
+ false,
33
+ now,
34
+ ),
35
+ ).toBe('17:02:28')
36
+ expect(
37
+ requestClock(
38
+ new Date(2026, 9, 9, 23, 42, 10),
39
+ formatIn('en-GB'),
40
+ false,
41
+ now,
42
+ ),
43
+ ).toBe('Yesterday, 23:42:10')
44
+ expect(
45
+ requestClock(
46
+ new Date(2026, 9, 9, 23, 42, 10),
47
+ formatIn('fr-FR'),
48
+ false,
49
+ now,
50
+ ),
51
+ ).toBe('Hier, 23:42:10')
52
+ expect(
53
+ requestClock(
54
+ new Date(2026, 9, 8, 12, 0, 0),
55
+ formatIn('en-GB'),
56
+ false,
57
+ now,
58
+ ),
59
+ ).toBe('8 Oct, 12:00:00')
60
+ })
61
+
62
+ it('scales a duration against the slow threshold', () => {
63
+ expect(durationScale(500, 1000)).toEqual({
64
+ share: 25,
65
+ threshold: 50,
66
+ ratio: 0.5,
67
+ slow: false,
68
+ max: 2000,
69
+ })
70
+ const slow = durationScale(6886, 1000)
71
+ expect(slow.slow).toBe(true)
72
+ expect(slow.share).toBe(100)
73
+ expect(slow.threshold).toBeCloseTo(14.5, 1)
74
+ expect(slow.ratio).toBeCloseTo(6.886)
75
+ expect(durationScale(1010, 1000).share).toBeCloseTo(50.5)
76
+ })
77
+
78
+ it('knows why a body is missing and how big it was', () => {
79
+ expect(bodyOmission('too-large')).toBe('too-large')
80
+ expect(bodyOmission('something')).toBeNull()
81
+ expect(bodyOmission(null)).toBeNull()
82
+ expect(originalBodySize(65_536, true, 184_051, {})).toBe(184_051)
83
+ expect(
84
+ originalBodySize(65_536, true, undefined, { 'Content-Length': '184051' }),
85
+ ).toBe(184_051)
86
+ expect(
87
+ originalBodySize(11, true, undefined, { 'content-length': '11' }),
88
+ ).toBeUndefined()
89
+ })
90
+
91
+ it('compares a whole body to nothing: masking changed its length only', () => {
92
+ // 5 values masked: 249 bytes stored of the 260 sent, nothing cut.
93
+ expect(
94
+ originalBodySize(249, false, null, { 'content-length': '260' }),
95
+ ).toBeUndefined()
96
+ expect(originalBodySize(249, undefined, 260, {})).toBeUndefined()
97
+ })
98
+
99
+ it('writes a ratio to the threshold that never reads as zero', () => {
100
+ expect(thresholdRatio(2.189, 'en-GB')).toBe('2.2')
101
+ expect(thresholdRatio(0.4, 'fr-FR')).toBe('0,4')
102
+ expect(thresholdRatio(0.036, 'en-GB')).toBe('< 0.1')
103
+ expect(thresholdRatio(0.036, 'fr-FR')).toBe('< 0,1')
104
+ expect(thresholdRatio(0, 'en-GB')).toBe('< 0.1')
105
+ })
106
+
107
+ it('names a body never read by a handler', () => {
108
+ expect(bodyOmission('not-read')).toBe('not-read')
109
+ })
110
+
111
+ it('tells a request id from what a link may hold', () => {
112
+ expect(isRequestId('0359c490-1b2c-4d5e-8f90-123456789abc')).toBe(true)
113
+ expect(isRequestId('<script>/../settings')).toBe(false)
114
+ })
115
+
116
+ describe('the lists a request leads to', () => {
117
+ const log = {
118
+ rawPath: '/api/orders',
119
+ routeRegistered: true,
120
+ responseTimeMs: 36,
121
+ slowThresholdMs: 1000,
122
+ links: { sameRoute: '/modules/api/logs?route=POST+%2Fapi%2Forders' },
123
+ }
124
+
125
+ it('leads a request no route matched to its path, not to an empty route list', () => {
126
+ expect(
127
+ requestPivots({
128
+ ...log,
129
+ rawPath: '/nope/qa-rd-notread',
130
+ routeRegistered: false,
131
+ responseTimeMs: null,
132
+ links: {
133
+ sameRoute: '/modules/api/logs?route=POST+%2Fnope%2Fqa-rd-notread',
134
+ samePath: '/modules/api/logs?path=%2Fnope%2Fqa-rd-notread',
135
+ },
136
+ }),
137
+ ).toEqual([
138
+ {
139
+ kind: 'same_path',
140
+ to: '/modules/api/logs?path=%2Fnope%2Fqa-rd-notread',
141
+ },
142
+ ])
143
+ })
144
+
145
+ it('offers slow requests once the route has some', () => {
146
+ const kinds = (value: Parameters<typeof requestPivots>[0]) =>
147
+ requestPivots(value).map((pivot) => pivot.kind)
148
+ const latency = { windowDays: 7, p50: 40, p95: 900 }
149
+ // Without the route's figures: the request itself tells.
150
+ expect(kinds(log)).toEqual(['same_route'])
151
+ expect(kinds({ ...log, responseTimeMs: 2189 })).toEqual([
152
+ 'same_route',
153
+ 'slow_route',
154
+ ])
155
+ expect(kinds({ ...log, routeLatency: { ...latency, slow: 0 } })).toEqual([
156
+ 'same_route',
157
+ ])
158
+ expect(
159
+ requestPivots({ ...log, routeLatency: { ...latency, slow: 3 } })[1],
160
+ ).toEqual({
161
+ kind: 'slow_route',
162
+ to: '/modules/api/logs?route=POST+%2Fapi%2Forders&slow=true',
163
+ })
164
+ expect(
165
+ kinds({
166
+ ...log,
167
+ rawPath: '/api/orders/42',
168
+ links: { ...log.links, samePath: '/modules/api/logs?path=x' },
169
+ }),
170
+ ).toEqual(['same_route', 'same_path'])
171
+ })
172
+ })
173
+
174
+ it('adds a parameter to a link', () => {
175
+ expect(
176
+ withParam('/modules/api/logs?route=GET+%2Forders', 'slow', 'true'),
177
+ ).toBe('/modules/api/logs?route=GET+%2Forders&slow=true')
178
+ })
179
+ })
@@ -0,0 +1,206 @@
1
+ import { beforeEach, describe, expect, it } from 'vitest'
2
+ import {
3
+ bySeverity,
4
+ type ExplorerRoute,
5
+ groupRoutes,
6
+ initialRoute,
7
+ lastRoute,
8
+ listedFolders,
9
+ listedMessages,
10
+ needsAttention,
11
+ optionId,
12
+ rememberRoute,
13
+ type RouteState,
14
+ stepFrom,
15
+ windowParts,
16
+ } from '../app/utils/routeExplorer'
17
+
18
+ function route(
19
+ method: string,
20
+ path: string,
21
+ folder: string,
22
+ state: RouteState = 'healthy',
23
+ requests = 10,
24
+ ): ExplorerRoute {
25
+ return { ref: `${method} ${path}`, method, path, folder, state, requests }
26
+ }
27
+
28
+ const ROUTES = [
29
+ route('GET', '/api/orders', '/api/orders'),
30
+ route('POST', '/api/orders', '/api/orders', 'failing', 40),
31
+ route('GET', '/api/orders/:id', '/api/orders', 'client-errors', 90),
32
+ route('POST', '/auth/2fa/verify', '/auth/2fa', 'slow', 5),
33
+ route('POST', '/auth/login', '/auth/login', 'idle', 0),
34
+ route('GET', '/auth/me', '/auth/me', 'recovered', 3),
35
+ route('GET', '/health', '/health'),
36
+ ]
37
+
38
+ describe('route list', () => {
39
+ it('folds a folder of a single route into its first segment', () => {
40
+ const folders = listedFolders(ROUTES)
41
+ expect(folders.get('POST /auth/2fa/verify')).toBe('/auth')
42
+ expect(folders.get('POST /auth/login')).toBe('/auth')
43
+ expect(folders.get('GET /api/orders/:id')).toBe('/api/orders')
44
+ // A top-level folder has nowhere to fold into.
45
+ expect(folders.get('GET /health')).toBe('/health')
46
+ })
47
+
48
+ it('groups by listed folder, folders and routes by path', () => {
49
+ const groups = groupRoutes(ROUTES, listedFolders(ROUTES))
50
+ expect(groups.map((group) => group.path)).toEqual([
51
+ '/api/orders',
52
+ '/auth',
53
+ '/health',
54
+ ])
55
+ expect(groups[1]!.routes.map((entry) => entry.ref)).toEqual([
56
+ 'POST /auth/2fa/verify',
57
+ 'POST /auth/login',
58
+ 'GET /auth/me',
59
+ ])
60
+ expect(groups[0]!.worst).toBe('failing')
61
+ expect(groups[1]!.worst).toBe('slow')
62
+ expect(groups[2]!.worst).toBe('healthy')
63
+ })
64
+
65
+ it('keeps a route in its folder whatever the filter', () => {
66
+ const folders = listedFolders(ROUTES)
67
+ const groups = groupRoutes(
68
+ ROUTES.filter((entry) => entry.ref === 'POST /auth/login'),
69
+ folders,
70
+ )
71
+ expect(groups.map((group) => group.path)).toEqual(['/auth'])
72
+ })
73
+
74
+ it('lists the routes the Overview says need attention', () => {
75
+ expect(ROUTES.filter(needsAttention).map((entry) => entry.state)).toEqual([
76
+ 'failing',
77
+ 'client-errors',
78
+ 'slow',
79
+ 'recovered',
80
+ ])
81
+ })
82
+
83
+ it('sorts worst first, then by traffic', () => {
84
+ const sorted = bySeverity([
85
+ route('GET', '/a', '/a', 'slow', 1),
86
+ route('GET', '/b', '/b', 'failing', 2),
87
+ route('GET', '/c', '/c', 'failing', 50),
88
+ route('GET', '/d', '/d', 'client-errors', 9),
89
+ route('GET', '/e', '/e', 'recovered', 9),
90
+ route('GET', '/f', '/f', 'idle', 0),
91
+ ])
92
+ expect(sorted.map((entry) => entry.path)).toEqual([
93
+ '/c',
94
+ '/b',
95
+ '/a',
96
+ '/d',
97
+ '/e',
98
+ '/f',
99
+ ])
100
+ })
101
+ })
102
+
103
+ describe('keyboard', () => {
104
+ const items = ROUTES.slice(0, 3)
105
+
106
+ it('steps from the route last asked for', () => {
107
+ expect(stepFrom(items, 'GET /api/orders', 1)?.ref).toBe('POST /api/orders')
108
+ expect(stepFrom(items, 'POST /api/orders', 1)?.ref).toBe(
109
+ 'GET /api/orders/:id',
110
+ )
111
+ })
112
+
113
+ it('stops at both ends', () => {
114
+ expect(stepFrom(items, 'GET /api/orders/:id', 1)?.ref).toBe(
115
+ 'GET /api/orders/:id',
116
+ )
117
+ expect(stepFrom(items, 'GET /api/orders', -1)?.ref).toBe('GET /api/orders')
118
+ expect(stepFrom(items, 'POST /api/orders', -items.length)?.ref).toBe(
119
+ 'GET /api/orders',
120
+ )
121
+ })
122
+
123
+ it('enters the list from either end when nothing listed is active', () => {
124
+ expect(stepFrom(items, null, 1)?.ref).toBe('GET /api/orders')
125
+ expect(stepFrom(items, 'GET /elsewhere', -1)?.ref).toBe(
126
+ 'GET /api/orders/:id',
127
+ )
128
+ expect(stepFrom([], null, 1)).toBeUndefined()
129
+ })
130
+
131
+ it('names options with ids an aria reference can hold', () => {
132
+ expect(optionId(12)).toBe('api-route-option-12')
133
+ })
134
+ })
135
+
136
+ describe('opening the page', () => {
137
+ it('reopens the last route looked at while it is listed', () => {
138
+ expect(initialRoute(ROUTES, 'GET /health')?.ref).toBe('GET /health')
139
+ })
140
+
141
+ it('falls back to the route needing a look first', () => {
142
+ expect(initialRoute(ROUTES, 'GET /gone')?.ref).toBe('POST /api/orders')
143
+ expect(initialRoute(ROUTES, null)?.ref).toBe('POST /api/orders')
144
+ })
145
+
146
+ describe('memory of the last route', () => {
147
+ const store = new Map<string, string>()
148
+ beforeEach(() => {
149
+ store.clear()
150
+ Object.assign(globalThis, {
151
+ window: {
152
+ sessionStorage: {
153
+ getItem: (key: string) => store.get(key) ?? null,
154
+ setItem: (key: string, value: string) => store.set(key, value),
155
+ },
156
+ },
157
+ })
158
+ })
159
+
160
+ it('keeps the last route for the tab', () => {
161
+ expect(lastRoute()).toBeNull()
162
+ rememberRoute('GET /health')
163
+ expect(lastRoute()).toBe('GET /health')
164
+ })
165
+
166
+ it('does without when storage is blocked', () => {
167
+ Object.assign(globalThis, {
168
+ window: {
169
+ get sessionStorage(): Storage {
170
+ throw new Error('blocked')
171
+ },
172
+ },
173
+ })
174
+ expect(() => rememberRoute('GET /health')).not.toThrow()
175
+ expect(lastRoute()).toBeNull()
176
+ })
177
+ })
178
+ })
179
+
180
+ describe('periods', () => {
181
+ it('writes a health window in its largest whole unit', () => {
182
+ expect(windowParts(15)).toEqual({ unit: 'min', amount: 15 })
183
+ expect(windowParts(90)).toEqual({ unit: 'min', amount: 90 })
184
+ expect(windowParts(60)).toEqual({ unit: 'h', amount: 1 })
185
+ expect(windowParts(1440)).toEqual({ unit: 'h', amount: 24 })
186
+ expect(windowParts(10080)).toEqual({ unit: 'd', amount: 7 })
187
+ })
188
+ })
189
+
190
+ describe('listedMessages', () => {
191
+ it('lists each message with its own count and counts the ones left out', () => {
192
+ const messages = [
193
+ { message: 'Order 10311 not found', count: 97 },
194
+ { message: 'Order 10312 not found', count: 80 },
195
+ { message: 'Order 10313 not found', count: 41 },
196
+ ]
197
+ expect(listedMessages({ messages, messageCount: 12 }, 2)).toEqual({
198
+ messages: messages.slice(0, 2),
199
+ more: 10,
200
+ })
201
+ expect(listedMessages({ messages, messageCount: 3 }, 5)).toEqual({
202
+ messages,
203
+ more: 0,
204
+ })
205
+ })
206
+ })
@@ -0,0 +1,155 @@
1
+ import { describe, expect, it, vi } from 'vitest'
2
+ import {
3
+ createRetentionGuard,
4
+ isLowered,
5
+ type RetentionChange,
6
+ shareRetentionGuard,
7
+ } from '../app/utils/settingsForm'
8
+
9
+ describe('isLowered', () => {
10
+ it('is a value below the saved one', () => {
11
+ expect(isLowered(30, 90)).toBe(true)
12
+ expect(isLowered(90, 90)).toBe(false)
13
+ expect(isLowered(120, 90)).toBe(false)
14
+ expect(isLowered(null, 90)).toBe(false)
15
+ expect(isLowered(30, undefined)).toBe(false)
16
+ })
17
+ })
18
+
19
+ describe('createRetentionGuard', () => {
20
+ const change = (field: string, to: number, from = 90): RetentionChange => ({
21
+ field,
22
+ label: field,
23
+ from,
24
+ to,
25
+ })
26
+
27
+ /** Confirms the changes the guard holds, then lets the resubmit through. */
28
+ async function confirmAndResubmit(
29
+ guard: ReturnType<typeof createRetentionGuard>,
30
+ resubmit: ReturnType<typeof vi.fn>,
31
+ ) {
32
+ const before = resubmit.mock.calls.length
33
+ expect(guard.allowSubmit()).toBe(false)
34
+ await vi.waitFor(() => expect(resubmit.mock.calls.length).toBe(before + 1))
35
+ expect(guard.allowSubmit()).toBe(true)
36
+ }
37
+
38
+ it('lets a save through when nothing is lowered', () => {
39
+ const ask = vi.fn()
40
+ const guard = createRetentionGuard(ask, vi.fn())
41
+ expect(guard.allowSubmit()).toBe(true)
42
+ expect(ask).not.toHaveBeenCalled()
43
+ })
44
+
45
+ it('asks once for every lowered field, then submits again', async () => {
46
+ const ask = vi.fn(async () => true)
47
+ const resubmit = vi.fn()
48
+ const guard = createRetentionGuard(ask, resubmit)
49
+ guard.set('statisticsLifetimeDays', change('statisticsLifetimeDays', 30))
50
+ guard.set('requestLogRetentionDays', change('requestLogRetentionDays', 7))
51
+
52
+ expect(guard.allowSubmit()).toBe(false)
53
+ // A second field's validator in the same pass does not ask again.
54
+ expect(guard.allowSubmit()).toBe(false)
55
+ await vi.waitFor(() => expect(resubmit).toHaveBeenCalledOnce())
56
+ expect(ask).toHaveBeenCalledOnce()
57
+ expect(ask.mock.calls[0]![0]).toHaveLength(2)
58
+
59
+ // Both fields' validators let the resubmit through.
60
+ expect(guard.allowSubmit()).toBe(true)
61
+ expect(guard.allowSubmit()).toBe(true)
62
+ })
63
+
64
+ it('keeps the save stopped when the user cancels', async () => {
65
+ const ask = vi.fn(async () => false)
66
+ const resubmit = vi.fn()
67
+ const guard = createRetentionGuard(ask, resubmit)
68
+ guard.set('statisticsLifetimeDays', change('statisticsLifetimeDays', 30))
69
+
70
+ expect(guard.allowSubmit()).toBe(false)
71
+ await vi.waitFor(() => expect(ask).toHaveBeenCalledOnce())
72
+ await Promise.resolve()
73
+ expect(resubmit).not.toHaveBeenCalled()
74
+ expect(guard.allowSubmit()).toBe(false)
75
+ await vi.waitFor(() => expect(ask).toHaveBeenCalledTimes(2))
76
+ })
77
+
78
+ it('asks again once the lowered value changes', async () => {
79
+ const ask = vi.fn(async () => true)
80
+ const resubmit = vi.fn()
81
+ const guard = createRetentionGuard(ask, resubmit)
82
+ guard.set('statisticsLifetimeDays', change('statisticsLifetimeDays', 60))
83
+ await confirmAndResubmit(guard, resubmit)
84
+
85
+ guard.set('statisticsLifetimeDays', change('statisticsLifetimeDays', 30))
86
+ expect(guard.allowSubmit()).toBe(false)
87
+ guard.set('statisticsLifetimeDays', null)
88
+ expect(guard.allowSubmit()).toBe(true)
89
+ })
90
+
91
+ it('asks again for each lowering saved on the same page (90 → 30, 30 → 60, 60 → 30)', async () => {
92
+ const ask = vi.fn(async () => true)
93
+ const resubmit = vi.fn()
94
+ const guard = createRetentionGuard(ask, resubmit)
95
+ const field = 'statisticsLifetimeDays'
96
+
97
+ guard.set(field, change(field, 30, 90))
98
+ await confirmAndResubmit(guard, resubmit)
99
+ expect(ask).toHaveBeenCalledTimes(1)
100
+ // Saved: 30 is the value in force, nothing lowered.
101
+ guard.set(field, null)
102
+
103
+ // 30 → 60 raises it: no question.
104
+ expect(guard.allowSubmit()).toBe(true)
105
+
106
+ // Saved again at 60, then lowered to 30: asked again.
107
+ guard.set(field, change(field, 30, 60))
108
+ await confirmAndResubmit(guard, resubmit)
109
+ expect(ask).toHaveBeenCalledTimes(2)
110
+ })
111
+
112
+ it('asks again for the same lowering once the form went back to its saved value', async () => {
113
+ const ask = vi.fn(async () => true)
114
+ const resubmit = vi.fn()
115
+ const guard = createRetentionGuard(ask, resubmit)
116
+ const field = 'statisticsLifetimeDays'
117
+
118
+ guard.set(field, change(field, 30, 90))
119
+ await confirmAndResubmit(guard, resubmit)
120
+ guard.set(field, null)
121
+ guard.set(field, change(field, 30, 90))
122
+ expect(guard.allowSubmit()).toBe(false)
123
+ await vi.waitFor(() => expect(ask).toHaveBeenCalledTimes(2))
124
+ })
125
+ })
126
+
127
+ describe('shareRetentionGuard', () => {
128
+ it('shares one guard while its fields are drawn, a new one after', () => {
129
+ const create = vi.fn(() => createRetentionGuard(vi.fn(), vi.fn()))
130
+ const first = shareRetentionGuard(create)
131
+ const second = shareRetentionGuard(create)
132
+ expect(second.guard).toBe(first.guard)
133
+ expect(create).toHaveBeenCalledOnce()
134
+
135
+ // A field letting go twice counts once: the other still holds it.
136
+ first.release()
137
+ first.release()
138
+ const third = shareRetentionGuard(create)
139
+ expect(third.guard).toBe(first.guard)
140
+
141
+ second.release()
142
+ third.release()
143
+ expect(create).toHaveBeenCalledOnce()
144
+ })
145
+
146
+ it('makes a new guard once the last field let go', () => {
147
+ const create = vi.fn(() => createRetentionGuard(vi.fn(), vi.fn()))
148
+ const only = shareRetentionGuard(create)
149
+ only.release()
150
+ const next = shareRetentionGuard(create)
151
+ expect(next.guard).not.toBe(only.guard)
152
+ expect(create).toHaveBeenCalledTimes(2)
153
+ next.release()
154
+ })
155
+ })