Skip to content

fix: use Grafast plan() instead of resolve() for downloadUrl field #1019

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pyramation merged 1 commit into from
Apr 20, 2026
Merged

fix: use Grafast plan() instead of resolve() for downloadUrl field #1019

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
120 changes: 70 additions & 50 deletions graphile/graphile-presigned-url-plugin/src/download-url-field.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,16 @@
* COMMENT ON TABLE files IS E'@storageFiles\nStorage files table';
*
* This is explicit and reliable — no duck-typing on column names.
*
* IMPORTANT: Uses Grafast plan() instead of traditional resolve().
* In PostGraphile V5, Grafast's planning system does not invoke traditional
* resolve functions on PG table type fields — it plans them as column
* lookups. Since downloadUrl is a computed field (not a real column),
* the plan() function is required for Grafast to execute the S3 signing.
*/

import type { GraphileConfig } from 'graphile-config';
import { context as grafastContext, lambda, object } from 'grafast';
import { Logger } from '@pgpmjs/logger';

import type { PresignedUrlPluginOptions, S3Config, StorageModuleConfig } from './types';
Expand Down Expand Up @@ -76,7 +83,7 @@ export function createDownloadUrlPlugin(

return {
name: 'PresignedUrlDownloadPlugin',
version: '0.1.0',
version: '0.2.0',
description: 'Adds downloadUrl computed field to File types tagged with @storageFiles',

schema: {
Expand Down Expand Up @@ -113,58 +120,71 @@ export function createDownloadUrlPlugin(
'URL to download this file. For public files, returns the public URL. ' +
'For private files, returns a time-limited presigned URL.',
type: GraphQLString,
async resolve(parent: any, _args: any, context: any) {
const key = parent.key || parent.get?.('key');
const isPublic = parent.is_public ?? parent.get?.('is_public');
const filename = parent.filename || parent.get?.('filename');
const status = parent.status || parent.get?.('status');

if (!key) return null;

// Only provide download URLs for ready/processed files
if (status !== 'ready' && status !== 'processed') {
return null;
}

// Resolve per-database config (bucket, publicUrlPrefix, expiry)
let s3ForDb = resolveS3(options); // fallback to global
let downloadUrlExpirySeconds = 3600; // fallback default
try {
const withPgClient = context.pgSettings
? context.withPgClient
: null;
if (withPgClient) {
const resolved = await withPgClient(null, async (pgClient: any) => {
const dbResult = await pgClient.query({
text: `SELECT jwt_private.current_database_id() AS id`,
plan($parent: any) {
// Access file attributes from the parent PgSelectSingleStep
const $key = $parent.get('key');
const $isPublic = $parent.get('is_public');
const $filename = $parent.get('filename');
const $status = $parent.get('status');

// Access GraphQL context for per-database config resolution
const $withPgClient = (grafastContext() as any).get('withPgClient');
const $pgSettings = (grafastContext() as any).get('pgSettings');

const $combined = object({
key: $key,
isPublic: $isPublic,
filename: $filename,
status: $status,
withPgClient: $withPgClient,
pgSettings: $pgSettings,
});

return lambda($combined, async ({ key, isPublic, filename, status, withPgClient, pgSettings }: any) => {
if (!key) return null;

// Only provide download URLs for ready/processed files
if (status !== 'ready' && status !== 'processed') {
return null;
}

// Resolve per-database config (bucket, publicUrlPrefix, expiry)
let s3ForDb = resolveS3(options); // fallback to global
let downloadUrlExpirySeconds = 3600; // fallback default
try {
if (withPgClient && pgSettings) {
const resolved = await withPgClient(null, async (pgClient: any) => {
const dbResult = await pgClient.query({
text: `SELECT jwt_private.current_database_id() AS id`,
});
const databaseId = dbResult.rows[0]?.id;
if (!databaseId) return null;
const config = await getStorageModuleConfig(pgClient, databaseId);
if (!config) return null;
return { config, databaseId };
});
const databaseId = dbResult.rows[0]?.id;
if (!databaseId) return null;
const config = await getStorageModuleConfig(pgClient, databaseId);
if (!config) return null;
return { config, databaseId };
});
if (resolved) {
downloadUrlExpirySeconds = resolved.config.downloadUrlExpirySeconds;
s3ForDb = resolveS3ForDatabase(options, resolved.config, resolved.databaseId);
if (resolved) {
downloadUrlExpirySeconds = resolved.config.downloadUrlExpirySeconds;
s3ForDb = resolveS3ForDatabase(options, resolved.config, resolved.databaseId);
}
}
} catch {
// Fall back to global config if lookup fails
}
} catch {
// Fall back to global config if lookup fails
}

if (isPublic && s3ForDb.publicUrlPrefix) {
// Public file: return direct CDN URL (per-database prefix)
return `${s3ForDb.publicUrlPrefix}/${key}`;
}

// Private file: generate presigned GET URL (per-database bucket)
return generatePresignedGetUrl(
s3ForDb,
key,
downloadUrlExpirySeconds,
filename || undefined,
);

if (isPublic && s3ForDb.publicUrlPrefix) {
// Public file: return direct CDN URL (per-database prefix)
return `${s3ForDb.publicUrlPrefix}/${key}`;
}

// Private file: generate presigned GET URL (per-database bucket)
return generatePresignedGetUrl(
s3ForDb,
key,
downloadUrlExpirySeconds,
filename || undefined,
);
});
},
},
),
Expand Down
Loading