feat: share registries across transport integrations - #149
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (5)
🚧 Files skipped from review as they are similar to previous changes (5)
📜 Recent review details⏰ Context from checks skipped due to timeout. (7)
|
| Layer / File(s) | Summary |
|---|---|
Registry resolution and validation interlock/integrations/_registry.py, tests/test_integration_registry.py |
Shared helpers reject conflicting options and return the effective registry with its ownership state. |
Integration registry ownership interlock/integrations/aiohttp.py, interlock/integrations/httpx.py, interlock/integrations/httpx2.py, interlock/integrations/requests.py |
All integrations accept registry=, share breaker state, and close registries only when they created them. |
Integration behavior coverage tests/test_aiohttp.py, tests/test_httpx.py, tests/test_httpx2.py, tests/test_requests.py |
Tests cover shared breakers, option conflicts, registry preservation, and wrapped transport cleanup. |
Integration usage documentation docs/integrations/*, docs/llms-full.txt, CHANGELOG.md |
Documentation describes registry sharing, classifier configuration, option conflicts, and shutdown ownership. |
Estimated code review effort: 3 (Moderate) | ~20 minutes
Suggested labels: enhancement
Sequence Diagram(s)
sequenceDiagram
participant ClientA
participant CircuitBreakerTransport
participant Registry
participant ClientB
ClientA->>CircuitBreakerTransport: send request
CircuitBreakerTransport->>Registry: resolve host breaker
ClientB->>Registry: resolve same host breaker
ClientA->>CircuitBreakerTransport: close wrapped transport
CircuitBreakerTransport-->>Registry: leave caller-owned registry open
🚥 Pre-merge checks | ✅ 9
✅ Passed checks (9 passed)
| Check name | Status | Explanation |
|---|---|---|
| Description Check | ✅ Passed | Check skipped - CodeRabbit’s high-level summary is enabled. |
| Title check | ✅ Passed | The title uses the required Conventional Commits format and accurately describes the registry-sharing feature. |
| Linked Issues check | ✅ Passed | The changes implement caller-supplied registries, conflict validation, ownership-aware shutdown, documentation, changelog updates, and integration coverage for issue #135. |
| Out of Scope Changes check | ✅ Passed | The code, tests, documentation, changelog, and generated reference updates directly support the linked issue objectives. |
| Zero-Dependency Core | ✅ Passed | The feature commit changes only interlock/integrations; pyproject.toml keeps dependencies=[]; interlock/init.py has no interlock.integrations re-export. |
| Changelog Entry | ✅ Passed | CHANGELOG.md contains a bullet under ## [Unreleased] describing shared caller-owned Registry support, registry= validation, ownership, and connection-pool teardown. |
| Docs And Llm Mirror | ✅ Passed | The PR adds public registry= integration options; all four relevant integration pages and docs/llms-full.txt are updated, with mirrored sections matching exactly. No new docs page was added. |
| Tests Accompany Behaviour Change | ✅ Passed | The PR changes five interlock Python implementation files and also changes five tests files, including added shared-registry, conflict, and teardown tests. |
| Public Api Surface | ✅ Passed | The feature-range diff changes neither guarded file; root and pipeline all sets match the base, and re-exported EventListener method signatures are unchanged. |
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
- Create stacked PR
- Commit on current branch
🧪 Generate unit tests (beta)
- Create PR with unit tests
- Commit unit tests in branch
feat/135-shared-registry-integrations
Comment @coderabbitai help to get the list of available commands.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/integrations/httpx.md`:
- Around line 121-124: Update the cleanup guidance in docs/integrations/httpx.md
lines 121-124, docs/integrations/httpx2.md lines 126-129,
docs/integrations/aiohttp.md lines 78-80, and docs/integrations/requests.md
lines 80-82 to state that automatic breaker cleanup occurs only when the
integration owns the registry; injected registries remain open until the
application explicitly calls the appropriate asynchronous or synchronous
shutdown method.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: a32197e2-df05-4418-8870-93c71f69d204
📒 Files selected for processing (16)
CHANGELOG.mddocs/integrations/aiohttp.mddocs/integrations/httpx.mddocs/integrations/httpx2.mddocs/integrations/requests.mddocs/llms-full.txtinterlock/integrations/_registry.pyinterlock/integrations/aiohttp.pyinterlock/integrations/httpx.pyinterlock/integrations/httpx2.pyinterlock/integrations/requests.pytests/test_aiohttp.pytests/test_httpx.pytests/test_httpx2.pytests/test_integration_registry.pytests/test_requests.py
📜 Review details
⏰ Context from checks skipped due to timeout. (1)
- GitHub Check: quality (3.14t)
⚠️ CI failures not shown inline (2)
GitHub Actions: Code scanning AI findings on PR #149 / github-advanced-security: Code scanning AI findings on PR #149
Conclusion: failure
##[group]Run set -euo pipefail
�[36;1mset -euo pipefail�[0m
�[36;1mecho "RUNNER_TEMP=$RUNNER_TEMP"�[0m
�[36;1mfind "$RUNNER_TEMP" -maxdepth 1 -type f -name 'git-credentials-*.config' -print -delete�[0m
�[36;1m�[0m
�[36;1m# Generate a unique token and stop processing workflow commands to prevent the runtime from injecting commands�[0m
�[36;1mSTOP_***REDACTED_SECRET_ASSIGNMENT*** /proc/sys/kernel/random/uuid)�[0m
�[36;1m�[0m
�[36;1m# Use a trap to ensure we always resume command processing and check for�[0m
�[36;1m# fallback error annotations, even if the runtime exits with a non-zero code�[0m
�[36;1m# (which would otherwise cause set -e to abort the shell before we get here).�[0m
�[36;1m# The trap preserves the original exit code.�[0m
�[36;1mcopilot_cleanup() {�[0m
�[36;1m �[0m
�[36;1m if [ -n "${GIT_PROXY_PID:-}" ] && kill -0 "$GIT_PROXY_PID" 2>/dev/null; then�[0m
�[36;1m echo "Stopping git-proxy (pid=$GIT_PROXY_PID)..."�[0m
�[36;1m kill "$GIT_PROXY_PID" 2>/dev/null || true�[0m
�[36;1m for _ in {1..25}; do�[0m
�[36;1m if ! kill -0 "$GIT_PROXY_PID" 2>/dev/null; then break; fi�[0m
�[36;1m sleep 0.2�[0m
�[36;1m done�[0m
�[36;1m if kill -0 "$GIT_PROXY_PID" 2>/dev/null; then�[0m
�[36;1m echo "git-proxy did not stop gracefully; forcing termination."�[0m
�[36;1m kill -KILL "$GIT_PROXY_PID" 2>/dev/null || true�[0m
�[36;1m fi�[0m
�[36;1m wait "$GIT_PROXY_PID" 2>/dev/null || true�[0m
�[36;1m fi�[0m
�[36;1m �[0m
�[36;1m echo "::$STOP_***REDACTED_SECRET_ASSIGNMENT***
�[36;1m FALLBACK_FILE="${RUNNER_TEMP}/copilot-fallback-error.txt"�[0m
�[36;1m if [ -f "$FALLBACK_FILE" ]; then�[0m
�[36;1m FALLBACK_MSG=$(head -c 500 "$FALLBACK_FILE" | tr -d '\n\r')�[0m
�[36;1m echo "::error title=Copilot Error::${FALLBACK_MSG}"�[0m
GitHub Actions: Code scanning AI findings on PR #149 / 0_github-advanced-security.txt: Code scanning AI findings on PR #149
Conclusion: failure
##[group]Run set -euo pipefail
�[36;1mset -euo pipefail�[0m
�[36;1mecho "RUNNER_TEMP=$RUNNER_TEMP"�[0m
�[36;1mfind "$RUNNER_TEMP" -maxdepth 1 -type f -name 'git-credentials-*.config' -print -delete�[0m
�[36;1m�[0m
�[36;1m# Generate a unique token and stop processing workflow commands to prevent the runtime from injecting commands�[0m
�[36;1mSTOP_***REDACTED_SECRET_ASSIGNMENT*** /proc/sys/kernel/random/uuid)�[0m
�[36;1m�[0m
�[36;1m# Use a trap to ensure we always resume command processing and check for�[0m
�[36;1m# fallback error annotations, even if the runtime exits with a non-zero code�[0m
�[36;1m# (which would otherwise cause set -e to abort the shell before we get here).�[0m
�[36;1m# The trap preserves the original exit code.�[0m
�[36;1mcopilot_cleanup() {�[0m
�[36;1m �[0m
�[36;1m if [ -n "${GIT_PROXY_PID:-}" ] && kill -0 "$GIT_PROXY_PID" 2>/dev/null; then�[0m
�[36;1m echo "Stopping git-proxy (pid=$GIT_PROXY_PID)..."�[0m
�[36;1m kill "$GIT_PROXY_PID" 2>/dev/null || true�[0m
�[36;1m for _ in {1..25}; do�[0m
�[36;1m if ! kill -0 "$GIT_PROXY_PID" 2>/dev/null; then break; fi�[0m
�[36;1m sleep 0.2�[0m
�[36;1m done�[0m
�[36;1m if kill -0 "$GIT_PROXY_PID" 2>/dev/null; then�[0m
�[36;1m echo "git-proxy did not stop gracefully; forcing termination."�[0m
�[36;1m kill -KILL "$GIT_PROXY_PID" 2>/dev/null || true�[0m
�[36;1m fi�[0m
�[36;1m wait "$GIT_PROXY_PID" 2>/dev/null || true�[0m
�[36;1m fi�[0m
�[36;1m �[0m
�[36;1m echo "::$STOP_***REDACTED_SECRET_ASSIGNMENT***
�[36;1m FALLBACK_FILE="${RUNNER_TEMP}/copilot-fallback-error.txt"�[0m
�[36;1m if [ -f "$FALLBACK_FILE" ]; then�[0m
�[36;1m FALLBACK_MSG=$(head -c 500 "$FALLBACK_FILE" | tr -d '\n\r')�[0m
�[36;1m echo "::error title=Copilot Error::${FALLBACK_MSG}"�[0m
🧰 Additional context used
📓 Path-based instructions (10)
**/*.md
📄 CodeRabbit inference engine (AGENTS.md)
Document user-facing changes in English Markdown documentation and keep generated documentation mirrors synchronized.
Files:
docs/integrations/aiohttp.mdCHANGELOG.mddocs/integrations/httpx.mddocs/integrations/requests.mddocs/integrations/httpx2.md
{interlock/**/*.py,docs/**/*.md,docs/llms-full.txt,docs/llms.txt}
📄 CodeRabbit inference engine (Custom checks)
When a change affects user-facing behaviour through the public API, integrations, or configuration options, update the relevant page under
docs/and regeneratedocs/llms-full.txt; when adding a new documentation page, list it under## Docsindocs/llms.txt.
Files:
docs/integrations/aiohttp.mddocs/integrations/httpx.mdinterlock/integrations/_registry.pydocs/integrations/requests.mddocs/integrations/httpx2.mdinterlock/integrations/requests.pydocs/llms-full.txtinterlock/integrations/aiohttp.pyinterlock/integrations/httpx2.pyinterlock/integrations/httpx.py
docs/**/*.{md,mdx}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
User-facing changes must update the relevant documentation page under
docs/.
Files:
docs/integrations/aiohttp.mddocs/integrations/httpx.mddocs/integrations/requests.mddocs/integrations/httpx2.md
docs/**/*.md
⚙️ CodeRabbit configuration file
User-facing documentation. Check that code samples match the current public API and would actually run. A new page must also be listed in docs/llms.txt under
## Docs. Keep the existing voice: short sentences, no marketing.
Files:
docs/integrations/aiohttp.mddocs/integrations/httpx.mddocs/integrations/requests.mddocs/integrations/httpx2.md
CHANGELOG.md
📄 CodeRabbit inference engine (AGENTS.md)
Add every change to the
[Unreleased]section underAdded,Fixed, orChanged, explaining user impact rather than only symbol movement.User-facing changes must update the
[Unreleased]section.
Files:
CHANGELOG.md
⚙️ CodeRabbit configuration file
Keep a Changelog format. New entries go under
## [Unreleased]in Added / Fixed / Changed. An entry describes what a user could not do before and can now, not which symbol moved. Only the release commit dates a section and updates the link references.
Files:
CHANGELOG.md
**/*.py
📄 CodeRabbit inference engine (AGENTS.md)
**/*.py: Support Python 3.11 and newer; use Python 3.11+ features where required.
Keep the core zero-dependency and use only the standard library; external dependencies must be isolated behind optional integrations.
Use injectedClockinstances for all time access; do not calltime.monotonic()orsleep()directly in logic.
Implement the core as an I/O-free state machine with a singlethreading.Lockaround the await-free critical section, never held across the protected call.
UseProtocols for extension points:Clock,SlidingWindow,Storage,FailureClassifier, andEventListener; do not inherit from internal classes.
Expose one publicCircuitBreakerclass for sync and async operation, with separate internal paths selected by coroutine detection.
Expose the public API through the package__init__.py; keep helpers underscore-prefixed and hidden.
Use absolute imports, placed at the top of the file, ordered as standard library, third-party, then local imports with blank lines between groups.
Use a maximum line length of 100 characters, single-quoted strings, f-strings, andpathlib.Pathinstead ofos.path.
Annotate every parameter and return value; use modern generic syntax andX | Noneinstead ofOptional[X].
UseStrEnumor module-level constants instead of magic constants.
When a constructor or function has three or more arguments, pass them by keyword.
Keep functions focused on one job, generally no longer than 20–30 lines, with minimal side effects and extracted repeated loop logic.
Useasync/awaitfor I/O-bound work,asyncio.TaskGroupinstead ofasyncio.gather, andasyncio.to_threadorProcessPoolExecutorfor CPU-bound work.
Do not mix sync and async in one function; never await a sync callable or block on an async callable.
Fail fast on invalid input or state by raising immediately; do not continue with partial results or invented defaults.
Catch only expected exceptions, log them with context, and re-raise; do not use ...
Files:
interlock/integrations/_registry.pytests/test_httpx.pytests/test_requests.pytests/test_aiohttp.pyinterlock/integrations/requests.pytests/test_httpx2.pytests/test_integration_registry.pyinterlock/integrations/aiohttp.pyinterlock/integrations/httpx2.pyinterlock/integrations/httpx.py
interlock/**/*.py
📄 CodeRabbit inference engine (Custom checks)
Every production behaviour change in
interlock/must be accompanied by a change undertests/; changes limited to docstrings, comments, or type annotations are exempt. Bug fixes must include at least one regression test that fails without the production fix.Keep the core dependency-free; external dependencies must belong to extras and be imported lazily.
Files:
interlock/integrations/_registry.pyinterlock/integrations/requests.pyinterlock/integrations/aiohttp.pyinterlock/integrations/httpx2.pyinterlock/integrations/httpx.py
⚙️ CodeRabbit configuration file
Core rules (AGENTS.md is authoritative): (1) Zero-dependency core — anything under interlock/ except interlock/integrations/ may import stdlib only. Flag every third-party import as a blocking issue. (2) No fallbacks, no silent excepts, no
a or b or cfor required config or data, no hidden retries. Invalid input or state raises immediately. interlock/_notify.py is the one sanctioned swallow (listener hooks are observability, logged with traceback, BaseException still propagates) — do not suggest generalising or "fixing" it. (3) Time comes only from the injected Clock protocol; direct time.monotonic()/time.sleep() in library logic is a bug. (4) Style: 100-char lines, single quotes, f-strings, pathlib, full annotations,X | NoneneverOptional[X], keyword arguments for calls with 3+ arguments, no magic constants (StrEnum or module constants), functions under ~30 lines. (5) Extension points are Protocols (Clock, SlidingWindow, Storage, FailureClassifier, EventListener) — do not propose inheriting internal classes. (6) Sync and async live in one CircuitBreaker with separate internal paths; never propose Sync*/Async* twins and never mix the two paths in one function. (7) Public API is exported from interlock/init.py; everything else is underscore-prefixed. New public symbols need__all__and a docstring. (8) Python 3.11 is the floor — no 3.12+ syntax or stdlib.
Files:
interlock/integrations/_registry.pyinterlock/integrations/requests.pyinterlock/integrations/aiohttp.pyinterlock/integrations/httpx2.pyinterlock/integrations/httpx.py
interlock/integrations/**/*.py
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Integration dependencies must be optional extras and imported lazily.
Files:
interlock/integrations/_registry.pyinterlock/integrations/requests.pyinterlock/integrations/aiohttp.pyinterlock/integrations/httpx2.pyinterlock/integrations/httpx.py
⚙️ CodeRabbit configuration file
Optional extras. The third-party import must stay inside this package, must never be re-exported from interlock/init.py, and a missing extra must fail with a clear install hint rather than a fallback. Wrap the dependency behind the project's own types so its objects do not leak into core signatures. Check that the extra is declared in pyproject.toml
[project.optional-dependencies]and documented under docs/integrations/.
Files:
interlock/integrations/_registry.pyinterlock/integrations/requests.pyinterlock/integrations/aiohttp.pyinterlock/integrations/httpx2.pyinterlock/integrations/httpx.py
tests/**/*.py
📄 CodeRabbit inference engine (AGENTS.md)
tests/**/*.py: Use pytest functions rather than test classes, with names formatted astest__unit_of_work__state_under_test__expected_behavior.
Mirror package layout in test filenames, use Arrange-Act-Assert, and create fixtures for repeated setup.
Use injectedClockinstances for deterministic tests; do not usesleep()in tests.
Usepytest-asyncioand@pytest.mark.asynciofor asynchronous tests, and usepytest-mockto isolate external dependencies.
Use Hypothesis property-based tests for the state machine and cover all transitions and races.
Write the reproducing test before a bug fix and specify the required behavior before implementing a feature.Tests must preserve 100% coverage, avoid
sleepfor time-dependent behavior, and use injected clocks instead.
Files:
tests/test_httpx.pytests/test_requests.pytests/test_aiohttp.pytests/test_httpx2.pytests/test_integration_registry.py
⚙️ CodeRabbit configuration file
pytest functions only, never test classes. Names follow
test__unit_of_work__state_under_test__expected_behaviorin lower case. One behaviour per test, Arrange-Act-Assert. Time is the injected fake Clock — any real sleep or wall-clock read is flakiness, flag it. Async tests use@pytest.mark.asyncio; state-machine work carries hypothesis property tests. Coverage must stay at 100%: point out uncovered branches the diff introduces. Tests run under-n auto, so anything relying on ordering or shared global state is a bug.
Files:
tests/test_httpx.pytests/test_requests.pytests/test_aiohttp.pytests/test_httpx2.pytests/test_integration_registry.py
docs/llms-full.txt
⚙️ CodeRabbit configuration file
Generated artefact — produced by
uv run python scripts/build_llms_full.py. Do not review its content or suggest edits; only confirm it was regenerated together with the docs/ changes in the same PR.
Files:
docs/llms-full.txt
🔇 Additional comments (2)
docs/llms-full.txt (1)
2780-2815: LGTM!Also applies to: 2939-2975, 3075-3102, 3207-3239
CHANGELOG.md (1)
19-26: LGTM!
## Summary Prepare the `2.5.0` minor release. - Bump the package version from `2.4.0` to `2.5.0`. - Move the current `[Unreleased]` changelog entries into `[2.5.0] - 2026-08-08`. - Update changelog comparison links and the comparison-page release version. - Regenerate `docs/llms-full.txt`. Minor, not patch: the release includes backward-compatible public additions: configurable transport breaker names, shared caller-owned registries, and narrower listener protocols. ## Checklist - [x] Tests added or updated (suite stays at 100% coverage) - [x] `uv run ruff format --check` and `uv run ruff check` pass - [x] `uv run mypy`, `uv run pyright` and `uv run pyrefly check` pass - [x] Docs updated (`docs/`) for user-facing changes - [x] `CHANGELOG.md` `[Unreleased]` updated - [x] Commits follow Conventional Commits Additional release checks: package and strict documentation builds pass. Griffe reports only the expected public `VERSION` change (`2.4.0` → `2.5.0`). ## Related issues Closes #148 Closes #149 Closes #150 Closes #151 Closes #152
1 participant
Summary
Registryregistryis combined with integration-owned configuration, while preserving existing public defaultsChecklist
uv run ruff format --checkanduv run ruff checkpassuv run mypy,uv run pyrightanduv run pyrefly checkpassdocs/) for user-facing changesCHANGELOG.md[Unreleased]updatedRelated issues
Closes #135
Added
registry=toCircuitBreakerTransportandAsyncCircuitBreakerTransportin thehttpxandhttpx2integrations.registry=toCircuitBreakerMiddlewarein theaiohttpintegration.registry=toCircuitBreakerAdapterin therequestsintegration.resolve_registryandreject_registry_optionsintegration utilities.Fixed
Registryinstances.registrywith conflicting builder options.Changed
aiohttp,httpx,httpx2, andrequestsextras.