Move Engine interface into common history package

service/history/api/respondworkflowtaskcompleted/api_test.go

@@ -63,6 +63,7 @@ import (
 	"go.temporal.io/server/common/testing/updateutils"
 	"go.temporal.io/server/internal/effect"
 	"go.temporal.io/server/service/history/api"
+	history "go.temporal.io/server/service/history/common"
 	"go.temporal.io/server/service/history/events"
 	"go.temporal.io/server/service/history/hsm"
 	"go.temporal.io/server/service/history/shard"
@@ -121,7 +122,7 @@ func (s *WorkflowTaskCompletedHandlerSuite) SetupSubTest() {
 	s.NoError(err)
 	s.mockShard.SetStateMachineRegistry(reg)
 
-	mockEngine := shard.NewMockEngine(s.controller)
+	mockEngine := history.NewMockEngine(s.controller)
 	mockEngine.EXPECT().NotifyNewHistoryEvent(gomock.Any()).AnyTimes()
 	mockEngine.EXPECT().NotifyNewTasks(gomock.Any()).AnyTimes()
 	s.mockShard.SetEngineForTesting(mockEngine)

service/history/shard/engine.go → service/history/common/engine.go

@@ -24,7 +24,7 @@
 
 //go:generate mockgen -copyright_file ../../../LICENSE -package $GOPACKAGE -source $GOFILE -destination engine_mock.go
 
-package shard
+package common
 
 import (
 	"context"
@@ -37,7 +37,6 @@ import (
 	persistencespb "go.temporal.io/server/api/persistence/v1"
 	replicationspb "go.temporal.io/server/api/replication/v1"
 	workflowspb "go.temporal.io/server/api/workflow/v1"
-	"go.temporal.io/server/common/collection"
 	"go.temporal.io/server/common/definition"
 	"go.temporal.io/server/common/metrics"
 	"go.temporal.io/server/common/namespace"
@@ -130,23 +129,6 @@ type (
 		Start()
 		Stop()
 	}
-
-	ReplicationStream interface {
-		SubscribeReplicationNotification() (<-chan struct{}, string)
-		UnsubscribeReplicationNotification(string)
-		ConvertReplicationTask(
-			ctx context.Context,
-			task tasks.Task,
-			clusterID int32,
-		) (*replicationspb.ReplicationTask, error)
-		GetReplicationTasksIter(
-			ctx context.Context,
-			pollingCluster string,
-			minInclusiveTaskID int64,
-			maxExclusiveTaskID int64,
-		) (collection.Iterator[tasks.Task], error)
-		GetMaxReplicationTaskInfo() (int64, time.Time)
-	}
 )
 
 type (

service/history/common/replication_stream.go

@@ -0,0 +1,53 @@
+// The MIT License
+//
+// Copyright (c) 2024 Temporal Technologies Inc.  All rights reserved.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+
+package common
+
+import (
+	"context"
+	"time"
+
+	replicationspb "go.temporal.io/server/api/replication/v1"
+	"go.temporal.io/server/common/collection"
+	"go.temporal.io/server/service/history/tasks"
+)
+
+type (
+	ReplicationStream interface {
+		SubscribeReplicationNotification() (<-chan struct{}, string)
+		UnsubscribeReplicationNotification(string)
+		ConvertReplicationTask(
+			ctx context.Context,
+			task tasks.Task,
+			clusterID int32,
+		) (*replicationspb.ReplicationTask, error)
+
+		GetReplicationTasksIter(
+			ctx context.Context,
+			pollingCluster string,
+			minInclusiveTaskID int64,
+			maxExclusiveTaskID int64,
+		) (collection.Iterator[tasks.Task], error)
+
+		GetMaxReplicationTaskInfo() (int64, time.Time)
+	}
+)

service/history/history_engine.go

@@ -101,6 +101,7 @@ import (
 	"go.temporal.io/server/service/history/api/verifychildworkflowcompletionrecorded"
 	"go.temporal.io/server/service/history/api/verifyfirstworkflowtaskscheduled"
 	"go.temporal.io/server/service/history/circuitbreakerpool"
+	history "go.temporal.io/server/service/history/common"
 	"go.temporal.io/server/service/history/configs"
 	"go.temporal.io/server/service/history/consts"
 	"go.temporal.io/server/service/history/deletemanager"
@@ -183,7 +184,7 @@ func NewEngineWithShardContext(
 	dlqWriter replication.DLQWriter,
 	commandHandlerRegistry *workflow.CommandHandlerRegistry,
 	outboundQueueCBPool *circuitbreakerpool.OutboundQueueCircuitBreakerPool,
-) shard.Engine {
+) history.Engine {
 	currentClusterName := shard.GetClusterMetadata().GetCurrentClusterName()
 
 	logger := shard.GetLogger()
@@ -759,14 +760,14 @@ func (e *historyEngineImpl) SyncActivities(
 
 func (e *historyEngineImpl) SyncHSM(
 	ctx context.Context,
-	request *shard.SyncHSMRequest,
+	request *history.SyncHSMRequest,
 ) error {
 	return e.nDCHSMStateReplicator.SyncHSMState(ctx, request)
 }
 
 func (e *historyEngineImpl) BackfillHistoryEvents(
 	ctx context.Context,
-	request *shard.BackfillHistoryEventsRequest,
+	request *history.BackfillHistoryEventsRequest,
 ) error {
 	return e.nDCHistoryReplicator.BackfillHistoryEvents(ctx, request)
 }

service/history/history_engine_factory.go

@@ -34,6 +34,7 @@ import (
 	"go.temporal.io/server/common/sdk"
 	"go.temporal.io/server/service/history/api"
 	"go.temporal.io/server/service/history/circuitbreakerpool"
+	history "go.temporal.io/server/service/history/common"
 	"go.temporal.io/server/service/history/configs"
 	"go.temporal.io/server/service/history/events"
 	"go.temporal.io/server/service/history/replication"
@@ -77,7 +78,7 @@ type (
 
 func (f *historyEngineFactory) CreateEngine(
 	shard shard.Context,
-) shard.Engine {
+) history.Engine {
 	var wfCache wcache.Cache
 	if shard.GetConfig().EnableHostLevelHistoryCache() {
 		wfCache = f.WorkflowCache

service/history/ndc/history_replicator.go

@@ -48,6 +48,7 @@ import (
 	"go.temporal.io/server/common/persistence/versionhistory"
 	"go.temporal.io/server/common/primitives/timestamp"
 	serviceerrors "go.temporal.io/server/common/serviceerror"
+	history "go.temporal.io/server/service/history/common"
 	"go.temporal.io/server/service/history/shard"
 	"go.temporal.io/server/service/history/workflow"
 	wcache "go.temporal.io/server/service/history/workflow/cache"
@@ -113,7 +114,7 @@ type (
 			newEvents []*historypb.HistoryEvent,
 			newRunID string,
 		) error
-		BackfillHistoryEvents(ctx context.Context, request *shard.BackfillHistoryEventsRequest) error
+		BackfillHistoryEvents(ctx context.Context, request *history.BackfillHistoryEventsRequest) error
 	}
 
 	HistoryReplicatorImpl struct {
@@ -229,7 +230,7 @@ func (r *HistoryReplicatorImpl) ApplyEvents(
 
 func (r *HistoryReplicatorImpl) BackfillHistoryEvents(
 	ctx context.Context,
-	request *shard.BackfillHistoryEventsRequest,
+	request *history.BackfillHistoryEventsRequest,
 ) error {
 	task, err := newReplicationTaskFromBatch(
 		r.clusterMetadata,

service/history/ndc/hsm_state_replicator.go

@@ -40,6 +40,7 @@ import (
 	"go.temporal.io/server/common/persistence"
 	"go.temporal.io/server/common/persistence/versionhistory"
 	serviceerrors "go.temporal.io/server/common/serviceerror"
+	history "go.temporal.io/server/service/history/common"
 	"go.temporal.io/server/service/history/hsm"
 	"go.temporal.io/server/service/history/shard"
 	"go.temporal.io/server/service/history/workflow"
@@ -50,7 +51,7 @@ type (
 	HSMStateReplicator interface {
 		SyncHSMState(
 			ctx context.Context,
-			request *shard.SyncHSMRequest,
+			request *history.SyncHSMRequest,
 		) error
 	}
 
@@ -76,7 +77,7 @@ func NewHSMStateReplicator(
 
 func (r *HSMStateReplicatorImpl) SyncHSMState(
 	ctx context.Context,
-	request *shard.SyncHSMRequest,
+	request *history.SyncHSMRequest,
 ) (retError error) {
 	namespaceID := namespace.ID(request.WorkflowKey.GetNamespaceID())
 	execution := &commonpb.WorkflowExecution{
@@ -150,7 +151,7 @@ func (r *HSMStateReplicatorImpl) SyncHSMState(
 
 func (r *HSMStateReplicatorImpl) syncHSMNode(
 	mutableState workflow.MutableState,
-	request *shard.SyncHSMRequest,
+	request *history.SyncHSMRequest,
 ) (bool, error) {
 
 	shouldSync, err := r.compareVersionHistory(mutableState, request.EventVersionHistory)