modules.go

/* Copyright 2019 Freerware
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package workfx

import (
	"database/sql"

	"github.com/freerware/work"
	"github.com/uber-go/tally"
	"go.uber.org/fx"
	"go.uber.org/zap"
)

// Modules defines the various work unit Fx modules.
var Modules = struct {
	SQLUnit        fx.Option
	BestEffortUnit fx.Option
}{
	SQLUnit: fx.Options(
		fx.Provide(func(p SQLUnitParameters) SQLWorkUniterResult {
			options := []work.Option{}
			if p.Logger != nil {
				options = append(options, work.UnitLogger(p.Logger))
			}
			if p.Scope != nil {
				options = append(options, work.UnitScope(p.Scope))
			}
			return SQLWorkUniterResult{
				WorkUniter: work.NewSQLUniter(p.Mappers, p.DB, options...),
			}
		})),

	BestEffortUnit: fx.Options(
		fx.Provide(func(p UnitParameters) BestEffortWorkUniterResult {
			options := []work.Option{}
			if p.Logger != nil {
				options = append(options, work.UnitLogger(p.Logger))
			}
			if p.Scope != nil {
				options = append(options, work.UnitScope(p.Scope))
			}
			return BestEffortWorkUniterResult{
				WorkUniter: work.NewBestEffortUniter(p.Mappers, options...),
			}
		})),
}

// SQLUnitParameters encapsulates the various dependencies
// required to construct SQL work units.
type SQLUnitParameters struct {
	fx.In

	Mappers map[work.TypeName]work.SQLDataMapper
	DB      *sql.DB     `name:"rwDB"`
	Logger  *zap.Logger `optional:"true"`
	Scope   tally.Scope `optional:"true"`
}

// UnitParameters encapsulates the various dependencies
// required to contruct various work units, such as the
// best effort work unit.
type UnitParameters struct {
	fx.In

	Mappers map[work.TypeName]work.DataMapper
	Logger  *zap.Logger `optional:"true"`
	Scope   tally.Scope `optional:"true"`
}

// SQLWorkUniterResult defines the SQL work uniter to be
// provided to the dependency injection container.
type SQLWorkUniterResult struct {
	fx.Out

	WorkUniter work.Uniter `name:"sqlWorkUniter",group:"workUniter"`
}

// BestEffortWorkUniterResult defines the best effort uniter
// to be provided to the dependency injection container.
type BestEffortWorkUniterResult struct {
	fx.Out

	WorkUniter work.Uniter `name:"bestEffortWorkUniter",group:"workUniter"`
}