@steadybrew/postgresjs 4.4.0 → 4.4.1

package/README.md

@@ -592,7 +592,7 @@ for await (const chunk of readableStream) {
 
 > **NOTE** This is a low-level API which does not provide any type safety. To make this work, you must match your [`copy query` parameters](https://www.postgresql.org/docs/14/sql-copy.html) correctly to your [Node.js stream read or write](https://nodejs.org/api/stream.html) code. Ensure [Node.js stream backpressure](https://nodejs.org/en/learn/modules/backpressuring-in-streams) is handled correctly to avoid memory exhaustion.
 
-A `COPY` holds its connection until it finishes. Postgres.js cannot tell that a simple-protocol query is a `COPY` until the server answers, so it sends nothing behind a simple query whose text contains the word `copy` (`sql.unsafe()` or `sql.file()` without parameters, `.simple()`, `.readable()`, `.writable()`). Queries sent through `sql` meanwhile run on another connection or wait for one. With `max: 1`, or when every connection is running a `COPY`, a query awaited before the `COPY` is ended therefore waits forever. Statements on a `sql.reserve()` or `sql.begin()` handle reject with `COPY_IN_PROGRESS` while its `COPY` runs.
+A `COPY` holds its connection until it finishes. Postgres.js cannot tell that a simple-protocol query is a `COPY` until the server answers, so it sends nothing behind a simple query whose text contains the word `copy` (`sql.unsafe()` or `sql.file()` without parameters, `.simple()`, `.readable()`, `.writable()`). Queries sent through `sql` meanwhile run on another connection or wait for one. When every connection is running a `COPY` that has not been ended, for example with `max: 1`, queries, `sql.reserve()` and `sql.begin()` through `sql` reject with `COPY_IN_PROGRESS` instead, because only that `COPY` finishing could free a connection. Statements on a `sql.reserve()` or `sql.begin()` handle reject with `COPY_IN_PROGRESS` while its `COPY` runs.
 
 ### Canceling Queries in Progress
 
@@ -1468,7 +1468,7 @@ If the only attempt times out, the error is `CONNECT_TIMEOUT`. Once earlier atte
 ##### COPY_IN_PROGRESS
 > You cannot execute queries during copy
 
-This error is thrown for a statement on a `sql.reserve()` or `sql.begin()` handle while its copy operation (writable / readable) runs, including statements sent before the server started it. Queries through `sql` wait instead.
+This error is thrown for a statement on a `sql.reserve()` or `sql.begin()` handle while its copy operation (writable / readable) runs, including statements sent before the server started it. A query, `sql.reserve()` or `sql.begin()` through `sql` gets it when every connection is running a copy operation whose writable has not been ended; otherwise it waits for a connection.
 
 ##### TRANSACTION_ROLLED_BACK
 > The server rolled the transaction back instead of committing it

package/cf/src/connection.js

@@ -231,6 +231,7 @@ function Connection(options, queues = {}, { onopen = noop, onend = noop, onclose
     get pipelined() { return sent.length },
     get accepting() { return accepting() },
     get copying() { return stream !== null },
+    get copyHeld() { return stream !== null && !stream.writableEnded },
     get acquiring() { return acquisition && !acquisition.owner.cancelled ? 1 : 0 },
     count: 0,
     id

package/cf/src/index.js

@@ -274,7 +274,9 @@ function Postgres(a, b) {
           const query = { reserve: c => resolve(own(c, l)), reject }
           closed.length
             ? connect(closed.shift(), query)
-            : queries.push(query)
+            : allHeldByCopy()
+              ? reject(copyInProgress())
+              : queries.push(query)
         })
     return l
   }
@@ -463,7 +465,17 @@ function Postgres(a, b) {
     const c = takeBusy()
     c
       ? go(c, query)
-      : queries.push(query)
+      : allHeldByCopy()
+        ? query.reject(copyInProgress())
+        : queries.push(query)
+  }
+
+  function allHeldByCopy() {
+    return connections.every(c => c.copyHeld)
+  }
+
+  function copyInProgress() {
+    return Errors.generic('COPY_IN_PROGRESS', 'You cannot execute queries during copy')
   }
 
   function takeBusy() {

package/cf/src/subscribe.js

@@ -4,6 +4,7 @@ import { defaultBackoff, backoffSeconds } from './connection.js'
 
 const noop = () => { /* noop */ }
     , commands = { 68: 'delete', 73: 'insert', 85: 'update' }
+    , statusInterval = 1000
 
 export default function Subscribe(postgres, options) {
   const subscribers = new Map()
@@ -152,6 +153,10 @@ export default function Subscribe(postgres, options) {
     stream.on('error', reportConnection)
     stream.on('close', sql.close)
 
+    // A walsender can miss the wakeup for a commit and sleep until its timeout; a status update wakes it.
+    const status = setInterval(() => stream.writable && pong(), statusInterval)
+    stream.on('close', () => clearInterval(status))
+
     return { stream, state: xs.state }
 
     function data(x) {

package/cjs/src/connection.js

@@ -229,6 +229,7 @@ function Connection(options, queues = {}, { onopen = noop, onend = noop, onclose
     get pipelined() { return sent.length },
     get accepting() { return accepting() },
     get copying() { return stream !== null },
+    get copyHeld() { return stream !== null && !stream.writableEnded },
     get acquiring() { return acquisition && !acquisition.owner.cancelled ? 1 : 0 },
     count: 0,
     id

package/cjs/src/index.js

@@ -273,7 +273,9 @@ function Postgres(a, b) {
           const query = { reserve: c => resolve(own(c, l)), reject }
           closed.length
             ? connect(closed.shift(), query)
-            : queries.push(query)
+            : allHeldByCopy()
+              ? reject(copyInProgress())
+              : queries.push(query)
         })
     return l
   }
@@ -462,7 +464,17 @@ function Postgres(a, b) {
     const c = takeBusy()
     c
       ? go(c, query)
-      : queries.push(query)
+      : allHeldByCopy()
+        ? query.reject(copyInProgress())
+        : queries.push(query)
+  }
+
+  function allHeldByCopy() {
+    return connections.every(c => c.copyHeld)
+  }
+
+  function copyInProgress() {
+    return Errors.generic('COPY_IN_PROGRESS', 'You cannot execute queries during copy')
   }
 
   function takeBusy() {

package/cjs/src/subscribe.js

@@ -3,6 +3,7 @@ const { defaultBackoff, backoffSeconds } = require('./connection.js')
 
 const noop = () => { /* noop */ }
     , commands = { 68: 'delete', 73: 'insert', 85: 'update' }
+    , statusInterval = 1000
 
 module.exports = Subscribe;function Subscribe(postgres, options) {
   const subscribers = new Map()
@@ -151,6 +152,10 @@ module.exports = Subscribe;function Subscribe(postgres, options) {
     stream.on('error', reportConnection)
     stream.on('close', sql.close)
 
+    // A walsender can miss the wakeup for a commit and sleep until its timeout; a status update wakes it.
+    const status = setInterval(() => stream.writable && pong(), statusInterval)
+    stream.on('close', () => clearInterval(status))
+
     return { stream, state: xs.state }
 
     function data(x) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@steadybrew/postgresjs",
-  "version": "4.4.0",
+  "version": "4.4.1",
   "description": "PostgreSQL client for Node.js and Deno, independently maintained by Steady Brew",
   "type": "module",
   "module": "src/index.js",

package/src/connection.js

@@ -229,6 +229,7 @@ function Connection(options, queues = {}, { onopen = noop, onend = noop, onclose
     get pipelined() { return sent.length },
     get accepting() { return accepting() },
     get copying() { return stream !== null },
+    get copyHeld() { return stream !== null && !stream.writableEnded },
     get acquiring() { return acquisition && !acquisition.owner.cancelled ? 1 : 0 },
     count: 0,
     id

package/src/index.js

@@ -273,7 +273,9 @@ function Postgres(a, b) {
           const query = { reserve: c => resolve(own(c, l)), reject }
           closed.length
             ? connect(closed.shift(), query)
-            : queries.push(query)
+            : allHeldByCopy()
+              ? reject(copyInProgress())
+              : queries.push(query)
         })
     return l
   }
@@ -462,7 +464,17 @@ function Postgres(a, b) {
     const c = takeBusy()
     c
       ? go(c, query)
-      : queries.push(query)
+      : allHeldByCopy()
+        ? query.reject(copyInProgress())
+        : queries.push(query)
+  }
+
+  function allHeldByCopy() {
+    return connections.every(c => c.copyHeld)
+  }
+
+  function copyInProgress() {
+    return Errors.generic('COPY_IN_PROGRESS', 'You cannot execute queries during copy')
   }
 
   function takeBusy() {

package/src/subscribe.js

@@ -3,6 +3,7 @@ import { defaultBackoff, backoffSeconds } from './connection.js'
 
 const noop = () => { /* noop */ }
     , commands = { 68: 'delete', 73: 'insert', 85: 'update' }
+    , statusInterval = 1000
 
 export default function Subscribe(postgres, options) {
   const subscribers = new Map()
@@ -151,6 +152,10 @@ export default function Subscribe(postgres, options) {
     stream.on('error', reportConnection)
     stream.on('close', sql.close)
 
+    // A walsender can miss the wakeup for a commit and sleep until its timeout; a status update wakes it.
+    const status = setInterval(() => stream.writable && pong(), statusInterval)
+    stream.on('close', () => clearInterval(status))
+
     return { stream, state: xs.state }
 
     function data(x) {