Skip to content

Commit

Permalink
fix: allow slashes in application name (#137)
Browse files Browse the repository at this point in the history
  • Loading branch information
marcsanmi authored Nov 29, 2024
1 parent 574b951 commit 3e89ad9
Show file tree
Hide file tree
Showing 2 changed files with 151 additions and 1 deletion.
2 changes: 1 addition & 1 deletion internal/flameql/flameql.go
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ func IsTagKeyRuneAllowed(r rune) bool {
}

func IsAppNameRuneAllowed(r rune) bool {
return r == '-' || r == '.' || IsTagKeyRuneAllowed(r)
return r == '-' || r == '.' || r == '/' || IsTagKeyRuneAllowed(r)
}

func IsTagKeyReserved(k string) bool {
Expand Down
150 changes: 150 additions & 0 deletions internal/flameql/flameql_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,150 @@
package flameql

import (
"testing"

"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)

func TestParseKey(t *testing.T) {
tests := []struct {
name string
input string
expected *Key
wantErr bool
}{
{
name: "basic app name",
input: "simple-app",
expected: &Key{
labels: map[string]string{
"__name__": "simple-app",
},
},
},
{
name: "app name with slashes and tags",
input: "my/service/name{environment=prod,version=1.0}",
expected: &Key{
labels: map[string]string{
"__name__": "my/service/name",
"environment": "prod",
"version": "1.0",
},
},
},
{
name: "multiple slashes and special characters",
input: "app/service/v1.0-beta/component{region=us-west}",
expected: &Key{
labels: map[string]string{
"__name__": "app/service/v1.0-beta/component",
"region": "us-west",
},
},
},
{
name: "empty app name",
input: "{}",
wantErr: true,
},
{
name: "invalid characters in tag key",
input: "my/service/name{invalid@key=value}",
wantErr: true,
},
{
name: "whitespace handling",
input: "my/service/name{ tag1 = value1 , tag2 = value2 }",
expected: &Key{
labels: map[string]string{
"__name__": "my/service/name",
"tag1": "value1",
"tag2": "value2",
},
},
},
{
name: "dots in service name",
input: "my/service.name/v1.0{environment=prod}",
expected: &Key{
labels: map[string]string{
"__name__": "my/service.name/v1.0",
"environment": "prod",
},
},
},
{
name: "app name with slashes",
input: "my/service/name{}",
expected: &Key{
labels: map[string]string{
"__name__": "my/service/name",
},
},
},
}

for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got, err := ParseKey(tt.input)

if tt.wantErr {
assert.Error(t, err)
return
}

require.NoError(t, err)
assert.Equal(t, tt.expected, got)
})
}
}

func TestKey_Normalized(t *testing.T) {
tests := []struct {
name string
key *Key
expected string
}{
{
name: "simple normalization",
key: &Key{
labels: map[string]string{
"__name__": "my/service/name",
},
},
expected: "my/service/name{}",
},
{
name: "normalization with tags",
key: &Key{
labels: map[string]string{
"__name__": "my/service/name",
"environment": "prod",
"version": "1.0",
},
},
expected: "my/service/name{environment=prod,version=1.0}",
},
{
name: "tags should be sorted",
key: &Key{
labels: map[string]string{
"__name__": "my/service/name",
"c": "3",
"b": "2",
"a": "1",
},
},
expected: "my/service/name{a=1,b=2,c=3}",
},
}

for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got := tt.key.Normalized()
assert.Equal(t, tt.expected, got)
})
}
}

0 comments on commit 3e89ad9

Please sign in to comment.