@nymphjs/driver-postgresql 1.0.0-beta.3 → 1.0.0-beta.31

package/CHANGELOG.md

@@ -3,6 +3,126 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [1.0.0-beta.31](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.30...v1.0.0-beta.31) (2023-05-12)
+
+**Note:** Version bump only for package @nymphjs/driver-postgresql
+
+# [1.0.0-beta.30](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.29...v1.0.0-beta.30) (2023-05-12)
+
+**Note:** Version bump only for package @nymphjs/driver-postgresql
+
+# [1.0.0-beta.29](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.28...v1.0.0-beta.29) (2023-05-08)
+
+**Note:** Version bump only for package @nymphjs/driver-postgresql
+
+# [1.0.0-beta.28](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.27...v1.0.0-beta.28) (2023-05-05)
+
+**Note:** Version bump only for package @nymphjs/driver-postgresql
+
+# [1.0.0-beta.27](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.26...v1.0.0-beta.27) (2023-05-04)
+
+**Note:** Version bump only for package @nymphjs/driver-postgresql
+
+# [1.0.0-beta.26](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.25...v1.0.0-beta.26) (2023-05-04)
+
+**Note:** Version bump only for package @nymphjs/driver-postgresql
+
+# [1.0.0-beta.25](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.24...v1.0.0-beta.25) (2023-05-04)
+
+### Bug Fixes
+
+- don't create empty entities ([1d4d2e9](https://github.com/sciactive/nymphjs/commit/1d4d2e99af2e9cdc647bcf58ac34572836f41176))
+
+# [1.0.0-beta.24](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.23...v1.0.0-beta.24) (2023-05-02)
+
+**Note:** Version bump only for package @nymphjs/driver-postgresql
+
+# [1.0.0-beta.23](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.22...v1.0.0-beta.23) (2023-05-02)
+
+**Note:** Version bump only for package @nymphjs/driver-postgresql
+
+# [1.0.0-beta.22](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.21...v1.0.0-beta.22) (2023-05-01)
+
+**Note:** Version bump only for package @nymphjs/driver-postgresql
+
+# [1.0.0-beta.21](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.20...v1.0.0-beta.21) (2023-05-01)
+
+**Note:** Version bump only for package @nymphjs/driver-postgresql
+
+# [1.0.0-beta.20](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.19...v1.0.0-beta.20) (2023-04-30)
+
+**Note:** Version bump only for package @nymphjs/driver-postgresql
+
+# [1.0.0-beta.19](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.18...v1.0.0-beta.19) (2023-04-29)
+
+**Note:** Version bump only for package @nymphjs/driver-postgresql
+
+# [1.0.0-beta.18](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.17...v1.0.0-beta.18) (2023-04-27)
+
+**Note:** Version bump only for package @nymphjs/driver-postgresql
+
+# [1.0.0-beta.17](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.16...v1.0.0-beta.17) (2023-04-24)
+
+### Features
+
+- use a long lived worker thread for synchronous mysql and postgres queries ([7e2bf84](https://github.com/sciactive/nymphjs/commit/7e2bf84a2d584d6906c31f44147025b793a05026))
+
+# [1.0.0-beta.16](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.15...v1.0.0-beta.16) (2023-03-31)
+
+**Note:** Version bump only for package @nymphjs/driver-postgresql
+
+# [1.0.0-beta.15](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.14...v1.0.0-beta.15) (2023-03-23)
+
+### Features
+
+- add option to sort results by a property ([16384e7](https://github.com/sciactive/nymphjs/commit/16384e7bdab88abb55ccccabb06ac09f92fa8a03))
+
+# [1.0.0-beta.14](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.13...v1.0.0-beta.14) (2023-03-17)
+
+**Note:** Version bump only for package @nymphjs/driver-postgresql
+
+# [1.0.0-beta.13](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.12...v1.0.0-beta.13) (2023-03-16)
+
+**Note:** Version bump only for package @nymphjs/driver-postgresql
+
+# [1.0.0-beta.12](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.11...v1.0.0-beta.12) (2023-03-04)
+
+**Note:** Version bump only for package @nymphjs/driver-postgresql
+
+# [1.0.0-beta.11](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.10...v1.0.0-beta.11) (2023-02-27)
+
+**Note:** Version bump only for package @nymphjs/driver-postgresql
+
+# [1.0.0-beta.10](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.9...v1.0.0-beta.10) (2023-01-19)
+
+**Note:** Version bump only for package @nymphjs/driver-postgresql
+
+# [1.0.0-beta.9](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.8...v1.0.0-beta.9) (2023-01-09)
+
+**Note:** Version bump only for package @nymphjs/driver-postgresql
+
+# [1.0.0-beta.8](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.7...v1.0.0-beta.8) (2023-01-09)
+
+**Note:** Version bump only for package @nymphjs/driver-postgresql
+
+# [1.0.0-beta.7](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.6...v1.0.0-beta.7) (2023-01-05)
+
+### Bug Fixes
+
+- sqlite transaction returns wrong instance of nymph if it has been cloned ([b278c76](https://github.com/sciactive/nymphjs/commit/b278c7633722cb1cca7a941187ae2f1ff8ebdc7b))
+
+# [1.0.0-beta.6](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.5...v1.0.0-beta.6) (2023-01-05)
+
+**Note:** Version bump only for package @nymphjs/driver-postgresql
+
+# [1.0.0-beta.5](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.4...v1.0.0-beta.5) (2022-11-24)
+
+**Note:** Version bump only for package @nymphjs/driver-postgresql
+
+# [1.0.0-beta.4](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.3...v1.0.0-beta.4) (2022-11-23)
+
+**Note:** Version bump only for package @nymphjs/driver-postgresql
+
 # [1.0.0-beta.3](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.2...v1.0.0-beta.3) (2022-11-21)
 
 ### Bug Fixes

package/dist/PostgreSQLDriver.d.ts

@@ -1,3 +1,5 @@
+/// <reference types="node" />
+import { Worker } from 'node:worker_threads';
 import { Pool, PoolClient } from 'pg';
 import { NymphDriver, EntityConstructor, EntityInterface, FormattedSelector, Options, Selector } from '@nymphjs/nymph';
 import { PostgreSQLDriverConfig } from './conf';
@@ -16,9 +18,11 @@ export default class PostgreSQLDriver extends NymphDriver {
     protected connected: boolean;
     protected link: Pool;
     protected transaction: PostgreSQLDriverTransaction | null;
+    protected worker: Worker;
     static escape(input: string): string;
     static escapeValue(input: string): string;
-    constructor(config: Partial<PostgreSQLDriverConfig>, link?: Pool, transaction?: PostgreSQLDriverTransaction);
+    constructor(config: Partial<PostgreSQLDriverConfig>, link?: Pool, transaction?: PostgreSQLDriverTransaction, worker?: Worker);
+    clone(): PostgreSQLDriver;
     private getConnection;
     connect(): Promise<true>;
     disconnect(): Promise<false>;

package/dist/PostgreSQLDriver.js

@@ -3,7 +3,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const child_process_1 = __importDefault(require("child_process"));
+const node_worker_threads_1 = require("node:worker_threads");
+const node_path_1 = require("node:path");
 const pg_1 = require("pg");
 const pg_format_1 = __importDefault(require("pg-format"));
 const nymph_1 = require("@nymphjs/nymph");
@@ -16,7 +17,7 @@ class PostgreSQLDriver extends nymph_1.NymphDriver {
     static escapeValue(input) {
         return pg_format_1.default.literal(input);
     }
-    constructor(config, link, transaction) {
+    constructor(config, link, transaction, worker) {
         super();
         this.connected = false;
         this.transaction = null;
@@ -37,10 +38,16 @@ class PostgreSQLDriver extends nymph_1.NymphDriver {
         if (transaction != null) {
             this.transaction = transaction;
         }
+        if (worker != null) {
+            this.worker = worker;
+        }
         if (link == null) {
             this.connect();
         }
     }
+    clone() {
+        return new PostgreSQLDriver(this.config, this.link, this.transaction ?? undefined, this.worker ?? undefined);
+    }
     getConnection() {
         if (this.transaction != null && this.transaction.connection != null) {
             return Promise.resolve(this.transaction.connection);
@@ -58,6 +65,7 @@ class PostgreSQLDriver extends nymph_1.NymphDriver {
                     resolve(0);
                 }));
                 connection.done();
+                this.worker.postMessage('halt');
             }
         }
         catch (e) {
@@ -66,6 +74,18 @@ class PostgreSQLDriver extends nymph_1.NymphDriver {
         if (!this.connected) {
             try {
                 this.link = new pg_1.Pool(this.postgresqlConfig);
+                const worker = new node_worker_threads_1.Worker((0, node_path_1.resolve)(__dirname, 'runPostgresqlSync.js'), {
+                    workerData: this.postgresqlConfig,
+                });
+                worker.on('message', (message) => {
+                    if (message === 'halted') {
+                        worker.terminate();
+                    }
+                    else if (typeof message === 'object' && 'error' in message) {
+                        console.error('Worker Thread Error', message.error);
+                    }
+                });
+                this.worker = worker;
                 this.connected = true;
             }
             catch (e) {
@@ -85,6 +105,7 @@ class PostgreSQLDriver extends nymph_1.NymphDriver {
     async disconnect() {
         if (this.connected) {
             await new Promise((resolve) => this.link.end(() => resolve(0)));
+            this.worker.postMessage('halt');
             this.connected = false;
         }
         return this.connected;
@@ -249,30 +270,17 @@ class PostgreSQLDriver extends nymph_1.NymphDriver {
     queryIterSync(query, { etypes = [], params = {}, } = {}) {
         const { query: newQuery, params: newParams } = this.translateQuery(query, params);
         return this.querySync(() => {
-            const output = child_process_1.default.spawnSync(process.argv0, [__dirname + '/runPostgresqlSync.js'], {
-                input: JSON.stringify({
-                    postgresqlConfig: this.postgresqlConfig,
-                    query: newQuery,
-                    params: newParams,
-                }),
-                timeout: 30000,
-                maxBuffer: 100 * 1024 * 1024,
-                encoding: 'utf8',
-                windowsHide: true,
-            });
-            try {
-                return JSON.parse(output.stdout).rows;
-            }
-            catch (e) {
-            }
-            if (output.status === 0) {
-                throw new Error('Unknown parse error.');
+            const channel = new node_worker_threads_1.MessageChannel();
+            this.worker.postMessage({ query: newQuery, params: newParams, port: channel.port2 }, [channel.port2]);
+            let output = undefined;
+            while (!output) {
+                output = (0, node_worker_threads_1.receiveMessageOnPort)(channel.port1);
             }
-            const err = JSON.parse(output.stderr);
-            const e = new Error(err.name);
-            for (const name in err) {
-                e[name] = err[name];
+            if (output.message.error) {
+                throw new Error(output.message.error);
             }
+            const { results } = output.message;
+            return results.rows;
         }, `${query} -- ${JSON.stringify(params)}`, etypes);
     }
     queryGet(query, { etypes = [], params = {}, } = {}) {
@@ -310,31 +318,17 @@ class PostgreSQLDriver extends nymph_1.NymphDriver {
     queryRunSync(query, { etypes = [], params = {}, } = {}) {
         const { query: newQuery, params: newParams } = this.translateQuery(query, params);
         return this.querySync(() => {
-            const output = child_process_1.default.spawnSync(process.argv0, [__dirname + '/runPostgresqlSync.js'], {
-                input: JSON.stringify({
-                    postgresqlConfig: this.postgresqlConfig,
-                    query: newQuery,
-                    params: newParams,
-                }),
-                timeout: 30000,
-                maxBuffer: 100 * 1024 * 1024,
-                encoding: 'utf8',
-                windowsHide: true,
-            });
-            try {
-                const results = JSON.parse(output.stdout);
-                return { rowCount: results.rowCount ?? 0 };
-            }
-            catch (e) {
-            }
-            if (output.status === 0) {
-                throw new Error('Unknown parse error.');
+            const channel = new node_worker_threads_1.MessageChannel();
+            this.worker.postMessage({ query: newQuery, params: newParams, port: channel.port2 }, [channel.port2]);
+            let output = undefined;
+            while (!output) {
+                output = (0, node_worker_threads_1.receiveMessageOnPort)(channel.port1);
             }
-            const err = JSON.parse(output.stderr);
-            const e = new Error(err.name);
-            for (const name in err) {
-                e[name] = err[name];
+            if (output.message.error) {
+                throw new Error(output.message.error);
             }
+            const { results } = output.message;
+            return { rowCount: results.rowCount ?? 0 };
         }, `${query} -- ${JSON.stringify(params)}`, etypes);
     }
     async commit(name) {
@@ -484,6 +478,7 @@ class PostgreSQLDriver extends nymph_1.NymphDriver {
         const fTable = `f${tableSuffix}`;
         const ieTable = `ie${tableSuffix}`;
         const countTable = `count${tableSuffix}`;
+        const sTable = `s${tableSuffix}`;
         const sort = options.sort ?? 'cdate';
         const queryParts = this.iterateSelectorsForQuery(formattedSelectors, (key, value, typeIsOr, typeIsNot) => {
             const clauseNot = key.startsWith('!');
@@ -1255,18 +1250,38 @@ class PostgreSQLDriver extends nymph_1.NymphDriver {
             return curQuery;
         });
         let sortBy;
+        let sortByInner;
+        let sortJoin = '';
+        let sortJoinInner = '';
+        const order = options.reverse ? ' DESC' : '';
         switch (sort) {
             case 'mdate':
-                sortBy = '"mdate"';
+                sortBy = `${eTable}."mdate"${order}`;
+                sortByInner = `${ieTable}."mdate"${order}`;
                 break;
             case 'cdate':
+                sortBy = `${eTable}."cdate"${order}`;
+                sortByInner = `${ieTable}."cdate"${order}`;
+                break;
             default:
-                sortBy = '"cdate"';
+                const name = `param${++count.i}`;
+                sortJoin = `LEFT JOIN (
+            SELECT "guid", "string", "number"
+            FROM ${PostgreSQLDriver.escape(this.prefix + 'comparisons_' + etype)}
+            WHERE "name"=@${name}
+            ORDER BY "number"${order}, "string"${order}
+          ) ${sTable} ON ${eTable}."guid"=${sTable}."guid"`;
+                sortJoinInner = `LEFT JOIN (
+            SELECT "guid", "string", "number"
+            FROM ${PostgreSQLDriver.escape(this.prefix + 'comparisons_' + etype)}
+            WHERE "name"=@${name}
+            ORDER BY "number"${order}, "string"${order}
+          ) ${sTable} ON ${ieTable}."guid"=${sTable}."guid"`;
+                sortBy = `${sTable}."number"${order}, ${sTable}."string"${order}`;
+                sortByInner = sortBy;
+                params[name] = sort;
                 break;
         }
-        if (options.reverse) {
-            sortBy += ' DESC';
-        }
         let query;
         if (queryParts.length) {
             if (subquery) {
@@ -1302,8 +1317,9 @@ class PostgreSQLDriver extends nymph_1.NymphDriver {
                         : `${ieTable}."guid"`;
                     query = `SELECT ${guidColumn} AS "guid"
             FROM ${PostgreSQLDriver.escape(`${this.prefix}entities_${etype}`)} ${ieTable}
+            ${sortJoinInner}
             WHERE (${whereClause})
-            ORDER BY ${ieTable}.${sortBy}${limit}${offset}`;
+            ORDER BY ${sortByInner}, ${ieTable}."guid"${limit}${offset}`;
                 }
                 else {
                     query = `SELECT
@@ -1318,13 +1334,15 @@ class PostgreSQLDriver extends nymph_1.NymphDriver {
             FROM ${PostgreSQLDriver.escape(`${this.prefix}entities_${etype}`)} ${eTable}
             LEFT JOIN ${PostgreSQLDriver.escape(`${this.prefix}data_${etype}`)} ${dTable} ON ${eTable}."guid"=${dTable}."guid"
             INNER JOIN ${PostgreSQLDriver.escape(`${this.prefix}comparisons_${etype}`)} ${cTable} ON ${dTable}."guid"=${cTable}."guid" AND ${dTable}."name"=${cTable}."name"
+            ${sortJoin}
             INNER JOIN (
               SELECT ${ieTable}."guid"
               FROM ${PostgreSQLDriver.escape(`${this.prefix}entities_${etype}`)} ${ieTable}
+              ${sortJoinInner}
               WHERE (${whereClause})
-              ORDER BY ${ieTable}.${sortBy}${limit}${offset}
+              ORDER BY ${sortByInner}${limit}${offset}
             ) ${fTable} ON ${eTable}."guid"=${fTable}."guid"
-            ORDER BY ${eTable}.${sortBy}`;
+            ORDER BY ${sortBy}, ${eTable}."guid"`;
                 }
             }
         }
@@ -1359,7 +1377,8 @@ class PostgreSQLDriver extends nymph_1.NymphDriver {
                         : `${ieTable}."guid"`;
                     query = `SELECT ${guidColumn} AS "guid"
             FROM ${PostgreSQLDriver.escape(`${this.prefix}entities_${etype}`)} ${ieTable}
-            ORDER BY ${ieTable}.${sortBy}${limit}${offset}`;
+            ${sortJoinInner}
+            ORDER BY ${sortByInner}, ${ieTable}."guid"${limit}${offset}`;
                 }
                 else {
                     if (limit || offset) {
@@ -1375,12 +1394,14 @@ class PostgreSQLDriver extends nymph_1.NymphDriver {
               FROM ${PostgreSQLDriver.escape(`${this.prefix}entities_${etype}`)} ${eTable}
               LEFT JOIN ${PostgreSQLDriver.escape(`${this.prefix}data_${etype}`)} ${dTable} ON ${eTable}."guid"=${dTable}."guid"
               INNER JOIN ${PostgreSQLDriver.escape(`${this.prefix}comparisons_${etype}`)} ${cTable} ON ${dTable}."guid"=${cTable}."guid" AND ${dTable}."name"=${cTable}."name"
+              ${sortJoin}
               INNER JOIN (
                 SELECT ${ieTable}."guid"
                 FROM ${PostgreSQLDriver.escape(`${this.prefix}entities_${etype}`)} ${ieTable}
-                ORDER BY ${ieTable}.${sortBy}${limit}${offset}
+                ${sortJoinInner}
+                ORDER BY ${sortByInner}${limit}${offset}
               ) ${fTable} ON ${eTable}."guid"=${fTable}."guid"
-              ORDER BY ${eTable}.${sortBy}`;
+              ORDER BY ${sortBy}, ${eTable}."guid"`;
                     }
                     else {
                         query = `SELECT
@@ -1395,7 +1416,8 @@ class PostgreSQLDriver extends nymph_1.NymphDriver {
               FROM ${PostgreSQLDriver.escape(`${this.prefix}entities_${etype}`)} ${eTable}
               LEFT JOIN ${PostgreSQLDriver.escape(`${this.prefix}data_${etype}`)} ${dTable} ON ${eTable}."guid"=${dTable}."guid"
               INNER JOIN ${PostgreSQLDriver.escape(`${this.prefix}comparisons_${etype}`)} ${cTable} ON ${dTable}."guid"=${cTable}."guid" AND ${dTable}."name"=${cTable}."name"
-              ORDER BY ${eTable}.${sortBy}`;
+              ${sortJoin}
+              ORDER BY ${sortBy}, ${eTable}."guid"`;
                     }
                 }
             }
@@ -1710,6 +1732,10 @@ class PostgreSQLDriver extends nymph_1.NymphDriver {
         };
         try {
             const result = await this.saveEntityRowLike(entity, async (_entity, guid, tags, data, sdata, cdate, etype) => {
+                if (Object.keys(data).length === 0 &&
+                    Object.keys(sdata).length === 0) {
+                    return false;
+                }
                 await this.queryRun(`INSERT INTO ${PostgreSQLDriver.escape(`${this.prefix}entities_${etype}`)} ("guid", "tags", "cdate", "mdate") VALUES (decode(@guid, 'hex'), @tags, @cdate, @cdate);`, {
                     etypes: [etype],
                     params: {
@@ -1721,6 +1747,10 @@ class PostgreSQLDriver extends nymph_1.NymphDriver {
                 await insertData(guid, data, sdata, etype);
                 return true;
             }, async (entity, guid, tags, data, sdata, mdate, etype) => {
+                if (Object.keys(data).length === 0 &&
+                    Object.keys(sdata).length === 0) {
+                    return false;
+                }
                 const promises = [];
                 promises.push(this.queryRun(`SELECT 1 FROM ${PostgreSQLDriver.escape(`${this.prefix}entities_${etype}`)} WHERE "guid"=decode(@guid, 'hex') FOR UPDATE;`, {
                     etypes: [etype],
@@ -1848,8 +1878,7 @@ class PostgreSQLDriver extends nymph_1.NymphDriver {
             this.transaction = null;
         }
         const nymph = this.nymph.clone();
-        nymph.driver = new PostgreSQLDriver(this.config, this.link, transaction);
-        nymph.driver.init(nymph);
+        nymph.driver.transaction = transaction;
         return nymph;
     }
 }