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

[FIXED] Set read deadline in object store to a configurable value #1531

Merged
merged 1 commit into from
Jan 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 5 additions & 1 deletion jetstream/object.go
Original file line number Diff line number Diff line change
Expand Up @@ -1120,7 +1120,11 @@ func (obs *obs) Status(ctx context.Context) (ObjectStoreStatus, error) {
func (o *objResult) Read(p []byte) (n int, err error) {
o.Lock()
defer o.Unlock()
readDeadline := time.Now().Add(defaultAPITimeout)
if ctx := o.ctx; ctx != nil {
if deadline, ok := ctx.Deadline(); ok {
readDeadline = deadline
}
select {
case <-ctx.Done():
if ctx.Err() == context.Canceled {
Expand All @@ -1139,7 +1143,7 @@ func (o *objResult) Read(p []byte) (n int, err error) {
}

r := o.r.(net.Conn)
_ = r.SetReadDeadline(time.Now().Add(2 * time.Second))
_ = r.SetReadDeadline(readDeadline)
n, err = r.Read(p)
if err, ok := err.(net.Error); ok && err.Timeout() {
if ctx := o.ctx; ctx != nil {
Expand Down
29 changes: 29 additions & 0 deletions jetstream/test/object_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -1077,3 +1077,32 @@ func TestDecodeObjectDigest(t *testing.T) {
})
}
}

func TestObjectStoreGetObjectContextTimeout(t *testing.T) {
s := RunBasicJetStreamServer()
defer shutdownJSServerAndRemoveStorage(t, s)

nc, js := jsClient(t, s)
defer nc.Close()

obs, err := js.CreateObjectStore(context.Background(), jetstream.ObjectStoreConfig{Bucket: "OBJS"})
expectOk(t, err)

blob := make([]byte, 1024)
_, err = rand.Read(blob)
expectOk(t, err)

_, err = obs.PutBytes(context.Background(), "blob", blob)
expectOk(t, err)

ctx, cancel := context.WithTimeout(context.Background(), 10*time.Millisecond)
defer cancel()

r, err := obs.Get(ctx, "blob")
expectOk(t, err)
time.Sleep(15 * time.Millisecond)
var res []byte
_, err = r.Read(res)
expectErr(t, err, nats.ErrTimeout)
r.Close()
}
20 changes: 13 additions & 7 deletions object.go
Original file line number Diff line number Diff line change
Expand Up @@ -535,11 +535,12 @@ func DecodeObjectDigest(data string) ([]byte, error) {
// ObjectResult impl.
type objResult struct {
sync.Mutex
info *ObjectInfo
r io.ReadCloser
err error
ctx context.Context
digest hash.Hash
info *ObjectInfo
r io.ReadCloser
err error
ctx context.Context
digest hash.Hash
readTimeout time.Duration
}

func (info *ObjectInfo) isLink() bool {
Expand Down Expand Up @@ -623,7 +624,7 @@ func (obs *obs) Get(name string, opts ...GetObjectOpt) (ObjectResult, error) {
return lobs.Get(info.ObjectMeta.Opts.Link.Name)
}

result := &objResult{info: info, ctx: ctx}
result := &objResult{info: info, ctx: ctx, readTimeout: obs.js.opts.wait}
if info.Size == 0 {
return result, nil
}
Expand Down Expand Up @@ -1242,7 +1243,11 @@ func (obs *obs) Status() (ObjectStoreStatus, error) {
func (o *objResult) Read(p []byte) (n int, err error) {
o.Lock()
defer o.Unlock()
readDeadline := time.Now().Add(o.readTimeout)
if ctx := o.ctx; ctx != nil {
if deadline, ok := ctx.Deadline(); ok {
readDeadline = deadline
}
select {
case <-ctx.Done():
if ctx.Err() == context.Canceled {
Expand All @@ -1261,7 +1266,8 @@ func (o *objResult) Read(p []byte) (n int, err error) {
}

r := o.r.(net.Conn)
r.SetReadDeadline(time.Now().Add(2 * time.Second))
fmt.Println("read deadline", o.readTimeout)
r.SetReadDeadline(readDeadline)
n, err = r.Read(p)
if err, ok := err.(net.Error); ok && err.Timeout() {
if ctx := o.ctx; ctx != nil {
Expand Down
29 changes: 29 additions & 0 deletions test/object_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -1058,3 +1058,32 @@ func TestDecodeObjectDigest(t *testing.T) {
})
}
}

func TestObjectStoreGetObjectContextTimeout(t *testing.T) {
s := RunBasicJetStreamServer()
defer shutdownJSServerAndRemoveStorage(t, s)

nc, js := jsClient(t, s)
defer nc.Close()

obs, err := js.CreateObjectStore(&nats.ObjectStoreConfig{Bucket: "OBJS"})
expectOk(t, err)

blob := make([]byte, 1024)
_, err = rand.Read(blob)
expectOk(t, err)

_, err = obs.PutBytes("blob", blob)
expectOk(t, err)

ctx, cancel := context.WithTimeout(context.Background(), 10*time.Millisecond)
defer cancel()

r, err := obs.Get("blob", nats.Context(ctx))
expectOk(t, err)
time.Sleep(15 * time.Millisecond)
var res []byte
_, err = r.Read(res)
expectErr(t, err, nats.ErrTimeout)
r.Close()
}