feat: add timeout option and graceful shutdown to Subscription.close() #2037
Conversation
This file contains hidden or 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
Implements a new `timeout` option (using `Duration`) for the `Subscription.close()` method. This provides more control over the shutdown process: - If `timeout` is zero, the subscription closes as quickly as possible without nacking buffered messages. - If `timeout` is positive, the subscription attempts to nack any buffered messages (in the lease manager) and waits up to the specified duration for pending acknowledgements and nacks to be sent to the server. - If no timeout is provided, the behavior remains as before (waits indefinitely for pending acks/modacks, no nacking). The core logic is implemented in `Subscriber.close()`. `PubSub.close()` documentation is updated to clarify its scope and recommend using `Subscription.close()` directly for this feature. Includes: - Unit tests for the new timeout behavior in `Subscriber.close()`. - A TypeScript sample (`samples/closeSubscriptionWithTimeout.ts`) demonstrating usage. - Updated JSDoc documentation for relevant methods.
No region tags are edited in this PR.This comment is generated by snippet-bot.
|
|
Warning: This pull request is touching the following templated files:
|
product-auto-label
bot
added
size: l
product-auto-label
bot
added
size: xl
feywind
added
the
owlbot:run
gcf-owl-bot
bot
removed
the
owlbot:run
product-auto-label
bot
added
size: l
gcf-owl-bot
bot
removed
the
owlbot:run
product-auto-label
bot
added
size: xl
gcf-owl-bot
bot
removed
the
owlbot:run
Collaborator
Author
|
Migrated to #2068 to get CI. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Implements a new
timeoutandbehavioroption (usingDuration) for theSubscription.close()method. These options are on the SubscriberOptions/SubscriptionOptions passed in when opening a subscriber.This provides more control over the shutdown process: