Merge branch 'master' into eslint-no-unreachable

Author: alxndrsn

.devcontainer/Dockerfile

@@ -3,7 +3,7 @@
 # Licensed under the MIT License. See https://go.microsoft.com/fwlink/?linkid=2090316 for license information.
 #-------------------------------------------------------------------------------------------------------------
 
-FROM node:12
+FROM node:20
 
 # Avoid warnings by switching to noninteractive
 ENV DEBIAN_FRONTEND=noninteractive

.devcontainer/devcontainer.json

@@ -1,6 +1,6 @@
 // If you want to run as a non-root user in the container, see .devcontainer/docker-compose.yml.
 {
-	"name": "Node.js 12 & Postgres",
+	"name": "Node.js 20 & Postgres",
 	"dockerComposeFile": "docker-compose.yml",
 	"service": "web",
 	"workspaceFolder": "/workspace",

.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

.github/workflows/ci.yml

@@ -42,6 +42,7 @@ jobs:
           - '18'
           - '20'
           - '22'
+          - '23'
         os:
           - ubuntu-latest
     name: Node.js ${{ matrix.node }}

CHANGELOG.md

@@ -4,6 +4,10 @@ For richer information consult the commit log on github with referenced pull req
 
 We do not include break-fix version release in this file.
 
+## [email protected]
+
+- Add ability to specify query timeout on [per-query basis](https://github.com/brianc/node-postgres/pull/3074).
+
 ## [email protected]
 
 - Add `queryMode` config option to [force use of the extended query protocol](https://github.com/brianc/node-postgres/pull/3214) on queries without any parameters.

README.md

@@ -18,6 +18,11 @@ This repo is a monorepo which contains the core [pg](https://github.com/brianc/n
 - [pg-connection-string](https://github.com/brianc/node-postgres/tree/master/packages/pg-connection-string)
 - [pg-protocol](https://github.com/brianc/node-postgres/tree/master/packages/pg-protocol)
 
+## Install
+```
+npm install pg
+```
+
 ## Documentation
 
 Each package in this repo should have its own readme more focused on how to develop/contribute. For overall documentation on the project and the related modules managed by this repo please see:

packages/pg-cursor/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pg-cursor",
-  "version": "2.12.0",
+  "version": "2.12.3",
   "description": "Query cursor extension for node-postgres",
   "main": "index.js",
   "directories": {
@@ -18,7 +18,7 @@
   "license": "MIT",
   "devDependencies": {
     "mocha": "^10.5.2",
-    "pg": "^8.13.0"
+    "pg": "^8.13.3"
   },
   "peerDependencies": {
     "pg": "^8"

packages/pg-native/bench/index.js

@@ -19,7 +19,7 @@ var warmup = function (fn, cb) {
 var native = Native()
 native.connectSync()
 
-var queryText = 'SELECT generate_series(0, 1000)'
+var queryText = 'SELECT generate_series(0, 1000) as X, generate_series(0, 1000) as Y, generate_series(0, 1000) as Z'
 var client = new pg.Client()
 client.connect(function () {
   var pure = function (cb) {
@@ -36,12 +36,12 @@ client.connect(function () {
   }
 
   var run = function () {
-    var start = Date.now()
+    console.time('pure')
     warmup(pure, function () {
-      console.log('pure done', Date.now() - start)
-      start = Date.now()
+      console.timeEnd('pure')
+      console.time('native')
       warmup(nativeQuery, function () {
-        console.log('native done', Date.now() - start)
+        console.timeEnd('native')
       })
     })
   }

packages/pg-native/lib/build-result.js

@@ -9,6 +9,7 @@ class Result {
     this.rowCount = undefined
     this.fields = []
     this.rows = []
+    this._prebuiltEmptyResultObject = null
   }
 
   consumeCommand(pq) {
@@ -18,46 +19,47 @@ class Result {
 
   consumeFields(pq) {
     const nfields = pq.nfields()
+    this.fields = new Array(nfields)
+    var row = {}
     for (var x = 0; x < nfields; x++) {
-      this.fields.push({
-        name: pq.fname(x),
+      var name = pq.fname(x)
+      row[name] = null
+      this.fields[x] = {
+        name: name,
         dataTypeID: pq.ftype(x),
-      })
+      }
     }
+    this._prebuiltEmptyResultObject = { ...row }
   }
 
   consumeRows(pq) {
     const tupleCount = pq.ntuples()
+    this.rows = new Array(tupleCount)
     for (var i = 0; i < tupleCount; i++) {
-      const row = this._arrayMode ? this.consumeRowAsArray(pq, i) : this.consumeRowAsObject(pq, i)
-      this.rows.push(row)
+      this.rows[i] = this._arrayMode ? this.consumeRowAsArray(pq, i) : this.consumeRowAsObject(pq, i)
     }
   }
 
   consumeRowAsObject(pq, rowIndex) {
-    const row = {}
+    const row = { ...this._prebuiltEmptyResultObject }
     for (var j = 0; j < this.fields.length; j++) {
-      const value = this.readValue(pq, rowIndex, j)
-      row[this.fields[j].name] = value
+      row[this.fields[j].name] = this.readValue(pq, rowIndex, j)
     }
     return row
   }
 
   consumeRowAsArray(pq, rowIndex) {
-    const row = []
+    const row = new Array(this.fields.length)
     for (var j = 0; j < this.fields.length; j++) {
-      const value = this.readValue(pq, rowIndex, j)
-      row.push(value)
+      row[j] = this.readValue(pq, rowIndex, j)
     }
     return row
   }
 
   readValue(pq, rowIndex, colIndex) {
     var rawValue = pq.getvalue(rowIndex, colIndex)
-    if (rawValue === '') {
-      if (pq.getisnull(rowIndex, colIndex)) {
-        return null
-      }
+    if (rawValue === '' && pq.getisnull(rowIndex, colIndex)) {
+      return null
     }
     const dataTypeId = this.fields[colIndex].dataTypeID
     return this._types.getTypeParser(dataTypeId)(rawValue)

packages/pg-native/package.json

@@ -1,14 +1,14 @@
 {
   "name": "pg-native",
-  "version": "3.2.0",
+  "version": "3.2.2",
   "description": "A slightly nicer interface to Postgres over node-libpq",
   "main": "index.js",
   "scripts": {
     "test": "mocha"
   },
   "repository": {
     "type": "git",
-    "url": "git://github.com/brianc/node-pg-native.git"
+    "url": "https://github.com/brianc/node-postgres.git"
   },
   "keywords": [
     "postgres",
@@ -18,18 +18,18 @@
   "author": "Brian M. Carlson",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/brianc/node-pg-native/issues"
+    "url": "https://github.com/brianc/node-postgres/issues"
   },
-  "homepage": "https://github.com/brianc/node-pg-native",
+  "homepage": "https://github.com/brianc/node-postgres/tree/master/packages/pg-native",
   "dependencies": {
-    "libpq": "1.8.13",
-    "pg-types": "^1.12.1"
+    "libpq": "1.8.14",
+    "pg-types": "^2.1.0"
   },
   "devDependencies": {
     "async": "^0.9.0",
     "concat-stream": "^1.4.6",
     "generic-pool": "^2.1.1",
-    "lodash": "^2.4.1",
+    "lodash": "^4.17.21",
     "mocha": "10.5.2",
     "node-gyp": ">=10.x",
     "okay": "^0.3.0",

packages/pg-pool/README.md

@@ -265,7 +265,7 @@ pool
 
 #### acquire
 
-Fired whenever the a client is acquired from the pool
+Fired whenever a client is acquired from the pool
 
 Example:
 

packages/pg-pool/index.js

@@ -244,7 +244,7 @@ class Pool extends EventEmitter {
         // remove the dead client from our list of clients
         this._clients = this._clients.filter((c) => c !== client)
         if (timeoutHit) {
-          err.message = 'Connection terminated due to connection timeout'
+          err = new Error('Connection terminated due to connection timeout', { cause: err })
         }
 
         // this client won’t be released, so move on immediately

packages/pg-pool/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pg-pool",
-  "version": "3.7.0",
+  "version": "3.7.1",
   "description": "Connection pool for node-postgres",
   "main": "index.js",
   "directories": {

packages/pg-protocol/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pg-protocol",
-  "version": "1.7.0",
+  "version": "1.7.1",
   "description": "The postgres client/server binary protocol, implemented in TypeScript",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

packages/pg-protocol/src/buffer-reader.ts

@@ -31,6 +31,12 @@ export class BufferReader {
     return result
   }
 
+  public uint32(): number {
+    const result = this.buffer.readUInt32BE(this.offset)
+    this.offset += 4
+    return result
+  }
+
   public string(length: number): string {
     const result = this.buffer.toString(this.encoding, this.offset, this.offset + length)
     this.offset += length

packages/pg-protocol/src/inbound-parser.test.ts

@@ -39,6 +39,17 @@ var twoRowBuf = buffers.rowDescription([
   },
 ])
 
+var rowWithBigOids = {
+  name: 'bigoid',
+  tableID: 3000000001,
+  attributeNumber: 2,
+  dataTypeID: 3000000003,
+  dataTypeSize: 4,
+  typeModifier: 5,
+  formatCode: 0,
+}
+var bigOidDescBuff = buffers.rowDescription([rowWithBigOids])
+
 var emptyRowFieldBuf = new BufferList().addInt16(0).join(true, 'D')
 
 var emptyRowFieldBuf = buffers.dataRow([])
@@ -132,6 +143,22 @@ var expectedTwoRowMessage = {
     },
   ],
 }
+var expectedBigOidMessage = {
+  name: 'rowDescription',
+  length: 31,
+  fieldCount: 1,
+  fields: [
+    {
+      name: 'bigoid',
+      tableID: 3000000001,
+      columnID: 2,
+      dataTypeID: 3000000003,
+      dataTypeSize: 4,
+      dataTypeModifier: 5,
+      format: 'text',
+    },
+  ],
+}
 
 var emptyParameterDescriptionBuffer = new BufferList()
   .addInt16(0) // number of parameters
@@ -163,7 +190,7 @@ var expectedTwoParameterMessage = {
 }
 
 var testForMessage = function (buffer: Buffer, expectedMessage: any) {
-  it('recieves and parses ' + expectedMessage.name, async () => {
+  it('receives and parses ' + expectedMessage.name, async () => {
     const messages = await parseBuffers([buffer])
     const [lastMessage] = messages
 
@@ -261,6 +288,7 @@ describe('PgPacketStream', function () {
     testForMessage(emptyRowDescriptionBuffer, expectedEmptyRowDescriptionMessage)
     testForMessage(oneRowDescBuff, expectedOneRowMessage)
     testForMessage(twoRowBuf, expectedTwoRowMessage)
+    testForMessage(bigOidDescBuff, expectedBigOidMessage)
   })
 
   describe('parameterDescription messages', function () {
@@ -459,12 +487,12 @@ describe('PgPacketStream', function () {
       assert.equal(message.fields[4], '!')
     })
 
-    var testMessageRecievedAfterSpiltAt = async function (split: number) {
+    var testMessageReceivedAfterSplitAt = async function (split: number) {
       var firstBuffer = Buffer.alloc(fullBuffer.length - split)
       var secondBuffer = Buffer.alloc(fullBuffer.length - firstBuffer.length)
       fullBuffer.copy(firstBuffer, 0, 0)
       fullBuffer.copy(secondBuffer, 0, firstBuffer.length)
-      const messages = await parseBuffers([fullBuffer])
+      const messages = await parseBuffers([firstBuffer, secondBuffer])
       const message = messages[0] as any
       assert.equal(message.fields.length, 5)
       assert.equal(message.fields[0], null)
@@ -475,17 +503,19 @@ describe('PgPacketStream', function () {
     }
 
     it('parses when split in the middle', function () {
-      testMessageRecievedAfterSpiltAt(6)
+      return testMessageReceivedAfterSplitAt(6)
     })
 
     it('parses when split at end', function () {
-      testMessageRecievedAfterSpiltAt(2)
+      return testMessageReceivedAfterSplitAt(2)
     })
 
     it('parses when split at beginning', function () {
-      testMessageRecievedAfterSpiltAt(fullBuffer.length - 2)
-      testMessageRecievedAfterSpiltAt(fullBuffer.length - 1)
-      testMessageRecievedAfterSpiltAt(fullBuffer.length - 5)
+      return Promise.all([
+        testMessageReceivedAfterSplitAt(fullBuffer.length - 2),
+        testMessageReceivedAfterSplitAt(fullBuffer.length - 1),
+        testMessageReceivedAfterSplitAt(fullBuffer.length - 5),
+      ])
     })
   })
 
@@ -512,7 +542,7 @@ describe('PgPacketStream', function () {
       })
     }
     // sanity check
-    it('recieves both messages when packet is not split', async function () {
+    it('receives both messages when packet is not split', async function () {
       const messages = await parseBuffers([fullBuffer])
       verifyMessages(messages)
     })
@@ -526,7 +556,7 @@ describe('PgPacketStream', function () {
       verifyMessages(messages)
     }
 
-    describe('recieves both messages when packet is split', function () {
+    describe('receives both messages when packet is split', function () {
       it('in the middle', function () {
         return splitAndVerifyTwoMessages(11)
       })

packages/pg-protocol/src/parser.ts

@@ -258,9 +258,9 @@ export class Parser {
 
   private parseField(): Field {
     const name = this.reader.cstring()
-    const tableID = this.reader.int32()
+    const tableID = this.reader.uint32()
     const columnID = this.reader.int16()
-    const dataTypeID = this.reader.int32()
+    const dataTypeID = this.reader.uint32()
     const dataTypeSize = this.reader.int16()
     const dataTypeModifier = this.reader.int32()
     const mode = this.reader.int16() === 0 ? 'text' : 'binary'