Merge remote-tracking branch 'origin/master' into bmc/perf/faster-bind

Author: brianc

.travis.yml

@@ -57,6 +57,10 @@ matrix:
       addons:
         postgresql: '9.6'
 
+    # only run lint on latest Node LTS
+    - node_js: lts/*
+      script: yarn lint
+
     # PostgreSQL 9.2 only works on precise
     - node_js: lts/carbon
       addons:

.yarnrc

@@ -0,0 +1 @@
+--install.ignore-engines true

CHANGELOG.md

@@ -4,6 +4,12 @@ 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]
+
+- 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).
+
 ### [email protected]
 
 - Support passing a [string of command line options flags](https://github.com/brianc/node-postgres/pull/2216) via the `{ options: string }` field on client/pool config.

README.md

@@ -5,7 +5,7 @@
 <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>
 
-Non-blocking PostgreSQL client for Node.js.  Pure JavaScript and optional native libpq bindings.
+Non-blocking PostgreSQL client for Node.js. Pure JavaScript and optional native libpq bindings.
 
 ## Monorepo
 
@@ -16,35 +16,36 @@ This repo is a monorepo which contains the core [pg](https://github.com/brianc/n
 - [pg-cursor](https://github.com/brianc/node-postgres/tree/master/packages/pg-cursor)
 - [pg-query-stream](https://github.com/brianc/node-postgres/tree/master/packages/pg-query-stream)
 - [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)
 
+## Documentation
 
-## Documenation
-
-Each package in this repo should have it's 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:
+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:
 
 ### :star: [Documentation](https://node-postgres.com) :star:
 
 ### Features
 
-* Pure JavaScript client and native libpq bindings share _the same API_
-* Connection pooling
-* Extensible JS ↔ PostgreSQL data-type coercion
-* Supported PostgreSQL features
-  * Parameterized queries
-  * Named statements with query plan caching
-  * Async notifications with `LISTEN/NOTIFY`
-  * Bulk import & export with `COPY TO/COPY FROM`
+- Pure JavaScript client and native libpq bindings share _the same API_
+- Connection pooling
+- Extensible JS ↔ PostgreSQL data-type coercion
+- Supported PostgreSQL features
+  - Parameterized queries
+  - Named statements with query plan caching
+  - Async notifications with `LISTEN/NOTIFY`
+  - Bulk import & export with `COPY TO/COPY FROM`
 
 ### Extras
 
-node-postgres is by design pretty light on abstractions.  These are some handy modules we've been using over the years to complete the picture.
+node-postgres is by design pretty light on abstractions. These are some handy modules we've been using over the years to complete the picture.
 The entire list can be found on our [wiki](https://github.com/brianc/node-postgres/wiki/Extras).
 
 ## Support
 
-node-postgres is free software.  If you encounter a bug with the library please open an issue on the [GitHub repo](https://github.com/brianc/node-postgres). If you have questions unanswered by the documentation please open an issue pointing out how the documentation was unclear & I will do my best to make it better!
+node-postgres is free software. If you encounter a bug with the library please open an issue on the [GitHub repo](https://github.com/brianc/node-postgres). If you have questions unanswered by the documentation please open an issue pointing out how the documentation was unclear & I will do my best to make it better!
 
 When you open an issue please provide:
+
 - version of Node
 - version of Postgres
 - smallest possible snippet of code to reproduce the problem
@@ -56,10 +57,6 @@ 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://www.timescale.com" target="_blank">
-  <img height="80" src="https://node-postgres.com/timescale.svg" />
-</a>
-<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAABCAQAAAB0m0auAAAADElEQVR42mNkIBIAAABSAAI2VLqiAAAAAElFTkSuQmCC" />
 <a href="https://crate.io" target="_blank">
   <img height="80" src="https://node-postgres.com/crate-io.png" />
 </a>
@@ -69,10 +66,11 @@ If you or your company are benefiting from node-postgres and would like to help
 
 ## Contributing
 
-__:heart: contributions!__
+**:heart: contributions!**
+
+I will **happily** accept your pull request if it:
 
-I will __happily__ accept your pull request if it:
-- __has tests__
+- **has tests**
 - looks reasonable
 - does not break backwards compatibility
 
@@ -94,20 +92,20 @@ The causes and solutions to common errors can be found among the [Frequently Ask
 
 Copyright (c) 2010-2020 Brian Carlson ([email protected])
 
- Permission is hereby granted, free of charge, to any person obtaining a copy
- of this software and associated documentation files (the "Software"), to deal
- in the Software without restriction, including without limitation the rights
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- copies of the Software, and to permit persons to whom the Software is
- furnished to do so, subject to the following conditions:
-
- The above copyright notice and this permission notice shall be included in
- all copies or substantial portions of the Software.
-
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
- THE SOFTWARE.
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

SPONSORS.md

@@ -31,3 +31,4 @@ node-postgres is made possible by the helpful contributors from the community as
 - Raul Murray
 - Simple Analytics
 - Trevor Linton
+- Ian Walter

package.json

@@ -10,22 +10,20 @@
     "packages/*"
   ],
   "scripts": {
-    "test": "yarn lint && yarn lerna exec yarn test",
+    "test": "yarn lerna exec yarn test",
     "build": "yarn lerna exec --scope pg-protocol yarn build",
     "pretest": "yarn build",
-    "lint": "if [ -x ./node_modules/.bin/prettier ]; then eslint '*/**/*.{js,ts,tsx}'; fi;"
+    "lint": "eslint '*/**/*.{js,ts,tsx}'"
   },
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "^2.27.0",
-    "@typescript-eslint/parser": "^2.27.0",
-    "eslint": "^6.8.0",
-    "eslint-config-prettier": "^6.10.1",
+    "@typescript-eslint/eslint-plugin": "^4.4.0",
+    "@typescript-eslint/parser": "^4.4.0",
+    "eslint": "^7.11.0",
+    "eslint-config-prettier": "^6.12.0",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-prettier": "^3.1.2",
-    "lerna": "^3.19.0"
-  },
-  "optionalDependencies": {
-    "prettier": "2.0.4"
+    "eslint-plugin-prettier": "^3.1.4",
+    "lerna": "^3.19.0",
+    "prettier": "2.1.2"
   },
   "prettier": {
     "semi": false,

packages/pg-connection-string/index.js

@@ -65,7 +65,7 @@ function parse(str) {
     config.ssl = false
   }
 
-  if (config.sslcert || config.sslkey || config.sslrootcert) {
+  if (config.sslcert || config.sslkey || config.sslrootcert || config.sslmode) {
     config.ssl = {}
   }
 
@@ -81,6 +81,23 @@ function parse(str) {
     config.ssl.ca = fs.readFileSync(config.sslrootcert).toString()
   }
 
+  switch (config.sslmode) {
+    case 'disable': {
+      config.ssl = false
+      break
+    }
+    case 'prefer':
+    case 'require':
+    case 'verify-ca':
+    case 'verify-full': {
+      break
+    }
+    case 'no-verify': {
+      config.ssl.rejectUnauthorized = false
+      break
+    }
+  }
+
   return config
 }
 

packages/pg-connection-string/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pg-connection-string",
-  "version": "2.3.0",
+  "version": "2.4.0",
   "description": "Functions for dealing with a PostgresSQL connection string",
   "main": "./index.js",
   "types": "./index.d.ts",
@@ -22,9 +22,9 @@
   "author": "Blaine Bublitz <[email protected]> (http://iceddev.com/)",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/iceddev/pg-connection-string/issues"
+    "url": "https://github.com/brianc/node-postgres/issues"
   },
-  "homepage": "https://github.com/iceddev/pg-connection-string",
+  "homepage": "https://github.com/brianc/node-postgres/tree/master/packages/pg-connection-string",
   "devDependencies": {
     "chai": "^4.1.1",
     "coveralls": "^3.0.4",

packages/pg-connection-string/test/parse.js

@@ -241,6 +241,52 @@ describe('parse', function () {
     })
   })
 
+  it('configuration parameter sslmode=no-verify', function () {
+    var connectionString = 'pg:///?sslmode=no-verify'
+    var subject = parse(connectionString)
+    subject.ssl.should.eql({
+      rejectUnauthorized: false,
+    })
+  })
+
+  it('configuration parameter sslmode=disable', function () {
+    var connectionString = 'pg:///?sslmode=disable'
+    var subject = parse(connectionString)
+    subject.ssl.should.eql(false)
+  })
+
+  it('configuration parameter sslmode=prefer', function () {
+    var connectionString = 'pg:///?sslmode=prefer'
+    var subject = parse(connectionString)
+    subject.ssl.should.eql({})
+  })
+
+  it('configuration parameter sslmode=require', function () {
+    var connectionString = 'pg:///?sslmode=require'
+    var subject = parse(connectionString)
+    subject.ssl.should.eql({})
+  })
+
+  it('configuration parameter sslmode=verify-ca', function () {
+    var connectionString = 'pg:///?sslmode=verify-ca'
+    var subject = parse(connectionString)
+    subject.ssl.should.eql({})
+  })
+
+  it('configuration parameter sslmode=verify-full', function () {
+    var connectionString = 'pg:///?sslmode=verify-full'
+    var subject = parse(connectionString)
+    subject.ssl.should.eql({})
+  })
+
+  it('configuration parameter ssl=true and sslmode=require still work with sslrootcert=/path/to/ca', function () {
+    var connectionString = 'pg:///?ssl=true&sslrootcert=' + __dirname + '/example.ca&sslmode=require'
+    var subject = parse(connectionString)
+    subject.ssl.should.eql({
+      ca: 'example ca\n',
+    })
+  })
+
   it('allow other params like max, ...', function () {
     var subject = parse('pg://myhost/db?max=18&min=4')
     subject.max.should.equal('18')

packages/pg-cursor/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pg-cursor",
-  "version": "2.3.0",
+  "version": "2.4.2",
   "description": "Query cursor extension for node-postgres",
   "main": "index.js",
   "directories": {
@@ -17,6 +17,6 @@
   "license": "MIT",
   "devDependencies": {
     "mocha": "^7.1.2",
-    "pg": "^8.3.0"
+    "pg": "^8.4.2"
   }
 }

packages/pg-pool/index.js

@@ -73,6 +73,13 @@ class Pool extends EventEmitter {
         value: options.password,
       })
     }
+    if (options != null && options.ssl && options.ssl.key) {
+      // "hiding" the ssl->key so it doesn't show up in stack traces
+      // or if the client is console.logged
+      Object.defineProperty(this.options.ssl, 'key', {
+        enumerable: false,
+      })
+    }
 
     this.options.max = this.options.max || this.options.poolSize || 10
     this.options.maxUses = this.options.maxUses || Infinity

packages/pg-pool/package.json

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

packages/pg-protocol/README.md

@@ -0,0 +1,3 @@
+# pg-protocol
+
+Low level postgres wire protocol parser and serailizer 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.2.5",
+  "version": "1.3.0",
   "description": "The postgres client/server binary protocol, implemented in TypeScript",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

packages/pg-protocol/src/index.ts

@@ -1,4 +1,4 @@
-import { BackendMessage } from './messages'
+import { BackendMessage, DatabaseError } from './messages'
 import { serialize } from './serializer'
 import { Parser, MessageCallback } from './parser'
 
@@ -8,4 +8,4 @@ export function parse(stream: NodeJS.ReadableStream, callback: MessageCallback):
   return new Promise((resolve) => stream.on('end', () => resolve()))
 }
 
-export { serialize }
+export { serialize, DatabaseError }

packages/pg-query-stream/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pg-query-stream",
-  "version": "3.2.0",
+  "version": "3.3.2",
   "description": "Postgres query result returned as readable stream",
   "main": "index.js",
   "scripts": {
@@ -26,12 +26,12 @@
     "concat-stream": "~1.0.1",
     "eslint-plugin-promise": "^3.5.0",
     "mocha": "^7.1.2",
-    "pg": "^8.3.0",
+    "pg": "^8.4.2",
     "stream-spec": "~0.3.5",
     "stream-tester": "0.0.5",
     "through": "~2.3.4"
   },
   "dependencies": {
-    "pg-cursor": "^2.3.0"
+    "pg-cursor": "^2.4.2"
   }
 }