feat(streaming): add RabbitMQ Streams provider - #8273
Conversation
204b177 to
2de28c9
Compare
2de28c9 to
27c6b26
Compare
27c6b26 to
33e5226
Compare
|
@iuribrindeiro This is awesome! Thank you for putting this together! |
I'm just so glad to be helping! I tried to use the |
|
Thanks for sharing this with the community, @iuribrindeiro. Curious if you've socialized this on the Orleans Discord channel to get some feedback from folks. Exciting stuff, considering how many .NET users are already RabbitMQ users. |
I hadn't tried that yet! But great idea, just joined there and seems like the PR is already known over there xD |
7e26df5 to
d789e35
Compare
|
hi |
This is a really good question. I'm using the RabbitMQ Stream client, so yes, it can. You would just have to follow their instructions to connect to a Multi Host environment. Here is how you would configure the stream provider with a custom RabbitMQ Stream configuration: https://github.com/dotnet/orleans/pull/8273/files#diff-871fbbd5e1d7a137910d48854bf3970bc069efa7f1cd9fceb79cf4e58b2c7dc3R71 |
|
Hi, I really appreciate the efforts making the Pull Request so this is not intended to sound rude, but it would give me clarity if I need to make one on my own or not. |
Unfortunately I ran out of time for this side project of mine (which is really sad for me because I was having a lot of fun). So, I don't see my self working on this anymore in near future :( |
a2d8949 to
b639ee4
Compare
b639ee4 to
7a0880d
Compare
|
@iuribrindeiro please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.
Contributor License AgreementContribution License AgreementThis Contribution License Agreement ( “Agreement” ) is agreed to by the party signing below ( “You” ), 1. Definitions. “Code” means the computer software code, whether in human-readable or machine-executable form, “Project” means any of the projects owned or managed by .NET Foundation and offered under a license “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any “Submission” means the Code and any other copyrightable material Submitted by You, including any 2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any 3. Originality of Work. You represent that each of Your Submissions is entirely Your 4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else 5. Licenses. a. Copyright License. You grant .NET Foundation, and those who receive the Submission directly b. Patent License. You grant .NET Foundation, and those who receive the Submission directly or c. Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement. 6. Representations and Warranties. You represent that You are legally entitled to grant the above 7. Notice to .NET Foundation. You agree to notify .NET Foundation in writing of any facts or 8. Information about Submissions. You agree that contributions to Projects and information about 9. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and 10. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and .NET Foundation dedicates this Contribution License Agreement to the public domain according to the Creative Commons CC0 1. |
1 similar comment
|
@iuribrindeiro please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.
Contributor License AgreementContribution License AgreementThis Contribution License Agreement ( “Agreement” ) is agreed to by the party signing below ( “You” ), 1. Definitions. “Code” means the computer software code, whether in human-readable or machine-executable form, “Project” means any of the projects owned or managed by .NET Foundation and offered under a license “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any “Submission” means the Code and any other copyrightable material Submitted by You, including any 2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any 3. Originality of Work. You represent that each of Your Submissions is entirely Your 4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else 5. Licenses. a. Copyright License. You grant .NET Foundation, and those who receive the Submission directly b. Patent License. You grant .NET Foundation, and those who receive the Submission directly or c. Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement. 6. Representations and Warranties. You represent that You are legally entitled to grant the above 7. Notice to .NET Foundation. You agree to notify .NET Foundation in writing of any facts or 8. Information about Submissions. You agree that contributions to Projects and information about 9. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and 10. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and .NET Foundation dedicates this Contribution License Agreement to the public domain according to the Creative Commons CC0 1. |
There was a problem hiding this comment.
Pull request overview
This PR adds a new RabbitMQ Streams persistent stream provider to Orleans (under src/RabbitMQ/), along with supporting cache/cursor infrastructure, tests, a runnable Aspire-based sample, and documentation updates to surface the new provider in the streaming docs and sample gallery.
Changes:
- Introduces
Microsoft.Orleans.Streaming.RabbitMQ(alpha) provider implementation, including adapter, receiver, producer/consumer, and a custom queue cache/cursor. - Adds unit tests for the queue cache and cursor behavior (purging, retry, refresh semantics).
- Adds an Aspire-hosted RabbitMQ streaming sample plus docs and TOC/package matrix updates.
Show a summary per file
| File | Description |
|---|---|
| test/Extensions/RabbitMQ.Tests/RabbitMqQueueCacheTest.cs | Adds queue cache purge/pressure tests. |
| test/Extensions/RabbitMQ.Tests/RabbitMqQueueCacheCursorTest.cs | Adds cursor behavior tests (retry/refresh/handshake behavior). |
| test/Extensions/RabbitMQ.Tests/RabbitMQ.Tests.csproj | Introduces a new test project for the RabbitMQ provider. |
| src/RabbitMQ/Orleans.Streaming.RabbitMQ/RabbitMQ/RabbitMQStreamSystemProvider.cs | Adds StreamSystem creation with retry + separate producer/consumer stream systems. |
| src/RabbitMQ/Orleans.Streaming.RabbitMQ/RabbitMQ/RabbitMQProducer.cs | Adds RabbitMQ Streams producer wrapper used by the adapter. |
| src/RabbitMQ/Orleans.Streaming.RabbitMQ/RabbitMQ/RabbitMQConsumer.cs | Adds consumer wrapper, queue creation helper, and message metadata constants. |
| src/RabbitMQ/Orleans.Streaming.RabbitMQ/RabbitMQ/RabbitMQConnectionRetryOptions.cs | Adds configurable connection retry settings. |
| src/RabbitMQ/Orleans.Streaming.RabbitMQ/RabbitMQ/RabbitMQClientOptions.cs | Adds provider configuration options (StreamSystemConfig, queue names, etc.). |
| src/RabbitMQ/Orleans.Streaming.RabbitMQ/Properties/AssemblyInfo.cs | Exposes internals to the RabbitMQ test project. |
| src/RabbitMQ/Orleans.Streaming.RabbitMQ/Orleans.Streaming.RabbitMQ.csproj | Introduces the new provider package project and dependency on RabbitMQ.Stream.Client. |
| src/RabbitMQ/Orleans.Streaming.RabbitMQ/Configurators/RabbitMQSiloConfigurator.cs | Adds silo configuration API (AddRabbitMQStreams, cache/partitioning configuration). |
| src/RabbitMQ/Orleans.Streaming.RabbitMQ/Adapters/RabbitMQBatchContainer.cs | Implements an Orleans batch container for serialized RabbitMQ stream messages. |
| src/RabbitMQ/Orleans.Streaming.RabbitMQ/Adapters/RabbitMQAdapterReceiverFactory.cs | Adds receiver factory wiring instrumentation/monitoring. |
| src/RabbitMQ/Orleans.Streaming.RabbitMQ/Adapters/RabbitMQAdapterReceiver.cs | Implements IQueueAdapterReceiver for pulling and offset checkpointing. |
| src/RabbitMQ/Orleans.Streaming.RabbitMQ/Adapters/RabbitMQAdapterFactory.cs | Implements IQueueAdapterFactory with mapper + cache selection. |
| src/RabbitMQ/Orleans.Streaming.RabbitMQ/Adapters/RabbitMQAdapter.cs | Implements IQueueAdapter for producing/receiving. |
| src/RabbitMQ/Orleans.Streaming.RabbitMQ/Adapters/Cache/RabbitMqQueueCacheCursor.cs | Implements custom cursor semantics for cache + retry behavior. |
| src/RabbitMQ/Orleans.Streaming.RabbitMQ/Adapters/Cache/RabbitMqQueueCacheAdapter.cs | Connects cache options to IQueueAdapterCache. |
| src/RabbitMQ/Orleans.Streaming.RabbitMQ/Adapters/Cache/RabbitMqQueueCache.cs | Implements custom in-memory queue cache with purge logic. |
| samples/Streaming/README.md | Updates streaming samples index to include RabbitMQ sample. |
| samples/Streaming/RabbitMQ/README.md | Adds RabbitMQ streaming sample instructions and environment variables. |
| samples/Streaming/RabbitMQ/RabbitMQ.Silo/StreamGrains.cs | Adds producer/consumer grains used by the sample. |
| samples/Streaming/RabbitMQ/RabbitMQ.Silo/RabbitMQ.Silo.csproj | Adds sample silo project referencing the new provider package. |
| samples/Streaming/RabbitMQ/RabbitMQ.Silo/Program.cs | Configures and runs a local silo with RabbitMQ Streams provider. |
| samples/Streaming/RabbitMQ/RabbitMQ.AppHost/RabbitMQ.AppHost.csproj | Adds Aspire AppHost project for orchestrating RabbitMQ + silo. |
| samples/Streaming/RabbitMQ/RabbitMQ.AppHost/Program.cs | Defines RabbitMQ resource and wires env vars into the silo project. |
| samples/Streaming/RabbitMQ/RabbitMQ.AppHost/enabled_plugins | Enables RabbitMQ management + stream plugins for the sample container. |
| samples/Streaming/Directory.Packages.props | Adds sample-scoped package versions (Aspire hosting, MessagePack, provider package). |
| samples/Samples.slnx | Adds RabbitMQ sample projects to the samples solution. |
| samples/README.md | Adds the RabbitMQ Streams sample to the sample catalog table. |
| samples/gallery.json | Adds RabbitMQ Streams sample entry to gallery manifest. |
| Orleans.slnx | Adds the new provider project and test project to the main solution. |
| NuGet.Config | Adds nuget.org package source mapping for RabbitMQ.Stream.Client. |
| docs/site/src/content/docs/toc.yml | Adds RabbitMQ Streams entry to streaming docs TOC. |
| docs/site/src/content/docs/streaming/stream-providers.md | Adds provider matrix entry + configuration section for RabbitMQ Streams. |
| docs/site/src/content/docs/streaming/snippets/rabbitmq/RabbitMQConfiguration.cs | Adds runnable snippet showing silo registration/config. |
| docs/site/src/content/docs/streaming/snippets/rabbitmq/rabbitmq.csproj | Adds snippet project referencing the new provider + Orleans.Server. |
| docs/site/src/content/docs/streaming/rabbitmq-streaming.md | Adds end-user “Stream with RabbitMQ” documentation page. |
| docs/site/src/content/docs/streaming/delivery-semantics.md | Updates rewindable providers list to include RabbitMQ Streams. |
| docs/site/src/content/docs/resources/nuget-packages.md | Adds the RabbitMQ streaming package to the NuGet package list. |
| docs/Docs.slnx | Adds RabbitMQ snippet project to docs solution. |
| Directory.Packages.props | Adds RabbitMQ.Stream.Client version and Aspire.Hosting.RabbitMQ version updates. |
Review details
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
- Files reviewed: 42/42 changed files
- Comments generated: 14
- Review effort level: Lite
652e221 to
b46f024
Compare
|
I am so happy to see that someone had the time to continue working on this <3 |
a113332 to
c09f2c0
Compare
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Remove temporary sample projects and replace Polly with Orleans retry helpers. Keep provider and tests registered in Orleans.slnx. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Document provider configuration and delivery semantics, and add an Aspire-orchestrated RabbitMQ Streams sample. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: f86d5c5c-553b-44e0-98dd-67870e0116fc
Retry failed deliveries within the RabbitMQ cursor and remove unrelated streaming runtime, Event Hubs, and public API changes. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: f86d5c5c-553b-44e0-98dd-67870e0116fc
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
c09f2c0 to
71f1985
Compare
Hello, hello. So, I've been working on a RabbitMQ stream provider implementation and today I think that I have something ready to demonstrate and ask for feedback.
The existing RabbitMQ implementations
I know that we have these 2 RabbitMQ implementations for Orleans:
These are quite old and are not maintained anymore. I did base myself on these libraries of how to write the
IQueueAdapter,IQueueAdapterReceiver, and others on this PR. But the main difference between this implementation and these other 2 libraries is that I'm not using the classic RabbitMQ queues. Instead, it will use the "new" RabbitMQ Streams implementation, so allowing us to use this provider as a Rewindable stream.There are still a few things to do here, and again, this is a WIP but I really wanted some feedback here either to back off or to change something.
Questions I have:
A custom Queue Cache Cursor. I spent some time trying to use
SimpleQueueCachehere like it is being used bySQSandAzureQueuebut no success. I was either loosing messages or getting duplicated messages. I saw this issue regarding theMessagesDeliveredAsyncso I assumed there was no priority to fixSimpleQueueCacheand I was very afraid to play with it for now since it is used by other providers. Let me know what you guys think. I might need help to fix it tho, not sure. One thing is for sure though, this RabbitMqStreamProvider needs theMessagesDeliveredAsyncto be called only when all messages are delivered to all consumers successfully as per documentation.When refreshing a consumer cursor (here), there is a scenario that the current cursor is already running (it is
Active) but it is on the last message. Since the consumer is running on a different thread, the following race condition could happen:lockon theconsumerDatafor now, but I think I could use theInterlocked.Exchangeas well, will try very soon.I tried to find issues with similar problems but couldn't find, so this is prob an issue with just my cursor@benjaminpetit is this related to this issue: EventHub Stream Provider doesn't refresh cursor on new data #7686 (comment) ?Things left to do:
Tests. I never wrote any tests with Orleans (and tbh, this is my first time ever playing with Orleans) so I will be taking a look at how you guys did the tests for the EventHub provider. This is my priority for now, since I had such a bad time writing the
RabbitMqQueueCacheCursorbecause it was hard to fix something, like making sure messages don't get duplicated without breaking something elseComments, a lot of comments. I tried to focus a bit on commenting on some stuff but at some point, I was just interested in solving issues regarding the implementation. There is still a lot to comment and a lot to refactor as well.
Make
RabbitMqQueueCacheCursorconsumer independent, so that every consumer can process messages at it is own pace.Consume previous failed messages that are too old. If I have a message that failed and no more messages are published to that same stream in a while, that message won't be retried (except for the times the pulling agent already did it) at all. For now, the pulling agent will only retry to process this failed message once a new message for that same stream arrives, making the consumer active again. I don't really know how, or if, other stream providers handle this but I'm gonna take a look.
rabbitmq-stream-dotnet-client has almost no
.ConfigureAwait(false). I was facing a lot of deadlocks because of that, since they also do.Resultor.GetAwaiter().GetResult()internally. I'll also open PR's there to fix this. I don't think we could ship this provider without these changes tho. See: Remove `.Result` inside `Client.MaybeClose` method rabbitmq/rabbitmq-stream-dotnet-client#222Microsoft Reviewers: Open in CodeFlow