.devcontainer/docker-compose.yml

@@ -25,6 +25,9 @@ services:
       PGUSER: user
       PGDATABASE: data
       PGHOST: db
+      # set this to true in the development environment until I can get SSL setup on the 
+      # docker postgres instance
+      PGTESTNOSSL: true
 
     # Overrides default command so things don't shut down after the process ends.
     command: sleep infinity

CHANGELOG.md

@@ -4,6 +4,17 @@ For richer information consult the commit log on github with referenced pull req
 
 We do not include break-fix version release in this file.
 
+### pg@8.6.0
+
+- Better [SASL](https://github.com/brianc/node-postgres/pull/2436) error messages & more validation on bad configuration.
+- Export [DatabaseError](https://github.com/brianc/node-postgres/pull/2445).
+- Add [ParameterDescription](https://github.com/brianc/node-postgres/pull/2464) support to protocol parsing.
+- Fix typescript [typedefs](https://github.com/brianc/node-postgres/pull/2490) with `--isolatedModules`.
+
+### pg-query-stream@4.0.0
+
+- Library has been [converted](https://github.com/brianc/node-postgres/pull/2376) to Typescript. The behavior is identical, but there could be subtle breaking changes due to class names changing or other small inconsistencies introduced by the conversion.
+
 ### pg@8.5.0
 
 - Fix bug forwarding [ssl key](https://github.com/brianc/node-postgres/pull/2394).
@@ -14,7 +25,7 @@ We do not include break-fix version release in this file.
 
 - Switch to optional peer dependencies & remove [semver](https://github.com/brianc/node-postgres/commit/a02dfac5ad2e2abf0dc3a9817f953938acdc19b1) package which has been a small thorn in the side of a few users.
 - Export `DatabaseError` from [pg-protocol](https://github.com/brianc/node-postgres/commit/58258430d52ee446721cc3e6611e26f8bcaa67f5).
-- Add support for `ssl-mode` in the [connection string](https://github.com/brianc/node-postgres/commit/6be3b9022f83efc721596cc41165afaa07bfceb0).
+- Add support for `sslmode` in the [connection string](https://github.com/brianc/node-postgres/commit/6be3b9022f83efc721596cc41165afaa07bfceb0).
 
 ### pg@8.3.0
 

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2010 - 2020 Brian Carlson
+Copyright (c) 2010 - 2021 Brian Carlson
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,7 +1,6 @@
 # node-postgres
 
 [![Build Status](https://secure.travis-ci.org/brianc/node-postgres.svg?branch=master)](http://travis-ci.org/brianc/node-postgres)
-[![Dependency Status](https://david-dm.org/brianc/node-postgres.svg?path=packages/pg)](https://david-dm.org/brianc/node-postgres?path=packages/pg)
 <span class="badge-npmversion"><a href="https://npmjs.org/package/pg" title="View this project on NPM"><img src="https://img.shields.io/npm/v/pg.svg" alt="NPM version" /></a></span>
 <span class="badge-npmdownloads"><a href="https://npmjs.org/package/pg" title="View this project on NPM"><img src="https://img.shields.io/npm/dm/pg.svg" alt="NPM downloads" /></a></span>
 
@@ -24,6 +23,8 @@ Each package in this repo should have its own readme more focused on how to deve
 
 ### :star: [Documentation](https://node-postgres.com) :star:
 
+The source repo for the documentation is https://github.com/brianc/node-postgres-docs.
+
 ### Features
 
 - Pure JavaScript client and native libpq bindings share _the same API_
@@ -57,9 +58,16 @@ You can also follow me [@briancarlson](https://twitter.com/briancarlson) if that
 node-postgres's continued development has been made possible in part by generous finanical support from [the community](https://github.com/brianc/node-postgres/blob/master/SPONSORS.md) and these featured sponsors:
 
 <div align="center">
-<a href="https://crate.io" target="_blank">
-  <img height="80" src="https://node-postgres.com/crate-io.png" />
-</a>
+  <p>
+    <a href="https://crate.io" target="_blank">
+      <img height="80" src="https://node-postgres.com/crate-io.png" />
+    </a>
+  </p>
+  <p>
+    <a href="https://www.eaze.com" target="_blank">
+      <img height="80" src="https://node-postgres.com/eaze.png" />
+    </a>
+  </p>
 </div>
 
 If you or your company are benefiting from node-postgres and would like to help keep the project financially sustainable [please consider supporting](https://github.com/sponsors/brianc) its development.

SPONSORS.md

@@ -9,6 +9,9 @@ node-postgres is made possible by the helpful contributors from the community as
 - [CrateDB](https://crate.io/)
 - [BitMEX](https://www.bitmex.com/app/trade/XBTUSD)
 - [Dataform](https://dataform.co/)
+- [Eaze](https://www.eaze.com/)
+- [simpleanalytics](https://simpleanalytics.com/)
+- [n8n.io]https://n8n.io/
 
 # Supporters
 
@@ -34,3 +37,6 @@ node-postgres is made possible by the helpful contributors from the community as
 - Trevor Linton
 - Ian Walter
 - @Guido4000
+- [Martti Laine](https://github.com/codeclown)
+- [Tim Nolet](https://github.com/tnolet)
+- [checkly](https://github.com/checkly)

packages/pg-connection-string/README.md

@@ -22,13 +22,14 @@ var config = parse('postgres://someuser:somepassword@somehost:381/somedatabase')
 
 The resulting config contains a subset of the following properties:
 
-* `host` - Postgres server hostname or, for UNIX doamain sockets, the socket filename
+* `host` - Postgres server hostname or, for UNIX domain sockets, the socket filename
 * `port` - port on which to connect
 * `user` - User with which to authenticate to the server
 * `password` - Corresponding password
 * `database` - Database name within the server
 * `client_encoding` - string encoding the client will use
 * `ssl`, either a boolean or an object with properties
+  * `rejectUnauthorized`
   * `cert`
   * `key`
   * `ca`
@@ -65,6 +66,10 @@ Query parameters follow a `?` character, including the following special query p
  * `host=<host>` - sets `host` property, overriding the URL's host
  * `encoding=<encoding>` - sets the `client_encoding` property
  * `ssl=1`, `ssl=true`, `ssl=0`, `ssl=false` - sets `ssl` to true or false, accordingly
+ * `sslmode=<sslmode>`
+   * `sslmode=disable` - sets `ssl` to false
+   * `sslmode=no-verify` - sets `ssl` to `{ rejectUnauthorized: false }`
+   * `sslmode=prefer`, `sslmode=require`, `sslmode=verify-ca`, `sslmode=verify-full` - sets `ssl` to true
  * `sslcert=<filename>` - reads data from the given file and includes the result as `ssl.cert`
  * `sslkey=<filename>` - reads data from the given file and includes the result as `ssl.key`
  * `sslrootcert=<filename>` - reads data from the given file and includes the result as `ssl.ca`

packages/pg-connection-string/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pg-connection-string",
-  "version": "2.4.0",
+  "version": "2.5.0",
   "description": "Functions for dealing with a PostgresSQL connection string",
   "main": "./index.js",
   "types": "./index.d.ts",
@@ -11,7 +11,8 @@
   },
   "repository": {
     "type": "git",
-    "url": "git://github.com/brianc/node-postgres.git"
+    "url": "git://github.com/brianc/node-postgres.git",
+    "directory": "packages/pg-connection-string"
   },
   "keywords": [
     "pg",

packages/pg-cursor/index.js

@@ -28,6 +28,9 @@ util.inherits(Cursor, EventEmitter)
 Cursor.prototype._ifNoData = function () {
   this.state = 'idle'
   this._shiftQueue()
+  if (this.connection) {
+    this.connection.removeListener('rowDescription', this._rowDescription)
+  }
 }
 
 Cursor.prototype._rowDescription = function () {
@@ -37,6 +40,7 @@ Cursor.prototype._rowDescription = function () {
 }
 
 Cursor.prototype.submit = function (connection) {
+  this.state = 'submitted'
   this.connection = connection
   this._portal = 'C_' + nextUniqueID++
 
@@ -87,7 +91,12 @@ Cursor.prototype._closePortal = function () {
   // open can lock tables for modification if inside a transaction.
   // see https://github.com/brianc/node-pg-cursor/issues/56
   this.connection.close({ type: 'P', name: this._portal })
-  this.connection.sync()
+
+  // If we've received an error we already sent a sync message.
+  // do not send another sync as it triggers another readyForQuery message.
+  if (this.state !== 'error') {
+    this.connection.sync()
+  }
 }
 
 Cursor.prototype.handleRowDescription = function (msg) {
@@ -138,8 +147,18 @@ Cursor.prototype.handleEmptyQuery = function () {
 }
 
 Cursor.prototype.handleError = function (msg) {
-  this.connection.removeListener('noData', this._ifNoData)
-  this.connection.removeListener('rowDescription', this._rowDescription)
+  // If we're in an initialized state we've never been submitted
+  // and don't have a connection instance reference yet.
+  // This can happen if you queue a stream and close the client before
+  // the client has submitted the stream.  In this scenario we don't have
+  // a connection so there's nothing to unsubscribe from.
+  if (this.state !== 'initialized') {
+    this.connection.removeListener('noData', this._ifNoData)
+    this.connection.removeListener('rowDescription', this._rowDescription)
+    // call sync to trigger a readyForQuery
+    this.connection.sync()
+  }
+
   this.state = 'error'
   this._error = msg
   // satisfy any waiting callback
@@ -155,8 +174,6 @@ Cursor.prototype.handleError = function (msg) {
     // only dispatch error events if we have a listener
     this.emit('error', msg)
   }
-  // call sync to keep this connection from hanging
-  this.connection.sync()
 }
 
 Cursor.prototype._getRows = function (rows, cb) {
@@ -189,6 +206,7 @@ Cursor.prototype.close = function (cb) {
       return
     }
   }
+
   this._closePortal()
   this.state = 'done'
   if (cb) {
@@ -199,7 +217,7 @@ Cursor.prototype.close = function (cb) {
 }
 
 Cursor.prototype.read = function (rows, cb) {
-  if (this.state === 'idle') {
+  if (this.state === 'idle' || this.state === 'submitted') {
     return this._getRows(rows, cb)
   }
   if (this.state === 'busy' || this.state === 'initialized') {

packages/pg-cursor/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pg-cursor",
-  "version": "2.5.1",
+  "version": "2.6.0",
   "description": "Query cursor extension for node-postgres",
   "main": "index.js",
   "directories": {
@@ -11,12 +11,16 @@
   },
   "repository": {
     "type": "git",
-    "url": "git://github.com/brianc/node-postgres.git"
+    "url": "git://github.com/brianc/node-postgres.git",
+    "directory": "packages/pg-cursor"
   },
   "author": "Brian M. Carlson",
   "license": "MIT",
   "devDependencies": {
     "mocha": "^7.1.2",
-    "pg": "^8.5.1"
+    "pg": "^8.6.0"
+  },
+  "peerDependencies": {
+    "pg": "^8"
   }
 }

packages/pg-pool/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pg-pool",
-  "version": "3.2.2",
+  "version": "3.3.0",
   "description": "Connection pool for node-postgres",
   "main": "index.js",
   "directories": {
@@ -11,7 +11,8 @@
   },
   "repository": {
     "type": "git",
-    "url": "git://github.com/brianc/node-postgres.git"
+    "url": "git://github.com/brianc/node-postgres.git",
+    "directory": "packages/pg-pool"
   },
   "keywords": [
     "pg",

packages/pg-protocol/README.md

@@ -1,3 +1,3 @@
 # pg-protocol
 
-Low level postgres wire protocol parser and serailizer written in Typescript. Used by node-postgres. Needs more documentation. :smile:
+Low level postgres wire protocol parser and serializer written in Typescript. Used by node-postgres. Needs more documentation. :smile:

packages/pg-protocol/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pg-protocol",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "description": "The postgres client/server binary protocol, implemented in TypeScript",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -22,6 +22,11 @@
     "prepublish": "yarn build",
     "pretest": "yarn build"
   },
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/brianc/node-postgres.git",
+    "directory": "packages/pg-protocol"
+  },
   "files": [
     "/dist/*{js,ts,map}",
     "/src"

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

@@ -144,6 +144,35 @@ var expectedTwoRowMessage = {
   ],
 }
 
+var emptyParameterDescriptionBuffer = new BufferList()
+  .addInt16(0) // number of parameters
+  .join(true, 't')
+
+var oneParameterDescBuf = buffers.parameterDescription([1111])
+
+var twoParameterDescBuf = buffers.parameterDescription([2222, 3333])
+
+var expectedEmptyParameterDescriptionMessage = {
+  name: 'parameterDescription',
+  length: 6,
+  parameterCount: 0,
+  dataTypeIDs: [],
+}
+
+var expectedOneParameterMessage = {
+  name: 'parameterDescription',
+  length: 10,
+  parameterCount: 1,
+  dataTypeIDs: [1111],
+}
+
+var expectedTwoParameterMessage = {
+  name: 'parameterDescription',
+  length: 14,
+  parameterCount: 2,
+  dataTypeIDs: [2222, 3333],
+}
+
 var testForMessage = function (buffer: Buffer, expectedMessage: any) {
   it('recieves and parses ' + expectedMessage.name, async () => {
     const messages = await parseBuffers([buffer])
@@ -245,6 +274,12 @@ describe('PgPacketStream', function () {
     testForMessage(twoRowBuf, expectedTwoRowMessage)
   })
 
+  describe('parameterDescription messages', function () {
+    testForMessage(emptyParameterDescriptionBuffer, expectedEmptyParameterDescriptionMessage)
+    testForMessage(oneParameterDescBuf, expectedOneParameterMessage)
+    testForMessage(twoParameterDescBuf, expectedTwoParameterMessage)
+  })
+
   describe('parsing rows', function () {
     describe('parsing empty row', function () {
       testForMessage(emptyRowFieldBuf, {