service/history/ndc/events_reapplier.go

// Copyright (c) 2019 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.

//go:generate mockgen -package $GOPACKAGE -source $GOFILE -destination events_reapplier_mock.go

package ndc

import (
	ctx "context"

	"github.com/uber/cadence/common/definition"
	"github.com/uber/cadence/common/log"
	"github.com/uber/cadence/common/metrics"
	"github.com/uber/cadence/common/types"
	"github.com/uber/cadence/service/history/execution"
)

type (
	// EventsReapplier handles event re-application
	EventsReapplier interface {
		ReapplyEvents(
			ctx ctx.Context,
			msBuilder execution.MutableState,
			historyEvents []*types.HistoryEvent,
			runID string,
		) ([]*types.HistoryEvent, error)
	}

	eventsReapplierImpl struct {
		metricsClient metrics.Client
		logger        log.Logger
	}
)

var _ EventsReapplier = (*eventsReapplierImpl)(nil)

// NewEventsReapplier creates events reapplier
func NewEventsReapplier(
	metricsClient metrics.Client,
	logger log.Logger,
) EventsReapplier {

	return &eventsReapplierImpl{
		metricsClient: metricsClient,
		logger:        logger,
	}
}

func (r *eventsReapplierImpl) ReapplyEvents(
	ctx ctx.Context,
	msBuilder execution.MutableState,
	historyEvents []*types.HistoryEvent,
	runID string,
) ([]*types.HistoryEvent, error) {

	var reappliedEvents []*types.HistoryEvent
	for _, event := range historyEvents {
		switch event.GetEventType() {
		case types.EventTypeWorkflowExecutionSignaled:
			dedupResource := definition.NewEventReappliedID(runID, event.ID, event.Version)
			if msBuilder.IsResourceDuplicated(dedupResource) {
				// skip already applied event
				continue
			}
			reappliedEvents = append(reappliedEvents, event)
		}
	}

	if len(reappliedEvents) == 0 {
		return nil, nil
	}

	// sanity check workflow still running
	if !msBuilder.IsWorkflowExecutionRunning() {
		return nil, &types.InternalServiceError{
			Message: "unable to reapply events to closed workflow.",
		}
	}

	for _, event := range reappliedEvents {
		signal := event.GetWorkflowExecutionSignaledEventAttributes()
		if _, err := msBuilder.AddWorkflowExecutionSignaled(
			signal.GetSignalName(),
			signal.GetInput(),
			signal.GetIdentity(),
			signal.GetRequestID(),
		); err != nil {
			return nil, err
		}
		deDupResource := definition.NewEventReappliedID(runID, event.ID, event.Version)
		msBuilder.UpdateDuplicatedResource(deDupResource)
	}
	return reappliedEvents, nil
}