convex-feedback 0.1.4 → 0.1.5

package/src/component/entries.ts

@@ -20,6 +20,8 @@ import {
   actorValidator,
   entryKindValidator,
   entrySortValidator,
+  entryStatusFilterForStatus,
+  entryStatusFilterValidator,
   entryStatusValidator,
   feedbackMetadataValidator,
   publicEntryValidator,
@@ -63,6 +65,7 @@ export const list = query({
     paginationOpts: paginationOptsValidator,
     kinds: v.optional(v.array(entryKindValidator)),
     status: v.optional(entryStatusValidator),
+    statusFilter: v.optional(entryStatusFilterValidator),
     sort: entrySortValidator,
     viewerActorId: v.optional(v.string()),
   },
@@ -70,11 +73,82 @@ export const list = query({
   handler: async (ctx, args) => {
     const db = paginator(ctx.db, schema);
     const kinds = normalizeKindFilter(args.kinds);
-    const { status } = args;
+    const { status, statusFilter } = args;
+
+    if (status !== undefined && statusFilter !== undefined) {
+      throw new ConvexError(
+        "`status` and `statusFilter` cannot be used together.",
+      );
+    }
 
     let result: PaginationResult<Doc<"entries">>;
 
-    if (kinds === undefined) {
+    if (statusFilter !== undefined) {
+      if (kinds === undefined) {
+        result =
+          args.sort === "top"
+            ? await db
+                .query("entries")
+                .withIndex("by_status_filter_upvotes", (q) =>
+                  q.eq("statusFilter", statusFilter),
+                )
+                .order("desc")
+                .paginate(args.paginationOpts)
+            : await db
+                .query("entries")
+                .withIndex("by_status_filter", (q) =>
+                  q.eq("statusFilter", statusFilter),
+                )
+                .order("desc")
+                .paginate(args.paginationOpts);
+      } else if (kinds.length === 1) {
+        const kind = kinds[0];
+
+        if (kind === undefined) {
+          throw new ConvexError("Invalid kind filter.");
+        }
+
+        result =
+          args.sort === "top"
+            ? await db
+                .query("entries")
+                .withIndex("by_kind_status_filter_upvotes", (q) =>
+                  q.eq("kind", kind).eq("statusFilter", statusFilter),
+                )
+                .order("desc")
+                .paginate(args.paginationOpts)
+            : await db
+                .query("entries")
+                .withIndex("by_kind_status_filter", (q) =>
+                  q.eq("kind", kind).eq("statusFilter", statusFilter),
+                )
+                .order("desc")
+                .paginate(args.paginationOpts);
+      } else {
+        const streams = kinds.map((kind) =>
+          args.sort === "top"
+            ? stream(ctx.db, schema)
+                .query("entries")
+                .withIndex("by_kind_status_filter_upvotes", (q) =>
+                  q.eq("kind", kind).eq("statusFilter", statusFilter),
+                )
+                .order("desc")
+            : stream(ctx.db, schema)
+                .query("entries")
+                .withIndex("by_kind_status_filter", (q) =>
+                  q.eq("kind", kind).eq("statusFilter", statusFilter),
+                )
+                .order("desc"),
+        );
+
+        result = await mergedStream(
+          streams,
+          args.sort === "top"
+            ? ["upvoteCount", "_creationTime"]
+            : ["_creationTime"],
+        ).paginate(args.paginationOpts);
+      }
+    } else if (kinds === undefined) {
       result =
         args.sort === "top"
           ? status === undefined
@@ -223,6 +297,7 @@ export const search = query({
     searchQuery: v.string(),
     kinds: v.optional(v.array(entryKindValidator)),
     status: v.optional(entryStatusValidator),
+    statusFilter: v.optional(entryStatusFilterValidator),
     limit: v.number(),
     viewerActorId: v.optional(v.string()),
   },
@@ -235,11 +310,67 @@ export const search = query({
     }
 
     const kinds = normalizeKindFilter(args.kinds);
-    const { status } = args;
+    const { status, statusFilter } = args;
+
+    if (status !== undefined && statusFilter !== undefined) {
+      throw new ConvexError(
+        "`status` and `statusFilter` cannot be used together.",
+      );
+    }
 
     let entries: Doc<"entries">[];
 
-    if (kinds === undefined) {
+    if (statusFilter !== undefined) {
+      if (kinds === undefined) {
+        entries = await ctx.db
+          .query("entries")
+          .withSearchIndex("search", (q) =>
+            q
+              .search("searchText", searchQuery)
+              .eq("statusFilter", statusFilter),
+          )
+          .take(args.limit);
+      } else if (kinds.length === 1) {
+        const kind = kinds[0];
+
+        if (kind === undefined) {
+          throw new ConvexError("Invalid kind filter.");
+        }
+
+        entries = await ctx.db
+          .query("entries")
+          .withSearchIndex("search", (q) =>
+            q
+              .search("searchText", searchQuery)
+              .eq("kind", kind)
+              .eq("statusFilter", statusFilter),
+          )
+          .take(args.limit);
+      } else {
+        const firstKind = kinds[0];
+        const secondKind = kinds[1];
+
+        if (firstKind === undefined || secondKind === undefined) {
+          throw new ConvexError("Invalid kind filter.");
+        }
+
+        entries = await ctx.db
+          .query("entries")
+          .withSearchIndex("search", (q) =>
+            q
+              .search("searchText", searchQuery)
+              .eq("statusFilter", statusFilter),
+          )
+          // eslint-disable-next-line @convex-dev/no-filter-in-query
+          .filter((q) =>
+            q.or(
+              q.eq(q.field("kind"), firstKind),
+              q.eq(q.field("kind"), secondKind),
+            ),
+          )
+          .take(args.limit);
+      }
+    } else if (kinds === undefined) {
       entries =
         status === undefined
           ? await ctx.db
@@ -453,6 +584,7 @@ export const create = mutation({
       actorId: args.actorId,
       kind: args.kind,
       status: args.defaultStatus,
+      statusFilter: entryStatusFilterForStatus(args.defaultStatus),
       title,
       body,
       normalizedTitle: normalizeTitle(title),
@@ -504,6 +636,7 @@ export const update = mutation({
       body,
       normalizedTitle: normalizeTitle(title),
       searchText: `${title}\n${body}`,
+      statusFilter: entryStatusFilterForStatus(entry.status),
       updatedAt: Date.now(),
     });
     return null;
@@ -526,6 +659,7 @@ export const setStatus = mutation({
     }
     await ctx.db.patch("entries", args.entryId, {
       status: args.status,
+      statusFilter: entryStatusFilterForStatus(args.status),
       updatedAt: Date.now(),
     });
     return null;
@@ -557,14 +691,20 @@ export const setUpvote = mutation({
         entryId: args.entryId,
       });
       const upvoteCount = entry.upvoteCount + 1;
-      await ctx.db.patch("entries", args.entryId, { upvoteCount });
+      await ctx.db.patch("entries", args.entryId, {
+        upvoteCount,
+        statusFilter: entryStatusFilterForStatus(entry.status),
+      });
       return { active: true, upvoteCount };
     }
 
     if (!args.desiredState && existing !== null) {
       await ctx.db.delete("reactions", existing._id);
       const upvoteCount = Math.max(0, entry.upvoteCount - 1);
-      await ctx.db.patch("entries", args.entryId, { upvoteCount });
+      await ctx.db.patch("entries", args.entryId, {
+        upvoteCount,
+        statusFilter: entryStatusFilterForStatus(entry.status),
+      });
       return { active: false, upvoteCount };
     }
 

package/src/component/migrations.ts

@@ -0,0 +1,44 @@
+import { v } from "convex/values";
+
+import { internal } from "./_generated/api.js";
+import { internalMutation } from "./_generated/server.js";
+import { entryStatusFilterForStatus } from "./model.js";
+
+const statusFilterMigrationBatchSize = 100;
+
+/**
+ * Backfills one bounded batch of legacy entries and schedules the next batch.
+ *
+ * The indexed undefined lookup and deterministic status mapping make this
+ * safe to run concurrently, retry, or invoke again after completion.
+ */
+export const backfillStatusFilter = internalMutation({
+  args: {},
+  returns: v.object({
+    updated: v.number(),
+    hasMore: v.boolean(),
+  }),
+  handler: async (ctx) => {
+    const entries = await ctx.db
+      .query("entries")
+      .withIndex("by_status_filter", (q) => q.eq("statusFilter", undefined))
+      .take(statusFilterMigrationBatchSize);
+
+    for (const entry of entries) {
+      await ctx.db.patch("entries", entry._id, {
+        statusFilter: entryStatusFilterForStatus(entry.status),
+      });
+    }
+
+    const hasMore = entries.length === statusFilterMigrationBatchSize;
+    if (hasMore) {
+      await ctx.scheduler.runAfter(
+        0,
+        internal.migrations.backfillStatusFilter,
+        {},
+      );
+    }
+
+    return { updated: entries.length, hasMore };
+  },
+});

package/src/component/model.ts

@@ -16,6 +16,11 @@ export const entryStatusValidator = v.union(
   v.literal("closed"),
 );
 
+export const entryStatusFilterValidator = v.union(
+  v.literal("open"),
+  v.literal("closed"),
+);
+
 export const entrySortValidator = v.union(
   v.literal("top"),
   v.literal("newest"),
@@ -100,6 +105,15 @@ export type EntryKind = Infer<typeof entryKindValidator>;
  */
 export type EntryStatus = Infer<typeof entryStatusValidator>;
 
+/** Coarse status bucket used by the indexed board and search filters. */
+export type EntryStatusFilter = Infer<typeof entryStatusFilterValidator>;
+
+export function entryStatusFilterForStatus(
+  status: EntryStatus,
+): EntryStatusFilter {
+  return status === "closed" ? "closed" : "open";
+}
+
 /**
  * Server-side ordering strategy for feedback entries.
  *

package/src/component/schema.ts

@@ -3,6 +3,7 @@ import { v } from "convex/values";
 
 import {
   entryKindValidator,
+  entryStatusFilterValidator,
   entryStatusValidator,
   feedbackMetadataValidator,
 } from "./model.js";
@@ -12,6 +13,7 @@ const schema = defineSchema({
     actorId: v.string(),
     kind: entryKindValidator,
     status: entryStatusValidator,
+    statusFilter: v.optional(entryStatusFilterValidator),
     title: v.string(),
     body: v.string(),
     normalizedTitle: v.string(),
@@ -24,15 +26,23 @@ const schema = defineSchema({
     .index("by_kind", ["kind"])
     .index("by_status", ["status"])
     .index("by_kind_status", ["kind", "status"])
+    .index("by_status_filter", ["statusFilter"])
+    .index("by_kind_status_filter", ["kind", "statusFilter"])
     .index("by_upvotes", ["upvoteCount"])
     .index("by_kind_upvotes", ["kind", "upvoteCount"])
     .index("by_status_upvotes", ["status", "upvoteCount"])
     .index("by_kind_status_upvotes", ["kind", "status", "upvoteCount"])
+    .index("by_status_filter_upvotes", ["statusFilter", "upvoteCount"])
+    .index("by_kind_status_filter_upvotes", [
+      "kind",
+      "statusFilter",
+      "upvoteCount",
+    ])
     .index("by_normalized_title", ["normalizedTitle"])
     .index("by_kind_normalized_title", ["kind", "normalizedTitle"])
     .searchIndex("search", {
       searchField: "searchText",
-      filterFields: ["kind", "status"],
+      filterFields: ["kind", "status", "statusFilter"],
     }),
 
   comments: defineTable({

package/src/react/index.ts

@@ -9,6 +9,7 @@ import type {
   EntryKind,
   EntrySort,
   EntryStatus,
+  EntryStatusFilter,
   SimilarEntriesResult,
 } from "../component/model.js";
 
@@ -61,6 +62,9 @@ export interface UseEntriesArgs {
   /** Optional workflow-status filter. */
   status?: EntryStatus;
 
+  /** Optional indexed open or closed board bucket. */
+  statusFilter?: EntryStatusFilter;
+
   /**
    * Server-side entry ordering.
    *
@@ -120,6 +124,9 @@ export interface SearchEntriesArgs {
   /** Optional workflow-status filter. */
   status?: EntryStatus;
 
+  /** Optional indexed open or closed board bucket. */
+  statusFilter?: EntryStatusFilter;
+
   /**
    * Maximum number of results requested.
    *
@@ -212,6 +219,9 @@ function createFeedbackHooksImplementation<RateLimitResult>(
       const queryArgs = {
         ...(args.kinds === undefined ? {} : { kinds: [...args.kinds] }),
         ...(args.status === undefined ? {} : { status: args.status }),
+        ...(args.statusFilter === undefined
+          ? {}
+          : { statusFilter: args.statusFilter }),
         ...(args.sort === undefined ? {} : { sort: args.sort }),
       };
 
@@ -244,6 +254,9 @@ function createFeedbackHooksImplementation<RateLimitResult>(
         searchQuery,
         ...(args.kinds === undefined ? {} : { kinds: [...args.kinds] }),
         ...(args.status === undefined ? {} : { status: args.status }),
+        ...(args.statusFilter === undefined
+          ? {}
+          : { statusFilter: args.statusFilter }),
         ...(args.limit === undefined ? {} : { limit: args.limit }),
       };