graphile-bucket-provisioner-plugin 1.9.3 → 1.11.0

package/esm/plugin.js

@@ -81,6 +81,17 @@ const ALL_STORAGE_MODULES_QUERY = `
   LEFT JOIN metaschema_public.schema es ON es.id = et.schema_id
   WHERE sm.database_id = $1
 `;
+/**
+ * Run a query against a grafast `withPgClient` client.
+ *
+ * That client's `query` takes the `{ text, values }` object form (the same
+ * shape the presigned-url plugin uses) — NOT node-pg's positional
+ * `(text, params)` args, which surface as "A query must have either text or a
+ * name" at runtime.
+ */
+function runQuery(pgClient, text, values) {
+    return pgClient.query(values === undefined ? { text } : { text, values });
+}
 /**
  * Resolve the storage module for a given scope.
  * If ownerId is provided, probes entity tables to find the matching module.
@@ -89,22 +100,44 @@ const ALL_STORAGE_MODULES_QUERY = `
 async function resolveStorageModule(pgClient, databaseId, ownerId) {
     if (!ownerId) {
         // App-level resolution
-        const result = await pgClient.query(APP_STORAGE_MODULE_QUERY, [databaseId]);
+        const result = await runQuery(pgClient, APP_STORAGE_MODULE_QUERY, [databaseId]);
         return result.rows[0] ?? null;
     }
     // Entity-scoped: load all modules and probe entity tables
-    const result = await pgClient.query(ALL_STORAGE_MODULES_QUERY, [databaseId]);
+    const result = await runQuery(pgClient, ALL_STORAGE_MODULES_QUERY, [databaseId]);
     const modules = result.rows;
     const entityModules = modules.filter((m) => m.entity_schema && m.entity_table);
     for (const mod of entityModules) {
         const entityTable = QuoteUtils.quoteQualifiedIdentifier(mod.entity_schema, mod.entity_table);
-        const probe = await pgClient.query(`SELECT 1 FROM ${entityTable} WHERE id = $1 LIMIT 1`, [ownerId]);
+        const probe = await runQuery(pgClient, `SELECT 1 FROM ${entityTable} WHERE id = $1 LIMIT 1`, [ownerId]);
         if (probe.rows.length > 0) {
             return mod;
         }
     }
     return null;
 }
+/**
+ * Normalize the recorded physical coordinate at the DB boundary.
+ *
+ * A bucket row either carries a recorded coordinate or it does not; SQL nulls
+ * and absent columns both mean "never provisioned". Collapsing them here is
+ * the single place that shape is interpreted — callers branch on `string`
+ * vs `null` and never coalesce a bucket name into existence.
+ */
+function storedPhysicalName(row) {
+    return row.physical_name == null ? null : row.physical_name;
+}
+/**
+ * Record the physical S3 bucket name on the source bucket row.
+ *
+ * Runs in the system lane (`withPgClient(null, ...)`) — server bookkeeping,
+ * RLS-independent. Idempotent via the `physical_name IS NULL` guard so a
+ * re-provision never clobbers an already-recorded coordinate.
+ */
+async function recordPhysicalName(withPgClient, bucketsTable, bucketId, physicalName) {
+    await withPgClient(null, (client) => runQuery(client, `UPDATE ${bucketsTable} SET physical_name = $1 WHERE id = $2 AND physical_name IS NULL`, [physicalName, bucketId]));
+    log.info(`Recorded physical_name="${physicalName}" on bucket ${bucketId}`);
+}
 // --- Helpers ---
 /**
  * Resolve the connection config from the options. If the option is a lazy
@@ -135,7 +168,7 @@ function resolveBucketName(bucketKey, databaseId, options) {
  * Resolve the database_id from the JWT context.
  */
 async function resolveDatabaseId(pgClient) {
-    const result = await pgClient.query(`SELECT jwt_private.current_database_id() AS id`);
+    const result = await runQuery(pgClient, `SELECT jwt_private.current_database_id() AS id`);
     return result.rows[0]?.id ?? null;
 }
 /**
@@ -174,8 +207,7 @@ function buildProvisioner(options, storageModule, effectiveOrigins) {
  * Core provisioning logic shared by both the explicit mutation and the
  * auto-provisioning hook.
  */
-async function provisionBucketForRow(pgClient, databaseId, bucketKey, bucketType, bucketAllowedOrigins, options) {
-    const s3BucketName = resolveBucketName(bucketKey, databaseId, options);
+async function provisionBucketForRow(pgClient, databaseId, bucketKey, bucketType, bucketAllowedOrigins, options, s3BucketName) {
     const accessType = bucketType;
     // Read storage module config to check for endpoint/provider/CORS overrides
     const storageModule = await resolveStorageModule(pgClient, databaseId);
@@ -198,8 +230,7 @@ async function provisionBucketForRow(pgClient, databaseId, bucketKey, bucketType
 /**
  * Update CORS on an existing S3 bucket when allowed_origins changes.
  */
-async function updateBucketCors(pgClient, databaseId, bucketKey, bucketType, bucketAllowedOrigins, options) {
-    const s3BucketName = resolveBucketName(bucketKey, databaseId, options);
+async function updateBucketCors(pgClient, databaseId, bucketKey, bucketType, bucketAllowedOrigins, options, s3BucketName) {
     const accessType = bucketType;
     const storageModule = await resolveStorageModule(pgClient, databaseId);
     const effectiveOrigins = resolveAllowedOrigins(bucketAllowedOrigins, storageModule?.allowed_origins, options.allowedOrigins);
@@ -303,12 +334,12 @@ export function createBucketProvisionerPlugin(options) {
                             // Look up the bucket row (RLS enforced via pgSettings)
                             const hasOwner = ownerId && storageModule.scope !== 'app';
                             const bucketsTable = QuoteUtils.quoteQualifiedIdentifier(storageModule.buckets_schema, storageModule.buckets_table);
-                            const bucketResult = await pgClient.query(hasOwner
-                                ? `SELECT id, key, type, is_public, allowed_origins
+                            const bucketResult = await runQuery(pgClient, hasOwner
+                                ? `SELECT id, key, type, is_public, allowed_origins, physical_name
                      FROM ${bucketsTable}
                      WHERE key = $1 AND owner_id = $2
                      LIMIT 1`
-                                : `SELECT id, key, type, is_public, allowed_origins
+                                : `SELECT id, key, type, is_public, allowed_origins, physical_name
                      FROM ${bucketsTable}
                      WHERE key = $1
                      LIMIT 1`, hasOwner ? [bucketKey, ownerId] : [bucketKey]);
@@ -316,8 +347,16 @@ export function createBucketProvisionerPlugin(options) {
                                 throw new Error('BUCKET_NOT_FOUND');
                             }
                             const bucket = bucketResult.rows[0];
+                            // First provision mints a name; afterwards the stored coordinate
+                            // is authoritative and the naming hook is never consulted again.
+                            const recorded = storedPhysicalName(bucket);
+                            const s3BucketName = recorded === null
+                                ? resolveBucketName(bucket.key, databaseId, options)
+                                : recorded;
                             try {
-                                const result = await provisionBucketForRow(pgClient, databaseId, bucket.key, bucket.type, bucket.allowed_origins, options);
+                                const result = await provisionBucketForRow(pgClient, databaseId, bucket.key, bucket.type, bucket.allowed_origins, options, s3BucketName);
+                                // Record the exact provisioned name on the source row.
+                                await recordPhysicalName(withPgClient, bucketsTable, bucket.id, result.bucketName);
                                 return {
                                     success: true,
                                     bucketName: result.bucketName,
@@ -331,7 +370,7 @@ export function createBucketProvisionerPlugin(options) {
                                 log.error(`Failed to provision bucket "${bucketKey}": ${err.message}`);
                                 return {
                                     success: false,
-                                    bucketName: resolveBucketName(bucket.key, databaseId, options),
+                                    bucketName: s3BucketName,
                                     accessType: bucket.type,
                                     provider: resolveConnection(options).provider,
                                     endpoint: resolveConnection(options).endpoint ?? null,
@@ -417,7 +456,17 @@ export function createBucketProvisionerPlugin(options) {
                                             log.warn('Auto-provision skipped: could not resolve database_id');
                                             return;
                                         }
-                                        await provisionBucketForRow(pgClient, databaseId, bucketInput.key, bucketInput.type, bucketInput.allowedOrigins ?? bucketInput.allowed_origins ?? null, options);
+                                        // Newly-created row has no stored coordinate yet — mint on first provision.
+                                        const result = await provisionBucketForRow(pgClient, databaseId, bucketInput.key, bucketInput.type, bucketInput.allowedOrigins ?? bucketInput.allowed_origins ?? null, options, resolveBucketName(bucketInput.key, databaseId, options));
+                                        // Record the provisioned name on the just-created row.
+                                        const storageModule = await resolveStorageModule(pgClient, databaseId);
+                                        if (storageModule) {
+                                            const bucketsTable = QuoteUtils.quoteQualifiedIdentifier(storageModule.buckets_schema, storageModule.buckets_table);
+                                            const idResult = await runQuery(pgClient, `SELECT id FROM ${bucketsTable} WHERE key = $1 LIMIT 1`, [bucketInput.key]);
+                                            const bucketId = idResult.rows[0]?.id;
+                                            if (bucketId)
+                                                await recordPhysicalName(withPgClient, bucketsTable, bucketId, result.bucketName);
+                                        }
                                     });
                                 }
                                 else {
@@ -451,7 +500,7 @@ export function createBucketProvisionerPlugin(options) {
                                         }
                                         // Read the full bucket row (post-update) to get type + origins
                                         const bucketsTable = QuoteUtils.quoteQualifiedIdentifier(storageModule.buckets_schema, storageModule.buckets_table);
-                                        const bucketResult = await pgClient.query(`SELECT id, key, type, is_public, allowed_origins
+                                        const bucketResult = await runQuery(pgClient, `SELECT id, key, type, is_public, allowed_origins, physical_name
                        FROM ${bucketsTable}
                        WHERE key = $1
                        LIMIT 1`, [patchKey]);
@@ -460,7 +509,13 @@ export function createBucketProvisionerPlugin(options) {
                                             return;
                                         }
                                         const bucket = bucketResult.rows[0];
-                                        await updateBucketCors(pgClient, databaseId, bucket.key, bucket.type, bucket.allowed_origins, options);
+                                        // CORS applies to the recorded physical bucket; if the row was
+                                        // never provisioned there is nothing to update yet, so mint the
+                                        // conventional name the first provision would use.
+                                        const recorded = storedPhysicalName(bucket);
+                                        await updateBucketCors(pgClient, databaseId, bucket.key, bucket.type, bucket.allowed_origins, options, recorded === null
+                                            ? resolveBucketName(bucket.key, databaseId, options)
+                                            : recorded);
                                     });
                                 }
                             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "graphile-bucket-provisioner-plugin",
-  "version": "1.9.3",
+  "version": "1.11.0",
   "description": "Bucket provisioning plugin for PostGraphile v5 — auto-provisions S3 buckets on bucket table mutations",
   "author": "Constructive <developers@constructive.io>",
   "homepage": "https://github.com/constructive-io/constructive",
@@ -57,5 +57,5 @@
     "@types/node": "^22.19.11",
     "makage": "^0.3.0"
   },
-  "gitHead": "c20b6be96b39bf71c0e2df0f4b51e05deacd006b"
+  "gitHead": "247e48d25b13524d992f00c1b2dc063884d1deb1"
 }

package/plugin.js

@@ -85,6 +85,17 @@ const ALL_STORAGE_MODULES_QUERY = `
   LEFT JOIN metaschema_public.schema es ON es.id = et.schema_id
   WHERE sm.database_id = $1
 `;
+/**
+ * Run a query against a grafast `withPgClient` client.
+ *
+ * That client's `query` takes the `{ text, values }` object form (the same
+ * shape the presigned-url plugin uses) — NOT node-pg's positional
+ * `(text, params)` args, which surface as "A query must have either text or a
+ * name" at runtime.
+ */
+function runQuery(pgClient, text, values) {
+    return pgClient.query(values === undefined ? { text } : { text, values });
+}
 /**
  * Resolve the storage module for a given scope.
  * If ownerId is provided, probes entity tables to find the matching module.
@@ -93,22 +104,44 @@ const ALL_STORAGE_MODULES_QUERY = `
 async function resolveStorageModule(pgClient, databaseId, ownerId) {
     if (!ownerId) {
         // App-level resolution
-        const result = await pgClient.query(APP_STORAGE_MODULE_QUERY, [databaseId]);
+        const result = await runQuery(pgClient, APP_STORAGE_MODULE_QUERY, [databaseId]);
         return result.rows[0] ?? null;
     }
     // Entity-scoped: load all modules and probe entity tables
-    const result = await pgClient.query(ALL_STORAGE_MODULES_QUERY, [databaseId]);
+    const result = await runQuery(pgClient, ALL_STORAGE_MODULES_QUERY, [databaseId]);
     const modules = result.rows;
     const entityModules = modules.filter((m) => m.entity_schema && m.entity_table);
     for (const mod of entityModules) {
         const entityTable = quotes_1.QuoteUtils.quoteQualifiedIdentifier(mod.entity_schema, mod.entity_table);
-        const probe = await pgClient.query(`SELECT 1 FROM ${entityTable} WHERE id = $1 LIMIT 1`, [ownerId]);
+        const probe = await runQuery(pgClient, `SELECT 1 FROM ${entityTable} WHERE id = $1 LIMIT 1`, [ownerId]);
         if (probe.rows.length > 0) {
             return mod;
         }
     }
     return null;
 }
+/**
+ * Normalize the recorded physical coordinate at the DB boundary.
+ *
+ * A bucket row either carries a recorded coordinate or it does not; SQL nulls
+ * and absent columns both mean "never provisioned". Collapsing them here is
+ * the single place that shape is interpreted — callers branch on `string`
+ * vs `null` and never coalesce a bucket name into existence.
+ */
+function storedPhysicalName(row) {
+    return row.physical_name == null ? null : row.physical_name;
+}
+/**
+ * Record the physical S3 bucket name on the source bucket row.
+ *
+ * Runs in the system lane (`withPgClient(null, ...)`) — server bookkeeping,
+ * RLS-independent. Idempotent via the `physical_name IS NULL` guard so a
+ * re-provision never clobbers an already-recorded coordinate.
+ */
+async function recordPhysicalName(withPgClient, bucketsTable, bucketId, physicalName) {
+    await withPgClient(null, (client) => runQuery(client, `UPDATE ${bucketsTable} SET physical_name = $1 WHERE id = $2 AND physical_name IS NULL`, [physicalName, bucketId]));
+    log.info(`Recorded physical_name="${physicalName}" on bucket ${bucketId}`);
+}
 // --- Helpers ---
 /**
  * Resolve the connection config from the options. If the option is a lazy
@@ -139,7 +172,7 @@ function resolveBucketName(bucketKey, databaseId, options) {
  * Resolve the database_id from the JWT context.
  */
 async function resolveDatabaseId(pgClient) {
-    const result = await pgClient.query(`SELECT jwt_private.current_database_id() AS id`);
+    const result = await runQuery(pgClient, `SELECT jwt_private.current_database_id() AS id`);
     return result.rows[0]?.id ?? null;
 }
 /**
@@ -178,8 +211,7 @@ function buildProvisioner(options, storageModule, effectiveOrigins) {
  * Core provisioning logic shared by both the explicit mutation and the
  * auto-provisioning hook.
  */
-async function provisionBucketForRow(pgClient, databaseId, bucketKey, bucketType, bucketAllowedOrigins, options) {
-    const s3BucketName = resolveBucketName(bucketKey, databaseId, options);
+async function provisionBucketForRow(pgClient, databaseId, bucketKey, bucketType, bucketAllowedOrigins, options, s3BucketName) {
     const accessType = bucketType;
     // Read storage module config to check for endpoint/provider/CORS overrides
     const storageModule = await resolveStorageModule(pgClient, databaseId);
@@ -202,8 +234,7 @@ async function provisionBucketForRow(pgClient, databaseId, bucketKey, bucketType
 /**
  * Update CORS on an existing S3 bucket when allowed_origins changes.
  */
-async function updateBucketCors(pgClient, databaseId, bucketKey, bucketType, bucketAllowedOrigins, options) {
-    const s3BucketName = resolveBucketName(bucketKey, databaseId, options);
+async function updateBucketCors(pgClient, databaseId, bucketKey, bucketType, bucketAllowedOrigins, options, s3BucketName) {
     const accessType = bucketType;
     const storageModule = await resolveStorageModule(pgClient, databaseId);
     const effectiveOrigins = resolveAllowedOrigins(bucketAllowedOrigins, storageModule?.allowed_origins, options.allowedOrigins);
@@ -307,12 +338,12 @@ function createBucketProvisionerPlugin(options) {
                             // Look up the bucket row (RLS enforced via pgSettings)
                             const hasOwner = ownerId && storageModule.scope !== 'app';
                             const bucketsTable = quotes_1.QuoteUtils.quoteQualifiedIdentifier(storageModule.buckets_schema, storageModule.buckets_table);
-                            const bucketResult = await pgClient.query(hasOwner
-                                ? `SELECT id, key, type, is_public, allowed_origins
+                            const bucketResult = await runQuery(pgClient, hasOwner
+                                ? `SELECT id, key, type, is_public, allowed_origins, physical_name
                      FROM ${bucketsTable}
                      WHERE key = $1 AND owner_id = $2
                      LIMIT 1`
-                                : `SELECT id, key, type, is_public, allowed_origins
+                                : `SELECT id, key, type, is_public, allowed_origins, physical_name
                      FROM ${bucketsTable}
                      WHERE key = $1
                      LIMIT 1`, hasOwner ? [bucketKey, ownerId] : [bucketKey]);
@@ -320,8 +351,16 @@ function createBucketProvisionerPlugin(options) {
                                 throw new Error('BUCKET_NOT_FOUND');
                             }
                             const bucket = bucketResult.rows[0];
+                            // First provision mints a name; afterwards the stored coordinate
+                            // is authoritative and the naming hook is never consulted again.
+                            const recorded = storedPhysicalName(bucket);
+                            const s3BucketName = recorded === null
+                                ? resolveBucketName(bucket.key, databaseId, options)
+                                : recorded;
                             try {
-                                const result = await provisionBucketForRow(pgClient, databaseId, bucket.key, bucket.type, bucket.allowed_origins, options);
+                                const result = await provisionBucketForRow(pgClient, databaseId, bucket.key, bucket.type, bucket.allowed_origins, options, s3BucketName);
+                                // Record the exact provisioned name on the source row.
+                                await recordPhysicalName(withPgClient, bucketsTable, bucket.id, result.bucketName);
                                 return {
                                     success: true,
                                     bucketName: result.bucketName,
@@ -335,7 +374,7 @@ function createBucketProvisionerPlugin(options) {
                                 log.error(`Failed to provision bucket "${bucketKey}": ${err.message}`);
                                 return {
                                     success: false,
-                                    bucketName: resolveBucketName(bucket.key, databaseId, options),
+                                    bucketName: s3BucketName,
                                     accessType: bucket.type,
                                     provider: resolveConnection(options).provider,
                                     endpoint: resolveConnection(options).endpoint ?? null,
@@ -421,7 +460,17 @@ function createBucketProvisionerPlugin(options) {
                                             log.warn('Auto-provision skipped: could not resolve database_id');
                                             return;
                                         }
-                                        await provisionBucketForRow(pgClient, databaseId, bucketInput.key, bucketInput.type, bucketInput.allowedOrigins ?? bucketInput.allowed_origins ?? null, options);
+                                        // Newly-created row has no stored coordinate yet — mint on first provision.
+                                        const result = await provisionBucketForRow(pgClient, databaseId, bucketInput.key, bucketInput.type, bucketInput.allowedOrigins ?? bucketInput.allowed_origins ?? null, options, resolveBucketName(bucketInput.key, databaseId, options));
+                                        // Record the provisioned name on the just-created row.
+                                        const storageModule = await resolveStorageModule(pgClient, databaseId);
+                                        if (storageModule) {
+                                            const bucketsTable = quotes_1.QuoteUtils.quoteQualifiedIdentifier(storageModule.buckets_schema, storageModule.buckets_table);
+                                            const idResult = await runQuery(pgClient, `SELECT id FROM ${bucketsTable} WHERE key = $1 LIMIT 1`, [bucketInput.key]);
+                                            const bucketId = idResult.rows[0]?.id;
+                                            if (bucketId)
+                                                await recordPhysicalName(withPgClient, bucketsTable, bucketId, result.bucketName);
+                                        }
                                     });
                                 }
                                 else {
@@ -455,7 +504,7 @@ function createBucketProvisionerPlugin(options) {
                                         }
                                         // Read the full bucket row (post-update) to get type + origins
                                         const bucketsTable = quotes_1.QuoteUtils.quoteQualifiedIdentifier(storageModule.buckets_schema, storageModule.buckets_table);
-                                        const bucketResult = await pgClient.query(`SELECT id, key, type, is_public, allowed_origins
+                                        const bucketResult = await runQuery(pgClient, `SELECT id, key, type, is_public, allowed_origins, physical_name
                        FROM ${bucketsTable}
                        WHERE key = $1
                        LIMIT 1`, [patchKey]);
@@ -464,7 +513,13 @@ function createBucketProvisionerPlugin(options) {
                                             return;
                                         }
                                         const bucket = bucketResult.rows[0];
-                                        await updateBucketCors(pgClient, databaseId, bucket.key, bucket.type, bucket.allowed_origins, options);
+                                        // CORS applies to the recorded physical bucket; if the row was
+                                        // never provisioned there is nothing to update yet, so mint the
+                                        // conventional name the first provision would use.
+                                        const recorded = storedPhysicalName(bucket);
+                                        await updateBucketCors(pgClient, databaseId, bucket.key, bucket.type, bucket.allowed_origins, options, recorded === null
+                                            ? resolveBucketName(bucket.key, databaseId, options)
+                                            : recorded);
                                     });
                                 }
                             }