Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(tracestate): drop right-most member in tracestate #2592

Merged
merged 11 commits into from Feb 23, 2022
17 changes: 7 additions & 10 deletions trace/tracestate.go
Expand Up @@ -179,17 +179,14 @@ func (ts TraceState) Insert(key, value string) (TraceState, error) {
}
MrAlias marked this conversation as resolved.
Show resolved Hide resolved

cTS := ts.Delete(key)
if cTS.Len()+1 > maxListMembers {
// TODO (MrAlias): When the second version of the Trace Context
// specification is published this needs to not return an error.
// Instead it should drop the "right-most" member and insert the new
// member at the front.
//
// https://github.com/w3c/trace-context/pull/448
return ts, fmt.Errorf("failed to insert: %w", errMemberNumber)
if cTS.Len()+1 <= maxListMembers {
cTS.list = append(cTS.list, member{})
}

cTS.list = append(cTS.list, member{})
// if tracestate's members > maxListMembers, defaultly
// it should drop the "right-most" member and insert the new
// member at the front.
1046102779 marked this conversation as resolved.
Show resolved Hide resolved
//
// https://github.com/w3c/trace-context/pull/448
copy(cTS.list[1:], cTS.list)
cTS.list[0] = m

Expand Down
17 changes: 12 additions & 5 deletions trace/tracestate_test.go
Expand Up @@ -443,14 +443,21 @@ func TestTraceStateInsert(t *testing.T) {
err: errInvalidKey,
},
{
name: "too many entries",
name: "drop the right-most member(oldest) in queue",
tracestate: maxMembers,
key: "keyx",
value: "valx",
expected: maxMembers,
err: errMemberNumber,
},
}
expected: func() TraceState {
1046102779 marked this conversation as resolved.
Show resolved Hide resolved
var traceState TraceState
traceState.list = make([]member, 0, len(maxMembers.list))
traceState.list = append(traceState.list, member{
Key: "keyx",
Value: "valx",
})
traceState.list = append(traceState.list, maxMembers.list[:len(maxMembers.list)-1]...)
return traceState
}(),
}}

for _, tc := range testCases {
actual, err := tc.tracestate.Insert(tc.key, tc.value)
Expand Down