ignore value if name splitter return empty (#111)

Follow up #110
nil-go · Feb 10, 2024 · ce69ab9 · ce69ab9
1 parent b366fb3
commit ce69ab9
Show file tree

Hide file tree

Showing 9 changed files with 63 additions and 1 deletion.
diff --git a/provider/env/env.go b/provider/env/env.go
@@ -48,7 +48,10 @@ func (e Env) Load() (map[string]any, error) {
 				// The environment variable with empty value is treated as unset.
 				continue
 			}
-			maps.Insert(values, e.splitter(key), value)
+
+			if keys := e.splitter(key); len(keys) > 1 || len(keys) == 1 && keys[0] != "" {
+				maps.Insert(values, keys, value)
+			}
 		}
 	}
 

diff --git a/provider/env/env_test.go b/provider/env/env_test.go
@@ -42,6 +42,22 @@ func TestEnv_Load(t *testing.T) {
 				},
 			},
 		},
+		{
+			description: "with nil splitter",
+			opts: []env.Option{
+				env.WithPrefix("P."),
+				env.WithNameSplitter(func(string) []string { return nil }),
+			},
+			expected: map[string]any{},
+		},
+		{
+			description: "with empty splitter",
+			opts: []env.Option{
+				env.WithPrefix("P."),
+				env.WithNameSplitter(func(string) []string { return []string{""} }),
+			},
+			expected: map[string]any{},
+		},
 	}
 
 	t.Setenv("P_K", "v")

diff --git a/provider/env/option.go b/provider/env/option.go
@@ -31,6 +31,7 @@ func WithDelimiter(delimiter string) Option {
 }
 
 // WithNameSplitter provides the function used to split environment variable names into nested keys.
+// If it returns an nil/[]string{}/[]string{""}, the variable will be ignored.
 //
 // For example, with the default splitter, an environment variable name like "PARENT_CHILD_KEY"
 // would be split into "PARENT", "CHILD", and "KEY".

diff --git a/provider/flag/flag.go b/provider/flag/flag.go
@@ -73,6 +73,10 @@ func (f Flag) Load() (map[string]any, error) {
 		}
 
 		keys := f.splitter(flag.Name)
+		if len(keys) == 0 || len(keys) == 1 && keys[0] == "" {
+			return
+		}
+
 		val := flag.Value.String()
 		// Skip zero default value to avoid overriding values set by other loader.
 		if val == flag.DefValue && (f.konf.Exists(keys) || isZeroDefValue(flag)) {

diff --git a/provider/flag/flag_test.go b/provider/flag/flag_test.go
@@ -52,6 +52,22 @@ func TestFlag_Load(t *testing.T) {
 				},
 			},
 		},
+		{
+			description: "with nil splitter",
+			opts: []kflag.Option{
+				kflag.WithPrefix("p_"),
+				kflag.WithNameSplitter(func(string) []string { return nil }),
+			},
+			expected: map[string]any{},
+		},
+		{
+			description: "with empty splitter",
+			opts: []kflag.Option{
+				kflag.WithPrefix("p_"),
+				kflag.WithNameSplitter(func(string) []string { return []string{""} }),
+			},
+			expected: map[string]any{},
+		},
 		{
 			description: "with prefix",
 			opts:        []kflag.Option{kflag.WithPrefix("p.")},

diff --git a/provider/flag/option.go b/provider/flag/option.go
@@ -43,6 +43,7 @@ func WithDelimiter(delimiter string) Option {
 }
 
 // WithNameSplitter provides the function used to split environment variable names into nested keys.
+// If it returns an nil/[]string{}/[]string{""}, the variable will be ignored.
 //
 // For example, with the default splitter, an flag name like "parent.child.key"
 // would be split into "parent", "child", and "key".

diff --git a/provider/pflag/option.go b/provider/pflag/option.go
@@ -44,6 +44,7 @@ func WithDelimiter(delimiter string) Option {
 }
 
 // WithNameSplitter provides the function used to split environment variable names into nested keys.
+// If it returns an nil/[]string{}/[]string{""}, the variable will be ignored.
 //
 // For example, with the default splitter, an flag name like "parent.child.key"
 // // would be split into "parent", "child", and "key".

diff --git a/provider/pflag/pflag.go b/provider/pflag/pflag.go
@@ -77,6 +77,10 @@ func (f PFlag) Load() (map[string]any, error) {
 			}
 
 			keys := f.splitter(flag.Name)
+			if len(keys) == 0 || len(keys) == 1 && keys[0] == "" {
+				return
+			}
+
 			val := f.flagVal(flag)
 			// Skip zero default value to avoid overriding values set by other loader.
 			if !flag.Changed && (f.konf.Exists(keys) || reflect.ValueOf(val).IsZero()) {

diff --git a/provider/pflag/pflag_test.go b/provider/pflag/pflag_test.go
@@ -56,6 +56,22 @@ func TestPFlag_Load(t *testing.T) {
 				},
 			},
 		},
+		{
+			description: "with nil splitter",
+			opts: []kflag.Option{
+				kflag.WithPrefix("p_"),
+				kflag.WithNameSplitter(func(string) []string { return nil }),
+			},
+			expected: map[string]any{},
+		},
+		{
+			description: "with empty splitter",
+			opts: []kflag.Option{
+				kflag.WithPrefix("p_"),
+				kflag.WithNameSplitter(func(string) []string { return []string{""} }),
+			},
+			expected: map[string]any{},
+		},
 		{
 			description: "with prefix",
 			opts:        []kflag.Option{kflag.WithPrefix("p.")},