graphile-llm 0.7.2 → 0.8.0

package/plugins/metering-plugin.js

@@ -0,0 +1,178 @@
+"use strict";
+/**
+ * LlmMeteringPlugin
+ *
+ * Opt-in billing integration for graphile-llm. Completely separate from the
+ * pure LLM plugins (text-search, text-mutation, rag).
+ *
+ * **How it works:**
+ * 1. At schema build time, replaces `build.llmEmbedder` with a metered wrapper
+ *    that has the same `(text: string) => Promise<number[]>` signature
+ * 2. At request time, wraps every root query/mutation resolver to set up a
+ *    request-scoped MeteringContext via AsyncLocalStorage
+ * 3. When the embedder is called (by any plugin), the wrapper checks
+ *    AsyncLocalStorage for a metering context and if found, calls
+ *    check_billing_quota before and record_usage after
+ * 4. If quota is exceeded, the wrapper returns null — the calling plugin sees
+ *    null and handles it (search falls back to text-only, mutations throw)
+ *
+ * The pure plugins never import metering, config-cache, or billing types.
+ * They call the embedder and handle null results — that's it.
+ *
+ * **Entity ID resolution:**
+ * The billing `entity_id` is resolved via a configurable callback.
+ * Default: reads `jwt.claims.user_id` from pgSettings. Override via
+ * `metering.resolveEntityId` in GraphileLlmPreset options.
+ *
+ * **Graceful behavior:**
+ * - billing_module not provisioned → embedder passes through unmetered
+ * - entity_id not available → embedder passes through unmetered
+ * - check_billing_quota throws → call is allowed (billing is opt-in)
+ * - record_usage throws → call succeeds, recording silently skipped
+ * - quota exceeded → embedder returns null
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createLlmMeteringPlugin = createLlmMeteringPlugin;
+const node_async_hooks_1 = require("node:async_hooks");
+const metering_1 = require("../metering");
+const config_cache_1 = require("../config-cache");
+// ─── Request-scoped context via AsyncLocalStorage ───────────────────────────
+const meteringStore = new node_async_hooks_1.AsyncLocalStorage();
+// ─── Helpers ────────────────────────────────────────────────────────────────
+function defaultResolveEntityId(pgSettings) {
+    return pgSettings['jwt.claims.user_id'] ?? null;
+}
+async function buildMeteringContext(graphqlContext, resolveEntityId) {
+    const pgSettings = graphqlContext?.pgSettings ?? {};
+    const entityId = resolveEntityId(pgSettings);
+    const databaseId = pgSettings['jwt.claims.database_id'] ?? null;
+    const requestId = pgSettings['request.id'] ?? null;
+    const actorId = pgSettings['jwt.claims.user_id'] ?? null;
+    if (!entityId || !databaseId)
+        return null;
+    const withPgClient = graphqlContext?.withPgClient;
+    if (!withPgClient)
+        return null;
+    let billingConfig = null;
+    let inferenceLogConfig = null;
+    try {
+        await withPgClient(pgSettings, async (pgClient) => {
+            const entry = await (0, config_cache_1.getLlmBillingConfig)(pgClient, databaseId);
+            billingConfig = entry.billing;
+            inferenceLogConfig = entry.inferenceLog;
+        });
+    }
+    catch {
+        return null;
+    }
+    if (!billingConfig)
+        return null;
+    return {
+        withPgClient,
+        pgSettings,
+        billing: billingConfig,
+        entityId,
+        requestId,
+        databaseId,
+        actorId,
+        inferenceLog: inferenceLogConfig,
+    };
+}
+/**
+ * Wrap an embedder with metering that reads context from AsyncLocalStorage.
+ * The returned function has the same signature as the original embedder,
+ * so downstream plugins are unaware of billing.
+ *
+ * When no metering context is in scope, the original embedder is called directly.
+ * When quota is exceeded, returns null instead of a vector.
+ */
+function wrapEmbedderWithMetering(embedder, meteringOptions) {
+    return async (text) => {
+        const ctx = meteringStore.getStore();
+        if (!ctx) {
+            // No metering context in scope — call original embedder directly
+            const startTime = Date.now();
+            const result = await embedder(text);
+            const latencyMs = Date.now() - startTime;
+            console.log(`[graphile-llm] Embed (unmetered): dims=${result?.length ?? 0}, latency=${latencyMs}ms`);
+            return result;
+        }
+        const result = await (0, metering_1.meteredEmbed)(embedder, text, ctx, meteringOptions);
+        if (result.quotaExceeded) {
+            return null;
+        }
+        return result.result;
+    };
+}
+// ─── Plugin ─────────────────────────────────────────────────────────────────
+function createLlmMeteringPlugin(meteringConfig = {}) {
+    const { embeddingMeterSlug: configEmbeddingSlug, chatMeterSlug: configChatSlug, skipMetering, resolveEntityId = defaultResolveEntityId, } = meteringConfig;
+    return {
+        name: 'LlmMeteringPlugin',
+        version: '0.2.0',
+        description: 'Wraps LLM embedder/chat with billing quota checks and usage recording',
+        after: ['LlmModulePlugin'],
+        before: ['LlmTextSearchPlugin', 'LlmTextMutationPlugin', 'LlmRagPlugin'],
+        schema: {
+            hooks: {
+                build(build) {
+                    const originalEmbedder = build.llmEmbedder;
+                    if (!originalEmbedder) {
+                        console.log('[graphile-llm] Metering plugin loaded but no embedder configured — skipping');
+                        return build;
+                    }
+                    // Meter slug = model name by default (three-level waterfall: model → inference → universal)
+                    const embeddingModel = build.llmEmbeddingModel;
+                    const chatModel = build.llmChatModel;
+                    const embeddingSlug = configEmbeddingSlug ?? embeddingModel ?? undefined;
+                    const chatSlug = configChatSlug ?? chatModel ?? undefined;
+                    if (embeddingSlug) {
+                        console.log(`[graphile-llm] Metering enabled — embedding meter: ${embeddingSlug}`);
+                    }
+                    else {
+                        console.log('[graphile-llm] Metering enabled but no embedding model name — usage will not be metered');
+                    }
+                    const meteringOptions = {
+                        embeddingMeterSlug: embeddingSlug,
+                        chatMeterSlug: chatSlug,
+                        skipMetering,
+                        embeddingModel: embeddingModel ?? undefined,
+                        chatModel: chatModel ?? undefined,
+                    };
+                    // Replace the embedder with a metered version.
+                    // Same signature except it can return null (quota exceeded).
+                    const meteredEmbedder = wrapEmbedderWithMetering(originalEmbedder, meteringOptions);
+                    return build.extend(build, {
+                        llmEmbedder: meteredEmbedder,
+                    }, 'LlmMeteringPlugin replacing llmEmbedder with metered version');
+                },
+                /**
+                 * Wrap every root query/mutation resolver to establish the
+                 * request-scoped metering context via AsyncLocalStorage.
+                 */
+                GraphQLObjectType_fields_field(field, build, context) {
+                    const { scope: { isRootQuery, isRootMutation }, } = context;
+                    if (!isRootQuery && !isRootMutation)
+                        return field;
+                    // Only wrap if we actually replaced the embedder
+                    if (!build.llmEmbedder)
+                        return field;
+                    const defaultResolver = (obj) => obj[context.scope.fieldName];
+                    const { resolve: oldResolve = defaultResolver, ...rest } = field;
+                    return {
+                        ...rest,
+                        async resolve(source, args, graphqlContext, info) {
+                            // Build the metering context for this request
+                            const ctx = await buildMeteringContext(graphqlContext, resolveEntityId);
+                            // Run the original resolver within the AsyncLocalStorage scope
+                            // so any embedder calls made by downstream plugins pick up the ctx
+                            return meteringStore.run(ctx, () => {
+                                return oldResolve(source, args, graphqlContext, info);
+                            });
+                        },
+                    };
+                },
+            },
+        },
+    };
+}

package/plugins/text-mutation-plugin.d.ts

@@ -9,6 +9,10 @@
  * Example:
  *   mutation { createArticle(input: { embeddingText: "Machine learning concepts" }) }
  *
+ * If the embedder returns null (e.g. quota exceeded when the metering plugin
+ * is loaded), the mutation throws an error — unlike search, mutations cannot
+ * silently skip writing a vector the user asked for.
+ *
  * This is the mutation counterpart to LlmTextSearchPlugin (which handles
  * filter/query-side text-to-vector). Together they let clients work entirely
  * with text/prompts instead of raw float vectors.

package/plugins/text-mutation-plugin.js

@@ -10,6 +10,10 @@
  * Example:
  *   mutation { createArticle(input: { embeddingText: "Machine learning concepts" }) }
  *
+ * If the embedder returns null (e.g. quota exceeded when the metering plugin
+ * is loaded), the mutation throws an error — unlike search, mutations cannot
+ * silently skip writing a vector the user asked for.
+ *
  * This is the mutation counterpart to LlmTextSearchPlugin (which handles
  * filter/query-side text-to-vector). Together they let clients work entirely
  * with text/prompts instead of raw float vectors.
@@ -64,7 +68,7 @@ function getTextToVectorMapping(pgCodec, build) {
 function createLlmTextMutationPlugin() {
     return {
         name: 'LlmTextMutationPlugin',
-        version: '0.1.0',
+        version: '0.2.0',
         description: 'Adds text companion fields on mutation inputs for vector columns — ' +
             'text is embedded server-side before storing',
         after: [
@@ -124,6 +128,8 @@ function createLlmTextMutationPlugin() {
                  * Uses the same v4-style resolver wrapping pattern as graphile-upload-plugin
                  * and graphile-bucket-provisioner-plugin. grafserv v5 supports this through
                  * its backwards-compatibility layer.
+                 *
+                 * If the embedder returns null (e.g. quota exceeded), throws an error.
                  */
                 GraphQLObjectType_fields_field(field, build, context) {
                     const { scope: { isRootMutation, fieldName, pgCodec }, } = context;
@@ -166,6 +172,10 @@ function createLlmTextMutationPlugin() {
                                             const startTime = Date.now();
                                             const vector = await embedder(value);
                                             const latencyMs = Date.now() - startTime;
+                                            if (vector === null) {
+                                                throw new Error(`EMBED_QUOTA_EXCEEDED: Cannot embed ${key} — embedding quota exceeded. ` +
+                                                    'Upgrade your plan or wait for the next billing period.');
+                                            }
                                             console.log(`[graphile-llm] Mutation embed: field=${key}, dims=${vector.length}, latency=${latencyMs}ms`);
                                             // Inject the vector into the corresponding field
                                             obj[vectorFieldName] = vector;

package/plugins/text-search-plugin.d.ts

@@ -22,6 +22,10 @@
  *
  * If the embedder is not configured, the `text` field is still registered
  * (so the schema is stable) but will return a clear error at execution time.
+ *
+ * If the embedder returns null (e.g. quota exceeded when the metering
+ * plugin is loaded), the text field is silently removed — the query
+ * continues with text-only search as a graceful fallback.
  */
 import type { GraphileConfig } from 'graphile-config';
 declare global {

package/plugins/text-search-plugin.js

@@ -23,6 +23,10 @@
  *
  * If the embedder is not configured, the `text` field is still registered
  * (so the schema is stable) but will return a clear error at execution time.
+ *
+ * If the embedder returns null (e.g. quota exceeded when the metering
+ * plugin is loaded), the text field is silently removed — the query
+ * continues with text-only search as a graceful fallback.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createLlmTextSearchPlugin = createLlmTextSearchPlugin;
@@ -41,6 +45,9 @@ function hasVectorColumns(pgCodec) {
 /**
  * Recursively walk a `where` argument object and embed any VectorNearbyInput
  * values that have `text` instead of `vector`.
+ *
+ * If the embedder returns null (e.g. quota exceeded), the text field is
+ * removed so the pgvector filter is skipped — graceful text-only fallback.
  */
 async function embedTextInWhere(obj, embedder) {
     if (!obj || typeof obj !== 'object')
@@ -56,6 +63,11 @@ async function embedTextInWhere(obj, embedder) {
                 const startTime = Date.now();
                 const vector = await embedder(value.text);
                 const latencyMs = Date.now() - startTime;
+                if (vector === null) {
+                    // Embedder returned null (e.g. quota exceeded) — skip vector search
+                    delete value.text;
+                    return;
+                }
                 console.log(`[graphile-llm] Search embed: field=${key}, dims=${vector.length}, latency=${latencyMs}ms`);
                 // Replace text with vector
                 value.vector = vector;
@@ -88,7 +100,7 @@ async function embedTextInWhere(obj, embedder) {
 function createLlmTextSearchPlugin() {
     return {
         name: 'LlmTextSearchPlugin',
-        version: '0.1.0',
+        version: '0.2.0',
         description: 'Adds text-to-vector embedding support on VectorNearbyInput filter fields',
         after: [
             'LlmModulePlugin',

package/preset.d.ts

@@ -8,7 +8,7 @@
  * - Resolves an embedder from configuration (llm_module, env vars, or preset options)
  * - Adds a `text: String` field to `VectorNearbyInput` for text-based vector search
  * - Adds `{column}Text: String` companion fields on mutation inputs for vector columns
- * - Logs token usage to console (metering integration deferred to billing system)
+ * - Optionally enables billing/metering via the LlmMeteringPlugin
  *
  * This preset is standalone — it is NOT included in ConstructivePreset by default.
  * Projects that want LLM features opt in by adding it to their preset.
@@ -42,6 +42,26 @@
  *   ],
  * };
  * ```
+ *
+ * @example With billing metering (opt-in, meter slug = model name by default):
+ * ```typescript
+ * GraphileLlmPreset({
+ *   defaultEmbedder: { provider: 'openai', model: 'text-embedding-3-small' },
+ *   metering: true,
+ *   // → embedding calls metered under 'text-embedding-3-small' meter slug
+ *   // → three-level waterfall: text-embedding-3-small → inference pool → universal
+ * })
+ * ```
+ *
+ * @example With custom entity_id resolution (bill per-database):
+ * ```typescript
+ * GraphileLlmPreset({
+ *   defaultEmbedder: { provider: 'openai', model: 'text-embedding-3-small' },
+ *   metering: {
+ *     resolveEntityId: (pgSettings) => pgSettings['jwt.claims.database_id'],
+ *   },
+ * })
+ * ```
  */
 import type { GraphileConfig } from 'graphile-config';
 import type { GraphileLlmOptions } from './types';

package/preset.js

@@ -9,7 +9,7 @@
  * - Resolves an embedder from configuration (llm_module, env vars, or preset options)
  * - Adds a `text: String` field to `VectorNearbyInput` for text-based vector search
  * - Adds `{column}Text: String` companion fields on mutation inputs for vector columns
- * - Logs token usage to console (metering integration deferred to billing system)
+ * - Optionally enables billing/metering via the LlmMeteringPlugin
  *
  * This preset is standalone — it is NOT included in ConstructivePreset by default.
  * Projects that want LLM features opt in by adding it to their preset.
@@ -43,6 +43,26 @@
  *   ],
  * };
  * ```
+ *
+ * @example With billing metering (opt-in, meter slug = model name by default):
+ * ```typescript
+ * GraphileLlmPreset({
+ *   defaultEmbedder: { provider: 'openai', model: 'text-embedding-3-small' },
+ *   metering: true,
+ *   // → embedding calls metered under 'text-embedding-3-small' meter slug
+ *   // → three-level waterfall: text-embedding-3-small → inference pool → universal
+ * })
+ * ```
+ *
+ * @example With custom entity_id resolution (bill per-database):
+ * ```typescript
+ * GraphileLlmPreset({
+ *   defaultEmbedder: { provider: 'openai', model: 'text-embedding-3-small' },
+ *   metering: {
+ *     resolveEntityId: (pgSettings) => pgSettings['jwt.claims.database_id'],
+ *   },
+ * })
+ * ```
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GraphileLlmPreset = GraphileLlmPreset;
@@ -50,6 +70,7 @@ const llm_module_plugin_1 = require("./plugins/llm-module-plugin");
 const text_search_plugin_1 = require("./plugins/text-search-plugin");
 const text_mutation_plugin_1 = require("./plugins/text-mutation-plugin");
 const rag_plugin_1 = require("./plugins/rag-plugin");
+const metering_plugin_1 = require("./plugins/metering-plugin");
 /**
  * Creates a preset that includes all LLM plugins.
  *
@@ -57,10 +78,16 @@ const rag_plugin_1 = require("./plugins/rag-plugin");
  * @returns A GraphileConfig.Preset to add to your extends array
  */
 function GraphileLlmPreset(options = {}) {
-    const { enableTextSearch = true, enableTextMutations = true, enableRag = false, ragDefaults, } = options;
+    const { enableTextSearch = true, enableTextMutations = true, enableRag = false, ragDefaults, metering, } = options;
     const plugins = [
         (0, llm_module_plugin_1.createLlmModulePlugin)(options),
     ];
+    // Metering is opt-in: only loaded when metering is truthy
+    // (true, or a MeteringConfig object)
+    if (metering) {
+        const meteringConfig = metering === true ? {} : metering;
+        plugins.push((0, metering_plugin_1.createLlmMeteringPlugin)(meteringConfig));
+    }
     if (enableTextSearch) {
         plugins.push((0, text_search_plugin_1.createLlmTextSearchPlugin)());
     }

package/types.d.ts

@@ -17,8 +17,6 @@ export interface EmbedderConfig {
     model?: string;
     /** Base URL for the provider (e.g. 'http://localhost:11434' for Ollama) */
     baseUrl?: string;
-    /** API key for providers that require authentication (e.g. OpenAI) */
-    apiKey?: string;
 }
 /**
  * A single message in a chat conversation.
@@ -50,8 +48,6 @@ export interface ChatConfig {
     model?: string;
     /** Base URL for the provider */
     baseUrl?: string;
-    /** API key for providers that require authentication */
-    apiKey?: string;
 }
 /**
  * The shape of the `llm_module` data stored in `services_public.api_modules`.
@@ -74,8 +70,6 @@ export interface LlmModuleData {
     chat_model?: string;
     /** Base URL for the chat provider */
     chat_base_url?: string;
-    /** API key reference (e.g. 'vault://openai-key' or env var name) */
-    api_key_ref?: string;
     /** Rate limit: requests per minute */
     rate_limit_rpm?: number;
     /** Maximum tokens per request */
@@ -131,6 +125,41 @@ export interface ChunkTableInfo {
     /** Text content column on chunks table (the actual chunk text) */
     contentField: string;
 }
+/**
+ * Configuration for billing/metering integration.
+ * When provided, embedding and chat calls are wrapped with quota checks
+ * and usage recording via the billing_module functions.
+ */
+export interface MeteringConfig {
+    /**
+     * Meter slug for embedding operations.
+     * Must match a slug in the billing_module meters table.
+     *
+     * @default the embedding model name (e.g. 'text-embedding-3-small')
+     * — meter slug = model name, so each model has its own meter
+     * in the three-level waterfall (per-model → inference pool → universal).
+     */
+    embeddingMeterSlug?: string;
+    /**
+     * Meter slug for chat completion operations.
+     *
+     * @default the chat model name (e.g. 'gpt-4o-mini')
+     */
+    chatMeterSlug?: string;
+    /**
+     * Disable metering entirely (e.g. for local dev).
+     * When true, billing functions are never called.
+     * @default false
+     */
+    skipMetering?: boolean;
+    /**
+     * Resolve the billing entity_id from pgSettings.
+     * The entity_id identifies who gets billed (user, org, etc.).
+     *
+     * @default reads jwt.claims.user_id
+     */
+    resolveEntityId?: (pgSettings: Record<string, string>) => string | null;
+}
 /**
  * Options for the GraphileLlmPreset.
  */
@@ -170,4 +199,16 @@ export interface GraphileLlmOptions {
      * Individual queries can override these values.
      */
     ragDefaults?: RagDefaults;
+    /**
+     * Billing/metering configuration (opt-in).
+     * When truthy, loads the LlmMeteringPlugin which wraps the embedder
+     * with billing quota checks + usage recording.
+     *
+     * Set to `true` to enable metering with defaults (entity_id from jwt.claims.user_id).
+     * Provide a MeteringConfig object for fine-grained control (custom entity_id, meter slugs).
+     * Set to `false` or omit to disable metering entirely.
+     *
+     * @default undefined (metering disabled)
+     */
+    metering?: boolean | MeteringConfig;
 }