From 4426f61e0c5c19bea0caf2ec1328fd0129c7e0c9 Mon Sep 17 00:00:00 2001
From: Carson Ip <carsonip@users.noreply.github.com>
Date: Fri, 8 Sep 2023 17:22:27 +0800
Subject: [PATCH] Add RemoveEventReceived processor (#147)

Moves removeEventReceivedBatchProcessor from apm-server to apm-data. It is responsible for removing event.received from APMEvent so that the field is not indexed.
---
 model/modelprocessor/eventreceived.go      | 42 ++++++++++++++++
 model/modelprocessor/eventreceived_test.go | 58 ++++++++++++++++++++++
 2 files changed, 100 insertions(+)
 create mode 100644 model/modelprocessor/eventreceived.go
 create mode 100644 model/modelprocessor/eventreceived_test.go

diff --git a/model/modelprocessor/eventreceived.go b/model/modelprocessor/eventreceived.go
new file mode 100644
index 00000000..af6d2909
--- /dev/null
+++ b/model/modelprocessor/eventreceived.go
@@ -0,0 +1,42 @@
+// Licensed to Elasticsearch B.V. under one or more contributor
+// license agreements. See the NOTICE file distributed with
+// this work for additional information regarding copyright
+// ownership. Elasticsearch B.V. licenses this file to you 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 modelprocessor
+
+import (
+	"context"
+
+	"github.com/elastic/apm-data/model/modelpb"
+)
+
+// RemoveEventReceived is a processor that removes event.received
+// field as it should not be indexed.
+type RemoveEventReceived struct{}
+
+// ProcessBatch removes event.received field for events.
+func (RemoveEventReceived) ProcessBatch(ctx context.Context, b *modelpb.Batch) error {
+	for i := range *b {
+		removeEventReceived((*b)[i])
+	}
+	return nil
+}
+
+func removeEventReceived(event *modelpb.APMEvent) {
+	if event.Event != nil {
+		event.Event.Received = 0
+	}
+}
diff --git a/model/modelprocessor/eventreceived_test.go b/model/modelprocessor/eventreceived_test.go
new file mode 100644
index 00000000..a890c5fa
--- /dev/null
+++ b/model/modelprocessor/eventreceived_test.go
@@ -0,0 +1,58 @@
+// Licensed to Elasticsearch B.V. under one or more contributor
+// license agreements. See the NOTICE file distributed with
+// this work for additional information regarding copyright
+// ownership. Elasticsearch B.V. licenses this file to you 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 modelprocessor_test
+
+import (
+	"testing"
+
+	"github.com/elastic/apm-data/model/modelpb"
+	"github.com/elastic/apm-data/model/modelprocessor"
+)
+
+func TestRemoveEventReceived(t *testing.T) {
+	processor := modelprocessor.RemoveEventReceived{}
+
+	for _, tc := range []struct {
+		name     string
+		input    *modelpb.APMEvent
+		expected *modelpb.APMEvent
+	}{
+		{
+			name: "with event",
+			input: &modelpb.APMEvent{
+				Event: &modelpb.Event{
+					Received: 1000,
+				},
+			},
+			expected: &modelpb.APMEvent{
+				Event: &modelpb.Event{
+					Received: 0,
+				},
+			},
+		},
+		{
+			name:     "without event",
+			input:    &modelpb.APMEvent{},
+			expected: &modelpb.APMEvent{},
+		},
+	} {
+		t.Run(tc.name, func(t *testing.T) {
+			testProcessBatch(t, processor, tc.input, tc.expected)
+		})
+	}
+}