improve api schema and types

Author: carderne

apps/webapp/app/routes/api.v1.bulk-actions.ts

@@ -42,8 +42,7 @@ const { action } = createActionApiRoute(
         userId: authentication.actor?.sub ?? null,
         action: body.action,
         title: body.name,
-        region: body.region,
-        emailNotification: body.emailNotification,
+        region: body.targetRegion,
         filters: body.runIds
           ? { runId: body.runIds }
           : bulkActionFilterToRunListFilters(body.filter),

apps/webapp/app/v3/services/bulk/BulkActionV2.server.ts

@@ -50,6 +50,7 @@ export type ProcessToCompletionResult = {
 
 export class BulkActionService extends BaseService {
   public async create(input: CreateBulkActionInput) {
+    const { organizationId, projectId, environmentId, userId } = input;
     const filters = freezeRunListFilters(input.filters);
 
     // Region is a replay-only override that re-routes the replayed runs. It's
@@ -61,7 +62,7 @@ export class BulkActionService extends BaseService {
       // region surfaces as a user-input (400) error rather than a 500.
       const [regionError] = await tryCatch(
         new WorkerGroupService({ prisma: this._prisma }).getDefaultWorkerGroupForProject({
-          projectId: input.projectId,
+          projectId,
           regionOverride: replayRegion,
         })
       );
@@ -78,17 +79,17 @@ export class BulkActionService extends BaseService {
 
     // Count the runs that will be affected by the bulk action
     const clickhouse = await clickhouseFactory.getClickhouseForOrganization(
-      input.organizationId,
+      organizationId,
       "standard"
     );
     const runsRepository = new RunsRepository({
       clickhouse,
       prisma: this._replica as PrismaClient,
     });
     const count = await runsRepository.countRuns({
-      organizationId: input.organizationId,
-      projectId: input.projectId,
-      environmentId: input.environmentId,
+      organizationId,
+      projectId,
+      environmentId,
       ...filters,
     });
 
@@ -98,9 +99,9 @@ export class BulkActionService extends BaseService {
       data: {
         id,
         friendlyId,
-        projectId: input.projectId,
-        environmentId: input.environmentId,
-        userId: input.userId,
+        projectId,
+        environmentId,
+        userId,
         name: input.title,
         type: input.action === "cancel" ? BulkActionType.CANCEL : BulkActionType.REPLAY,
         params,

packages/core/src/v3/apiClient/bulkActions.test.ts

@@ -67,8 +67,7 @@ describe("ApiClient bulk actions", () => {
       action: "replay",
       filter: { status: ["FAILED"], taskIdentifier: "my-task" },
       name: "Replay failures",
-      region: "eu_1",
-      emailNotification: true,
+      targetRegion: "eu_1",
     });
 
     expect(result).toEqual({ id: "bulk_created" });
@@ -80,8 +79,7 @@ describe("ApiClient bulk actions", () => {
       action: "replay",
       filter: { status: ["FAILED"], taskIdentifier: "my-task" },
       name: "Replay failures",
-      region: "eu_1",
-      emailNotification: true,
+      targetRegion: "eu_1",
     });
   });
 

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

@@ -70,32 +70,35 @@ export interface ListProjectRunsQueryParams extends CursorPageParams, ListRunsQu
   env?: Array<"dev" | "staging" | "prod"> | "dev" | "staging" | "prod";
 }
 
+/** Same filters as runs.list(), excluding pagination. */
 export type BulkActionFilter = Omit<ListRunsQueryParams, keyof CursorPageParams>;
 
 export type BulkActionSelection =
   | { filter: BulkActionFilter; runIds?: never }
   | { runIds: string[]; filter?: never };
 
-export type CreateBulkActionOptions = BulkActionSelection & {
-  action: "cancel" | "replay";
+type BaseBulkActionOptions = BulkActionSelection & {
   name?: string;
-  /** Region identifier to replay runs in. When omitted, each replay keeps the original run's region. */
-  region?: string;
-  emailNotification?: boolean;
 };
 
-export type CreateBulkCancelActionOptions = BulkActionSelection & {
-  name?: string;
-  emailNotification?: boolean;
+type TargetRegionOption = {
+  /** Region identifier to replay runs in. When omitted, each replay keeps the original run's region. */
+  targetRegion?: string;
 };
 
-export type CreateBulkReplayActionOptions = BulkActionSelection & {
-  name?: string;
-  /** Region identifier to replay runs in. When omitted, each replay keeps the original run's region. */
-  region?: string;
-  emailNotification?: boolean;
+export type CreateBulkActionOptions =
+  | (BaseBulkActionOptions & {
+      action: "cancel";
+      targetRegion?: never;
+    })
+  | (BaseBulkActionOptions & { action: "replay" } & TargetRegionOption);
+
+export type CreateBulkCancelActionOptions = BaseBulkActionOptions & {
+  targetRegion?: never;
 };
 
+export type CreateBulkReplayActionOptions = BaseBulkActionOptions & TargetRegionOption;
+
 export type ListBulkActionsQueryParams = CursorPageParams;
 
 export interface SubscribeToRunsQueryParams {

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

@@ -1246,15 +1246,25 @@ const BulkActionFilterRequestBody = z.object({
   region: StringOrStringArray.optional(),
 });
 
+const BulkActionSelectionRequestBody = {
+  filter: BulkActionFilterRequestBody.optional(),
+  runIds: z.array(z.string()).min(1).optional(),
+  name: z.string().optional(),
+};
+
 export const CreateBulkActionRequestBody = z
-  .object({
-    action: z.enum(["cancel", "replay"]),
-    filter: BulkActionFilterRequestBody.optional(),
-    runIds: z.array(z.string()).min(1).optional(),
-    name: z.string().optional(),
-    region: z.string().optional(),
-    emailNotification: z.boolean().optional(),
-  })
+  .discriminatedUnion("action", [
+    z.object({
+      action: z.literal("cancel"),
+      targetRegion: z.never().optional(),
+      ...BulkActionSelectionRequestBody,
+    }),
+    z.object({
+      action: z.literal("replay"),
+      targetRegion: z.string().optional(),
+      ...BulkActionSelectionRequestBody,
+    }),
+  ])
   .refine((body) => (body.filter ? 1 : 0) + (body.runIds ? 1 : 0) === 1, {
     message: "Exactly one of filter or runIds must be provided",
   });

packages/trigger-sdk/src/v3/runs-bulk.test.ts

@@ -85,8 +85,7 @@ describe("runs.bulk", () => {
       runs.bulk.replay({
         filter: { status: "FAILED", taskIdentifier: ["task-a", "task-b"] },
         name: "Replay failed tasks",
-        region: "eu_1",
-        emailNotification: true,
+        targetRegion: "eu_1",
       })
     );
 
@@ -97,8 +96,7 @@ describe("runs.bulk", () => {
       action: "replay",
       filter: { status: "FAILED", taskIdentifier: ["task-a", "task-b"] },
       name: "Replay failed tasks",
-      region: "eu_1",
-      emailNotification: true,
+      targetRegion: "eu_1",
     });
   });