@constructive-io/graphql-server 5.32.1 → 5.32.2

package/esm/middleware/graphile-introspection.js

@@ -1,17 +1,10 @@
 import { resolvePreset } from 'graphile-config';
+import { ScopedIntrospectionPreset } from 'graphile-scoped-introspection';
 import { makePgService } from 'graphile-settings';
-const SCOPED_INTROSPECTION_PLUGIN = 'ConstructivePgIntrospectionPlugin';
-let scopedIntrospectionPresetPromise;
-const loadScopedIntrospectionPreset = () => {
-    scopedIntrospectionPresetPromise ??=
-        import('graphile-scoped-introspection').then(({ ScopedIntrospectionPreset }) => ScopedIntrospectionPreset);
-    return scopedIntrospectionPresetPromise;
-};
+const SERVICE_NAME = 'main';
 /**
- * Resolve caller-provided Graphile configuration before deciding whether the
- * optional scoped introspection package is needed. Graphile config applies
- * nested `extends` entries before the containing preset, so this preserves the
- * same precedence used by the eventual schema build.
+ * Resolve caller-provided Graphile configuration with the same `extends`
+ * precedence used by the eventual schema build.
  */
 export const resolveCallerPreset = (graphileOptions) => {
     const preset = graphileOptions?.preset;
@@ -21,45 +14,29 @@ export const resolveCallerPreset = (graphileOptions) => {
     ];
     return presets.length > 0 ? resolvePreset({ extends: presets }) : undefined;
 };
-const hasLocalScopedIntrospectionPreset = (preset) => preset?.plugins.some((plugin) => plugin.name === SCOPED_INTROSPECTION_PLUGIN) ??
-    false;
-const hasUpstreamIntrospectionDisabled = (preset) => preset?.disablePlugins.includes('PgIntrospectionPlugin') ?? false;
+const isPlainObject = (value) => value !== null && typeof value === 'object' && !Array.isArray(value);
 /**
- * Select the stock or scoped introspection wiring once, while constructing a
- * server-owned schema handler. The stock branch returns before the scoped
- * package (and its upstream contract sentinel) is loaded.
+ * Every server handler introspects only its API's schemas and their dependency
+ * closure. Stock introspection reads the whole database into each cached
+ * handler, so it is not an option here: `main: false` is rejected. Caller
+ * options for `main` (catalog policy, capability extensions) are kept.
  */
-export const makeIntrospectionWiring = async (pool, schemas, graphileOptions, loadScopedPreset = loadScopedIntrospectionPreset, introspectionRole) => {
+export const makeIntrospectionWiring = (pool, schemas, graphileOptions, introspectionRole) => {
     const pgSettingsForIntrospection = introspectionRole ? { role: introspectionRole } : undefined;
     const pgService = makePgService({ pool, schemas, pgSettingsForIntrospection });
-    const callerPreset = resolveCallerPreset(graphileOptions);
-    const scopedConfig = callerPreset?.gather?.pgScopedIntrospection;
-    const hasScopedConfiguration = scopedConfig !== undefined;
-    // An explicitly supplied local preset already installs the replacement
-    // plugin. Keep that path synchronous and avoid importing the optional
-    // package a second time. A raw plugin entry may omit the stock plugin's
-    // disablement, so add that narrow preset to keep the replacement atomic.
-    if (hasLocalScopedIntrospectionPreset(callerPreset)) {
-        return {
-            presets: hasUpstreamIntrospectionDisabled(callerPreset)
-                ? []
-                : [{ disablePlugins: ['PgIntrospectionPlugin'] }],
-            pgService
-        };
+    const configured = resolveCallerPreset(graphileOptions)?.gather?.pgScopedIntrospection;
+    if (configured !== undefined && !isPlainObject(configured)) {
+        throw new Error('pgScopedIntrospection must be an object keyed by PostgreSQL service name');
     }
-    if (!hasScopedConfiguration) {
-        return {
-            presets: [],
-            pgService
-        };
+    if (configured?.[SERVICE_NAME] === false) {
+        throw new Error(`Schema-scoped introspection cannot be disabled for the server's '${SERVICE_NAME}' service: stock introspection retains the whole database in every cached handler`);
     }
-    // Load the replacement whenever the map is supplied, including an empty map,
-    // entries set to false, or entries keyed by an unknown service. The
-    // replacement owns validation; leaving it out would cause Graphile's stock
-    // plugin to silently ignore the gather option in those cases.
-    const scopedPreset = await loadScopedPreset();
     return {
-        presets: [scopedPreset],
-        pgService
+        presets: [ScopedIntrospectionPreset],
+        pgService,
+        pgScopedIntrospection: {
+            ...configured,
+            [SERVICE_NAME]: configured?.[SERVICE_NAME] ?? true
+        }
     };
 };

package/esm/middleware/graphile.js

@@ -2,7 +2,7 @@ import './types'; // for Request type
 import { errors } from '@constructive-io/errors';
 import { DEFAULT_REQUEST_PROTECTION, protectionPgSettings } from '@constructive-io/express-context';
 import { Logger } from '@pgpmjs/logger';
-import { createGraphileInstance, graphileCache } from 'graphile-cache';
+import { cacheGraphileInstance, createGraphileInstance, graphileCache } from 'graphile-cache';
 import { createFunctionBindingsPlugin } from 'graphile-function-bindings';
 import { createConstructivePreset, createGrafastCacheLimitsPreset } from 'graphile-settings';
 import { getPgPool } from 'pg-cache';
@@ -56,8 +56,8 @@ const reqLabel = (req) => (req.requestId ? `[${req.requestId}]` : '[req]');
  * plugin preset.  Without settings the default preset is used
  * (everything on except aggregates).
  */
-const buildPreset = async (pool, schemas, anonRole, roleName, introspectionRole, graphileOptions, databaseSettings, apiId, compute, webauthn) => {
-    const introspection = await makeIntrospectionWiring(pool, schemas, graphileOptions, undefined, introspectionRole);
+const buildPreset = (pool, schemas, anonRole, roleName, introspectionRole, graphileOptions, databaseSettings, apiId, compute, webauthn) => {
+    const introspection = makeIntrospectionWiring(pool, schemas, graphileOptions, introspectionRole);
     const configuredPreset = graphileOptions?.preset ?? {};
     const grafastCachePreset = createGrafastCacheLimitsPreset(graphileOptions?.grafastCache);
     return {
@@ -100,6 +100,10 @@ const buildPreset = async (pool, schemas, anonRole, roleName, introspectionRole,
                 : [])
         ],
         pgServices: [introspection.pgService],
+        gather: {
+            ...configuredPreset.gather,
+            pgScopedIntrospection: introspection.pgScopedIntrospection
+        },
         grafserv: {
             graphqlPath: '/graphql',
             graphiqlPath: '/graphiql',
@@ -279,7 +283,7 @@ export const graphile = (opts) => {
                     return instance.handler(req, res, next);
                 }
                 catch (error) {
-                    log.warn(`${label} Coalesced request failed for PostGraphile[${key}], retrying`);
+                    log.warn(`${label} Coalesced request failed for PostGraphile[${key}], retrying`, error);
                     // Fall through to Phase C to retry creation
                 }
             }
@@ -311,8 +315,8 @@ export const graphile = (opts) => {
             // concurrent requests coalesce while optional plugin modules load.
             const creationPromise = (async () => {
                 const compute = api.apiId ? await req.constructive?.useModule('compute') : undefined;
-                const preset = await buildPreset(pool, schema || [], anonRole, roleName, opts.api?.introspectionRole, opts.graphile, api.databaseSettings, api.apiId, compute, Boolean(api.webauthnSettings));
-                return observeGraphileBuild({
+                const preset = buildPreset(pool, schema || [], anonRole, roleName, opts.api?.introspectionRole, opts.graphile, api.databaseSettings, api.apiId, compute, Boolean(api.webauthnSettings));
+                const instance = await observeGraphileBuild({
                     cacheKey: key,
                     serviceKey: key,
                     databaseId: api.databaseId ?? null
@@ -321,11 +325,14 @@ export const graphile = (opts) => {
                     cacheKey: key,
                     enableRealtime: api.databaseSettings?.enableRealtime
                 }), { enabled: observabilityEnabled });
+                // Admission is part of the shared promise: a handler the cache rejects
+                // has been released, so coalesced waiters must not be handed it.
+                await cacheGraphileInstance(key, instance);
+                return instance;
             })();
             creating.set(key, creationPromise);
             try {
                 const instance = await creationPromise;
-                graphileCache.set(key, instance);
                 log.info(`${label} Cached PostGraphile v5 handler key=${key} db=${dbname}`);
                 return instance.handler(req, res, next);
             }

package/middleware/graphile-introspection.d.ts

@@ -1,23 +1,22 @@
-import type { GraphileOptions } from '@constructive-io/graphql-types';
+import type { GraphileOptions, PgScopedIntrospectionConfig } from '@constructive-io/graphql-types';
 import { type GraphileConfig } from 'graphile-config';
 import type { Pool } from 'pg';
 export interface IntrospectionWiring {
     presets: GraphileConfig.Preset[];
     pgService: GraphileConfig.PgServiceConfiguration;
+    pgScopedIntrospection: PgScopedIntrospectionConfig;
 }
-export type ScopedIntrospectionPresetLoader = () => Promise<GraphileConfig.Preset>;
 type ResolvedCallerPreset = GraphileConfig.ResolvedPreset | undefined;
 /**
- * Resolve caller-provided Graphile configuration before deciding whether the
- * optional scoped introspection package is needed. Graphile config applies
- * nested `extends` entries before the containing preset, so this preserves the
- * same precedence used by the eventual schema build.
+ * Resolve caller-provided Graphile configuration with the same `extends`
+ * precedence used by the eventual schema build.
  */
 export declare const resolveCallerPreset: (graphileOptions: GraphileOptions | undefined) => ResolvedCallerPreset;
 /**
- * Select the stock or scoped introspection wiring once, while constructing a
- * server-owned schema handler. The stock branch returns before the scoped
- * package (and its upstream contract sentinel) is loaded.
+ * Every server handler introspects only its API's schemas and their dependency
+ * closure. Stock introspection reads the whole database into each cached
+ * handler, so it is not an option here: `main: false` is rejected. Caller
+ * options for `main` (catalog policy, capability extensions) are kept.
  */
-export declare const makeIntrospectionWiring: (pool: Pool, schemas: string[], graphileOptions: GraphileOptions | undefined, loadScopedPreset?: ScopedIntrospectionPresetLoader, introspectionRole?: string) => Promise<IntrospectionWiring>;
+export declare const makeIntrospectionWiring: (pool: Pool, schemas: string[], graphileOptions: GraphileOptions | undefined, introspectionRole?: string) => IntrospectionWiring;
 export {};

package/middleware/graphile-introspection.js

@@ -2,19 +2,12 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeIntrospectionWiring = exports.resolveCallerPreset = void 0;
 const graphile_config_1 = require("graphile-config");
+const graphile_scoped_introspection_1 = require("graphile-scoped-introspection");
 const graphile_settings_1 = require("graphile-settings");
-const SCOPED_INTROSPECTION_PLUGIN = 'ConstructivePgIntrospectionPlugin';
-let scopedIntrospectionPresetPromise;
-const loadScopedIntrospectionPreset = () => {
-    scopedIntrospectionPresetPromise ??=
-        import('graphile-scoped-introspection').then(({ ScopedIntrospectionPreset }) => ScopedIntrospectionPreset);
-    return scopedIntrospectionPresetPromise;
-};
+const SERVICE_NAME = 'main';
 /**
- * Resolve caller-provided Graphile configuration before deciding whether the
- * optional scoped introspection package is needed. Graphile config applies
- * nested `extends` entries before the containing preset, so this preserves the
- * same precedence used by the eventual schema build.
+ * Resolve caller-provided Graphile configuration with the same `extends`
+ * precedence used by the eventual schema build.
  */
 const resolveCallerPreset = (graphileOptions) => {
     const preset = graphileOptions?.preset;
@@ -25,46 +18,30 @@ const resolveCallerPreset = (graphileOptions) => {
     return presets.length > 0 ? (0, graphile_config_1.resolvePreset)({ extends: presets }) : undefined;
 };
 exports.resolveCallerPreset = resolveCallerPreset;
-const hasLocalScopedIntrospectionPreset = (preset) => preset?.plugins.some((plugin) => plugin.name === SCOPED_INTROSPECTION_PLUGIN) ??
-    false;
-const hasUpstreamIntrospectionDisabled = (preset) => preset?.disablePlugins.includes('PgIntrospectionPlugin') ?? false;
+const isPlainObject = (value) => value !== null && typeof value === 'object' && !Array.isArray(value);
 /**
- * Select the stock or scoped introspection wiring once, while constructing a
- * server-owned schema handler. The stock branch returns before the scoped
- * package (and its upstream contract sentinel) is loaded.
+ * Every server handler introspects only its API's schemas and their dependency
+ * closure. Stock introspection reads the whole database into each cached
+ * handler, so it is not an option here: `main: false` is rejected. Caller
+ * options for `main` (catalog policy, capability extensions) are kept.
  */
-const makeIntrospectionWiring = async (pool, schemas, graphileOptions, loadScopedPreset = loadScopedIntrospectionPreset, introspectionRole) => {
+const makeIntrospectionWiring = (pool, schemas, graphileOptions, introspectionRole) => {
     const pgSettingsForIntrospection = introspectionRole ? { role: introspectionRole } : undefined;
     const pgService = (0, graphile_settings_1.makePgService)({ pool, schemas, pgSettingsForIntrospection });
-    const callerPreset = (0, exports.resolveCallerPreset)(graphileOptions);
-    const scopedConfig = callerPreset?.gather?.pgScopedIntrospection;
-    const hasScopedConfiguration = scopedConfig !== undefined;
-    // An explicitly supplied local preset already installs the replacement
-    // plugin. Keep that path synchronous and avoid importing the optional
-    // package a second time. A raw plugin entry may omit the stock plugin's
-    // disablement, so add that narrow preset to keep the replacement atomic.
-    if (hasLocalScopedIntrospectionPreset(callerPreset)) {
-        return {
-            presets: hasUpstreamIntrospectionDisabled(callerPreset)
-                ? []
-                : [{ disablePlugins: ['PgIntrospectionPlugin'] }],
-            pgService
-        };
+    const configured = (0, exports.resolveCallerPreset)(graphileOptions)?.gather?.pgScopedIntrospection;
+    if (configured !== undefined && !isPlainObject(configured)) {
+        throw new Error('pgScopedIntrospection must be an object keyed by PostgreSQL service name');
     }
-    if (!hasScopedConfiguration) {
-        return {
-            presets: [],
-            pgService
-        };
+    if (configured?.[SERVICE_NAME] === false) {
+        throw new Error(`Schema-scoped introspection cannot be disabled for the server's '${SERVICE_NAME}' service: stock introspection retains the whole database in every cached handler`);
     }
-    // Load the replacement whenever the map is supplied, including an empty map,
-    // entries set to false, or entries keyed by an unknown service. The
-    // replacement owns validation; leaving it out would cause Graphile's stock
-    // plugin to silently ignore the gather option in those cases.
-    const scopedPreset = await loadScopedPreset();
     return {
-        presets: [scopedPreset],
-        pgService
+        presets: [graphile_scoped_introspection_1.ScopedIntrospectionPreset],
+        pgService,
+        pgScopedIntrospection: {
+            ...configured,
+            [SERVICE_NAME]: configured?.[SERVICE_NAME] ?? true
+        }
     };
 };
 exports.makeIntrospectionWiring = makeIntrospectionWiring;

package/middleware/graphile.js

@@ -62,8 +62,8 @@ const reqLabel = (req) => (req.requestId ? `[${req.requestId}]` : '[req]');
  * plugin preset.  Without settings the default preset is used
  * (everything on except aggregates).
  */
-const buildPreset = async (pool, schemas, anonRole, roleName, introspectionRole, graphileOptions, databaseSettings, apiId, compute, webauthn) => {
-    const introspection = await (0, graphile_introspection_1.makeIntrospectionWiring)(pool, schemas, graphileOptions, undefined, introspectionRole);
+const buildPreset = (pool, schemas, anonRole, roleName, introspectionRole, graphileOptions, databaseSettings, apiId, compute, webauthn) => {
+    const introspection = (0, graphile_introspection_1.makeIntrospectionWiring)(pool, schemas, graphileOptions, introspectionRole);
     const configuredPreset = graphileOptions?.preset ?? {};
     const grafastCachePreset = (0, graphile_settings_1.createGrafastCacheLimitsPreset)(graphileOptions?.grafastCache);
     return {
@@ -106,6 +106,10 @@ const buildPreset = async (pool, schemas, anonRole, roleName, introspectionRole,
                 : [])
         ],
         pgServices: [introspection.pgService],
+        gather: {
+            ...configuredPreset.gather,
+            pgScopedIntrospection: introspection.pgScopedIntrospection
+        },
         grafserv: {
             graphqlPath: '/graphql',
             graphiqlPath: '/graphiql',
@@ -285,7 +289,7 @@ const graphile = (opts) => {
                     return instance.handler(req, res, next);
                 }
                 catch (error) {
-                    log.warn(`${label} Coalesced request failed for PostGraphile[${key}], retrying`);
+                    log.warn(`${label} Coalesced request failed for PostGraphile[${key}], retrying`, error);
                     // Fall through to Phase C to retry creation
                 }
             }
@@ -317,8 +321,8 @@ const graphile = (opts) => {
             // concurrent requests coalesce while optional plugin modules load.
             const creationPromise = (async () => {
                 const compute = api.apiId ? await req.constructive?.useModule('compute') : undefined;
-                const preset = await buildPreset(pool, schema || [], anonRole, roleName, opts.api?.introspectionRole, opts.graphile, api.databaseSettings, api.apiId, compute, Boolean(api.webauthnSettings));
-                return (0, graphile_build_stats_1.observeGraphileBuild)({
+                const preset = buildPreset(pool, schema || [], anonRole, roleName, opts.api?.introspectionRole, opts.graphile, api.databaseSettings, api.apiId, compute, Boolean(api.webauthnSettings));
+                const instance = await (0, graphile_build_stats_1.observeGraphileBuild)({
                     cacheKey: key,
                     serviceKey: key,
                     databaseId: api.databaseId ?? null
@@ -327,11 +331,14 @@ const graphile = (opts) => {
                     cacheKey: key,
                     enableRealtime: api.databaseSettings?.enableRealtime
                 }), { enabled: observabilityEnabled });
+                // Admission is part of the shared promise: a handler the cache rejects
+                // has been released, so coalesced waiters must not be handed it.
+                await (0, graphile_cache_1.cacheGraphileInstance)(key, instance);
+                return instance;
             })();
             creating.set(key, creationPromise);
             try {
                 const instance = await creationPromise;
-                graphile_cache_1.graphileCache.set(key, instance);
                 log.info(`${label} Cached PostGraphile v5 handler key=${key} db=${dbname}`);
                 return instance.handler(req, res, next);
             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructive-io/graphql-server",
-  "version": "5.32.1",
+  "version": "5.32.2",
   "author": "Constructive <developers@constructive.io>",
   "description": "Constructive GraphQL Server",
   "main": "index.js",
@@ -44,7 +44,7 @@
     "@constructive-io/csrf": "^0.31.0",
     "@constructive-io/errors": "^0.25.0",
     "@constructive-io/express-context": "^0.35.0",
-    "@constructive-io/graphql-env": "^3.37.0",
+    "@constructive-io/graphql-env": "^3.37.1",
     "@constructive-io/graphql-types": "^3.36.0",
     "@constructive-io/llm-env": "^0.16.0",
     "@constructive-io/query-builder": "^3.17.0",
@@ -65,13 +65,13 @@
     "grafserv": "1.0.1",
     "graphile-build": "5.1.1",
     "graphile-build-pg": "5.1.3",
-    "graphile-cache": "^4.16.0",
+    "graphile-cache": "^4.16.1",
     "graphile-config": "1.1.0",
-    "graphile-function-bindings": "^1.18.0",
+    "graphile-function-bindings": "^1.18.1",
     "graphile-plugin-utils": "^1.14.0",
     "graphile-presigned-url-plugin": "^1.23.1",
     "graphile-scoped-introspection": "^0.5.0",
-    "graphile-settings": "^6.26.1",
+    "graphile-settings": "^6.26.2",
     "graphile-utils": "5.0.3",
     "graphql": "16.13.0",
     "graphql-upload": "^13.0.0",
@@ -94,11 +94,11 @@
     "@types/request-ip": "^0.0.41",
     "@types/supertest": "^7.2.1",
     "cookie-parser": "^1.4.7",
-    "graphile-test": "5.18.0",
+    "graphile-test": "5.18.1",
     "makage": "^0.8.0",
     "nodemon": "^3.1.14",
     "supertest": "^7.2.2",
     "ts-node": "^10.9.2"
   },
-  "gitHead": "6cbaa8605270a2e019439fd9f444a35b3f2a9de0"
+  "gitHead": "91e18cc80da92331fb3aadd5baa43251c8934bc8"
 }