From ba91f69653d53fef07eb97b56cd1615819c91530 Mon Sep 17 00:00:00 2001
From: Antoine Toulme <antoine@lunar-ocean.com>
Date: Sat, 20 Apr 2024 01:23:27 -0700
Subject: [PATCH] [pkg/stanza] Fix TimeParser unmarshaling (#32568)

**Description:**
Fix unmarshaling of TimeParser to conserve initial settings before
unmarshaling.

**Link to tracking Issue:**
Fixes #32169

**Testing:**
Added the test from the issue.

For @mx-psi I could not make it so we would apply
https://github.com/open-telemetry/opentelemetry-collector-contrib/pull/31802#discussion_r1559849575
because `TimeParser` is reused on all operators, and therefore it
becomes contentious to patch all over the place.
---
 .chloggen/time_parser_take2.yaml        | 27 +++++++++++++++++++++++++
 pkg/stanza/operator/helper/time.go      | 11 ++++------
 pkg/stanza/operator/helper/time_test.go | 16 +++++++++++++++
 3 files changed, 47 insertions(+), 7 deletions(-)
 create mode 100644 .chloggen/time_parser_take2.yaml

diff --git a/.chloggen/time_parser_take2.yaml b/.chloggen/time_parser_take2.yaml
new file mode 100644
index 0000000000000..d0240f7ce319c
--- /dev/null
+++ b/.chloggen/time_parser_take2.yaml
@@ -0,0 +1,27 @@
+# Use this changelog template to create an entry for release notes.
+
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: bug_fix
+
+# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
+component: stanza
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Unmarshaling now preserves the initial configuration.
+
+# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
+issues: [32169]
+
+# (Optional) One or more lines of additional information to render under the primary note.
+# These lines will be padded with 2 spaces and then inserted directly into the document.
+# Use pipe (|) for multiline entries.
+subtext:
+
+# If your change doesn't affect end users or the exported elements of any package,
+# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
+# Optional: The change log or logs in which this entry should be included.
+# e.g. '[user]' or '[user, api]'
+# Include 'user' if the change is relevant to end users.
+# Include 'api' if there is a change to a library API.
+# Default: '[user]'
+change_logs: []
diff --git a/pkg/stanza/operator/helper/time.go b/pkg/stanza/operator/helper/time.go
index 158fffc8bee75..bee6adbc29bed 100644
--- a/pkg/stanza/operator/helper/time.go
+++ b/pkg/stanza/operator/helper/time.go
@@ -47,12 +47,13 @@ type TimeParser struct {
 
 // Unmarshal starting from default settings
 func (t *TimeParser) Unmarshal(component *confmap.Conf) error {
-	cfg := NewTimeParser()
-	err := component.Unmarshal(&cfg, confmap.WithIgnoreUnused())
+	err := component.Unmarshal(t, confmap.WithIgnoreUnused())
 	if err != nil {
 		return err
 	}
-	*t = cfg
+	if t.LayoutType == "" {
+		t.LayoutType = StrptimeKey
+	}
 	return nil
 }
 
@@ -71,10 +72,6 @@ func (t *TimeParser) Validate() error {
 		return errors.NewError("missing required configuration parameter `layout`", "")
 	}
 
-	if t.LayoutType == "" {
-		t.LayoutType = StrptimeKey
-	}
-
 	switch t.LayoutType {
 	case NativeKey, GotimeKey: // ok
 	case StrptimeKey:
diff --git a/pkg/stanza/operator/helper/time_test.go b/pkg/stanza/operator/helper/time_test.go
index 3911df78ab05a..b356859f38e8c 100644
--- a/pkg/stanza/operator/helper/time_test.go
+++ b/pkg/stanza/operator/helper/time_test.go
@@ -9,7 +9,9 @@ import (
 	"testing"
 	"time"
 
+	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
+	"go.opentelemetry.io/collector/confmap"
 
 	"github.com/open-telemetry/opentelemetry-collector-contrib/internal/coreinternal/timeutils"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/entry"
@@ -573,6 +575,20 @@ func TestSetInvalidLocation(t *testing.T) {
 	require.Contains(t, err.Error(), "failed to load location "+"not_a_location")
 }
 
+func TestUnmarshal(t *testing.T) {
+	conf := confmap.NewFromStringMap(map[string]any{
+		"location": "America/Shiprock",
+	})
+	tp := TimeParser{
+		Layout: "1/2/2006 15:04:05",
+	}
+
+	require.NoError(t, tp.Unmarshal(conf))
+	assert.Equal(t, "America/Shiprock", tp.Location)
+	assert.Equal(t, "strptime", tp.LayoutType)
+	assert.Equal(t, "1/2/2006 15:04:05", tp.Layout)
+}
+
 func TestUnmarshalTimeConfig(t *testing.T) {
 	operatortest.ConfigUnmarshalTests{
 		DefaultConfig: newHelpersConfig(),