Cascade terminate/Purge Workflow Support

Makefile

@@ -373,8 +373,8 @@ test-integration: test-deps
 ################################################################################
 # Target: lint                                                                 #
 ################################################################################
-# Please use golangci-lint version v1.51.2 , otherwise you might encounter errors.
-# You can download version v1.51.2 at https://github.com/golangci/golangci-lint/releases/tag/v1.51.2
+# Please use golangci-lint version v1.55.2 , otherwise you might encounter errors.
+# You can download version v1.55.2 at https://github.com/golangci/golangci-lint/releases/tag/v1.55.2
 .PHONY: lint
 lint: check-linter
 	$(GOLANGCI_LINT) run --build-tags=allcomponents --timeout=20m

dapr/proto/runtime/v1/dapr.proto

@@ -1066,6 +1066,8 @@ message TerminateWorkflowRequest {
   string instance_id = 1 [json_name = "instanceID"];
   // Name of the workflow component.
   string workflow_component = 2 [json_name = "workflowComponent"];
+  // Indicates whether this is a recursive terminate request
+  bool recursive = 3 [json_name = "recursive"];
 }
 
 // PauseWorkflowRequest is the request for PauseWorkflowBeta1.
@@ -1102,6 +1104,8 @@ message PurgeWorkflowRequest {
   string instance_id = 1 [json_name = "instanceID"];
   // Name of the workflow component.
   string workflow_component = 2 [json_name = "workflowComponent"];
+  // Indicates whether this is a recursive purge request
+  bool recursive = 3 [json_name = "recursive"];
 }
 
 // ShutdownRequest is the request for Shutdown.

go.mod

@@ -11,7 +11,7 @@ require (
 	github.com/argoproj/argo-rollouts v1.4.1
 	github.com/cenkalti/backoff/v4 v4.2.1
 	github.com/cloudevents/sdk-go/v2 v2.14.0
-	github.com/dapr/components-contrib v1.12.1-0.20231219201927-02c6b21ec621
+	github.com/dapr/components-contrib v1.12.1-0.20240102173552-0c48ced685a6
 	github.com/dapr/kit v0.12.2-0.20231220162141-abe711ef620f
 	github.com/evanphx/json-patch/v5 v5.7.0
 	github.com/go-chi/chi/v5 v5.0.10
@@ -36,7 +36,7 @@ require (
 	github.com/jhump/protoreflect v1.15.2
 	github.com/kelseyhightower/envconfig v1.4.0
 	github.com/lestrrat-go/jwx/v2 v2.0.18
-	github.com/microsoft/durabletask-go v0.4.0
+	github.com/microsoft/durabletask-go v0.4.1-0.20231222205218-fc5756737d3c
 	github.com/mitchellh/mapstructure v1.5.1-0.20220423185008-bf980b35cac4
 	github.com/phayes/freeport v0.0.0-20220201140144-74d24b5ae9f5
 	github.com/prometheus/client_golang v1.16.0

go.sum

@@ -431,8 +431,8 @@ github.com/dancannon/gorethink v4.0.0+incompatible h1:KFV7Gha3AuqT+gr0B/eKvGhbjm
 github.com/dancannon/gorethink v4.0.0+incompatible/go.mod h1:BLvkat9KmZc1efyYwhz3WnybhRZtgF1K929FD8z1avU=
 github.com/danieljoos/wincred v1.1.2 h1:QLdCxFs1/Yl4zduvBdcHB8goaYk9RARS2SgLLRuAyr0=
 github.com/danieljoos/wincred v1.1.2/go.mod h1:GijpziifJoIBfYh+S7BbkdUTU4LfM+QnGqR5Vl2tAx0=
-github.com/dapr/components-contrib v1.12.1-0.20231219201927-02c6b21ec621 h1:3ZCVOQ/wy/pxB8XrHaxFbA4h+Y395ZgOYyRBENIF4EA=
-github.com/dapr/components-contrib v1.12.1-0.20231219201927-02c6b21ec621/go.mod h1:IDhR653dYqUhPVZJYCwiLe5V9rTIC3/A6eyVCyPPcfA=
+github.com/dapr/components-contrib v1.12.1-0.20240102173552-0c48ced685a6 h1:nXU85+BojBJ8YoyS70d7Z/mkHsOFgaICsxiPcdHx3LE=
+github.com/dapr/components-contrib v1.12.1-0.20240102173552-0c48ced685a6/go.mod h1:IDhR653dYqUhPVZJYCwiLe5V9rTIC3/A6eyVCyPPcfA=
 github.com/dapr/kit v0.12.2-0.20231220162141-abe711ef620f h1:21ETHtiA6O2hAovtsNDdhuxlKg/wZpkslzAsBH+L9q0=
 github.com/dapr/kit v0.12.2-0.20231220162141-abe711ef620f/go.mod h1:kCRdU8av1epsDzfxjpLo2gB2VYTgsNefRauD5gbir3A=
 github.com/dave/jennifer v1.4.0/go.mod h1:fIb+770HOpJ2fmN9EPPKOqm1vMGhB+TwXKMZhrIygKg=
@@ -1157,8 +1157,8 @@ github.com/matttproud/golang_protobuf_extensions v1.0.4 h1:mmDVorXM7PCGKw94cs5zk
 github.com/matttproud/golang_protobuf_extensions v1.0.4/go.mod h1:BSXmuO+STAnVfrANrmjBb36TMTDstsz7MSK+HVaYKv4=
 github.com/microcosm-cc/bluemonday v1.0.24 h1:NGQoPtwGVcbGkKfvyYk1yRqknzBuoMiUrO6R7uFTPlw=
 github.com/microcosm-cc/bluemonday v1.0.24/go.mod h1:ArQySAMps0790cHSkdPEJ7bGkF2VePWH773hsJNSHf8=
-github.com/microsoft/durabletask-go v0.4.0 h1:rGqKRZYyvxBaD/UIfVUnlGqrycqBg30Ngpt0ODcIzqY=
-github.com/microsoft/durabletask-go v0.4.0/go.mod h1:svScWPnRqjf9YgxeCB3CkYLMAyvuu+qqNf4Hl9dmvcg=
+github.com/microsoft/durabletask-go v0.4.1-0.20231222205218-fc5756737d3c h1:eng0MBn0jE65oWhzHbCugaGs6JetgfkdVW36nIJ0vgI=
+github.com/microsoft/durabletask-go v0.4.1-0.20231222205218-fc5756737d3c/go.mod h1:OSZ4K7SgqBEsaouk3lAVdDzvanIzsdj7angZ0FTeSAU=
 github.com/microsoft/go-mssqldb v1.6.0 h1:mM3gYdVwEPFrlg/Dvr2DNVEgYFG7L42l+dGc67NNNpc=
 github.com/microsoft/go-mssqldb v1.6.0/go.mod h1:00mDtPbeQCRGC1HwOOR5K/gr30P1NcEG0vx6Kbv2aJU=
 github.com/miekg/dns v1.0.14/go.mod h1:W1PPwlIAgtquWBMBEV9nkV9Cazfe8ScdGz/Lj7v3Nrg=

pkg/grpc/universalapi/api_workflow.go

@@ -128,6 +128,7 @@ func (a *UniversalAPI) TerminateWorkflowBeta1(ctx context.Context, in *runtimev1
 
 	req := &workflows.TerminateRequest{
 		InstanceID: in.GetInstanceId(),
+		Recursive:  in.GetRecursive(),
 	}
 	if err := workflowComponent.Terminate(ctx, req); err != nil {
 		if errors.Is(err, api.ErrInstanceNotFound) {
@@ -254,6 +255,7 @@ func (a *UniversalAPI) PurgeWorkflowBeta1(ctx context.Context, in *runtimev1pb.P
 
 	req := workflows.PurgeRequest{
 		InstanceID: in.GetInstanceId(),
+		Recursive:  in.GetRecursive(),
 	}
 
 	err = workflowComponent.Purge(ctx, &req)

pkg/http/api_test.go

@@ -2817,6 +2817,23 @@ func TestV1Beta1Workflow(t *testing.T) {
 		assert.Nil(t, resp.ErrorBody)
 	})
 
+	t.Run("Terminate with recursive true", func(t *testing.T) {
+		// Note that in case of recursive termination, MockWorkflow intentionally returns fake error, even when it is not an actual error.
+		// This is to test that recursive flag is being passed correctly to the workflow component.
+
+		apiPath := "v1.0-beta1/workflows/dapr/instanceID/terminate"
+		data := struct {
+			Recursive bool `json:"recursive"`
+		}{
+			Recursive: true,
+		}
+		body, _ := json.Marshal(data)
+		resp := fakeServer.DoRequest("POST", apiPath, body, nil)
+		assert.Equal(t, 500, resp.StatusCode)
+		assert.Equal(t, "ERR_TERMINATE_WORKFLOW", resp.ErrorBody["errorCode"])
+		assert.Equal(t, fmt.Sprintf(messages.ErrTerminateWorkflow.Message(), "instanceID", daprt.ErrFakeWorkflowTerminateRecursiveError), resp.ErrorBody["message"])
+	})
+
 	///////////////////////////
 	// RAISE EVENT API TESTS //
 	///////////////////////////
@@ -2927,6 +2944,22 @@ func TestV1Beta1Workflow(t *testing.T) {
 		// assert
 		assert.Nil(t, resp.ErrorBody)
 	})
+	t.Run("Purge with recursive true", func(t *testing.T) {
+		// Note that in case of recursive purge, MockWorkflow intentionally returns fake error, even when it is not an actual error.
+		// This is to test that recursive flag is being passed correctly to the workflow component.
+
+		apiPath := "v1.0-beta1/workflows/dapr/instanceID/purge"
+		data := struct {
+			Recursive bool `json:"recursive"`
+		}{
+			Recursive: true,
+		}
+		body, _ := json.Marshal(data)
+		resp := fakeServer.DoRequest("POST", apiPath, body, nil)
+		assert.Equal(t, 500, resp.StatusCode)
+		assert.Equal(t, "ERR_PURGE_WORKFLOW", resp.ErrorBody["errorCode"])
+		assert.Equal(t, fmt.Sprintf(messages.ErrPurgeWorkflow.Message(), "instanceID", daprt.ErrFakeWorkflowPurgeRecursiveError), resp.ErrorBody["message"])
+	})
 }
 
 func buildHTTPPineline(spec config.PipelineSpec) httpMiddleware.Pipeline {