From 5701eb935c2bfcfdf9707f8ed0395f34a76c5095 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Johannes=20W=C3=BCrbach?= Date: Mon, 11 Feb 2019 21:18:53 +0100 Subject: [PATCH 1/5] Prevent requeuing a broken client If a client is not queryable, the pool should prevent requeuing instead of strictly enforcing errors to be propagated back to it. --- packages/pg-pool/index.js | 25 ++++++++++++++++++ packages/pg-pool/test/error-handling.js | 34 +++++++++++++++++++++++++ 2 files changed, 59 insertions(+) diff --git a/packages/pg-pool/index.js b/packages/pg-pool/index.js index 1c7faf210..fddb935a8 100644 --- a/packages/pg-pool/index.js +++ b/packages/pg-pool/index.js @@ -25,6 +25,31 @@ class PendingItem { } } +function throwOnRelease () { + throw new Error('Release called on client which has already been released to the pool.') +} + +function release (client, err) { + client.release = throwOnRelease + if (err || this.ending || !client._queryable || client._ending) { + this._remove(client) + this._pulseQueue() + return + } + + // idle timeout + let tid + if (this.options.idleTimeoutMillis) { + tid = setTimeout(() => { + this.log('remove idle client') + this._remove(client) + }, this.options.idleTimeoutMillis) + } + + this._idle.push(new IdleItem(client, tid)) + this._pulseQueue() +} + function promisify (Promise, callback) { if (callback) { return { callback: callback, result: undefined } diff --git a/packages/pg-pool/test/error-handling.js b/packages/pg-pool/test/error-handling.js index 72d97ede0..4bdb2f507 100644 --- a/packages/pg-pool/test/error-handling.js +++ b/packages/pg-pool/test/error-handling.js @@ -181,6 +181,40 @@ describe('pool error handling', function () { }) }) + describe('releasing a not queryable client', () => { + it('removes the client from the pool', (done) => { + const pool = new Pool({ max: 1 }) + const connectionError = new Error('connection failed') + + pool.once('error', () => { + // Ignore error on pool + }) + + pool.connect((err, client) => { + expect(err).to.be(undefined) + + client.once('error', (err) => { + expect(err).to.eql(connectionError) + + // Releasing the client should remove it from the pool, + // whether called with an error or not + client.release() + + // Verify that the pool is still usuable and new client has been + // created + pool.query('SELECT $1::text as name', ['brianc'], (err, res) => { + expect(err).to.be(undefined) + expect(res.rows).to.eql([{ name: 'brianc' }]) + + pool.end(done) + }) + }) + + client.emit('error', connectionError) + }) + }) + }) + describe('pool with lots of errors', () => { it('continues to work and provide new clients', co.wrap(function* () { const pool = new Pool({ max: 1 }) From 2b5bb1490c385512f9aff81dbe05c659fd7c4022 Mon Sep 17 00:00:00 2001 From: "Brian M. Carlson" Date: Thu, 23 Jan 2020 11:31:15 -0600 Subject: [PATCH 2/5] Write tests for change --- packages/pg-pool/index.js | 28 ++--------- packages/pg-pool/test/error-handling.js | 34 -------------- packages/pg-pool/test/releasing-clients.js | 54 ++++++++++++++++++++++ 3 files changed, 58 insertions(+), 58 deletions(-) create mode 100644 packages/pg-pool/test/releasing-clients.js diff --git a/packages/pg-pool/index.js b/packages/pg-pool/index.js index fddb935a8..83ec51e09 100644 --- a/packages/pg-pool/index.js +++ b/packages/pg-pool/index.js @@ -25,31 +25,10 @@ class PendingItem { } } -function throwOnRelease () { +function throwOnDoubleRelease () { throw new Error('Release called on client which has already been released to the pool.') } -function release (client, err) { - client.release = throwOnRelease - if (err || this.ending || !client._queryable || client._ending) { - this._remove(client) - this._pulseQueue() - return - } - - // idle timeout - let tid - if (this.options.idleTimeoutMillis) { - tid = setTimeout(() => { - this.log('remove idle client') - this._remove(client) - }, this.options.idleTimeoutMillis) - } - - this._idle.push(new IdleItem(client, tid)) - this._pulseQueue() -} - function promisify (Promise, callback) { if (callback) { return { callback: callback, result: undefined } @@ -269,7 +248,7 @@ class Pool extends EventEmitter { client.release = (err) => { if (released) { - throw new Error('Release called on client which has already been released to the pool.') + throwOnDoubleRelease() } released = true @@ -305,7 +284,8 @@ class Pool extends EventEmitter { _release (client, idleListener, err) { client.on('error', idleListener) - if (err || this.ending) { + // TODO(bmc): expose a proper, public interface _queryable and _ending + if (err || this.ending || !client._queryable || client._ending) { this._remove(client) this._pulseQueue() return diff --git a/packages/pg-pool/test/error-handling.js b/packages/pg-pool/test/error-handling.js index 4bdb2f507..72d97ede0 100644 --- a/packages/pg-pool/test/error-handling.js +++ b/packages/pg-pool/test/error-handling.js @@ -181,40 +181,6 @@ describe('pool error handling', function () { }) }) - describe('releasing a not queryable client', () => { - it('removes the client from the pool', (done) => { - const pool = new Pool({ max: 1 }) - const connectionError = new Error('connection failed') - - pool.once('error', () => { - // Ignore error on pool - }) - - pool.connect((err, client) => { - expect(err).to.be(undefined) - - client.once('error', (err) => { - expect(err).to.eql(connectionError) - - // Releasing the client should remove it from the pool, - // whether called with an error or not - client.release() - - // Verify that the pool is still usuable and new client has been - // created - pool.query('SELECT $1::text as name', ['brianc'], (err, res) => { - expect(err).to.be(undefined) - expect(res.rows).to.eql([{ name: 'brianc' }]) - - pool.end(done) - }) - }) - - client.emit('error', connectionError) - }) - }) - }) - describe('pool with lots of errors', () => { it('continues to work and provide new clients', co.wrap(function* () { const pool = new Pool({ max: 1 }) diff --git a/packages/pg-pool/test/releasing-clients.js b/packages/pg-pool/test/releasing-clients.js new file mode 100644 index 000000000..8fccde36e --- /dev/null +++ b/packages/pg-pool/test/releasing-clients.js @@ -0,0 +1,54 @@ +const Pool = require('../') + +const expect = require('expect.js') +const net = require('net') + +describe('releasing clients', () => { + it('removes a client which cannot be queried', async () => { + // make a pool w/ only 1 client + const pool = new Pool({ max: 1 }) + expect(pool.totalCount).to.eql(0) + const client = await pool.connect() + expect(pool.totalCount).to.eql(1) + expect(pool.idleCount).to.eql(0) + // reach into the client and sever its connection + client.connection.end() + + // wait for the client to error out + const err = await new Promise((resolve) => client.once('error', resolve)) + expect(err).to.be.ok() + expect(pool.totalCount).to.eql(1) + expect(pool.idleCount).to.eql(0) + + // try to return it to the pool - this removes it because its broken + client.release() + expect(pool.totalCount).to.eql(0) + expect(pool.idleCount).to.eql(0) + + // make sure pool still works + const { rows } = await pool.query('SELECT NOW()') + expect(rows).to.have.length(1) + await pool.end() + }) + + it('removes a client which is ending', async () => { + // make a pool w/ only 1 client + const pool = new Pool({ max: 1 }) + expect(pool.totalCount).to.eql(0) + const client = await pool.connect() + expect(pool.totalCount).to.eql(1) + expect(pool.idleCount).to.eql(0) + // end the client gracefully (but you shouldn't do this with pooled clients) + client.end() + + // try to return it to the bool + client.release() + expect(pool.totalCount).to.eql(0) + expect(pool.idleCount).to.eql(0) + + // make sure pool still works + const { rows } = await pool.query('SELECT NOW()') + expect(rows).to.have.length(1) + await pool.end() + }) +}) From 9e04e1fc167f4cb9385954db143dfdbbca3c5228 Mon Sep 17 00:00:00 2001 From: "Brian M. Carlson" Date: Thu, 23 Jan 2020 12:08:57 -0600 Subject: [PATCH 3/5] Use node 13.6 in travis Some weird behavior changed w/ async iteration in node 13.7...I'm not sure if this was an unintentional break or not but it definitely diverges in behavior from node 12 and earlier versions in node 13...so for now going to run tests on 13.6 to unblock the tests from running while I track this down. --- .travis.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.travis.yml b/.travis.yml index 61a7a79af..7ea347e9b 100644 --- a/.travis.yml +++ b/.travis.yml @@ -10,7 +10,7 @@ env: node_js: - lts/dubnium - lts/erbium - - 13 + - 13.6 addons: postgresql: "10" From 904932ecdc644349d8cb3135552f27144aad5855 Mon Sep 17 00:00:00 2001 From: Brian C Date: Mon, 27 Jan 2020 10:06:23 -0600 Subject: [PATCH 4/5] Update packages/pg-pool/test/releasing-clients.js Co-Authored-By: Charmander <~@charmander.me> --- packages/pg-pool/test/releasing-clients.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/pg-pool/test/releasing-clients.js b/packages/pg-pool/test/releasing-clients.js index 8fccde36e..da8e09c16 100644 --- a/packages/pg-pool/test/releasing-clients.js +++ b/packages/pg-pool/test/releasing-clients.js @@ -41,7 +41,7 @@ describe('releasing clients', () => { // end the client gracefully (but you shouldn't do this with pooled clients) client.end() - // try to return it to the bool + // try to return it to the pool client.release() expect(pool.totalCount).to.eql(0) expect(pool.idleCount).to.eql(0) From b8e7dd2f82a23089d9629e2b44bf7c27f285e086 Mon Sep 17 00:00:00 2001 From: Brian C Date: Mon, 27 Jan 2020 10:07:35 -0600 Subject: [PATCH 5/5] Update .travis.yml --- .travis.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.travis.yml b/.travis.yml index 7ea347e9b..b00d6e695 100644 --- a/.travis.yml +++ b/.travis.yml @@ -10,6 +10,9 @@ env: node_js: - lts/dubnium - lts/erbium + # node 13.7 seems to have changed behavior of async iterators exiting early on streams + # if 13.8 still has this problem when it comes down I'll talk to the node team about the change + # in the mean time...peg to 13.6 - 13.6 addons: