@nymphjs/driver-postgresql 1.0.0-beta.2 → 1.0.0-beta.21

package/src/PostgreSQLDriver.ts

@@ -1,4 +1,9 @@
-import cp from 'child_process';
+import {
+  Worker,
+  MessageChannel,
+  receiveMessageOnPort,
+} from 'node:worker_threads';
+import { resolve } from 'node:path';
 import { Pool, PoolClient, PoolConfig, QueryResult } from 'pg';
 import format from 'pg-format';
 import {
@@ -44,6 +49,8 @@ export default class PostgreSQLDriver extends NymphDriver {
   // @ts-ignore: this is assigned in connect(), which is called by the constructor.
   protected link: Pool;
   protected transaction: PostgreSQLDriverTransaction | null = null;
+  // @ts-ignore: this is assigned in connect(), which is called by the constructor.
+  protected worker: Worker;
 
   static escape(input: string) {
     return format.ident(input);
@@ -56,7 +63,8 @@ export default class PostgreSQLDriver extends NymphDriver {
   constructor(
     config: Partial<PostgreSQLDriverConfig>,
     link?: Pool,
-    transaction?: PostgreSQLDriverTransaction
+    transaction?: PostgreSQLDriverTransaction,
+    worker?: Worker
   ) {
     super();
     this.config = { ...defaults, ...config };
@@ -77,11 +85,28 @@ export default class PostgreSQLDriver extends NymphDriver {
     if (transaction != null) {
       this.transaction = transaction;
     }
+    if (worker != null) {
+      this.worker = worker;
+    }
     if (link == null) {
       this.connect();
     }
   }
 
+  /**
+   * This is used internally by Nymph. Don't call it yourself.
+   *
+   * @returns A clone of this instance.
+   */
+  public clone() {
+    return new PostgreSQLDriver(
+      this.config,
+      this.link,
+      this.transaction ?? undefined,
+      this.worker ?? undefined
+    );
+  }
+
   private getConnection(): Promise<PostgreSQLDriverConnection> {
     if (this.transaction != null && this.transaction.connection != null) {
       return Promise.resolve(this.transaction.connection);
@@ -117,6 +142,7 @@ export default class PostgreSQLDriver extends NymphDriver {
           })
         );
         connection.done();
+        this.worker.postMessage('halt');
       }
     } catch (e: any) {
       this.connected = false;
@@ -126,6 +152,17 @@ export default class PostgreSQLDriver extends NymphDriver {
     if (!this.connected) {
       try {
         this.link = new Pool(this.postgresqlConfig);
+        const worker = new Worker(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: any) {
         if (
@@ -153,6 +190,7 @@ export default class PostgreSQLDriver extends NymphDriver {
   public async disconnect() {
     if (this.connected) {
       await new Promise((resolve) => this.link.end(() => resolve(0)));
+      this.worker.postMessage('halt');
       this.connected = false;
     }
     return this.connected;
@@ -572,34 +610,24 @@ export default class PostgreSQLDriver extends NymphDriver {
     );
     return this.querySync(
       () => {
-        const output = cp.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,
-          }
+        const channel = new MessageChannel();
+
+        this.worker.postMessage(
+          { query: newQuery, params: newParams, port: channel.port2 },
+          [channel.port2]
         );
-        try {
-          return JSON.parse(output.stdout).rows;
-        } catch (e) {
-          // Do nothing.
-        }
-        if (output.status === 0) {
-          throw new Error('Unknown parse error.');
+
+        let output = undefined;
+        while (!output) {
+          output = receiveMessageOnPort(channel.port1);
         }
-        const err = JSON.parse(output.stderr);
-        const e = new Error(err.name);
-        for (const name in err) {
-          (e as any)[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
@@ -693,35 +721,24 @@ export default class PostgreSQLDriver extends NymphDriver {
     );
     return this.querySync(
       () => {
-        const output = cp.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,
-          }
+        const channel = new MessageChannel();
+
+        this.worker.postMessage(
+          { query: newQuery, params: newParams, port: channel.port2 },
+          [channel.port2]
         );
-        try {
-          const results = JSON.parse(output.stdout);
-          return { rowCount: results.rowCount ?? 0 };
-        } catch (e) {
-          // Do nothing.
-        }
-        if (output.status === 0) {
-          throw new Error('Unknown parse error.');
+
+        let output = undefined;
+        while (!output) {
+          output = receiveMessageOnPort(channel.port1);
         }
-        const err = JSON.parse(output.stderr);
-        const e = new Error(err.name);
-        for (const name in err) {
-          (e as any)[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
@@ -953,6 +970,7 @@ export default class PostgreSQLDriver extends 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,
@@ -1748,18 +1766,42 @@ export default class PostgreSQLDriver extends NymphDriver {
     );
 
     let sortBy: string;
+    let sortByInner: string;
+    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: string;
     if (queryParts.length) {
@@ -1804,8 +1846,9 @@ export default class PostgreSQLDriver extends NymphDriver {
             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
               encode(${eTable}."guid", 'hex') AS "guid",
@@ -1825,15 +1868,17 @@ export default class PostgreSQLDriver extends NymphDriver {
             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"`;
         }
       }
     } else {
@@ -1875,7 +1920,8 @@ export default class PostgreSQLDriver extends NymphDriver {
             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) {
             query = `SELECT
@@ -1896,14 +1942,16 @@ export default class PostgreSQLDriver extends NymphDriver {
               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
                 encode(${eTable}."guid", 'hex') AS "guid",
@@ -1923,7 +1971,8 @@ export default class PostgreSQLDriver extends NymphDriver {
               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"`;
           }
         }
       }
@@ -2026,7 +2075,11 @@ export default class PostgreSQLDriver extends NymphDriver {
     );
 
     const result = await resultPromise;
-    return process();
+    const value = process();
+    if (value instanceof Error) {
+      throw value;
+    }
+    return value;
   }
 
   protected getEntitiesSync<T extends EntityConstructor = EntityConstructor>(
@@ -2073,7 +2126,11 @@ export default class PostgreSQLDriver extends NymphDriver {
             : row.value,
       })
     );
-    return process();
+    const value = process();
+    if (value instanceof Error) {
+      throw value;
+    }
+    return value;
   }
 
   public async getUID(name: string) {
@@ -2674,8 +2731,7 @@ export default class PostgreSQLDriver extends NymphDriver {
     }
 
     const nymph = this.nymph.clone();
-    nymph.driver = new PostgreSQLDriver(this.config, this.link, transaction);
-    nymph.driver.init(nymph);
+    (nymph.driver as PostgreSQLDriver).transaction = transaction;
 
     return nymph;
   }

package/src/runPostgresqlSync.js

@@ -1,35 +1,41 @@
+const { isMainThread, workerData, parentPort } = require('node:worker_threads');
 const pg = require('pg');
 
-let stdin = '';
-
-process.stdin.on('data', (data) => {
-  if (data != null) {
-    stdin += data.toString();
-  }
-});
+if (isMainThread) {
+  throw new Error("Don't load this file as main thread.");
+}
 
-process.stdin.on('end', () => {
-  run();
-});
+try {
+  const postgresqlConfig = workerData;
+  const pool = new pg.Pool(postgresqlConfig);
 
-async function run() {
-  try {
-    const { postgresqlConfig, query, params } = JSON.parse(stdin);
-    const pool = new pg.Pool(postgresqlConfig);
-    const results = await new Promise((resolve, reject) =>
-      pool.query(query, params).then(
-        (results) => resolve(results),
-        (error) => reject(error)
-      )
-    );
-    process.stdout.end(JSON.stringify(results), 'utf8', () => {
+  parentPort.on('message', async (message) => {
+    if (message === 'halt') {
       pool.end(() => {
-        process.exit(0);
+        parentPort.postMessage('halted');
       });
-    });
-  } catch (e) {
-    process.stderr.end(JSON.stringify(e), 'utf8', () => {
-      process.exit(1);
-    });
-  }
+    } else {
+      const { query, params, port } = message;
+
+      try {
+        const results = await new Promise((resolve, reject) =>
+          pool.query(query, params).then(
+            (results) => resolve(results),
+            (error) => reject(error)
+          )
+        );
+
+        port.postMessage({
+          results: {
+            rows: results.rows,
+            rowCount: results.rowCount,
+          },
+        });
+      } catch (e) {
+        port.postMessage({ error: e.message });
+      }
+    }
+  });
+} catch (e) {
+  parentPort.postMessage({ error: e.message });
 }

package/src/testpostgresql.js

@@ -1,4 +1,13 @@
 const cp = require('child_process');
+const {
+  Worker,
+  isMainThread,
+  workerData,
+  parentPort,
+  MessageChannel,
+  receiveMessageOnPort,
+} = require('node:worker_threads');
+const pg = require('pg');
 
 const postgresqlConfig = {
   host: 'localhost',
@@ -38,22 +47,73 @@ const params = [['Hello, world.']];
 // const query = 'SELECT relname FROM pg_stat_user_tables ORDER BY relname;';
 // const params = [];
 
-const output = cp.spawnSync(
-  process.argv0,
-  [__dirname + '/runPostgresqlSync.js'],
-  {
-    input: JSON.stringify({ postgresqlConfig, query, params }),
-    timeout: 30000,
-    maxBuffer: 100 * 1024 * 1024,
-    encoding: 'utf8',
-    windowsHide: true,
+const methodOne = () => {
+  // Doesn't work anymore since runPostgresqlSync is updated.
+  const output = cp.spawnSync(
+    process.argv0,
+    [__dirname + '/runPostgresqlSync.js'],
+    {
+      input: JSON.stringify({ postgresqlConfig, query, params }),
+      timeout: 30000,
+      maxBuffer: 100 * 1024 * 1024,
+      encoding: 'utf8',
+      windowsHide: true,
+    }
+  );
+  try {
+    const result = JSON.parse(output.stdout);
+    console.log('Server reply: ', result);
+  } catch (e) {
+    // Do nothing.
   }
-);
-try {
-  const result = JSON.parse(output.stdout);
-  console.log('Server reply: ', result);
-} catch (e) {
-  // Do nothing.
-}
-const err = output.status === 0 ? null : JSON.parse(output.stderr);
-if (err) console.error(err);
+  const err = output.status === 0 ? null : JSON.parse(output.stderr);
+  if (err) console.error(err);
+};
+
+const methodTwo = () => {
+  if (isMainThread) {
+    const worker = new Worker(__filename, { workerData: postgresqlConfig });
+    const channel = new MessageChannel();
+
+    worker.postMessage({ query, params, port: channel.port2 }, [channel.port2]);
+
+    let result = undefined;
+    while (!result) {
+      result = receiveMessageOnPort(channel.port1);
+    }
+
+    if (result.message.error) {
+      throw new Error(result.message.error);
+    }
+
+    console.log(JSON.stringify(result, null, 2));
+  } else {
+    const postgresqlConfig = workerData;
+    const pool = new pg.Pool(postgresqlConfig);
+    parentPort.on('message', async ({ query, params, port }) => {
+      try {
+        const results = await new Promise((resolve, reject) =>
+          pool.query(query, params).then(
+            (results) => resolve(results),
+            (error) => reject(error)
+          )
+        );
+
+        port.postMessage({
+          results: {
+            rows: results.rows,
+            rowCount: results.rowCount,
+          },
+        });
+
+        pool.end(() => {
+          process.exit(0);
+        });
+      } catch (e) {
+        port.postMessage({ error: e.message });
+      }
+    });
+  }
+};
+
+methodTwo();