@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
|
@@ -2,8 +2,10 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.queryRequestLogsScoped = queryRequestLogsScoped;
|
|
4
4
|
exports.getRequestLog = getRequestLog;
|
|
5
|
-
exports.
|
|
5
|
+
exports.getRouteLatency = getRouteLatency;
|
|
6
6
|
const types_1 = require("@/types");
|
|
7
|
+
const memo_1 = require("../../memo");
|
|
8
|
+
const statistics_utils_1 = require("../statistics-utils");
|
|
7
9
|
const UNBOUNDED_SCAN_FLOOR_MS = 30 * types_1.MS_PER_DAY;
|
|
8
10
|
function queryRequestLogsScoped(model, filters, keys) {
|
|
9
11
|
if (!keys)
|
|
@@ -19,8 +21,49 @@ function queryRequestLogsScoped(model, filters, keys) {
|
|
|
19
21
|
async function getRequestLog(model, id) {
|
|
20
22
|
return model.get(id);
|
|
21
23
|
}
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
24
|
+
const ROUTE_LATENCY_WINDOW_DAYS = 7;
|
|
25
|
+
const routeLatencies = (0, memo_1.createMemo)(64, 60_000);
|
|
26
|
+
function daysLatency(days, firstDay) {
|
|
27
|
+
const histogram = (0, statistics_utils_1.emptyHistogram)();
|
|
28
|
+
let min = Infinity;
|
|
29
|
+
let max = 0;
|
|
30
|
+
for (const day of days) {
|
|
31
|
+
if (day.day < firstDay || day.timedRequestsCount === 0)
|
|
32
|
+
continue;
|
|
33
|
+
day.latencyHistogram.forEach((count, index) => {
|
|
34
|
+
histogram[index] += count;
|
|
35
|
+
});
|
|
36
|
+
min = Math.min(min, day.minResponseTime);
|
|
37
|
+
max = Math.max(max, day.maxResponseTime);
|
|
38
|
+
}
|
|
39
|
+
return { histogram, range: { min, max } };
|
|
40
|
+
}
|
|
41
|
+
function getRouteLatency(sources, route, slowThresholdMs, now = new Date()) {
|
|
42
|
+
const key = `${route.method} ${route.uri} ${slowThresholdMs}`;
|
|
43
|
+
return routeLatencies.cached(key, async () => {
|
|
44
|
+
const since = new Date(now.getTime() - ROUTE_LATENCY_WINDOW_DAYS * types_1.MS_PER_DAY);
|
|
45
|
+
const firstDay = new Date(since).setHours(0, 0, 0, 0);
|
|
46
|
+
const [rollup, slow] = await Promise.all([
|
|
47
|
+
sources.stats.getByRoute(route.method, route.uri),
|
|
48
|
+
sources.logs.list({
|
|
49
|
+
routeMethod: route.method,
|
|
50
|
+
uri: route.uri,
|
|
51
|
+
since,
|
|
52
|
+
apiTrafficOnly: true,
|
|
53
|
+
slowThresholdMs,
|
|
54
|
+
}, { limit: 0 }),
|
|
55
|
+
]);
|
|
56
|
+
const { histogram, range } = daysLatency(rollup?.statistics ?? [], firstDay);
|
|
57
|
+
const p50 = (0, statistics_utils_1.histogramQuantile)(histogram, 0.5, range);
|
|
58
|
+
const p95 = (0, statistics_utils_1.histogramQuantile)(histogram, 0.95, range);
|
|
59
|
+
if (p50 === null || p95 === null)
|
|
60
|
+
return null;
|
|
61
|
+
return {
|
|
62
|
+
windowDays: ROUTE_LATENCY_WINDOW_DAYS,
|
|
63
|
+
p50,
|
|
64
|
+
p95,
|
|
65
|
+
slow: slow.total,
|
|
66
|
+
};
|
|
67
|
+
});
|
|
25
68
|
}
|
|
26
69
|
//# sourceMappingURL=read.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"read.js","sourceRoot":"","sources":["../../../src/services/request-log/read.ts"],"names":[],"mappings":";;
|
|
1
|
+
{"version":3,"file":"read.js","sourceRoot":"","sources":["../../../src/services/request-log/read.ts"],"names":[],"mappings":";;AAgCA,wDAsBC;AAED,sCAKC;AAiDD,0CAuCC;AA/ID,mCAAyD;AACzD,qCAAwC;AACxC,0DAAwE;AAQxE,MAAM,uBAAuB,GAAG,EAAE,GAAG,kBAAU,CAAC;AAgBhD,SAAgB,sBAAsB,CACpC,KAAsB,EACtB,OAA0B,EAC1B,IAAoC;IAEpC,IAAI,CAAC,IAAI;QAAE,OAAO,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAKvC,IAAI,IAAI,CAAC,IAAI,KAAK,CAAC;QACjB,OAAO,OAAO,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC;IAC5D,OAAO,KAAK,CAAC,KAAK,CAAC;QAMjB,KAAK,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,uBAAuB,CAAC;QACrD,GAAG,OAAO;QACV,SAAS,EAAE,CAAC,GAAG,IAAI,CAAC;KACrB,CAAC,CAAC;AACL,CAAC;AAEM,KAAK,UAAU,aAAa,CACjC,KAAsB,EACtB,EAAU;IAEV,OAAO,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;AACvB,CAAC;AAGD,MAAM,yBAAyB,GAAG,CAAC,CAAC;AAsBpC,MAAM,cAAc,GAAG,IAAA,iBAAU,EAAC,EAAE,EAAE,MAAM,CAAC,CAAC;AAG9C,SAAS,WAAW,CAAC,IAA8B,EAAE,QAAgB;IACnE,MAAM,SAAS,GAAG,IAAA,iCAAc,GAAE,CAAC;IACnC,IAAI,GAAG,GAAG,QAAQ,CAAC;IACnB,IAAI,GAAG,GAAG,CAAC,CAAC;IACZ,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,IAAI,GAAG,CAAC,GAAG,GAAG,QAAQ,IAAI,GAAG,CAAC,kBAAkB,KAAK,CAAC;YAAE,SAAS;QACjE,GAAG,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;YAC5C,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC;QAC5B,CAAC,CAAC,CAAC;QACH,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,eAAe,CAAC,CAAC;QACzC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,eAAe,CAAC,CAAC;IAC3C,CAAC;IACD,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC;AAC5C,CAAC;AAQD,SAAgB,eAAe,CAC7B,OAA4B,EAC5B,KAAsC,EACtC,eAAuB,EACvB,MAAY,IAAI,IAAI,EAAE;IAEtB,MAAM,GAAG,GAAG,GAAG,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,eAAe,EAAE,CAAC;IAC9D,OAAO,cAAc,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,IAAI,EAAE;QAC3C,MAAM,KAAK,GAAG,IAAI,IAAI,CACpB,GAAG,CAAC,OAAO,EAAE,GAAG,yBAAyB,GAAG,kBAAU,CACvD,CAAC;QACF,MAAM,QAAQ,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QACtD,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YACvC,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,CAAC;YACjD,OAAO,CAAC,IAAI,CAAC,IAAI,CACf;gBACE,WAAW,EAAE,KAAK,CAAC,MAAM;gBACzB,GAAG,EAAE,KAAK,CAAC,GAAG;gBACd,KAAK;gBACL,cAAc,EAAE,IAAI;gBACpB,eAAe;aAChB,EACD,EAAE,KAAK,EAAE,CAAC,EAAE,CACb;SACF,CAAC,CAAC;QACH,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,WAAW,CACtC,MAAM,EAAE,UAAU,IAAI,EAAE,EACxB,QAAQ,CACT,CAAC;QACF,MAAM,GAAG,GAAG,IAAA,oCAAiB,EAAC,SAAS,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;QACrD,MAAM,GAAG,GAAG,IAAA,oCAAiB,EAAC,SAAS,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;QACtD,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,IAAI;YAAE,OAAO,IAAI,CAAC;QAC9C,OAAO;YACL,UAAU,EAAE,yBAAyB;YACrC,GAAG;YACH,GAAG;YACH,IAAI,EAAE,IAAI,CAAC,KAAK;SACjB,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC"}
|
|
@@ -1,4 +1,17 @@
|
|
|
1
|
+
export declare const REDACTED_KEY_WORDS: readonly string[];
|
|
1
2
|
export declare function isSensitiveKey(key: string): boolean;
|
|
2
|
-
export declare function
|
|
3
|
-
export declare function
|
|
4
|
-
export declare function
|
|
3
|
+
export declare function isSensitiveHeader(name: string): boolean;
|
|
4
|
+
export declare function passesLuhn(digits: string): boolean;
|
|
5
|
+
export declare function isCardNumber(digits: string): boolean;
|
|
6
|
+
export interface Redacted<T> {
|
|
7
|
+
value: T;
|
|
8
|
+
redacted: number;
|
|
9
|
+
}
|
|
10
|
+
export declare function redactValue(value: unknown): Redacted<unknown>;
|
|
11
|
+
export declare function redactSearchParams(params: URLSearchParams): Redacted<URLSearchParams>;
|
|
12
|
+
export interface SanitizedBody {
|
|
13
|
+
text?: string;
|
|
14
|
+
omitted?: "not-json" | "malformed";
|
|
15
|
+
redacted: number;
|
|
16
|
+
}
|
|
17
|
+
export declare function sanitizeBody(body: unknown, contentType: string): SanitizedBody;
|
|
@@ -1,53 +1,175 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.REDACTED_KEY_WORDS = void 0;
|
|
3
4
|
exports.isSensitiveKey = isSensitiveKey;
|
|
5
|
+
exports.isSensitiveHeader = isSensitiveHeader;
|
|
6
|
+
exports.passesLuhn = passesLuhn;
|
|
7
|
+
exports.isCardNumber = isCardNumber;
|
|
4
8
|
exports.redactValue = redactValue;
|
|
5
9
|
exports.redactSearchParams = redactSearchParams;
|
|
6
10
|
exports.sanitizeBody = sanitizeBody;
|
|
11
|
+
const constants_1 = require("@/types/constants");
|
|
7
12
|
const REDACTED = "[REDACTED]";
|
|
8
13
|
const MAX_REDACTION_DEPTH = 32;
|
|
9
|
-
const
|
|
14
|
+
const KEY_RULES = [
|
|
15
|
+
["password", "anywhere"],
|
|
16
|
+
["passwd", "anywhere"],
|
|
17
|
+
["secret", "anywhere"],
|
|
18
|
+
["authorization", "anywhere"],
|
|
19
|
+
["cookie", "anywhere"],
|
|
20
|
+
["apikey", "anywhere"],
|
|
21
|
+
["privatekey", "anywhere"],
|
|
22
|
+
["credential", "anywhere"],
|
|
23
|
+
["recoverycode", "anywhere"],
|
|
24
|
+
["backupcode", "anywhere"],
|
|
25
|
+
["cardnumber", "anywhere"],
|
|
26
|
+
["securitycode", "anywhere"],
|
|
27
|
+
["pincode", "anywhere"],
|
|
28
|
+
["token", "suffix"],
|
|
29
|
+
["otp", "suffix"],
|
|
30
|
+
["cvc", "suffix"],
|
|
31
|
+
["cvv", "suffix"],
|
|
32
|
+
["cvn", "suffix"],
|
|
33
|
+
["iban", "suffix"],
|
|
34
|
+
["pin", "word"],
|
|
35
|
+
["pan", "word"],
|
|
36
|
+
["ssn", "word"],
|
|
37
|
+
["card", "last"],
|
|
38
|
+
];
|
|
39
|
+
exports.REDACTED_KEY_WORDS = KEY_RULES.map(([word]) => word);
|
|
40
|
+
function keyWords(key) {
|
|
41
|
+
return (key
|
|
42
|
+
.replace(/([a-z0-9])([A-Z])/g, "$1 $2")
|
|
43
|
+
.replace(/([A-Z]+)([A-Z][a-z])/g, "$1 $2")
|
|
44
|
+
.toLowerCase()
|
|
45
|
+
.match(/[a-z]+|[0-9]+/g) ?? []);
|
|
46
|
+
}
|
|
10
47
|
function isSensitiveKey(key) {
|
|
11
|
-
|
|
48
|
+
const words = keyWords(key);
|
|
49
|
+
const joined = words.join("");
|
|
50
|
+
return KEY_RULES.some(([word, match]) => {
|
|
51
|
+
switch (match) {
|
|
52
|
+
case "anywhere":
|
|
53
|
+
return joined.includes(word);
|
|
54
|
+
case "suffix":
|
|
55
|
+
return words.some((each) => each.endsWith(word));
|
|
56
|
+
case "word":
|
|
57
|
+
return words.includes(word);
|
|
58
|
+
case "last":
|
|
59
|
+
return words.at(-1) === word;
|
|
60
|
+
}
|
|
61
|
+
});
|
|
62
|
+
}
|
|
63
|
+
function isSensitiveHeader(name) {
|
|
64
|
+
return name.toLowerCase() === constants_1.TESTER_SOURCE_HEADER || isSensitiveKey(name);
|
|
12
65
|
}
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
66
|
+
const CARD_NUMBER = /(?<![0-9])[2-6](?:[ -]?[0-9]){12,18}(?![0-9])/g;
|
|
67
|
+
function passesLuhn(digits) {
|
|
68
|
+
let sum = 0;
|
|
69
|
+
for (let index = 0; index < digits.length; index++) {
|
|
70
|
+
let digit = Number(digits[digits.length - 1 - index]);
|
|
71
|
+
if (index % 2 === 1) {
|
|
72
|
+
digit *= 2;
|
|
73
|
+
if (digit > 9)
|
|
74
|
+
digit -= 9;
|
|
75
|
+
}
|
|
76
|
+
sum += digit;
|
|
18
77
|
}
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
78
|
+
return sum % 10 === 0;
|
|
79
|
+
}
|
|
80
|
+
const CARD_NETWORKS = [
|
|
81
|
+
{ prefix: /^4/, lengths: [13, 16, 19] },
|
|
82
|
+
{
|
|
83
|
+
prefix: /^(?:5[1-5]|222[1-9]|22[3-9][0-9]|2[3-6][0-9]{2}|27[01][0-9]|2720)/,
|
|
84
|
+
lengths: [16],
|
|
85
|
+
},
|
|
86
|
+
{ prefix: /^3[47]/, lengths: [15] },
|
|
87
|
+
{ prefix: /^(?:6011|64[4-9]|65)/, lengths: [16, 17, 18, 19] },
|
|
88
|
+
{ prefix: /^35(?:2[89]|[3-8][0-9])/, lengths: [16, 17, 18, 19] },
|
|
89
|
+
{ prefix: /^62/, lengths: [16, 17, 18, 19] },
|
|
90
|
+
{ prefix: /^3(?:0[0-5]|[689])/, lengths: [14, 15, 16, 17, 18, 19] },
|
|
91
|
+
];
|
|
92
|
+
function isCardNumber(digits) {
|
|
93
|
+
return (CARD_NETWORKS.some(({ prefix, lengths }) => lengths.includes(digits.length) && prefix.test(digits)) && passesLuhn(digits));
|
|
94
|
+
}
|
|
95
|
+
class Redactor {
|
|
96
|
+
count = 0;
|
|
97
|
+
text(text) {
|
|
98
|
+
return text.replace(CARD_NUMBER, (match) => {
|
|
99
|
+
if (!isCardNumber(match.replace(/[ -]/g, "")))
|
|
100
|
+
return match;
|
|
101
|
+
this.count++;
|
|
102
|
+
return REDACTED;
|
|
103
|
+
});
|
|
104
|
+
}
|
|
105
|
+
value(value, depth = 0) {
|
|
106
|
+
if (depth >= MAX_REDACTION_DEPTH) {
|
|
107
|
+
this.count++;
|
|
108
|
+
return REDACTED;
|
|
109
|
+
}
|
|
110
|
+
if (Array.isArray(value)) {
|
|
111
|
+
return value.map((item) => this.value(item, depth + 1));
|
|
112
|
+
}
|
|
113
|
+
if (typeof value === "string")
|
|
114
|
+
return this.text(value);
|
|
115
|
+
if (typeof value === "number" && Number.isSafeInteger(value)) {
|
|
116
|
+
const redacted = this.text(String(value));
|
|
117
|
+
return redacted === REDACTED ? redacted : value;
|
|
118
|
+
}
|
|
119
|
+
if (value === null || typeof value !== "object")
|
|
120
|
+
return value;
|
|
121
|
+
return Object.fromEntries(Object.entries(value).map(([key, item]) => {
|
|
122
|
+
if (!isSensitiveKey(key))
|
|
123
|
+
return [key, this.value(item, depth + 1)];
|
|
124
|
+
this.count++;
|
|
125
|
+
return [key, REDACTED];
|
|
126
|
+
}));
|
|
127
|
+
}
|
|
128
|
+
params(params) {
|
|
129
|
+
return new URLSearchParams([...params].map(([key, value]) => {
|
|
130
|
+
if (!isSensitiveKey(key))
|
|
131
|
+
return [key, this.text(value)];
|
|
132
|
+
this.count++;
|
|
133
|
+
return [key, REDACTED];
|
|
134
|
+
}));
|
|
135
|
+
}
|
|
136
|
+
}
|
|
137
|
+
function redactWith(redact) {
|
|
138
|
+
const redactor = new Redactor();
|
|
139
|
+
const value = redact(redactor);
|
|
140
|
+
return { value, redacted: redactor.count };
|
|
141
|
+
}
|
|
142
|
+
function redactValue(value) {
|
|
143
|
+
return redactWith((redactor) => redactor.value(value));
|
|
25
144
|
}
|
|
26
145
|
function redactSearchParams(params) {
|
|
27
|
-
return
|
|
28
|
-
key,
|
|
29
|
-
isSensitiveKey(key) ? REDACTED : value,
|
|
30
|
-
]));
|
|
146
|
+
return redactWith((redactor) => redactor.params(params));
|
|
31
147
|
}
|
|
32
148
|
function sanitizeBody(body, contentType) {
|
|
33
149
|
const mediaType = contentType.split(";")[0].trim().toLowerCase();
|
|
34
150
|
const text = Buffer.isBuffer(body) ? body.toString("utf8") : body;
|
|
151
|
+
const isForm = mediaType === "application/x-www-form-urlencoded";
|
|
152
|
+
if (!isForm &&
|
|
153
|
+
mediaType !== "application/json" &&
|
|
154
|
+
!mediaType.endsWith("+json")) {
|
|
155
|
+
return { omitted: "not-json", redacted: 0 };
|
|
156
|
+
}
|
|
35
157
|
try {
|
|
36
|
-
if (
|
|
158
|
+
if (isForm) {
|
|
37
159
|
if (typeof text !== "string")
|
|
38
|
-
return
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
if (mediaType !== "application/json" && !mediaType.endsWith("+json")) {
|
|
42
|
-
return undefined;
|
|
160
|
+
return { omitted: "malformed", redacted: 0 };
|
|
161
|
+
const { value, redacted } = redactSearchParams(new URLSearchParams(text));
|
|
162
|
+
return { text: value.toString(), redacted };
|
|
43
163
|
}
|
|
44
164
|
const parsed = typeof text === "string" ? JSON.parse(text) : text;
|
|
45
|
-
if (parsed === null || typeof parsed !== "object")
|
|
46
|
-
return
|
|
47
|
-
|
|
165
|
+
if (parsed === null || typeof parsed !== "object") {
|
|
166
|
+
return { omitted: "not-json", redacted: 0 };
|
|
167
|
+
}
|
|
168
|
+
const { value, redacted } = redactValue(parsed);
|
|
169
|
+
return { text: JSON.stringify(value), redacted };
|
|
48
170
|
}
|
|
49
171
|
catch {
|
|
50
|
-
return
|
|
172
|
+
return { omitted: "malformed", redacted: 0 };
|
|
51
173
|
}
|
|
52
174
|
}
|
|
53
175
|
//# sourceMappingURL=redaction.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"redaction.js","sourceRoot":"","sources":["../../../src/services/request-log/redaction.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"redaction.js","sourceRoot":"","sources":["../../../src/services/request-log/redaction.ts"],"names":[],"mappings":";;;AAoEA,wCAeC;AAMD,8CAEC;AAWD,gCAWC;AAsBD,oCAOC;AAiED,kCAEC;AAGD,gDAIC;AAUD,oCA+BC;AAjQD,iDAAyD;AAEzD,MAAM,QAAQ,GAAG,YAAY,CAAC;AAC9B,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAkB/B,MAAM,SAAS,GAA+C;IAC5D,CAAC,UAAU,EAAE,UAAU,CAAC;IACxB,CAAC,QAAQ,EAAE,UAAU,CAAC;IACtB,CAAC,QAAQ,EAAE,UAAU,CAAC;IACtB,CAAC,eAAe,EAAE,UAAU,CAAC;IAC7B,CAAC,QAAQ,EAAE,UAAU,CAAC;IACtB,CAAC,QAAQ,EAAE,UAAU,CAAC;IACtB,CAAC,YAAY,EAAE,UAAU,CAAC;IAC1B,CAAC,YAAY,EAAE,UAAU,CAAC;IAC1B,CAAC,cAAc,EAAE,UAAU,CAAC;IAC5B,CAAC,YAAY,EAAE,UAAU,CAAC;IAC1B,CAAC,YAAY,EAAE,UAAU,CAAC;IAC1B,CAAC,cAAc,EAAE,UAAU,CAAC;IAC5B,CAAC,SAAS,EAAE,UAAU,CAAC;IACvB,CAAC,OAAO,EAAE,QAAQ,CAAC;IACnB,CAAC,KAAK,EAAE,QAAQ,CAAC;IACjB,CAAC,KAAK,EAAE,QAAQ,CAAC;IACjB,CAAC,KAAK,EAAE,QAAQ,CAAC;IACjB,CAAC,KAAK,EAAE,QAAQ,CAAC;IACjB,CAAC,MAAM,EAAE,QAAQ,CAAC;IAClB,CAAC,KAAK,EAAE,MAAM,CAAC;IACf,CAAC,KAAK,EAAE,MAAM,CAAC;IACf,CAAC,KAAK,EAAE,MAAM,CAAC;IACf,CAAC,MAAM,EAAE,MAAM,CAAC;CACjB,CAAC;AAOW,QAAA,kBAAkB,GAAsB,SAAS,CAAC,GAAG,CAChE,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,CACjB,CAAC;AAGF,SAAS,QAAQ,CAAC,GAAW;IAC3B,OAAO,CACL,GAAG;SACA,OAAO,CAAC,oBAAoB,EAAE,OAAO,CAAC;SACtC,OAAO,CAAC,uBAAuB,EAAE,OAAO,CAAC;SACzC,WAAW,EAAE;SACb,KAAK,CAAC,gBAAgB,CAAC,IAAI,EAAE,CACjC,CAAC;AACJ,CAAC;AAGD,SAAgB,cAAc,CAAC,GAAW;IACxC,MAAM,KAAK,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;IAC5B,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC9B,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE;QACtC,QAAQ,KAAK,EAAE,CAAC;YACd,KAAK,UAAU;gBACb,OAAO,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC/B,KAAK,QAAQ;gBACX,OAAO,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;YACnD,KAAK,MAAM;gBACT,OAAO,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC9B,KAAK,MAAM;gBACT,OAAO,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;QACjC,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AAMD,SAAgB,iBAAiB,CAAC,IAAY;IAC5C,OAAO,IAAI,CAAC,WAAW,EAAE,KAAK,gCAAoB,IAAI,cAAc,CAAC,IAAI,CAAC,CAAC;AAC7E,CAAC;AAQD,MAAM,WAAW,GAAG,gDAAgD,CAAC;AAGrE,SAAgB,UAAU,CAAC,MAAc;IACvC,IAAI,GAAG,GAAG,CAAC,CAAC;IACZ,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC;QACnD,IAAI,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC;QACtD,IAAI,KAAK,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;YACpB,KAAK,IAAI,CAAC,CAAC;YACX,IAAI,KAAK,GAAG,CAAC;gBAAE,KAAK,IAAI,CAAC,CAAC;QAC5B,CAAC;QACD,GAAG,IAAI,KAAK,CAAC;IACf,CAAC;IACD,OAAO,GAAG,GAAG,EAAE,KAAK,CAAC,CAAC;AACxB,CAAC;AAQD,MAAM,aAAa,GAAyD;IAC1E,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE;IACvC;QACE,MAAM,EAAE,mEAAmE;QAC3E,OAAO,EAAE,CAAC,EAAE,CAAC;KACd;IACD,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC,EAAE;IACnC,EAAE,MAAM,EAAE,sBAAsB,EAAE,OAAO,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE;IAC7D,EAAE,MAAM,EAAE,yBAAyB,EAAE,OAAO,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE;IAChE,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE;IAC5C,EAAE,MAAM,EAAE,oBAAoB,EAAE,OAAO,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE;CACpE,CAAC;AAGF,SAAgB,YAAY,CAAC,MAAc;IACzC,OAAO,CACL,aAAa,CAAC,IAAI,CAChB,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,EAAE,CACtB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CACzD,IAAI,UAAU,CAAC,MAAM,CAAC,CACxB,CAAC;AACJ,CAAC;AAGD,MAAM,QAAQ;IACZ,KAAK,GAAG,CAAC,CAAC;IAGV,IAAI,CAAC,IAAY;QACf,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,KAAK,EAAE,EAAE;YACzC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;gBAAE,OAAO,KAAK,CAAC;YAC5D,IAAI,CAAC,KAAK,EAAE,CAAC;YACb,OAAO,QAAQ,CAAC;QAClB,CAAC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,KAAc,EAAE,KAAK,GAAG,CAAC;QAC7B,IAAI,KAAK,IAAI,mBAAmB,EAAE,CAAC;YACjC,IAAI,CAAC,KAAK,EAAE,CAAC;YACb,OAAO,QAAQ,CAAC;QAClB,CAAC;QACD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;QAC1D,CAAC;QACD,IAAI,OAAO,KAAK,KAAK,QAAQ;YAAE,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACvD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;YAC7D,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YAC1C,OAAO,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC;QAClD,CAAC;QACD,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ;YAAE,OAAO,KAAK,CAAC;QAC9D,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,EAAE;YACxC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC;gBAAE,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;YACpE,IAAI,CAAC,KAAK,EAAE,CAAC;YACb,OAAO,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;QACzB,CAAC,CAAC,CACH,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,MAAuB;QAC5B,OAAO,IAAI,eAAe,CACxB,CAAC,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;YAC/B,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC;gBAAE,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;YACzD,IAAI,CAAC,KAAK,EAAE,CAAC;YACb,OAAO,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;QACzB,CAAC,CAAC,CACH,CAAC;IACJ,CAAC;CACF;AAQD,SAAS,UAAU,CAAI,MAAiC;IACtD,MAAM,QAAQ,GAAG,IAAI,QAAQ,EAAE,CAAC;IAChC,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC;IAC/B,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,CAAC,KAAK,EAAE,CAAC;AAC7C,CAAC;AAMD,SAAgB,WAAW,CAAC,KAAc;IACxC,OAAO,UAAU,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;AACzD,CAAC;AAGD,SAAgB,kBAAkB,CAChC,MAAuB;IAEvB,OAAO,UAAU,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;AAC3D,CAAC;AAUD,SAAgB,YAAY,CAC1B,IAAa,EACb,WAAmB;IAEnB,MAAM,SAAS,GAAG,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;IACjE,MAAM,IAAI,GAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAClE,MAAM,MAAM,GAAG,SAAS,KAAK,mCAAmC,CAAC;IACjE,IACE,CAAC,MAAM;QACP,SAAS,KAAK,kBAAkB;QAChC,CAAC,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,EAC5B,CAAC;QACD,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC;IAC9C,CAAC;IACD,IAAI,CAAC;QACH,IAAI,MAAM,EAAE,CAAC;YACX,IAAI,OAAO,IAAI,KAAK,QAAQ;gBAC1B,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC;YAC/C,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,kBAAkB,CAAC,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC;YAC1E,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC,QAAQ,EAAE,EAAE,QAAQ,EAAE,CAAC;QAC9C,CAAC;QACD,MAAM,MAAM,GAAY,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAE3E,IAAI,MAAM,KAAK,IAAI,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;YAClD,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC;QAC9C,CAAC;QACD,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC;QAChD,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,QAAQ,EAAE,CAAC;IACnD,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC;IAC/C,CAAC;AACH,CAAC"}
|
|
@@ -1,12 +1,19 @@
|
|
|
1
1
|
import type { IncomingHttpHeaders } from "node:http";
|
|
2
|
-
|
|
3
|
-
export declare function
|
|
2
|
+
import type { RequestLogBodyOmission } from "@/db/tables/request_log.table";
|
|
3
|
+
export declare function pickHeaders(headers: IncomingHttpHeaders | Record<string, string | string[] | undefined>, allowList: ReadonlyArray<string>, dropped?: string[]): Record<string, string>;
|
|
4
4
|
export interface CapturedBody {
|
|
5
5
|
body?: string;
|
|
6
6
|
truncated: boolean;
|
|
7
|
+
omitted?: RequestLogBodyOmission;
|
|
8
|
+
redacted: number;
|
|
9
|
+
size?: number;
|
|
7
10
|
}
|
|
11
|
+
export declare function omittedBody(reason: RequestLogBodyOmission): CapturedBody;
|
|
8
12
|
export declare function captureBody(body: unknown, contentType: string | undefined, maxBytes: number): CapturedBody;
|
|
9
|
-
export declare function queryToRecord(url: URL):
|
|
13
|
+
export declare function queryToRecord(url: URL): {
|
|
14
|
+
query: Record<string, string | string[]>;
|
|
15
|
+
redacted: number;
|
|
16
|
+
};
|
|
10
17
|
export declare function extractStatusCode(value: unknown): number;
|
|
11
18
|
export declare function extractBody(value: unknown): unknown;
|
|
12
19
|
export declare function extractContentType(value: unknown): string | undefined;
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.pickHeaders = pickHeaders;
|
|
4
|
-
exports.
|
|
4
|
+
exports.omittedBody = omittedBody;
|
|
5
5
|
exports.captureBody = captureBody;
|
|
6
6
|
exports.queryToRecord = queryToRecord;
|
|
7
7
|
exports.extractStatusCode = extractStatusCode;
|
|
@@ -10,47 +10,64 @@ exports.extractContentType = extractContentType;
|
|
|
10
10
|
exports.extractHeaders = extractHeaders;
|
|
11
11
|
const constants_1 = require("@/types/constants");
|
|
12
12
|
const redaction_1 = require("./redaction");
|
|
13
|
-
function pickHeaders(headers, allowList) {
|
|
13
|
+
function pickHeaders(headers, allowList, dropped) {
|
|
14
14
|
const out = {};
|
|
15
15
|
const allow = new Set(allowList.map((h) => h.toLowerCase()));
|
|
16
16
|
for (const [name, value] of Object.entries(headers)) {
|
|
17
|
-
if ((0, redaction_1.isSensitiveKey)(name))
|
|
18
|
-
continue;
|
|
19
17
|
if (!allow.has(name.toLowerCase()))
|
|
20
18
|
continue;
|
|
21
19
|
if (value === undefined)
|
|
22
20
|
continue;
|
|
21
|
+
if ((0, redaction_1.isSensitiveHeader)(name)) {
|
|
22
|
+
dropped?.push(name.toLowerCase());
|
|
23
|
+
continue;
|
|
24
|
+
}
|
|
23
25
|
out[name.toLowerCase()] = Array.isArray(value) ? value.join(", ") : value;
|
|
24
26
|
}
|
|
25
27
|
return out;
|
|
26
28
|
}
|
|
27
|
-
function
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
29
|
+
function omittedBody(reason) {
|
|
30
|
+
return { truncated: false, omitted: reason, redacted: 0 };
|
|
31
|
+
}
|
|
32
|
+
function isEmptyBody(body) {
|
|
33
|
+
if (body === undefined || body === null || body === "")
|
|
34
|
+
return true;
|
|
35
|
+
return Buffer.isBuffer(body) && body.length === 0;
|
|
32
36
|
}
|
|
33
37
|
function captureBody(body, contentType, maxBytes) {
|
|
34
|
-
if (body
|
|
35
|
-
return
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
38
|
+
if (isEmptyBody(body))
|
|
39
|
+
return omittedBody("empty");
|
|
40
|
+
if (maxBytes <= 0)
|
|
41
|
+
return omittedBody("disabled");
|
|
42
|
+
const sanitized = (0, redaction_1.sanitizeBody)(body, contentType ?? "");
|
|
43
|
+
if (sanitized.text === undefined) {
|
|
44
|
+
return omittedBody(sanitized.omitted ?? "not-json");
|
|
39
45
|
}
|
|
40
|
-
const text
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
46
|
+
const { text, redacted } = sanitized;
|
|
47
|
+
const bytes = Buffer.from(text, "utf8");
|
|
48
|
+
if (bytes.length > maxBytes) {
|
|
49
|
+
return {
|
|
50
|
+
body: utf8Prefix(bytes, maxBytes),
|
|
51
|
+
truncated: true,
|
|
52
|
+
redacted,
|
|
53
|
+
size: bytes.length,
|
|
54
|
+
};
|
|
45
55
|
}
|
|
46
|
-
return { body: text, truncated: false };
|
|
56
|
+
return { body: text, truncated: false, redacted };
|
|
57
|
+
}
|
|
58
|
+
function utf8Prefix(bytes, maxBytes) {
|
|
59
|
+
let end = maxBytes;
|
|
60
|
+
while (end > 0 && (bytes[end] & 0xc0) === 0x80)
|
|
61
|
+
end--;
|
|
62
|
+
return bytes.subarray(0, end).toString("utf8");
|
|
47
63
|
}
|
|
48
64
|
function queryToRecord(url) {
|
|
49
|
-
const params = (0, redaction_1.redactSearchParams)(url.searchParams);
|
|
50
|
-
|
|
65
|
+
const { value: params, redacted } = (0, redaction_1.redactSearchParams)(url.searchParams);
|
|
66
|
+
const query = Object.fromEntries([...new Set(params.keys())].map((key) => {
|
|
51
67
|
const values = params.getAll(key);
|
|
52
68
|
return [key, values.length > 1 ? values : values[0]];
|
|
53
69
|
}));
|
|
70
|
+
return { query, redacted };
|
|
54
71
|
}
|
|
55
72
|
function extractStatusCode(value) {
|
|
56
73
|
if (!value || typeof value !== "object")
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"util.js","sourceRoot":"","sources":["../../../src/services/request-log/util.ts"],"names":[],"mappings":";;
|
|
1
|
+
{"version":3,"file":"util.js","sourceRoot":"","sources":["../../../src/services/request-log/util.ts"],"names":[],"mappings":";;AAcA,kCAiBC;AAcD,kCAEC;AAOD,kCAuBC;AAYD,sCAYC;AAED,8CAiBC;AAED,kCAWC;AAED,gDAWC;AAED,wCAWC;AA7JD,iDAAmD;AACnD,2CAIqB;AAOrB,SAAgB,WAAW,CACzB,OAA4E,EAC5E,SAAgC,EAChC,OAAkB;IAElB,MAAM,GAAG,GAA2B,EAAE,CAAC;IACvC,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;IAC7D,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;QACpD,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;YAAE,SAAS;QAC7C,IAAI,KAAK,KAAK,SAAS;YAAE,SAAS;QAClC,IAAI,IAAA,6BAAiB,EAAC,IAAI,CAAC,EAAE,CAAC;YAC5B,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;YAClC,SAAS;QACX,CAAC;QACD,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IAC5E,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAcD,SAAgB,WAAW,CAAC,MAA8B;IACxD,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC;AAC5D,CAAC;AAED,SAAS,WAAW,CAAC,IAAa;IAChC,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,EAAE;QAAE,OAAO,IAAI,CAAC;IACpE,OAAO,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC;AACpD,CAAC;AAED,SAAgB,WAAW,CACzB,IAAa,EACb,WAA+B,EAC/B,QAAgB;IAEhB,IAAI,WAAW,CAAC,IAAI,CAAC;QAAE,OAAO,WAAW,CAAC,OAAO,CAAC,CAAC;IACnD,IAAI,QAAQ,IAAI,CAAC;QAAE,OAAO,WAAW,CAAC,UAAU,CAAC,CAAC;IAElD,MAAM,SAAS,GAAG,IAAA,wBAAY,EAAC,IAAI,EAAE,WAAW,IAAI,EAAE,CAAC,CAAC;IACxD,IAAI,SAAS,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QACjC,OAAO,WAAW,CAAC,SAAS,CAAC,OAAO,IAAI,UAAU,CAAC,CAAC;IACtD,CAAC;IACD,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,SAAS,CAAC;IACrC,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACxC,IAAI,KAAK,CAAC,MAAM,GAAG,QAAQ,EAAE,CAAC;QAC5B,OAAO;YACL,IAAI,EAAE,UAAU,CAAC,KAAK,EAAE,QAAQ,CAAC;YACjC,SAAS,EAAE,IAAI;YACf,QAAQ;YACR,IAAI,EAAE,KAAK,CAAC,MAAM;SACnB,CAAC;IACJ,CAAC;IACD,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC;AACpD,CAAC;AAGD,SAAS,UAAU,CAAC,KAAa,EAAE,QAAgB;IACjD,IAAI,GAAG,GAAG,QAAQ,CAAC;IAGnB,OAAO,GAAG,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,KAAK,IAAI;QAAE,GAAG,EAAE,CAAC;IACtD,OAAO,KAAK,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AACjD,CAAC;AAGD,SAAgB,aAAa,CAAC,GAAQ;IAIpC,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAA,8BAAkB,EAAC,GAAG,CAAC,YAAY,CAAC,CAAC;IACzE,MAAM,KAAK,GAAG,MAAM,CAAC,WAAW,CAC9B,CAAC,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QACtC,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAClC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IACvD,CAAC,CAAC,CACH,CAAC;IACF,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC;AAC7B,CAAC;AAED,SAAgB,iBAAiB,CAAC,KAAc;IAC9C,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,0BAAc,CAAC;IAC/D,MAAM,CAAC,GAAG,KAIT,CAAC;IACF,IAAI,OAAO,CAAC,CAAC,SAAS,KAAK,UAAU,EAAE,CAAC;QACtC,IAAI,CAAC;YACH,OAAO,CAAC,CAAC,SAAS,EAAE,CAAC;QACvB,CAAC;QAAC,MAAM,CAAC;QAET,CAAC;IACH,CAAC;IACD,IAAI,OAAO,CAAC,CAAC,UAAU,KAAK,QAAQ;QAAE,OAAO,CAAC,CAAC,UAAU,CAAC;IAC1D,IAAI,OAAO,CAAC,CAAC,MAAM,KAAK,QAAQ;QAAE,OAAO,CAAC,CAAC,MAAM,CAAC;IAClD,OAAO,0BAAc,CAAC;AACxB,CAAC;AAED,SAAgB,WAAW,CAAC,KAAc;IACxC,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,SAAS,CAAC;IAC1D,MAAM,CAAC,GAAG,KAAoD,CAAC;IAC/D,IAAI,OAAO,CAAC,CAAC,OAAO,KAAK,UAAU,EAAE,CAAC;QACpC,IAAI,CAAC;YACH,OAAO,CAAC,CAAC,OAAO,EAAE,CAAC;QACrB,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,SAAS,CAAC;QACnB,CAAC;IACH,CAAC;IACD,OAAO,CAAC,CAAC,IAAI,CAAC;AAChB,CAAC;AAED,SAAgB,kBAAkB,CAAC,KAAc;IAC/C,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,SAAS,CAAC;IAC1D,MAAM,CAAC,GAAG,KAA0C,CAAC;IACrD,IAAI,OAAO,CAAC,CAAC,cAAc,KAAK,UAAU,EAAE,CAAC;QAC3C,IAAI,CAAC;YACH,OAAO,CAAC,CAAC,cAAc,EAAE,CAAC;QAC5B,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,SAAS,CAAC;QACnB,CAAC;IACH,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAgB,cAAc,CAAC,KAAc;IAC3C,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,EAAE,CAAC;IACnD,MAAM,CAAC,GAAG,KAAsD,CAAC;IACjE,IAAI,OAAO,CAAC,CAAC,UAAU,KAAK,UAAU,EAAE,CAAC;QACvC,IAAI,CAAC;YACH,OAAO,CAAC,CAAC,UAAU,EAAE,CAAC;QACxB,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,EAAE,CAAC;QACZ,CAAC;IACH,CAAC;IACD,OAAO,EAAE,CAAC;AACZ,CAAC"}
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
import type { RequestLogModel, RouteModel, RouteStatisticsModel } from "@/db";
|
|
2
|
+
import { type RouteInspection } from "./introspection";
|
|
3
|
+
import { type DocumentedParameter, type ObservedContract, type ObservedStatus } from "./route-contract";
|
|
4
|
+
import type { ScopeKeys } from "./traffic";
|
|
5
|
+
export interface CatalogModels {
|
|
6
|
+
logs: RequestLogModel;
|
|
7
|
+
stats: RouteStatisticsModel;
|
|
8
|
+
routes: RouteModel;
|
|
9
|
+
}
|
|
10
|
+
export interface RouteRow {
|
|
11
|
+
ref: string;
|
|
12
|
+
method: string;
|
|
13
|
+
path: string;
|
|
14
|
+
folder: string;
|
|
15
|
+
controller: string | null;
|
|
16
|
+
handler: string;
|
|
17
|
+
}
|
|
18
|
+
export declare function folderOf(path: string): string;
|
|
19
|
+
export declare function countRoutes(keys: ScopeKeys): number;
|
|
20
|
+
export declare function listRoutes(keys: ScopeKeys): RouteRow[];
|
|
21
|
+
export declare function parseRouteRef(ref: string | undefined): {
|
|
22
|
+
method: string;
|
|
23
|
+
path: string;
|
|
24
|
+
} | undefined;
|
|
25
|
+
export declare function isRegisteredRoute(ref: string | undefined): boolean;
|
|
26
|
+
export declare function findRoute(ref: string | undefined): RouteInspection | undefined;
|
|
27
|
+
export interface PipelineStep {
|
|
28
|
+
kind: "prefix" | "handler" | "postfix" | "monitor";
|
|
29
|
+
name: string;
|
|
30
|
+
location: string;
|
|
31
|
+
priority?: number;
|
|
32
|
+
isAuth: boolean;
|
|
33
|
+
}
|
|
34
|
+
export declare function pipelineOf(inspection: RouteInspection): PipelineStep[];
|
|
35
|
+
export declare function requiresAuth(inspection: RouteInspection): boolean;
|
|
36
|
+
export type AuthStatus = "required" | "probable" | "unknown";
|
|
37
|
+
export interface RouteAuth {
|
|
38
|
+
status: AuthStatus;
|
|
39
|
+
guards: string[];
|
|
40
|
+
unauthorized: number;
|
|
41
|
+
}
|
|
42
|
+
export declare function authOf(inspection: RouteInspection, statuses: Array<Pick<ObservedStatus, "status" | "count">>): RouteAuth;
|
|
43
|
+
export interface RouteDetail {
|
|
44
|
+
ref: string;
|
|
45
|
+
method: string;
|
|
46
|
+
path: string;
|
|
47
|
+
folder: string;
|
|
48
|
+
controller: string | null;
|
|
49
|
+
handler: string;
|
|
50
|
+
module: string | null;
|
|
51
|
+
own: boolean | null;
|
|
52
|
+
requiresAuth: boolean;
|
|
53
|
+
auth: RouteAuth;
|
|
54
|
+
registeredAt: string | null;
|
|
55
|
+
pathParams: string[];
|
|
56
|
+
parameters: DocumentedParameter[];
|
|
57
|
+
pipeline: PipelineStep[];
|
|
58
|
+
inspection: RouteInspection;
|
|
59
|
+
contract: ObservedContract;
|
|
60
|
+
apiOrigin: string | null;
|
|
61
|
+
}
|
|
62
|
+
export declare function getRouteDetail(models: CatalogModels, ref: string, apiOrigin?: string | null, now?: Date): Promise<RouteDetail | undefined>;
|