Conversation
…to reduce-saga-storage-overhead
|
Warning Rate limit exceeded
⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📝 WalkthroughWalkthroughThe pull request updates the README.md file with comprehensive documentation improvements, including revised installation instructions, new Table of Contents entries, updated repository references from legacy paths to python-cqrs paths, and expanded sections covering Bootstrap, Saga Pattern, Protobuf messaging, and various integrations. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
# Conflicts: # README.md
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #63 +/- ##
=======================================
Coverage 87.67% 87.67%
=======================================
Files 70 70
Lines 2636 2636
=======================================
Hits 2311 2311
Misses 325 325 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Merging this PR will not alter performance
Comparing Footnotes
|
There was a problem hiding this comment.
Actionable comments posted: 4
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
README.md (1)
432-469:⚠️ Potential issue | 🟡 MinorAdd missing imports to the bootstrap code snippet in README.md.
The code at lines 432-469 uses
saga_bootstrapandMemorySagaStoragewithout importing them, which would raise aNameErrorif users copy the snippet verbatim.Proposed fix
from cqrs.events import bootstrap as event_bootstrap from cqrs.requests import bootstrap as request_bootstrap +from cqrs.saga import bootstrap as saga_bootstrap +from cqrs.saga.storage.memory import MemorySagaStorage from app import dependencies, mapping, orm🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` around lines 432 - 469, The README bootstrap snippet is missing imports for saga_bootstrap and MemorySagaStorage which causes NameError when copying; add the missing import statements at the top of the snippet to import saga_bootstrap and MemorySagaStorage from the CQRS saga module used in the project (so the saga_mediator_factory() call can resolve saga_bootstrap and MemorySagaStorage), keeping the existing imports for event_bootstrap/request_bootstrap and referencing the existing factory functions (mediator_factory, event_mediator_factory, saga_mediator_factory) to validate the snippet compiles.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Around line 920-975: Delete the stale duplicate sections titled "## Mapping"
and "## Bootstrap" that were accidentally copied into the README (the block that
contains the incorrect symbol events_models); remove that entire duplicate block
so only the original, complete Mapping and Bootstrap sections (which include
CoR/Streaming/Saga mapping and saga_mediator_factory) remain, and ensure there
are no remaining references to events_models in the file (use event_models where
needed).
- Line 842: Update the three stale links that point to the old "vadikko2/cqrs"
repo: find occurrences of the URL fragment "vadikko2/cqrs" (e.g., the link
"https://github.com/vadikko2/cqrs/blob/master/examples/kafka_outboxed_event_producing.py"
and the two other matches noted) and replace them with the current repo path
used elsewhere in the README (the same base GitHub owner/name and blob/path used
by the other working links in this file) so all references are consistent;
ensure the example file paths (like kafka_outboxed_event_producing.py) remain
correct after replacement.
- Around line 45-65: Add a missing Table of Contents entry for the existing "##
Transaction log tailing" section by inserting a new bullet "- [Transaction log
tailing](`#transaction-log-tailing`)" immediately after the "- [Producing Events
from Outbox to Kafka](`#producing-events-from-outbox-to-kafka`)" line so the TOC
includes the Transaction log tailing section and the anchor matches the section
header.
- Around line 109-132: Update the Quick Start example to avoid top-level await
by moving the call to mediator.send into an async function (e.g., async def
main()) and then execute it with asyncio.run(main()); specifically, create an
async def main() that calls await mediator.send(...) (using the existing
mediator returned from bootstrap.bootstrap) and add a final line that invokes
asyncio.run(main()) so the snippet runs as a standalone script.
---
Outside diff comments:
In `@README.md`:
- Around line 432-469: The README bootstrap snippet is missing imports for
saga_bootstrap and MemorySagaStorage which causes NameError when copying; add
the missing import statements at the top of the snippet to import saga_bootstrap
and MemorySagaStorage from the CQRS saga module used in the project (so the
saga_mediator_factory() call can resolve saga_bootstrap and MemorySagaStorage),
keeping the existing imports for event_bootstrap/request_bootstrap and
referencing the existing factory functions (mediator_factory,
event_mediator_factory, saga_mediator_factory) to validate the snippet compiles.
Summary by CodeRabbit