From 68dbe4ade7f77df64f43b189673205485f706409 Mon Sep 17 00:00:00 2001 From: ryder777777 Date: Tue, 20 Oct 2026 22:04:54 +0000 Subject: [PATCH] feat(analytics): add contract-test-the-frontend-api helper and unit tests (#111) --- .../contract-test-the-frontend-api.test.ts | 14 +++++++ .../contract-test-the-frontend-api.ts | 40 +++++++++++++++++++ 2 files changed, 54 insertions(+) create mode 100644 lib/analytics/__tests__/contract-test-the-frontend-api.test.ts create mode 100644 lib/analytics/contract-test-the-frontend-api.ts diff --git a/lib/analytics/__tests__/contract-test-the-frontend-api.test.ts b/lib/analytics/__tests__/contract-test-the-frontend-api.test.ts new file mode 100644 index 0000000..ebb7812 --- /dev/null +++ b/lib/analytics/__tests__/contract-test-the-frontend-api.test.ts @@ -0,0 +1,14 @@ +import { describe, expect, it } from "vitest"; +import { evaluateContractTestTheFrontendApi } from "../contract-test-the-frontend-api"; + +describe("evaluateContractTestTheFrontendApi", () => { + it("evaluates nominal, elevated, and critical thresholds deterministically", () => { + expect(evaluateContractTestTheFrontendApi({ contextId: "ctx-1", primaryMetric: 15, secondaryMetric: 10, limitThreshold: 100 }).status).toBe("nominal"); + expect(evaluateContractTestTheFrontendApi({ contextId: "ctx-2", primaryMetric: 40, secondaryMetric: 20 }).status).toBe("elevated"); + expect(evaluateContractTestTheFrontendApi({ contextId: "ctx-3", primaryMetric: 70, secondaryMetric: 25, limitThreshold: 100 }).status).toBe("critical"); + }); + + it("rejects blank contextId", () => { + expect(() => evaluateContractTestTheFrontendApi({ contextId: " ", primaryMetric: 1, secondaryMetric: 1 })).toThrow(/contextId is required/); + }); +}); diff --git a/lib/analytics/contract-test-the-frontend-api.ts b/lib/analytics/contract-test-the-frontend-api.ts new file mode 100644 index 0000000..8aef803 --- /dev/null +++ b/lib/analytics/contract-test-the-frontend-api.ts @@ -0,0 +1,40 @@ +export interface ContractTestTheFrontendApiSummaryInput { + contextId: string; + primaryMetric: number; + secondaryMetric: number; + limitThreshold?: number; +} + +export interface ContractTestTheFrontendApiSummary { + contextId: string; + primaryMetric: number; + secondaryMetric: number; + scoreBps: number; + status: "nominal" | "elevated" | "critical"; +} + +export function evaluateContractTestTheFrontendApi(input: ContractTestTheFrontendApiSummaryInput): ContractTestTheFrontendApiSummary { + const contextId = input.contextId.trim(); + if (!contextId) { + throw new Error("evaluateContractTestTheFrontendApi: contextId is required"); + } + const primaryMetric = Math.max(0, Math.trunc(input.primaryMetric)); + const secondaryMetric = Math.max(0, Math.trunc(input.secondaryMetric)); + const limit = Math.max(1, Math.trunc(input.limitThreshold ?? 100)); + + const scoreBps = Math.min(10000, Math.round(((primaryMetric + secondaryMetric) * 10000) / limit)); + let status: "nominal" | "elevated" | "critical" = "nominal"; + if (scoreBps >= 8500) { + status = "critical"; + } else if (scoreBps >= 5000) { + status = "elevated"; + } + + return { + contextId, + primaryMetric, + secondaryMetric, + scoreBps, + status, + }; +}