graphile-cache 3.8.0 → 3.10.1

package/create-instance.d.ts

@@ -2,6 +2,12 @@ import type { GraphileCacheEntry } from './graphile-cache';
 interface GraphileInstanceOptions {
     preset: any;
     cacheKey: string;
+    /**
+     * When true, a RealtimeManager is created and started alongside the
+     * PostGraphile instance.  The pool is extracted from the preset's
+     * pgServices (managed by pg-cache) rather than passed separately.
+     */
+    enableRealtime?: boolean;
 }
 /**
  * Create a PostGraphile v5 instance backed by grafserv/express.
@@ -12,6 +18,12 @@ interface GraphileInstanceOptions {
  *
  * Callers are responsible for building the `GraphileConfig.Preset` (including
  * pgServices, grafserv options, grafast context, etc.) before passing it here.
+ *
+ * When `enableRealtime` is true, a RealtimeManager is created that bridges
+ * cursor-tracked events from `drain_changes()` into the PostGraphile
+ * instance's PgSubscriber EventEmitter.  Both `pgSubscriber` and the pg
+ * pool are extracted from the resolved preset's pgServices — no separate
+ * pool parameter is needed.
  */
 export declare const createGraphileInstance: (opts: GraphileInstanceOptions) => Promise<GraphileCacheEntry>;
 export {};

package/create-instance.js

@@ -5,9 +5,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createGraphileInstance = void 0;
 const node_http_1 = require("node:http");
+const logger_1 = require("@pgpmjs/logger");
 const express_1 = __importDefault(require("express"));
 const postgraphile_1 = require("postgraphile");
 const v4_1 = require("grafserv/express/v4");
+const log = new logger_1.Logger('graphile-cache:create');
 /**
  * Create a PostGraphile v5 instance backed by grafserv/express.
  *
@@ -17,16 +19,22 @@ const v4_1 = require("grafserv/express/v4");
  *
  * Callers are responsible for building the `GraphileConfig.Preset` (including
  * pgServices, grafserv options, grafast context, etc.) before passing it here.
+ *
+ * When `enableRealtime` is true, a RealtimeManager is created that bridges
+ * cursor-tracked events from `drain_changes()` into the PostGraphile
+ * instance's PgSubscriber EventEmitter.  Both `pgSubscriber` and the pg
+ * pool are extracted from the resolved preset's pgServices — no separate
+ * pool parameter is needed.
  */
 const createGraphileInstance = async (opts) => {
-    const { preset, cacheKey } = opts;
+    const { preset, cacheKey, enableRealtime = false } = opts;
     const pgl = (0, postgraphile_1.postgraphile)(preset);
     const serv = pgl.createServ(v4_1.grafserv);
     const handler = (0, express_1.default)();
     const httpServer = (0, node_http_1.createServer)(handler);
     await serv.addTo(handler, httpServer);
     await serv.ready();
-    return {
+    const entry = {
         pgl,
         serv,
         handler,
@@ -34,5 +42,38 @@ const createGraphileInstance = async (opts) => {
         cacheKey,
         createdAt: Date.now(),
     };
+    if (enableRealtime) {
+        try {
+            const { RealtimeManager } = await import('graphile-realtime-subscriptions');
+            // Extract PgSubscriber and pool from the resolved preset's pgServices.
+            // The pool is the same instance managed by pg-cache (via getPgPool)
+            // and threaded into the preset by makePgService({ pool, schemas }).
+            const resolvedPreset = pgl.getResolvedPreset();
+            const pgService = resolvedPreset.pgServices?.[0];
+            const pgSubscriber = pgService?.pgSubscriber ?? null;
+            const pool = pgService?.adaptorSettings?.pool ?? null;
+            if (!pgSubscriber) {
+                log.warn(`PostGraphile[${cacheKey}] has no pgSubscriber — RealtimeManager will not be started`);
+            }
+            else if (!pool) {
+                log.warn(`PostGraphile[${cacheKey}] has no pool in pgService — RealtimeManager will not be started`);
+            }
+            else {
+                const manager = new RealtimeManager({
+                    pgSubscriber,
+                    pool,
+                    nodeId: `graphile-cache:${cacheKey}`,
+                    schema: 'realtime_public',
+                });
+                await manager.start();
+                entry.realtimeManager = manager;
+                log.info(`RealtimeManager started for PostGraphile[${cacheKey}]`);
+            }
+        }
+        catch (err) {
+            log.error(`Failed to start RealtimeManager for PostGraphile[${cacheKey}]:`, err);
+        }
+    }
+    return entry;
 };
 exports.createGraphileInstance = createGraphileInstance;

package/esm/create-instance.js

@@ -1,7 +1,9 @@
 import { createServer } from 'node:http';
+import { Logger } from '@pgpmjs/logger';
 import express from 'express';
 import { postgraphile } from 'postgraphile';
 import { grafserv } from 'grafserv/express/v4';
+const log = new Logger('graphile-cache:create');
 /**
  * Create a PostGraphile v5 instance backed by grafserv/express.
  *
@@ -11,16 +13,22 @@ import { grafserv } from 'grafserv/express/v4';
  *
  * Callers are responsible for building the `GraphileConfig.Preset` (including
  * pgServices, grafserv options, grafast context, etc.) before passing it here.
+ *
+ * When `enableRealtime` is true, a RealtimeManager is created that bridges
+ * cursor-tracked events from `drain_changes()` into the PostGraphile
+ * instance's PgSubscriber EventEmitter.  Both `pgSubscriber` and the pg
+ * pool are extracted from the resolved preset's pgServices — no separate
+ * pool parameter is needed.
  */
 export const createGraphileInstance = async (opts) => {
-    const { preset, cacheKey } = opts;
+    const { preset, cacheKey, enableRealtime = false } = opts;
     const pgl = postgraphile(preset);
     const serv = pgl.createServ(grafserv);
     const handler = express();
     const httpServer = createServer(handler);
     await serv.addTo(handler, httpServer);
     await serv.ready();
-    return {
+    const entry = {
         pgl,
         serv,
         handler,
@@ -28,4 +36,37 @@ export const createGraphileInstance = async (opts) => {
         cacheKey,
         createdAt: Date.now(),
     };
+    if (enableRealtime) {
+        try {
+            const { RealtimeManager } = await import('graphile-realtime-subscriptions');
+            // Extract PgSubscriber and pool from the resolved preset's pgServices.
+            // The pool is the same instance managed by pg-cache (via getPgPool)
+            // and threaded into the preset by makePgService({ pool, schemas }).
+            const resolvedPreset = pgl.getResolvedPreset();
+            const pgService = resolvedPreset.pgServices?.[0];
+            const pgSubscriber = pgService?.pgSubscriber ?? null;
+            const pool = pgService?.adaptorSettings?.pool ?? null;
+            if (!pgSubscriber) {
+                log.warn(`PostGraphile[${cacheKey}] has no pgSubscriber — RealtimeManager will not be started`);
+            }
+            else if (!pool) {
+                log.warn(`PostGraphile[${cacheKey}] has no pool in pgService — RealtimeManager will not be started`);
+            }
+            else {
+                const manager = new RealtimeManager({
+                    pgSubscriber,
+                    pool,
+                    nodeId: `graphile-cache:${cacheKey}`,
+                    schema: 'realtime_public',
+                });
+                await manager.start();
+                entry.realtimeManager = manager;
+                log.info(`RealtimeManager started for PostGraphile[${cacheKey}]`);
+            }
+        }
+        catch (err) {
+            log.error(`Failed to start RealtimeManager for PostGraphile[${cacheKey}]:`, err);
+        }
+    }
+    return entry;
 };

package/esm/graphile-cache.js

@@ -66,6 +66,15 @@ const disposeEntry = async (entry, key) => {
                 entry.httpServer.close(() => resolve());
             });
         }
+        // Stop RealtimeManager if present (before releasing PostGraphile)
+        if (entry.realtimeManager) {
+            try {
+                await entry.realtimeManager.stop();
+            }
+            catch (err) {
+                log.error(`Error stopping RealtimeManager for PostGraphile[${key}]:`, err);
+            }
+        }
         // Release PostGraphile instance (this also releases grafserv internally)
         if (entry.pgl) {
             await entry.pgl.release();

package/graphile-cache.d.ts

@@ -49,6 +49,10 @@ export interface GraphileCacheEntry {
     httpServer: HttpServer;
     cacheKey: string;
     createdAt: number;
+    /** Optional RealtimeManager for cursor-tracked subscription delivery */
+    realtimeManager?: {
+        stop(): Promise<void>;
+    } | null;
 }
 export declare const graphileCache: LRUCache<string, GraphileCacheEntry, unknown>;
 export interface CacheStats {

package/graphile-cache.js

@@ -73,6 +73,15 @@ const disposeEntry = async (entry, key) => {
                 entry.httpServer.close(() => resolve());
             });
         }
+        // Stop RealtimeManager if present (before releasing PostGraphile)
+        if (entry.realtimeManager) {
+            try {
+                await entry.realtimeManager.stop();
+            }
+            catch (err) {
+                log.error(`Error stopping RealtimeManager for PostGraphile[${key}]:`, err);
+            }
+        }
         // Release PostGraphile instance (this also releases grafserv internally)
         if (entry.pgl) {
             await entry.pgl.release();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "graphile-cache",
-  "version": "3.8.0",
+  "version": "3.10.1",
   "author": "Constructive <developers@constructive.io>",
   "description": "PostGraphile v5 LRU cache with automatic pool cleanup integration",
   "main": "index.js",
@@ -29,11 +29,12 @@
     "test:watch": "jest --watch"
   },
   "dependencies": {
-    "@pgpmjs/logger": "^2.9.0",
+    "@pgpmjs/logger": "^2.10.1",
     "express": "^5.2.1",
     "grafserv": "1.0.0",
+    "graphile-realtime-subscriptions": "^0.5.2",
     "lru-cache": "^11.2.7",
-    "pg-cache": "^3.8.0",
+    "pg-cache": "^3.9.1",
     "postgraphile": "5.0.0"
   },
   "devDependencies": {
@@ -51,5 +52,5 @@
     "constructive",
     "v5"
   ],
-  "gitHead": "0538fe39630e6bafd228cb3f2b114fff4f9a61aa"
+  "gitHead": "d43f1d7e38cc39a71b4f8d2cafb39f46df12e31a"
 }