Skip to content

Commit

Permalink
Render UUID in parameters as string
Browse files Browse the repository at this point in the history 
We make heavy use of the new UUID feature introduced in deepmap#571, deepmap#546 and deepmap#556.
However, we observed that using a UUID as parameter creates malformed
strings in the requests made by the generated clients. This adds a
special handling for types.UUID in the StyleParamWithLocation function.
I'm not that happy with this approach. I would like to use an interface
"MarshalParameter" for this with semantics similar to MarshalJSON. But
that doesn't work for aliased types as UUIDs.
  • Loading branch information
Christoph Petrausch committed Jun 3, 2022
1 parent 14fc88e commit 486bd0f
Show file tree
Hide file tree
Showing 2 changed files with 111 additions and 0 deletions.
9 changes: 9 additions & 0 deletions pkg/runtime/styleparam.go
View file
Expand Up @@ -62,6 +62,15 @@ func StyleParamWithLocation(style string, explode bool, paramName string, paramL
t = v.Type()
}

// types.UUID is internally a byte array, thus primitiveToString doesn't support this type. So to enable
// the usage of UUID formated strings as parameters, we first convert the UUID to string and than handle it as
// normal string.
if t.ConvertibleTo(reflect.TypeOf(types.UUID{})) {
value = (v.Interface()).(types.UUID).String()
t = reflect.TypeOf(value)
v = reflect.ValueOf(value)
}

switch t.Kind() {
case reflect.Slice:
n := v.Len()
Expand Down
102 changes: 102 additions & 0 deletions pkg/runtime/styleparam_test.go
View file
Expand Up @@ -46,6 +46,8 @@ func TestStyleParam(t *testing.T) {
type AliasedDate types.Date
date := AliasedDate{time.Date(2020, 1, 1, 0, 0, 0, 0, time.UTC)}

uuid := types.UUID{29, 187, 26, 155, 135, 17, 72, 196, 128, 137, 190, 20, 140, 9, 201, 56}

// ---------------------------- Simple Style -------------------------------

result, err := StyleParamWithLocation("simple", false, "id", ParamLocationQuery, primitive)
Expand Down Expand Up @@ -112,6 +114,22 @@ func TestStyleParam(t *testing.T) {
assert.NoError(t, err)
assert.EqualValues(t, "2020-01-01", result)

result, err = StyleParamWithLocation("simple", false, "id", ParamLocationQuery, uuid)
assert.NoError(t, err)
assert.EqualValues(t, "1dbb1a9b-8711-48c4-8089-be148c09c938", result)

result, err = StyleParamWithLocation("simple", true, "id", ParamLocationQuery, uuid)
assert.NoError(t, err)
assert.EqualValues(t, "1dbb1a9b-8711-48c4-8089-be148c09c938", result)

result, err = StyleParamWithLocation("simple", false, "id", ParamLocationQuery, &uuid)
assert.NoError(t, err)
assert.EqualValues(t, "1dbb1a9b-8711-48c4-8089-be148c09c938", result)

result, err = StyleParamWithLocation("simple", true, "id", ParamLocationQuery, &uuid)
assert.NoError(t, err)
assert.EqualValues(t, "1dbb1a9b-8711-48c4-8089-be148c09c938", result)

// ----------------------------- Label Style -------------------------------

result, err = StyleParamWithLocation("label", false, "id", ParamLocationQuery, primitive)
Expand Down Expand Up @@ -178,6 +196,22 @@ func TestStyleParam(t *testing.T) {
assert.NoError(t, err)
assert.EqualValues(t, ".2020-01-01", result)

result, err = StyleParamWithLocation("label", false, "id", ParamLocationQuery, uuid)
assert.NoError(t, err)
assert.EqualValues(t, ".1dbb1a9b-8711-48c4-8089-be148c09c938", result)

result, err = StyleParamWithLocation("label", true, "id", ParamLocationQuery, uuid)
assert.NoError(t, err)
assert.EqualValues(t, ".1dbb1a9b-8711-48c4-8089-be148c09c938", result)

result, err = StyleParamWithLocation("label", false, "id", ParamLocationQuery, &uuid)
assert.NoError(t, err)
assert.EqualValues(t, ".1dbb1a9b-8711-48c4-8089-be148c09c938", result)

result, err = StyleParamWithLocation("label", true, "id", ParamLocationQuery, &uuid)
assert.NoError(t, err)
assert.EqualValues(t, ".1dbb1a9b-8711-48c4-8089-be148c09c938", result)

// ----------------------------- Matrix Style ------------------------------

result, err = StyleParamWithLocation("matrix", false, "id", ParamLocationQuery, primitive)
Expand Down Expand Up @@ -244,6 +278,22 @@ func TestStyleParam(t *testing.T) {
assert.NoError(t, err)
assert.EqualValues(t, ";id=2020-01-01", result)

result, err = StyleParamWithLocation("matrix", false, "id", ParamLocationQuery, uuid)
assert.NoError(t, err)
assert.EqualValues(t, ";id=1dbb1a9b-8711-48c4-8089-be148c09c938", result)

result, err = StyleParamWithLocation("matrix", true, "id", ParamLocationQuery, uuid)
assert.NoError(t, err)
assert.EqualValues(t, ";id=1dbb1a9b-8711-48c4-8089-be148c09c938", result)

result, err = StyleParamWithLocation("matrix", false, "id", ParamLocationQuery, &uuid)
assert.NoError(t, err)
assert.EqualValues(t, ";id=1dbb1a9b-8711-48c4-8089-be148c09c938", result)

result, err = StyleParamWithLocation("matrix", true, "id", ParamLocationQuery, &uuid)
assert.NoError(t, err)
assert.EqualValues(t, ";id=1dbb1a9b-8711-48c4-8089-be148c09c938", result)

// ------------------------------ Form Style -------------------------------
result, err = StyleParamWithLocation("form", false, "id", ParamLocationQuery, primitive)
assert.NoError(t, err)
Expand Down Expand Up @@ -325,6 +375,22 @@ func TestStyleParam(t *testing.T) {
assert.NoError(t, err)
assert.EqualValues(t, "id=2020-01-01", result)

result, err = StyleParamWithLocation("form", false, "id", ParamLocationQuery, uuid)
assert.NoError(t, err)
assert.EqualValues(t, "id=1dbb1a9b-8711-48c4-8089-be148c09c938", result)

result, err = StyleParamWithLocation("form", true, "id", ParamLocationQuery, uuid)
assert.NoError(t, err)
assert.EqualValues(t, "id=1dbb1a9b-8711-48c4-8089-be148c09c938", result)

result, err = StyleParamWithLocation("form", false, "id", ParamLocationQuery, &uuid)
assert.NoError(t, err)
assert.EqualValues(t, "id=1dbb1a9b-8711-48c4-8089-be148c09c938", result)

result, err = StyleParamWithLocation("form", true, "id", ParamLocationQuery, &uuid)
assert.NoError(t, err)
assert.EqualValues(t, "id=1dbb1a9b-8711-48c4-8089-be148c09c938", result)

// ------------------------ spaceDelimited Style --------------------------

result, err = StyleParamWithLocation("spaceDelimited", false, "id", ParamLocationQuery, primitive)
Expand Down Expand Up @@ -377,6 +443,18 @@ func TestStyleParam(t *testing.T) {
result, err = StyleParamWithLocation("spaceDelimited", true, "id", ParamLocationQuery, &date)
assert.Error(t, err)

result, err = StyleParamWithLocation("spaceDelimited", false, "id", ParamLocationQuery, uuid)
assert.Error(t, err)

result, err = StyleParamWithLocation("spaceDelimited", true, "id", ParamLocationQuery, uuid)
assert.Error(t, err)

result, err = StyleParamWithLocation("spaceDelimited", false, "id", ParamLocationQuery, &uuid)
assert.Error(t, err)

result, err = StyleParamWithLocation("spaceDelimited", true, "id", ParamLocationQuery, &uuid)
assert.Error(t, err)

// ------------------------- pipeDelimited Style --------------------------

result, err = StyleParamWithLocation("pipeDelimited", false, "id", ParamLocationQuery, primitive)
Expand Down Expand Up @@ -429,6 +507,18 @@ func TestStyleParam(t *testing.T) {
result, err = StyleParamWithLocation("pipeDelimited", true, "id", ParamLocationQuery, &date)
assert.Error(t, err)

result, err = StyleParamWithLocation("pipeDelimited", false, "id", ParamLocationQuery, uuid)
assert.Error(t, err)

result, err = StyleParamWithLocation("pipeDelimited", true, "id", ParamLocationQuery, uuid)
assert.Error(t, err)

result, err = StyleParamWithLocation("pipeDelimited", false, "id", ParamLocationQuery, &uuid)
assert.Error(t, err)

result, err = StyleParamWithLocation("pipeDelimited", true, "id", ParamLocationQuery, &uuid)
assert.Error(t, err)

// --------------------------- deepObject Style ---------------------------
result, err = StyleParamWithLocation("deepObject", false, "id", ParamLocationQuery, primitive)
assert.Error(t, err)
Expand Down Expand Up @@ -478,6 +568,18 @@ func TestStyleParam(t *testing.T) {
result, err = StyleParamWithLocation("deepObject", true, "id", ParamLocationQuery, &date)
assert.Error(t, err)

result, err = StyleParamWithLocation("deepObject", false, "id", ParamLocationQuery, uuid)
assert.Error(t, err)

result, err = StyleParamWithLocation("deepObject", true, "id", ParamLocationQuery, uuid)
assert.Error(t, err)

result, err = StyleParamWithLocation("deepObject", false, "id", ParamLocationQuery, &uuid)
assert.Error(t, err)

result, err = StyleParamWithLocation("deepObject", true, "id", ParamLocationQuery, &uuid)
assert.Error(t, err)

// Misc tests
// Test type aliases
type StrType string
Expand Down

0 comments on commit 486bd0f

Please sign in to comment.