prostgles-server 4.2.183 → 4.2.185

package/lib/PubSubManager/getPubSubManagerInitQuery.ts

@@ -1,7 +1,11 @@
-
 import { tryCatch } from "prostgles-types";
 import { pgp } from "../DboBuilder/DboBuilderTypes";
-import { asValue, NOTIF_CHANNEL, NOTIF_TYPE, PubSubManager } from "./PubSubManager";
+import {
+  asValue,
+  NOTIF_CHANNEL,
+  NOTIF_TYPE,
+  PubSubManager,
+} from "./PubSubManager";
 const { version } = require("../../package.json");
 import { getAppCheckQuery } from "./orphanTriggerCheck";
 import { DboBuilder } from "../DboBuilder/DboBuilder";
@@ -11,7 +15,7 @@ export const DB_OBJ_NAMES = {
   data_watch_func: "prostgles.prostgles_trigger_function",
   schema_watch_func: "prostgles.schema_watch_func",
   schema_watch_trigger: "prostgles_schema_watch_trigger_new",
-  schema_watch_trigger_drop: "prostgles_schema_watch_trigger_new_drop"
+  schema_watch_trigger_drop: "prostgles_schema_watch_trigger_new_drop",
 } as const;
 
 const PROSTGLES_SCHEMA_EXISTS_QUERY = `
@@ -30,11 +34,10 @@ const PROSTGLES_SCHEMA_VERSION_OK_QUERY = `
 `;
 
 const getInitQuery = (debugMode: boolean | undefined, pgVersion: number) => {
-
   const canReplaceTriggers = pgVersion >= 140006;
-  const createTriggerQuery = canReplaceTriggers ? 
-    `CREATE OR REPLACE TRIGGER %1$I`: 
-    `
+  const createTriggerQuery = canReplaceTriggers
+    ? `CREATE OR REPLACE TRIGGER %1$I`
+    : `
     DROP TRIGGER IF EXISTS %1$I ON %2$s;
     CREATE TRIGGER %1$I
     `;
@@ -334,7 +337,7 @@ BEGIN
                                   THEN concat_ws('; ', 'error', err_text, err_detail, err_hint, 'query: ' || query ) 
                                   ELSE COALESCE(v_trigger.cids, '') 
                                 END
-                                ${debugMode? (", COALESCE(current_query(), 'current_query ??'), ' ', query") : ""}
+                                ${debugMode ? ", COALESCE(current_query(), 'current_query ??'), ' ', query" : ""}
                               ), 7999/4) -- Some chars are 2bytes -> 'Ω'
                             );
                         END LOOP;
@@ -504,7 +507,7 @@ BEGIN
                             $q$
                                 DO $e$ 
                                 BEGIN
-                                    /* ${ PubSubManager.EXCLUDE_QUERY_FROM_SCHEMA_WATCH_ID} */
+                                    /* ${PubSubManager.EXCLUDE_QUERY_FROM_SCHEMA_WATCH_ID} */
                                     %s
 
                                 END $e$;
@@ -532,7 +535,7 @@ BEGIN
                         json_build_object(
                           'TG_OP', TG_OP, 
                           'duration', (EXTRACT(EPOCH FROM now()) * 1000) - start_time,
-                          'query', ${debugMode? 'LEFT(current_query(), 400)' : "'Only shown in debug mode'"}
+                          'query', ${debugMode ? "LEFT(current_query(), 400)" : "'Only shown in debug mode'"}
                         )
                       )::TEXT, 7999/4)
                     );
@@ -609,7 +612,7 @@ BEGIN
                           ${asValue(NOTIF_TYPE.schema)}, 
                           tg_tag , 
                           TG_event, 
-                          ${debugMode? 'curr_query' : "'Only shown in debug mode'"}
+                          ${debugMode ? "curr_query" : "'Only shown in debug mode'"}
                         ), 7999/4)
                       );
                     END LOOP;
@@ -629,34 +632,49 @@ $do$;
 
 COMMIT;
 `;
-
-}
+};
 
 /**
  * Initialize the prostgles schema and functions needed for realtime data and schema changes
  * undefined returned if the database contains the apropriate prostgles schema
  */
-export const getPubSubManagerInitQuery = async function(this: DboBuilder): Promise<string | undefined> { 
-
-  const versionNum = await this.db.one("SELECT current_setting('server_version_num')::int as val");
-  const initQuery = getInitQuery(this.prostgles.opts.DEBUG_MODE, versionNum.val);
-  const { schema_md5 = "none" } = await this.db.oneOrNone("SELECT md5($1) as schema_md5", [initQuery.trim()]);
+export const getPubSubManagerInitQuery = async function (
+  this: DboBuilder,
+): Promise<string | undefined> {
+  const versionNum = await this.db.one(
+    "SELECT current_setting('server_version_num')::int as val",
+  );
+  const initQuery = getInitQuery(
+    this.prostgles.opts.DEBUG_MODE,
+    versionNum.val,
+  );
+  const { schema_md5 = "none" } = await this.db.oneOrNone(
+    "SELECT md5($1) as schema_md5",
+    [initQuery.trim()],
+  );
   const query = pgp.as.format(initQuery, { schema_md5, version });
   const existingSchema = await this.db.any(PROSTGLES_SCHEMA_EXISTS_QUERY);
-  if(!existingSchema.length){
-    console.log("getPubSubManagerInitQuery: No prostgles.versions table found. Creating...");
+  if (!existingSchema.length) {
+    console.log(
+      "getPubSubManagerInitQuery: No prostgles.versions table found. Creating...",
+    );
     return query;
   }
   const { existingSchemaVersions } = await tryCatch(async () => {
-    const existingSchemaVersions = await this.db.any(PROSTGLES_SCHEMA_VERSION_OK_QUERY, { schema_md5, version });
+    const existingSchemaVersions = await this.db.any(
+      PROSTGLES_SCHEMA_VERSION_OK_QUERY,
+      { schema_md5, version },
+    );
     return {
-      existingSchemaVersions
-    }
+      existingSchemaVersions,
+    };
   });
-  if(!existingSchemaVersions?.length){
-    console.log("getPubSubManagerInitQuery: Outdated prostgles schema. Re-creating...");
+  if (!existingSchemaVersions?.length) {
+    console.log(
+      "getPubSubManagerInitQuery: Outdated prostgles schema. Re-creating...",
+    );
     return query;
   }
-  
+
   return undefined;
-}
+};

package/lib/PubSubManager/initPubSubManager.ts

@@ -3,11 +3,14 @@ import { PostgresNotifListenManager } from "../PostgresNotifListenManager";
 import { getWatchSchemaTagList } from "../SchemaWatch/getWatchSchemaTagList";
 import { NOTIF_CHANNEL, PubSubManager, asValue } from "./PubSubManager";
 import { getPubSubManagerInitQuery } from "./getPubSubManagerInitQuery";
-export const REALTIME_TRIGGER_CHECK_QUERY = "prostgles-server internal query used to manage realtime triggers" as const;  
+export const REALTIME_TRIGGER_CHECK_QUERY =
+  "prostgles-server internal query used to manage realtime triggers" as const;
 
-export const tout = (ms: number) => new Promise(res => setTimeout(res, ms));
+export const tout = (ms: number) => new Promise((res) => setTimeout(res, ms));
 
-export async function initPubSubManager(this: PubSubManager): Promise<PubSubManager | undefined> {
+export async function initPubSubManager(
+  this: PubSubManager,
+): Promise<PubSubManager | undefined> {
   if (!this.getIsDestroyed()) return undefined;
 
   const initQuery = await getPubSubManagerInitQuery.bind(this.dboBuilder)();
@@ -15,7 +18,7 @@ export async function initPubSubManager(this: PubSubManager): Promise<PubSubMana
   /**
    * High database activity might cause deadlocks.
    * Must retry
-  */
+   */
   let didDeadlock = false;
   let tries = 3;
   let error: any;
@@ -25,20 +28,20 @@ export async function initPubSubManager(this: PubSubManager): Promise<PubSubMana
       await tout(Math.random());
 
       // await this.dboBuilder.runClientTransactionStatement(initQuery);// this.db.tx(t => t.any(initQuery));
-      await this.db.tx(t => t.any(initQuery));
+      await this.db.tx((t) => t.any(initQuery));
       error = undefined;
       tries = 0;
     } catch (e: any) {
-      if(!didDeadlock && isObject(e) && e.code === "40P01"){
+      if (!didDeadlock && isObject(e) && e.code === "40P01") {
         didDeadlock = true;
         tries = 5;
         console.error("Deadlock detected. Retrying...");
       }
       error = e;
-      tries --;
+      tries--;
     }
   }
-  if(error){
+  if (error) {
     throw error;
   }
 
@@ -48,19 +51,21 @@ export async function initPubSubManager(this: PubSubManager): Promise<PubSubMana
   if (!this.appInfoWasInserted) {
     this.appInfoWasInserted = true;
     const check_frequency_ms = this.appCheckFrequencyMS;
-    const watching_schema_tag_names = this.dboBuilder.prostgles.schemaWatch?.type.watchType !== "NONE" ? getWatchSchemaTagList(this.dboBuilder.prostgles.opts.watchSchema) : null;
+    const watching_schema_tag_names =
+      this.dboBuilder.prostgles.schemaWatch?.type.watchType !== "NONE"
+        ? getWatchSchemaTagList(this.dboBuilder.prostgles.opts.watchSchema)
+        : null;
     await this.db.one(
       "INSERT INTO prostgles.apps (id, check_frequency_ms, watching_schema_tag_names, application_name) \
       VALUES($1, $2, $3, current_setting('application_name')) \
-      RETURNING *; "
-      , [
-        this.appId,
-        check_frequency_ms,
-        watching_schema_tag_names
-      ]
+      RETURNING *; ",
+      [this.appId, check_frequency_ms, watching_schema_tag_names],
     );
 
-    const appRecord = await this.db.one("SELECT * FROM prostgles.apps WHERE id = $1", [this.appId]);
+    const appRecord = await this.db.one(
+      "SELECT * FROM prostgles.apps WHERE id = $1",
+      [this.appId],
+    );
     if (!appRecord || !appRecord.application_name?.includes(this.appId)) {
       throw `initPubSubManager error: App record with application_name containing appId (${this.appId}) not found`;
     }
@@ -71,9 +76,13 @@ export async function initPubSubManager(this: PubSubManager): Promise<PubSubMana
     `);
   }
 
-  this.postgresNotifListenManager = new PostgresNotifListenManager(this.db, this.notifListener, NOTIF_CHANNEL.getFull(this.appId));
+  this.postgresNotifListenManager = new PostgresNotifListenManager(
+    this.db,
+    this.notifListener,
+    NOTIF_CHANNEL.getFull(this.appId),
+  );
 
   await this.initialiseEventTriggers();
 
   return this;
-}
+}

package/lib/PubSubManager/notifListener.ts

@@ -1,11 +1,14 @@
 import { log, NOTIF_TYPE, pickKeys, PubSubManager } from "./PubSubManager";
 
 /* Relay relevant data to relevant subscriptions */
-export async function notifListener(this: PubSubManager, data: { payload: string }) {
+export async function notifListener(
+  this: PubSubManager,
+  data: { payload: string },
+) {
   const str = data.payload;
 
   if (!str) {
-    console.error("Unexpected Empty notif")
+    console.error("Unexpected Empty notif");
     return;
   }
 
@@ -15,19 +18,25 @@ export async function notifListener(this: PubSubManager, data: { payload: string
   log(str);
 
   if (notifType === NOTIF_TYPE.schema) {
-
     if (this.dboBuilder.prostgles.schemaWatch?.onSchemaChange) {
       const [_, command, _event_type, query] = dataArr;
-      await this.dboBuilder.prostgles.opts.onLog?.({ type: "debug", command: "schemaChangeNotif", duration: 0, data: { command, query } });
+      await this.dboBuilder.prostgles.opts.onLog?.({
+        type: "debug",
+        command: "schemaChangeNotif",
+        duration: 0,
+        data: { command, query },
+      });
 
       if (query && command) {
-        this.dboBuilder.prostgles.schemaWatch.onSchemaChange({ command, query })
+        this.dboBuilder.prostgles.schemaWatch.onSchemaChange({
+          command,
+          query,
+        });
       }
     }
 
     return;
-  } else if(notifType === NOTIF_TYPE.data_trigger_change) {
-    
+  } else if (notifType === NOTIF_TYPE.data_trigger_change) {
     await this.refreshTriggers();
     return;
   }
@@ -38,60 +47,61 @@ export async function notifListener(this: PubSubManager, data: { payload: string
   }
 
   if (dataArr.length < 3) {
-    throw "notifListener: dataArr length < 3"
+    throw "notifListener: dataArr length < 3";
   }
-  
+
   const [_, table_name, op_name, condition_ids_str] = dataArr;
-  const condition_ids = condition_ids_str?.split(",").map(v => +v);
-  
-  
-  if(!table_name) {
+  const condition_ids = condition_ids_str?.split(",").map((v) => +v);
+
+  if (!table_name) {
     throw "table_name undef";
   }
 
-  const tableTriggerConditions = this._triggers?.[table_name]?.map((condition, idx) => ({
-    idx,
-    condition,
-    subs: this.getTriggerSubs(table_name, condition),
-    syncs: this.getSyncs(table_name, condition),
-  }));
+  const tableTriggerConditions = this._triggers?.[table_name]?.map(
+    (condition, idx) => ({
+      idx,
+      condition,
+      subs: this.getTriggerSubs(table_name, condition),
+      syncs: this.getSyncs(table_name, condition),
+    }),
+  );
   let state: "error" | "no-triggers" | "ok" | "invalid_condition_ids" = "ok";
-  
+
   // const triggers = await this.db.any("SELECT * FROM prostgles.triggers WHERE table_name = $1 AND id IN ($2:csv)", [table_name, condition_ids_str.split(",").map(v => +v)]);
   // const conditions: string[] = triggers.map(t => t.condition);
-  
 
-  if(!tableTriggerConditions?.length){
+  if (!tableTriggerConditions?.length) {
     state = "no-triggers";
 
     /* Trigger error */
-  } else if (
-    condition_ids_str?.startsWith("error")
-  ) {
+  } else if (condition_ids_str?.startsWith("error")) {
     state = "error";
     const pref = "INTERNAL ERROR";
-    console.error(`${pref}: condition_ids_str: ${condition_ids_str}`)
+    console.error(`${pref}: condition_ids_str: ${condition_ids_str}`);
     tableTriggerConditions.map(({ condition }) => {
       const subs = this.getTriggerSubs(table_name, condition);
-      subs.map(s => {
-        this.pushSubData(s, pref + ". Check server logs. Schema might have changed");
-      })
+      subs.map((s) => {
+        this.pushSubData(
+          s,
+          pref + ". Check server logs. Schema might have changed",
+        );
+      });
     });
 
     /* Trigger ok */
-  } else if (
-    condition_ids?.every(id => Number.isInteger(id))
-  ) {
-
+  } else if (condition_ids?.every((id) => Number.isInteger(id))) {
     state = "ok";
-    const firedTableConditions = tableTriggerConditions.filter(({ idx }) => condition_ids.includes(idx));
+    const firedTableConditions = tableTriggerConditions.filter(({ idx }) =>
+      condition_ids.includes(idx),
+    );
     const orphanedTableConditions = condition_ids.filter((condId) => {
       const tc = tableTriggerConditions.at(condId);
       return !tc || (tc.subs.length === 0 && tc.syncs.length === 0);
     });
-    if(orphanedTableConditions.length){
+    if (orphanedTableConditions.length) {
       this.db
-        .any(`
+        .any(
+          `
           /* Delete removed subscriptions */
           /* ${PubSubManager.EXCLUDE_QUERY_FROM_SCHEMA_WATCH_ID} */
           DELETE FROM prostgles.app_triggers at
@@ -105,52 +115,57 @@ export async function notifListener(this: PubSubManager, data: { payload: string
             AND at.table_name = t.table_name
             AND at.condition = t.condition
           ) 
-          `, 
-          [table_name, orphanedTableConditions, this.appId]
+          `,
+          [table_name, orphanedTableConditions, this.appId],
         )
         .then(() => {
           this.refreshTriggers();
         })
-        .catch(e => {
+        .catch((e) => {
           console.error("Error deleting orphaned triggers", e);
         });
     }
 
     firedTableConditions.map(({ subs, syncs }) => {
-
-      log("notifListener", subs.map(s => s.channel_name), syncs.map(s => s.channel_name))
+      log(
+        "notifListener",
+        subs.map((s) => s.channel_name),
+        syncs.map((s) => s.channel_name),
+      );
 
       syncs.map((s) => {
         this.syncData(s, undefined, "trigger");
       });
 
       /* Throttle the subscriptions */
-      const activeAndReadySubs = subs.filter(sub => 
-        sub.triggers.some(trg => 
-          this.dbo[trg.table_name] &&
-          sub.is_ready &&
-          (sub.socket_id && this.sockets[sub.socket_id] || sub.localFuncs)
-        )
+      const activeAndReadySubs = subs.filter((sub) =>
+        sub.triggers.some(
+          (trg) =>
+            this.dbo[trg.table_name] &&
+            sub.is_ready &&
+            ((sub.socket_id && this.sockets[sub.socket_id]) || sub.localFuncs),
+        ),
       );
-      activeAndReadySubs.forEach(sub => {
+      activeAndReadySubs.forEach((sub) => {
         const { throttle = 0, throttleOpts } = sub;
-        if (!throttleOpts?.skipFirst && sub.last_throttled <= Date.now() - throttle) {
+        if (
+          !throttleOpts?.skipFirst &&
+          sub.last_throttled <= Date.now() - throttle
+        ) {
           sub.last_throttled = Date.now();
 
           /* It is assumed the policy was checked before this point */
           this.pushSubData(sub);
         } else if (!sub.is_throttling) {
-
-          log("throttling sub")
+          log("throttling sub");
           sub.is_throttling = setTimeout(() => {
-            log("throttling finished. pushSubData...")
+            log("throttling finished. pushSubData...");
             sub.is_throttling = null;
             sub.last_throttled = Date.now();
             this.pushSubData(sub);
           }, throttle);
         }
       });
-
     });
 
     /* Trigger unknown issue */
@@ -158,16 +173,19 @@ export async function notifListener(this: PubSubManager, data: { payload: string
     state = "invalid_condition_ids";
   }
 
-  await this._log({ 
+  await this._log({
     type: "sync",
     command: "notifListener",
     state,
-    tableName: table_name, 
-    op_name, 
+    tableName: table_name,
+    op_name,
     condition_ids_str,
     tableTriggers: this._triggers?.[table_name],
-    tableSyncs: JSON.stringify(this.syncs.filter(s => s.table_name === table_name).map(s => pickKeys(s, ["condition", "socket_id"]))),
+    tableSyncs: JSON.stringify(
+      this.syncs
+        .filter((s) => s.table_name === table_name)
+        .map((s) => pickKeys(s, ["condition", "socket_id"])),
+    ),
     connectedSocketIds: this.connectedSocketIds,
   });
-
-}
+}

package/lib/PubSubManager/orphanTriggerCheck.ts

@@ -1,13 +1,14 @@
-import { PubSubManager } from './PubSubManager';
+import { PubSubManager } from "./PubSubManager";
 import { REALTIME_TRIGGER_CHECK_QUERY } from "./initPubSubManager";
 
 /**
- * Schema and Data watch triggers (DB_OBJ_NAMES.schema_watch_func, DB_OBJ_NAMES.data_watch_func) 
+ * Schema and Data watch triggers (DB_OBJ_NAMES.schema_watch_func, DB_OBJ_NAMES.data_watch_func)
  * survive and continue to user resources even after the client disconnects.
  * We must therefore delete apps that do not have active connections
  */
 
-const queryIdentifier = "prostgles query used to keep track of which prgl backend clients are still connected";
+const queryIdentifier =
+  "prostgles query used to keep track of which prgl backend clients are still connected";
 const connectedApplicationNamesQuery = `
   SELECT DISTINCT application_name
   FROM prostgles.apps 
@@ -15,7 +16,7 @@ const connectedApplicationNamesQuery = `
     SELECT application_name 
     FROM pg_catalog.pg_stat_activity
   )
-`; 
+`;
 
 export const DELETE_DISCONNECTED_APPS_QUERY = `
   DELETE FROM prostgles.apps a

package/lib/PubSubManager/pushSubData.ts

@@ -1,11 +1,15 @@
 import { parseLocalFuncs } from "../DboBuilder/ViewHandler/subscribe";
 import { log, PubSubManager, Subscription } from "./PubSubManager";
 
-export async function pushSubData(this: PubSubManager, sub: Subscription, err?: any) {
+export async function pushSubData(
+  this: PubSubManager,
+  sub: Subscription,
+  err?: any,
+) {
   if (!sub) throw "pushSubData: invalid sub";
 
   const { socket_id, channel_name } = sub;
-  if(!this.subs.some(s => s.channel_name === channel_name)){
+  if (!this.subs.some((s) => s.channel_name === channel_name)) {
     // Might be throttling a sub that was removed
     return;
   }
@@ -20,13 +24,12 @@ export async function pushSubData(this: PubSubManager, sub: Subscription, err?:
 
   return new Promise(async (resolve, reject) => {
     /* TODO: Retire subOne -> it's redundant */
-    
-    const { data, err } = await this.getSubData(sub);
 
-    if(data){
+    const { data, err } = await this.getSubData(sub);
 
+    if (data) {
       if (socket_id && this.sockets[socket_id]) {
-        log("Pushed " + data.length + " records to sub")
+        log("Pushed " + data.length + " records to sub");
         this.sockets[socket_id].emit(channel_name, { data }, () => {
           resolve(data);
         });
@@ -38,13 +41,12 @@ export async function pushSubData(this: PubSubManager, sub: Subscription, err?:
         resolve(data);
       }
       // sub.last_throttled = Date.now();
-
     } else {
       const errObj = { _err_msg: err.toString(), err };
       if (socket_id && this.sockets[socket_id]) {
         this.sockets[socket_id].emit(channel_name, { err: errObj });
       } else if (localFuncs) {
-        if(!localFuncs.onError){
+        if (!localFuncs.onError) {
           console.error("Uncaught subscription error", err);
         }
         localFuncs.onError?.(errObj);
@@ -52,4 +54,4 @@ export async function pushSubData(this: PubSubManager, sub: Subscription, err?:
       reject(errObj);
     }
   });
-}
+}