Move metadata from core to its own package

Author: cschleiden

internal/core/metadata.go renamed to backend/metadata/metadata.go

@@ -1,4 +1,4 @@
-package core
+package metadata
 
 type WorkflowMetadata map[string]string
 

backend/mysql/mysql.go

@@ -12,6 +12,7 @@ import (
 	"time"
 
 	"github.com/cschleiden/go-workflows/backend"
+	"github.com/cschleiden/go-workflows/backend/metadata"
 	"github.com/cschleiden/go-workflows/converter"
 	"github.com/cschleiden/go-workflows/internal/contextpropagation"
 	"github.com/cschleiden/go-workflows/internal/core"
@@ -385,7 +386,7 @@ func (b *mysqlBackend) GetWorkflowTask(ctx context.Context) (*backend.WorkflowTa
 		wfi = core.NewWorkflowInstance(instanceID, executionID)
 	}
 
-	var metadata *core.WorkflowMetadata
+	var metadata *metadata.WorkflowMetadata
 	if metadataJson.Valid {
 		if err := json.Unmarshal([]byte(metadataJson.String), &metadata); err != nil {
 			return nil, fmt.Errorf("parsing workflow metadata: %w", err)

backend/redis/instance.go

@@ -7,6 +7,7 @@ import (
 	"time"
 
 	"github.com/cschleiden/go-workflows/backend"
+	"github.com/cschleiden/go-workflows/backend/metadata"
 	"github.com/cschleiden/go-workflows/internal/core"
 	"github.com/cschleiden/go-workflows/internal/history"
 	"github.com/cschleiden/go-workflows/workflow"
@@ -127,15 +128,15 @@ type instanceState struct {
 	Instance *core.WorkflowInstance     `json:"instance,omitempty"`
 	State    core.WorkflowInstanceState `json:"state,omitempty"`
 
-	Metadata *core.WorkflowMetadata `json:"metadata,omitempty"`
+	Metadata *metadata.WorkflowMetadata `json:"metadata,omitempty"`
 
 	CreatedAt   time.Time  `json:"created_at,omitempty"`
 	CompletedAt *time.Time `json:"completed_at,omitempty"`
 
 	LastSequenceID int64 `json:"last_sequence_id,omitempty"`
 }
 
-func createInstanceP(ctx context.Context, p redis.Pipeliner, instance *core.WorkflowInstance, metadata *core.WorkflowMetadata, ignoreDuplicate bool) error {
+func createInstanceP(ctx context.Context, p redis.Pipeliner, instance *core.WorkflowInstance, metadata *metadata.WorkflowMetadata, ignoreDuplicate bool) error {
 	key := instanceKey(instance)
 
 	createdAt := time.Now()

backend/sqlite/sqlite.go

@@ -12,6 +12,7 @@ import (
 	"time"
 
 	"github.com/cschleiden/go-workflows/backend"
+	"github.com/cschleiden/go-workflows/backend/metadata"
 	"github.com/cschleiden/go-workflows/converter"
 	"github.com/cschleiden/go-workflows/internal/contextpropagation"
 	"github.com/cschleiden/go-workflows/internal/core"
@@ -324,7 +325,7 @@ func (sb *sqliteBackend) GetWorkflowTask(ctx context.Context) (*backend.Workflow
 		wfi = core.NewWorkflowInstance(instanceID, executionID)
 	}
 
-	var metadata *core.WorkflowMetadata
+	var metadata *metadata.WorkflowMetadata
 	if metadataJson.Valid {
 		if err := json.Unmarshal([]byte(metadataJson.String), &metadata); err != nil {
 			return nil, fmt.Errorf("parsing workflow metadata: %w", err)

backend/tasks.go

@@ -1,6 +1,7 @@
 package backend
 
 import (
+	"github.com/cschleiden/go-workflows/backend/metadata"
 	"github.com/cschleiden/go-workflows/internal/core"
 	"github.com/cschleiden/go-workflows/internal/history"
 )
@@ -14,7 +15,7 @@ type WorkflowTask struct {
 
 	WorkflowInstanceState core.WorkflowInstanceState
 
-	Metadata *core.WorkflowMetadata
+	Metadata *metadata.WorkflowMetadata
 
 	// LastSequenceID is the sequence ID of the newest event in the workflow instances's history
 	LastSequenceID int64

backend/test/backendtest.go

@@ -7,6 +7,7 @@ import (
 	"time"
 
 	"github.com/cschleiden/go-workflows/backend"
+	"github.com/cschleiden/go-workflows/backend/metadata"
 	"github.com/cschleiden/go-workflows/client"
 	"github.com/cschleiden/go-workflows/diag"
 	"github.com/cschleiden/go-workflows/internal/core"
@@ -233,7 +234,7 @@ func BackendTest(t *testing.T, setup func(options ...backend.BackendOption) Test
 				startedEvent := history.NewHistoryEvent(1, time.Now(), history.EventType_WorkflowExecutionStarted, &history.ExecutionStartedAttributes{
 					Name:     "some-workflow",
 					Inputs:   []payload.Payload{},
-					Metadata: &core.WorkflowMetadata{},
+					Metadata: &metadata.WorkflowMetadata{},
 				})
 
 				wfi := core.NewWorkflowInstance(uuid.NewString(), uuid.NewString())

internal/command/continueasnew.go

@@ -2,6 +2,7 @@ package command
 
 import (
 	"github.com/benbjohnson/clock"
+	"github.com/cschleiden/go-workflows/backend/metadata"
 	"github.com/cschleiden/go-workflows/internal/core"
 	"github.com/cschleiden/go-workflows/internal/history"
 	"github.com/cschleiden/go-workflows/internal/payload"
@@ -13,14 +14,14 @@ type ContinueAsNewCommand struct {
 
 	Instance *core.WorkflowInstance
 	Name     string
-	Metadata *core.WorkflowMetadata
+	Metadata *metadata.WorkflowMetadata
 	Inputs   []payload.Payload
 	Result   payload.Payload
 }
 
 var _ Command = (*ContinueAsNewCommand)(nil)
 
-func NewContinueAsNewCommand(id int64, instance *core.WorkflowInstance, result payload.Payload, name string, metadata *core.WorkflowMetadata, inputs []payload.Payload) *ContinueAsNewCommand {
+func NewContinueAsNewCommand(id int64, instance *core.WorkflowInstance, result payload.Payload, name string, metadata *metadata.WorkflowMetadata, inputs []payload.Payload) *ContinueAsNewCommand {
 	return &ContinueAsNewCommand{
 		command: command{
 			id:    id,

internal/command/schedule_activity.go

@@ -2,7 +2,7 @@ package command
 
 import (
 	"github.com/benbjohnson/clock"
-	"github.com/cschleiden/go-workflows/internal/core"
+	"github.com/cschleiden/go-workflows/backend/metadata"
 	"github.com/cschleiden/go-workflows/internal/history"
 	"github.com/cschleiden/go-workflows/internal/payload"
 )
@@ -12,12 +12,12 @@ type ScheduleActivityCommand struct {
 
 	Name     string
 	Inputs   []payload.Payload
-	Metadata *core.WorkflowMetadata
+	Metadata *metadata.WorkflowMetadata
 }
 
 var _ Command = (*ScheduleActivityCommand)(nil)
 
-func NewScheduleActivityCommand(id int64, name string, inputs []payload.Payload, metadata *core.WorkflowMetadata) *ScheduleActivityCommand {
+func NewScheduleActivityCommand(id int64, name string, inputs []payload.Payload, metadata *metadata.WorkflowMetadata) *ScheduleActivityCommand {
 	return &ScheduleActivityCommand{
 		command: command{
 			id:    id,

internal/command/schedule_activity_test.go

@@ -4,7 +4,7 @@ import (
 	"testing"
 
 	"github.com/benbjohnson/clock"
-	"github.com/cschleiden/go-workflows/internal/core"
+	"github.com/cschleiden/go-workflows/backend/metadata"
 	"github.com/cschleiden/go-workflows/internal/history"
 	"github.com/cschleiden/go-workflows/internal/payload"
 	"github.com/stretchr/testify/require"
@@ -37,7 +37,7 @@ func TestScheduleActivityCommand_StateTransitions(t *testing.T) {
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
 			clock := clock.NewMock()
-			cmd := NewScheduleActivityCommand(1, "activity", []payload.Payload{}, &core.WorkflowMetadata{})
+			cmd := NewScheduleActivityCommand(1, "activity", []payload.Payload{}, &metadata.WorkflowMetadata{})
 
 			tt.f(t, cmd, clock)
 		})

internal/command/schedule_subworkflow.go

@@ -2,6 +2,7 @@ package command
 
 import (
 	"github.com/benbjohnson/clock"
+	"github.com/cschleiden/go-workflows/backend/metadata"
 	"github.com/cschleiden/go-workflows/internal/core"
 	"github.com/cschleiden/go-workflows/internal/history"
 	"github.com/cschleiden/go-workflows/internal/payload"
@@ -12,7 +13,7 @@ type ScheduleSubWorkflowCommand struct {
 	cancelableCommand
 
 	Instance *core.WorkflowInstance
-	Metadata *core.WorkflowMetadata
+	Metadata *metadata.WorkflowMetadata
 
 	Name   string
 	Inputs []payload.Payload
@@ -21,7 +22,7 @@ type ScheduleSubWorkflowCommand struct {
 var _ CancelableCommand = (*ScheduleSubWorkflowCommand)(nil)
 
 func NewScheduleSubWorkflowCommand(
-	id int64, parentInstance *core.WorkflowInstance, subWorkflowInstanceID, name string, inputs []payload.Payload, metadata *core.WorkflowMetadata,
+	id int64, parentInstance *core.WorkflowInstance, subWorkflowInstanceID, name string, inputs []payload.Payload, metadata *metadata.WorkflowMetadata,
 ) *ScheduleSubWorkflowCommand {
 	if subWorkflowInstanceID == "" {
 		subWorkflowInstanceID = uuid.New().String()