[allenflux]

Exhausting a job event iterator at a terminal frame, or explicitly closing it, does not currently close the low-level SSE generator it owns. That generator holds the HTTP response context across yields, so resource release can depend on generator finalization.

Close each owned stream with closing / aclosing inside the existing per-connection error handling. Preserve polling fallback and reconnection behavior, and accurately annotate the low-level generator return types. This covers terminal exhaustion and explicit iterator closure; it does not promise automatic cleanup for an arbitrary bare break while the caller retains the iterator.

Validation on Python 3.12.11 / macOS arm64:

• Four resource regressions fail on unchanged main, while seven controls pass with identical final tests. All eleven pass with the fix.
• Tests retain the real low-level generator and observe the real HTTP response context using the existing local API stub; no httpx mocks.
• Full suite: 1270 passed, 9 environment-gated gateway tests skipped. Ruff, formatting and mypy src pass. The public-repo hygiene check passes with the new test tracked.
• Independent automated verification reproduces the four failures, passes the fixed eleven cases and five additional read-idle/reconnect controls.

No live gateway or GPU was used. The cancellation case is a general control, not proof of cancellation during an active SSE read.

Summary by CodeRabbit

• Bug Fixes
  • Event streams now close their underlying HTTP connections when iteration finishes, reaches a terminal status, or is closed early. This applies to both synchronous and asynchronous clients.

[coderabbitai]

No actionable comments were generated in the recent review.

Recent review info

Run configuration

• Source mode: Auto
• Repository: Comfy-Org/comfy-python-sdk
• Branch: main
• File: .coderabbit.yaml
• Commit: 8185f0e
• Layers: Repository YAML
• Review profile: ASSERTIVE
• Plan: Advanced
• Run ID: e0d49740-0dd6-4e64-8beb-f3f65903f55c

Commits

Reviewing files that changed from the base of the PR and between 8185f0e and 2c75eca.

Files selected for processing: 4

• CHANGELOG.md
• src/comfy_low/transport.py
• src/comfy_sdk/jobs.py
• tests/test_event_stream_cleanup.py

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

Walkthrough

Synchronous and asynchronous job event iteration now closes the underlying HTTP stream when iteration completes or exits early. The changelog records this change, and tests cover terminal events, explicit closure, and asynchronous cancellation.

Changes: Job event stream cleanup

Layer / File(s)	Summary
Close job event streams on exit src/comfy_low/transport.py, src/comfy_sdk/jobs.py, tests/test_event_stream_cleanup.py, CHANGELOG.md	The low-level event methods declare generator return types. The synchronous and asynchronous Job.events methods close their iterators when iteration exits. Tests cover terminal completion, explicit closure, and asynchronous cancellation. The changelog records the cleanup behavior.

Priority: Normal

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Bug fix

Suggested reviewers: wei-hai, mattmillerai

Merge Risk: Minimal · up to 2c75e

No actionable issue remains in the supplied evidence; the change is mergeable after normal checks.

Pre-merge checks: 4 · 1

Failed checks: 1 warning

Check name	Status	Explanation	Resolution
Docstring Coverage		Docstring coverage is 36.36% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 11 functions across 3 files. (1 skipped: …	Write docstrings for the functions missing them to satisfy the coverage threshold.

Passed checks: 4 passed

Check name	Status	Explanation
Description Check		Check skipped - CodeRabbit’s high-level summary is enabled.
Title check		The title clearly and concisely identifies the main change: closing owned job event streams.
Linked Issues check		Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check		Check skipped because no linked issues were found for this pull request.

Full details: Docstring Coverage

Explanation

Docstring coverage is 36.36% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 11 functions across 3 files. (1 skipped: 1 unsupported.)

Resolution

Write docstrings for the functions missing them to satisfy the coverage threshold.

Finishing Touches

🧪 Generate unit tests (beta)

• Create a new PR

• Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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