fix(pools): release the reserved slot when connection creation fails - #93
Merged
Conversation
loks0n
requested review from
ArnabChatterjee20k,
abnegate and
eldadfux
as code owners
July 27, 2026 15:03
Contributor
Greptile SummaryUpdates pool acquisition cleanup so failed connection creation always releases reserved capacity.
Confidence Score: 5/5The PR appears safe to merge. No blocking failure remains. Important Files Changed
Reviews (2): Last reviewed commit: "fix(pools): release the reserved slot wh..." | Re-trigger Greptile |
pop() reserves capacity by incrementing connectionsCreated before the connection exists, then releases it in a catch. The catch was scoped to \Exception, so anything else escaping createConnection() kept the slot. The init callback is caller supplied, so an Error is entirely reachable: a TypeError from the callback, or a failure inside an adapter. Each leaked slot is permanent for the life of the process, and they accumulate one failed pop at a time. Once connectionsCreated reaches size the pool refuses to create anything and reports itself empty while nothing is actually in use — "Pool 'x' is empty (size 24, active 0, idle 0)". Only a restart recovers it, which is why an upstream outage that should degrade into slow acquisition instead ratchets a process into permanent failure that outlives the outage. Catch \Throwable, and move the release into a finally guarded by a $reserved flag so the reservation is balanced on every path out of the block, not only the ones enumerated in a catch. destroyConnection() already used \Throwable for the same reason a few lines below. The added test drains a size-2 pool with five pops against an init callback that throws a TypeError. Before this change count() drops to 0 with nothing handed out; after it stays at 2. Reported previously as utopia-php/pools#34, which was auto-closed because that repository is a read-only mirror. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
loks0n
force-pushed
the
fix/pool-slot-leak-on-throwable
branch
from
July 27, 2026 15:06
53bd265 to
ed81f9b
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The bug
Pool::pop()reserves capacity by incrementingconnectionsCreatedbefore the connection exists, then releases it in acatch:The
initcallback is caller-supplied, so anErroris entirely reachable — aTypeErrorfrom the callback, or a failure inside an adapter. Anything that isn't anExceptionescapes the catch and keeps the slot.Each leaked slot is permanent for the life of the process, and they accumulate one failed
pop()at a time. OnceconnectionsCreatedreachessize, the first branch never fires again and the pool reports itself empty while nothing is in use:active 0, idle 0withsize 24is the tell — all capacity reserved, nothing checked out, nothing to hand back.The consequence is worse than the arithmetic suggests. An upstream backend outage should degrade into slow acquisition and recover when the backend does. Instead every failed pop ratchets capacity down, so the process stays broken after the outage clears. Only a restart recovers it.
The fix
Catch
\Throwable, and move the release into afinallyguarded by a$reservedflag, so the reservation is balanced on every path out of the block rather than the ones acatchhappens to enumerate.destroyConnection()already usescatch (\Throwable)a few lines below for the same reason — this bringspop()in line with it.Test
Drains a size-2 pool with five
pop()s against an init callback that throws aTypeError:That is the production signature reproduced as a unit test — capacity at zero with nothing handed out.
Full suite: 108 tests, 372 assertions, green.
bin/monorepo check poolsclean (PHPStan level 8, Pint, Rector).PHPStan flagged the first version of the test for catching
\TypeError— dead, because with the fixpop()surfaces exhaustion as anExceptionwith the original attached asprevious. The test now asserts that instead, which is a better check anyway.Prior art
Filed previously as utopia-php/pools#34 and auto-closed by the mirror-redirect bot ("development happens in
packages/poolsin the monorepo"). That version changed the catch only; this one adds thefinallyso the balance does not depend on enumerating throwable types.Not included
createConnection()retries internally (reconnectAttempts) insidepop()'s own retry loop (retryAttempts), both defaulting to 3 with 1s sleeps. Against a backend that consumes a full connect timeout, onepop()can take ~35s before failing. That is a defaults question rather than a correctness one, and consumers can already scope it per pool, so I have left it alone here.🤖 Generated with Claude Code