docs: Issue 168 fix doc discrepancy

[andrewwormald]

Fixes issue mentioned in #168

[coderabbitai]

Walkthrough

The changes comprehensively refactor the event streaming API across documentation files. The EventStreamer interface methods have been reorganised, replacing NewProducer and NewConsumer with context-aware NewSender and NewReceiver methods that accept topic and optional configuration parameters. The Producer interface has been renamed to EventSender with a revised Send method signature, whilst Consumer has been renamed to EventReceiver with a new Recv method replacing the previous Consume implementation. Concrete implementations (MyProducer and MyConsumer) have been correspondingly renamed to MySender and MyReceiver with updated field structures and method implementations.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~22 minutes

Poem

🐰 From Produce to Send, from Consume to Recv,
The interfaces evolve with a purpose we perceive,
With NewSender and NewReceiver in context we trust,
The event streams flow cleaner—a modernised gust! ✨
No more callbacks pushing—now explicit and clear,
The rabbit's refactoring brings API cheer! 🌾

Pre-merge checks

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'docs: Issue 168 fix doc discrepancy' clearly identifies that this PR fixes documentation inconsistencies related to issue 168, which aligns with the changeset updating architecture and adapter documentation.
Description check	✅ Passed	The description references issue 168, which is directly related to the documentation changes in the PR that address API interface discrepancies between EventStreamer, Producer/EventSender, and Consumer/EventReceiver interfaces.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

---

📜 Recent review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 27e7b2e and a6a4eac.

📒 Files selected for processing (2)

• docs/adapters.md
• docs/architecture.md

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Integration Tests (Testcontainers)

🔇 Additional comments (3)

docs/architecture.md (1)

189-206: Interface definitions are clear and correctly refactored.

The EventStreamer API changes from push/pull (Producer/Consumer) to neutral sender/receiver semantics are well-documented. Interface signatures and method parameters align with the issue 168 objectives.

docs/adapters.md (2)

24-44: Interface definitions match architecture.md and are correctly updated.

The EventStreamer, EventSender, and EventReceiver interfaces are consistently refactored across both documentation files. The terminology shift from Producer/Consumer to EventSender/EventReceiver aligns with issue 168 objectives.

---

284-340: Custom adapter implementation correctly demonstrates the refactored API.

The MyEventStreamer implementation properly illustrates the new sender/receiver pattern:

• NewSender and NewReceiver methods correctly accept context and topic parameters
• Topic is stored on MySender and MyReceiver instances and used consistently
• Send and Recv methods properly delegate to underlying client methods
• Ack function is correctly defined as a closure

The example is idiomatic Go and demonstrates best practices for adapter implementation.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud