@iann29/rastro 0.1.0-alpha.9 → 0.1.0

package/dist/component/rollupStore.d.ts

@@ -0,0 +1,320 @@
+import type { Doc, Id } from "./_generated/dataModel.js";
+import type { MutationCtx } from "./_generated/server.js";
+import { type VitalMetric } from "./vitals.js";
+/**
+ * Report rollups (goal, funnel, affiliate, route and Web Vitals daily rows)
+ * are the hottest documents in the store: a goal on the home page or one
+ * affiliate carrying a campaign means every batch read-modify-writes the same
+ * two rows, and under concurrent load Convex's optimistic retries run out and
+ * whole batches are lost (#52). Ingestion therefore never touches a rollup
+ * row. It appends the batch's deltas to `reportRollupQueue` — an insert
+ * conflicts with nothing — and one leased fold job per site merges the queue
+ * into the rows a few hundred milliseconds later, so every rollup row has a
+ * single writer.
+ */
+export type GoalRollupDelta = {
+    siteId: Id<"sites">;
+    goalId: Id<"goals">;
+    bucketStart: number;
+    shard: number;
+    goalKey: string;
+    completions: number;
+    valueCents: number;
+};
+export type FunnelRollupDelta = {
+    siteId: Id<"sites">;
+    funnelId: Id<"funnels">;
+    bucketStart: number;
+    shard: number;
+    steps: Map<number, {
+        step: number;
+        entrants: number;
+        completions: number;
+    }>;
+};
+export type FunnelStepDelta = {
+    siteId: Id<"sites">;
+    funnelId: Id<"funnels">;
+    bucketStart: number;
+    step: number;
+    shard: number;
+    entrants: number;
+    completions: number;
+};
+export type AffiliateRollupDelta = {
+    siteId: Id<"sites">;
+    affiliateId: Id<"affiliates">;
+    bucketStart: number;
+    shard: number;
+    affiliateSlug: string;
+    visits: number;
+    visitorKeys: Set<string>;
+    conversions: number;
+    revenueCents: number;
+    commissionCents: number;
+};
+export type VitalRollupDelta = {
+    siteId: Id<"sites">;
+    bucketStart: number;
+    device: string;
+    page: string;
+    shard: number;
+    metrics: Map<VitalMetric, {
+        count: number;
+        sum: number;
+        histogram: number[];
+    }>;
+};
+export type RouteRollupDelta = {
+    siteId: Id<"sites">;
+    bucketStart: number;
+    shard: number;
+    route: string;
+    pageviews: number;
+    entries: number;
+    continued: number;
+    dwellMs: number;
+    dwellSamples: number;
+    visitorKeys: Set<string>;
+    outgoing: Map<string, number>;
+};
+export type ReportRollupDeltas = {
+    goals: Map<string, GoalRollupDelta>;
+    funnels: Map<string, FunnelRollupDelta>;
+    funnelSteps: Map<string, FunnelStepDelta>;
+    affiliates: Map<string, AffiliateRollupDelta>;
+    vitals: Map<string, VitalRollupDelta>;
+    routes: Map<string, RouteRollupDelta>;
+};
+export declare function createReportRollupDeltas(): ReportRollupDeltas;
+export declare function reportRollupCoordinates(siteId: Id<"sites">, definitionId: string, timestamp: number, visitorId: string): {
+    bucketStart: number;
+    shard: number;
+    key: string;
+};
+export declare function countReportRollupRows(deltas: ReportRollupDeltas): number;
+export declare const reportRollupQueueFields: {
+    siteId: import("convex/values").VId<import("convex/values").GenericId<"sites">, "required">;
+    createdAt: import("convex/values").VFloat64<number, "required">;
+    goals: import("convex/values").VArray<{
+        bucketStart: number;
+        completions: number;
+        goalId: import("convex/values").GenericId<"goals">;
+        goalKey: string;
+        shard: number;
+        valueCents: number;
+    }[], import("convex/values").VObject<{
+        bucketStart: number;
+        completions: number;
+        goalId: import("convex/values").GenericId<"goals">;
+        goalKey: string;
+        shard: number;
+        valueCents: number;
+    }, {
+        goalId: import("convex/values").VId<import("convex/values").GenericId<"goals">, "required">;
+        bucketStart: import("convex/values").VFloat64<number, "required">;
+        shard: import("convex/values").VFloat64<number, "required">;
+        goalKey: import("convex/values").VString<string, "required">;
+        completions: import("convex/values").VFloat64<number, "required">;
+        valueCents: import("convex/values").VFloat64<number, "required">;
+    }, "required", "bucketStart" | "completions" | "goalId" | "goalKey" | "shard" | "valueCents">, "required">;
+    funnels: import("convex/values").VArray<{
+        bucketStart: number;
+        funnelId: import("convex/values").GenericId<"funnels">;
+        shard: number;
+        steps: {
+            completions: number;
+            entrants: number;
+            step: number;
+        }[];
+    }[], import("convex/values").VObject<{
+        bucketStart: number;
+        funnelId: import("convex/values").GenericId<"funnels">;
+        shard: number;
+        steps: {
+            completions: number;
+            entrants: number;
+            step: number;
+        }[];
+    }, {
+        funnelId: import("convex/values").VId<import("convex/values").GenericId<"funnels">, "required">;
+        bucketStart: import("convex/values").VFloat64<number, "required">;
+        shard: import("convex/values").VFloat64<number, "required">;
+        steps: import("convex/values").VArray<{
+            completions: number;
+            entrants: number;
+            step: number;
+        }[], import("convex/values").VObject<{
+            completions: number;
+            entrants: number;
+            step: number;
+        }, {
+            step: import("convex/values").VFloat64<number, "required">;
+            entrants: import("convex/values").VFloat64<number, "required">;
+            completions: import("convex/values").VFloat64<number, "required">;
+        }, "required", "completions" | "entrants" | "step">, "required">;
+    }, "required", "bucketStart" | "funnelId" | "shard" | "steps">, "required">;
+    funnelSteps: import("convex/values").VArray<{
+        bucketStart: number;
+        completions: number;
+        entrants: number;
+        funnelId: import("convex/values").GenericId<"funnels">;
+        shard: number;
+        step: number;
+    }[], import("convex/values").VObject<{
+        bucketStart: number;
+        completions: number;
+        entrants: number;
+        funnelId: import("convex/values").GenericId<"funnels">;
+        shard: number;
+        step: number;
+    }, {
+        funnelId: import("convex/values").VId<import("convex/values").GenericId<"funnels">, "required">;
+        bucketStart: import("convex/values").VFloat64<number, "required">;
+        step: import("convex/values").VFloat64<number, "required">;
+        shard: import("convex/values").VFloat64<number, "required">;
+        entrants: import("convex/values").VFloat64<number, "required">;
+        completions: import("convex/values").VFloat64<number, "required">;
+    }, "required", "bucketStart" | "completions" | "entrants" | "funnelId" | "shard" | "step">, "required">;
+    affiliates: import("convex/values").VArray<{
+        affiliateId: import("convex/values").GenericId<"affiliates">;
+        affiliateSlug: string;
+        bucketStart: number;
+        commissionCents: number;
+        conversions: number;
+        revenueCents: number;
+        shard: number;
+        visitorKeys: string[];
+        visits: number;
+    }[], import("convex/values").VObject<{
+        affiliateId: import("convex/values").GenericId<"affiliates">;
+        affiliateSlug: string;
+        bucketStart: number;
+        commissionCents: number;
+        conversions: number;
+        revenueCents: number;
+        shard: number;
+        visitorKeys: string[];
+        visits: number;
+    }, {
+        affiliateId: import("convex/values").VId<import("convex/values").GenericId<"affiliates">, "required">;
+        bucketStart: import("convex/values").VFloat64<number, "required">;
+        shard: import("convex/values").VFloat64<number, "required">;
+        affiliateSlug: import("convex/values").VString<string, "required">;
+        visits: import("convex/values").VFloat64<number, "required">;
+        visitorKeys: import("convex/values").VArray<string[], import("convex/values").VString<string, "required">, "required">;
+        conversions: import("convex/values").VFloat64<number, "required">;
+        revenueCents: import("convex/values").VFloat64<number, "required">;
+        commissionCents: import("convex/values").VFloat64<number, "required">;
+    }, "required", "affiliateId" | "affiliateSlug" | "bucketStart" | "commissionCents" | "conversions" | "revenueCents" | "shard" | "visitorKeys" | "visits">, "required">;
+    routes: import("convex/values").VArray<{
+        bucketStart: number;
+        continued: number;
+        dwellMs: number;
+        dwellSamples: number;
+        entries: number;
+        outgoing: {
+            count: number;
+            route: string;
+        }[];
+        pageviews: number;
+        route: string;
+        shard: number;
+        visitorKeys: string[];
+    }[], import("convex/values").VObject<{
+        bucketStart: number;
+        continued: number;
+        dwellMs: number;
+        dwellSamples: number;
+        entries: number;
+        outgoing: {
+            count: number;
+            route: string;
+        }[];
+        pageviews: number;
+        route: string;
+        shard: number;
+        visitorKeys: string[];
+    }, {
+        route: import("convex/values").VString<string, "required">;
+        bucketStart: import("convex/values").VFloat64<number, "required">;
+        shard: import("convex/values").VFloat64<number, "required">;
+        pageviews: import("convex/values").VFloat64<number, "required">;
+        entries: import("convex/values").VFloat64<number, "required">;
+        continued: import("convex/values").VFloat64<number, "required">;
+        dwellMs: import("convex/values").VFloat64<number, "required">;
+        dwellSamples: import("convex/values").VFloat64<number, "required">;
+        visitorKeys: import("convex/values").VArray<string[], import("convex/values").VString<string, "required">, "required">;
+        outgoing: import("convex/values").VArray<{
+            count: number;
+            route: string;
+        }[], import("convex/values").VObject<{
+            count: number;
+            route: string;
+        }, {
+            route: import("convex/values").VString<string, "required">;
+            count: import("convex/values").VFloat64<number, "required">;
+        }, "required", "count" | "route">, "required">;
+    }, "required", "bucketStart" | "continued" | "dwellMs" | "dwellSamples" | "entries" | "outgoing" | "pageviews" | "route" | "shard" | "visitorKeys">, "required">;
+    vitals: import("convex/values").VArray<{
+        bucketStart: number;
+        device: string;
+        metrics: {
+            count: number;
+            histogram: number[];
+            metric: "CLS" | "FCP" | "INP" | "LCP" | "TTFB";
+            sum: number;
+        }[];
+        page: string;
+        shard: number;
+    }[], import("convex/values").VObject<{
+        bucketStart: number;
+        device: string;
+        metrics: {
+            count: number;
+            histogram: number[];
+            metric: "CLS" | "FCP" | "INP" | "LCP" | "TTFB";
+            sum: number;
+        }[];
+        page: string;
+        shard: number;
+    }, {
+        bucketStart: import("convex/values").VFloat64<number, "required">;
+        device: import("convex/values").VString<string, "required">;
+        page: import("convex/values").VString<string, "required">;
+        shard: import("convex/values").VFloat64<number, "required">;
+        metrics: import("convex/values").VArray<{
+            count: number;
+            histogram: number[];
+            metric: "CLS" | "FCP" | "INP" | "LCP" | "TTFB";
+            sum: number;
+        }[], import("convex/values").VObject<{
+            count: number;
+            histogram: number[];
+            metric: "CLS" | "FCP" | "INP" | "LCP" | "TTFB";
+            sum: number;
+        }, {
+            metric: import("convex/values").VUnion<"CLS" | "FCP" | "INP" | "LCP" | "TTFB", [import("convex/values").VLiteral<"LCP", "required">, import("convex/values").VLiteral<"CLS", "required">, import("convex/values").VLiteral<"INP", "required">, import("convex/values").VLiteral<"FCP", "required">, import("convex/values").VLiteral<"TTFB", "required">], "required", never>;
+            count: import("convex/values").VFloat64<number, "required">;
+            sum: import("convex/values").VFloat64<number, "required">;
+            histogram: import("convex/values").VArray<number[], import("convex/values").VFloat64<number, "required">, "required">;
+        }, "required", "count" | "histogram" | "metric" | "sum">, "required">;
+    }, "required", "bucketStart" | "device" | "metrics" | "page" | "shard">, "required">;
+};
+export declare const rollupFoldStateFields: {
+    siteId: import("convex/values").VId<import("convex/values").GenericId<"sites">, "required">;
+    leaseUntil: import("convex/values").VFloat64<number, "required">;
+    token: import("convex/values").VString<string, "required">;
+};
+/** Accumulates one queued document into the deltas the fold will write. */
+export declare function mergeQueuedRollups(deltas: ReportRollupDeltas, queued: Doc<"reportRollupQueue">): void;
+/**
+ * Appends a batch's rollup deltas to the site's queue and makes sure a fold
+ * job will pick them up. The only document this reads is the site's fold
+ * state, which the fold job rewrites about twice a minute under load, so
+ * concurrent ingests almost never retry because of it.
+ */
+export declare function enqueueReportRollups(ctx: MutationCtx, siteId: Id<"sites">, deltas: ReportRollupDeltas, now: number): Promise<void>;
+export declare function ensureRollupFold(ctx: MutationCtx, siteId: Id<"sites">, now: number): Promise<void>;
+export declare function flushReportRollups(ctx: MutationCtx, deltas: ReportRollupDeltas): Promise<void>;
+//# sourceMappingURL=rollupStore.d.ts.map

package/dist/component/rollupStore.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rollupStore.d.ts","sourceRoot":"","sources":["../../src/component/rollupStore.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,GAAG,EAAE,EAAE,EAAE,MAAM,2BAA2B,CAAC;AACzD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAoB1D,OAAO,EAIL,KAAK,WAAW,EACjB,MAAM,aAAa,CAAC;AAErB;;;;;;;;;;GAUG;AAEH,MAAM,MAAM,eAAe,GAAG;IAC5B,MAAM,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC;IACpB,MAAM,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AACF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,MAAM,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC;IACpB,QAAQ,EAAE,EAAE,CAAC,SAAS,CAAC,CAAC;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CAC7E,CAAC;AACF,MAAM,MAAM,eAAe,GAAG;IAC5B,MAAM,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC;IACpB,QAAQ,EAAE,EAAE,CAAC,SAAS,CAAC,CAAC;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AACF,MAAM,MAAM,oBAAoB,GAAG;IACjC,MAAM,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC;IACpB,WAAW,EAAE,EAAE,CAAC,YAAY,CAAC,CAAC;IAC9B,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,eAAe,EAAE,MAAM,CAAC;CACzB,CAAC;AACF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,MAAM,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,GAAG,CACV,WAAW,EACX;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,EAAE,CAAA;KAAE,CACpD,CAAC;CACH,CAAC;AACF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,MAAM,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IACzB,QAAQ,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC/B,CAAC;AACF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IACpC,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;IACxC,WAAW,EAAE,GAAG,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAC1C,UAAU,EAAE,GAAG,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC;IAC9C,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;IACtC,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;CACvC,CAAC;AAEF,wBAAgB,wBAAwB,IAAI,kBAAkB,CAS7D;AAED,wBAAgB,uBAAuB,CACrC,MAAM,EAAE,EAAE,CAAC,OAAO,CAAC,EACnB,YAAY,EAAE,MAAM,EACpB,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM;;;;EASlB;AAED,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,kBAAkB,GAAG,MAAM,CASxE;AAyED,eAAO,MAAM,uBAAuB;IAClC,MAAM;IACN,SAAS;IACT,KAAK;;;;;;;;;;;;;;;;;;;;;;IACL,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IACP,WAAW;;;;;;;;;;;;;;;;;;;;;;IACX,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IACV,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IACN,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CACP,CAAC;AAEF,eAAO,MAAM,qBAAqB;IAChC,MAAM;IACN,UAAU;IACV,KAAK;CACN,CAAC;AAmEF,2EAA2E;AAC3E,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,kBAAkB,EAC1B,MAAM,EAAE,GAAG,CAAC,mBAAmB,CAAC,QAoJjC;AAED;;;;;GAKG;AACH,wBAAsB,oBAAoB,CACxC,GAAG,EAAE,WAAW,EAChB,MAAM,EAAE,EAAE,CAAC,OAAO,CAAC,EACnB,MAAM,EAAE,kBAAkB,EAC1B,GAAG,EAAE,MAAM,iBAQZ;AAED,wBAAsB,gBAAgB,CACpC,GAAG,EAAE,WAAW,EAChB,MAAM,EAAE,EAAE,CAAC,OAAO,CAAC,EACnB,GAAG,EAAE,MAAM,iBAeZ;AAKD,wBAAsB,kBAAkB,CACtC,GAAG,EAAE,WAAW,EAChB,MAAM,EAAE,kBAAkB,iBAyI3B"}