Fail task on unknown event when HistoryEvent.worker_may_ignore is fal…

…se (#1363)

internal/internal_event_handlers.go

@@ -212,6 +212,8 @@ var (
 	ErrMissingMarkerDetails = errors.New("marker details are nil")
 	// ErrMissingMarkerDataKey is returned when marker details doesn't have data key.
 	ErrMissingMarkerDataKey = errors.New("marker key is missing in details")
+	// ErrUnknownHistoryEvent is returned if there is an unknown event in history and the SDK needs to handle it
+	ErrUnknownHistoryEvent = errors.New("unknown history event")
 )
 
 func newWorkflowExecutionEventHandler(
@@ -1235,10 +1237,17 @@ func (weh *workflowExecutionEventHandlerImpl) ProcessEvent(
 		weh.handleWorkflowPropertiesModified(event)
 
 	default:
-		weh.logger.Error("unknown event type",
-			tagEventID, event.GetEventId(),
-			tagEventType, event.GetEventType().String())
-		// Do not fail to be forward compatible with new events
+		if event.WorkerMayIgnore {
+			// Do not fail to be forward compatible with new events
+			weh.logger.Debug("unknown event type",
+				tagEventID, event.GetEventId(),
+				tagEventType, event.GetEventType().String())
+		} else {
+			weh.logger.Error("unknown event type",
+				tagEventID, event.GetEventId(),
+				tagEventType, event.GetEventType().String())
+			return ErrUnknownHistoryEvent
+		}
 	}
 
 	if err != nil {

test/replaytests/replay_test.go

@@ -113,6 +113,22 @@ func (s *replayTestSuite) TestReplayWorkflowHistoryFromFile() {
 	}
 }
 
+func (s *replayTestSuite) TestReplayWorkflowWithBadUnknownEvent() {
+	// Test replaying a history with an unknown event that cannot be ignored fails
+	replayer := worker.NewWorkflowReplayer()
+	replayer.RegisterWorkflow(Workflow1)
+	err := replayer.ReplayWorkflowHistoryFromJSONFile(ilog.NewDefaultLogger(), "workflow_with_bad_unknown_event.json")
+	require.ErrorContains(s.T(), err, "unknown history event")
+}
+
+func (s *replayTestSuite) TestReplayWorkflowWithUnknownEvent() {
+	// Test replaying a history with an unknown event that can be ignored does not fails
+	replayer := worker.NewWorkflowReplayer()
+	replayer.RegisterWorkflow(Workflow1)
+	err := replayer.ReplayWorkflowHistoryFromJSONFile(ilog.NewDefaultLogger(), "workflow_with_unknown_event.json")
+	require.NoError(s.T(), err)
+}
+
 func (s *replayTestSuite) TestReplayBadWorkflowHistoryFromFile() {
 	replayer := worker.NewWorkflowReplayer()
 	replayer.RegisterWorkflow(Workflow1)