Skip to content

Commit

Permalink
Handle bad message ordering - make it catchable. Fixes 3174
Browse files Browse the repository at this point in the history
  • Loading branch information
brianc committed Aug 1, 2024
1 parent 50c06f9 commit a221d7c
Show file tree
Hide file tree
Showing 3 changed files with 173 additions and 37 deletions.
6 changes: 5 additions & 1 deletion packages/pg/lib/client.js
Original file line number Diff line number Diff line change
Expand Up @@ -381,7 +381,11 @@ class Client extends EventEmitter {
this.activeQuery.handleCommandComplete(msg, this.connection)
}

_handleParseComplete(msg) {
_handleParseComplete() {
if (this.activeQuery == null) {
this.emit('error', new Error('Received parseComplete when not in parsing state'))
return
}
// if a prepared statement has a name and properly parses
// we track that its already been executed so we don't parse
// it again on the same client
Expand Down
57 changes: 21 additions & 36 deletions packages/pg/script/create-test-tables.js
Original file line number Diff line number Diff line change
Expand Up @@ -31,41 +31,26 @@ var people = [
{ name: 'Zanzabar', age: 260 },
]

var con = new pg.Client({
user: args.user,
password: args.password,
host: args.host,
port: args.port,
database: args.database,
})

con.connect((err) => {
if (err) {
throw err
}

con.query(
'DROP TABLE IF EXISTS person;' + ' CREATE TABLE person (id serial, name varchar(10), age integer)',
(err) => {
if (err) {
throw err
}

console.log('Created table person')
console.log('Filling it with people')

con.query(
'INSERT INTO person (name, age) VALUES' +
people.map((person) => ` ('${person.name}', ${person.age})`).join(','),
(err, result) => {
if (err) {
throw err
}

console.log(`Inserted ${result.rowCount} people`)
con.end()
}
)
}
async function run() {
var con = new pg.Client({
user: args.user,
password: args.password,
host: args.host,
port: args.port,
database: args.database,
})
console.log('creating test dataset')
await con.connect()
await con.query('DROP TABLE IF EXISTS person')
await con.query('CREATE TABLE person (id serial, name varchar(10), age integer)')
await con.query(
'INSERT INTO person (name, age) VALUES' + people.map((person) => ` ('${person.name}', ${person.age})`).join(',')
)
await con.end()
console.log('created test dataset')
}

run().catch((e) => {
console.log('setup failed', e)
process.exit(255)
})
147 changes: 147 additions & 0 deletions packages/pg/test/integration/gh-issues/3174-tests.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,147 @@
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, timeout, 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(buffers.parseComplete())
})
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(buffers.parseComplete())
})
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)
})

suite.testAsync('Out of order parseComplete on simple query is catchable', async () => {
const closeServer = await new Promise((resolve, reject) => {
return startMockServer(options.port, 0, (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)
await client.query('SELECT NOW')
await delay(50)
await client.query('SELECT NOW')
await delay(50)
await client.end()
assert(cli.native || errorHit)

await closeServer()
})

suite.testAsync('Out of order parseComplete on extended query is catchable', async () => {
const closeServer = await new Promise((resolve, reject) => {
return startMockServer(options.port, 0, (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 client.end()
await delay(100)
assert(cli.native || errorHit)

await closeServer()
})

suite.testAsync('Out of order parseComplete on pool is catchable', async () => {
const closeServer = await new Promise((resolve, reject) => {
return startMockServer(options.port, 0, (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)
assert(cli.native || errorHit)

await pool.end()
await closeServer()
})

0 comments on commit a221d7c

Please sign in to comment.