prostgles-server 4.2.264 → 4.2.266

package/lib/PubSubManager/PubSubManager.ts

@@ -29,6 +29,7 @@ import {
   SelectParams,
   SubscribeParams,
   WAL,
+  type SubscribeOptions,
 } from "prostgles-types";
 
 import { find, pickKeys } from "prostgles-types/dist/util";
@@ -109,7 +110,7 @@ export type ViewSubscriptionOptions = (
   }[];
 };
 
-export type SubscriptionParams = Pick<SubscribeParams, "throttle" | "throttleOpts"> & {
+export type SubscriptionParams = {
   socket_id?: string;
   channel_name: string;
 
@@ -124,22 +125,23 @@ export type SubscriptionParams = Pick<SubscribeParams, "throttle" | "throttleOpt
   /* Used as input */
   table_rules?: ParsedTableRule;
   filter: object;
-  params: SelectParams;
+  selectParams: SelectParams;
+  subscribeOptions: SubscribeOptions;
 
   localFuncs?: LocalFuncs;
   socket: PRGLIOSocket | undefined;
 
-  last_throttled: number;
+  lastPushed: number;
   is_throttling?: any;
   is_ready?: boolean;
 };
 
 export type Subscription = Pick<
   SubscriptionParams,
-  | "throttle"
+  | "selectParams"
+  | "subscribeOptions"
   | "is_throttling"
-  | "last_throttled"
-  | "throttleOpts"
+  | "lastPushed"
   | "channel_name"
   | "is_ready"
   | "localFuncs"
@@ -147,7 +149,6 @@ export type Subscription = Pick<
   | "socket_id"
   | "table_info"
   | "filter"
-  | "params"
   | "table_rules"
 > & {
   triggers: {
@@ -298,7 +299,7 @@ export class PubSubManager {
   getSubData = async (
     sub: Subscription
   ): Promise<{ data: any[]; err?: undefined } | { data?: undefined; err: any }> => {
-    const { table_info, filter, params, table_rules } = sub; //, subOne = false
+    const { table_info, filter, selectParams: params, table_rules } = sub; //, subOne = false
     const { name: table_name } = table_info;
 
     if (!this.dbo[table_name]?.find) {

package/lib/PubSubManager/addSub.ts

@@ -1,4 +1,6 @@
 import { SubscriptionChannels } from "prostgles-types";
+import { VoidFunction } from "../SchemaWatch/SchemaWatch";
+import { tout } from "./initPubSubManager";
 import {
   BasicCallback,
   parseCondition,
@@ -6,7 +8,6 @@ import {
   Subscription,
   SubscriptionParams,
 } from "./PubSubManager";
-import { VoidFunction } from "../SchemaWatch/SchemaWatch";
 
 type AddSubscriptionParams = SubscriptionParams & {
   condition: string;
@@ -27,12 +28,11 @@ export async function addSub(
     localFuncs,
     table_rules,
     filter = {},
-    params = {},
+    selectParams = {},
     condition = "",
-    throttle = 0, //subOne = false,
     viewOptions,
     table_info,
-    throttleOpts,
+    subscribeOptions,
   } = subscriptionParams;
   const table_name = table_info.name;
 
@@ -43,16 +43,7 @@ export async function addSub(
     throw "addSub: cannot have socket AND func";
   }
 
-  let validated_throttle = subscriptionParams.throttle || 10;
-  const pubThrottle = table_rules?.subscribe?.throttle || 0;
-  if (pubThrottle && Number.isInteger(pubThrottle) && pubThrottle > 0) {
-    validated_throttle = pubThrottle;
-  }
-  if (throttle && Number.isInteger(throttle) && throttle >= pubThrottle) {
-    validated_throttle = throttle;
-  }
-
-  const channel_name = `${this.socketChannelPreffix}.${table_name}.${JSON.stringify(filter)}.${JSON.stringify(params)}.${"m"}.sub`;
+  const channel_name = `${this.socketChannelPreffix}.${table_name}.${JSON.stringify(filter)}.${JSON.stringify(selectParams)}.${"m"}.sub`;
   const mainTrigger = {
     table_name: table_name,
     condition: parseCondition(condition),
@@ -63,16 +54,16 @@ export async function addSub(
     channel_name,
     filter,
     localFuncs,
-    params,
-    last_throttled: 0,
+    selectParams: selectParams,
+    lastPushed: 0,
     socket,
-    throttleOpts,
+    subscribeOptions,
     table_info,
     is_ready: true,
     is_throttling: false,
     socket_id: socket?.id,
     table_rules,
-    throttle: validated_throttle,
+
     triggers: [mainTrigger],
   };
 
@@ -105,14 +96,21 @@ export async function addSub(
     }
   }
 
+  const { skipFirst, throttleOpts, throttle } = subscribeOptions;
+  const sendFirstData = async () => {
+    if (skipFirst) return;
+    if (throttleOpts?.skipFirst && throttle) {
+      await tout(throttle);
+    }
+    void this.pushSubData(newSub);
+  };
+
   if (localFuncs) {
     /**
      * Must ensure sub will start sending data after all triggers are set up.
      * Socket clients are not affected as they need to confirm they are ready to receive data
      */
-    result.sendFirstData = () => {
-      void this.pushSubData(newSub);
-    };
+    result.sendFirstData = sendFirstData;
   } else if (socket) {
     const removeListeners = () => {
       socket.removeAllListeners(channel_name);
@@ -121,9 +119,7 @@ export async function addSub(
     };
     removeListeners();
 
-    socket.once(result.channelNameReady, () => {
-      void this.pushSubData(newSub);
-    });
+    socket.once(result.channelNameReady, sendFirstData);
     socket.once(result.channelNameUnsubscribe, (_data: any, cb: BasicCallback) => {
       const res = "ok";
       this.subs = this.subs.filter((s) => {

package/lib/PubSubManager/notifListener.ts

@@ -1,3 +1,4 @@
+import { parseFieldFilter } from "../DboBuilder/ViewHandler/parseFieldFilter";
 import { log, NOTIF_TYPE, NotifTypeName, pickKeys, PubSubManager } from "./PubSubManager";
 
 /* Relay relevant data to relevant subscriptions */
@@ -128,10 +129,22 @@ export async function notifListener(this: PubSubManager, data: { payload: string
         )
       );
       activeAndReadySubs.forEach((sub) => {
-        const { throttle = 0, throttleOpts } = sub;
-        if (!throttleOpts?.skipFirst && sub.last_throttled <= Date.now() - throttle) {
-          sub.last_throttled = Date.now();
+        const { throttle = 0, throttleOpts, actions } = sub.subscribeOptions;
+
+        const commandLowerCase = (op_name?.toLowerCase() || "insert") as keyof NonNullable<
+          typeof actions
+        >;
+
+        const actionIsIgnored =
+          actions &&
+          !parseFieldFilter(actions, false, ["insert", "update", "delete"]).includes(
+            commandLowerCase as any
+          );
+        if (actionIsIgnored) {
+          return;
+        }
 
+        if (!throttleOpts?.skipFirst && sub.lastPushed <= Date.now() - throttle) {
           /* It is assumed the policy was checked before this point */
           void this.pushSubData(sub);
         } else if (!sub.is_throttling) {
@@ -139,7 +152,6 @@ export async function notifListener(this: PubSubManager, data: { payload: string
           sub.is_throttling = setTimeout(() => {
             log("throttling finished. pushSubData...");
             sub.is_throttling = null;
-            sub.last_throttled = Date.now();
             void this.pushSubData(sub);
           }, throttle);
         }

package/lib/PubSubManager/pushSubData.ts

@@ -35,6 +35,7 @@ export async function pushSubData(this: PubSubManager, sub: Subscription, err?:
     return true;
   }
 
+  sub.lastPushed = Date.now();
   return new Promise(async (resolve, reject) => {
     /* TODO: Retire subOne -> it's redundant */
 
@@ -57,7 +58,6 @@ export async function pushSubData(this: PubSubManager, sub: Subscription, err?:
       } else {
         onLog("no client to push data to");
       }
-      // sub.last_throttled = Date.now();
     } else {
       onLog("fetch data error");
       const errObj = { _err_msg: err.toString(), err };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prostgles-server",
-  "version": "4.2.264",
+  "version": "4.2.266",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -15,6 +15,7 @@
     "test-only": "cd tests/ && ./test.sh",
     "test-quick": "cd tests/ && ./test.sh -quick",
     "test": "rm -rf ./node_modules/* && rm -rf ./dist/* && npm i && npm run lint && npm run test-only",
+    "test-server-funcs": "node --trace-uncaught --test dist/**/*.spec.js",
     "generate-docs": "rm -f ./docs/*.md && cd docs/utils && npm start",
     "pushpublish": "npm run generate-docs && npm version patch --git-tag-version false && git push && npm publish"
   },
@@ -56,7 +57,7 @@
     "pg": "^8.11.5",
     "pg-cursor": "^2.11.0",
     "pg-promise": "^11.9.1",
-    "prostgles-types": "^4.0.161"
+    "prostgles-types": "^4.0.164"
   },
   "devDependencies": {
     "@eslint/js": "^9.22.0",

package/tsconfig.json

@@ -20,6 +20,9 @@
     "declarationMap": true, 
     "noImplicitAny": true
   },
+  "include": [
+    "lib/**/*.spec.ts"
+  ],
   "exclude": [
     "dist"
   ]