Add the ability to skip queue factories

service/history/queueFactoryBase.go

@@ -22,6 +22,8 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 // THE SOFTWARE.
 
+//go:generate mockgen -copyright_file ../../LICENSE -package $GOPACKAGE -source $GOFILE -destination queueFactoryBase_mock.go QueueFactory
+
 package history
 
 import (
@@ -63,6 +65,7 @@ type (
 		// 2. Move this interface to queues package after 1 is done so that there's no cycle dependency
 		// between workflow and queues package.
 		CreateQueue(shard shard.Context, cache workflow.Cache) queues.Queue
+		Enabled() bool
 	}
 
 	QueueFactoryBaseParams struct {
@@ -127,16 +130,22 @@ func QueueSchedulerRateLimiterProvider(
 func QueueFactoryLifetimeHooks(
 	params QueueFactoriesLifetimeHookParams,
 ) {
+	var factories []QueueFactory
+	for _, f := range params.Factories {
+		if f.Enabled() {
+			factories = append(factories, f)
+		}
+	}
 	params.Lifecycle.Append(
 		fx.Hook{
 			OnStart: func(context.Context) error {
-				for _, factory := range params.Factories {
+				for _, factory := range factories {
 					factory.Start()
 				}
 				return nil
 			},
 			OnStop: func(context.Context) error {
-				for _, factory := range params.Factories {
+				for _, factory := range factories {
 					factory.Stop()
 				}
 				return nil
@@ -145,6 +154,10 @@ func QueueFactoryLifetimeHooks(
 	)
 }
 
+func (f *QueueFactoryBase) Enabled() bool {
+	return true
+}
+
 func (f *QueueFactoryBase) Start() {
 	if f.HostScheduler != nil {
 		f.HostScheduler.Start()

service/history/queueFactoryBase_test.go

@@ -0,0 +1,67 @@
+// The MIT License
+//
+// Copyright (c) 2020 Temporal Technologies Inc.  All rights reserved.
+//
+// Copyright (c) 2020 Uber Technologies, Inc.
+//
+// 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 history
+
+import (
+	"context"
+	"testing"
+
+	"github.com/golang/mock/gomock"
+	"github.com/stretchr/testify/require"
+	"go.uber.org/fx"
+)
+
+func TestQueueFactoryLifetimeHooks(t *testing.T) {
+	var (
+		ctrl          = gomock.NewController(t)
+		disabledQueue = NewMockQueueFactory(ctrl)
+		enabledQueue  = NewMockQueueFactory(ctrl)
+	)
+
+	disabledQueue.EXPECT().Enabled().Return(false)
+	enabledQueue.EXPECT().Enabled().Return(true)
+
+	app := fx.New(
+		fx.Provide(fx.Annotated{
+			Group: QueueFactoryFxGroup,
+			Target: func() QueueFactory {
+				return disabledQueue
+			},
+		}, fx.Annotated{
+			Group: QueueFactoryFxGroup,
+			Target: func() QueueFactory {
+				return enabledQueue
+			},
+		}),
+		fx.Invoke(QueueFactoryLifetimeHooks),
+	)
+	require.NoError(t, app.Err())
+
+	enabledQueue.EXPECT().Start()
+	require.NoError(t, app.Start(context.Background()))
+
+	enabledQueue.EXPECT().Stop()
+	require.NoError(t, app.Stop(context.Background()))
+}