Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix(pubsublite): ensure timeout settings are respected (#4329)
Fixes for retryableStream and partitionCountWatcher to ensure PublisherSettings.Timeout and ReceiveSettings.Timeout are respected.
- Loading branch information
Showing
7 changed files
with
311 additions
and
35 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| // Copyright 2021 Google LLC | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // https://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
|
|
||
| package wire | ||
|
|
||
| import ( | ||
| "sync" | ||
| "time" | ||
| ) | ||
|
|
||
| type requestTimerStatus int | ||
|
|
||
| const ( | ||
| requestTimerNew requestTimerStatus = iota | ||
| requestTimerStopped | ||
| requestTimerTriggered | ||
| ) | ||
|
|
||
| // requestTimer bounds the duration of a request and executes `onTimeout` if | ||
| // the timer is triggered. | ||
| type requestTimer struct { | ||
| onTimeout func() | ||
| timeoutErr error | ||
| timer *time.Timer | ||
| mu sync.Mutex | ||
| status requestTimerStatus | ||
| } | ||
|
|
||
| func newRequestTimer(duration time.Duration, onTimeout func(), timeoutErr error) *requestTimer { | ||
| rt := &requestTimer{ | ||
| onTimeout: onTimeout, | ||
| timeoutErr: timeoutErr, | ||
| status: requestTimerNew, | ||
| } | ||
| rt.timer = time.AfterFunc(duration, rt.onTriggered) | ||
| return rt | ||
| } | ||
|
|
||
| func (rt *requestTimer) onTriggered() { | ||
| rt.mu.Lock() | ||
| defer rt.mu.Unlock() | ||
| if rt.status == requestTimerNew { | ||
| rt.status = requestTimerTriggered | ||
| rt.onTimeout() | ||
| } | ||
| } | ||
|
|
||
| // Stop should be called upon a successful request to prevent the timer from | ||
| // expiring. | ||
| func (rt *requestTimer) Stop() { | ||
| rt.mu.Lock() | ||
| defer rt.mu.Unlock() | ||
| if rt.status == requestTimerNew { | ||
| rt.status = requestTimerStopped | ||
| rt.timer.Stop() | ||
| } | ||
| } | ||
|
|
||
| // ResolveError returns `timeoutErr` if the timer triggered, or otherwise | ||
| // `originalErr`. | ||
| func (rt *requestTimer) ResolveError(originalErr error) error { | ||
| rt.mu.Lock() | ||
| defer rt.mu.Unlock() | ||
| if rt.status == requestTimerTriggered { | ||
| return rt.timeoutErr | ||
| } | ||
| return originalErr | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| // Copyright 2021 Google LLC | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // https://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
|
|
||
| package wire | ||
|
|
||
| import ( | ||
| "errors" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "cloud.google.com/go/pubsublite/internal/test" | ||
| ) | ||
|
|
||
| func TestRequestTimerStop(t *testing.T) { | ||
| const timeout = 5 * time.Millisecond | ||
| onTimeout := func() { | ||
| t.Error("onTimeout should not be called") | ||
| } | ||
|
|
||
| rt := newRequestTimer(timeout, onTimeout, errors.New("unused")) | ||
| rt.Stop() | ||
| time.Sleep(2 * timeout) | ||
|
|
||
| if err := rt.ResolveError(nil); err != nil { | ||
| t.Errorf("ResolveError() got gotErr: %v", err) | ||
| } | ||
| wantErr := errors.New("original error") | ||
| if gotErr := rt.ResolveError(wantErr); !test.ErrorEqual(gotErr, wantErr) { | ||
| t.Errorf("ResolveError() got err: %v, want err: %v", gotErr, wantErr) | ||
| } | ||
| } | ||
|
|
||
| func TestRequestTimerExpires(t *testing.T) { | ||
| const timeout = 5 * time.Millisecond | ||
| timeoutErr := errors.New("on timeout") | ||
|
|
||
| expired := test.NewCondition("request timer expired") | ||
| onTimeout := func() { | ||
| expired.SetDone() | ||
| } | ||
|
|
||
| rt := newRequestTimer(timeout, onTimeout, timeoutErr) | ||
| expired.WaitUntilDone(t, serviceTestWaitTimeout) | ||
|
|
||
| if gotErr := rt.ResolveError(nil); !test.ErrorEqual(gotErr, timeoutErr) { | ||
| t.Errorf("ResolveError() got err: %v, want err: %v", gotErr, timeoutErr) | ||
| } | ||
| if gotErr := rt.ResolveError(errors.New("ignored")); !test.ErrorEqual(gotErr, timeoutErr) { | ||
| t.Errorf("ResolveError() got err: %v, want err: %v", gotErr, timeoutErr) | ||
| } | ||
| } |
Oops, something went wrong.