Function deployWorkflow

apps/sim/lib/workflows/persistence/utils.ts:598–788

(params: {
  workflowId: string
  deployedBy: string
  workflowName?: string
  /** Optional human-readable summary of what changed, stored on the deployment version. */
  description?: string | null
  /** Optional human-readable name/label for the deployment version. */
  name?: string | null
  workflowState?: WorkflowState
  validateWorkflowState?: (
    workflowState: WorkflowState,
    executor: DbOrTx
  ) => DeployWorkflowValidationResult | Promise<DeployWorkflowValidationResult>
  onDeployTransaction?: (
    tx: DbOrTx,
    result: { deploymentVersionId: string; version: number; previousVersionId?: string }
  ) => Promise<void>
})

}

export async function deployWorkflow(params: {
  workflowId: string
  deployedBy: string
  workflowName?: string
  /** Optional human-readable summary of what changed, stored on the deployment version. */
  description?: string | null
  /** Optional human-readable name/label for the deployment version. */
  name?: string | null
  workflowState?: WorkflowState
  validateWorkflowState?: (
    workflowState: WorkflowState,
    executor: DbOrTx
  ) => DeployWorkflowValidationResult | Promise<DeployWorkflowValidationResult>
  onDeployTransaction?: (
    tx: DbOrTx,
    result: { deploymentVersionId: string; version: number; previousVersionId?: string }
  ) => Promise<void>
}): Promise<{
  success: boolean
  version?: number
  deploymentVersionId?: string
  deployedAt?: Date
  previousVersionId?: string
  currentState?: WorkflowState
  error?: string
  errorCode?: 'validation' | 'not_found'
}> {
  const { workflowId, deployedBy, workflowName } = params

  try {
    const now = new Date()
    let currentState: WorkflowState | null = null

    const deployedVersion = await db.transaction(async (tx) => {
      if (!(await lockWorkflowForUpdate(tx, workflowId))) {
        return {
          success: false as const,
          error: 'Workflow not found',
          errorCode: 'not_found' as const,
        }
      }

      // Refuse to deploy an archived (soft-deleted) workflow. Checked under the row
      // lock so it's atomic with a concurrent fork rollback that archives a
      // promote-created workflow: a stale promote deploy can never resurrect it into
      // an archived-but-deployed (incoherent) state.
      const [archivedRow] = await tx
        .select({ archivedAt: workflow.archivedAt })
        .from(workflow)
        .where(eq(workflow.id, workflowId))
        .limit(1)
      if (archivedRow?.archivedAt != null) {
        return {
          success: false as const,
          error: 'Cannot deploy an archived workflow',
          errorCode: 'validation' as const,
        }
      }