Merge pull request #246 from cschleiden/external-backend

Remove internal package usage from `Backend` interface

Author: cschleiden

activitytester/activitytester.go

@@ -4,8 +4,8 @@ import (
 	"context"
 	"log/slog"
 
+	"github.com/cschleiden/go-workflows/core"
 	"github.com/cschleiden/go-workflows/internal/activity"
-	"github.com/cschleiden/go-workflows/internal/core"
 )
 
 func WithActivityTestState(ctx context.Context, activityID, instanceID string, logger *slog.Logger) context.Context {

backend/backend.go

@@ -5,11 +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/backend/history"
+	"github.com/cschleiden/go-workflows/contextpropagation"
+	"github.com/cschleiden/go-workflows/converter"
+	"github.com/cschleiden/go-workflows/core"
 	"github.com/cschleiden/go-workflows/metrics"
 	"github.com/cschleiden/go-workflows/workflow"
 	"go.opentelemetry.io/otel/trace"
@@ -45,7 +44,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 +55,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

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

@@ -1,7 +1,7 @@
 package history
 
 import (
-	"github.com/cschleiden/go-workflows/internal/core"
+	"github.com/cschleiden/go-workflows/backend/metadata"
 	"github.com/cschleiden/go-workflows/internal/payload"
 )
 
@@ -10,5 +10,5 @@ type ActivityScheduledAttributes struct {
 
 	Inputs []payload.Payload `json:"inputs,omitempty"`
 
-	Metadata *core.WorkflowMetadata `json:"metadata,omitempty"`
+	Metadata *metadata.WorkflowMetadata `json:"metadata,omitempty"`
 }

internal/history/activity_failed.go renamed to backend/history/activity_failed.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/activity_scheduled.go renamed to backend/history/activity_scheduled.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"
 )