@convex-dev/agent 0.1.9 → 0.1.10-alpha.1

package/src/component/streams.ts

@@ -6,7 +6,7 @@ import {
   vStreamMessage,
 } from "../validators.js";
 import { api, internal } from "./_generated/api.js";
-import type { Id } from "./_generated/dataModel.js";
+import type { Doc, Id } from "./_generated/dataModel.js";
 import {
   internalMutation,
   mutation,
@@ -106,33 +106,87 @@ export const create = mutation({
 export const list = query({
   args: {
     threadId: v.id("threads"),
+    startOrder: v.optional(v.number()),
+    statuses: v.optional(
+      v.array(
+        v.union(
+          v.literal("streaming"),
+          v.literal("finished"),
+          v.literal("aborted")
+        )
+      )
+    ),
   },
   returns: v.array(vStreamMessage),
   handler: async (ctx, args) => {
-    return ctx.db
-      .query("streamingMessages")
-      .withIndex("threadId_state_order_stepOrder", (q) =>
-        q.eq("threadId", args.threadId).eq("state.kind", "streaming")
-      )
-      .order("desc")
-      .take(100)
-      .then((msgs) =>
-        msgs.map((m) => ({
-          streamId: m._id,
-          ...pick(m, [
-            "order",
-            "stepOrder",
-            "userId",
-            "agentName",
-            "model",
-            "provider",
-            "providerOptions",
-          ]),
-        }))
+    const statuses = args.statuses ?? ["streaming"];
+    const messages = await mergedStream(
+      statuses.map((status) =>
+        stream(ctx.db, schema)
+          .query("streamingMessages")
+          .withIndex("threadId_state_order_stepOrder", (q) =>
+            q
+              .eq("threadId", args.threadId)
+              .eq("state.kind", status)
+              .gte("order", args.startOrder ?? 0)
+          )
+          .order("desc")
+      ),
+      ["order", "stepOrder"]
+    ).take(100);
+
+    return messages.map((m) => ({
+      streamId: m._id,
+      status: m.state.kind,
+      ...pick(m, [
+        "order",
+        "stepOrder",
+        "userId",
+        "agentName",
+        "model",
+        "provider",
+        "providerOptions",
+      ]),
+    }));
+  },
+});
+
+export const abort = mutation({
+  args: {
+    streamId: v.id("streamingMessages"),
+    reason: v.string(),
+  },
+  returns: v.null(),
+  handler: async (ctx, args) => {
+    const stream = await ctx.db.get(args.streamId);
+    if (!stream) {
+      throw new Error(`Stream not found: ${args.streamId}`);
+    }
+    if (stream.state.kind !== "streaming") {
+      console.warn(
+        `Stream trying to abort but not currently streaming (${stream.state.kind}): ${args.streamId}`
       );
+      return;
+    }
+    await cleanupTimeoutFn(ctx, stream);
+    await ctx.db.patch(args.streamId, {
+      state: { kind: "aborted", reason: args.reason },
+    });
   },
 });
 
+async function cleanupTimeoutFn(
+  ctx: MutationCtx,
+  stream: Doc<"streamingMessages">
+) {
+  if (stream.state.kind === "streaming" && stream.state.timeoutFnId) {
+    const timeoutFn = await ctx.db.system.get(stream.state.timeoutFnId);
+    if (timeoutFn?.state.kind === "pending") {
+      await ctx.scheduler.cancel(stream.state.timeoutFnId);
+    }
+  }
+}
+
 export const finish = mutation({
   args: {
     streamId: v.id("streamingMessages"),
@@ -153,20 +207,15 @@ export const finish = mutation({
       );
       return;
     }
-    if (stream.state.timeoutFnId) {
-      const timeoutFn = await ctx.db.system.get(stream.state.timeoutFnId);
-      if (timeoutFn?.state.kind === "pending") {
-        await ctx.scheduler.cancel(stream.state.timeoutFnId);
-      }
-    }
-    await ctx.db.patch(args.streamId, {
-      state: { kind: "finished", endedAt: Date.now() },
-    });
-    await ctx.scheduler.runAfter(
+    await cleanupTimeoutFn(ctx, stream);
+    const cleanupFnId = await ctx.scheduler.runAfter(
       DELETE_STREAM_DELAY,
       api.streams.deleteStreamAsync,
       { streamId: args.streamId }
     );
+    await ctx.db.patch(args.streamId, {
+      state: { kind: "finished", endedAt: Date.now(), cleanupFnId },
+    });
   },
 });
 
@@ -217,14 +266,14 @@ export const timeoutStream = internalMutation({
   returns: v.null(),
   handler: async (ctx, args) => {
     const stream = await ctx.db.get(args.streamId);
-    if (!stream) {
+    if (!stream || stream.state.kind !== "streaming") {
       console.warn("Stream not found", args.streamId);
       return;
     }
     await ctx.db.patch(args.streamId, {
       state: {
-        kind: "finished",
-        endedAt: Date.now(),
+        kind: "aborted",
+        reason: "timeout",
       },
     });
   },
@@ -243,7 +292,14 @@ async function deletePageForStreamId(
     });
   await Promise.all(deltas.page.map((d) => ctx.db.delete(d._id)));
   if (deltas.isDone) {
-    await ctx.db.delete(args.streamId);
+    const stream = await ctx.db.get(args.streamId);
+    if (stream) {
+      await cleanupTimeoutFn(ctx, stream);
+      if (stream.state.kind === "finished" && stream.state.cleanupFnId) {
+        await ctx.scheduler.cancel(stream.state.cleanupFnId);
+      }
+      await ctx.db.delete(args.streamId);
+    }
   }
   return deltas;
 }

package/src/react/deltas.ts

@@ -256,12 +256,14 @@ export function createStreamingMessage(
 ): MessageDoc {
   const { streamId, ...rest } = message;
   const metadata: MessageDoc = {
+    ...rest,
     _id: `${streamId}-${index}`,
     _creationTime: Date.now(),
-    status: "pending",
+    status: (
+      { streaming: "pending", finished: "success", aborted: "failed" } as const
+    )[message.status],
     threadId,
     tool: false,
-    ...rest,
   };
   switch (part.type) {
     case "text-delta":

package/src/react/index.ts

@@ -1,5 +1,5 @@
 "use client";
-import type { ErrorMessage } from "convex-helpers";
+import { omit, type ErrorMessage } from "convex-helpers";
 import {
   type PaginatedQueryArgs,
   type UsePaginatedQueryResult,
@@ -7,7 +7,7 @@ import {
 } from "convex/react";
 import { usePaginatedQuery } from "convex-helpers/react";
 import type { FunctionArgs } from "convex/server";
-import { useMemo, useState } from "react";
+import { useMemo, useRef, useState } from "react";
 import type { MessageDoc } from "../client/index.js";
 import type { SyncStreamsReturnValue } from "../client/types.js";
 import type { StreamArgs } from "../validators.js";
@@ -103,14 +103,18 @@ export function useThreadMessages<
       ThreadMessagesArgs<Query>,
       ThreadMessagesResult<Query>
     >,
-    !options.stream ? "skip" : args
+    !options.stream ||
+      args === "skip" ||
+      paginated.status === "LoadingFirstPage"
+      ? "skip"
+      : { ...args, startOrder: paginated.results.at(-1)?.order }
   );
 
   const merged = useMemo(() => {
     const streamListMessages =
       streamMessages?.map((m) => ({
         ...m,
-        streaming: true,
+        streaming: !m.status || m.status === "streaming",
       })) ?? [];
     return {
       ...paginated,
@@ -150,7 +154,7 @@ export function useStreamingThreadMessages<
   Query extends ThreadStreamQuery<any, any>,
 >(
   query: Query,
-  args: ThreadMessagesArgs<Query> | "skip"
+  args: (ThreadMessagesArgs<Query> & { startOrder?: number }) | "skip"
 ): Array<ThreadMessagesResult<Query>> | undefined {
   // Invariant: streamMessages[streamId] is comprised of all deltas up to the
   // cursor. There can be multiple messages in the same stream, e.g. for tool
@@ -158,15 +162,23 @@ export function useStreamingThreadMessages<
   const [streams, setStreams] = useState<
     Array<{ streamId: string; cursor: number; messages: MessageDoc[] }>
   >([]);
+  const startOrderRef = useRef<number>(0);
+  const queryArgs = args === "skip" ? args : omit(args, ["startOrder"]);
+  if (args !== "skip" && !startOrderRef.current && args.startOrder) {
+    startOrderRef.current = args.startOrder;
+  }
   // Get all the active streams
   const streamList = useQuery(
     query,
-    args === "skip"
-      ? args
+    queryArgs === "skip"
+      ? queryArgs
       : ({
-          ...args,
+          ...queryArgs,
           paginationOpts: { cursor: null, numItems: 0 },
-          streamArgs: { kind: "list" } as StreamArgs,
+          streamArgs: {
+            kind: "list",
+            startOrder: startOrderRef.current,
+          } as StreamArgs,
         } as FunctionArgs<Query>)
   ) as
     | { streams: Extract<SyncStreamsReturnValue, { kind: "list" }> }
@@ -186,10 +198,10 @@ export function useStreamingThreadMessages<
   // Get the deltas for all the active streams, if any.
   const cursorQuery = useQuery(
     query,
-    args === "skip" || !streamList
+    queryArgs === "skip" || !streamList
       ? ("skip" as const)
       : ({
-          ...args,
+          ...queryArgs,
           paginationOpts: { cursor: null, numItems: 0 },
           streamArgs: { kind: "deltas", cursors } as StreamArgs,
         } as FunctionArgs<Query>)

package/src/react/optimisticallySendMessage.ts

@@ -11,7 +11,7 @@ export function optimisticallySendMessage(
 ) => void {
   return (store, args) => {
     const queries = store.getAllQueries(query);
-    let maxOrder = 0;
+    let maxOrder = -1;
     let maxStepOrder = 0;
     for (const q of queries) {
       if (q.args?.threadId !== args.threadId) continue;

package/src/validators.ts

@@ -460,6 +460,7 @@ export const vStreamArgs = v.optional(
   v.union(
     v.object({
       kind: v.literal("list"),
+      startOrder: v.optional(v.number()),
     }),
     v.object({
       kind: v.literal("deltas"),
@@ -471,6 +472,11 @@ export type StreamArgs = Infer<typeof vStreamArgs>;
 
 export const vStreamMessage = v.object({
   streamId: v.string(),
+  status: v.union(
+    v.literal("streaming"),
+    v.literal("finished"),
+    v.literal("aborted")
+  ),
   order: v.number(),
   stepOrder: v.number(),
   // metadata