@iann29/rastro 0.1.0-alpha.0 → 0.1.0-alpha.2

package/src/component/live.ts

@@ -1,6 +1,9 @@
 import { v } from "convex/values";
 import { internal } from "./_generated/api.js";
 import { internalMutation } from "./_generated/server.js";
+import { LIVE_SWEEP_INTERVAL_MS } from "./constants.js";
+
+const SWEEP_BATCH_SIZE = 500;
 
 export const expire = internalMutation({
   args: {
@@ -21,16 +24,88 @@ export const expire = internalMutation({
       return { expired: false, rescheduled: false, stale: true };
     }
     if (liveSession.expiresAt > Date.now()) {
-      await ctx.db.patch("liveSessions", liveSession._id, {
-        expiryChainDeadline: liveSession.expiresAt,
-      });
-      await ctx.scheduler.runAt(liveSession.expiresAt, internal.live.expire, {
-        liveSessionId: liveSession._id,
-        scheduledDeadline: liveSession.expiresAt,
-      });
-      return { expired: false, rescheduled: true, stale: false };
+      const state = await ctx.db
+        .query("liveSweepStates")
+        .withIndex("by_siteId", (range) => range.eq("siteId", liveSession.siteId))
+        .unique();
+      const scheduledAt = Math.min(
+        liveSession.expiresAt,
+        Date.now() + LIVE_SWEEP_INTERVAL_MS,
+      );
+      if (!state || state.scheduledAt > scheduledAt) {
+        if (state) {
+          await ctx.db.patch("liveSweepStates", state._id, {
+            scheduledAt,
+          });
+        } else {
+          await ctx.db.insert("liveSweepStates", {
+            siteId: liveSession.siteId,
+            scheduledAt,
+          });
+        }
+        await ctx.scheduler.runAt(scheduledAt, internal.live.sweep, {
+          siteId: liveSession.siteId,
+          scheduledAt,
+        });
+        return { expired: false, rescheduled: true, stale: false };
+      }
+      return { expired: false, rescheduled: false, stale: false };
     }
     await ctx.db.delete("liveSessions", liveSession._id);
     return { expired: true, rescheduled: false, stale: false };
   },
 });
+
+export const sweep = internalMutation({
+  args: {
+    siteId: v.id("sites"),
+    scheduledAt: v.number(),
+  },
+  returns: v.object({
+    expired: v.number(),
+    rescheduled: v.boolean(),
+    stale: v.boolean(),
+  }),
+  handler: async (ctx, args) => {
+    const state = await ctx.db
+      .query("liveSweepStates")
+      .withIndex("by_siteId", (range) => range.eq("siteId", args.siteId))
+      .unique();
+    if (!state || state.scheduledAt !== args.scheduledAt) {
+      return { expired: 0, rescheduled: false, stale: true };
+    }
+
+    const now = Date.now();
+    const expired = await ctx.db
+      .query("liveSessions")
+      .withIndex("by_siteId_and_expiresAt", (range) =>
+        range.eq("siteId", args.siteId).lte("expiresAt", now),
+      )
+      .take(SWEEP_BATCH_SIZE);
+    for (const session of expired) {
+      await ctx.db.delete("liveSessions", session._id);
+    }
+
+    const next = await ctx.db
+      .query("liveSessions")
+      .withIndex("by_siteId_and_expiresAt", (range) =>
+        range.eq("siteId", args.siteId),
+      )
+      .order("asc")
+      .first();
+    if (!next) {
+      await ctx.db.delete("liveSweepStates", state._id);
+      return { expired: expired.length, rescheduled: false, stale: false };
+    }
+
+    const scheduledAt = expired.length === SWEEP_BATCH_SIZE
+      ? now
+      : now + LIVE_SWEEP_INTERVAL_MS;
+    await ctx.db.patch("liveSweepStates", state._id, { scheduledAt });
+    await ctx.scheduler.runAt(scheduledAt, internal.live.sweep, {
+      siteId: args.siteId,
+      scheduledAt,
+    });
+    return { expired: expired.length, rescheduled: true, stale: false };
+  },
+});

package/src/component/migrations.ts

@@ -0,0 +1,52 @@
+import { Migrations } from "@convex-dev/migrations";
+import { v } from "convex/values";
+import { components } from "./_generated/api.js";
+import { internalMutation, internalQuery } from "./_generated/server.js";
+import { migrateLegacyEventToBatch } from "./eventStore.js";
+import schema from "./schema.js";
+
+const migrations = new Migrations(components.migrations, {
+  internalMutation,
+  schema,
+});
+
+export const migrateLegacyEvents = migrations.define({
+  table: "events",
+  batchSize: 16,
+  migrateOne: migrateLegacyEventToBatch,
+});
+
+export const legacyEventsStatus = internalQuery({
+  args: {},
+  returns: v.object({
+    complete: v.boolean(),
+    sourceEmpty: v.boolean(),
+    migrationState: v.union(
+      v.literal("inProgress"),
+      v.literal("success"),
+      v.literal("failed"),
+      v.literal("canceled"),
+      v.literal("unknown"),
+    ),
+    processed: v.number(),
+    sampleRemainingId: v.union(v.id("events"), v.null()),
+  }),
+  handler: async (ctx) => {
+    const [remaining, statuses] = await Promise.all([
+      ctx.db.query("events").first(),
+      migrations.getStatus(ctx, {
+        migrations: ["migrations:migrateLegacyEvents"],
+      }),
+    ]);
+    const migrationStatus = statuses[0];
+    const migrationState = migrationStatus?.state ?? "unknown";
+    const sourceEmpty = remaining === null;
+    return {
+      complete: sourceEmpty && migrationState === "success",
+      sourceEmpty,
+      migrationState,
+      processed: migrationStatus?.processed ?? 0,
+      sampleRemainingId: remaining?._id ?? null,
+    };
+  },
+});

package/src/component/reports.ts

@@ -3,22 +3,31 @@ import {
   paginationResultValidator,
 } from "convex/server";
 import { v } from "convex/values";
+import type { Doc } from "./_generated/dataModel.js";
 import { query } from "./_generated/server.js";
 import {
   AGGREGATE_SHARDS,
   DAY_MS,
   HOUR_MS,
+  HOURLY_AGGREGATE_SHARDS,
   MAX_AFFILIATES_PER_SITE,
   MAX_FUNNELS_PER_SITE,
   MAX_GOALS_PER_SITE,
   MAX_JOURNEY_EVENTS,
   MAX_LIVE_VISITORS,
-  MAX_MANUAL_PAGINATION_OFFSET,
   MAX_OVERVIEW_AGGREGATE_ROWS,
   MAX_REPORT_RANGE_DAYS,
   MAX_REPORT_SITES,
 } from "./constants.js";
 import { fail } from "./errors.js";
+import {
+  compareJourneyEvents,
+  hydrateEventContexts,
+  type JourneyCursor,
+  loadSessionJourneyEvents,
+  loadVisitorJourneyEvents,
+  type RawJourneyEvent,
+} from "./eventStore.js";
 import { isPlainRecord } from "./guards.js";
 import {
   affiliateFieldsValidator,
@@ -33,7 +42,7 @@ const sessionDocumentValidator = sessionFieldsValidator.extend({
   _creationTime: v.number(),
 });
 const eventDocumentValidator = eventFieldsValidator.extend({
-  _id: v.id("events"),
+  _id: v.string(),
   _creationTime: v.number(),
 });
 const liveSessionDocumentValidator = v.object({
@@ -131,15 +140,16 @@ export const overview = query({
     }
     const currency = [...currencies][0];
     const { from, to } = validateRange(args.from, args.to, MAX_REPORT_RANGE_DAYS);
-    const interval = args.interval ?? (to - from <= 7 * DAY_MS ? "hour" : "day");
-    if (interval === "hour" && to - from > 7 * DAY_MS) {
-      fail("INVALID_ARGUMENT", "hourly reports are limited to seven days");
+    const interval = args.interval ?? (to - from <= DAY_MS ? "hour" : "day");
+    if (interval === "hour" && to - from > DAY_MS) {
+      fail("INVALID_ARGUMENT", "hourly reports are limited to 24 hours");
     }
     const intervalMs = interval === "hour" ? HOUR_MS : DAY_MS;
     const firstBucket = Math.floor(from / intervalMs) * intervalMs;
     const lastBucket = Math.floor(to / intervalMs) * intervalMs;
     const bucketCount = Math.floor((lastBucket - firstBucket) / intervalMs) + 1;
-    const perSiteLimit = bucketCount * AGGREGATE_SHARDS;
+    const perSiteLimit = bucketCount *
+      (interval === "hour" ? HOURLY_AGGREGATE_SHARDS : AGGREGATE_SHARDS);
     if (perSiteLimit * siteIds.length > MAX_OVERVIEW_AGGREGATE_ROWS) {
       fail(
         "LIMIT_EXCEEDED",
@@ -272,18 +282,59 @@ export const listSessions = query({
   returns: paginationResultValidator(sessionDocumentValidator),
   handler: async (ctx, args) => {
     validateRange(args.from, args.to, MAX_REPORT_RANGE_DAYS);
-    const pagination = parseManualPagination(args.paginationOpts);
-    const rows = await ctx.db
-      .query("sessions")
-      .withIndex("by_siteId_and_lastSeenAt", (range) =>
-        range
-          .eq("siteId", args.siteId)
-          .gte("lastSeenAt", args.from)
-          .lte("lastSeenAt", args.to),
-      )
-      .order("desc")
-      .take(pagination.offset + pagination.numItems + 1);
-    return manualPaginationResult(rows, pagination);
+    const pagination = parseKeysetPagination(args.paginationOpts, {
+      kind: "sessions",
+      siteId: String(args.siteId),
+      from: args.from,
+      to: args.to,
+    });
+    const rows: Doc<"sessions">[] = [];
+    const take = pagination.numItems + 1;
+    if (pagination.cursor) {
+      rows.push(
+        ...(await ctx.db
+          .query("sessions")
+          .withIndex("by_siteId_and_lastSeenAt", (range) =>
+            range
+              .eq("siteId", args.siteId)
+              .eq("lastSeenAt", pagination.cursor!.timestamp)
+              .lt("_creationTime", pagination.cursor!.creationTime),
+          )
+          .order("desc")
+          .take(take)),
+      );
+      if (rows.length < take) {
+        rows.push(
+          ...(await ctx.db
+            .query("sessions")
+            .withIndex("by_siteId_and_lastSeenAt", (range) =>
+              range
+                .eq("siteId", args.siteId)
+                .gte("lastSeenAt", args.from)
+                .lt("lastSeenAt", pagination.cursor!.timestamp),
+            )
+            .order("desc")
+            .take(take - rows.length)),
+        );
+      }
+    } else {
+      rows.push(
+        ...(await ctx.db
+          .query("sessions")
+          .withIndex("by_siteId_and_lastSeenAt", (range) =>
+            range
+              .eq("siteId", args.siteId)
+              .gte("lastSeenAt", args.from)
+              .lte("lastSeenAt", args.to),
+          )
+          .order("desc")
+          .take(take)),
+      );
+    }
+    return keysetPaginationResult(rows, pagination, (row) => ({
+      timestamp: row.lastSeenAt,
+      creationTime: row._creationTime,
+    }));
   },
 });
 
@@ -298,19 +349,23 @@ export const sessionJourney = query({
   returns: paginationResultValidator(eventDocumentValidator),
   handler: async (ctx, args) => {
     validateRange(args.from, args.to, MAX_REPORT_RANGE_DAYS);
-    const pagination = parseManualPagination(args.paginationOpts);
-    const rows = await ctx.db
-      .query("events")
-      .withIndex("by_siteId_and_sessionId_and_timestamp", (range) =>
-        range
-          .eq("siteId", args.siteId)
-          .eq("sessionId", args.sessionId)
-          .gte("timestamp", args.from)
-          .lte("timestamp", args.to),
-      )
-      .order("asc")
-      .take(pagination.offset + pagination.numItems + 1);
-    return manualPaginationResult(rows, pagination);
+    const pagination = parseJourneyPagination(args.paginationOpts, {
+      kind: "events",
+      siteId: String(args.siteId),
+      sessionId: args.sessionId,
+      from: args.from,
+      to: args.to,
+    });
+    const rows = await loadSessionJourneyEvents(ctx, {
+      siteId: args.siteId,
+      sessionId: args.sessionId,
+      from: args.from,
+      to: args.to,
+      cursor: pagination.cursor,
+      resultLimit: pagination.numItems + 1,
+    });
+    const hydratedRows = await hydrateEventContexts(ctx, rows);
+    return journeyPaginationResult(hydratedRows, pagination);
   },
 });
 
@@ -324,18 +379,59 @@ export const listConversions = query({
   returns: paginationResultValidator(conversionDocumentValidator),
   handler: async (ctx, args) => {
     validateRange(args.from, args.to, MAX_REPORT_RANGE_DAYS);
-    const pagination = parseManualPagination(args.paginationOpts);
-    const rows = await ctx.db
-      .query("conversions")
-      .withIndex("by_siteId_and_timestamp", (range) =>
-        range
-          .eq("siteId", args.siteId)
-          .gte("timestamp", args.from)
-          .lte("timestamp", args.to),
-      )
-      .order("desc")
-      .take(pagination.offset + pagination.numItems + 1);
-    return manualPaginationResult(rows, pagination);
+    const pagination = parseKeysetPagination(args.paginationOpts, {
+      kind: "conversions",
+      siteId: String(args.siteId),
+      from: args.from,
+      to: args.to,
+    });
+    const rows: Doc<"conversions">[] = [];
+    const take = pagination.numItems + 1;
+    if (pagination.cursor) {
+      rows.push(
+        ...(await ctx.db
+          .query("conversions")
+          .withIndex("by_siteId_and_timestamp", (range) =>
+            range
+              .eq("siteId", args.siteId)
+              .eq("timestamp", pagination.cursor!.timestamp)
+              .lt("_creationTime", pagination.cursor!.creationTime),
+          )
+          .order("desc")
+          .take(take)),
+      );
+      if (rows.length < take) {
+        rows.push(
+          ...(await ctx.db
+            .query("conversions")
+            .withIndex("by_siteId_and_timestamp", (range) =>
+              range
+                .eq("siteId", args.siteId)
+                .gte("timestamp", args.from)
+                .lt("timestamp", pagination.cursor!.timestamp),
+            )
+            .order("desc")
+            .take(take - rows.length)),
+        );
+      }
+    } else {
+      rows.push(
+        ...(await ctx.db
+          .query("conversions")
+          .withIndex("by_siteId_and_timestamp", (range) =>
+            range
+              .eq("siteId", args.siteId)
+              .gte("timestamp", args.from)
+              .lte("timestamp", args.to),
+          )
+          .order("desc")
+          .take(take)),
+      );
+    }
+    return keysetPaginationResult(rows, pagination, (row) => ({
+      timestamp: row.timestamp,
+      creationTime: row._creationTime,
+    }));
   },
 });
 
@@ -355,25 +451,22 @@ export const visitorJourney = query({
     if (!Number.isSafeInteger(limit) || limit < 1 || limit > MAX_JOURNEY_EVENTS) {
       fail("INVALID_ARGUMENT", `limit must be an integer between 1 and ${MAX_JOURNEY_EVENTS}`);
     }
-    const rows = [];
+    const rows: RawJourneyEvent[] = [];
     for (const siteId of siteIds) {
-      rows.push(
-        ...(await ctx.db
-          .query("events")
-          .withIndex("by_siteId_and_visitorId_and_timestamp", (range) =>
-            range
-              .eq("siteId", siteId)
-              .eq("visitorId", args.visitorId)
-              .gte("timestamp", args.from)
-              .lte("timestamp", args.to),
-          )
-          .order("asc")
-          .take(limit)),
-      );
+      const cutoff = rows.length >= limit
+        ? rows[limit - 1]!.timestamp
+        : args.to;
+      rows.push(...await loadVisitorJourneyEvents(ctx, {
+        siteId,
+        visitorId: args.visitorId,
+        from: args.from,
+        to: cutoff,
+        resultLimit: limit,
+      }));
+      rows.sort(compareJourneyEvents);
+      if (rows.length > limit) rows.length = limit;
     }
-    return rows
-      .sort((left, right) => left.timestamp - right.timestamp || left.sequence - right.sequence)
-      .slice(0, limit);
+    return hydrateEventContexts(ctx, rows);
   },
 });
 
@@ -633,24 +726,45 @@ function validateRange(from: number, to: number, maxDays: number) {
   return { from: Math.trunc(from), to: Math.trunc(to) };
 }
 
-type ManualPaginationInput = {
+type KeysetPaginationInput = {
   cursor: string | null;
   numItems: number;
   maximumRowsRead?: number;
   maximumBytesRead?: number;
 };
 
-type ManualPagination = {
-  offset: number;
+type PaginationScope = {
+  kind: "sessions" | "events" | "conversions";
+  siteId: string;
+  sessionId?: string;
+  from: number;
+  to: number;
+};
+
+type KeysetCursor = {
+  timestamp: number;
+  creationTime: number;
+};
+
+type KeysetPagination = {
+  numItems: number;
+  scope: PaginationScope;
+  cursor: KeysetCursor | null;
+};
+
+type JourneyPagination = {
   numItems: number;
+  scope: PaginationScope & { kind: "events"; sessionId: string };
+  cursor: JourneyCursor | null;
 };
 
-function parseManualPagination(
-  options: ManualPaginationInput,
-): ManualPagination {
+function parseKeysetPagination(
+  options: KeysetPaginationInput,
+  scope: PaginationScope,
+): KeysetPagination {
   validatePagination(options);
   if (options.cursor === null) {
-    return { offset: 0, numItems: options.numItems };
+    return { numItems: options.numItems, scope, cursor: null };
   }
   let decoded: unknown;
   try {
@@ -660,35 +774,130 @@ function parseManualPagination(
   }
   if (
     !isPlainRecord(decoded) ||
-    decoded.v !== 1 ||
-    typeof decoded.o !== "number" ||
-    !Number.isSafeInteger(decoded.o) ||
-    decoded.o < 0 ||
-    decoded.o > MAX_MANUAL_PAGINATION_OFFSET
+    decoded.v !== 2 ||
+    decoded.k !== scope.kind ||
+    decoded.s !== scope.siteId ||
+    decoded.n !== (scope.sessionId ?? null) ||
+    decoded.f !== scope.from ||
+    decoded.t !== scope.to ||
+    typeof decoded.x !== "number" ||
+    !Number.isFinite(decoded.x) ||
+    decoded.x < scope.from ||
+    decoded.x > scope.to ||
+    typeof decoded.c !== "number" ||
+    !Number.isFinite(decoded.c) ||
+    decoded.c < 0
   ) {
-    fail("INVALID_ARGUMENT", "pagination cursor is invalid or exceeds the offset limit");
+    fail("INVALID_ARGUMENT", "pagination cursor is invalid for this query");
   }
-  return { offset: decoded.o, numItems: options.numItems };
+  return {
+    numItems: options.numItems,
+    scope,
+    cursor: {
+      timestamp: decoded.x,
+      creationTime: decoded.c,
+    },
+  };
 }
 
-function manualPaginationResult<T>(
+function parseJourneyPagination(
+  options: KeysetPaginationInput,
+  scope: PaginationScope & { kind: "events"; sessionId: string },
+): JourneyPagination {
+  validatePagination(options);
+  if (options.cursor === null) {
+    return { numItems: options.numItems, scope, cursor: null };
+  }
+  let decoded: unknown;
+  try {
+    decoded = JSON.parse(atob(options.cursor));
+  } catch {
+    fail("INVALID_ARGUMENT", "pagination cursor is malformed");
+  }
+  if (
+    !isPlainRecord(decoded) ||
+    decoded.v !== 4 ||
+    decoded.k !== scope.kind ||
+    decoded.s !== scope.siteId ||
+    decoded.n !== scope.sessionId ||
+    decoded.f !== scope.from ||
+    decoded.t !== scope.to ||
+    typeof decoded.x !== "number" ||
+    !Number.isFinite(decoded.x) ||
+    decoded.x < scope.from ||
+    decoded.x > scope.to ||
+    typeof decoded.c !== "number" ||
+    !Number.isFinite(decoded.c) ||
+    decoded.c < 0 ||
+    typeof decoded.i !== "string" ||
+    decoded.i.length === 0
+  ) {
+    fail("INVALID_ARGUMENT", "pagination cursor is invalid for this query");
+  }
+  return {
+    numItems: options.numItems,
+    scope,
+    cursor: {
+      timestamp: decoded.x,
+      creationTime: decoded.c,
+      id: decoded.i,
+    },
+  };
+}
+
+function keysetPaginationResult<T>(
   rows: T[],
-  pagination: ManualPagination,
+  pagination: KeysetPagination,
+  cursorFor: (row: T) => KeysetCursor,
 ) {
-  const page = rows.slice(
-    pagination.offset,
-    pagination.offset + pagination.numItems,
-  );
-  const nextOffset = pagination.offset + page.length;
-  const isDone =
-    rows.length <= pagination.offset + pagination.numItems ||
-    nextOffset >= MAX_MANUAL_PAGINATION_OFFSET;
+  const page = rows.slice(0, pagination.numItems);
+  const isDone = rows.length <= pagination.numItems;
+  const next = page.length > 0
+    ? cursorFor(page[page.length - 1])
+    : pagination.cursor;
+  return {
+    page,
+    isDone,
+    continueCursor: btoa(JSON.stringify({
+      v: 2,
+      k: pagination.scope.kind,
+      s: pagination.scope.siteId,
+      n: pagination.scope.sessionId ?? null,
+      f: pagination.scope.from,
+      t: pagination.scope.to,
+      x: next?.timestamp ?? pagination.scope.to,
+      c: next?.creationTime ?? Number.MAX_SAFE_INTEGER,
+    })),
+  };
+}
+
+function journeyPaginationResult(
+  rows: Awaited<ReturnType<typeof hydrateEventContexts>>,
+  pagination: JourneyPagination,
+) {
+  const page = rows.slice(0, pagination.numItems);
+  const isDone = rows.length <= pagination.numItems;
+  const last = page.at(-1);
+  const next = last
+      ? {
+          timestamp: last.timestamp,
+          creationTime: last._creationTime,
+          id: last._id,
+      }
+    : pagination.cursor;
   return {
     page,
     isDone,
     continueCursor: btoa(JSON.stringify({
-      v: 1,
-      o: Math.min(nextOffset, MAX_MANUAL_PAGINATION_OFFSET),
+      v: 4,
+      k: pagination.scope.kind,
+      s: pagination.scope.siteId,
+      n: pagination.scope.sessionId,
+      f: pagination.scope.from,
+      t: pagination.scope.to,
+      x: next?.timestamp ?? pagination.scope.to,
+      c: next?.creationTime ?? Number.MAX_SAFE_INTEGER,
+      i: next?.id ?? "~",
     })),
   };
 }