Skip to content
This repository has been archived by the owner on May 21, 2024. It is now read-only.

Commit

Permalink
Extracting metadata construction logic
Browse files Browse the repository at this point in the history
Extracting logic + few more tests
  • Loading branch information
olegbespalov committed Sep 14, 2023
1 parent 2c61f57 commit ee5e0dc
Show file tree
Hide file tree
Showing 2 changed files with 83 additions and 23 deletions.
64 changes: 41 additions & 23 deletions grpc/params.go
Original file line number Diff line number Diff line change
Expand Up @@ -41,31 +41,12 @@ func newCallParams(vu modules.VU, input goja.Value) (*callParams, error) {
for _, k := range params.Keys() {
switch k {
case "metadata":
v := params.Get(k).Export()
rawHeaders, ok := v.(map[string]interface{})
if !ok {
return result, errors.New("metadata must be an object with key-value pairs")
md, err := newMetadata(params.Get(k))
if err != nil {
return result, fmt.Errorf("invalid metadata param: %w", err)
}

for hk, kv := range rawHeaders {
var val string

// The gRPC spec defines that Binary-valued keys end in -bin
// https://grpc.io/docs/what-is-grpc/core-concepts/#metadata
if strings.HasSuffix(hk, "-bin") {
var binVal []byte
if binVal, ok = kv.([]byte); !ok {
return result, fmt.Errorf("metadata %q value must be binary", hk)
}

// https://github.com/grpc/grpc-go/blob/v1.57.0/Documentation/grpc-metadata.md#storing-binary-data-in-metadata
val = string(binVal)
} else if val, ok = kv.(string); !ok {
return result, fmt.Errorf("metadata %q value must be a string", hk)
}

result.Metadata.Append(hk, val)
}
result.Metadata = md
case "tags":
if err := common.ApplyCustomUserTags(rt, &result.TagsAndMeta, params.Get(k)); err != nil {
return result, fmt.Errorf("metric tags: %w", err)
Expand All @@ -85,6 +66,43 @@ func newCallParams(vu modules.VU, input goja.Value) (*callParams, error) {
return result, nil
}

// newMetadata constructs a metadata.MD from the input value.
func newMetadata(input goja.Value) (metadata.MD, error) {
md := metadata.New(nil)

if input == nil || goja.IsUndefined(input) || goja.IsNull(input) {
return md, nil
}

v := input.Export()

rawHeaders, ok := v.(map[string]interface{})
if !ok {
return md, errors.New("metadata must be an object with key-value pairs")
}

for hk, kv := range rawHeaders {
var val string
// The gRPC spec defines that Binary-valued keys end in -bin
// https://grpc.io/docs/what-is-grpc/core-concepts/#metadata
if strings.HasSuffix(hk, "-bin") {
var binVal []byte
if binVal, ok = kv.([]byte); !ok {
return md, fmt.Errorf("metadata %q value must be binary", hk)
}

// https://github.com/grpc/grpc-go/blob/v1.57.0/Documentation/grpc-metadata.md#storing-binary-data-in-metadata
val = string(binVal)
} else if val, ok = kv.(string); !ok {
return md, fmt.Errorf("metadata %q value must be a string", hk)
}

md.Append(hk, val)
}

return md, nil
}

// SetSystemTags sets the system tags for the call.
func (p *callParams) SetSystemTags(state *lib.State, addr string, methodName string) {
if state.Options.SystemTags.Has(metrics.TagURL) {
Expand Down
42 changes: 42 additions & 0 deletions grpc/params_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import (
"go.k6.io/k6/js/modulestest"
"go.k6.io/k6/lib"
"go.k6.io/k6/metrics"
"google.golang.org/grpc/metadata"
"gopkg.in/guregu/null.v3"
)

Expand All @@ -39,6 +40,11 @@ func TestParamsInvalidInput(t *testing.T) {
JSON: `{ timeout: "please" }`,
ErrContains: `invalid duration`,
},
{
Name: "InvalidMetadata",
JSON: `{ metadata: "lorem" }`,
ErrContains: `invalid metadata param: metadata must be an object with key-value pairs`,
},
}

for _, tc := range testCases {
Expand All @@ -56,6 +62,42 @@ func TestParamsInvalidInput(t *testing.T) {
}
}

func TestCallParamsMetadata(t *testing.T) {
t.Parallel()

testCases := []struct {
Name string
JSON string
ExpectedMetadata metadata.MD
}{
{
Name: "EmptyMetadata",
JSON: `{}`,
ExpectedMetadata: metadata.New(nil),
},
{
Name: "Metadata",
JSON: `{metadata: {foo: "bar", baz: "qux"}}`,
ExpectedMetadata: metadata.New(map[string]string{"foo": "bar", "baz": "qux"}),
},
}

for _, tc := range testCases {
tc := tc

t.Run(tc.Name, func(t *testing.T) {
t.Parallel()

testRuntime, params := newParamsTestRuntime(t, tc.JSON)

p, err := newCallParams(testRuntime.VU, params)

require.NoError(t, err)
assert.Equal(t, tc.ExpectedMetadata, p.Metadata)
})
}
}

func TestParamsTimeOutParse(t *testing.T) {
t.Parallel()

Expand Down

0 comments on commit ee5e0dc

Please sign in to comment.