The schedule HTTP API now accepts deduplicationKeys as well as schedule IDs in the URL (#2329)

Author: ericallam

apps/webapp/app/models/schedules.server.ts

@@ -0,0 +1,37 @@
+import { Prisma } from "~/db.server";
+
+export function scheduleUniqWhereClause(
+  projectId: string,
+  scheduleId: string
+): Prisma.TaskScheduleWhereUniqueInput {
+  if (scheduleId.startsWith("sched_")) {
+    return {
+      friendlyId: scheduleId,
+      projectId,
+    };
+  }
+
+  return {
+    projectId_deduplicationKey: {
+      projectId,
+      deduplicationKey: scheduleId,
+    },
+  };
+}
+
+export function scheduleWhereClause(
+  projectId: string,
+  scheduleId: string
+): Prisma.TaskScheduleWhereInput {
+  if (scheduleId.startsWith("sched_")) {
+    return {
+      friendlyId: scheduleId,
+      projectId,
+    };
+  }
+
+  return {
+    projectId,
+    deduplicationKey: scheduleId,
+  };
+}

apps/webapp/app/presenters/v3/ViewSchedulePresenter.server.ts

@@ -4,6 +4,7 @@ import { displayableEnvironment } from "~/models/runtimeEnvironment.server";
 import { clickhouseClient } from "~/services/clickhouseInstance.server";
 import { nextScheduledTimestamps } from "~/v3/utils/calculateNextSchedule.server";
 import { NextRunListPresenter } from "./NextRunListPresenter.server";
+import { scheduleWhereClause } from "~/models/schedules.server";
 
 type ViewScheduleOptions = {
   userId?: string;
@@ -63,10 +64,7 @@ export class ViewSchedulePresenter {
         },
         active: true,
       },
-      where: {
-        friendlyId,
-        projectId,
-      },
+      where: scheduleWhereClause(projectId, friendlyId),
     });
 
     if (!schedule) {

apps/webapp/app/routes/api.v1.schedules.$scheduleId.activate.ts

@@ -1,8 +1,8 @@
 import type { ActionFunctionArgs } from "@remix-run/server-runtime";
 import { json } from "@remix-run/server-runtime";
-import { truncateSync } from "fs";
 import { z } from "zod";
 import { prisma } from "~/db.server";
+import { scheduleUniqWhereClause, scheduleWhereClause } from "~/models/schedules.server";
 import { ViewSchedulePresenter } from "~/presenters/v3/ViewSchedulePresenter.server";
 import { authenticateApiRequest } from "~/services/apiAuth.server";
 
@@ -34,21 +34,21 @@ export async function action({ request, params }: ActionFunctionArgs) {
 
   try {
     const existingSchedule = await prisma.taskSchedule.findFirst({
-      where: {
-        friendlyId: parsedParams.data.scheduleId,
-        projectId: authenticationResult.environment.projectId,
-      },
+      where: scheduleWhereClause(
+        authenticationResult.environment.projectId,
+        parsedParams.data.scheduleId
+      ),
     });
 
     if (!existingSchedule) {
       return json({ error: "Schedule not found" }, { status: 404 });
     }
 
     await prisma.taskSchedule.update({
-      where: {
-        friendlyId: parsedParams.data.scheduleId,
-        projectId: authenticationResult.environment.projectId,
-      },
+      where: scheduleUniqWhereClause(
+        authenticationResult.environment.projectId,
+        parsedParams.data.scheduleId
+      ),
       data: {
         active: true,
       },

apps/webapp/app/routes/api.v1.schedules.$scheduleId.deactivate.ts

@@ -2,6 +2,7 @@ import type { ActionFunctionArgs } from "@remix-run/server-runtime";
 import { json } from "@remix-run/server-runtime";
 import { z } from "zod";
 import { prisma } from "~/db.server";
+import { scheduleUniqWhereClause, scheduleWhereClause } from "~/models/schedules.server";
 import { ViewSchedulePresenter } from "~/presenters/v3/ViewSchedulePresenter.server";
 import { authenticateApiRequest } from "~/services/apiAuth.server";
 
@@ -33,21 +34,21 @@ export async function action({ request, params }: ActionFunctionArgs) {
 
   try {
     const existingSchedule = await prisma.taskSchedule.findFirst({
-      where: {
-        friendlyId: parsedParams.data.scheduleId,
-        projectId: authenticationResult.environment.projectId,
-      },
+      where: scheduleWhereClause(
+        authenticationResult.environment.projectId,
+        parsedParams.data.scheduleId
+      ),
     });
 
     if (!existingSchedule) {
       return json({ error: "Schedule not found" }, { status: 404 });
     }
 
     await prisma.taskSchedule.update({
-      where: {
-        friendlyId: parsedParams.data.scheduleId,
-        projectId: authenticationResult.environment.projectId,
-      },
+      where: scheduleUniqWhereClause(
+        authenticationResult.environment.projectId,
+        parsedParams.data.scheduleId
+      ),
       data: {
         active: false,
       },

apps/webapp/app/routes/api.v1.schedules.$scheduleId.ts

@@ -3,6 +3,7 @@ import { json } from "@remix-run/server-runtime";
 import { ScheduleObject, UpdateScheduleOptions } from "@trigger.dev/core/v3";
 import { z } from "zod";
 import { Prisma, prisma } from "~/db.server";
+import { scheduleUniqWhereClause } from "~/models/schedules.server";
 import { ViewSchedulePresenter } from "~/presenters/v3/ViewSchedulePresenter.server";
 import { authenticateApiRequest } from "~/services/apiAuth.server";
 import { UpsertSchedule } from "~/v3/schedules";
@@ -36,10 +37,10 @@ export async function action({ request, params }: ActionFunctionArgs) {
     case "DELETE": {
       try {
         const deletedSchedule = await prisma.taskSchedule.delete({
-          where: {
-            friendlyId: parsedParams.data.scheduleId,
-            projectId: authenticationResult.environment.projectId,
-          },
+          where: scheduleUniqWhereClause(
+            authenticationResult.environment.projectId,
+            parsedParams.data.scheduleId
+          ),
         });
 
         return json(

apps/webapp/app/v3/services/upsertTaskSchedule.server.ts

@@ -7,6 +7,7 @@ import { calculateNextScheduledTimestampFromNow } from "../utils/calculateNextSc
 import { BaseService, ServiceValidationError } from "./baseService.server";
 import { CheckScheduleService } from "./checkSchedule.server";
 import { scheduleEngine } from "../scheduleEngine.server";
+import { scheduleWhereClause } from "~/models/schedules.server";
 
 export type UpsertTaskScheduleServiceOptions = UpsertSchedule;
 
@@ -37,9 +38,7 @@ export class UpsertTaskScheduleService extends BaseService {
 
     const existingSchedule = schedule.friendlyId
       ? await this._prisma.taskSchedule.findFirst({
-          where: {
-            friendlyId: schedule.friendlyId,
-          },
+          where: scheduleWhereClause(projectId, schedule.friendlyId),
         })
       : await this._prisma.taskSchedule.findFirst({
           where: {