chore: upgrade fork to upstream pg@8.20.0

.devcontainer/Dockerfile

@@ -3,7 +3,7 @@
 # Licensed under the MIT License. See https://go.microsoft.com/fwlink/?linkid=2090316 for license information.
 #-------------------------------------------------------------------------------------------------------------
 
-FROM node:20
+FROM node:22
 
 # Avoid warnings by switching to noninteractive
 ENV DEBIAN_FRONTEND=noninteractive
@@ -35,7 +35,7 @@ RUN apt-get update \
     && echo "deb https://dl.yarnpkg.com/$(lsb_release -is | tr '[:upper:]' '[:lower:]')/ stable main" | tee /etc/apt/sources.list.d/yarn.list \
     && apt-get update \
     && apt-get -y install --no-install-recommends yarn tmux locales postgresql \
-    && apt-get install libpq-dev g++ make \
+    && apt-get install libpq-dev python3 g++ make \
     #
     # Install eslint globally
     && npm install -g eslint \

.devcontainer/docker-compose.yml

@@ -39,7 +39,7 @@ services:
       - db:db
 
   db:
-    image: postgres:14-alpine
+    image: postgres:14
     restart: unless-stopped
     ports: 
       - 5432:5432

.eslintrc

@@ -1,7 +1,7 @@
 {
   "plugins": ["@typescript-eslint", "prettier"],
   "parser": "@typescript-eslint/parser",
-  "extends": ["plugin:prettier/recommended", "prettier"],
+  "extends": ["eslint:recommended", "plugin:prettier/recommended", "prettier"],
   "ignorePatterns": ["node_modules", "coverage", "packages/pg-protocol/dist/**/*", "packages/pg-query-stream/dist/**/*"],
   "parserOptions": {
     "ecmaVersion": 2017,
@@ -14,8 +14,22 @@
   },
   "rules": {
     "@typescript-eslint/no-unused-vars": ["error", {
-      "args": "none"
+      "args": "none",
+      "varsIgnorePattern": "^_$"
     }],
-    "no-unused-vars": "off"
-  }
+    "no-unused-vars": ["error", {
+      "args": "none",
+      "varsIgnorePattern": "^_$"
+    }],
+    "no-var": "error",
+    "prefer-const": "error"
+  },
+  "overrides": [
+    {
+      "files": ["*.ts", "*.mts", "*.cts", "*.tsx"],
+      "rules": {
+        "no-undef": "off"
+      }
+    }
+  ]
 }

.github/workflows/deploy-pg-protocol.yml

@@ -26,7 +26,7 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f # v6.3.0
         with:
-          node-version: '18'
+          node-version: '20'
           registry-url: 'https://registry.npmjs.org'
 
       - name: Install dependencies

.github/workflows/deploy-pg.yml

@@ -26,7 +26,7 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f # v6.3.0
         with:
-          node-version: '18'
+          node-version: '20'
           registry-url: 'https://registry.npmjs.org'
 
       - name: Install dependencies

.gitignore

@@ -9,4 +9,4 @@ dist
 .DS_Store
 /.eslintcache
 .vscode/
-manually-test-on-heroku.js
+manually-test-on-heroku.js

CHANGELOG.md

@@ -4,6 +4,31 @@ 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.20.0
+
+- Add [onConnect](https://github.com/brianc/node-postgres/pull/3620) callback to pg.Pool constructor options allowing for async initialization of newly created & connected pooled clients.
+
+## pg@8.19.0
+
+- [Deprecate interal query queue](https://github.com/brianc/node-postgres/pull/3603).
+- Pass connection parameters [to password callback](https://github.com/brianc/node-postgres/pull/3602).
+
+## pg@8.18.0
+
+- [Return the client instance](https://github.com/brianc/node-postgres/pull/3564) as the result of calling `connect` (previously it was `void`).
+
+## pg@8.17.0
+
+- Throw correct error if database URL parsing [fails](https://github.com/brianc/node-postgres/issues/3513).
+
+## pg@8.16.0
+
+- Add support for [min connection pool size](https://github.com/brianc/node-postgres/pull/3438).
+
+## pg@8.15.0
+
+- Add support for [esm](https://github.com/brianc/node-postgres/pull/3423) importing. CommonJS importing is still also supported.
+
 ## pg@8.14.0
 
 - Add support from SCRAM-SAH-256-PLUS i.e. [channel binding](https://github.com/brianc/node-postgres/pull/3356).

docs/README.md

@@ -0,0 +1,20 @@
+# node-postgres docs website
+
+This is the documentation for node-postgres which is currently hosted at [https://node-postgres.com](https://node-postgres.com).
+
+## Development
+
+To run the documentation locally, you need to have [Node.js](https://nodejs.org) installed. Then, you can clone the repository and install the dependencies:
+
+```bash
+cd docs
+yarn
+```
+
+Once you've installed the deps, you can run the development server:
+
+```bash
+yarn dev
+```
+
+This will start a local server at [http://localhost:3000](http://localhost:3000) where you can view the documentation and see your changes.

docs/components/alert.tsx

@@ -1,5 +1,4 @@
-import React from 'react'
-import { Callout } from 'nextra-theme-docs'
+import { Callout } from 'nextra/components'
 
 export const Alert = ({ children }) => {
   return (

docs/components/info.tsx

@@ -1,5 +1,4 @@
-import React from 'react'
-import { Callout } from 'nextra-theme-docs'
+import { Callout } from 'nextra/components'
 
 export const Info = ({ children }) => {
   return <Callout emoji="ℹ️">{children}</Callout>

docs/components/logo.tsx

@@ -0,0 +1,9 @@
+type Props = {
+  src: string
+  alt?: string
+}
+
+export function Logo(props: Props) {
+  const alt = props.alt || 'Logo'
+  return <img src={props.src} alt={alt} width={100} height={100} style={{ width: 400, height: 'auto' }} />
+}

docs/next.config.js

@@ -1,8 +1,11 @@
-// next.config.js
-const withNextra = require('nextra')({
+import nextra from 'nextra'
+
+const withNextra = nextra({
   theme: 'nextra-theme-docs',
   themeConfig: './theme.config.js',
-  // optional: add `unstable_staticImage: true` to enable Nextra's auto image import
 })
 
-module.exports = withNextra()
+export default withNextra({
+  output: 'export',
+  images: { unoptimized: true },
+})

docs/package.json

@@ -3,18 +3,20 @@
   "version": "1.0.0",
   "description": "",
   "main": "next.config.js",
+  "type": "module",
   "scripts": {
-    "start": "next dev",
-    "build": "next build && next export"
+    "dev": "next dev",
+    "build": "next build"
   },
   "keywords": [],
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "next": "^15.5.10",
-    "nextra": "2.0.0-beta.29",
-    "nextra-theme-docs": "2.0.0-beta.29",
-    "react": "^17.0.1",
-    "react-dom": "^17.0.1"
+    "next": "^13.5.11",
+    "nextra": "^3.3.1",
+    "nextra-theme-docs": "^3.3.1",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
+    "typescript": "^5.0.2"
   }
 }

docs/pages/_app.js

@@ -1,9 +1,5 @@
 import 'nextra-theme-docs/style.css'
 
 export default function Nextra({ Component, pageProps }) {
-  return (
-    <>
-      <Component {...pageProps} />
-    </>
-  )
+  return <Component {...pageProps} />
 }

docs/pages/_meta.js

@@ -0,0 +1,5 @@
+export default {
+  index: 'Welcome',
+  announcements: 'Announcements',
+  apis: 'API',
+}

docs/pages/apis/_meta.js

@@ -0,0 +1,8 @@
+export default {
+  client: 'pg.Client',
+  pool: 'pg.Pool',
+  result: 'pg.Result',
+  types: 'pg.Types',
+  cursor: 'Cursor',
+  utilities: 'Utilities',
+}

docs/pages/apis/client.mdx

@@ -23,15 +23,20 @@ type Config = {
   lock_timeout?: number, // number of milliseconds a query is allowed to be en lock state before it's cancelled due to lock timeout
   application_name?: string, // The name of the application that created this Client instance
   connectionTimeoutMillis?: number, // number of milliseconds to wait for connection, default is no timeout
-  idle_in_transaction_session_timeout?: number // number of milliseconds before terminating any session with an open idle transaction, default is no timeout
+  keepAlive?: boolean, // if true, enable keepalive on the `net.Socket`
+  keepAliveInitialDelayMillis?: number, // number of milliseconds between last data packet received and first keepalive probe, default is 0 (keep existing value);
+                                        // no effect unless `keepAlive` is true
+  idle_in_transaction_session_timeout?: number, // number of milliseconds before terminating any session with an open idle transaction, default is no timeout
+  client_encoding?: string, // specifies the character set encoding that the database uses for sending data to the client
+  fallback_application_name?: string, // provide an application name to use if application_name is not set
+  options?: string // command-line options to be sent to the server
 }
 ```
 
 example to create a client with specific connection information:
 
 ```js
-import pg from 'pg'
-const { Client } = pg
+import { Client } from 'pg'
 
 const client = new Client({
   user: 'database-user',
@@ -45,8 +50,7 @@ const client = new Client({
 ## client.connect
 
 ```js
-import pg from 'pg'
-const { Client } = pg
+import { Client } from 'pg'
 const client = new Client()
 
 await client.connect()
@@ -88,8 +92,7 @@ client.query(text: string, values?: any[]) => Promise<Result>
 **Plain text query**
 
 ```js
-import pg from 'pg'
-const { Client } = pg
+import { Client } from 'pg'
 const client = new Client()
 
 await client.connect()
@@ -103,8 +106,7 @@ await client.end()
 **Parameterized query**
 
 ```js
-import pg from 'pg'
-const { Client } = pg
+import { Client } from 'pg'
 const client = new Client()
 
 await client.connect()
@@ -142,8 +144,7 @@ await client.end()
 If you pass an object to `client.query` and the object has a `.submit` function on it, the client will pass it's PostgreSQL server connection to the object and delegate query dispatching to the supplied object. This is an advanced feature mostly intended for library authors. It is incidentally also currently how the callback and promise based queries above are handled internally, but this is subject to change. It is also how [pg-cursor](https://github.com/brianc/node-pg-cursor) and [pg-query-stream](https://github.com/brianc/node-pg-query-stream) work.
 
 ```js
-import pg from 'pg'
-const { Query } = pg
+import { Query } from 'pg'
 const query = new Query('select $1::text as name', ['brianc'])
 
 const result = client.query(query)

docs/pages/apis/cursor.mdx

@@ -18,8 +18,7 @@ $ npm install pg pg-cursor
 Instantiates a new Cursor. A cursor is an instance of `Submittable` and should be passed directly to the `client.query` method.
 
 ```js
-import pg from 'pg'
-const { Pool } = pg
+import { Pool } from 'pg'
 import Cursor from 'pg-cursor'
 
 const pool = new Pool()
@@ -29,11 +28,9 @@ const values = [10]
 
 const cursor = client.query(new Cursor(text, values))
 
-cursor.read(100, (err, rows) => {
-  cursor.close(() => {
-    client.release()
-  })
-})
+const { rows } = await cursor.read(100)
+console.log(rows.length) // 100 (unless the table has fewer than 100 rows)
+client.release()
 ```
 
 ```ts
@@ -58,8 +55,7 @@ If the cursor has read to the end of the result sets all subsequent calls to cur
 Here is an example of reading to the end of a cursor:
 
 ```js
-import pg from 'pg'
-const { Pool } = pg
+import { Pool } from 'pg'
 import Cursor from 'pg-cursor'
 
 const pool = new Pool()