Repository navigation
docs: align microservices-messaging README with actual Kafka-based implementation - #3625
1wu-davy-2 wants to merge 1 commit into
Conversation
PR SummaryUpdates the README to reflect the Kafka-based messaging implementation. Replaces the in-memory MessageBroker with Kafka-based producer/consumer concepts, shows KafkaMessageProducer, OrderService using the producer for order-topic, and App wiring KafkaMessageConsumer instances. Adjusts the console output to reflect the Kafka flow and removes references to MessageBroker. Changes
autogenerated by presubmit.ai |
There was a problem hiding this comment.
✅ LGTM!
Review Summary
Commits Considered (1)
- 8df5f64: docs: align microservices-messaging README with actual Kafka-based implementation
Files Processed (1)
- microservices-messaging/README.md (3 hunks)
Actionable Comments (0)
Skipped Comments (4)
-
microservices-messaging/README.md [74-87]
best_practice: "KafkaMessageProducer snippet lacks self-contained initialization and resource management."
-
microservices-messaging/README.md [93-109]
enhancement: "Clarify Kafka-based wiring in OrderService."
-
microservices-messaging/README.md [140-168]
readability: "Document App wiring and lifecycle behavior."
-
microservices-messaging/README.md [173-189]
readability: "Document console output expectations and IDs."
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #3625 +/- ##
============================================
- Coverage 84.06% 84.01% -0.05%
+ Complexity 4353 4350 -3
============================================
Files 1133 1133
Lines 15400 15400
Branches 739 739
============================================
- Hits 12946 12939 -7
- Misses 2158 2162 +4
- Partials 296 299 +3 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Description
The "Programmatic Example" section documented an in-memory
MessageBrokerclass withsubscribe/publishmethods, anOrderService(MessageBroker)constructor and a matching console output block. None of that exists in the module.The actual implementation uses Apache Kafka:
MessageBrokerclass.KafkaMessageProducerwraps a KafkaProducer, serializes eachMessageto JSON and publishes it to a topic.OrderServicetakes aKafkaMessageProducerin its constructor and publishes to theorder-topicconstant.Appconnects tolocalhost:9092, creates threeKafkaMessageConsumers (inventory-group,payment-group,notification-group) onorder-topic, and runs them in a thread pool.The "How to Run" section was left unchanged: it already describes the Docker Compose / helper-script Kafka setup correctly.
Checklist
microservices-messaging/README.md)App.java,OrderService.java,KafkaMessageProducer.javaand the three consumer servicesMessageBrokerAssisted by AI tools for initial analysis; all changes manually verified and tested.