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

added xcontext.CancelsGuard #1188

Merged
merged 1 commit into from
Apr 9, 2024
Merged
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
37 changes: 27 additions & 10 deletions internal/conn/conn.go
Original file line number Diff line number Diff line change
@@ -56,6 +56,7 @@ type conn struct {
closed bool
state atomic.Uint32
lastUsage *lastUsage
childStreams *xcontext.CancelsGuard
onClose []func(*conn)
onTransportErrors []func(ctx context.Context, cc Conn, cause error)
}
@@ -392,23 +393,21 @@ func (c *conn) NewStream(
desc *grpc.StreamDesc,
method string,
opts ...grpc.CallOption,
) (_ grpc.ClientStream, err error) {
) (_ grpc.ClientStream, finalErr error) {
var (
onDone = trace.DriverOnConnNewStream(
c.config.Trace(), &ctx,
stack.FunctionID("github.com/ydb-platform/ydb-go-sdk/3/internal/conn.(*conn).NewStream"),
c.endpoint.Copy(), trace.Method(method),
)
useWrapping = UseWrapping(ctx)
cc *grpc.ClientConn
s grpc.ClientStream
)

defer func() {
onDone(err, c.GetState())
onDone(finalErr, c.GetState())
}()

cc, err = c.realConn(ctx)
cc, err := c.realConn(ctx)
if err != nil {
return nil, c.wrapError(err)
}
@@ -423,7 +422,19 @@ func (c *conn) NewStream(

ctx, sentMark := markContext(meta.WithTraceID(ctx, traceID))

s, err = cc.NewStream(ctx, desc, method, opts...)
ctx, cancel := xcontext.WithCancel(ctx)
defer func() {
if finalErr != nil {
cancel()
} else {
c.childStreams.Remember(&cancel)
}
}()

s, err := cc.NewStream(ctx, desc, method, append(opts, grpc.OnFinish(func(err error) {
cancel()
c.childStreams.Forget(&cancel)
}))...)
if err != nil {
if xerrors.IsContextError(err) {
return nil, xerrors.WithStackTrace(err)
@@ -490,10 +501,16 @@ func withOnTransportError(onTransportError func(ctx context.Context, cc Conn, ca

func newConn(e endpoint.Endpoint, config Config, opts ...option) *conn {
c := &conn{
endpoint: e,
config: config,
done: make(chan struct{}),
lastUsage: newLastUsage(nil),
endpoint: e,
config: config,
done: make(chan struct{}),
lastUsage: newLastUsage(nil),
childStreams: xcontext.NewCancelsGuard(),
onClose: []func(*conn){
func(c *conn) {
c.childStreams.Cancel()
},
},
}
c.state.Store(uint32(Created))
for _, opt := range opts {
38 changes: 38 additions & 0 deletions internal/xcontext/cancels_quard.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
package xcontext

import (
"context"
"sync"
)

type CancelsGuard struct {
mu sync.Mutex
cancels map[*context.CancelFunc]struct{}
}

func NewCancelsGuard() *CancelsGuard {
return &CancelsGuard{
cancels: make(map[*context.CancelFunc]struct{}),
}
}

func (g *CancelsGuard) Remember(cancel *context.CancelFunc) {
g.mu.Lock()
defer g.mu.Unlock()
g.cancels[cancel] = struct{}{}
}

func (g *CancelsGuard) Forget(cancel *context.CancelFunc) {
g.mu.Lock()
defer g.mu.Unlock()
delete(g.cancels, cancel)
}

func (g *CancelsGuard) Cancel() {
g.mu.Lock()
defer g.mu.Unlock()
for cancel := range g.cancels {
(*cancel)()
}
g.cancels = make(map[*context.CancelFunc]struct{})
}
24 changes: 24 additions & 0 deletions internal/xcontext/cancels_quard_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
package xcontext

import (
"testing"

"github.com/stretchr/testify/require"
"golang.org/x/net/context"
)

func TestCancelsGuard(t *testing.T) {
g := NewCancelsGuard()
ctx, cancel1 := context.WithCancel(context.Background())
g.Remember(&cancel1)
require.Len(t, g.cancels, 1)
g.Forget(&cancel1)
require.Empty(t, g.cancels, 0)
cancel2 := context.CancelFunc(func() {
cancel1()
})
g.Remember(&cancel2)
require.Len(t, g.cancels, 1)
g.Cancel()
require.Error(t, ctx.Err())
}