Merge pull request #470 from labd/464-error-when-using-es-419-language-code-on-localized_value-does-not-allow-numbers

feat(localization): Added more support for IETF BCP 47 language tags

Author: demeyerthom

.changes/unreleased/Fixed-20240119-111634.yaml

@@ -0,0 +1,3 @@
+kind: Fixed
+body: Added more support for IETF BCP 47 language tags
+time: 2024-01-19T11:16:34.573242447+01:00

commercetools/utils.go

@@ -2,11 +2,12 @@ package commercetools
 
 import (
 	"fmt"
+	"github.com/hashicorp/go-cty/cty"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
-	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/validation"
 	"github.com/labd/commercetools-go-sdk/platform"
+	"golang.org/x/text/language"
 	"reflect"
-	"regexp"
 )
 
 // TypeLocalizedString defined merely for documentation,
@@ -321,10 +322,35 @@ func nilIfEmpty(val *string) *string {
 	return val
 }
 
-var validateLocalizedStringKey = validation.MapKeyMatch(
-	regexp.MustCompile("^[a-z]{2}(-[A-Z]{2})?$"),
-	"Locale keys must match pattern ^[a-z]{2}(-[A-Z]{2})?$",
-)
+var validateLocalizedStringKey schema.SchemaValidateDiagFunc = func(v interface{}, path cty.Path) diag.Diagnostics {
+	var diags diag.Diagnostics
+
+	m, ok := v.(map[string]interface{})
+	if !ok {
+		diags = append(diags, diag.Diagnostic{
+			Severity:      diag.Error,
+			Summary:       "Input is not a map of language tags",
+			Detail:        "The input provided is not a map of language tags",
+			AttributePath: path,
+		})
+		return diags
+	}
+
+	for key := range m {
+		_, err := language.Parse(key)
+		if err != nil {
+			diags = append(diags, diag.Diagnostic{
+				Severity:      diag.Error,
+				Summary:       "Bad language tag",
+				Detail:        fmt.Sprintf("Language tag %s is not valid: %s", key, err.Error()),
+				AttributePath: append(path, cty.IndexStep{Key: cty.StringVal(key)}),
+			})
+			continue
+		}
+	}
+
+	return diags
+}
 
 func compareDateString(a, b string) bool {
 	if a == b {

commercetools/utils_test.go

@@ -53,7 +53,7 @@ func TestCompareDateString(t *testing.T) {
 	for _, tt := range testCases {
 		res = compareDateString(tt.a, tt.b)
 		if res != tt.expected {
-			t.Errorf("expected %v, got %v", tt.expected, res)
+			t.Errorf("failures %v, got %v", tt.expected, res)
 		}
 	}
 
@@ -92,3 +92,25 @@ func TestIntNilIfEmpty(t *testing.T) {
 		assert.Equal(t, tt.expected, v)
 	}
 }
+
+func TestValidateLocalizedStringKey(t *testing.T) {
+	testCases := []struct {
+		input    interface{}
+		failures int
+	}{
+		{map[string]any{"en": "English"}, 0},
+		{map[string]any{"en-US": "English (United States)"}, 0},
+		{map[string]any{"es-419": "Spanish (Latin America)"}, 0},
+		{map[string]any{"rm-sursilv": "Romansh Sursilvan"}, 0},
+		{map[string]any{"sr-Cyrl": "Serbian in Cyrillic"}, 0},
+		{map[string]any{"foobar": "Fail"}, 1},
+		{"foobar", 1},
+		{1, 1},
+		{map[string]any{"es-409": "Spanish (Latin America)"}, 1},
+	}
+
+	for _, tt := range testCases {
+		diag := validateLocalizedStringKey(tt.input, nil)
+		assert.Equal(t, tt.failures, len(diag), fmt.Sprintf("%+v", diag))
+	}
+}