-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Explicit Resource Management for pg pool client #3661
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
hyperair
wants to merge
5
commits into
brianc:master
Choose a base branch
from
hyperair:disposable-pool-client
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+99
−0
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
e308652
pool: Add Disposable support to PoolClient
hyperair 2b4879c
pool: Update docs for disposable pool client
hyperair c482a12
pool: Add support for client.release(true) with Symbol.dispose
hyperair 1f75492
Drop unnecessary ?. in Symbol.dispose check
hyperair f56d448
Fix typo in docs
hyperair File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| const Pool = require('../') | ||
|
|
||
| const expect = require('expect.js') | ||
|
|
||
| describe('disposable clients', () => { | ||
| it('defines a callable [Symbol.dispose]() when symbol is present', async () => { | ||
| const pool = new Pool({ max: 1 }) | ||
| const client = await pool.connect() | ||
|
|
||
| if (Symbol.dispose) { | ||
| expect(client[Symbol.dispose]).to.be.a('function') | ||
| } | ||
|
|
||
| // ensure we don't define an `undefined` function when Symbol.dispose | ||
| // doesn't exist | ||
| expect(client).not.to.have.property('undefined') | ||
|
|
||
| client.release() | ||
| await pool.end() | ||
| }) | ||
|
|
||
| if (process.version.slice(1).split('.')[0] >= 24) { | ||
| require('./disposable-clients/using.js') | ||
| } | ||
| }) |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| const Pool = require('../..') | ||
|
|
||
| const expect = require('expect.js') | ||
|
|
||
| it('supports releasing clients via `using`', async () => { | ||
| const pool = new Pool({ max: 1 }) | ||
| expect(pool.totalCount).to.eql(0) | ||
|
|
||
| { | ||
| using client = await pool.connect() | ||
| expect(pool.totalCount).to.eql(1) | ||
| expect(pool.idleCount).to.eql(0) | ||
| await client.query('SELECT NOW()') | ||
| } | ||
|
|
||
| expect(pool.totalCount).to.eql(1) | ||
| expect(pool.idleCount).to.eql(1) | ||
|
|
||
| await pool.end() | ||
| }) | ||
|
|
||
| it('supports destroying clients via `using`', async () => { | ||
| const pool = new Pool({ max: 1 }) | ||
| expect(pool.totalCount).to.eql(0) | ||
|
|
||
| { | ||
| using client = await pool.connect() | ||
| client.destroyOnDispose = true | ||
| expect(pool.totalCount).to.eql(1) | ||
| expect(pool.idleCount).to.eql(0) | ||
| await client.query('SELECT NOW()') | ||
| } | ||
|
|
||
| expect(pool.totalCount).to.eql(0) | ||
| expect(pool.idleCount).to.eql(0) | ||
|
|
||
| await pool.end() | ||
| }) |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this would normally go on the prototype, but pg-pool’s approach is already a bit messy (it’s lacking a
PooledClientobject that’s specific to one acquisition operation) so it’s also not the end of the world if the patch goes in as-is.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agreed, and that's why I implemented it like this.
@types/pghas aPooledClienttype with thereleasesignature, and I intend to make a PR there to add the[Symbol.dispose]addition later.