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

feat: add WithoutCancel #200

Merged
merged 6 commits into from
Sep 27, 2021
Merged
Show file tree
Hide file tree
Changes from 3 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
43 changes: 43 additions & 0 deletions ctxmeta/without_cancel.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
package ctxmeta

import (
"context"
"time"
)

type asyncContext struct {
ctx context.Context
}

func (a asyncContext) Deadline() (deadline time.Time, ok bool) {
return
GGXXLL marked this conversation as resolved.
Show resolved Hide resolved
}

func (a asyncContext) Done() <-chan struct{} {
return nil
Copy link
Member Author

Choose a reason for hiding this comment

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

what's the purpose of this change?

}

func (a asyncContext) Err() error {
return nil
}

func (a asyncContext) Value(key interface{}) interface{} {
return a.ctx.Value(key)
}

// WithoutCancel creates a new context from an existing context and inherits all
// values from the existing context. However if the existing context is
// cancelled, timeouts or passes deadline, the returning context will not be
// affected. This is useful in an async HTTP handler. When the http response is sent,
// the request context will be cancelled. If you still want to access the value from request context (eg. tracing),
// you can use:
// func(request *http.Request, responseWriter http.ResponseWriter) {
// go DoSomeSlowDatabaseOperation(WithoutCancel(request.Context()))
// responseWriter.Write([]byte("ok"))
// }
func WithoutCancel(requestScopeContext context.Context) (valueOnlyContext context.Context) {
if requestScopeContext == nil {
panic("cannot create context from nil parent")
}
return asyncContext{requestScopeContext}
}
33 changes: 33 additions & 0 deletions ctxmeta/without_cancel_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
package ctxmeta

import (
"context"
"testing"

"github.com/stretchr/testify/assert"
)

func TestWithoutCancel(t *testing.T) {
key := struct{}{}
ctx := context.WithValue(context.Background(), key, "value")
ctx, cancel := context.WithCancel(ctx)
cancel()

select {
case <-WithoutCancel(ctx).Done():
t.Fatal("context is cancelled")
default:
}

_, dead := WithoutCancel(ctx).Deadline()
assert.False(t, dead)
assert.Nil(t, WithoutCancel(ctx).Err())
assert.Equal(t, "value", WithoutCancel(ctx).Value(key))
}

func TestWithoutCancel_Nil(t *testing.T) {
defer func() {
assert.Equal(t, recover(), "cannot create context from nil parent")
}()
WithoutCancel(nil)
}