Added runs to the batch.retrieve call/API

Author: matt-aitken

apps/webapp/app/routes/api.v2.batches.$batchId.ts

@@ -0,0 +1,40 @@
+import { json } from "@remix-run/server-runtime";
+import { z } from "zod";
+import { $replica } from "~/db.server";
+import { createLoaderApiRoute } from "~/services/routeBuilders/apiBuilder.server";
+
+const ParamsSchema = z.object({
+  batchId: z.string(),
+});
+
+export const loader = createLoaderApiRoute(
+  {
+    params: ParamsSchema,
+    allowJWT: true,
+    corsStrategy: "all",
+    findResource: (params, auth) => {
+      return $replica.batchTaskRun.findFirst({
+        where: {
+          friendlyId: params.batchId,
+          runtimeEnvironmentId: auth.environment.id,
+        },
+      });
+    },
+    authorization: {
+      action: "read",
+      resource: (batch) => ({ batch: batch.friendlyId }),
+      superScopes: ["read:runs", "read:all", "admin"],
+    },
+  },
+  async ({ resource: batch }) => {
+    return json({
+      id: batch.friendlyId,
+      status: batch.status,
+      idempotencyKey: batch.idempotencyKey ?? undefined,
+      createdAt: batch.createdAt,
+      updatedAt: batch.updatedAt,
+      runCount: batch.runCount,
+      runs: batch.runIds,
+    });
+  }
+);

packages/core/src/v3/apiClient/index.ts

@@ -4,8 +4,6 @@ import { generateJWT } from "../jwt.js";
 import {
   AddTagsRequestBody,
   BatchTaskRunExecutionResult,
-  BatchTriggerTaskV2RequestBody,
-  BatchTriggerTaskV2Response,
   BatchTriggerTaskV3RequestBody,
   BatchTriggerTaskV3Response,
   CanceledRunResponse,
@@ -20,7 +18,7 @@ import {
   ListScheduleOptions,
   ReplayRunResponse,
   RescheduleRunRequestBody,
-  RetrieveBatchResponse,
+  RetrieveBatchV2Response,
   RetrieveRunResponse,
   ScheduleObject,
   TaskRunExecutionResult,
@@ -44,9 +42,9 @@ import {
 } from "./core.js";
 import { ApiError } from "./errors.js";
 import {
+  AnyRealtimeRun,
   AnyRunShape,
   RealtimeRun,
-  AnyRealtimeRun,
   RunShape,
   RunStreamCallback,
   RunSubscription,
@@ -97,10 +95,10 @@ const DEFAULT_ZOD_FETCH_OPTIONS: ZodFetchOptions = {
 
 export { isRequestOptions };
 export type {
+  AnyRealtimeRun,
   AnyRunShape,
   ApiRequestOptions,
   RealtimeRun,
-  AnyRealtimeRun,
   RunShape,
   RunStreamCallback,
   RunSubscription,
@@ -675,8 +673,8 @@ export class ApiClient {
 
   retrieveBatch(batchId: string, requestOptions?: ZodFetchOptions) {
     return zodfetch(
-      RetrieveBatchResponse,
-      `${this.baseUrl}/api/v1/batches/${batchId}`,
+      RetrieveBatchV2Response,
+      `${this.baseUrl}/api/v2/batches/${batchId}`,
       {
         method: "GET",
         headers: this.#getHeaders(false),

packages/core/src/v3/schemas/api.ts

@@ -819,6 +819,18 @@ export const RetrieveBatchResponse = z.object({
 
 export type RetrieveBatchResponse = z.infer<typeof RetrieveBatchResponse>;
 
+export const RetrieveBatchV2Response = z.object({
+  id: z.string(),
+  status: BatchStatus,
+  idempotencyKey: z.string().optional(),
+  createdAt: z.coerce.date(),
+  updatedAt: z.coerce.date(),
+  runCount: z.number(),
+  runs: z.array(z.string()),
+});
+
+export type RetrieveBatchV2Response = z.infer<typeof RetrieveBatchV2Response>;
+
 export const SubscribeRealtimeStreamChunkRawShape = z.object({
   id: z.string(),
   runId: z.string(),

references/hello-world/src/trigger/idempotency.ts

@@ -141,6 +141,9 @@ export const idempotencyBatch = task({
     );
     logger.log("Batch 1", { batch1 });
 
+    const b = await batch.retrieve(batch1.id);
+    logger.log("Batch retrieve", { ...b });
+
     const batch2 = await childTask.batchTriggerAndWait(
       [
         {