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 runtime error: comparing uncomparable type #18893

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion client/v3/lease.go
Original file line number Diff line number Diff line change
Expand Up @@ -264,6 +264,9 @@ func (l *lessor) Leases(ctx context.Context) (*LeaseLeasesResponse, error) {
return nil, ContextError(ctx, err)
}

// for marking context itself
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
// for marking context itself
// To identify the context passed to `KeepAlive`, a key/value pair is
// attached to the context. The key is a `keepAliveCtxKey` object, and
// the value is the pointer to the context object itself, ensuring
// uniqueness as each context has a unique memory address.

type keepAliveCtxKey struct{}

func (l *lessor) KeepAlive(ctx context.Context, id LeaseID) (<-chan *LeaseKeepAliveResponse, error) {
ch := make(chan *LeaseKeepAliveResponse, LeaseResponseChSize)

Expand All @@ -278,6 +281,11 @@ func (l *lessor) KeepAlive(ctx context.Context, id LeaseID) (<-chan *LeaseKeepAl
default:
}
ka, ok := l.keepAlives[id]

if ctx.Done() != nil {
// mark this context for later retrieval
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
// mark this context for later retrieval

ctx = context.WithValue(ctx, keepAliveCtxKey{}, &ctx)
}
if !ok {
// create fresh keep alive
ka = &keepAlive{
Expand Down Expand Up @@ -348,7 +356,8 @@ func (l *lessor) keepAliveCtxCloser(ctx context.Context, id LeaseID, donec <-cha

// close channel and remove context if still associated with keep alive
for i, c := range ka.ctxs {
if c == ctx {
// the target ctx should have the same value as the current ctx
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
// the target ctx should have the same value as the current ctx

if c.Value(keepAliveCtxKey{}) == ctx.Value(keepAliveCtxKey{}) {
close(ka.chs[i])
ka.ctxs = append(ka.ctxs[:i], ka.ctxs[i+1:]...)
ka.chs = append(ka.chs[:i], ka.chs[i+1:]...)
Expand Down
29 changes: 28 additions & 1 deletion tests/integration/clientv3/lease/lease_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,14 @@ func TestLeaseKeepAlive(t *testing.T) {
t.Errorf("failed to create lease %v", err)
}

rc, kerr := lapi.KeepAlive(context.Background(), resp.ID)
type uncomparableCtx struct {
context.Context
_ func()
}

ctx, cancel := context.WithCancel(context.Background())
defer cancel()
rc, kerr := lapi.KeepAlive(uncomparableCtx{Context: ctx}, resp.ID)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The easiest workaround is to pass in a pointer &uncomparableCtx{Context: ctx}.

if kerr != nil {
t.Errorf("failed to keepalive lease %v", kerr)
}
Expand All @@ -154,6 +161,26 @@ func TestLeaseKeepAlive(t *testing.T) {
t.Errorf("ID = %x, want %x", kresp.ID, resp.ID)
}

ctx2, cancel2 := context.WithCancel(context.Background())
rc2, kerr2 := lapi.KeepAlive(uncomparableCtx{Context: ctx2}, resp.ID)
if kerr2 != nil {
t.Errorf("failed to keepalive lease %v", kerr2)
}

cancel2()

_, ok = <-rc2
if ok {
t.Errorf("chan is not closed, want cancel stop keepalive")
}

select {
case <-rc:
// cancel2() should not affect first keepalive
t.Errorf("chan is closed, want keepalive continue")
default:
}

lapi.Close()

_, ok = <-rc
Expand Down