Merge pull request #83 from vercel/fabio/add-cheks-api-example

add example to run the checks api

Author: correttojs

app/webhook/route.ts

@@ -5,7 +5,8 @@ import {
   type WebhookEvent,
   webhookEventSchema,
 } from "@/lib/vercel/schemas";
-import { storeWebhookEvent, uninstallInstallation } from "@/lib/partner";
+import { listInstallations, storeWebhookEvent, uninstallInstallation } from "@/lib/partner";
+import { fetchVercelApi } from "@/lib/vercel/api";
 
 export const dynamic = "force-dynamic";
 
@@ -53,6 +54,63 @@ export async function POST(req: Request): Promise<Response> {
   switch (type) {
     case "integration-configuration.removed": {
       await uninstallInstallation(payload.configuration.id);
+      break;
+    }
+    case "deployment.created": {
+      const deploymentId = payload.deployment.id
+      const installationId = await getInstallationId(payload.installationIds)
+      if (!installationId) {
+        console.error(`No installations found for deployment ${deploymentId}`, payload)
+        break;
+      }
+      await fetchVercelApi(
+        `/v1/deployments/${deploymentId}/checks`,
+        {
+          data: {
+            blocking: true,
+            rerequestable: true,
+            name: "Test Check",
+          },
+          method: "POST",
+          installationId
+        },
+      );
+      break;
+    }
+    case "deployment.ready": {
+      const deploymentId = payload.deployment.id
+      const installationId = await getInstallationId(payload.installationIds)
+      if (!installationId) {
+        console.error(`No installations found for deployment ${deploymentId}`, payload)
+        break;
+      }
+
+      const data = (await fetchVercelApi(
+        `/v1/deployments/${deploymentId}/checks`,
+        {
+          method: "get",
+          installationId
+        },
+      )) as { checks: { id: string }[] };
+
+      const checkId = data.checks[0]?.id;
+
+      if (!checkId) {
+        console.error(`No Check found for deployment ${deploymentId}`, data)
+      }
+
+      await fetchVercelApi(
+        `/v1/deployments/${deploymentId}/checks/${data.checks[0]?.id}`,
+        {
+          data: {
+            conclusion: "succeeded",
+            status: "completed",
+          },
+          method: "PATCH",
+          installationId
+        },
+      )
+      break;
     }
   }
 
@@ -65,3 +123,9 @@ function sha1(data: Buffer, secret: string): string {
     .update(new Uint8Array(data))
     .digest("hex");
 }
+
+async function getInstallationId(installationIds: string[] | undefined) {
+  const installations = await listInstallations()
+  const installationId = installationIds?.find((id) => installations.includes(id))
+  return installationId
+}

lib/vercel/schemas.ts

@@ -620,33 +620,44 @@ const integrationConfigurationRemovedWebhookEventSchema =
 export type DeploymentIntegrationActionStartEvent = z.infer<
   typeof deploymentIntegrationActionStartEventSchema
 >;
+
+const deploymentWebhookPayloadEventSchema = z.object({
+  user: z
+    .object({
+      id: z.string(),
+    })
+    .passthrough(),
+  team: z
+    .object({
+      id: z.string(),
+    })
+    .passthrough(),
+  installationIds: z.string().array().optional(),
+  deployment: z
+    .object({
+      id: z.string(),
+    })
+    .passthrough(),
+});
+
 const deploymentIntegrationActionStartEventSchema =
   webhookEventBaseSchema.extend({
     type: z.literal("deployment.integration.action.start"),
-    payload: z.object({
-      user: z
-        .object({
-          id: z.string(),
-        })
-        .passthrough(),
-      team: z
-        .object({
-          id: z.string(),
-        })
-        .passthrough(),
+    payload: deploymentWebhookPayloadEventSchema.extend({
       installationId: z.string(),
       action: z.string(),
-      resourceId: z.string(),
-      deployment: z
-        .object({
-          id: z.string(),
-        })
-        .passthrough(),
-      configuration: z.object({
+      resourceId: z.string(), configuration: z.object({
         id: z.string(),
       }),
-    }),
+    })
+  });
+
+const deploymentEvent = <T extends string>(eventType: T) => {
+  return webhookEventBaseSchema.extend({
+    type: z.literal(eventType),
+    payload: deploymentWebhookPayloadEventSchema,
   });
+}
 
 export type WebhookEvent = z.infer<typeof webhookEventSchema>;
 export const webhookEventSchema = z.discriminatedUnion("type", [
@@ -655,6 +666,13 @@ export const webhookEventSchema = z.discriminatedUnion("type", [
   invoiceNotPaidWebhookEventSchema,
   integrationConfigurationRemovedWebhookEventSchema,
   deploymentIntegrationActionStartEventSchema,
+  deploymentEvent("deployment.created"),
+  deploymentEvent("deployment.ready"),
+  deploymentEvent("deployment.promoted"),
+  deploymentEvent("deployment.succeeded"),
+  deploymentEvent("deployment.error"),
+  deploymentEvent("deployment.cancelled"),
+  deploymentEvent("deployment.check-rerequested"),
 ]);
 
 export type UnknownWebhookEvent = z.infer<typeof unknownWebhookEventSchema>;