feat: pauseable workflows (#879)

* feat: pause workflow state

* feat: dont run paused workflows

* feat: skipped paused

* implement unpaused behavior for workflow runs

* fix: frontend

* fix: more frontend

* fix: imports

---------

Co-authored-by: Alexander Belanger <[email protected]>

api-contracts/openapi/components/schemas/_index.yaml

@@ -114,6 +114,8 @@ CancelEventRequest:
   $ref: "./event.yaml#/CancelEventRequest"
 Workflow:
   $ref: "./workflow.yaml#/Workflow"
+WorkflowUpdateRequest:
+  $ref: "./workflow.yaml#/WorkflowUpdateRequest"
 WorkflowConcurrency:
   $ref: "./workflow.yaml#/WorkflowConcurrency"
 WorkflowVersionMeta:

api-contracts/openapi/components/schemas/workflow.yaml

@@ -8,6 +8,9 @@ Workflow:
     description:
       type: string
       description: The description of the workflow.
+    isPaused:
+      type: boolean
+      description: Whether the workflow is paused.
     versions:
       type: array
       items:
@@ -27,6 +30,13 @@ Workflow:
     - name
   type: object
 
+WorkflowUpdateRequest:
+  type: object
+  properties:
+    isPaused:
+      type: boolean
+      description: Whether the workflow is paused.
+
 WorkflowTag:
   type: object
   properties:

api-contracts/openapi/paths/workflow/workflow.yaml

@@ -116,6 +116,49 @@ withWorkflow:
     summary: Delete workflow
     tags:
       - Workflow
+  patch:
+    x-resources: ["tenant", "workflow"]
+    description: Update a workflow for a tenant
+    operationId: workflow:update
+    parameters:
+      - description: The workflow id
+        in: path
+        name: workflow
+        required: true
+        schema:
+          type: string
+          format: uuid
+          minLength: 36
+          maxLength: 36
+    requestBody:
+      content:
+        application/json:
+          schema:
+            $ref: "../../components/schemas/_index.yaml#/WorkflowUpdateRequest"
+      description: The input to update the workflow
+      required: true
+    responses:
+      "200":
+        content:
+          application/json:
+            schema:
+              $ref: "../../components/schemas/_index.yaml#/Workflow"
+        description: Successfully updated the workflow
+      "400":
+        content:
+          application/json:
+            schema:
+              $ref: "../../components/schemas/_index.yaml#/APIErrors"
+        description: A malformed or bad request
+      "403":
+        content:
+          application/json:
+            schema:
+              $ref: "../../components/schemas/_index.yaml#/APIErrors"
+        description: Forbidden
+    summary: Update workflow
+    tags:
+      - Workflow
 workflowVersion:
   get:
     x-resources: ["tenant", "workflow"]

api/v1/server/handlers/workflows/update.go

@@ -0,0 +1,31 @@
+package workflows
+
+import (
+	"github.com/labstack/echo/v4"
+
+	"github.com/hatchet-dev/hatchet/api/v1/server/oas/gen"
+	"github.com/hatchet-dev/hatchet/api/v1/server/oas/transformers"
+	"github.com/hatchet-dev/hatchet/pkg/repository"
+	"github.com/hatchet-dev/hatchet/pkg/repository/prisma/db"
+	"github.com/hatchet-dev/hatchet/pkg/repository/prisma/dbsqlc"
+	"github.com/hatchet-dev/hatchet/pkg/repository/prisma/sqlchelpers"
+)
+
+func (t *WorkflowService) WorkflowUpdate(ctx echo.Context, request gen.WorkflowUpdateRequestObject) (gen.WorkflowUpdateResponseObject, error) {
+	tenant := ctx.Get("tenant").(*db.TenantModel)
+	workflow := ctx.Get("workflow").(*dbsqlc.GetWorkflowByIdRow)
+
+	opts := repository.UpdateWorkflowOpts{
+		IsPaused: request.Body.IsPaused,
+	}
+
+	updated, err := t.config.APIRepository.Workflow().UpdateWorkflow(ctx.Request().Context(), tenant.ID, sqlchelpers.UUIDToStr(workflow.Workflow.ID), &opts)
+
+	if err != nil {
+		return nil, err
+	}
+
+	resp := transformers.ToWorkflowFromSQLC(updated)
+
+	return gen.WorkflowUpdate200JSONResponse(*resp), nil
+}

api/v1/server/oas/transformers/workflow.go

@@ -25,6 +25,8 @@ func ToWorkflow(
 		Name: workflow.Name,
 	}
 
+	res.IsPaused = &workflow.IsPaused.Bool
+
 	res.Description = &workflow.Description.String
 
 	if version != nil {
@@ -44,7 +46,7 @@ func ToWorkflowVersionMeta(version *dbsqlc.WorkflowVersion, workflow *dbsqlc.Wor
 			version.UpdatedAt.Time,
 		),
 		WorkflowId: sqlchelpers.UUIDToStr(version.WorkflowId),
-		Order:      int32(version.Order),
+		Order:      int32(version.Order), // nolint: gosec
 		Version:    version.Version.String,
 	}
 
@@ -73,7 +75,7 @@ func ToWorkflowVersion(
 			version.UpdatedAt.Time,
 		),
 		// WorkflowId:      sqlchelpers.UUIDToStr(version.WorkflowId),
-		Order:           int32(version.Order),
+		Order:           int32(version.Order), // nolint: gosec
 		Version:         version.Version.String,
 		ScheduleTimeout: &version.ScheduleTimeout,
 		DefaultPriority: &version.DefaultPriority.Int32,
@@ -290,6 +292,7 @@ func ToWorkflowFromSQLC(row *dbsqlc.Workflow) *gen.Workflow {
 		Metadata:    *toAPIMetadata(pgUUIDToStr(row.ID), row.CreatedAt.Time, row.UpdatedAt.Time),
 		Name:        row.Name,
 		Description: &row.Description.String,
+		IsPaused:    &row.IsPaused.Bool,
 	}
 
 	return res

frontend/app/src/components/ui/use-toast.ts → frontend/app/src/components/hooks/use-toast.ts

@@ -1,25 +1,15 @@
-// Inspired by react-hot-toast library
 import * as React from 'react';
 
 import type { ToastActionElement, ToastProps } from '@/components/ui/toast';
 
 const TOAST_LIMIT = 1;
 const TOAST_REMOVE_DELAY = 1000000;
 
-// Add this type definition
-export type ToastPosition =
-  | 'top-left'
-  | 'top-right'
-  | 'bottom-left'
-  | 'bottom-right';
-
-// Modify the existing ToasterToast type
 type ToasterToast = ToastProps & {
   id: string;
   title?: React.ReactNode;
   description?: React.ReactNode;
   action?: ToastActionElement;
-  position?: ToastPosition;
 };
 
 const actionTypes = {
@@ -144,10 +134,9 @@ function dispatch(action: Action) {
   });
 }
 
-// Modify the Toast type
 type Toast = Omit<ToasterToast, 'id'>;
 
-function toast({ position = 'bottom-right', ...props }: Toast) {
+function toast({ ...props }: Toast) {
   const id = genId();
 
   const update = (props: ToasterToast) =>
@@ -162,7 +151,6 @@ function toast({ position = 'bottom-right', ...props }: Toast) {
     toast: {
       ...props,
       id,
-      position,
       open: true,
       onOpenChange: (open) => {
         if (!open) {

frontend/app/src/components/ui/toast.tsx

@@ -2,8 +2,8 @@ import * as React from 'react';
 import { Cross2Icon } from '@radix-ui/react-icons';
 import * as ToastPrimitives from '@radix-ui/react-toast';
 import { cva, type VariantProps } from 'class-variance-authority';
+
 import { cn } from '@/lib/utils';
-import { ToastPosition } from './use-toast';
 
 const ToastProvider = ToastPrimitives.Provider;
 
@@ -14,7 +14,7 @@ const ToastViewport = React.forwardRef<
   <ToastPrimitives.Viewport
     ref={ref}
     className={cn(
-      'fixed z-[100] flex max-h-screen w-full flex-col-reverse p-4 sm:flex-col md:max-w-[420px]',
+      'fixed top-0 z-[100] flex max-h-screen w-full flex-col-reverse p-4 sm:bottom-0 sm:right-0 sm:top-auto sm:flex-col md:max-w-[420px]',
       className,
     )}
     {...props}
@@ -27,7 +27,7 @@ const toastVariants = cva(
   {
     variants: {
       variant: {
-        default: 'border bg-background text-foreground',
+        default: 'border-foreground bg-background text-foreground',
         destructive:
           'destructive group border-destructive bg-destructive text-destructive-foreground',
       },
@@ -41,23 +41,12 @@ const toastVariants = cva(
 const Toast = React.forwardRef<
   React.ElementRef<typeof ToastPrimitives.Root>,
   React.ComponentPropsWithoutRef<typeof ToastPrimitives.Root> &
-    VariantProps<typeof toastVariants> & {
-      position?: ToastPosition;
-    }
->(({ className, variant, position = 'bottom-right', ...props }, ref) => {
+    VariantProps<typeof toastVariants>
+>(({ className, variant, ...props }, ref) => {
   return (
     <ToastPrimitives.Root
       ref={ref}
-      className={cn(
-        toastVariants({ variant }),
-        {
-          'top-0 left-0': position === 'top-left',
-          'top-0 right-0': position === 'top-right',
-          'bottom-0 left-0': position === 'bottom-left',
-          'bottom-0 right-0': position === 'bottom-right',
-        },
-        className,
-      )}
+      className={cn(toastVariants({ variant }), className)}
       {...props}
     />
   );

frontend/app/src/components/ui/toaster.tsx

@@ -1,3 +1,4 @@
+import { useToast } from '@/components/hooks/use-toast';
 import {
   Toast,
   ToastClose,
@@ -6,7 +7,6 @@ import {
   ToastTitle,
   ToastViewport,
 } from '@/components/ui/toast';
-import { useToast } from '@/components/ui/use-toast';
 
 export function Toaster() {
   const { toasts } = useToast();