Allow digits in the generated short name (#820)

## Changes

Digits were previously replaced by `_`.

## Tests

Additional test cases with uncommon variations of email addresses.

Author: pietern

bundle/config/mutator/populate_current_user.go

@@ -38,15 +38,17 @@ func (m *populateCurrentUser) Apply(ctx context.Context, b *bundle.Bundle) error
 	return nil
 }
 
+func replaceNonAlphanumeric(r rune) rune {
+	if unicode.IsLetter(r) || unicode.IsDigit(r) {
+		return r
+	}
+	return '_'
+}
+
 // Get a short-form username, based on the user's primary email address.
 // We leave the full range of unicode letters in tact, but remove all "special" characters,
 // including dots, which are not supported in e.g. experiment names.
 func getShortUserName(emailAddress string) string {
-	r := []rune(strings.Split(emailAddress, "@")[0])
-	for i := 0; i < len(r); i++ {
-		if !unicode.IsLetter(r[i]) {
-			r[i] = '_'
-		}
-	}
-	return string(r)
+	local, _, _ := strings.Cut(emailAddress, "@")
+	return strings.Map(replaceNonAlphanumeric, local)
 }

bundle/config/mutator/populate_current_user_test.go

@@ -1,6 +1,10 @@
 package mutator
 
-import "testing"
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
 
 func TestPopulateCurrentUser(t *testing.T) {
 	// We need to implement workspace client mocking to implement this test.
@@ -13,28 +17,60 @@ func TestGetShortUserName(t *testing.T) {
 		expected string
 	}{
 		{
-			name:     "test alphanumeric characters",
-			email:    "[email protected]",
-			expected: "test_user",
+			email:    "[email protected]",
+			expected: "test_user_1234",
 		},
 		{
-			name:     "test unicode characters",
 			email:    "tést.ü[email protected]",
 			expected: "tést_üser",
 		},
 		{
-			name:     "test special characters",
 			email:    "[email protected]",
 			expected: "test__user",
 		},
+		{
+			email:    `jöhn.dœ@domain.com`, // Using non-ASCII characters.
+			expected: "jöhn_dœ",
+		},
+		{
+			email:    `[email protected]`, // The plus (+) sign is used for "sub-addressing" in some email services.
+			expected: "first_tag",
+		},
+		{
+			email:    `[email protected]`, // Using a sub-domain.
+			expected: "email",
+		},
+		{
+			email:    `"_quoted"@domain.com`, // Quoted strings can be part of the local-part.
+			expected: "__quoted_",
+		},
+		{
+			email:    `name-o'[email protected]`, // Single quote in the local-part.
+			expected: "name_o_mally",
+		},
+		{
+			email:    `user%[email protected]`, // Percent sign can be used for email routing in legacy systems.
+			expected: "user_domain",
+		},
+		{
+			email:    `[email protected]`, // Multiple dots in the local-part.
+			expected: "long_name_with_dots",
+		},
+		{
+			email:    `me&[email protected]`, // Using an ampersand (&) in the local-part.
+			expected: "me_you",
+		},
+		{
+			email:    `[email protected]`, // The exclamation mark can be valid in some legacy systems.
+			expected: "user_def_xyz",
+		},
+		{
+			email:    `admin@ιντερνετ.com`, // Domain in non-ASCII characters (IDN or Internationalized Domain Name).
+			expected: "admin",
+		},
 	}
 
 	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			result := getShortUserName(tt.email)
-			if result != tt.expected {
-				t.Errorf("getShortUserName(%q) = %q; expected %q", tt.email, result, tt.expected)
-			}
-		})
+		assert.Equal(t, tt.expected, getShortUserName(tt.email))
 	}
 }