pg-promise 10.9.3 → 10.10.2

package/README.md

@@ -5,7 +5,6 @@ PostgreSQL interface for Node.js
 
 [![Build Status](https://travis-ci.org/vitaly-t/pg-promise.svg?branch=master)](https://travis-ci.org/vitaly-t/pg-promise)
 [![Join the chat at https://gitter.im/vitaly-t/pg-promise](https://img.shields.io/gitter/room/vitaly-t/pg-promise.svg)](https://gitter.im/vitaly-t/pg-promise?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-[![xscode](https://img.shields.io/badge/Available%20on-xs%3Acode-blue?style=?style=plastic&logo=appveyor&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAMAAACdt4HsAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAAZQTFRF////////VXz1bAAAAAJ0Uk5T/wDltzBKAAAAlUlEQVR42uzXSwqAMAwE0Mn9L+3Ggtgkk35QwcnSJo9S+yGwM9DCooCbgn4YrJ4CIPUcQF7/XSBbx2TEz4sAZ2q1RAECBAiYBlCtvwN+KiYAlG7UDGj59MViT9hOwEqAhYCtAsUZvL6I6W8c2wcbd+LIWSCHSTeSAAECngN4xxIDSK9f4B9t377Wd7H5Nt7/Xz8eAgwAvesLRjYYPuUAAAAASUVORK5CYII=)](https://xscode.com/vitaly-tomilov/pg-promise)
 
 ---
 
@@ -60,11 +59,9 @@ only its tiny part.
 
 # Support & Sponsorship  
 
-For paid support and sponsorship, see [pg-promise on xscode...](https://xscode.com/vitaly-tomilov/pg-promise)
+I do free support here and on [StackOverflow](https://stackoverflow.com/questions/tagged/pg-promise).
 
-<a href='https://xscode.com/vitaly-tomilov/pg-promise'><img alt='Click here for support and sponsorship.' src='https://github.com/vitaly-t/pg-promise/raw/master/jsdoc/pg-promise-banner.png' border='0' ></a>
-
-We also do free support here and on [StackOverflow](https://stackoverflow.com/questions/tagged/pg-promise).
+And if you want to help this project, I can accept Bitcoin: `1yki7MXMkuDw8qqe5icVdh1GJZSQSzKZp`
 
 # Documentation
 

package/lib/connect.js

@@ -37,7 +37,10 @@ function poolConnect(ctx, db, config) {
                 reject(err);
             } else {
                 if (`$useCount` in client) {
-                    client.$useCount++;
+                    // Make sure useCount drops to 1, if it ever reaches maximum integer number;
+                    // We do not drop it to zero, to avoid rerun of initialization queries that
+                    // usually check for useCount === 0;
+                    client.$useCount = client.$useCount >= Number.MAX_SAFE_INTEGER ? 1 : ++client.$useCount;
                 } else {
                     Object.defineProperty(client, `$useCount`, {
                         value: 0,
@@ -86,9 +89,10 @@ function directConnect(ctx, config) {
                     useCount: 0,
                     release() {
                         client.end = end;
-                        client.end();
+                        const p = config.promise((res, rej) => client.end().then(res).catch(rej));
                         Events.disconnect(ctx, client);
                         client.removeListener(`error`, onError);
+                        return p;
                     }
                 });
                 Events.connect(ctx, client, 0);

package/lib/context.js

@@ -59,8 +59,9 @@ class ConnectionContext {
 
     disconnect(kill) {
         if (this.db) {
-            this.db.release(kill);
+            const p = this.db.release(kill);
             this.db = null;
+            return p;
         }
     }
 
@@ -73,13 +74,13 @@ class ConnectionContext {
 
     get nextTxCount() {
         let txCurrent = this, txTop = this;
-        while(txCurrent.parent) {
+        while (txCurrent.parent) {
             txCurrent = txCurrent.parent;
-            if(txCurrent.taskCtx && txCurrent.taskCtx.isTX) {
+            if (txCurrent.taskCtx && txCurrent.taskCtx.isTX) {
                 txTop = txCurrent;
             }
         }
-        return txTop.txCount ++;
+        return txTop.txCount++;
     }
 }
 

package/lib/database.js

@@ -147,7 +147,7 @@ function Database(cn, dc, config) {
      * in the end of the chain by calling `done()` on the connection object.
      *
      * Method `done` takes one optional parameter - boolean `kill` flag, to signal the connection pool that you want it to kill
-     * the physical connection. This flag is ignored for direct connections, as they always auto-close when released.
+     * the physical connection. This flag is ignored for direct connections, as they always close when released.
      *
      * It should not be used just for chaining queries on the same connection, methods {@link Database#task task} and
      * {@link Database#tx tx} (for transactions) are to be used for that. This method is primarily for special cases, like
@@ -167,6 +167,9 @@ function Database(cn, dc, config) {
      * By default, all connections are acquired from the connection pool. But if you set this option, the library will instead
      * create a new {@link external:Client Client} object directly (separately from the pool), and then call its `connect` method.
      *
+     * Note that specifically for direct connections, method `done` returns a {@link external:Promise Promise}, because those connections
+     * are closed physically, which may take time.
+     *
      * **WARNING:**
      *
      * Do not use this option for regular query execution, because it exclusively occupies one physical channel, and it cannot scale.
@@ -199,7 +202,8 @@ function Database(cn, dc, config) {
      * A promise object that represents the connection result:
      *  - resolves with the complete {@link Database} protocol, extended with:
      *    - property `client` of type {@link external:Client Client} that represents the open connection
-     *    - method `done` that must be called in the end, in order to release the connection
+     *    - method `done` that must be called in the end, in order to release the connection (returns a {@link external:Promise Promise}
+     *      in case of direct connections)
      *    - methods `batch`, `page` and `sequence`, same as inside a {@link Task}
      *  - rejects with a connection-related error when it fails to connect.
      *
@@ -253,7 +257,7 @@ function Database(cn, dc, config) {
                 if (!ctx.db) {
                     throw new Error(npm.text.looseQuery);
                 }
-                ctx.disconnect(kill);
+                return ctx.disconnect(kill);
             },
             batch(values, opt) {
                 return config.$npm.spex.batch.call(this, values, opt);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pg-promise",
-  "version": "10.9.3",
+  "version": "10.10.2",
   "description": "PostgreSQL interface for Node.js",
   "main": "lib/index.js",
   "typings": "typescript/pg-promise.d.ts",
@@ -41,22 +41,21 @@
   },
   "dependencies": {
     "assert-options": "0.7.0",
-    "pg": "8.5.1",
+    "pg": "8.6.0",
     "pg-minify": "1.6.2",
-    "pg-native": "^3.0.0",
     "spex": "3.2.0"
   },
   "devDependencies": {
-    "@types/node": "14.14.31",
+    "@types/node": "15.0.1",
     "bluebird": "3.7.2",
     "coveralls": "3.1.0",
-    "eslint": "7.21.0",
+    "eslint": "7.25.0",
     "istanbul": "0.4.5",
     "jasmine-node": "3.0.0",
     "jsdoc": "3.6.6",
     "JSONStream": "1.3.5",
-    "pg-query-stream": "4.0.0",
+    "pg-query-stream": "4.1.0",
     "tslint": "6.1.3",
-    "typescript": "4.2.2"
+    "typescript": "4.2.4"
   }
 }

package/typescript/README.MD

@@ -1,6 +1,6 @@
 ## TypeScript for pg-promise
 
-Complete TypeScript 3.x (`strict` mode) declarations for [pg-promise].
+Complete TypeScript declarations for [pg-promise].
 
 ### Inclusion
 
@@ -14,12 +14,14 @@ import * as pgPromise from 'pg-promise';
 const pgp = pgPromise({/* Initialization Options */});
 
 const db = pgp('postgres://username:password@host:port/database');
+
+const {value} = await db.one('SELECT 123 as value');
 ```
 
 #### With Extensions
 
 The library supports dynamic protocol extensions, via event [extend], which requires
-explicit extension interface to be declared, and parameterized as shown below.
+explicit extension interface to be declared and parameterized, as shown below.
 
 ```ts
 import * as pgPromise from 'pg-promise';
@@ -33,7 +35,7 @@ interface IExtensions {
 const options: pgPromise.IInitOptions<IExtensions> = {
     extend(obj) {
         obj.findUser = userId => {
-            return obj.one('SELECT * FROM Users WHERE id = $1', userId);
+            return obj.one('SELECT * FROM Users WHERE id = $1', [userId]);
         }
     }
 };
@@ -44,11 +46,17 @@ const pgp = pgPromise(options);
 // database object:
 const db = pgp('postgres://username:password@host:port/database');
 
-// now you can use the extensions everywhere (including tasks and transactions):
-db.findUser(123).then(...);
+// protocol is extended on each level:
+const user = await db.findUser(123);
+
+// ...including inside tasks and transactions:
+await db.task(async t => {
+    const user = await t.findUser(123);
+    // ...etc
+});
 ```
 
-For a complete and comprehensive example, check out [pg-promise-demo].
+For a comprehensive example, check out [pg-promise-demo].
 
 [pg-promise-demo]:https://github.com/vitaly-t/pg-promise-demo
 [extend]:http://vitaly-t.github.io/pg-promise/global.html#event:extend

package/typescript/pg-promise.d.ts

@@ -413,7 +413,16 @@ declare namespace pgPromise {
     interface IConnected<Ext, C extends pg.IClient> extends IBaseProtocol<Ext>, spexLib.ISpexBase {
         readonly client: C
 
-        done(kill?: boolean): void
+        // Note that for normal connections (working with the pool), method `done` accepts `kill`
+        // flag to terminate the connection within the pool, so it can be auto-recreated;
+        // And in this case the method returns nothing / void.
+
+        // But for direct connections (connect({direct: true})), `kill` flag is ignored, because
+        // the connection is always closed physically, which may take time, and so in this case
+        // the method returns a Promise, to indicate when the connection finished closing.
+        done(kill?: boolean): void | XPromise<void>;
+
+        // Repeated calls are not allowed, and will throw an error.
     }
 
     // Event context extension for tasks + transactions;
@@ -570,7 +579,8 @@ declare namespace pgPromise {
 
         query?(e: IEventContext<C>): void
 
-        receive?(data: any[], result: IResultExt, e: IEventContext<C>): void
+        // NOTE: result is undefined when data comes from QueryStream, i.e. via method Database.stream
+        receive?(data: any[], result: IResultExt | void, e: IEventContext<C>): void
 
         task?(e: IEventContext<C>): void