Uh oh!
There was an error while loading. Please reload this page.
Document IDataConsumer UID filtering - #10740
Conversation
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 469109f6-5c6d-4ebb-af75-24785643dc56
There was a problem hiding this comment.
Note
🤖 Automated review by GitHub Copilot. Generated by the Expert Code Review workflow. To request a follow-up action, reply by tagging @copilot directly.
Review Summary
This is a documentation-only change adding XML doc <remarks> to IDataConsumer and IMessageBus.PublishAsync to document the same-UID skip behavior.
| Dimension | Verdict |
|---|---|
| Accuracy | ✅ Verified — AsyncConsumerDataProcessor (line 90) and BlockingConsumerDataProcessor (line 55) both check dataProducer.Uid == DataConsumer.Uid and skip dispatch when they match. |
| Clarity | ✅ Clear and concise |
| Consistency | ✅ Matches existing XML doc style in the codebase |
| Completeness | ✅ Both the consumer interface and the publish method are annotated |
| Public API surface | ✅ No new public API — doc comments only |
No issues found. The documented behavior accurately reflects the implementation.
There was a problem hiding this comment.
Pull request overview
Documents message-bus UID filtering to clarify why consumers do not receive self-produced data.
Changes:
- Documents same-UID filtering on
IMessageBus.PublishAsync. - Advises
IDataConsumerimplementations to process self-produced data directly.
Show a summary per file
| File | Description |
|---|---|
IMessageBus.cs | Documents publish-time UID filtering. |
IDataConsumer.cs | Explains UID requirements and self-processing guidance. |
Review details
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
- Files reviewed: 2/2 changed files
- Comments generated: 0
- Review effort level: Balanced
Uh oh!
There was an error while loading. Please reload this page.
Clarifies that the Microsoft.Testing.Platform message bus does not dispatch data to an
IDataConsumerwhen the producer and consumer share the sameIExtension.Uid.The API documentation now explains that producer and consumer registrations communicating through the message bus need distinct UIDs, while self-produced data should be processed directly.
Fixes#4588