Merge branch 'main' into pr/lovromazgon/245

Author: cschleiden

README.md

@@ -268,7 +268,7 @@ Create a `Client` instance then then call `CancelWorkflow` to cancel a workflow.
 Sub-workflows will be canceled if their parent workflow is canceled.
 
 ```go
-var c client.Client
+var c *client.Client
 err = c.CancelWorkflowInstance(context.Background(), workflowInstance)
 if err != nil {
 	panic("could not cancel workflow")

activitytester/activitytester.go

@@ -4,10 +4,12 @@ import (
 	"context"
 	"log/slog"
 
+	"github.com/cschleiden/go-workflows/core"
 	"github.com/cschleiden/go-workflows/internal/activity"
-	"github.com/cschleiden/go-workflows/internal/core"
 )
 
+// WithActivityTestState returns a context with an activity state attached that can be used for unit testing
+// activities.
 func WithActivityTestState(ctx context.Context, activityID, instanceID string, logger *slog.Logger) context.Context {
 	if logger == nil {
 		logger = slog.Default()

backend/backend.go

@@ -5,12 +5,10 @@ import (
 	"errors"
 	"log/slog"
 
-	"github.com/cschleiden/go-workflows/internal/contextpropagation"
-	"github.com/cschleiden/go-workflows/internal/converter"
-	core "github.com/cschleiden/go-workflows/internal/core"
-	"github.com/cschleiden/go-workflows/internal/history"
-	"github.com/cschleiden/go-workflows/internal/task"
-	"github.com/cschleiden/go-workflows/metrics"
+	"github.com/cschleiden/go-workflows/backend/converter"
+	"github.com/cschleiden/go-workflows/backend/history"
+	"github.com/cschleiden/go-workflows/backend/metrics"
+	"github.com/cschleiden/go-workflows/core"
 	"github.com/cschleiden/go-workflows/workflow"
 	"go.opentelemetry.io/otel/trace"
 )
@@ -45,7 +43,7 @@ type Backend interface {
 	SignalWorkflow(ctx context.Context, instanceID string, event *history.Event) error
 
 	// GetWorkflowTask returns a pending workflow task or nil if there are no pending workflow executions
-	GetWorkflowTask(ctx context.Context) (*task.Workflow, error)
+	GetWorkflowTask(ctx context.Context) (*WorkflowTask, error)
 
 	// ExtendWorkflowTask extends the lock of a workflow task
 	ExtendWorkflowTask(ctx context.Context, taskID string, instance *core.WorkflowInstance) error
@@ -56,11 +54,11 @@ type Backend interface {
 	// which will be added to the workflow instance history. workflowEvents are new events for the
 	// completed or other workflow instances.
 	CompleteWorkflowTask(
-		ctx context.Context, task *task.Workflow, instance *workflow.Instance, state core.WorkflowInstanceState,
+		ctx context.Context, task *WorkflowTask, instance *workflow.Instance, state core.WorkflowInstanceState,
 		executedEvents, activityEvents, timerEvents []*history.Event, workflowEvents []history.WorkflowEvent) error
 
 	// GetActivityTask returns a pending activity task or nil if there are no pending activities
-	GetActivityTask(ctx context.Context) (*task.Activity, error)
+	GetActivityTask(ctx context.Context) (*ActivityTask, error)
 
 	// CompleteActivityTask completes an activity task retrieved using GetActivityTask
 	CompleteActivityTask(ctx context.Context, instance *workflow.Instance, activityID string, event *history.Event) error
@@ -84,5 +82,5 @@ type Backend interface {
 	Converter() converter.Converter
 
 	// ContextPropagators returns the configured context propagators for the backend
-	ContextPropagators() []contextpropagation.ContextPropagator
+	ContextPropagators() []workflow.ContextPropagator
 }

internal/converter/converter.go renamed to backend/converter/converter.go

@@ -1,7 +1,7 @@
 package converter
 
 import (
-	"github.com/cschleiden/go-workflows/internal/payload"
+	"github.com/cschleiden/go-workflows/backend/payload"
 )
 
 type Converter interface {

internal/converter/json.go renamed to backend/converter/json.go

@@ -3,7 +3,7 @@ package converter
 import (
 	"encoding/json"
 
-	"github.com/cschleiden/go-workflows/internal/payload"
+	"github.com/cschleiden/go-workflows/backend/payload"
 )
 
 type jsonConverter struct{}

internal/history/activity_completed.go renamed to backend/history/activity_completed.go

@@ -1,6 +1,6 @@
 package history
 
-import "github.com/cschleiden/go-workflows/internal/payload"
+import "github.com/cschleiden/go-workflows/backend/payload"
 
 type ActivityCompletedAttributes struct {
 	Result payload.Payload `json:"result,omitempty"`

internal/history/activity_failed.go renamed to backend/history/activity_failed.go

@@ -0,0 +1,14 @@
+package history
+
+import (
+	"github.com/cschleiden/go-workflows/backend/metadata"
+	"github.com/cschleiden/go-workflows/backend/payload"
+)
+
+type ActivityScheduledAttributes struct {
+	Name string `json:"name,omitempty"`
+
+	Inputs []payload.Payload `json:"inputs,omitempty"`
+
+	Metadata *metadata.WorkflowMetadata `json:"metadata,omitempty"`
+}

backend/history/activity_scheduled.go

@@ -1,6 +1,6 @@
 package history
 
-import "github.com/cschleiden/go-workflows/internal/core"
+import "github.com/cschleiden/go-workflows/core"
 
 func EventsByWorkflowInstance(events []WorkflowEvent) map[core.WorkflowInstance][]WorkflowEvent {
 	groupedEvents := make(map[core.WorkflowInstance][]WorkflowEvent)

internal/history/grouping.go renamed to backend/history/grouping.go

@@ -4,7 +4,7 @@ import (
 	"testing"
 	"time"
 
-	"github.com/cschleiden/go-workflows/internal/core"
+	"github.com/cschleiden/go-workflows/core"
 	"github.com/google/uuid"
 	"github.com/stretchr/testify/require"
 )