-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Handle bad message ordering - make it catchable. Fixes 3174 (#3289)
* Handle bad message ordering - make it catchable. Fixes 3174 * Close client in test * Mess w/ github action settings * update ci config * Remove redundant tests * Update code to use handle error event * Add tests for commandComplete message being out of order * Lint fix * Fix native tests * Fix lint again...airport computer not my friend * Not a native issue
- Loading branch information
Showing
5 changed files
with
203 additions
and
53 deletions.
There are no files selected for viewing
This file contains 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 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 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 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 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,167 @@ | ||
| const net = require('net') | ||
| const buffers = require('../../test-buffers') | ||
| const helper = require('../test-helper') | ||
| const assert = require('assert') | ||
| const cli = require('../../cli') | ||
|
|
||
| const suite = new helper.Suite() | ||
|
|
||
| const options = { | ||
| host: 'localhost', | ||
| port: Math.floor(Math.random() * 2000) + 2000, | ||
| connectionTimeoutMillis: 2000, | ||
| user: 'not', | ||
| database: 'existing', | ||
| } | ||
|
|
||
| const startMockServer = (port, badBuffer, callback) => { | ||
| const sockets = new Set() | ||
|
|
||
| const server = net.createServer((socket) => { | ||
| sockets.add(socket) | ||
| socket.once('end', () => sockets.delete(socket)) | ||
|
|
||
| socket.on('data', (data) => { | ||
| // deny request for SSL | ||
| if (data.length === 8) { | ||
| socket.write(Buffer.from('N', 'utf8')) | ||
| return | ||
| // consider all authentication requests as good | ||
| } | ||
| // the initial message coming in has a 0 message type for authentication negotiation | ||
| if (!data[0]) { | ||
| socket.write(buffers.authenticationOk()) | ||
| // send ReadyForQuery `timeout` ms after authentication | ||
| socket.write(buffers.readyForQuery()) | ||
| return | ||
| // respond with our canned response | ||
| } | ||
| const code = data.toString('utf8', 0, 1) | ||
| switch (code) { | ||
| // parse | ||
| case 'P': | ||
| socket.write(buffers.parseComplete()) | ||
| socket.write(buffers.bindComplete()) | ||
| socket.write(buffers.rowDescription()) | ||
| socket.write(buffers.dataRow()) | ||
| socket.write(buffers.commandComplete('FOO BAR')) | ||
| socket.write(buffers.readyForQuery()) | ||
| // this message is invalid, but sometimes sent out of order when using proxies or pg-bouncer | ||
| setImmediate(() => { | ||
| socket.write(badBuffer) | ||
| }) | ||
| break | ||
| case 'Q': | ||
| socket.write(buffers.rowDescription()) | ||
| socket.write(buffers.dataRow()) | ||
| socket.write(buffers.commandComplete('FOO BAR')) | ||
| socket.write(buffers.readyForQuery()) | ||
| // this message is invalid, but sometimes sent out of order when using proxies or pg-bouncer | ||
| setImmediate(() => { | ||
| socket.write(badBuffer) | ||
| }) | ||
| default: | ||
| // console.log('got code', code) | ||
| } | ||
| }) | ||
| }) | ||
|
|
||
| const closeServer = () => { | ||
| for (const socket of sockets) { | ||
| socket.destroy() | ||
| } | ||
| return new Promise((resolve) => { | ||
| server.close(resolve) | ||
| }) | ||
| } | ||
|
|
||
| server.listen(port, options.host, () => callback(closeServer)) | ||
| } | ||
|
|
||
| const delay = (ms) => | ||
| new Promise((resolve) => { | ||
| setTimeout(resolve, ms) | ||
| }) | ||
|
|
||
| const testErrorBuffer = (bufferName, errorBuffer) => { | ||
| suite.testAsync(`Out of order ${bufferName} on simple query is catchable`, async () => { | ||
| const closeServer = await new Promise((resolve, reject) => { | ||
| return startMockServer(options.port, errorBuffer, (closeServer) => resolve(closeServer)) | ||
| }) | ||
| const client = new helper.Client(options) | ||
| await client.connect() | ||
|
|
||
| let errorHit = false | ||
| client.on('error', () => { | ||
| errorHit = true | ||
| }) | ||
|
|
||
| await client.query('SELECT NOW()') | ||
| await delay(50) | ||
|
|
||
| // the native client only emits a notice message and keeps on its merry way | ||
| if (!cli.native) { | ||
| assert(errorHit) | ||
| // further queries on the client should fail since its in an invalid state | ||
| await assert.rejects(() => client.query('SELECTR NOW()'), 'Further queries on the client should reject') | ||
| } | ||
|
|
||
| await closeServer() | ||
| }) | ||
|
|
||
| suite.testAsync(`Out of order ${bufferName} on extended query is catchable`, async () => { | ||
| const closeServer = await new Promise((resolve, reject) => { | ||
| return startMockServer(options.port, errorBuffer, (closeServer) => resolve(closeServer)) | ||
| }) | ||
| const client = new helper.Client(options) | ||
| await client.connect() | ||
|
|
||
| let errorHit = false | ||
| client.on('error', () => { | ||
| errorHit = true | ||
| }) | ||
|
|
||
| await client.query('SELECT $1', ['foo']) | ||
| await delay(40) | ||
|
|
||
| // the native client only emits a notice message and keeps on its merry way | ||
| if (!cli.native) { | ||
| assert(errorHit) | ||
| // further queries on the client should fail since its in an invalid state | ||
| await assert.rejects(() => client.query('SELECTR NOW()'), 'Further queries on the client should reject') | ||
| } | ||
|
|
||
| await client.end() | ||
|
|
||
| await closeServer() | ||
| }) | ||
|
|
||
| suite.testAsync(`Out of order ${bufferName} on pool is catchable`, async () => { | ||
| const closeServer = await new Promise((resolve, reject) => { | ||
| return startMockServer(options.port, errorBuffer, (closeServer) => resolve(closeServer)) | ||
| }) | ||
| const pool = new helper.pg.Pool(options) | ||
|
|
||
| let errorHit = false | ||
| pool.on('error', () => { | ||
| errorHit = true | ||
| }) | ||
|
|
||
| await pool.query('SELECT $1', ['foo']) | ||
| await delay(100) | ||
|
|
||
| if (!cli.native) { | ||
| assert(errorHit) | ||
| assert.strictEqual(pool.idleCount, 0, 'Pool should have no idle clients') | ||
| assert.strictEqual(pool.totalCount, 0, 'Pool should have no connected clients') | ||
| } | ||
|
|
||
| await pool.end() | ||
| await closeServer() | ||
| }) | ||
| } | ||
|
|
||
| if (!helper.args.native) { | ||
| testErrorBuffer('parseComplete', buffers.parseComplete()) | ||
| testErrorBuffer('commandComplete', buffers.commandComplete('f')) | ||
| } |