Particular / NServiceBus

Build, version, and monitor better microservices with the most powerful service platform for .NET
https://particular.net/nservicebus/
Other
2.08k stars 648 forks source link

Document the Learning Transport #7104

Closed dannyyy closed 1 month ago

dannyyy commented 2 months ago

Describe the suggested improvement

Is your improvement related to a problem? Please describe.

Currently, the learning transport behaves like a black box. The documentation just mentions the obvious. There are four folders s with the name .bodies, .committed, ... I guess every developer which is able to use a file manager comes to the same conclusion.

For a commercially provided product, I expect another level of documentation.

Describe the suggested solution

Please explain, how the messages within the folders have to look like. How to manually produce new events for testing purposes, ...

Describe alternatives you've considered

Provide examples in your documentation or GitHub repository

Additional Context

No response

tmasternak commented 2 months ago

Hi @dannyyy,

Thank you for your feedback! I assume that what you mean by:

How to manually produce new events

refers to a scenario in which you want to write a piece of C# code (or use any other language) without any reference to NServiceBus that produces a message that can be consumed by an NServiceBus endpoint. In NServiceBus documentation this is referred to as "native integration" (e.g. RabbitMQ native integration) and is documented for all transports that are supported in production.

As mentioned in the documentation the Learning Transport (as well as the Learning Persistence) is not meant for production use and as a result, the documentation does not cover the native integration scenario.

Could you share more details on your testing approach and why it requires you to follow the native integration path?

tmasternak commented 1 month ago

Hi @dannyyy, I'll close this issue for now.