Add consumer info usage warnings#1079
Merged
Merged
Conversation
Add performance warnings about frequent `ConsumerInfo` API calls.
Contributor
There was a problem hiding this comment.
Pull request overview
Adds documentation warnings to discourage frequent ConsumerInfo/$JS.API.CONSUMER.INFO calls and steer users toward message metadata for runtime progress signals.
Changes:
- Add performance warning remarks to
INatsJSContext.GetConsumerAsyncdocumenting server load implications and alternatives. - Add warning remarks to
INatsJSConsumer.InfoandINatsJSConsumer.RefreshAsyncabout repeated refresh patterns. - Switch implementation XML docs in
NatsJSContext/NatsJSConsumerto<inheritdoc />to inherit the updated interface documentation.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| src/NATS.Client.JetStream/NatsJSContext.Consumers.cs | Uses <inheritdoc /> on GetConsumerAsync so warnings in the interface surface on the concrete implementation. |
| src/NATS.Client.JetStream/NatsJSConsumer.cs | Uses <inheritdoc /> for Info and RefreshAsync so interface warnings apply to the implementation. |
| src/NATS.Client.JetStream/INatsJSContext.cs | Adds detailed remarks warning about frequent CONSUMER.INFO calls and suggests alternatives. |
| src/NATS.Client.JetStream/INatsJSConsumer.cs | Adds similar warning remarks on Info and RefreshAsync to reduce misuse. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
|
@mtmk is it possible to preview these docs rendered? |
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…in permissions Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>
This comment was marked as resolved.
This comment was marked as resolved.
…ts properties (#1080) * Initial plan * docs: clarify that INatsJSMsg.Metadata is nullable and must be checked before use Co-authored-by: mtmk <386903+mtmk@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: mtmk <386903+mtmk@users.noreply.github.com>
Member
Author
thanks for checking this @alexbozhenko ... there is a preview now :-) Please check the 'Deployed on' link in comments for new commits. |
Contributor
|
@mtmk great, the text is very clear! |
mtmk
added a commit
that referenced
this pull request
Mar 13, 2026
* Add optional window_size parameter to StreamSnapshotRequest (#1088) * Bump Microsoft.Bcl.Memory from 9.0.0 to 9.0.14 (#1089) * Fix `PingCommand` cancellation (#1086) * rework terminate reason (#1081) * Fix OTel network telemetry tags (#1078) * Add consumer info usage warnings (#1079) * Add TermWithReason support to AckTerminateAsync (#1048) * Fix code analyser warning (#1076) * Add cancelled token handling for consumers (#1068) * Add validation for unsupported PinnedClient calls (#1063) * Add see-also references to Orbit packages (#1077) * Add Synadia.Orbit.Testing.NatsServerProcessManager (#1065) * Add slow consumer docs (#1073) * Fix error logs URI rewritten by OnConnectingAsync (#1067) * Add more tests for JetStream consumer behavior (#1055)
Merged
mtmk
added a commit
that referenced
this pull request
Mar 13, 2026
* Add optional window_size parameter to StreamSnapshotRequest (#1088) * Bump Microsoft.Bcl.Memory from 9.0.0 to 9.0.14 (#1089) * Fix `PingCommand` cancellation (#1086) * rework terminate reason (#1081) * Fix OTel network telemetry tags (#1078) * Add consumer info usage warnings (#1079) * Add TermWithReason support to AckTerminateAsync (#1048) * Fix code analyser warning (#1076) * Add cancelled token handling for consumers (#1068) * Add validation for unsupported PinnedClient calls (#1063) * Add see-also references to Orbit packages (#1077) * Add Synadia.Orbit.Testing.NatsServerProcessManager (#1065) * Add slow consumer docs (#1073) * Fix error logs URI rewritten by OnConnectingAsync (#1067) * Add more tests for JetStream consumer behavior (#1055)
This was referenced Jul 12, 2026
This was referenced Jul 13, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Add performance warnings about frequent
ConsumerInfoAPI calls.