Update hivegrid-cloud reference to latest main
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
1 parent
e98d38e716
commit
7b21524c86
3781 files changed
+373484
-225607
No files matched your search
@@ -0,0 +1,160 @@
|
||||
import { describe, it, expect } from "vitest";
|
||||
import { validateMetricsTokenAuth, redactMetricsToken } from "./auth.js";
|
||||
|
||||
/**
|
||||
* Edge cases for the constant-time token comparison and the Bearer-header
|
||||
* parser that the happy-path suite (auth.test.ts) does not exercise:
|
||||
* - tokens that share UTF-16 `.length` but differ in UTF-8 byte length,
|
||||
* - case / whitespace variations the regex must tolerate or reject,
|
||||
* - the redaction boundary at length 9 (first length not fully masked).
|
||||
*/
|
||||
describe("validateMetricsTokenAuth — multi-byte comparison", () => {
|
||||
it("rejects a token that matches in code-unit length but differs in UTF-8 bytes", () => {
|
||||
// "é" is one UTF-16 code unit but two UTF-8 bytes; "a" is one of each.
|
||||
// This passes the cheap `a.length !== b.length` guard and must still be
|
||||
// rejected by the byte-length check inside timingSafeEqualStrings.
|
||||
const result = validateMetricsTokenAuth({
|
||||
metricsEnabled: true,
|
||||
configuredToken: "a",
|
||||
authorizationHeader: "Bearer é",
|
||||
});
|
||||
expect(result).toEqual({ ok: false, status: 401, code: "invalid_token" });
|
||||
});
|
||||
|
||||
it("accepts an exactly matching multi-byte token", () => {
|
||||
const token = "tökén-Ünïcödé-✓-0123456789";
|
||||
const result = validateMetricsTokenAuth({
|
||||
metricsEnabled: true,
|
||||
configuredToken: token,
|
||||
authorizationHeader: `Bearer ${token}`,
|
||||
});
|
||||
expect(result).toEqual({ ok: true });
|
||||
});
|
||||
|
||||
it("rejects multi-byte tokens of equal code-unit length but different content", () => {
|
||||
// Both presented and configured are length 1 in UTF-16 and 2 bytes in
|
||||
// UTF-8, so the comparison reaches the per-byte XOR loop and must fail.
|
||||
const result = validateMetricsTokenAuth({
|
||||
metricsEnabled: true,
|
||||
configuredToken: "é",
|
||||
authorizationHeader: "Bearer ü",
|
||||
});
|
||||
expect(result).toEqual({ ok: false, status: 401, code: "invalid_token" });
|
||||
});
|
||||
});
|
||||
|
||||
describe("validateMetricsTokenAuth — Bearer header parsing", () => {
|
||||
const token = "abcdef0123456789abcdef0123456789";
|
||||
|
||||
it("accepts a lowercase 'bearer' scheme (case-insensitive)", () => {
|
||||
expect(
|
||||
validateMetricsTokenAuth({
|
||||
metricsEnabled: true,
|
||||
configuredToken: token,
|
||||
authorizationHeader: `bearer ${token}`,
|
||||
}),
|
||||
).toEqual({ ok: true });
|
||||
});
|
||||
|
||||
it("tolerates surrounding and trailing whitespace around the header", () => {
|
||||
expect(
|
||||
validateMetricsTokenAuth({
|
||||
metricsEnabled: true,
|
||||
configuredToken: token,
|
||||
authorizationHeader: ` Bearer ${token} `,
|
||||
}),
|
||||
).toEqual({ ok: true });
|
||||
});
|
||||
|
||||
it("accepts multiple spaces between scheme and token", () => {
|
||||
expect(
|
||||
validateMetricsTokenAuth({
|
||||
metricsEnabled: true,
|
||||
configuredToken: token,
|
||||
authorizationHeader: `Bearer ${token}`,
|
||||
}),
|
||||
).toEqual({ ok: true });
|
||||
});
|
||||
|
||||
it("treats a scheme with no token as missing_token", () => {
|
||||
expect(
|
||||
validateMetricsTokenAuth({
|
||||
metricsEnabled: true,
|
||||
configuredToken: token,
|
||||
authorizationHeader: "Bearer",
|
||||
}),
|
||||
).toEqual({ ok: false, status: 401, code: "missing_token" });
|
||||
});
|
||||
|
||||
it("treats a scheme followed only by whitespace as missing_token", () => {
|
||||
expect(
|
||||
validateMetricsTokenAuth({
|
||||
metricsEnabled: true,
|
||||
configuredToken: token,
|
||||
authorizationHeader: "Bearer ",
|
||||
}),
|
||||
).toEqual({ ok: false, status: 401, code: "missing_token" });
|
||||
});
|
||||
|
||||
it("treats an empty-string header as missing_token", () => {
|
||||
expect(
|
||||
validateMetricsTokenAuth({
|
||||
metricsEnabled: true,
|
||||
configuredToken: token,
|
||||
authorizationHeader: "",
|
||||
}),
|
||||
).toEqual({ ok: false, status: 401, code: "missing_token" });
|
||||
});
|
||||
|
||||
it("rejects a Bearer token containing internal whitespace (regex requires a single \\S+ run)", () => {
|
||||
// "Bearer foo bar" -> the optional trailing-whitespace anchor cannot match
|
||||
// "bar", so the whole header fails to parse -> no token presented.
|
||||
expect(
|
||||
validateMetricsTokenAuth({
|
||||
metricsEnabled: true,
|
||||
configuredToken: token,
|
||||
authorizationHeader: "Bearer foo bar",
|
||||
}),
|
||||
).toEqual({ ok: false, status: 401, code: "missing_token" });
|
||||
});
|
||||
});
|
||||
|
||||
describe("validateMetricsTokenAuth — configuration precedence", () => {
|
||||
it("checks the disabled switch before the token configuration", () => {
|
||||
// Disabled wins even when the token is also unconfigured: callers must see
|
||||
// 403 (feature off) rather than 500 (operator misconfiguration).
|
||||
expect(
|
||||
validateMetricsTokenAuth({
|
||||
metricsEnabled: false,
|
||||
configuredToken: undefined,
|
||||
authorizationHeader: undefined,
|
||||
}),
|
||||
).toEqual({ ok: false, status: 403, code: "metrics_disabled" });
|
||||
});
|
||||
|
||||
it("returns 500 for a null configured token when enabled", () => {
|
||||
expect(
|
||||
validateMetricsTokenAuth({
|
||||
metricsEnabled: true,
|
||||
configuredToken: null,
|
||||
authorizationHeader: "Bearer anything",
|
||||
}),
|
||||
).toEqual({ ok: false, status: 500, code: "token_misconfigured" });
|
||||
});
|
||||
});
|
||||
|
||||
describe("redactMetricsToken — length boundary", () => {
|
||||
it("fully masks a token of exactly 8 characters", () => {
|
||||
expect(redactMetricsToken("12345678")).toBe("***");
|
||||
});
|
||||
|
||||
it("reveals a prefix/suffix at the first non-masked length (9)", () => {
|
||||
// length 9 is the smallest input where slice(0,4)…slice(-2) is returned.
|
||||
expect(redactMetricsToken("abcdef123")).toBe("abcd…23");
|
||||
});
|
||||
|
||||
it("trims surrounding whitespace before deciding the masking strategy", () => {
|
||||
// After trimming, "abcdef123" is 9 chars -> prefix/suffix form.
|
||||
expect(redactMetricsToken(" abcdef123 ")).toBe("abcd…23");
|
||||
});
|
||||
});
|
||||
@@ -20,7 +20,7 @@ describe("createDefaultMetrics", () => {
|
||||
metrics.outboxDispatchTotal.labels({ event_type: "workflow.trigger.event", status: "ok" }).inc();
|
||||
metrics.webSsrLoaderDurationSeconds.labels({ route: "root", status: "ok" }).observe(0.02);
|
||||
metrics.aiTokensConsumedTotal.labels({ provider: "openai", model: "gpt-4", tenant_bucket: "other" }).inc(1234);
|
||||
metrics.stripeWebhookEventsTotal.labels({ event_type: "invoice.paid", status: "received" }).inc();
|
||||
metrics.billingProviderWebhookEventsTotal.labels({ event_type: "invoice.paid", status: "received" }).inc();
|
||||
metrics.mailSentTotal.labels({ provider: "mailjet", status: "delivered" }).inc();
|
||||
metrics.webhookDeliveryAttemptsTotal.labels({ status: "success" }).inc();
|
||||
metrics.csrfTokenRotationTotal.inc();
|
||||
@@ -43,7 +43,7 @@ describe("createDefaultMetrics", () => {
|
||||
"outbox_dispatch_total",
|
||||
"web_ssr_loader_duration_seconds",
|
||||
"ai_tokens_consumed_total",
|
||||
"stripe_webhook_events_total",
|
||||
"billing_provider_webhook_events_total",
|
||||
"mail_sent_total",
|
||||
"webhook_delivery_attempts_total",
|
||||
"csrf_token_rotation_total",
|
||||
|
||||
@@ -32,7 +32,7 @@ export type DefaultMetrics = {
|
||||
outboxDispatchTotal: Counter<"event_type" | "status">;
|
||||
webSsrLoaderDurationSeconds: Histogram<"route" | "status">;
|
||||
aiTokensConsumedTotal: Counter<"provider" | "model" | "tenant_bucket">;
|
||||
stripeWebhookEventsTotal: Counter<"event_type" | "status">;
|
||||
billingProviderWebhookEventsTotal: Counter<"event_type" | "status">;
|
||||
mailSentTotal: Counter<"provider" | "status">;
|
||||
webhookDeliveryAttemptsTotal: Counter<"status">;
|
||||
csrfTokenRotationTotal: Counter<string>;
|
||||
@@ -131,9 +131,9 @@ export function createDefaultMetrics(registry: MetricsRegistry): DefaultMetrics
|
||||
labelNames: ["provider", "model", "tenant_bucket"] as const,
|
||||
registers: [registry],
|
||||
}),
|
||||
stripeWebhookEventsTotal: new Counter({
|
||||
name: "stripe_webhook_events_total",
|
||||
help: "Stripe webhook events processed per event_type / status.",
|
||||
billingProviderWebhookEventsTotal: new Counter({
|
||||
name: "billing_provider_webhook_events_total",
|
||||
help: "Billing webhook events processed per event_type / status.",
|
||||
labelNames: ["event_type", "status"] as const,
|
||||
registers: [registry],
|
||||
}),
|
||||
|
||||
@@ -0,0 +1,59 @@
|
||||
import { describe, it, expect } from "vitest";
|
||||
import * as barrel from "./index.js";
|
||||
|
||||
/**
|
||||
* Guards the public API surface of the package. The barrel (`index.ts`) is the
|
||||
* only entrypoint declared in `package.json#exports`, so a renamed or dropped
|
||||
* re-export would silently break every consumer (api / worker / web). These
|
||||
* tests assert that each runtime symbol is not merely present but wired to the
|
||||
* correct underlying implementation.
|
||||
*/
|
||||
describe("public API barrel", () => {
|
||||
it("re-exports exactly the expected runtime symbols", () => {
|
||||
expect(Object.keys(barrel).sort()).toEqual(
|
||||
[
|
||||
"HISTOGRAM_BUCKETS_SECONDS",
|
||||
"createDefaultMetrics",
|
||||
"createMetricsRegistry",
|
||||
"isMetricsEnabled",
|
||||
"redactMetricsToken",
|
||||
"validateMetricsTokenAuth",
|
||||
].sort(),
|
||||
);
|
||||
});
|
||||
|
||||
it("re-exports the shared histogram bucket constant verbatim", () => {
|
||||
expect(barrel.HISTOGRAM_BUCKETS_SECONDS).toEqual([
|
||||
0.005, 0.01, 0.025, 0.05, 0.1, 0.25, 0.5, 1, 2.5, 5, 10,
|
||||
]);
|
||||
});
|
||||
|
||||
it("re-exports a working isMetricsEnabled", () => {
|
||||
expect(barrel.isMetricsEnabled({ METRICS_ENABLED: "true" })).toBe(true);
|
||||
expect(barrel.isMetricsEnabled({ METRICS_ENABLED: "false" })).toBe(false);
|
||||
});
|
||||
|
||||
it("re-exports a working redactMetricsToken", () => {
|
||||
expect(barrel.redactMetricsToken(undefined)).toBe("<unset>");
|
||||
expect(barrel.redactMetricsToken("abcdef1234567890abcdef")).toBe("abcd…ef");
|
||||
});
|
||||
|
||||
it("re-exports a working validateMetricsTokenAuth", () => {
|
||||
expect(barrel.validateMetricsTokenAuth({ metricsEnabled: false })).toEqual({
|
||||
ok: false,
|
||||
status: 403,
|
||||
code: "metrics_disabled",
|
||||
});
|
||||
});
|
||||
|
||||
it("re-exports a registry factory and default-metric factory that compose", async () => {
|
||||
const registry = barrel.createMetricsRegistry({
|
||||
serviceName: "api",
|
||||
collectDefaultProcessMetrics: false,
|
||||
});
|
||||
const metrics = barrel.createDefaultMetrics(registry);
|
||||
metrics.activeTenants.set(3);
|
||||
const text = await registry.metrics();
|
||||
expect(text).toContain('active_tenants{service="api"} 3');
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,70 @@
|
||||
import { describe, it, expect } from "vitest";
|
||||
import { createMetricsRegistry } from "./registry.js";
|
||||
import { createDefaultMetrics } from "./defaults.js";
|
||||
|
||||
/**
|
||||
* Behavioural guards for the registry contract documented in registry.ts /
|
||||
* defaults.ts: the canonical metric set may only be registered once per
|
||||
* registry, and identically-named metrics on separate service registries must
|
||||
* not collide (the whole reason each service owns its own registry).
|
||||
*/
|
||||
describe("createMetricsRegistry — registration contract", () => {
|
||||
it("throws when the canonical metric set is registered twice on one registry", () => {
|
||||
const registry = createMetricsRegistry({
|
||||
serviceName: "api",
|
||||
collectDefaultProcessMetrics: false,
|
||||
});
|
||||
createDefaultMetrics(registry);
|
||||
expect(() => createDefaultMetrics(registry)).toThrow(
|
||||
/already been registered/i,
|
||||
);
|
||||
});
|
||||
|
||||
it("keeps identically-named metrics isolated across two service registries", async () => {
|
||||
const api = createMetricsRegistry({
|
||||
serviceName: "api",
|
||||
collectDefaultProcessMetrics: false,
|
||||
});
|
||||
const worker = createMetricsRegistry({
|
||||
serviceName: "worker",
|
||||
collectDefaultProcessMetrics: false,
|
||||
});
|
||||
|
||||
const apiMetrics = createDefaultMetrics(api);
|
||||
const workerMetrics = createDefaultMetrics(worker);
|
||||
|
||||
apiMetrics.activeTenants.set(11);
|
||||
workerMetrics.activeTenants.set(22);
|
||||
|
||||
const apiText = await api.metrics();
|
||||
const workerText = await worker.metrics();
|
||||
|
||||
// Each registry renders only its own service label + value; no bleed.
|
||||
expect(apiText).toContain('active_tenants{service="api"} 11');
|
||||
expect(apiText).not.toContain('service="worker"');
|
||||
expect(workerText).toContain('active_tenants{service="worker"} 22');
|
||||
expect(workerText).not.toContain('service="api"');
|
||||
});
|
||||
|
||||
it("renders numeric default labels alongside the service label", async () => {
|
||||
const registry = createMetricsRegistry({
|
||||
serviceName: "web",
|
||||
collectDefaultProcessMetrics: false,
|
||||
// The option type permits numeric label values (e.g. a build revision).
|
||||
defaultLabels: { build: 4711 },
|
||||
});
|
||||
const metrics = createDefaultMetrics(registry);
|
||||
metrics.activeUsers24h.set(5);
|
||||
const text = await registry.metrics();
|
||||
expect(text).toContain('active_users_24h{service="web",build="4711"} 5');
|
||||
});
|
||||
|
||||
it("exposes serviceName and defaultMetricsAttached reflecting the options", () => {
|
||||
const registry = createMetricsRegistry({
|
||||
serviceName: "worker",
|
||||
collectDefaultProcessMetrics: false,
|
||||
});
|
||||
expect(registry.serviceName).toBe("worker");
|
||||
expect(registry.defaultMetricsAttached).toBe(false);
|
||||
});
|
||||
});
|
||||
Reference in new issue
Block a user