@antelopejs/dms-api 0.1.6 → 0.2.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.
- package/README.md +99 -8
- package/dist/automation/get-api-health.js +4 -3
- package/dist/automation/get-api-health.js.map +1 -1
- package/dist/automation/route-unhealthy.js +2 -2
- package/dist/automation/route-unhealthy.js.map +1 -1
- package/dist/automation/scope.d.ts +0 -1
- package/dist/automation/scope.js +0 -7
- package/dist/automation/scope.js.map +1 -1
- package/dist/config.d.ts +4 -0
- package/dist/config.js +15 -9
- package/dist/config.js.map +1 -1
- package/dist/db/models/request_log.model.d.ts +37 -2
- package/dist/db/models/request_log.model.js +130 -35
- package/dist/db/models/request_log.model.js.map +1 -1
- package/dist/db/models/request_log.search.d.ts +5 -0
- package/dist/db/models/request_log.search.js +35 -0
- package/dist/db/models/request_log.search.js.map +1 -0
- package/dist/db/models/request_log.status.d.ts +5 -0
- package/dist/db/models/request_log.status.js +9 -0
- package/dist/db/models/request_log.status.js.map +1 -0
- package/dist/db/models/routes.model.d.ts +1 -0
- package/dist/db/models/routes.model.js +5 -1
- package/dist/db/models/routes.model.js.map +1 -1
- package/dist/db/models/routes_statistics.model.js +1 -1
- package/dist/db/models/routes_statistics.model.js.map +1 -1
- package/dist/db/tables/api_settings.table.d.ts +1 -0
- package/dist/db/tables/api_settings.table.js +4 -0
- package/dist/db/tables/api_settings.table.js.map +1 -1
- package/dist/db/tables/request_log.table.d.ts +18 -3
- package/dist/db/tables/request_log.table.js +34 -1
- package/dist/db/tables/request_log.table.js.map +1 -1
- package/dist/db/tables/routes.table.d.ts +1 -2
- package/dist/db/tables/routes.table.js.map +1 -1
- package/dist/db/tables/routes_statistics.table.d.ts +4 -3
- package/dist/db/tables/routes_statistics.table.js +5 -1
- package/dist/db/tables/routes_statistics.table.js.map +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +9 -1
- package/dist/index.js.map +1 -1
- package/dist/memo.d.ts +5 -0
- package/dist/memo.js +36 -0
- package/dist/memo.js.map +1 -0
- package/dist/pages/blocks.d.ts +3 -0
- package/dist/pages/blocks.js +31 -0
- package/dist/pages/blocks.js.map +1 -0
- package/dist/pages/displays.d.ts +7 -0
- package/dist/pages/displays.js +23 -0
- package/dist/pages/displays.js.map +1 -0
- package/dist/pages/index.d.ts +5 -2
- package/dist/pages/index.js +5 -2
- package/dist/pages/index.js.map +1 -1
- package/dist/pages/logs.d.ts +18 -0
- package/dist/pages/logs.js +112 -0
- package/dist/pages/logs.js.map +1 -0
- package/dist/pages/module.d.ts +3 -0
- package/dist/pages/module.js +102 -6
- package/dist/pages/module.js.map +1 -1
- package/dist/pages/overview.d.ts +14 -0
- package/dist/pages/overview.js +215 -0
- package/dist/pages/overview.js.map +1 -0
- package/dist/pages/period.d.ts +9 -0
- package/dist/pages/period.js +24 -0
- package/dist/pages/period.js.map +1 -0
- package/dist/pages/request-table.d.ts +11 -0
- package/dist/pages/request-table.js +187 -0
- package/dist/pages/request-table.js.map +1 -0
- package/dist/pages/routes.d.ts +15 -0
- package/dist/pages/routes.js +269 -0
- package/dist/pages/routes.js.map +1 -0
- package/dist/pages/scope-chip.d.ts +9 -0
- package/dist/pages/scope-chip.js +28 -0
- package/dist/pages/scope-chip.js.map +1 -0
- package/dist/pages/{logs/page.d.ts → settings.d.ts} +3 -3
- package/dist/pages/settings.js +218 -0
- package/dist/pages/settings.js.map +1 -0
- package/dist/pages/toolbar.d.ts +9 -0
- package/dist/pages/toolbar.js +33 -0
- package/dist/pages/toolbar.js.map +1 -0
- package/dist/realtime.d.ts +2 -0
- package/dist/realtime.js +21 -0
- package/dist/realtime.js.map +1 -0
- package/dist/routes/index.d.ts +2 -2
- package/dist/routes/index.js +2 -2
- package/dist/routes/index.js.map +1 -1
- package/dist/routes/logs.d.ts +173 -2
- package/dist/routes/logs.js +177 -86
- package/dist/routes/logs.js.map +1 -1
- package/dist/routes/overview.d.ts +27 -0
- package/dist/routes/overview.js +131 -0
- package/dist/routes/overview.js.map +1 -0
- package/dist/routes/routes.d.ts +92 -28
- package/dist/routes/routes.js +165 -97
- package/dist/routes/routes.js.map +1 -1
- package/dist/routes/settings.d.ts +16 -11
- package/dist/routes/settings.js +62 -54
- package/dist/routes/settings.js.map +1 -1
- package/dist/routes/tester.d.ts +7 -0
- package/dist/routes/tester.js +34 -0
- package/dist/routes/tester.js.map +1 -0
- package/dist/services/activity.d.ts +49 -0
- package/dist/services/activity.js +207 -0
- package/dist/services/activity.js.map +1 -0
- package/dist/services/aggregate-cache.d.ts +3 -0
- package/dist/services/aggregate-cache.js +16 -0
- package/dist/services/aggregate-cache.js.map +1 -0
- package/dist/services/api-origin.d.ts +1 -0
- package/dist/services/api-origin.js +9 -0
- package/dist/services/api-origin.js.map +1 -0
- package/dist/services/attention.d.ts +45 -0
- package/dist/services/attention.js +203 -0
- package/dist/services/attention.js.map +1 -0
- package/dist/services/composed-text.d.ts +6 -0
- package/dist/services/composed-text.js +23 -0
- package/dist/services/composed-text.js.map +1 -0
- package/dist/services/health-rules.d.ts +49 -0
- package/dist/services/health-rules.js +233 -0
- package/dist/services/health-rules.js.map +1 -0
- package/dist/services/index.d.ts +1 -3
- package/dist/services/index.js +3 -3
- package/dist/services/index.js.map +1 -1
- package/dist/services/introspection/decorators.d.ts +14 -0
- package/dist/services/introspection/decorators.js +192 -0
- package/dist/services/introspection/decorators.js.map +1 -0
- package/dist/services/introspection/errors.js +4 -4
- package/dist/services/introspection/errors.js.map +1 -1
- package/dist/services/introspection/index.d.ts +6 -8
- package/dist/services/introspection/index.js +96 -32
- package/dist/services/introspection/index.js.map +1 -1
- package/dist/services/introspection/probe.d.ts +2 -1
- package/dist/services/introspection/probe.js +11 -0
- package/dist/services/introspection/probe.js.map +1 -1
- package/dist/services/links.d.ts +25 -0
- package/dist/services/links.js +72 -0
- package/dist/services/links.js.map +1 -0
- package/dist/services/live-feed.d.ts +6 -0
- package/dist/services/live-feed.js +18 -0
- package/dist/services/live-feed.js.map +1 -0
- package/dist/services/live.d.ts +16 -0
- package/dist/services/live.js +32 -0
- package/dist/services/live.js.map +1 -0
- package/dist/services/overview.d.ts +122 -0
- package/dist/services/overview.js +324 -0
- package/dist/services/overview.js.map +1 -0
- package/dist/services/period.d.ts +0 -9
- package/dist/services/period.js +5 -52
- package/dist/services/period.js.map +1 -1
- package/dist/services/request-log/access.d.ts +5 -0
- package/dist/services/request-log/access.js +21 -0
- package/dist/services/request-log/access.js.map +1 -0
- package/dist/services/request-log/capture.d.ts +30 -0
- package/dist/services/request-log/capture.js +216 -39
- package/dist/services/request-log/capture.js.map +1 -1
- package/dist/services/request-log/list.d.ts +36 -0
- package/dist/services/request-log/list.js +201 -0
- package/dist/services/request-log/list.js.map +1 -0
- package/dist/services/request-log/read.d.ts +15 -2
- package/dist/services/request-log/read.js +47 -4
- package/dist/services/request-log/read.js.map +1 -1
- package/dist/services/request-log/redaction.d.ts +16 -3
- package/dist/services/request-log/redaction.js +149 -27
- package/dist/services/request-log/redaction.js.map +1 -1
- package/dist/services/request-log/util.d.ts +10 -3
- package/dist/services/request-log/util.js +39 -22
- package/dist/services/request-log/util.js.map +1 -1
- package/dist/services/route-catalog.d.ts +62 -0
- package/dist/services/route-catalog.js +163 -0
- package/dist/services/route-catalog.js.map +1 -0
- package/dist/services/route-contract.d.ts +66 -0
- package/dist/services/route-contract.js +266 -0
- package/dist/services/route-contract.js.map +1 -0
- package/dist/services/route-health.d.ts +35 -0
- package/dist/services/route-health.js +179 -0
- package/dist/services/route-health.js.map +1 -0
- package/dist/services/route-statistics.d.ts +68 -0
- package/dist/services/route-statistics.js +277 -0
- package/dist/services/route-statistics.js.map +1 -0
- package/dist/services/routes-sync.d.ts +7 -3
- package/dist/services/routes-sync.js +96 -20
- package/dist/services/routes-sync.js.map +1 -1
- package/dist/services/scope.d.ts +0 -1
- package/dist/services/scope.js +4 -17
- package/dist/services/scope.js.map +1 -1
- package/dist/services/settings-form.d.ts +131 -0
- package/dist/services/settings-form.js +210 -0
- package/dist/services/settings-form.js.map +1 -0
- package/dist/services/settings.d.ts +2 -0
- package/dist/services/settings.js +5 -0
- package/dist/services/settings.js.map +1 -1
- package/dist/services/statistics-aggregate.d.ts +6 -41
- package/dist/services/statistics-aggregate.js +55 -280
- package/dist/services/statistics-aggregate.js.map +1 -1
- package/dist/services/statistics-utils.d.ts +7 -12
- package/dist/services/statistics-utils.js +36 -51
- package/dist/services/statistics-utils.js.map +1 -1
- package/dist/services/statistics-write.js +64 -22
- package/dist/services/statistics-write.js.map +1 -1
- package/dist/services/tester-source.d.ts +11 -0
- package/dist/services/tester-source.js +48 -0
- package/dist/services/tester-source.js.map +1 -0
- package/dist/services/traffic-samples.d.ts +18 -0
- package/dist/services/traffic-samples.js +134 -0
- package/dist/services/traffic-samples.js.map +1 -0
- package/dist/services/traffic.d.ts +43 -0
- package/dist/services/traffic.js +270 -0
- package/dist/services/traffic.js.map +1 -0
- package/dist/services/window.d.ts +48 -0
- package/dist/services/window.js +179 -0
- package/dist/services/window.js.map +1 -0
- package/dist/types/constants.d.ts +11 -20
- package/dist/types/constants.js +15 -25
- package/dist/types/constants.js.map +1 -1
- package/dist/types/index.d.ts +0 -1
- package/dist/types/index.js +0 -1
- package/dist/types/index.js.map +1 -1
- package/dist/types/statistics.d.ts +5 -3
- package/dist/types/statistics.js +5 -0
- package/dist/types/statistics.js.map +1 -1
- package/frontend-vue/app/components/blocks/BetaBadge.vue +20 -0
- package/frontend-vue/app/components/blocks/HealthHero.vue +708 -0
- package/frontend-vue/app/components/blocks/LiveTraffic.vue +356 -0
- package/frontend-vue/app/components/blocks/LogsEmptyState.vue +228 -0
- package/frontend-vue/app/components/blocks/LogsFilters.vue +279 -0
- package/frontend-vue/app/components/blocks/RequestDetail.vue +722 -0
- package/frontend-vue/app/components/blocks/RetentionInput.vue +227 -0
- package/frontend-vue/app/components/blocks/RouteDocumentation.vue +611 -0
- package/frontend-vue/app/components/blocks/RouteHeader.vue +320 -0
- package/frontend-vue/app/components/blocks/RouteTester.vue +1879 -0
- package/frontend-vue/app/components/blocks/RouteTree.vue +676 -0
- package/frontend-vue/app/components/blocks/ScopeChip.vue +89 -0
- package/frontend-vue/app/components/blocks/SettingNumberInput.vue +65 -0
- package/frontend-vue/app/components/blocks/SplitLayout.vue +41 -0
- package/frontend-vue/app/components/internal/ApiBody.vue +129 -0
- package/frontend-vue/app/components/internal/ApiJsonTree.vue +82 -0
- package/frontend-vue/app/components/internal/ApiKeyValues.vue +41 -0
- package/frontend-vue/app/components/internal/ApiMethodBadge.vue +19 -19
- package/frontend-vue/app/components/internal/ApiPath.vue +33 -0
- package/frontend-vue/app/components/internal/ApiStatusBadge.vue +20 -15
- package/frontend-vue/app/components/internal/ApiTesterBadge.vue +17 -0
- package/frontend-vue/app/composables/useApiOrigin.ts +19 -0
- package/frontend-vue/app/composables/useApiPeriod.ts +19 -0
- package/frontend-vue/app/composables/useApiResource.ts +92 -0
- package/frontend-vue/app/composables/useDateFormat.ts +23 -0
- package/frontend-vue/app/composables/useLiveMissedErrors.ts +33 -0
- package/frontend-vue/app/composables/useRouteDetail.ts +253 -0
- package/frontend-vue/app/composables/useRouteSelection.ts +43 -0
- package/frontend-vue/app/config/shortcuts-registry.ts +30 -0
- package/frontend-vue/app/plugins/displays.ts +92 -0
- package/frontend-vue/app/utils/format.ts +281 -0
- package/frontend-vue/app/utils/http.ts +127 -0
- package/frontend-vue/app/utils/logsQuery.ts +261 -0
- package/frontend-vue/app/utils/minuteHistogram.ts +116 -0
- package/frontend-vue/app/utils/requestDrawer.ts +257 -0
- package/frontend-vue/app/utils/routeExplorer.ts +206 -0
- package/frontend-vue/app/utils/search.ts +45 -0
- package/frontend-vue/app/utils/settingsForm.ts +119 -0
- package/frontend-vue/app/utils/snippets.ts +501 -0
- package/frontend-vue/app/utils/testerHistory.ts +354 -0
- package/frontend-vue/app/utils/testerRequest.ts +632 -11
- package/frontend-vue/dms.frontend.build.ts +7 -0
- package/frontend-vue/dms.frontend.ts +10 -3
- package/frontend-vue/i18n/locales/api-en-GB.json +866 -0
- package/frontend-vue/i18n/locales/api-fr-FR.json +866 -0
- package/frontend-vue/package.json +4 -5
- package/frontend-vue/pnpm-lock.yaml +97 -3375
- package/frontend-vue/tests/format.test.ts +180 -0
- package/frontend-vue/tests/http.test.ts +61 -0
- package/frontend-vue/tests/logsQuery.test.ts +255 -0
- package/frontend-vue/tests/minuteHistogram.test.ts +94 -0
- package/frontend-vue/tests/registration.test.ts +24 -7
- package/frontend-vue/tests/requestDrawer.test.ts +179 -0
- package/frontend-vue/tests/routeExplorer.test.ts +206 -0
- package/frontend-vue/tests/settingsForm.test.ts +155 -0
- package/frontend-vue/tests/snippets.test.ts +285 -0
- package/frontend-vue/tests/testerHistory.test.ts +295 -0
- package/frontend-vue/tests/testerRequest.test.ts +471 -76
- package/frontend-vue/tests/tooltipTriggers.test.ts +51 -0
- package/package.json +8 -8
- package/dist/middlewares/index.d.ts +0 -1
- package/dist/middlewares/index.js +0 -18
- package/dist/middlewares/index.js.map +0 -1
- package/dist/middlewares/request-log-capture.d.ts +0 -1
- package/dist/middlewares/request-log-capture.js +0 -6
- package/dist/middlewares/request-log-capture.js.map +0 -1
- package/dist/pages/all.d.ts +0 -4
- package/dist/pages/all.js +0 -21
- package/dist/pages/all.js.map +0 -1
- package/dist/pages/logs/page.js +0 -29
- package/dist/pages/logs/page.js.map +0 -1
- package/dist/pages/routes/page.d.ts +0 -9
- package/dist/pages/routes/page.js +0 -29
- package/dist/pages/routes/page.js.map +0 -1
- package/dist/pages/settings/form.d.ts +0 -3
- package/dist/pages/settings/form.js +0 -80
- package/dist/pages/settings/form.js.map +0 -1
- package/dist/pages/settings/page.d.ts +0 -9
- package/dist/pages/settings/page.js +0 -26
- package/dist/pages/settings/page.js.map +0 -1
- package/dist/pages/summary/page.d.ts +0 -9
- package/dist/pages/summary/page.js +0 -29
- package/dist/pages/summary/page.js.map +0 -1
- package/dist/routes/monitoring.d.ts +0 -17
- package/dist/routes/monitoring.js +0 -101
- package/dist/routes/monitoring.js.map +0 -1
- package/dist/routes/summary.d.ts +0 -32
- package/dist/routes/summary.js +0 -181
- package/dist/routes/summary.js.map +0 -1
- package/dist/services/request-log/index.d.ts +0 -3
- package/dist/services/request-log/index.js +0 -12
- package/dist/services/request-log/index.js.map +0 -1
- package/dist/services/statistics-read.d.ts +0 -4
- package/dist/services/statistics-read.js +0 -48
- package/dist/services/statistics-read.js.map +0 -1
- package/dist/services/tree.d.ts +0 -10
- package/dist/services/tree.js +0 -128
- package/dist/services/tree.js.map +0 -1
- package/dist/types/charts.d.ts +0 -9
- package/dist/types/charts.js +0 -3
- package/dist/types/charts.js.map +0 -1
- package/frontend-vue/app/components/ConfigurationView.vue +0 -187
- package/frontend-vue/app/components/DocumentationView.vue +0 -224
- package/frontend-vue/app/components/LogDetailDrawer.vue +0 -178
- package/frontend-vue/app/components/LogsView.vue +0 -347
- package/frontend-vue/app/components/RouteDetailTabs.vue +0 -179
- package/frontend-vue/app/components/RouteTree.vue +0 -196
- package/frontend-vue/app/components/RoutesView.vue +0 -79
- package/frontend-vue/app/components/StatsView.vue +0 -268
- package/frontend-vue/app/components/SummaryView.vue +0 -657
- package/frontend-vue/app/components/TesterPanel.vue +0 -499
- package/frontend-vue/app/components/internal/PeriodSelect.vue +0 -58
- package/frontend-vue/app/components/internal/RouteTreeNode.vue +0 -168
- package/frontend-vue/app/components/internal/StatusBreakdownBars.vue +0 -162
- package/frontend-vue/app/components/internal/StatusDonut.vue +0 -84
- package/frontend-vue/app/components/internal/UnitAreaChart.vue +0 -73
- package/frontend-vue/app/composables/useApiIntrospection.ts +0 -350
- package/frontend-vue/app/composables/useLogDetailDrawer.ts +0 -50
- package/frontend-vue/app/composables/useSelectedPeriod.ts +0 -107
- package/frontend-vue/app/composables/useStatsPeriods.ts +0 -139
- package/frontend-vue/app/custom-layouts/.gitkeep +0 -0
- package/frontend-vue/app/custom-pages/.gitkeep +0 -0
- package/frontend-vue/app/utils/httpMethod.ts +0 -49
- package/frontend-vue/app/utils/statusClass.ts +0 -49
- package/frontend-vue/i18n/locales/en-GB.json +0 -240
- package/frontend-vue/i18n/locales/fr-FR.json +0 -240
- package/frontend-vue/public/.gitkeep +0 -0
- package/frontend-vue/server/.gitkeep +0 -0
- package/frontend-vue/tests/periods.test.ts +0 -145
- package/frontend-vue/tests/persistence.test.ts +0 -45
|
@@ -0,0 +1,163 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.folderOf = folderOf;
|
|
4
|
+
exports.countRoutes = countRoutes;
|
|
5
|
+
exports.listRoutes = listRoutes;
|
|
6
|
+
exports.parseRouteRef = parseRouteRef;
|
|
7
|
+
exports.isRegisteredRoute = isRegisteredRoute;
|
|
8
|
+
exports.findRoute = findRoute;
|
|
9
|
+
exports.pipelineOf = pipelineOf;
|
|
10
|
+
exports.requiresAuth = requiresAuth;
|
|
11
|
+
exports.authOf = authOf;
|
|
12
|
+
exports.getRouteDetail = getRouteDetail;
|
|
13
|
+
const interface_api_1 = require("@antelopejs/interface-api");
|
|
14
|
+
const routes_statistics_table_1 = require("@/db/tables/routes_statistics.table");
|
|
15
|
+
const introspection_1 = require("./introspection");
|
|
16
|
+
const links_1 = require("./links");
|
|
17
|
+
const capture_1 = require("./request-log/capture");
|
|
18
|
+
const route_contract_1 = require("./route-contract");
|
|
19
|
+
const memo_1 = require("@/memo");
|
|
20
|
+
const aggregate_cache_1 = require("./aggregate-cache");
|
|
21
|
+
const scope_1 = require("./scope");
|
|
22
|
+
const FOLDER_DEPTH = 2;
|
|
23
|
+
function folderOf(path) {
|
|
24
|
+
const segments = path.split("/").filter(Boolean);
|
|
25
|
+
const statics = [];
|
|
26
|
+
for (const segment of segments) {
|
|
27
|
+
if (segment.startsWith(":") || statics.length === FOLDER_DEPTH)
|
|
28
|
+
break;
|
|
29
|
+
statics.push(segment);
|
|
30
|
+
}
|
|
31
|
+
return `/${statics.join("/")}`;
|
|
32
|
+
}
|
|
33
|
+
function routeHandlers(keys) {
|
|
34
|
+
return (0, interface_api_1.getRegisteredRouteHandlers)().filter(({ handler }) => handler.mode === "handler" &&
|
|
35
|
+
!(0, capture_1.isPageLayoutPath)(handler.location) &&
|
|
36
|
+
(!keys || keys.has((0, scope_1.scopeRouteKey)(handler.method, handler.location))));
|
|
37
|
+
}
|
|
38
|
+
function countRoutes(keys) {
|
|
39
|
+
return routeHandlers(keys).length;
|
|
40
|
+
}
|
|
41
|
+
function listRoutes(keys) {
|
|
42
|
+
return routeHandlers(keys)
|
|
43
|
+
.map(({ handler }) => {
|
|
44
|
+
const method = handler.method.toUpperCase();
|
|
45
|
+
const path = (0, routes_statistics_table_1.normalizeRoutePath)(handler.location);
|
|
46
|
+
return {
|
|
47
|
+
ref: (0, links_1.routeRef)(method, path),
|
|
48
|
+
method,
|
|
49
|
+
path,
|
|
50
|
+
folder: folderOf(path),
|
|
51
|
+
controller: handler.proto
|
|
52
|
+
?.constructor?.name ?? null,
|
|
53
|
+
handler: handler.callback.name || "anonymous",
|
|
54
|
+
};
|
|
55
|
+
})
|
|
56
|
+
.sort((a, b) => a.folder.localeCompare(b.folder) ||
|
|
57
|
+
a.path.localeCompare(b.path) ||
|
|
58
|
+
a.method.localeCompare(b.method));
|
|
59
|
+
}
|
|
60
|
+
function parseRouteRef(ref) {
|
|
61
|
+
const match = ref?.trim().match(/^([A-Za-z]+)\s+(\/\S*)$/);
|
|
62
|
+
if (!match)
|
|
63
|
+
return undefined;
|
|
64
|
+
return { method: match[1].toUpperCase(), path: (0, routes_statistics_table_1.normalizeRoutePath)(match[2]) };
|
|
65
|
+
}
|
|
66
|
+
function findHandler(ref) {
|
|
67
|
+
const parsed = parseRouteRef(ref);
|
|
68
|
+
if (!parsed)
|
|
69
|
+
return undefined;
|
|
70
|
+
return (0, interface_api_1.getRegisteredRouteHandlers)().find(({ handler }) => handler.mode === "handler" &&
|
|
71
|
+
handler.method.toUpperCase() === parsed.method &&
|
|
72
|
+
(0, routes_statistics_table_1.normalizeRoutePath)(handler.location) === parsed.path);
|
|
73
|
+
}
|
|
74
|
+
function isRegisteredRoute(ref) {
|
|
75
|
+
return findHandler(ref) !== undefined;
|
|
76
|
+
}
|
|
77
|
+
function findRoute(ref) {
|
|
78
|
+
const found = findHandler(ref);
|
|
79
|
+
return found ? (0, introspection_1.getRouteInspection)(found.id) : undefined;
|
|
80
|
+
}
|
|
81
|
+
const MIDDLEWARE_STAGE = {
|
|
82
|
+
prefix: 0,
|
|
83
|
+
postfix: 2,
|
|
84
|
+
monitor: 3,
|
|
85
|
+
};
|
|
86
|
+
function pipelineOf(inspection) {
|
|
87
|
+
const steps = inspection.applicableMiddleware.map((middleware) => ({
|
|
88
|
+
stage: MIDDLEWARE_STAGE[middleware.mode],
|
|
89
|
+
step: {
|
|
90
|
+
kind: middleware.mode,
|
|
91
|
+
name: middleware.callbackName,
|
|
92
|
+
location: middleware.location,
|
|
93
|
+
priority: middleware.priority,
|
|
94
|
+
isAuth: middleware.isAuth,
|
|
95
|
+
},
|
|
96
|
+
}));
|
|
97
|
+
steps.push({
|
|
98
|
+
stage: 1,
|
|
99
|
+
step: {
|
|
100
|
+
kind: "handler",
|
|
101
|
+
name: inspection.controllerName
|
|
102
|
+
? `${inspection.controllerName}.${inspection.callbackName}`
|
|
103
|
+
: inspection.callbackName,
|
|
104
|
+
location: inspection.location,
|
|
105
|
+
priority: inspection.priority,
|
|
106
|
+
isAuth: inspection.authGuards.length > 0,
|
|
107
|
+
},
|
|
108
|
+
});
|
|
109
|
+
return steps
|
|
110
|
+
.sort((a, b) => a.stage - b.stage || (a.step.priority ?? 2) - (b.step.priority ?? 2))
|
|
111
|
+
.map(({ step }) => step);
|
|
112
|
+
}
|
|
113
|
+
function requiresAuth(inspection) {
|
|
114
|
+
return inspection.authGuards.length > 0;
|
|
115
|
+
}
|
|
116
|
+
const HTTP_UNAUTHORIZED = 401;
|
|
117
|
+
function authOf(inspection, statuses) {
|
|
118
|
+
const unauthorized = statuses.find((entry) => entry.status === HTTP_UNAUTHORIZED)?.count ?? 0;
|
|
119
|
+
const guards = inspection.authGuards;
|
|
120
|
+
let status = "unknown";
|
|
121
|
+
if (guards.length > 0)
|
|
122
|
+
status = "required";
|
|
123
|
+
else if (unauthorized > 0)
|
|
124
|
+
status = "probable";
|
|
125
|
+
return { status, guards, unauthorized };
|
|
126
|
+
}
|
|
127
|
+
const contracts = (0, memo_1.createMemo)(16, aggregate_cache_1.CACHE_TTL_MS);
|
|
128
|
+
async function getRouteDetail(models, ref, apiOrigin = null, now = new Date()) {
|
|
129
|
+
const inspection = findRoute(ref);
|
|
130
|
+
if (!inspection)
|
|
131
|
+
return undefined;
|
|
132
|
+
const method = inspection.method.toUpperCase();
|
|
133
|
+
const path = (0, routes_statistics_table_1.normalizeRoutePath)(inspection.location);
|
|
134
|
+
const [stored, observed] = await Promise.all([
|
|
135
|
+
models.routes.getByRoute(method, inspection.location),
|
|
136
|
+
contracts.cached(`${method} ${path}`, () => (0, route_contract_1.loadContractTraffic)(models.logs, method, inspection.location, now)),
|
|
137
|
+
]);
|
|
138
|
+
const contract = (0, route_contract_1.contractOf)(observed);
|
|
139
|
+
const auth = authOf(inspection, contract.statuses);
|
|
140
|
+
return {
|
|
141
|
+
ref: (0, links_1.routeRef)(method, path),
|
|
142
|
+
method,
|
|
143
|
+
path,
|
|
144
|
+
folder: folderOf(path),
|
|
145
|
+
controller: inspection.controllerName,
|
|
146
|
+
handler: inspection.callbackName,
|
|
147
|
+
module: inspection.module ?? stored?.module ?? null,
|
|
148
|
+
own: stored ? stored.own : null,
|
|
149
|
+
requiresAuth: auth.status !== "unknown",
|
|
150
|
+
auth,
|
|
151
|
+
registeredAt: stored?.createdAt?.toISOString() ?? null,
|
|
152
|
+
pathParams: inspection.location
|
|
153
|
+
.split("/")
|
|
154
|
+
.filter((segment) => segment.startsWith(":"))
|
|
155
|
+
.map((segment) => segment.slice(1)),
|
|
156
|
+
parameters: (0, route_contract_1.documentParameters)(inspection, observed.successful, contract.queryParams),
|
|
157
|
+
pipeline: pipelineOf(inspection),
|
|
158
|
+
inspection,
|
|
159
|
+
contract,
|
|
160
|
+
apiOrigin,
|
|
161
|
+
};
|
|
162
|
+
}
|
|
163
|
+
//# sourceMappingURL=route-catalog.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"route-catalog.js","sourceRoot":"","sources":["../../src/services/route-catalog.ts"],"names":[],"mappings":";;AAsDA,4BAQC;AAqBD,kCAEC;AAGD,gCAsBC;AAGD,sCAMC;AAiBD,8CAEC;AAED,8BAKC;AAkBD,gCA6BC;AAOD,oCAEC;AAqBD,wBAWC;AAqCD,wCA4CC;AA1TD,6DAGmC;AAEnC,iFAAyE;AACzE,mDAIyB;AACzB,mCAAmC;AACnC,mDAAyD;AACzD,qDAO0B;AAC1B,iCAAoC;AACpC,uDAAiD;AACjD,mCAAwC;AA4BxC,MAAM,YAAY,GAAG,CAAC,CAAC;AAGvB,SAAgB,QAAQ,CAAC,IAAY;IACnC,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACjD,MAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC/B,IAAI,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,OAAO,CAAC,MAAM,KAAK,YAAY;YAAE,MAAM;QACtE,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACxB,CAAC;IACD,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;AACjC,CAAC;AAOD,SAAS,aAAa,CAAC,IAAe;IACpC,OAAO,IAAA,0CAA0B,GAAE,CAAC,MAAM,CACxC,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CACd,OAAO,CAAC,IAAI,KAAK,SAAS;QAC1B,CAAC,IAAA,0BAAgB,EAAC,OAAO,CAAC,QAAQ,CAAC;QACnC,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,GAAG,CAAC,IAAA,qBAAa,EAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CACvE,CAAC;AACJ,CAAC;AAOD,SAAgB,WAAW,CAAC,IAAe;IACzC,OAAO,aAAa,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC;AACpC,CAAC;AAGD,SAAgB,UAAU,CAAC,IAAe;IACxC,OAAO,aAAa,CAAC,IAAI,CAAC;SACvB,GAAG,CAAC,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE;QACnB,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;QAC5C,MAAM,IAAI,GAAG,IAAA,4CAAkB,EAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAClD,OAAO;YACL,GAAG,EAAE,IAAA,gBAAQ,EAAC,MAAM,EAAE,IAAI,CAAC;YAC3B,MAAM;YACN,IAAI;YACJ,MAAM,EAAE,QAAQ,CAAC,IAAI,CAAC;YACtB,UAAU,EACP,OAAO,CAAC,KAAyD;gBAChE,EAAE,WAAW,EAAE,IAAI,IAAI,IAAI;YAC/B,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,IAAI,IAAI,WAAW;SAC9C,CAAC;IACJ,CAAC,CAAC;SACD,IAAI,CACH,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CACP,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC;QAChC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC;QAC5B,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC,CACnC,CAAC;AACN,CAAC;AAGD,SAAgB,aAAa,CAC3B,GAAuB;IAEvB,MAAM,KAAK,GAAG,GAAG,EAAE,IAAI,EAAE,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC3D,IAAI,CAAC,KAAK;QAAE,OAAO,SAAS,CAAC;IAC7B,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,IAAA,4CAAkB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AAChF,CAAC;AAGD,SAAS,WAAW,CAClB,GAAuB;IAEvB,MAAM,MAAM,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC;IAClC,IAAI,CAAC,MAAM;QAAE,OAAO,SAAS,CAAC;IAC9B,OAAO,IAAA,0CAA0B,GAAE,CAAC,IAAI,CACtC,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CACd,OAAO,CAAC,IAAI,KAAK,SAAS;QAC1B,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,KAAK,MAAM,CAAC,MAAM;QAC9C,IAAA,4CAAkB,EAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,MAAM,CAAC,IAAI,CACvD,CAAC;AACJ,CAAC;AAGD,SAAgB,iBAAiB,CAAC,GAAuB;IACvD,OAAO,WAAW,CAAC,GAAG,CAAC,KAAK,SAAS,CAAC;AACxC,CAAC;AAED,SAAgB,SAAS,CACvB,GAAuB;IAEvB,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC;IAC/B,OAAO,KAAK,CAAC,CAAC,CAAC,IAAA,kCAAkB,EAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AAC1D,CAAC;AAWD,MAAM,gBAAgB,GAA2C;IAC/D,MAAM,EAAE,CAAC;IACT,OAAO,EAAE,CAAC;IACV,OAAO,EAAE,CAAC;CACX,CAAC;AAGF,SAAgB,UAAU,CAAC,UAA2B;IACpD,MAAM,KAAK,GAAG,UAAU,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;QACjE,KAAK,EAAE,gBAAgB,CAAC,UAAU,CAAC,IAAI,CAAC;QACxC,IAAI,EAAE;YACJ,IAAI,EAAE,UAAU,CAAC,IAAI;YACrB,IAAI,EAAE,UAAU,CAAC,YAAY;YAC7B,QAAQ,EAAE,UAAU,CAAC,QAAQ;YAC7B,QAAQ,EAAE,UAAU,CAAC,QAAQ;YAC7B,MAAM,EAAE,UAAU,CAAC,MAAM;SACV;KAClB,CAAC,CAAC,CAAC;IACJ,KAAK,CAAC,IAAI,CAAC;QACT,KAAK,EAAE,CAAC;QACR,IAAI,EAAE;YACJ,IAAI,EAAE,SAAS;YACf,IAAI,EAAE,UAAU,CAAC,cAAc;gBAC7B,CAAC,CAAC,GAAG,UAAU,CAAC,cAAc,IAAI,UAAU,CAAC,YAAY,EAAE;gBAC3D,CAAC,CAAC,UAAU,CAAC,YAAY;YAC3B,QAAQ,EAAE,UAAU,CAAC,QAAQ;YAC7B,QAAQ,EAAE,UAAU,CAAC,QAAQ;YAC7B,MAAM,EAAE,UAAU,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC;SACzC;KACF,CAAC,CAAC;IACH,OAAO,KAAK;SACT,IAAI,CACH,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CACP,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,CAAC,CACvE;SACA,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC;AAC7B,CAAC;AAOD,SAAgB,YAAY,CAAC,UAA2B;IACtD,OAAO,UAAU,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC;AAC1C,CAAC;AAkBD,MAAM,iBAAiB,GAAG,GAAG,CAAC;AAG9B,SAAgB,MAAM,CACpB,UAA2B,EAC3B,QAAyD;IAEzD,MAAM,YAAY,GAChB,QAAQ,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,KAAK,iBAAiB,CAAC,EAAE,KAAK,IAAI,CAAC,CAAC;IAC3E,MAAM,MAAM,GAAG,UAAU,CAAC,UAAU,CAAC;IACrC,IAAI,MAAM,GAAe,SAAS,CAAC;IACnC,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC;QAAE,MAAM,GAAG,UAAU,CAAC;SACtC,IAAI,YAAY,GAAG,CAAC;QAAE,MAAM,GAAG,UAAU,CAAC;IAC/C,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC;AAC1C,CAAC;AAkCD,MAAM,SAAS,GAAG,IAAA,iBAAU,EAAC,EAAE,EAAE,8BAAY,CAAC,CAAC;AAGxC,KAAK,UAAU,cAAc,CAClC,MAAqB,EACrB,GAAW,EACX,YAA2B,IAAI,EAC/B,MAAY,IAAI,IAAI,EAAE;IAEtB,MAAM,UAAU,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;IAClC,IAAI,CAAC,UAAU;QAAE,OAAO,SAAS,CAAC;IAClC,MAAM,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;IAC/C,MAAM,IAAI,GAAG,IAAA,4CAAkB,EAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IACrD,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;QAC3C,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,UAAU,CAAC,QAAQ,CAAC;QACrD,SAAS,CAAC,MAAM,CAAC,GAAG,MAAM,IAAI,IAAI,EAAE,EAAE,GAAG,EAAE,CACzC,IAAA,oCAAmB,EAAC,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,CAAC,QAAQ,EAAE,GAAG,CAAC,CACnE;KACF,CAAC,CAAC;IACH,MAAM,QAAQ,GAAG,IAAA,2BAAU,EAAC,QAAQ,CAAC,CAAC;IACtC,MAAM,IAAI,GAAG,MAAM,CAAC,UAAU,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACnD,OAAO;QACL,GAAG,EAAE,IAAA,gBAAQ,EAAC,MAAM,EAAE,IAAI,CAAC;QAC3B,MAAM;QACN,IAAI;QACJ,MAAM,EAAE,QAAQ,CAAC,IAAI,CAAC;QACtB,UAAU,EAAE,UAAU,CAAC,cAAc;QACrC,OAAO,EAAE,UAAU,CAAC,YAAY;QAChC,MAAM,EAAE,UAAU,CAAC,MAAM,IAAI,MAAM,EAAE,MAAM,IAAI,IAAI;QACnD,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI;QAC/B,YAAY,EAAE,IAAI,CAAC,MAAM,KAAK,SAAS;QACvC,IAAI;QACJ,YAAY,EAAE,MAAM,EAAE,SAAS,EAAE,WAAW,EAAE,IAAI,IAAI;QACtD,UAAU,EAAE,UAAU,CAAC,QAAQ;aAC5B,KAAK,CAAC,GAAG,CAAC;aACV,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;aAC5C,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACrC,UAAU,EAAE,IAAA,mCAAkB,EAC5B,UAAU,EACV,QAAQ,CAAC,UAAU,EACnB,QAAQ,CAAC,WAAW,CACrB;QACD,QAAQ,EAAE,UAAU,CAAC,UAAU,CAAC;QAChC,UAAU;QACV,QAAQ;QACR,SAAS;KACV,CAAC;AACJ,CAAC"}
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
import type { RequestLogModel } from "@/db";
|
|
2
|
+
import type { RequestLogSample } from "@/db/models/request_log.model";
|
|
3
|
+
import type { RequestLog } from "@/db/tables/request_log.table";
|
|
4
|
+
import type { RouteInspection } from "./introspection";
|
|
5
|
+
export interface InferredField {
|
|
6
|
+
name: string;
|
|
7
|
+
types: string[];
|
|
8
|
+
required: boolean;
|
|
9
|
+
example?: string | number | boolean | null;
|
|
10
|
+
}
|
|
11
|
+
export interface ObservedStatus {
|
|
12
|
+
status: number;
|
|
13
|
+
count: number;
|
|
14
|
+
message: string | null;
|
|
15
|
+
messages: Array<{
|
|
16
|
+
message: string;
|
|
17
|
+
count: number;
|
|
18
|
+
}>;
|
|
19
|
+
messageCount: number;
|
|
20
|
+
lastSeen: string;
|
|
21
|
+
}
|
|
22
|
+
export interface ObservedResponse {
|
|
23
|
+
status: number;
|
|
24
|
+
body: string;
|
|
25
|
+
json: boolean;
|
|
26
|
+
truncated: boolean;
|
|
27
|
+
}
|
|
28
|
+
export interface ObservedContract {
|
|
29
|
+
windowDays: number;
|
|
30
|
+
total: number;
|
|
31
|
+
exampleBody: unknown;
|
|
32
|
+
bodyFields: InferredField[];
|
|
33
|
+
sampled: number;
|
|
34
|
+
queryParams: string[];
|
|
35
|
+
statuses: ObservedStatus[];
|
|
36
|
+
examplePath: Record<string, string>;
|
|
37
|
+
exampleQuery: Record<string, string | string[]>;
|
|
38
|
+
exampleResponse: ObservedResponse | null;
|
|
39
|
+
responseKind: "object" | "array" | null;
|
|
40
|
+
responseFields: InferredField[];
|
|
41
|
+
latency: {
|
|
42
|
+
p50: number;
|
|
43
|
+
p95: number;
|
|
44
|
+
} | null;
|
|
45
|
+
}
|
|
46
|
+
export declare const CONTRACT_WINDOW_DAYS = 7;
|
|
47
|
+
export declare const RESPONSE_EXAMPLE_CHARS = 16384;
|
|
48
|
+
export declare function inferBodyFields(bodies: Record<string, unknown>[]): InferredField[];
|
|
49
|
+
export declare function observedStatuses(samples: Array<Pick<RequestLogSample, "statusCode" | "timestamp" | "errorMessage">>): ObservedStatus[];
|
|
50
|
+
export interface ContractTraffic {
|
|
51
|
+
samples: RequestLogSample[];
|
|
52
|
+
successful: RequestLog[];
|
|
53
|
+
latest: RequestLog[];
|
|
54
|
+
}
|
|
55
|
+
export declare function loadContractTraffic(model: RequestLogModel, method: string, path: string, now?: Date): Promise<ContractTraffic>;
|
|
56
|
+
export declare function contractOf({ samples, successful, latest, }: ContractTraffic): ObservedContract;
|
|
57
|
+
export interface DocumentedParameter {
|
|
58
|
+
name: string;
|
|
59
|
+
in: "path" | "query" | "header";
|
|
60
|
+
type: string;
|
|
61
|
+
example: string | null;
|
|
62
|
+
declared: boolean;
|
|
63
|
+
required: boolean;
|
|
64
|
+
}
|
|
65
|
+
export declare function valueType(value: string): string;
|
|
66
|
+
export declare function documentParameters(inspection: RouteInspection, successful: Array<Pick<RequestLog, "pathParams" | "query" | "requestHeaders">>, queryParams: string[]): DocumentedParameter[];
|
|
@@ -0,0 +1,266 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.RESPONSE_EXAMPLE_CHARS = exports.CONTRACT_WINDOW_DAYS = void 0;
|
|
4
|
+
exports.inferBodyFields = inferBodyFields;
|
|
5
|
+
exports.observedStatuses = observedStatuses;
|
|
6
|
+
exports.loadContractTraffic = loadContractTraffic;
|
|
7
|
+
exports.contractOf = contractOf;
|
|
8
|
+
exports.valueType = valueType;
|
|
9
|
+
exports.documentParameters = documentParameters;
|
|
10
|
+
const routes_statistics_table_1 = require("@/db/tables/routes_statistics.table");
|
|
11
|
+
const types_1 = require("@/types");
|
|
12
|
+
const statistics_utils_1 = require("./statistics-utils");
|
|
13
|
+
exports.CONTRACT_WINDOW_DAYS = 7;
|
|
14
|
+
const CONTRACT_SAMPLE = 200;
|
|
15
|
+
exports.RESPONSE_EXAMPLE_CHARS = 16_384;
|
|
16
|
+
const STATUS_MESSAGES = 10;
|
|
17
|
+
function parseJson(text) {
|
|
18
|
+
if (!text)
|
|
19
|
+
return undefined;
|
|
20
|
+
try {
|
|
21
|
+
return JSON.parse(text);
|
|
22
|
+
}
|
|
23
|
+
catch {
|
|
24
|
+
return undefined;
|
|
25
|
+
}
|
|
26
|
+
}
|
|
27
|
+
function typeName(value) {
|
|
28
|
+
if (value === null)
|
|
29
|
+
return "null";
|
|
30
|
+
if (Array.isArray(value))
|
|
31
|
+
return "array";
|
|
32
|
+
return typeof value;
|
|
33
|
+
}
|
|
34
|
+
function isScalar(value) {
|
|
35
|
+
return (value === null || ["string", "number", "boolean"].includes(typeof value));
|
|
36
|
+
}
|
|
37
|
+
function inferBodyFields(bodies) {
|
|
38
|
+
const fields = new Map();
|
|
39
|
+
for (const body of bodies) {
|
|
40
|
+
for (const [name, value] of Object.entries(body)) {
|
|
41
|
+
const field = fields.get(name) ?? {
|
|
42
|
+
types: new Set(),
|
|
43
|
+
seen: 0,
|
|
44
|
+
example: value,
|
|
45
|
+
};
|
|
46
|
+
field.types.add(typeName(value));
|
|
47
|
+
field.seen += 1;
|
|
48
|
+
fields.set(name, field);
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
return [...fields].map(([name, field]) => {
|
|
52
|
+
const inferred = {
|
|
53
|
+
name,
|
|
54
|
+
types: [...field.types].sort(),
|
|
55
|
+
required: field.seen === bodies.length,
|
|
56
|
+
};
|
|
57
|
+
if (isScalar(field.example))
|
|
58
|
+
inferred.example = field.example;
|
|
59
|
+
return inferred;
|
|
60
|
+
});
|
|
61
|
+
}
|
|
62
|
+
function isRecord(value) {
|
|
63
|
+
return typeof value === "object" && value !== null && !Array.isArray(value);
|
|
64
|
+
}
|
|
65
|
+
function fromTester(entry) {
|
|
66
|
+
return "source" in entry && entry.source === "tester";
|
|
67
|
+
}
|
|
68
|
+
function observedStatuses(samples) {
|
|
69
|
+
const statuses = new Map();
|
|
70
|
+
for (const sample of samples) {
|
|
71
|
+
const entry = statuses.get(sample.statusCode) ?? {
|
|
72
|
+
count: 0,
|
|
73
|
+
messages: new Map(),
|
|
74
|
+
lastSeen: sample.timestamp,
|
|
75
|
+
};
|
|
76
|
+
entry.count += 1;
|
|
77
|
+
if (sample.timestamp > entry.lastSeen)
|
|
78
|
+
entry.lastSeen = sample.timestamp;
|
|
79
|
+
if (sample.errorMessage) {
|
|
80
|
+
entry.messages.set(sample.errorMessage, (entry.messages.get(sample.errorMessage) ?? 0) + 1);
|
|
81
|
+
}
|
|
82
|
+
statuses.set(sample.statusCode, entry);
|
|
83
|
+
}
|
|
84
|
+
return [...statuses]
|
|
85
|
+
.map(([status, entry]) => {
|
|
86
|
+
const messages = [...entry.messages]
|
|
87
|
+
.map(([message, count]) => ({ message, count }))
|
|
88
|
+
.sort((a, b) => b.count - a.count)
|
|
89
|
+
.slice(0, STATUS_MESSAGES);
|
|
90
|
+
return {
|
|
91
|
+
status,
|
|
92
|
+
count: entry.count,
|
|
93
|
+
message: messages[0]?.message ?? null,
|
|
94
|
+
messages,
|
|
95
|
+
messageCount: entry.messages.size,
|
|
96
|
+
lastSeen: new Date(entry.lastSeen).toISOString(),
|
|
97
|
+
};
|
|
98
|
+
})
|
|
99
|
+
.sort((a, b) => a.status - b.status);
|
|
100
|
+
}
|
|
101
|
+
function exampleResponse(log) {
|
|
102
|
+
if (!log?.responseBody)
|
|
103
|
+
return null;
|
|
104
|
+
const json = parseJson(log.responseBody);
|
|
105
|
+
const text = json === undefined ? log.responseBody : JSON.stringify(json, null, 2);
|
|
106
|
+
return {
|
|
107
|
+
status: log.statusCode,
|
|
108
|
+
body: text.slice(0, exports.RESPONSE_EXAMPLE_CHARS),
|
|
109
|
+
json: json !== undefined,
|
|
110
|
+
truncated: log.responseBodyTruncated || text.length > exports.RESPONSE_EXAMPLE_CHARS,
|
|
111
|
+
};
|
|
112
|
+
}
|
|
113
|
+
function responseShape(logs) {
|
|
114
|
+
const bodies = logs.map((log) => parseJson(log.responseBody));
|
|
115
|
+
const lists = bodies.filter(Array.isArray);
|
|
116
|
+
const objects = bodies.filter(isRecord);
|
|
117
|
+
if (lists.length > objects.length) {
|
|
118
|
+
return {
|
|
119
|
+
responseKind: "array",
|
|
120
|
+
responseFields: inferBodyFields(lists.flatMap((list) => list.filter(isRecord))),
|
|
121
|
+
};
|
|
122
|
+
}
|
|
123
|
+
if (objects.length > 0) {
|
|
124
|
+
return { responseKind: "object", responseFields: inferBodyFields(objects) };
|
|
125
|
+
}
|
|
126
|
+
return { responseKind: null, responseFields: [] };
|
|
127
|
+
}
|
|
128
|
+
function latencyOf(samples) {
|
|
129
|
+
const durations = samples
|
|
130
|
+
.filter((sample) => sample.statusCode < 400)
|
|
131
|
+
.map((sample) => sample.responseTimeMs)
|
|
132
|
+
.filter((ms) => typeof ms === "number");
|
|
133
|
+
const p50 = (0, statistics_utils_1.exactQuantile)(durations, 0.5);
|
|
134
|
+
const p95 = (0, statistics_utils_1.exactQuantile)(durations, 0.95);
|
|
135
|
+
return p50 === null || p95 === null ? null : { p50, p95 };
|
|
136
|
+
}
|
|
137
|
+
function newestFirst(a, b) {
|
|
138
|
+
return +new Date(b.timestamp) - +new Date(a.timestamp);
|
|
139
|
+
}
|
|
140
|
+
async function loadContractTraffic(model, method, path, now = new Date()) {
|
|
141
|
+
const since = new Date(now.getTime() - exports.CONTRACT_WINDOW_DAYS * types_1.MS_PER_DAY);
|
|
142
|
+
const filters = {
|
|
143
|
+
method,
|
|
144
|
+
since,
|
|
145
|
+
until: now,
|
|
146
|
+
uri: (0, routes_statistics_table_1.normalizeRoutePath)(path),
|
|
147
|
+
apiTrafficOnly: true,
|
|
148
|
+
};
|
|
149
|
+
const recent = (statusClass) => model
|
|
150
|
+
.query({ ...filters, statusClass, limit: CONTRACT_SAMPLE })
|
|
151
|
+
.then(({ results }) => results.filter((log) => !fromTester(log)).sort(newestFirst));
|
|
152
|
+
const [samples, successful, latest] = await Promise.all([
|
|
153
|
+
model
|
|
154
|
+
.samples(filters)
|
|
155
|
+
.then((rows) => rows.filter((row) => !fromTester(row))),
|
|
156
|
+
recent("success"),
|
|
157
|
+
recent(),
|
|
158
|
+
]);
|
|
159
|
+
return { samples, successful, latest };
|
|
160
|
+
}
|
|
161
|
+
function contractOf({ samples, successful, latest, }) {
|
|
162
|
+
const bodies = successful
|
|
163
|
+
.map((log) => parseJson(log.requestBody))
|
|
164
|
+
.filter(isRecord);
|
|
165
|
+
const queryParams = new Set();
|
|
166
|
+
for (const log of [...successful, ...latest]) {
|
|
167
|
+
for (const key of Object.keys(log.query ?? {}))
|
|
168
|
+
queryParams.add(key);
|
|
169
|
+
}
|
|
170
|
+
const last = successful[0];
|
|
171
|
+
return {
|
|
172
|
+
windowDays: exports.CONTRACT_WINDOW_DAYS,
|
|
173
|
+
total: samples.length,
|
|
174
|
+
exampleBody: bodies[0] ?? null,
|
|
175
|
+
bodyFields: inferBodyFields(bodies),
|
|
176
|
+
sampled: successful.length,
|
|
177
|
+
queryParams: [...queryParams].sort(),
|
|
178
|
+
statuses: observedStatuses(samples),
|
|
179
|
+
examplePath: last?.pathParams ?? {},
|
|
180
|
+
exampleQuery: last?.query ?? {},
|
|
181
|
+
exampleResponse: exampleResponse(last),
|
|
182
|
+
...responseShape(successful),
|
|
183
|
+
latency: latencyOf(samples),
|
|
184
|
+
};
|
|
185
|
+
}
|
|
186
|
+
const UUID = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i;
|
|
187
|
+
const ISO_DATE = /^\d{4}-\d{2}-\d{2}(?:T[\d:.]+(?:Z|[+-]\d{2}:?\d{2})?)?$/;
|
|
188
|
+
function valueType(value) {
|
|
189
|
+
if (/^-?\d+(?:\.\d+)?$/.test(value))
|
|
190
|
+
return "number";
|
|
191
|
+
if (value === "true" || value === "false")
|
|
192
|
+
return "boolean";
|
|
193
|
+
if (UUID.test(value))
|
|
194
|
+
return "uuid";
|
|
195
|
+
if (ISO_DATE.test(value))
|
|
196
|
+
return "date";
|
|
197
|
+
return "string";
|
|
198
|
+
}
|
|
199
|
+
function firstValue(value) {
|
|
200
|
+
if (value === undefined)
|
|
201
|
+
return null;
|
|
202
|
+
return (Array.isArray(value) ? value[0] : value) ?? null;
|
|
203
|
+
}
|
|
204
|
+
function documentParameters(inspection, successful, queryParams) {
|
|
205
|
+
const example = (where, name) => {
|
|
206
|
+
for (const log of successful) {
|
|
207
|
+
const value = where === "path"
|
|
208
|
+
? log.pathParams?.[name]
|
|
209
|
+
: where === "query"
|
|
210
|
+
? firstValue(log.query?.[name])
|
|
211
|
+
: log.requestHeaders?.[name.toLowerCase()];
|
|
212
|
+
if (value)
|
|
213
|
+
return value;
|
|
214
|
+
}
|
|
215
|
+
return null;
|
|
216
|
+
};
|
|
217
|
+
const declared = new Map(inspection.parameters
|
|
218
|
+
.filter((parameter) => parameter.name &&
|
|
219
|
+
(parameter.source === "param" ||
|
|
220
|
+
parameter.source === "query" ||
|
|
221
|
+
parameter.source === "header"))
|
|
222
|
+
.map((parameter) => [`${parameter.source}:${parameter.name}`, parameter]));
|
|
223
|
+
const entries = [
|
|
224
|
+
...inspection.location
|
|
225
|
+
.split("/")
|
|
226
|
+
.filter((segment) => segment.startsWith(":"))
|
|
227
|
+
.map((segment) => ({ in: "path", name: segment.slice(1) })),
|
|
228
|
+
...[
|
|
229
|
+
...new Set([
|
|
230
|
+
...inspection.parameters
|
|
231
|
+
.filter((parameter) => parameter.source === "query" && parameter.name)
|
|
232
|
+
.map((parameter) => parameter.name),
|
|
233
|
+
...queryParams,
|
|
234
|
+
]),
|
|
235
|
+
]
|
|
236
|
+
.sort()
|
|
237
|
+
.map((name) => ({ in: "query", name })),
|
|
238
|
+
...inspection.parameters
|
|
239
|
+
.filter((parameter) => parameter.source === "header" && parameter.name)
|
|
240
|
+
.map((parameter) => ({
|
|
241
|
+
in: "header",
|
|
242
|
+
name: parameter.name,
|
|
243
|
+
})),
|
|
244
|
+
];
|
|
245
|
+
return entries.map((entry) => {
|
|
246
|
+
const source = entry.in === "path" ? "param" : entry.in;
|
|
247
|
+
const parameter = declared.get(`${source}:${entry.name}`);
|
|
248
|
+
const value = example(entry.in, entry.name);
|
|
249
|
+
let type = value ? valueType(value) : "string";
|
|
250
|
+
if (parameter?.multi)
|
|
251
|
+
type = `${type}[]`;
|
|
252
|
+
else if (parameter &&
|
|
253
|
+
parameter.inferredType !== "string" &&
|
|
254
|
+
parameter.inferredType !== "unknown")
|
|
255
|
+
type = parameter.inferredType;
|
|
256
|
+
return {
|
|
257
|
+
name: entry.name,
|
|
258
|
+
in: entry.in,
|
|
259
|
+
type,
|
|
260
|
+
example: value,
|
|
261
|
+
declared: parameter !== undefined,
|
|
262
|
+
required: entry.in === "path",
|
|
263
|
+
};
|
|
264
|
+
});
|
|
265
|
+
}
|
|
266
|
+
//# sourceMappingURL=route-contract.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"route-contract.js","sourceRoot":"","sources":["../../src/services/route-contract.ts"],"names":[],"mappings":";;;AAsGA,0CA4BC;AAeD,4CAyCC;AAmED,kDA6BC;AAOD,gCA2BC;AAmBD,8BAMC;AAYD,gDAyEC;AAvaD,iFAAyE;AACzE,mCAAqC;AAErC,yDAAmD;AAmEtC,QAAA,oBAAoB,GAAG,CAAC,CAAC;AAEtC,MAAM,eAAe,GAAG,GAAG,CAAC;AAEf,QAAA,sBAAsB,GAAG,MAAM,CAAC;AAC7C,MAAM,eAAe,GAAG,EAAE,CAAC;AAE3B,SAAS,SAAS,CAAC,IAAwB;IACzC,IAAI,CAAC,IAAI;QAAE,OAAO,SAAS,CAAC;IAC5B,IAAI,CAAC;QACH,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED,SAAS,QAAQ,CAAC,KAAc;IAC9B,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,MAAM,CAAC;IAClC,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,OAAO,OAAO,CAAC;IACzC,OAAO,OAAO,KAAK,CAAC;AACtB,CAAC;AAED,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,CACL,KAAK,KAAK,IAAI,IAAI,CAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC,QAAQ,CAAC,OAAO,KAAK,CAAC,CACzE,CAAC;AACJ,CAAC;AAGD,SAAgB,eAAe,CAC7B,MAAiC;IAEjC,MAAM,MAAM,GAAG,IAAI,GAAG,EAGnB,CAAC;IACJ,KAAK,MAAM,IAAI,IAAI,MAAM,EAAE,CAAC;QAC1B,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACjD,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI;gBAChC,KAAK,EAAE,IAAI,GAAG,EAAU;gBACxB,IAAI,EAAE,CAAC;gBACP,OAAO,EAAE,KAAK;aACf,CAAC;YACF,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;YACjC,KAAK,CAAC,IAAI,IAAI,CAAC,CAAC;YAChB,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAC1B,CAAC;IACH,CAAC;IACD,OAAO,CAAC,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE;QACvC,MAAM,QAAQ,GAAkB;YAC9B,IAAI;YACJ,KAAK,EAAE,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE;YAC9B,QAAQ,EAAE,KAAK,CAAC,IAAI,KAAK,MAAM,CAAC,MAAM;SACvC,CAAC;QACF,IAAI,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC;YAAE,QAAQ,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;QAC9D,OAAO,QAAQ,CAAC;IAClB,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC9E,CAAC;AAMD,SAAS,UAAU,CAAC,KAAoC;IACtD,OAAO,QAAQ,IAAI,KAAK,IAAI,KAAK,CAAC,MAAM,KAAK,QAAQ,CAAC;AACxD,CAAC;AAGD,SAAgB,gBAAgB,CAC9B,OAEC;IAED,MAAM,QAAQ,GAAG,IAAI,GAAG,EAGrB,CAAC;IACJ,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,MAAM,KAAK,GAAG,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI;YAC/C,KAAK,EAAE,CAAC;YACR,QAAQ,EAAE,IAAI,GAAG,EAAkB;YACnC,QAAQ,EAAE,MAAM,CAAC,SAAS;SAC3B,CAAC;QACF,KAAK,CAAC,KAAK,IAAI,CAAC,CAAC;QACjB,IAAI,MAAM,CAAC,SAAS,GAAG,KAAK,CAAC,QAAQ;YAAE,KAAK,CAAC,QAAQ,GAAG,MAAM,CAAC,SAAS,CAAC;QACzE,IAAI,MAAM,CAAC,YAAY,EAAE,CAAC;YACxB,KAAK,CAAC,QAAQ,CAAC,GAAG,CAChB,MAAM,CAAC,YAAY,EACnB,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CACnD,CAAC;QACJ,CAAC;QACD,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;IACzC,CAAC;IACD,OAAO,CAAC,GAAG,QAAQ,CAAC;SACjB,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,EAAE;QACvB,MAAM,QAAQ,GAAG,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC;aACjC,GAAG,CAAC,CAAC,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;aAC/C,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC;aACjC,KAAK,CAAC,CAAC,EAAE,eAAe,CAAC,CAAC;QAC7B,OAAO;YACL,MAAM;YACN,KAAK,EAAE,KAAK,CAAC,KAAK;YAClB,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,OAAO,IAAI,IAAI;YACrC,QAAQ;YACR,YAAY,EAAE,KAAK,CAAC,QAAQ,CAAC,IAAI;YACjC,QAAQ,EAAE,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAE;SACjD,CAAC;IACJ,CAAC,CAAC;SACD,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC;AACzC,CAAC;AAED,SAAS,eAAe,CAAC,GAA2B;IAClD,IAAI,CAAC,GAAG,EAAE,YAAY;QAAE,OAAO,IAAI,CAAC;IACpC,MAAM,IAAI,GAAG,SAAS,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;IACzC,MAAM,IAAI,GACR,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IACxE,OAAO;QACL,MAAM,EAAE,GAAG,CAAC,UAAU;QACtB,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,8BAAsB,CAAC;QAC3C,IAAI,EAAE,IAAI,KAAK,SAAS;QACxB,SAAS,EACP,GAAG,CAAC,qBAAqB,IAAI,IAAI,CAAC,MAAM,GAAG,8BAAsB;KACpE,CAAC;AACJ,CAAC;AAED,SAAS,aAAa,CACpB,IAAkB;IAElB,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC;IAC9D,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC3C,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IACxC,IAAI,KAAK,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;QAClC,OAAO;YACL,YAAY,EAAE,OAAO;YACrB,cAAc,EAAE,eAAe,CAC7B,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAC/C;SACF,CAAC;IACJ,CAAC;IACD,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACvB,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,cAAc,EAAE,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;IAC9E,CAAC;IACD,OAAO,EAAE,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,EAAE,EAAE,CAAC;AACpD,CAAC;AAED,SAAS,SAAS,CAChB,OAAuE;IAEvE,MAAM,SAAS,GAAG,OAAO;SACtB,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,UAAU,GAAG,GAAG,CAAC;SAC3C,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,cAAc,CAAC;SACtC,MAAM,CAAC,CAAC,EAAE,EAAgB,EAAE,CAAC,OAAO,EAAE,KAAK,QAAQ,CAAC,CAAC;IACxD,MAAM,GAAG,GAAG,IAAA,gCAAa,EAAC,SAAS,EAAE,GAAG,CAAC,CAAC;IAC1C,MAAM,GAAG,GAAG,IAAA,gCAAa,EAAC,SAAS,EAAE,IAAI,CAAC,CAAC;IAC3C,OAAO,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;AAC5D,CAAC;AAED,SAAS,WAAW,CAAC,CAAa,EAAE,CAAa;IAC/C,OAAO,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;AACzD,CAAC;AAiBM,KAAK,UAAU,mBAAmB,CACvC,KAAsB,EACtB,MAAc,EACd,IAAY,EACZ,MAAY,IAAI,IAAI,EAAE;IAEtB,MAAM,KAAK,GAAG,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,4BAAoB,GAAG,kBAAU,CAAC,CAAC;IAE1E,MAAM,OAAO,GAAG;QACd,MAAM;QACN,KAAK;QACL,KAAK,EAAE,GAAG;QACV,GAAG,EAAE,IAAA,4CAAkB,EAAC,IAAI,CAAC;QAC7B,cAAc,EAAE,IAAI;KACrB,CAAC;IACF,MAAM,MAAM,GAAG,CAAC,WAAuB,EAAE,EAAE,CACzC,KAAK;SACF,KAAK,CAAC,EAAE,GAAG,OAAO,EAAE,WAAW,EAAE,KAAK,EAAE,eAAe,EAAE,CAAC;SAC1D,IAAI,CAAC,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CACpB,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAC5D,CAAC;IACN,MAAM,CAAC,OAAO,EAAE,UAAU,EAAE,MAAM,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;QACtD,KAAK;aACF,OAAO,CAAC,OAAO,CAAC;aAChB,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;QACzD,MAAM,CAAC,SAAS,CAAC;QACjB,MAAM,EAAE;KACT,CAAC,CAAC;IACH,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC;AACzC,CAAC;AAOD,SAAgB,UAAU,CAAC,EACzB,OAAO,EACP,UAAU,EACV,MAAM,GACU;IAChB,MAAM,MAAM,GAAG,UAAU;SACtB,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;SACxC,MAAM,CAAC,QAAQ,CAAC,CAAC;IACpB,MAAM,WAAW,GAAG,IAAI,GAAG,EAAU,CAAC;IACtC,KAAK,MAAM,GAAG,IAAI,CAAC,GAAG,UAAU,EAAE,GAAG,MAAM,CAAC,EAAE,CAAC;QAC7C,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE,CAAC;YAAE,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACvE,CAAC;IACD,MAAM,IAAI,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;IAC3B,OAAO;QACL,UAAU,EAAE,4BAAoB;QAChC,KAAK,EAAE,OAAO,CAAC,MAAM;QACrB,WAAW,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,IAAI;QAC9B,UAAU,EAAE,eAAe,CAAC,MAAM,CAAC;QACnC,OAAO,EAAE,UAAU,CAAC,MAAM;QAC1B,WAAW,EAAE,CAAC,GAAG,WAAW,CAAC,CAAC,IAAI,EAAE;QACpC,QAAQ,EAAE,gBAAgB,CAAC,OAAO,CAAC;QACnC,WAAW,EAAE,IAAI,EAAE,UAAU,IAAI,EAAE;QACnC,YAAY,EAAE,IAAI,EAAE,KAAK,IAAI,EAAE;QAC/B,eAAe,EAAE,eAAe,CAAC,IAAI,CAAC;QACtC,GAAG,aAAa,CAAC,UAAU,CAAC;QAC5B,OAAO,EAAE,SAAS,CAAC,OAAO,CAAC;KAC5B,CAAC;AACJ,CAAC;AAeD,MAAM,IAAI,GAAG,iEAAiE,CAAC;AAC/E,MAAM,QAAQ,GAAG,yDAAyD,CAAC;AAG3E,SAAgB,SAAS,CAAC,KAAa;IACrC,IAAI,mBAAmB,CAAC,IAAI,CAAC,KAAK,CAAC;QAAE,OAAO,QAAQ,CAAC;IACrD,IAAI,KAAK,KAAK,MAAM,IAAI,KAAK,KAAK,OAAO;QAAE,OAAO,SAAS,CAAC;IAC5D,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC;QAAE,OAAO,MAAM,CAAC;IACpC,IAAI,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC;QAAE,OAAO,MAAM,CAAC;IACxC,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,SAAS,UAAU,CAAC,KAAoC;IACtD,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,IAAI,CAAC;IACrC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC;AAC3D,CAAC;AAOD,SAAgB,kBAAkB,CAChC,UAA2B,EAC3B,UAEC,EACD,WAAqB;IAErB,MAAM,OAAO,GAAG,CAAC,KAAgC,EAAE,IAAY,EAAE,EAAE;QACjE,KAAK,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;YAC7B,MAAM,KAAK,GACT,KAAK,KAAK,MAAM;gBACd,CAAC,CAAC,GAAG,CAAC,UAAU,EAAE,CAAC,IAAI,CAAC;gBACxB,CAAC,CAAC,KAAK,KAAK,OAAO;oBACjB,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,IAAI,CAAC,CAAC;oBAC/B,CAAC,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;YACjD,IAAI,KAAK;gBAAE,OAAO,KAAK,CAAC;QAC1B,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;IACF,MAAM,QAAQ,GAAG,IAAI,GAAG,CACtB,UAAU,CAAC,UAAU;SAClB,MAAM,CACL,CAAC,SAAS,EAAE,EAAE,CACZ,SAAS,CAAC,IAAI;QACd,CAAC,SAAS,CAAC,MAAM,KAAK,OAAO;YAC3B,SAAS,CAAC,MAAM,KAAK,OAAO;YAC5B,SAAS,CAAC,MAAM,KAAK,QAAQ,CAAC,CACnC;SACA,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,GAAG,SAAS,CAAC,MAAM,IAAI,SAAS,CAAC,IAAI,EAAE,EAAE,SAAS,CAAC,CAAC,CAC5E,CAAC;IACF,MAAM,OAAO,GAA2D;QACtE,GAAG,UAAU,CAAC,QAAQ;aACnB,KAAK,CAAC,GAAG,CAAC;aACV,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;aAC5C,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,MAAe,EAAE,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QACtE,GAAG;YACD,GAAG,IAAI,GAAG,CAAC;gBACT,GAAG,UAAU,CAAC,UAAU;qBACrB,MAAM,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,KAAK,OAAO,IAAI,SAAS,CAAC,IAAI,CAAC;qBACrE,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,IAAc,CAAC;gBAC/C,GAAG,WAAW;aACf,CAAC;SACH;aACE,IAAI,EAAE;aACN,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,OAAgB,EAAE,IAAI,EAAE,CAAC,CAAC;QAClD,GAAG,UAAU,CAAC,UAAU;aACrB,MAAM,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,KAAK,QAAQ,IAAI,SAAS,CAAC,IAAI,CAAC;aACtE,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;YACnB,EAAE,EAAE,QAAiB;YACrB,IAAI,EAAE,SAAS,CAAC,IAAc;SAC/B,CAAC,CAAC;KACN,CAAC;IACF,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;QAC3B,MAAM,MAAM,GAAG,KAAK,CAAC,EAAE,KAAK,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;QACxD,MAAM,SAAS,GAAG,QAAQ,CAAC,GAAG,CAAC,GAAG,MAAM,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;QAC1D,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,EAAE,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;QAC5C,IAAI,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;QAC/C,IAAI,SAAS,EAAE,KAAK;YAAE,IAAI,GAAG,GAAG,IAAI,IAAI,CAAC;aACpC,IACH,SAAS;YACT,SAAS,CAAC,YAAY,KAAK,QAAQ;YACnC,SAAS,CAAC,YAAY,KAAK,SAAS;YAEpC,IAAI,GAAG,SAAS,CAAC,YAAY,CAAC;QAChC,OAAO;YACL,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,EAAE,EAAE,KAAK,CAAC,EAAE;YACZ,IAAI;YACJ,OAAO,EAAE,KAAK;YACd,QAAQ,EAAE,SAAS,KAAK,SAAS;YACjC,QAAQ,EAAE,KAAK,CAAC,EAAE,KAAK,MAAM;SAC9B,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC"}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import type { RequestLogSample } from "@/db/models/request_log.model";
|
|
2
|
+
import { type HealthEvaluation, type HealthVerdict, type Incident } from "./health-rules";
|
|
3
|
+
import { type TrafficBucket } from "./traffic";
|
|
4
|
+
import type { TimeRange } from "./window";
|
|
5
|
+
export type RouteIssue = "failing" | "slow" | "client-errors";
|
|
6
|
+
export type RouteState = RouteIssue | "recovered" | "healthy" | "idle";
|
|
7
|
+
export interface ErrorGroup {
|
|
8
|
+
status: number;
|
|
9
|
+
message: string | null;
|
|
10
|
+
count: number;
|
|
11
|
+
first: Date;
|
|
12
|
+
last: Date;
|
|
13
|
+
}
|
|
14
|
+
export interface RouteHealth {
|
|
15
|
+
key: string;
|
|
16
|
+
method: string;
|
|
17
|
+
uri: string;
|
|
18
|
+
traffic: TrafficBucket;
|
|
19
|
+
issue: RouteIssue | null;
|
|
20
|
+
errors: ErrorGroup[];
|
|
21
|
+
}
|
|
22
|
+
export interface RouteHealthState extends RouteHealth {
|
|
23
|
+
state: RouteState;
|
|
24
|
+
verdict: HealthVerdict;
|
|
25
|
+
incident: Incident | null;
|
|
26
|
+
durationMs: number | null;
|
|
27
|
+
windows: HealthEvaluation["windows"];
|
|
28
|
+
p95Ms: number | null;
|
|
29
|
+
lastCall: Date;
|
|
30
|
+
}
|
|
31
|
+
export declare function issueOf(traffic: TrafficBucket, slowThresholdMs: number): RouteIssue | null;
|
|
32
|
+
export declare function sortErrorGroups(groups: Iterable<ErrorGroup>): ErrorGroup[];
|
|
33
|
+
export declare function computeRouteHealth(samples: RequestLogSample[], slowThresholdMs?: number): Map<string, RouteHealth>;
|
|
34
|
+
export declare function evaluateRoutes(samples: RequestLogSample[], lookback: TimeRange, slowThresholdMs?: number): Map<string, RouteHealthState>;
|
|
35
|
+
export declare function routesNeedingAttention(health: Iterable<RouteHealthState>): RouteHealthState[];
|