@constructive-io/graphql-server 4.3.3 → 4.4.0

package/esm/middleware/debug-memory.js

@@ -0,0 +1,54 @@
+import { getNodeEnv } from '@constructive-io/graphql-env';
+import { Logger } from '@pgpmjs/logger';
+import { svcCache } from '@pgpmjs/server-utils';
+import { getCacheStats } from 'graphile-cache';
+import { getInFlightCount, getInFlightKeys } from './graphile';
+const log = new Logger('debug-memory');
+const toMB = (bytes) => `${(bytes / 1024 / 1024).toFixed(1)} MB`;
+/**
+ * Development-only debug endpoint for monitoring memory usage and cache state.
+ *
+ * Mounts GET /debug/memory which returns:
+ * - Node.js process memory (heap, RSS, external, array buffers)
+ * - Graphile cache stats (size, max, TTL, keys with ages)
+ * - Service cache size
+ * - In-flight handler creation count
+ * - Process uptime
+ *
+ * This endpoint is only available when NODE_ENV=development.
+ * In production, it returns 404.
+ */
+export const debugMemory = (_req, res) => {
+    if (getNodeEnv() !== 'development') {
+        res.status(404).send('Not found');
+        return;
+    }
+    const mem = process.memoryUsage();
+    const cacheStats = getCacheStats();
+    const response = {
+        memory: {
+            heapUsed: toMB(mem.heapUsed),
+            heapTotal: toMB(mem.heapTotal),
+            rss: toMB(mem.rss),
+            external: toMB(mem.external),
+            arrayBuffers: toMB(mem.arrayBuffers),
+        },
+        graphileCache: {
+            size: cacheStats.size,
+            max: cacheStats.max,
+            ttl: `${(cacheStats.ttl / 1000 / 60).toFixed(0)} min`,
+            keys: cacheStats.keys,
+        },
+        svcCache: {
+            size: svcCache.size,
+        },
+        inFlight: {
+            count: getInFlightCount(),
+            keys: getInFlightKeys(),
+        },
+        uptime: `${(process.uptime() / 60).toFixed(1)} min`,
+        timestamp: new Date().toISOString(),
+    };
+    log.debug('Memory snapshot:', response);
+    res.json(response);
+};

package/esm/server.js

@@ -17,6 +17,7 @@ import { flush, flushService } from './middleware/flush';
 import { graphile } from './middleware/graphile';
 import { multipartBridge } from './middleware/multipart-bridge';
 import { createUploadAuthenticateMiddleware, uploadRoute } from './middleware/upload';
+import { debugMemory } from './middleware/debug-memory';
 import { normalizeServerOptions } from './options';
 const log = new Logger('server');
 /**
@@ -103,6 +104,7 @@ class Server {
             roleName: apiOpts.roleName,
         });
         healthz(app);
+        app.get('/debug/memory', debugMemory);
         app.use(favicon);
         trustProxy(app, effectiveOpts.server.trustProxy);
         // Warn if a global CORS override is set in production

package/middleware/debug-memory.d.ts

@@ -0,0 +1,15 @@
+import type { RequestHandler } from 'express';
+/**
+ * Development-only debug endpoint for monitoring memory usage and cache state.
+ *
+ * Mounts GET /debug/memory which returns:
+ * - Node.js process memory (heap, RSS, external, array buffers)
+ * - Graphile cache stats (size, max, TTL, keys with ages)
+ * - Service cache size
+ * - In-flight handler creation count
+ * - Process uptime
+ *
+ * This endpoint is only available when NODE_ENV=development.
+ * In production, it returns 404.
+ */
+export declare const debugMemory: RequestHandler;

package/middleware/debug-memory.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.debugMemory = void 0;
+const graphql_env_1 = require("@constructive-io/graphql-env");
+const logger_1 = require("@pgpmjs/logger");
+const server_utils_1 = require("@pgpmjs/server-utils");
+const graphile_cache_1 = require("graphile-cache");
+const graphile_1 = require("./graphile");
+const log = new logger_1.Logger('debug-memory');
+const toMB = (bytes) => `${(bytes / 1024 / 1024).toFixed(1)} MB`;
+/**
+ * Development-only debug endpoint for monitoring memory usage and cache state.
+ *
+ * Mounts GET /debug/memory which returns:
+ * - Node.js process memory (heap, RSS, external, array buffers)
+ * - Graphile cache stats (size, max, TTL, keys with ages)
+ * - Service cache size
+ * - In-flight handler creation count
+ * - Process uptime
+ *
+ * This endpoint is only available when NODE_ENV=development.
+ * In production, it returns 404.
+ */
+const debugMemory = (_req, res) => {
+    if ((0, graphql_env_1.getNodeEnv)() !== 'development') {
+        res.status(404).send('Not found');
+        return;
+    }
+    const mem = process.memoryUsage();
+    const cacheStats = (0, graphile_cache_1.getCacheStats)();
+    const response = {
+        memory: {
+            heapUsed: toMB(mem.heapUsed),
+            heapTotal: toMB(mem.heapTotal),
+            rss: toMB(mem.rss),
+            external: toMB(mem.external),
+            arrayBuffers: toMB(mem.arrayBuffers),
+        },
+        graphileCache: {
+            size: cacheStats.size,
+            max: cacheStats.max,
+            ttl: `${(cacheStats.ttl / 1000 / 60).toFixed(0)} min`,
+            keys: cacheStats.keys,
+        },
+        svcCache: {
+            size: server_utils_1.svcCache.size,
+        },
+        inFlight: {
+            count: (0, graphile_1.getInFlightCount)(),
+            keys: (0, graphile_1.getInFlightKeys)(),
+        },
+        uptime: `${(process.uptime() / 60).toFixed(1)} min`,
+        timestamp: new Date().toISOString(),
+    };
+    log.debug('Memory snapshot:', response);
+    res.json(response);
+};
+exports.debugMemory = debugMemory;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructive-io/graphql-server",
-  "version": "4.3.3",
+  "version": "4.4.0",
   "author": "Constructive <developers@constructive.io>",
   "description": "Constructive GraphQL Server",
   "main": "index.js",
@@ -59,7 +59,7 @@
     "graphile-build-pg": "5.0.0-rc.5",
     "graphile-cache": "^3.1.0",
     "graphile-config": "1.0.0-rc.5",
-    "graphile-settings": "^4.3.3",
+    "graphile-settings": "^4.4.0",
     "graphile-utils": "5.0.0-rc.5",
     "graphql": "^16.9.0",
     "graphql-upload": "^13.0.0",
@@ -82,10 +82,10 @@
     "@types/multer": "^1.4.12",
     "@types/pg": "^8.16.0",
     "@types/request-ip": "^0.0.41",
-    "graphile-test": "4.2.3",
+    "graphile-test": "4.2.4",
     "makage": "^0.1.10",
     "nodemon": "^3.1.10",
     "ts-node": "^10.9.2"
   },
-  "gitHead": "0deec313ff9af77b02cb749be9ef34e236e8cab8"
+  "gitHead": "c9364ffbc4d4a6b1b3750f0a5e347a7290d8d4ce"
 }

package/server.js

@@ -23,6 +23,7 @@ const flush_1 = require("./middleware/flush");
 const graphile_1 = require("./middleware/graphile");
 const multipart_bridge_1 = require("./middleware/multipart-bridge");
 const upload_1 = require("./middleware/upload");
+const debug_memory_1 = require("./middleware/debug-memory");
 const options_1 = require("./options");
 const log = new logger_1.Logger('server');
 /**
@@ -110,6 +111,7 @@ class Server {
             roleName: apiOpts.roleName,
         });
         (0, server_utils_1.healthz)(app);
+        app.get('/debug/memory', debug_memory_1.debugMemory);
         app.use(favicon_1.favicon);
         (0, server_utils_1.trustProxy)(app, effectiveOpts.server.trustProxy);
         // Warn if a global CORS override is set in production