Various fixes and accepted recommendations by CodeRabbit

ericallam · ericallam · commit 8e97108b4334 · 2024-11-18T13:41:12.000Z
diff --git a/apps/webapp/app/routes/api.v1.packets.$.ts b/apps/webapp/app/routes/api.v1.packets.$.ts
@@ -2,7 +2,7 @@ import type { ActionFunctionArgs } from "@remix-run/server-runtime";
 import { json } from "@remix-run/server-runtime";
 import { z } from "zod";
 import { authenticateApiRequest } from "~/services/apiAuth.server";
-import { createLoaderApiRoute } from "~/services/routeBuiilders/apiBuilder.server";
+import { createLoaderApiRoute } from "~/services/routeBuilders/apiBuilder.server";
 import { generatePresignedUrl } from "~/v3/r2.server";
 
 const ParamsSchema = z.object({
diff --git a/apps/webapp/app/routes/api.v1.projects.$projectRef.runs.ts b/apps/webapp/app/routes/api.v1.projects.$projectRef.runs.ts
@@ -5,7 +5,7 @@ import {
   ApiRunListPresenter,
   ApiRunListSearchParams,
 } from "~/presenters/v3/ApiRunListPresenter.server";
-import { createLoaderPATApiRoute } from "~/services/routeBuiilders/apiBuilder.server";
+import { createLoaderPATApiRoute } from "~/services/routeBuilders/apiBuilder.server";
 
 const ParamsSchema = z.object({
   projectRef: z.string(),
diff --git a/apps/webapp/app/routes/api.v1.runs.ts b/apps/webapp/app/routes/api.v1.runs.ts
@@ -3,7 +3,7 @@ import {
   ApiRunListPresenter,
   ApiRunListSearchParams,
 } from "~/presenters/v3/ApiRunListPresenter.server";
-import { createLoaderApiRoute } from "~/services/routeBuiilders/apiBuilder.server";
+import { createLoaderApiRoute } from "~/services/routeBuilders/apiBuilder.server";
 
 export const loader = createLoaderApiRoute(
   {
diff --git a/apps/webapp/app/routes/api.v1.tasks.$taskId.trigger.ts b/apps/webapp/app/routes/api.v1.tasks.$taskId.trigger.ts
@@ -5,7 +5,7 @@ import { z } from "zod";
 import { env } from "~/env.server";
 import { AuthenticatedEnvironment } from "~/services/apiAuth.server";
 import { logger } from "~/services/logger.server";
-import { createActionApiRoute } from "~/services/routeBuiilders/apiBuilder.server";
+import { createActionApiRoute } from "~/services/routeBuilders/apiBuilder.server";
 import { ServiceValidationError } from "~/v3/services/baseService.server";
 import { OutOfEntitlementError, TriggerTaskService } from "~/v3/services/triggerTask.server";
 
diff --git a/apps/webapp/app/routes/api.v3.runs.$runId.ts b/apps/webapp/app/routes/api.v3.runs.$runId.ts
@@ -1,7 +1,7 @@
 import { json } from "@remix-run/server-runtime";
 import { z } from "zod";
 import { ApiRetrieveRunPresenter } from "~/presenters/v3/ApiRetrieveRunPresenter.server";
-import { createLoaderApiRoute } from "~/services/routeBuiilders/apiBuilder.server";
+import { createLoaderApiRoute } from "~/services/routeBuilders/apiBuilder.server";
 
 const ParamsSchema = z.object({
   runId: z.string(),
diff --git a/apps/webapp/app/routes/realtime.v1.batches.$batchId.ts b/apps/webapp/app/routes/realtime.v1.batches.$batchId.ts
@@ -2,7 +2,7 @@ import { json } from "@remix-run/server-runtime";
 import { z } from "zod";
 import { $replica } from "~/db.server";
 import { realtimeClient } from "~/services/realtimeClientGlobal.server";
-import { createLoaderApiRoute } from "~/services/routeBuiilders/apiBuilder.server";
+import { createLoaderApiRoute } from "~/services/routeBuilders/apiBuilder.server";
 
 const ParamsSchema = z.object({
   batchId: z.string(),
diff --git a/apps/webapp/app/routes/realtime.v1.runs.$runId.ts b/apps/webapp/app/routes/realtime.v1.runs.$runId.ts
@@ -2,7 +2,7 @@ import { json } from "@remix-run/server-runtime";
 import { z } from "zod";
 import { $replica } from "~/db.server";
 import { realtimeClient } from "~/services/realtimeClientGlobal.server";
-import { createLoaderApiRoute } from "~/services/routeBuiilders/apiBuilder.server";
+import { createLoaderApiRoute } from "~/services/routeBuilders/apiBuilder.server";
 
 const ParamsSchema = z.object({
   runId: z.string(),
diff --git a/apps/webapp/app/routes/realtime.v1.runs.ts b/apps/webapp/app/routes/realtime.v1.runs.ts
@@ -1,6 +1,6 @@
 import { z } from "zod";
 import { realtimeClient } from "~/services/realtimeClientGlobal.server";
-import { createLoaderApiRoute } from "~/services/routeBuiilders/apiBuilder.server";
+import { createLoaderApiRoute } from "~/services/routeBuilders/apiBuilder.server";
 
 const SearchParamsSchema = z.object({
   tags: z
diff --git a/apps/webapp/app/routes/realtime.v1.streams.$runId.$streamId.ts b/apps/webapp/app/routes/realtime.v1.streams.$runId.$streamId.ts
@@ -2,7 +2,7 @@ import { ActionFunctionArgs } from "@remix-run/server-runtime";
 import { z } from "zod";
 import { $replica } from "~/db.server";
 import { realtimeStreams } from "~/services/realtimeStreamsGlobal.server";
-import { createLoaderApiRoute } from "~/services/routeBuiilders/apiBuilder.server";
+import { createLoaderApiRoute } from "~/services/routeBuilders/apiBuilder.server";
 
 const ParamsSchema = z.object({
   runId: z.string(),
diff --git a/apps/webapp/app/services/routeBuilders/apiBuilder.server.ts b/apps/webapp/app/services/routeBuilders/apiBuilder.server.ts
@@ -13,6 +13,7 @@ import {
   authenticateApiRequestWithPersonalAccessToken,
   PersonalAccessTokenAuthenticationResult,
 } from "../personalAccessToken.server";
+import { safeJsonParse } from "~/utils/json";
 
 type ApiKeyRouteBuilderOptions<
   TParamsSchema extends z.AnyZodObject | undefined = undefined,
@@ -448,7 +449,17 @@ export function createActionApiRoute<
         );
       }
 
-      const body = bodySchema.safeParse(JSON.parse(rawBody));
+      const rawParsedJson = safeJsonParse(rawBody);
+
+      if (!rawParsedJson) {
+        return wrapResponse(
+          request,
+          json({ error: "Invalid JSON" }, { status: 400 }),
+          corsStrategy !== "none"
+        );
+      }
+
+      const body = bodySchema.safeParse(rawParsedJson);
       if (!body.success) {
         return wrapResponse(
           request,
diff --git a/packages/core/src/v3/runMetadata/manager.ts b/packages/core/src/v3/runMetadata/manager.ts
@@ -173,25 +173,31 @@ export class StandardMetadataManager implements RunMetadataManager {
       return $value;
     }
 
-    // Add the key to the special stream metadata object
-    this.setKey(`$$stream.${key}`, key);
+    try {
+      // Add the key to the special stream metadata object
+      this.setKey(`$$stream.${key}`, key);
 
-    await this.flush();
+      await this.flush();
 
-    const streamInstance = new MetadataStream({
-      key,
-      runId: this.runId,
-      iterator: $value[Symbol.asyncIterator](),
-      baseUrl: this.streamsBaseUrl,
-      signal,
-    });
+      const streamInstance = new MetadataStream({
+        key,
+        runId: this.runId,
+        iterator: $value[Symbol.asyncIterator](),
+        baseUrl: this.streamsBaseUrl,
+        signal,
+      });
 
-    this.activeStreams.set(key, streamInstance);
+      this.activeStreams.set(key, streamInstance);
 
-    // Clean up when stream completes
-    streamInstance.wait().finally(() => this.activeStreams.delete(key));
+      // Clean up when stream completes
+      streamInstance.wait().finally(() => this.activeStreams.delete(key));
 
-    return streamInstance;
+      return streamInstance;
+    } catch (error) {
+      // Clean up metadata key if stream creation fails
+      this.deleteKey(`$$stream.${key}`);
+      throw error;
+    }
   }
 
   public hasActiveStreams(): boolean {
diff --git a/packages/core/src/v3/runMetadata/metadataStream.ts b/packages/core/src/v3/runMetadata/metadataStream.ts
@@ -1,5 +1,3 @@
-import { run } from "node:test";
-
 export type MetadataOptions<T> = {
   baseUrl: string;
   runId: string;
diff --git a/packages/react-hooks/src/hooks/useApiClient.ts b/packages/react-hooks/src/hooks/useApiClient.ts
@@ -12,8 +12,8 @@ export type UseApiClientOptions = {
 export function useApiClient(options?: UseApiClientOptions): ApiClient {
   const auth = useTriggerAuthContextOptional();
 
-  const baseUrl = auth?.baseURL ?? options?.baseURL ?? "https://api.trigger.dev";
-  const accessToken = auth?.accessToken ?? options?.accessToken;
+  const baseUrl = options?.baseURL ?? auth?.baseURL ?? "https://api.trigger.dev";
+  const accessToken = options?.accessToken ?? auth?.accessToken;
 
   if (!accessToken) {
     throw new Error("Missing accessToken in TriggerAuthContext or useApiClient options");
diff --git a/packages/react-hooks/src/hooks/useRealtime.ts b/packages/react-hooks/src/hooks/useRealtime.ts
@@ -87,6 +87,10 @@ export function useRealtimeRun<TTask extends AnyTask>(
       }
 
       setError(err as Error);
+    } finally {
+      if (abortControllerRef.current) {
+        abortControllerRef.current = null;
+      }
     }
   }, [runId, mutateRun, abortControllerRef, apiClient, setError]);
 
@@ -104,7 +108,7 @@ export function useRealtimeRun<TTask extends AnyTask>(
     return () => {
       stop();
     };
-  }, [runId, stop, options?.enabled]);
+  }, [runId, stop, options?.enabled, triggerRequest]);
 
   return { run, error, stop };
 }
@@ -208,6 +212,10 @@ export function useRealtimeRunWithStreams<
       }
 
       setError(err as Error);
+    } finally {
+      if (abortControllerRef.current) {
+        abortControllerRef.current = null;
+      }
     }
   }, [runId, mutateRun, mutateStreams, streamsRef, abortControllerRef, apiClient, setError]);
 
@@ -225,7 +233,7 @@ export function useRealtimeRunWithStreams<
     return () => {
       stop();
     };
-  }, [runId, stop, options?.enabled]);
+  }, [runId, stop, options?.enabled, triggerRequest]);
 
   return { run, streams: streams ?? initialStreamsFallback, error, stop };
 }
@@ -290,6 +298,10 @@ export function useRealtimeRunsWithTag<TTask extends AnyTask>(
       }
 
       setError(err as Error);
+    } finally {
+      if (abortControllerRef.current) {
+        abortControllerRef.current = null;
+      }
     }
   }, [tag, mutateRuns, runsRef, abortControllerRef, apiClient, setError]);
 
@@ -303,7 +315,7 @@ export function useRealtimeRunsWithTag<TTask extends AnyTask>(
     return () => {
       stop();
     };
-  }, [tag, stop, options?.enabled]);
+  }, [tag, stop, options?.enabled, triggerRequest]);
 
   return { runs: runs ?? [], error, stop };
 }
@@ -371,6 +383,10 @@ export function useRealtimeBatch<TTask extends AnyTask>(
       }
 
       setError(err as Error);
+    } finally {
+      if (abortControllerRef.current) {
+        abortControllerRef.current = null;
+      }
     }
   }, [batchId, mutateRuns, runsRef, abortControllerRef, apiClient, setError]);
 
@@ -384,7 +400,7 @@ export function useRealtimeBatch<TTask extends AnyTask>(
     return () => {
       stop();
     };
-  }, [batchId, stop, options?.enabled]);
+  }, [batchId, stop, options?.enabled, triggerRequest]);
 
   return { runs: runs ?? [], error, stop };
 }
diff --git a/packages/react-hooks/src/hooks/useTaskTrigger.ts b/packages/react-hooks/src/hooks/useTaskTrigger.ts
@@ -23,6 +23,7 @@ export interface TriggerInstance<TTask extends AnyTask> {
   submit: (payload: TaskPayload<TTask>) => void;
   isLoading: boolean;
   handle?: RunHandleFromTypes<InferRunTypes<TTask>>;
+  error?: Error;
 }
 
 export type UseTaskTriggerOptions = UseApiClientOptions;
@@ -69,6 +70,7 @@ export function useTaskTrigger<TTask extends AnyTask>(
     },
     isLoading: mutation.isMutating,
     handle: mutation.data as RunHandleFromTypes<InferRunTypes<TTask>>,
+    error: mutation.error,
   };
 }
 
@@ -124,7 +126,11 @@ export function useRealtimeTaskTrigger<TTask extends AnyTask>(
   });
 
   return {
-    ...realtimeInstance,
-    ...triggerInstance,
+    submit: triggerInstance.submit,
+    isLoading: triggerInstance.isLoading,
+    handle: triggerInstance.handle,
+    run: realtimeInstance.run,
+    error: realtimeInstance.error ?? triggerInstance.error,
+    stop: realtimeInstance.stop,
   };
 }
diff --git a/packages/rsc/package.json b/packages/rsc/package.json
@@ -9,7 +9,7 @@
   "repository": {
     "type": "git",
     "url": "https://github.com/triggerdotdev/trigger.dev",
-    "directory": "packages/react-hooks"
+    "directory": "packages/rsc"
   },
   "type": "module",
   "files": [
diff --git a/packages/trigger-sdk/src/v3/metadata.ts b/packages/trigger-sdk/src/v3/metadata.ts
@@ -109,14 +109,48 @@ function saveMetadata(metadata: RunMetadata): void {
   runMetadata.update(metadata);
 }
 
-function incrementMetadataKey(key: string, value: number) {
+/**
+ * Increments a numeric value in the metadata of the current run by the specified amount.
+ * This function allows you to atomically increment a numeric metadata value.
+ *
+ * @param {string} key - The key of the numeric value to increment.
+ * @param {number} value - The amount to increment the value by.
+ *
+ * @example
+ * metadata.increment("counter", 1); // Increments counter by 1
+ * metadata.increment("score", 10); // Increments score by 10
+ */
+function incrementMetadataKey(key: string, value: number = 1) {
   runMetadata.incrementKey(key, value);
 }
 
-function decrementMetadataKey(key: string, value: number) {
+/**
+ * Decrements a numeric value in the metadata of the current run by the specified amount.
+ * This function allows you to atomically decrement a numeric metadata value.
+ *
+ * @param {string} key - The key of the numeric value to decrement.
+ * @param {number} value - The amount to decrement the value by.
+ *
+ * @example
+ * metadata.decrement("counter", 1); // Decrements counter by 1
+ * metadata.decrement("score", 5); // Decrements score by 5
+ */
+function decrementMetadataKey(key: string, value: number = 1) {
   runMetadata.decrementKey(key, value);
 }
 
+/**
+ * Appends a value to an array in the metadata of the current run.
+ * If the key doesn't exist, it creates a new array with the value.
+ * If the key exists but isn't an array, it converts the existing value to an array.
+ *
+ * @param {string} key - The key of the array in metadata.
+ * @param {DeserializedJson} value - The value to append to the array.
+ *
+ * @example
+ * metadata.append("logs", "User logged in");
+ * metadata.append("events", { type: "click", timestamp: Date.now() });
+ */
 function appendMetadataKey(key: string, value: DeserializedJson) {
   runMetadata.appendKey(key, value);
 }
diff --git a/packages/trigger-sdk/src/v3/shared.ts b/packages/trigger-sdk/src/v3/shared.ts
@@ -44,6 +44,7 @@ import type {
   BatchRunHandleFromTypes,
   InferRunTypes,
   inferSchemaIn,
+  inferToolParameters,
   RetrieveRunResult,
   RunHandle,
   RunHandleFromTypes,
@@ -231,7 +232,7 @@ export function createToolTask<
     tool: {
       parameters: params.parameters,
       description: params.description,
-      execute: async (args: any) => {
+      execute: async (args: inferToolParameters<TParameters>) => {
         return task.triggerAndWait(args).unwrap();
       },
     },

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@ import {`
`3`	`3`	`ApiRunListPresenter,`
`4`	`4`	`ApiRunListSearchParams,`
`5`	`5`	`} from "~/presenters/v3/ApiRunListPresenter.server";`
`6`		`-import { createLoaderApiRoute } from "~/services/routeBuiilders/apiBuilder.server";`
	`6`	`+import { createLoaderApiRoute } from "~/services/routeBuilders/apiBuilder.server";`
`7`	`7`
`8`	`8`	`export const loader = createLoaderApiRoute(`
`9`	`9`	`{`