@constructive-io/graphql-env 3.34.2 → 3.34.4

package/README.md

@@ -99,6 +99,14 @@ Restart the server after changing its environment. `capabilityExtensions`
 retains introspection metadata for extension capabilities; it does not install
 PostgreSQL extensions or change the API's exposed schemas.
 
+### Grafast Cache Limits
+- `GRAPHILE_QUERY_CACHE_MAX_LENGTH` - Maximum parsed and validated queries retained per schema
+- `GRAPHILE_OPERATIONS_CACHE_MAX_LENGTH` - Maximum operations retained for plan lookup per schema
+- `GRAPHILE_OPERATION_PLANS_CACHE_MAX_LENGTH` - Maximum context/variable-specific plans retained per operation
+
+Each cache limit must be a safe integer of at least `2`. When omitted, Grafast's
+upstream default for that cache remains in effect.
+
 ### Feature Flags
 - `FEATURES_SIMPLE_INFLECTION` - Enable simple inflection plugin
 - `FEATURES_OPPOSITE_BASE_NAMES` - Enable opposite base names

package/env.js

@@ -2,18 +2,24 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getGraphQLEnvVars = void 0;
 const _12factor_env_1 = require("12factor-env");
+const grafast_cache_limits_1 = require("./grafast-cache-limits");
 const scoped_introspection_1 = require("./scoped-introspection");
 /**
  * @param env - Environment object to read from (defaults to process.env for backwards compatibility)
  */
 const getGraphQLEnvVars = (env = process.env) => {
     const scopedIntrospection = (0, scoped_introspection_1.getScopedIntrospectionEnv)(env);
-    const { GRAPHILE_SCHEMA, FEATURES_SIMPLE_INFLECTION, FEATURES_OPPOSITE_BASE_NAMES, FEATURES_POSTGIS, API_ROUTING_SCHEMA, API_IS_PUBLIC, API_EXPOSED_SCHEMAS, API_META_SCHEMAS, API_ANON_ROLE, API_ROLE_NAME, API_FLUSH_TOKEN, API_INTROSPECTION_ROLE, EMBEDDER_PROVIDER, EMBEDDER_MODEL, EMBEDDER_BASE_URL, CHAT_PROVIDER, CHAT_MODEL, CHAT_BASE_URL, SMS_PROVIDER, SMS_SENDER_ID, SMS_REQUEST_TIMEOUT_MS, SEND_SMS_DRY_RUN, DEVSMS_BASE_URL } = env;
+    const { GRAPHILE_SCHEMA, GRAPHILE_QUERY_CACHE_MAX_LENGTH, GRAPHILE_OPERATIONS_CACHE_MAX_LENGTH, GRAPHILE_OPERATION_PLANS_CACHE_MAX_LENGTH, FEATURES_SIMPLE_INFLECTION, FEATURES_OPPOSITE_BASE_NAMES, FEATURES_POSTGIS, API_ROUTING_SCHEMA, API_IS_PUBLIC, API_EXPOSED_SCHEMAS, API_META_SCHEMAS, API_ANON_ROLE, API_ROLE_NAME, API_FLUSH_TOKEN, API_INTROSPECTION_ROLE, EMBEDDER_PROVIDER, EMBEDDER_MODEL, EMBEDDER_BASE_URL, CHAT_PROVIDER, CHAT_MODEL, CHAT_BASE_URL, SMS_PROVIDER, SMS_SENDER_ID, SMS_REQUEST_TIMEOUT_MS, SEND_SMS_DRY_RUN, DEVSMS_BASE_URL } = env;
     // Keep this function as a partial env-override parser. SMS runtime defaults
     // belong to the consuming application; injecting them here would incorrectly
     // let an absent env var overwrite pgpm.json or consumer-specific values.
     const smsRequestTimeoutMs = (0, _12factor_env_1.parseEnvNumber)(SMS_REQUEST_TIMEOUT_MS);
     const smsDryRun = (0, _12factor_env_1.parseEnvBoolean)(SEND_SMS_DRY_RUN);
+    const hasGrafastCacheLimits = [
+        GRAPHILE_QUERY_CACHE_MAX_LENGTH,
+        GRAPHILE_OPERATIONS_CACHE_MAX_LENGTH,
+        GRAPHILE_OPERATION_PLANS_CACHE_MAX_LENGTH
+    ].some(value => value !== undefined);
     const hasSmsEnvOverrides = Boolean(SMS_PROVIDER ||
         SMS_SENDER_ID ||
         smsRequestTimeoutMs !== undefined ||
@@ -28,6 +34,13 @@ const getGraphQLEnvVars = (env = process.env) => {
                     }
                 }
             }),
+            ...(hasGrafastCacheLimits && {
+                grafastCache: (0, grafast_cache_limits_1.normalizeGrafastCacheLimits)({
+                    queryCacheMaxLength: (0, grafast_cache_limits_1.parseGrafastCacheLimitEnv)(GRAPHILE_QUERY_CACHE_MAX_LENGTH, 'GRAPHILE_QUERY_CACHE_MAX_LENGTH'),
+                    operationsCacheMaxLength: (0, grafast_cache_limits_1.parseGrafastCacheLimitEnv)(GRAPHILE_OPERATIONS_CACHE_MAX_LENGTH, 'GRAPHILE_OPERATIONS_CACHE_MAX_LENGTH'),
+                    operationOperationPlansCacheMaxLength: (0, grafast_cache_limits_1.parseGrafastCacheLimitEnv)(GRAPHILE_OPERATION_PLANS_CACHE_MAX_LENGTH, 'GRAPHILE_OPERATION_PLANS_CACHE_MAX_LENGTH')
+                })
+            }),
             ...(GRAPHILE_SCHEMA && {
                 schema: GRAPHILE_SCHEMA.includes(',')
                     ? GRAPHILE_SCHEMA.split(',').map(s => s.trim())

package/esm/env.js

@@ -1,16 +1,22 @@
 import { parseEnvBoolean, parseEnvNumber } from '12factor-env';
+import { normalizeGrafastCacheLimits, parseGrafastCacheLimitEnv } from './grafast-cache-limits';
 import { getScopedIntrospectionEnv } from './scoped-introspection';
 /**
  * @param env - Environment object to read from (defaults to process.env for backwards compatibility)
  */
 export const getGraphQLEnvVars = (env = process.env) => {
     const scopedIntrospection = getScopedIntrospectionEnv(env);
-    const { GRAPHILE_SCHEMA, FEATURES_SIMPLE_INFLECTION, FEATURES_OPPOSITE_BASE_NAMES, FEATURES_POSTGIS, API_ROUTING_SCHEMA, API_IS_PUBLIC, API_EXPOSED_SCHEMAS, API_META_SCHEMAS, API_ANON_ROLE, API_ROLE_NAME, API_FLUSH_TOKEN, API_INTROSPECTION_ROLE, EMBEDDER_PROVIDER, EMBEDDER_MODEL, EMBEDDER_BASE_URL, CHAT_PROVIDER, CHAT_MODEL, CHAT_BASE_URL, SMS_PROVIDER, SMS_SENDER_ID, SMS_REQUEST_TIMEOUT_MS, SEND_SMS_DRY_RUN, DEVSMS_BASE_URL } = env;
+    const { GRAPHILE_SCHEMA, GRAPHILE_QUERY_CACHE_MAX_LENGTH, GRAPHILE_OPERATIONS_CACHE_MAX_LENGTH, GRAPHILE_OPERATION_PLANS_CACHE_MAX_LENGTH, FEATURES_SIMPLE_INFLECTION, FEATURES_OPPOSITE_BASE_NAMES, FEATURES_POSTGIS, API_ROUTING_SCHEMA, API_IS_PUBLIC, API_EXPOSED_SCHEMAS, API_META_SCHEMAS, API_ANON_ROLE, API_ROLE_NAME, API_FLUSH_TOKEN, API_INTROSPECTION_ROLE, EMBEDDER_PROVIDER, EMBEDDER_MODEL, EMBEDDER_BASE_URL, CHAT_PROVIDER, CHAT_MODEL, CHAT_BASE_URL, SMS_PROVIDER, SMS_SENDER_ID, SMS_REQUEST_TIMEOUT_MS, SEND_SMS_DRY_RUN, DEVSMS_BASE_URL } = env;
     // Keep this function as a partial env-override parser. SMS runtime defaults
     // belong to the consuming application; injecting them here would incorrectly
     // let an absent env var overwrite pgpm.json or consumer-specific values.
     const smsRequestTimeoutMs = parseEnvNumber(SMS_REQUEST_TIMEOUT_MS);
     const smsDryRun = parseEnvBoolean(SEND_SMS_DRY_RUN);
+    const hasGrafastCacheLimits = [
+        GRAPHILE_QUERY_CACHE_MAX_LENGTH,
+        GRAPHILE_OPERATIONS_CACHE_MAX_LENGTH,
+        GRAPHILE_OPERATION_PLANS_CACHE_MAX_LENGTH
+    ].some(value => value !== undefined);
     const hasSmsEnvOverrides = Boolean(SMS_PROVIDER ||
         SMS_SENDER_ID ||
         smsRequestTimeoutMs !== undefined ||
@@ -25,6 +31,13 @@ export const getGraphQLEnvVars = (env = process.env) => {
                     }
                 }
             }),
+            ...(hasGrafastCacheLimits && {
+                grafastCache: normalizeGrafastCacheLimits({
+                    queryCacheMaxLength: parseGrafastCacheLimitEnv(GRAPHILE_QUERY_CACHE_MAX_LENGTH, 'GRAPHILE_QUERY_CACHE_MAX_LENGTH'),
+                    operationsCacheMaxLength: parseGrafastCacheLimitEnv(GRAPHILE_OPERATIONS_CACHE_MAX_LENGTH, 'GRAPHILE_OPERATIONS_CACHE_MAX_LENGTH'),
+                    operationOperationPlansCacheMaxLength: parseGrafastCacheLimitEnv(GRAPHILE_OPERATION_PLANS_CACHE_MAX_LENGTH, 'GRAPHILE_OPERATION_PLANS_CACHE_MAX_LENGTH')
+                })
+            }),
             ...(GRAPHILE_SCHEMA && {
                 schema: GRAPHILE_SCHEMA.includes(',')
                     ? GRAPHILE_SCHEMA.split(',').map(s => s.trim())

package/esm/grafast-cache-limits.d.ts

@@ -0,0 +1,4 @@
+import type { GrafastCacheLimits } from '@constructive-io/graphql-types';
+export declare const parseGrafastCacheLimitEnv: (value: string | undefined, envName: string) => number | undefined;
+/** Validate every configuration source before cache bounds reach Grafast. */
+export declare const normalizeGrafastCacheLimits: (limits: GrafastCacheLimits | undefined) => Readonly<GrafastCacheLimits> | undefined;

package/esm/grafast-cache-limits.js

@@ -0,0 +1,39 @@
+import { parseEnvNumber } from '12factor-env';
+const LIMIT_KEYS = [
+    'queryCacheMaxLength',
+    'operationsCacheMaxLength',
+    'operationOperationPlansCacheMaxLength',
+];
+const assertGrafastCacheLimit = (value, label) => {
+    if (!Number.isSafeInteger(value) || value < 2) {
+        throw new Error(`${label} must be a safe integer of at least 2`);
+    }
+    return value;
+};
+export const parseGrafastCacheLimitEnv = (value, envName) => {
+    if (value === undefined)
+        return undefined;
+    return assertGrafastCacheLimit(parseEnvNumber(value), envName);
+};
+/** Validate every configuration source before cache bounds reach Grafast. */
+export const normalizeGrafastCacheLimits = (limits) => {
+    if (limits === undefined)
+        return undefined;
+    if (typeof limits !== 'object' || limits === null || Array.isArray(limits)) {
+        throw new Error('graphile.grafastCache must be an object');
+    }
+    const allowedKeys = new Set(LIMIT_KEYS);
+    for (const key of Object.keys(limits)) {
+        if (!allowedKeys.has(key)) {
+            throw new Error(`graphile.grafastCache contains unsupported setting '${key}'`);
+        }
+    }
+    const normalized = {};
+    for (const key of LIMIT_KEYS) {
+        const value = limits[key];
+        if (value !== undefined) {
+            normalized[key] = assertGrafastCacheLimit(value, `graphile.grafastCache.${key}`);
+        }
+    }
+    return Object.freeze(normalized);
+};

package/esm/index.d.ts

@@ -1,3 +1,4 @@
 export { getGraphQLEnvVars } from './env';
+export { normalizeGrafastCacheLimits } from './grafast-cache-limits';
 export { getConstructiveEnvOptions, getEnvOptions } from './merge';
 export type { DevSmsOptions, SmsOptions } from '@constructive-io/graphql-types';

package/esm/index.js

@@ -1,3 +1,4 @@
 // Export Constructive-specific env functions
 export { getGraphQLEnvVars } from './env';
+export { normalizeGrafastCacheLimits } from './grafast-cache-limits';
 export { getConstructiveEnvOptions, getEnvOptions } from './merge';

package/esm/merge.js

@@ -2,6 +2,7 @@ import { constructiveGraphqlDefaults } from '@constructive-io/graphql-types';
 import { getEnvOptions as getPgpmEnvOptions, loadConfigSync, replaceArrays } from '@pgpmjs/env';
 import deepmerge from 'deepmerge';
 import { getGraphQLEnvVars } from './env';
+import { normalizeGrafastCacheLimits } from './grafast-cache-limits';
 /**
  * Get Constructive environment options by merging:
  * 1. Core PGPM defaults (from @pgpmjs/env)
@@ -27,7 +28,7 @@ export const getEnvOptions = (overrides = {}, cwd = process.cwd(), env = process
     // even though loadConfigSync returns PgpmOptions type
     const configOptions = loadConfigSync(cwd);
     // Merge in order: core -> graphql defaults -> config (for graphql keys) -> graphql env -> overrides
-    return deepmerge.all([
+    const options = deepmerge.all([
         coreOptions,
         constructiveGraphqlDefaults,
         // Only merge graphql-related keys from config (if present)
@@ -42,6 +43,11 @@ export const getEnvOptions = (overrides = {}, cwd = process.cwd(), env = process
     ], {
         arrayMerge: replaceArrays
     });
+    const grafastCache = normalizeGrafastCacheLimits(options.graphile?.grafastCache);
+    if (grafastCache !== undefined && options.graphile) {
+        options.graphile = { ...options.graphile, grafastCache };
+    }
+    return options;
 };
 /**
  * Alias - same as getEnvOptions

package/grafast-cache-limits.d.ts

@@ -0,0 +1,4 @@
+import type { GrafastCacheLimits } from '@constructive-io/graphql-types';
+export declare const parseGrafastCacheLimitEnv: (value: string | undefined, envName: string) => number | undefined;
+/** Validate every configuration source before cache bounds reach Grafast. */
+export declare const normalizeGrafastCacheLimits: (limits: GrafastCacheLimits | undefined) => Readonly<GrafastCacheLimits> | undefined;

package/grafast-cache-limits.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeGrafastCacheLimits = exports.parseGrafastCacheLimitEnv = void 0;
+const _12factor_env_1 = require("12factor-env");
+const LIMIT_KEYS = [
+    'queryCacheMaxLength',
+    'operationsCacheMaxLength',
+    'operationOperationPlansCacheMaxLength',
+];
+const assertGrafastCacheLimit = (value, label) => {
+    if (!Number.isSafeInteger(value) || value < 2) {
+        throw new Error(`${label} must be a safe integer of at least 2`);
+    }
+    return value;
+};
+const parseGrafastCacheLimitEnv = (value, envName) => {
+    if (value === undefined)
+        return undefined;
+    return assertGrafastCacheLimit((0, _12factor_env_1.parseEnvNumber)(value), envName);
+};
+exports.parseGrafastCacheLimitEnv = parseGrafastCacheLimitEnv;
+/** Validate every configuration source before cache bounds reach Grafast. */
+const normalizeGrafastCacheLimits = (limits) => {
+    if (limits === undefined)
+        return undefined;
+    if (typeof limits !== 'object' || limits === null || Array.isArray(limits)) {
+        throw new Error('graphile.grafastCache must be an object');
+    }
+    const allowedKeys = new Set(LIMIT_KEYS);
+    for (const key of Object.keys(limits)) {
+        if (!allowedKeys.has(key)) {
+            throw new Error(`graphile.grafastCache contains unsupported setting '${key}'`);
+        }
+    }
+    const normalized = {};
+    for (const key of LIMIT_KEYS) {
+        const value = limits[key];
+        if (value !== undefined) {
+            normalized[key] = assertGrafastCacheLimit(value, `graphile.grafastCache.${key}`);
+        }
+    }
+    return Object.freeze(normalized);
+};
+exports.normalizeGrafastCacheLimits = normalizeGrafastCacheLimits;

package/index.d.ts

@@ -1,3 +1,4 @@
 export { getGraphQLEnvVars } from './env';
+export { normalizeGrafastCacheLimits } from './grafast-cache-limits';
 export { getConstructiveEnvOptions, getEnvOptions } from './merge';
 export type { DevSmsOptions, SmsOptions } from '@constructive-io/graphql-types';

package/index.js

@@ -1,9 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getEnvOptions = exports.getConstructiveEnvOptions = exports.getGraphQLEnvVars = void 0;
+exports.getEnvOptions = exports.getConstructiveEnvOptions = exports.normalizeGrafastCacheLimits = exports.getGraphQLEnvVars = void 0;
 // Export Constructive-specific env functions
 var env_1 = require("./env");
 Object.defineProperty(exports, "getGraphQLEnvVars", { enumerable: true, get: function () { return env_1.getGraphQLEnvVars; } });
+var grafast_cache_limits_1 = require("./grafast-cache-limits");
+Object.defineProperty(exports, "normalizeGrafastCacheLimits", { enumerable: true, get: function () { return grafast_cache_limits_1.normalizeGrafastCacheLimits; } });
 var merge_1 = require("./merge");
 Object.defineProperty(exports, "getConstructiveEnvOptions", { enumerable: true, get: function () { return merge_1.getConstructiveEnvOptions; } });
 Object.defineProperty(exports, "getEnvOptions", { enumerable: true, get: function () { return merge_1.getEnvOptions; } });

package/merge.js

@@ -8,6 +8,7 @@ const graphql_types_1 = require("@constructive-io/graphql-types");
 const env_1 = require("@pgpmjs/env");
 const deepmerge_1 = __importDefault(require("deepmerge"));
 const env_2 = require("./env");
+const grafast_cache_limits_1 = require("./grafast-cache-limits");
 /**
  * Get Constructive environment options by merging:
  * 1. Core PGPM defaults (from @pgpmjs/env)
@@ -33,7 +34,7 @@ const getEnvOptions = (overrides = {}, cwd = process.cwd(), env = process.env) =
     // even though loadConfigSync returns PgpmOptions type
     const configOptions = (0, env_1.loadConfigSync)(cwd);
     // Merge in order: core -> graphql defaults -> config (for graphql keys) -> graphql env -> overrides
-    return deepmerge_1.default.all([
+    const options = deepmerge_1.default.all([
         coreOptions,
         graphql_types_1.constructiveGraphqlDefaults,
         // Only merge graphql-related keys from config (if present)
@@ -48,6 +49,11 @@ const getEnvOptions = (overrides = {}, cwd = process.cwd(), env = process.env) =
     ], {
         arrayMerge: env_1.replaceArrays
     });
+    const grafastCache = (0, grafast_cache_limits_1.normalizeGrafastCacheLimits)(options.graphile?.grafastCache);
+    if (grafastCache !== undefined && options.graphile) {
+        options.graphile = { ...options.graphile, grafastCache };
+    }
+    return options;
 };
 exports.getEnvOptions = getEnvOptions;
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructive-io/graphql-env",
-  "version": "3.34.2",
+  "version": "3.34.4",
   "author": "Constructive <developers@constructive.io>",
   "description": "Constructive environment configuration with GraphQL/Graphile support",
   "main": "index.js",
@@ -30,8 +30,8 @@
   },
   "dependencies": {
     "12factor-env": "^1.33.0",
-    "@constructive-io/graphql-types": "^3.33.2",
-    "@pgpmjs/env": "^2.45.2",
+    "@constructive-io/graphql-types": "^3.33.4",
+    "@pgpmjs/env": "^2.46.1",
     "deepmerge": "^4.3.1"
   },
   "keywords": [
@@ -45,5 +45,5 @@
   "devDependencies": {
     "makage": "^0.8.0"
   },
-  "gitHead": "e05686fb94c5e22c954436f18c25aa4439b9e83e"
+  "gitHead": "34e91da5b3dd9c0cae14875afe609993acf53a84"
 }