Function archiveWorkflow

apps/sim/lib/workflows/lifecycle.ts:88–207

(
  workflowId: string,
  options: ArchiveWorkflowOptions
)

}

export async function archiveWorkflow(
  workflowId: string,
  options: ArchiveWorkflowOptions
): Promise<{ archived: boolean; workflow: Awaited<ReturnType<typeof getWorkflowById>> | null }> {
  const existingWorkflow = await getWorkflowById(workflowId, { includeArchived: true })

  if (!existingWorkflow) {
    return { archived: false, workflow: null }
  }

  if (existingWorkflow.archivedAt) {
    return { archived: false, workflow: existingWorkflow }
  }

  const now = options.archivedAt ?? new Date()
  const affectedWorkflowMcpServers = await db
    .select({ serverId: workflowMcpTool.serverId })
    .from(workflowMcpTool)
    .where(and(eq(workflowMcpTool.workflowId, workflowId), isNull(workflowMcpTool.archivedAt)))

  await db.transaction(async (tx) => {
    await tx
      .update(workflowSchedule)
      .set({
        archivedAt: now,
        updatedAt: now,
        status: 'disabled',
        nextRunAt: null,
        lastQueuedAt: null,
      })
      .where(and(eq(workflowSchedule.workflowId, workflowId), isNull(workflowSchedule.archivedAt)))

    await tx
      .update(webhook)
      .set({
        archivedAt: now,
        updatedAt: now,
        isActive: false,
      })
      .where(and(eq(webhook.workflowId, workflowId), isNull(webhook.archivedAt)))

    await tx
      .update(chat)
      .set({
        archivedAt: now,
        updatedAt: now,
        isActive: false,
      })
      .where(and(eq(chat.workflowId, workflowId), isNull(chat.archivedAt)))

    await tx
      .update(workflowMcpTool)
      .set({
        archivedAt: now,
        updatedAt: now,
      })
      .where(and(eq(workflowMcpTool.workflowId, workflowId), isNull(workflowMcpTool.archivedAt)))