diff options
Diffstat (limited to 'packages/integrations/vercel/src')
12 files changed, 657 insertions, 920 deletions
diff --git a/packages/integrations/vercel/src/image/shared.ts b/packages/integrations/vercel/src/image/shared.ts index dfae0d06f..cacb09192 100644 --- a/packages/integrations/vercel/src/image/shared.ts +++ b/packages/integrations/vercel/src/image/shared.ts @@ -13,12 +13,12 @@ export function isESMImportedImage(src: ImageMetadata | string): src is ImageMet return typeof src === 'object'; } -export type DevImageService = 'sharp' | 'squoosh' | (string & {}); +export type DevImageService = 'sharp' | (string & {}); // https://vercel.com/docs/build-output-api/v3/configuration#images type ImageFormat = 'image/avif' | 'image/webp'; -type RemotePattern = { +export type RemotePattern = { protocol?: 'http' | 'https'; hostname: string; port?: string; @@ -76,9 +76,6 @@ export function getAstroImageConfig( case 'sharp': devService = '@astrojs/vercel/dev-image-service'; break; - case 'squoosh': - devService = '@astrojs/vercel/squoosh-dev-image-service'; - break; default: if (typeof devImageService === 'string') { devService = devImageService; diff --git a/packages/integrations/vercel/src/image/squoosh-dev-service.ts b/packages/integrations/vercel/src/image/squoosh-dev-service.ts deleted file mode 100644 index d3b05bb11..000000000 --- a/packages/integrations/vercel/src/image/squoosh-dev-service.ts +++ /dev/null @@ -1,31 +0,0 @@ -import type { LocalImageService } from 'astro'; -import squooshService from 'astro/assets/services/squoosh'; -import { baseDevService } from './shared-dev-service.js'; - -const service: LocalImageService = { - ...baseDevService, - getHTMLAttributes(options, serviceOptions) { - const { inputtedWidth, ...props } = options; - - // If `validateOptions` returned a different width than the one of the image, use it for attributes - if (inputtedWidth) { - props.width = inputtedWidth; - } - - return squooshService.getHTMLAttributes - ? squooshService.getHTMLAttributes(props, serviceOptions) - : {}; - }, - transform(inputBuffer, transform, serviceOptions) { - // NOTE: Hardcoding webp here isn't accurate to how the Vercel Image Optimization API works, normally what we should - // do is setup a custom endpoint that sniff the user's accept-content header and serve the proper format based on the - // user's Vercel config. However, that's: a lot of work for: not much. The dev service is inaccurate to the prod service - // in many more ways, this is one of the less offending cases and is, imo, okay, erika - 2023-04-27 - transform.format = transform.src.endsWith('svg') ? 'svg' : 'webp'; - - // The base squoosh service works the same way as the Vercel Image Optimization API, so it's a safe fallback in local - return squooshService.transform(inputBuffer, transform, serviceOptions); - }, -}; - -export default service; diff --git a/packages/integrations/vercel/src/index.ts b/packages/integrations/vercel/src/index.ts new file mode 100644 index 000000000..f6d71661b --- /dev/null +++ b/packages/integrations/vercel/src/index.ts @@ -0,0 +1,622 @@ +import { existsSync, readFileSync } from 'node:fs'; +import { basename } from 'node:path'; +import { pathToFileURL } from 'node:url'; +import { emptyDir, removeDir, writeJson } from '@astrojs/internal-helpers/fs'; +import type { + AstroAdapter, + AstroConfig, + AstroIntegration, + AstroIntegrationLogger, + IntegrationRouteData, +} from 'astro'; +import glob from 'fast-glob'; +import { + type DevImageService, + type VercelImageConfig, + getAstroImageConfig, + getDefaultImageConfig, +} from './image/shared.js'; +import type { RemotePattern } from './image/shared.js'; +import { copyDependenciesToFunction } from './lib/nft.js'; +import { escapeRegex, getRedirects } from './lib/redirects.js'; +import { + type VercelWebAnalyticsConfig, + getInjectableWebAnalyticsContent, +} from './lib/web-analytics.js'; +import { generateEdgeMiddleware } from './serverless/middleware.js'; + +const PACKAGE_NAME = '@astrojs/vercel'; + +/** + * The edge function calls the node server at /_render, + * with the original path as the value of this header. + */ +export const ASTRO_PATH_HEADER = 'x-astro-path'; +export const ASTRO_PATH_PARAM = 'x_astro_path'; + +/** + * The edge function calls the node server at /_render, + * with the locals serialized into this header. + */ +export const ASTRO_LOCALS_HEADER = 'x-astro-locals'; +export const ASTRO_MIDDLEWARE_SECRET_HEADER = 'x-astro-middleware-secret'; +export const VERCEL_EDGE_MIDDLEWARE_FILE = 'vercel-edge-middleware'; + +// Vercel routes the folder names to a path on the deployed website. +// We attempt to avoid interfering by prefixing with an underscore. +export const NODE_PATH = '_render'; +const MIDDLEWARE_PATH = '_middleware'; + +// This isn't documented by vercel anywhere, but unlike serverless +// and edge functions, isr functions are not passed the original path. +// Instead, we have to use $0 to refer to the regex match from "src". +const ISR_PATH = `/_isr?${ASTRO_PATH_PARAM}=$0`; + +// https://vercel.com/docs/concepts/functions/serverless-functions/runtimes/node-js#node.js-version +const SUPPORTED_NODE_VERSIONS: Record< + string, + | { status: 'default' } + | { status: 'beta' } + | { status: 'retiring'; removal: Date | string; warnDate: Date } + | { status: 'deprecated'; removal: Date } +> = { + 18: { status: 'retiring', removal: 'Early 2025', warnDate: new Date('October 1 2024') }, + 20: { status: 'default' }, +}; + +function getAdapter({ + edgeMiddleware, + middlewareSecret, + skewProtection, + buildOutput, +}: { + buildOutput: 'server' | 'static'; + edgeMiddleware: boolean; + middlewareSecret: string; + skewProtection: boolean; +}): AstroAdapter { + return { + name: PACKAGE_NAME, + serverEntrypoint: `${PACKAGE_NAME}/entrypoint`, + exports: ['default'], + args: { middlewareSecret, skewProtection }, + adapterFeatures: { + edgeMiddleware, + buildOutput, + }, + supportedAstroFeatures: { + hybridOutput: 'stable', + staticOutput: 'stable', + serverOutput: 'stable', + sharpImageService: 'stable', + i18nDomains: 'experimental', + envGetSecret: 'stable', + }, + }; +} + +export interface VercelServerlessConfig { + /** Configuration for [Vercel Web Analytics](https://vercel.com/docs/concepts/analytics). */ + webAnalytics?: VercelWebAnalyticsConfig; + + /** Force files to be bundled with your function. This is helpful when you notice missing files. */ + includeFiles?: string[]; + + /** Exclude any files from the bundling process that would otherwise be included. */ + excludeFiles?: string[]; + + /** When enabled, an Image Service powered by the Vercel Image Optimization API will be automatically configured and used in production. In development, the image service specified by devImageService will be used instead. */ + imageService?: boolean; + + /** Configuration options for [Vercel’s Image Optimization API](https://vercel.com/docs/concepts/image-optimization). See [Vercel’s image configuration documentation](https://vercel.com/docs/build-output-api/v3/configuration#images) for a complete list of supported parameters. */ + imagesConfig?: VercelImageConfig; + + /** Allows you to configure which image service to use in development when imageService is enabled. */ + devImageService?: DevImageService; + + /** Whether to create the Vercel Edge middleware from an Astro middleware in your code base. */ + edgeMiddleware?: boolean; + + /** The maximum duration (in seconds) that Serverless Functions can run before timing out. See the [Vercel documentation](https://vercel.com/docs/functions/serverless-functions/runtimes#maxduration) for the default and maximum limit for your account plan. */ + maxDuration?: number; + + /** Whether to cache on-demand rendered pages in the same way as static files. */ + isr?: boolean | VercelISRConfig; + /** + * It enables Vercel skew protection: https://vercel.com/docs/deployments/skew-protection + */ + skewProtection?: boolean; +} + +interface VercelISRConfig { + /** + * A secret random string that you create. + * Its presence in the `__prerender_bypass` cookie will result in fresh responses being served, bypassing the cache. See Vercel’s documentation on [Draft Mode](https://vercel.com/docs/build-output-api/v3/features#draft-mode) for more information. + * Its presence in the `x-prerender-revalidate` header will result in a fresh response which will then be cached for all future requests to be used. See Vercel’s documentation on [On-Demand Incremental Static Regeneration (ISR)](https://vercel.com/docs/build-output-api/v3/features#on-demand-incremental-static-regeneration-isr) for more information. + * + * @default `undefined` + */ + bypassToken?: string; + + /** + * Expiration time (in seconds) before the pages will be re-generated. + * + * Setting to `false` means that the page will stay cached as long as the current deployment is in production. + * + * @default `false` + */ + expiration?: number | false; + + /** + * Paths that will always be served by a serverless function instead of an ISR function. + * + * @default `[]` + */ + exclude?: string[]; +} + +export default function vercelAdapter({ + webAnalytics, + includeFiles: _includeFiles = [], + excludeFiles: _excludeFiles = [], + imageService, + imagesConfig, + devImageService = 'sharp', + edgeMiddleware = false, + maxDuration, + isr = false, + skewProtection = false, +}: VercelServerlessConfig = {}): AstroIntegration { + if (maxDuration) { + if (typeof maxDuration !== 'number') { + // biome-ignore lint/style/noUnusedTemplateLiteral: <explanation> + throw new TypeError(`maxDuration must be a number`, { cause: maxDuration }); + } + if (maxDuration <= 0) { + // biome-ignore lint/style/noUnusedTemplateLiteral: <explanation> + throw new TypeError(`maxDuration must be a positive number`, { cause: maxDuration }); + } + } + + let _config: AstroConfig; + let _buildTempFolder: URL; + let _serverEntry: string; + let _entryPoints: Map<IntegrationRouteData, URL>; + let _middlewareEntryPoint: URL | undefined; + // Extra files to be merged with `includeFiles` during build + const extraFilesToInclude: URL[] = []; + // Secret used to verify that the caller is the astro-generated edge middleware and not a third-party + const middlewareSecret = crypto.randomUUID(); + + let buildOutput: 'server' | 'static'; + + return { + name: PACKAGE_NAME, + hooks: { + 'astro:config:setup': async ({ command, config, updateConfig, injectScript, logger }) => { + buildOutput = config.output; + if (webAnalytics?.enabled) { + injectScript( + 'head-inline', + await getInjectableWebAnalyticsContent({ + mode: command === 'dev' ? 'development' : 'production', + }) + ); + } + + if (buildOutput === 'server') { + if (maxDuration && maxDuration > 900) { + logger.warn( + `maxDuration is set to ${maxDuration} seconds, which is longer than the maximum allowed duration of 900 seconds.` + ); + logger.warn( + // biome-ignore lint/style/noUnusedTemplateLiteral: <explanation> + `Please make sure that your plan allows for this duration. See https://vercel.com/docs/functions/serverless-functions/runtimes#maxduration for more information.` + ); + } + + const vercelConfigPath = new URL('vercel.json', config.root); + if (existsSync(vercelConfigPath)) { + try { + const vercelConfig = JSON.parse(readFileSync(vercelConfigPath, 'utf-8')); + if (vercelConfig.trailingSlash === true && config.trailingSlash === 'always') { + logger.warn( + '\n' + + `\tYour "vercel.json" \`trailingSlash\` configuration (set to \`true\`) will conflict with your Astro \`trailinglSlash\` configuration (set to \`"always"\`).\n` + + // biome-ignore lint/style/noUnusedTemplateLiteral: <explanation> + `\tThis would cause infinite redirects under certain conditions and throw an \`ERR_TOO_MANY_REDIRECTS\` error.\n` + + `\tTo prevent this, your Astro configuration is updated to \`"ignore"\` during builds.\n` + ); + updateConfig({ + trailingSlash: 'ignore', + }); + } + } catch (_err) { + logger.warn(`Your "vercel.json" config is not a valid json file.`); + } + } + + updateConfig({ + outDir: new URL('./.vercel/output/', config.root), + build: { + client: new URL('./.vercel/output/static/', config.root), + server: new URL('./.vercel/output/_functions/', config.root), + redirects: false, + }, + vite: { + ssr: { + external: ['@vercel/nft'], + }, + }, + ...getAstroImageConfig( + imageService, + imagesConfig, + command, + devImageService, + config.image + ), + }); + } else { + const outDir = new URL('./.vercel/output/static/', config.root); + updateConfig({ + outDir, + build: { + format: 'directory', + redirects: false, + }, + ...getAstroImageConfig( + imageService, + imagesConfig, + command, + devImageService, + config.image + ), + }); + } + }, + 'astro:config:done': ({ setAdapter, config }) => { + if (buildOutput === 'server') { + setAdapter(getAdapter({ buildOutput, edgeMiddleware, middlewareSecret, skewProtection })); + } else { + setAdapter( + getAdapter({ + edgeMiddleware: false, + middlewareSecret: '', + skewProtection, + buildOutput, + }) + ); + } + _config = config; + _buildTempFolder = config.build.server; + _serverEntry = config.build.serverEntry; + }, + 'astro:build:start': async () => { + if (buildOutput !== 'static') { + // Ensure to have `.vercel/output` empty. + // This is because, when building to static, outDir = .vercel/output/static/, + // so .vercel/output itself won't get cleaned. + await emptyDir(new URL('./.vercel/output/', _config.root)); + } + }, + 'astro:build:ssr': async ({ entryPoints, middlewareEntryPoint }) => { + _entryPoints = new Map( + Array.from(entryPoints).filter(([routeData]) => !routeData.prerender) + ); + _middlewareEntryPoint = middlewareEntryPoint; + }, + 'astro:build:done': async ({ routes, logger }) => { + const routeDefinitions: Array<{ + src: string; + dest: string; + middlewarePath?: string; + }> = []; + + if (buildOutput === 'server') { + // Merge any includes from `vite.assetsInclude + if (_config.vite.assetsInclude) { + const mergeGlobbedIncludes = (globPattern: unknown) => { + if (typeof globPattern === 'string') { + const entries = glob.sync(globPattern).map((p) => pathToFileURL(p)); + extraFilesToInclude.push(...entries); + } else if (Array.isArray(globPattern)) { + for (const pattern of globPattern) { + mergeGlobbedIncludes(pattern); + } + } + }; + + mergeGlobbedIncludes(_config.vite.assetsInclude); + } + + const includeFiles = _includeFiles + .map((file) => new URL(file, _config.root)) + .concat(extraFilesToInclude); + const excludeFiles = _excludeFiles.map((file) => new URL(file, _config.root)); + + const builder = new VercelBuilder( + _config, + excludeFiles, + includeFiles, + logger, + maxDuration + ); + + // Multiple entrypoint support + if (_entryPoints.size) { + const getRouteFuncName = (route: IntegrationRouteData) => + route.component.replace('src/pages/', ''); + + const getFallbackFuncName = (entryFile: URL) => + basename(entryFile.toString()) + .replace('entry.', '') + .replace(/\.mjs$/, ''); + + for (const [route, entryFile] of _entryPoints) { + const func = route.component.startsWith('src/pages/') + ? getRouteFuncName(route) + : getFallbackFuncName(entryFile); + + await builder.buildServerlessFolder(entryFile, func, _config.root); + + routeDefinitions.push({ + src: route.pattern.source, + dest: func, + }); + } + } else { + const entryFile = new URL(_serverEntry, _buildTempFolder); + if (isr) { + const isrConfig = typeof isr === 'object' ? isr : {}; + await builder.buildServerlessFolder(entryFile, NODE_PATH, _config.root); + if (isrConfig.exclude?.length) { + const dest = _middlewareEntryPoint ? MIDDLEWARE_PATH : NODE_PATH; + for (const route of isrConfig.exclude) { + // vercel interprets src as a regex pattern, so we need to escape it + routeDefinitions.push({ src: escapeRegex(route), dest }); + } + } + await builder.buildISRFolder(entryFile, '_isr', isrConfig, _config.root); + for (const route of routes) { + const src = route.pattern.source; + const dest = src.startsWith('^\\/_image') ? NODE_PATH : ISR_PATH; + if (!route.prerender) routeDefinitions.push({ src, dest }); + } + } else { + await builder.buildServerlessFolder(entryFile, NODE_PATH, _config.root); + const dest = _middlewareEntryPoint ? MIDDLEWARE_PATH : NODE_PATH; + for (const route of routes) { + if (!route.prerender) routeDefinitions.push({ src: route.pattern.source, dest }); + } + } + } + if (_middlewareEntryPoint) { + await builder.buildMiddlewareFolder( + _middlewareEntryPoint, + MIDDLEWARE_PATH, + middlewareSecret + ); + } + } + const fourOhFourRoute = routes.find((route) => route.pathname === '/404'); + const destination = + buildOutput === 'server' + ? new URL('./config.json', _config.outDir) + : new URL('./.vercel/output/config.json', _config.root); + const finalRoutes = [ + ...getRedirects(routes, _config), + { + src: `^/${_config.build.assets}/(.*)$`, + headers: { 'cache-control': 'public, max-age=31536000, immutable' }, + continue: true, + }, + { handle: 'filesystem' }, + ]; + if (buildOutput === 'server') { + finalRoutes.push(...routeDefinitions); + } + + if (fourOhFourRoute) { + if (buildOutput === 'server') { + finalRoutes.push({ + src: '/.*', + dest: fourOhFourRoute.prerender + ? '/404.html' + : _middlewareEntryPoint + ? MIDDLEWARE_PATH + : NODE_PATH, + status: 404, + }); + } else { + finalRoutes.push({ + src: '/.*', + dest: '/404.html', + status: 404, + }); + } + } + + let images: VercelImageConfig | undefined; + if (imageService || imagesConfig) { + if (imagesConfig) { + images = { + ...imagesConfig, + domains: [...imagesConfig.domains, ..._config.image.domains], + remotePatterns: [...(imagesConfig.remotePatterns ?? [])], + }; + const remotePatterns = _config.image.remotePatterns; + for (const pattern of remotePatterns) { + if (isAcceptedPattern(pattern)) { + images.remotePatterns?.push(pattern); + } + } + } else { + images = getDefaultImageConfig(_config.image); + } + } + + // Output configuration + // https://vercel.com/docs/build-output-api/v3#build-output-configuration + await writeJson(destination, { + version: 3, + routes: finalRoutes, + images, + }); + + // Remove temporary folder + if (buildOutput === 'server') { + await removeDir(_buildTempFolder); + } + }, + }, + }; +} + +function isAcceptedPattern(pattern: any): pattern is RemotePattern { + if (pattern == null) { + return false; + } + if (!pattern.hostname) { + return false; + } + if (pattern.protocol && (pattern.protocol !== 'http' || pattern.protocol !== 'https')) { + return false; + } + return true; +} + +type Runtime = `nodejs${string}.x`; + +class VercelBuilder { + readonly NTF_CACHE = {}; + + constructor( + readonly config: AstroConfig, + readonly excludeFiles: URL[], + readonly includeFiles: URL[], + readonly logger: AstroIntegrationLogger, + readonly maxDuration?: number, + readonly runtime = getRuntime(process, logger) + ) {} + + async buildServerlessFolder(entry: URL, functionName: string, root: URL) { + const { config, includeFiles, excludeFiles, logger, NTF_CACHE, runtime, maxDuration } = this; + // .vercel/output/functions/<name>.func/ + const functionFolder = new URL(`./functions/${functionName}.func/`, config.outDir); + const packageJson = new URL(`./functions/${functionName}.func/package.json`, config.outDir); + const vcConfig = new URL(`./functions/${functionName}.func/.vc-config.json`, config.outDir); + + // Copy necessary files (e.g. node_modules/) + const { handler } = await copyDependenciesToFunction( + { + entry, + outDir: functionFolder, + includeFiles, + excludeFiles, + logger, + root, + }, + NTF_CACHE + ); + + // Enable ESM + // https://aws.amazon.com/blogs/compute/using-node-js-es-modules-and-top-level-await-in-aws-lambda/ + await writeJson(packageJson, { type: 'module' }); + + // Serverless function config + // https://vercel.com/docs/build-output-api/v3#vercel-primitives/serverless-functions/configuration + await writeJson(vcConfig, { + runtime, + handler: handler.replaceAll('\\', '/'), + launcherType: 'Nodejs', + maxDuration, + supportsResponseStreaming: true, + }); + } + + async buildISRFolder(entry: URL, functionName: string, isr: VercelISRConfig, root: URL) { + await this.buildServerlessFolder(entry, functionName, root); + const prerenderConfig = new URL( + `./functions/${functionName}.prerender-config.json`, + this.config.outDir + ); + // https://vercel.com/docs/build-output-api/v3/primitives#prerender-configuration-file + await writeJson(prerenderConfig, { + expiration: isr.expiration ?? false, + bypassToken: isr.bypassToken, + allowQuery: [ASTRO_PATH_PARAM], + passQuery: true, + }); + } + + async buildMiddlewareFolder(entry: URL, functionName: string, middlewareSecret: string) { + const functionFolder = new URL(`./functions/${functionName}.func/`, this.config.outDir); + + await generateEdgeMiddleware( + entry, + this.config.root, + new URL(VERCEL_EDGE_MIDDLEWARE_FILE, this.config.srcDir), + new URL('./middleware.mjs', functionFolder), + middlewareSecret, + this.logger + ); + + // biome-ignore lint/style/noUnusedTemplateLiteral: <explanation> + await writeJson(new URL(`./.vc-config.json`, functionFolder), { + runtime: 'edge', + entrypoint: 'middleware.mjs', + }); + } +} + +function getRuntime(process: NodeJS.Process, logger: AstroIntegrationLogger): Runtime { + const version = process.version.slice(1); // 'v18.19.0' --> '18.19.0' + const major = version.split('.')[0]; // '18.19.0' --> '18' + const support = SUPPORTED_NODE_VERSIONS[major]; + if (support === undefined) { + logger.warn( + // biome-ignore lint/style/useTemplate: <explanation> + // biome-ignore lint/style/noUnusedTemplateLiteral: <explanation> + `\n` + + `\tThe local Node.js version (${major}) is not supported by Vercel Serverless Functions.\n` + + // biome-ignore lint/style/noUnusedTemplateLiteral: <explanation> + `\tYour project will use Node.js 18 as the runtime instead.\n` + + // biome-ignore lint/style/noUnusedTemplateLiteral: <explanation> + `\tConsider switching your local version to 18.\n` + ); + return 'nodejs18.x'; + } + if (support.status === 'default') { + return `nodejs${major}.x`; + } + if (support.status === 'retiring') { + if (support.warnDate && new Date() >= support.warnDate) { + logger.warn( + `Your project is being built for Node.js ${major} as the runtime, which is retiring by ${support.removal}.` + ); + } + return `nodejs${major}.x`; + } + if (support.status === 'beta') { + logger.warn( + `Your project is being built for Node.js ${major} as the runtime, which is currently in beta for Vercel Serverless Functions.` + ); + return `nodejs${major}.x`; + } + if (support.status === 'deprecated') { + const removeDate = new Intl.DateTimeFormat(undefined, { dateStyle: 'long' }).format( + support.removal + ); + logger.warn( + // biome-ignore lint/style/useTemplate: <explanation> + // biome-ignore lint/style/noUnusedTemplateLiteral: <explanation> + `\n` + + `\tYour project is being built for Node.js ${major} as the runtime.\n` + + `\tThis version is deprecated by Vercel Serverless Functions, and scheduled to be disabled on ${removeDate}.\n` + + // biome-ignore lint/style/noUnusedTemplateLiteral: <explanation> + `\tConsider upgrading your local version to 18.\n` + ); + return `nodejs${major}.x`; + } + return 'nodejs18.x'; +} diff --git a/packages/integrations/vercel/src/lib/prerender.ts b/packages/integrations/vercel/src/lib/prerender.ts deleted file mode 100644 index f69f3b5d4..000000000 --- a/packages/integrations/vercel/src/lib/prerender.ts +++ /dev/null @@ -1,5 +0,0 @@ -import type { AstroConfig } from 'astro'; - -export function isServerLikeOutput(config: AstroConfig) { - return config.output === 'server' || config.output === 'hybrid'; -} diff --git a/packages/integrations/vercel/src/lib/redirects.ts b/packages/integrations/vercel/src/lib/redirects.ts index e6d991429..7ef4d5045 100644 --- a/packages/integrations/vercel/src/lib/redirects.ts +++ b/packages/integrations/vercel/src/lib/redirects.ts @@ -1,6 +1,6 @@ import nodePath from 'node:path'; import { appendForwardSlash, removeLeadingForwardSlash } from '@astrojs/internal-helpers/path'; -import type { AstroConfig, RouteData, RoutePart } from 'astro'; +import type { AstroConfig, IntegrationRouteData, RoutePart } from 'astro'; const pathJoin = nodePath.posix.join; @@ -91,7 +91,7 @@ function getReplacePattern(segments: RoutePart[][]) { return result; } -function getRedirectLocation(route: RouteData, config: AstroConfig): string { +function getRedirectLocation(route: IntegrationRouteData, config: AstroConfig): string { if (route.redirectRoute) { const pattern = getReplacePattern(route.redirectRoute.segments); const path = config.trailingSlash === 'always' ? appendForwardSlash(pattern) : pattern; @@ -105,7 +105,7 @@ function getRedirectLocation(route: RouteData, config: AstroConfig): string { } } -function getRedirectStatus(route: RouteData): number { +function getRedirectStatus(route: IntegrationRouteData): number { if (typeof route.redirect === 'object') { return route.redirect.status; } @@ -122,7 +122,7 @@ export function escapeRegex(content: string) { return `^/${getMatchPattern(segments)}$`; } -export function getRedirects(routes: RouteData[], config: AstroConfig): VercelRoute[] { +export function getRedirects(routes: IntegrationRouteData[], config: AstroConfig): VercelRoute[] { const redirects: VercelRoute[] = []; for (const route of routes) { diff --git a/packages/integrations/vercel/src/lib/speed-insights.ts b/packages/integrations/vercel/src/lib/speed-insights.ts deleted file mode 100644 index 033a705c5..000000000 --- a/packages/integrations/vercel/src/lib/speed-insights.ts +++ /dev/null @@ -1,30 +0,0 @@ -export type VercelSpeedInsightsConfig = { - enabled: boolean; -}; - -export function getSpeedInsightsViteConfig(enabled?: boolean) { - if (enabled) { - return { - define: exposeEnv(['VERCEL_ANALYTICS_ID']), - }; - } - - return {}; -} - -/** - * While Vercel adds the `PUBLIC_` prefix for their `VERCEL_` env vars by default, some env vars - * like `VERCEL_ANALYTICS_ID` aren't, so handle them here so that it works correctly in runtime. - */ -export function exposeEnv(envs: string[]): Record<string, unknown> { - const mapped: Record<string, unknown> = {}; - - // biome-ignore lint/complexity/noForEach: <explanation> - envs - .filter((env) => process.env[env]) - .forEach((env) => { - mapped[`import.meta.env.PUBLIC_${env}`] = JSON.stringify(process.env[env]); - }); - - return mapped; -} diff --git a/packages/integrations/vercel/src/serverless/adapter.ts b/packages/integrations/vercel/src/serverless/adapter.ts index e50bd4190..86464f89b 100644 --- a/packages/integrations/vercel/src/serverless/adapter.ts +++ b/packages/integrations/vercel/src/serverless/adapter.ts @@ -1,608 +1,10 @@ -import { existsSync, readFileSync } from 'node:fs'; -import { basename } from 'node:path'; -import { pathToFileURL } from 'node:url'; -import { removeDir, writeJson } from '@astrojs/internal-helpers/fs'; -import type { - AstroAdapter, - AstroConfig, - AstroIntegration, - AstroIntegrationLogger, - RouteData, -} from 'astro'; -import { AstroError } from 'astro/errors'; -import glob from 'fast-glob'; -import { - type DevImageService, - type VercelImageConfig, - getAstroImageConfig, - getDefaultImageConfig, -} from '../image/shared.js'; -import { copyDependenciesToFunction } from '../lib/nft.js'; -import { escapeRegex, getRedirects } from '../lib/redirects.js'; -import { - type VercelSpeedInsightsConfig, - getSpeedInsightsViteConfig, -} from '../lib/speed-insights.js'; -import { - type VercelWebAnalyticsConfig, - getInjectableWebAnalyticsContent, -} from '../lib/web-analytics.js'; -import { generateEdgeMiddleware } from './middleware.js'; - -const PACKAGE_NAME = '@astrojs/vercel/serverless'; - -/** - * The edge function calls the node server at /_render, - * with the original path as the value of this header. - */ -export const ASTRO_PATH_HEADER = 'x-astro-path'; -export const ASTRO_PATH_PARAM = 'x_astro_path'; - -/** - * The edge function calls the node server at /_render, - * with the locals serialized into this header. - */ -export const ASTRO_LOCALS_HEADER = 'x-astro-locals'; -export const ASTRO_MIDDLEWARE_SECRET_HEADER = 'x-astro-middleware-secret'; -export const VERCEL_EDGE_MIDDLEWARE_FILE = 'vercel-edge-middleware'; - -// Vercel routes the folder names to a path on the deployed website. -// We attempt to avoid interfering by prefixing with an underscore. -export const NODE_PATH = '_render'; -const MIDDLEWARE_PATH = '_middleware'; - -// This isn't documented by vercel anywhere, but unlike serverless -// and edge functions, isr functions are not passed the original path. -// Instead, we have to use $0 to refer to the regex match from "src". -const ISR_PATH = `/_isr?${ASTRO_PATH_PARAM}=$0`; - -// https://vercel.com/docs/concepts/functions/serverless-functions/runtimes/node-js#node.js-version -const SUPPORTED_NODE_VERSIONS: Record< - string, - | { status: 'default' } - | { status: 'beta' } - | { status: 'retiring'; removal: Date | string; warnDate: Date } - | { status: 'deprecated'; removal: Date } -> = { - 18: { status: 'retiring', removal: 'Early 2025', warnDate: new Date('October 1 2024') }, - 20: { status: 'default' }, -}; - -function getAdapter({ - edgeMiddleware, - functionPerRoute, - middlewareSecret, - skewProtection, -}: { - edgeMiddleware: boolean; - functionPerRoute: boolean; - middlewareSecret: string; - skewProtection: boolean; -}): AstroAdapter { - return { - name: PACKAGE_NAME, - serverEntrypoint: `${PACKAGE_NAME}/entrypoint`, - exports: ['default'], - args: { middlewareSecret, skewProtection }, - adapterFeatures: { - edgeMiddleware, - functionPerRoute, - }, - supportedAstroFeatures: { - hybridOutput: 'stable', - staticOutput: 'stable', - serverOutput: 'stable', - assets: { - supportKind: 'stable', - isSharpCompatible: true, - isSquooshCompatible: true, - }, - i18nDomains: 'experimental', - envGetSecret: 'experimental', - }, - }; -} - -export interface VercelServerlessConfig { - /** Configuration for [Vercel Web Analytics](https://vercel.com/docs/concepts/analytics). */ - webAnalytics?: VercelWebAnalyticsConfig; - - /** - * @deprecated This option lets you configure the legacy speed insights API which is now deprecated by Vercel. - * - * See [Vercel Speed Insights Quickstart](https://vercel.com/docs/speed-insights/quickstart) for instructions on how to use the library instead. - * - * https://vercel.com/docs/speed-insights/quickstart - */ - speedInsights?: VercelSpeedInsightsConfig; - - /** Force files to be bundled with your function. This is helpful when you notice missing files. */ - includeFiles?: string[]; - - /** Exclude any files from the bundling process that would otherwise be included. */ - excludeFiles?: string[]; - - /** When enabled, an Image Service powered by the Vercel Image Optimization API will be automatically configured and used in production. In development, the image service specified by devImageService will be used instead. */ - imageService?: boolean; - - /** Configuration options for [Vercel’s Image Optimization API](https://vercel.com/docs/concepts/image-optimization). See [Vercel’s image configuration documentation](https://vercel.com/docs/build-output-api/v3/configuration#images) for a complete list of supported parameters. */ - imagesConfig?: VercelImageConfig; - - /** Allows you to configure which image service to use in development when imageService is enabled. */ - devImageService?: DevImageService; - - /** Whether to create the Vercel Edge middleware from an Astro middleware in your code base. */ - edgeMiddleware?: boolean; - - /** - * Whether to split builds into a separate function for each route. - * @deprecated `functionPerRoute` is deprecated and will be removed in the next major release of the adapter. - */ - functionPerRoute?: boolean; - - /** The maximum duration (in seconds) that Serverless Functions can run before timing out. See the [Vercel documentation](https://vercel.com/docs/functions/serverless-functions/runtimes#maxduration) for the default and maximum limit for your account plan. */ - maxDuration?: number; - - /** Whether to cache on-demand rendered pages in the same way as static files. */ - isr?: boolean | VercelISRConfig; - /** - * It enables Vercel skew protection: https://vercel.com/docs/deployments/skew-protection - */ - skewProtection?: boolean; -} - -interface VercelISRConfig { - /** - * A secret random string that you create. - * Its presence in the `__prerender_bypass` cookie will result in fresh responses being served, bypassing the cache. See Vercel’s documentation on [Draft Mode](https://vercel.com/docs/build-output-api/v3/features#draft-mode) for more information. - * Its presence in the `x-prerender-revalidate` header will result in a fresh response which will then be cached for all future requests to be used. See Vercel’s documentation on [On-Demand Incremental Static Regeneration (ISR)](https://vercel.com/docs/build-output-api/v3/features#on-demand-incremental-static-regeneration-isr) for more information. - * - * @default `undefined` - */ - bypassToken?: string; - - /** - * Expiration time (in seconds) before the pages will be re-generated. - * - * Setting to `false` means that the page will stay cached as long as the current deployment is in production. - * - * @default `false` - */ - expiration?: number | false; - - /** - * Paths that will always be served by a serverless function instead of an ISR function. - * - * @default `[]` - */ - exclude?: string[]; -} - -export default function vercelServerless({ - webAnalytics, - speedInsights, - includeFiles: _includeFiles = [], - excludeFiles: _excludeFiles = [], - imageService, - imagesConfig, - devImageService = 'sharp', - functionPerRoute = false, - edgeMiddleware = false, - maxDuration, - isr = false, - skewProtection = false, -}: VercelServerlessConfig = {}): AstroIntegration { - if (maxDuration) { - if (typeof maxDuration !== 'number') { - // biome-ignore lint/style/noUnusedTemplateLiteral: <explanation> - throw new TypeError(`maxDuration must be a number`, { cause: maxDuration }); - } - if (maxDuration <= 0) { - // biome-ignore lint/style/noUnusedTemplateLiteral: <explanation> - throw new TypeError(`maxDuration must be a positive number`, { cause: maxDuration }); - } - } - - let _config: AstroConfig; - let _buildTempFolder: URL; - let _serverEntry: string; - let _entryPoints: Map<RouteData, URL>; - let _middlewareEntryPoint: URL | undefined; - // Extra files to be merged with `includeFiles` during build - const extraFilesToInclude: URL[] = []; - // Secret used to verify that the caller is the astro-generated edge middleware and not a third-party - const middlewareSecret = crypto.randomUUID(); - - return { - name: PACKAGE_NAME, - hooks: { - 'astro:config:setup': async ({ command, config, updateConfig, injectScript, logger }) => { - if (maxDuration && maxDuration > 900) { - logger.warn( - `maxDuration is set to ${maxDuration} seconds, which is longer than the maximum allowed duration of 900 seconds.` - ); - logger.warn( - // biome-ignore lint/style/noUnusedTemplateLiteral: <explanation> - `Please make sure that your plan allows for this duration. See https://vercel.com/docs/functions/serverless-functions/runtimes#maxduration for more information.` - ); - } - - if (webAnalytics?.enabled) { - injectScript( - 'head-inline', - await getInjectableWebAnalyticsContent({ - mode: command === 'dev' ? 'development' : 'production', - }) - ); - } - if (command === 'build' && speedInsights?.enabled) { - injectScript('page', 'import "@astrojs/vercel/speed-insights"'); - } - - const vercelConfigPath = new URL('vercel.json', config.root); - if (existsSync(vercelConfigPath)) { - try { - const vercelConfig = JSON.parse(readFileSync(vercelConfigPath, 'utf-8')); - if (vercelConfig.trailingSlash === true && config.trailingSlash === 'always') { - logger.warn( - '\n' + - `\tYour "vercel.json" \`trailingSlash\` configuration (set to \`true\`) will conflict with your Astro \`trailinglSlash\` configuration (set to \`"always"\`).\n` + - // biome-ignore lint/style/noUnusedTemplateLiteral: <explanation> - `\tThis would cause infinite redirects under certain conditions and throw an \`ERR_TOO_MANY_REDIRECTS\` error.\n` + - `\tTo prevent this, your Astro configuration is updated to \`"ignore"\` during builds.\n` - ); - updateConfig({ - trailingSlash: 'ignore', - }); - } - } catch (_err) { - logger.warn(`Your "vercel.json" config is not a valid json file.`); - } - } - - updateConfig({ - outDir: new URL('./.vercel/output/', config.root), - build: { - client: new URL('./.vercel/output/static/', config.root), - server: new URL('./.vercel/output/_functions/', config.root), - redirects: false, - }, - vite: { - ...getSpeedInsightsViteConfig(speedInsights?.enabled), - ssr: { - external: [ - '@vercel/nft', - ...((await shouldExternalizeAstroEnvSetup()) ? ['astro/env/setup'] : []), - ], - }, - }, - ...getAstroImageConfig( - imageService, - imagesConfig, - command, - devImageService, - config.image - ), - }); - }, - 'astro:config:done': ({ setAdapter, config, logger }) => { - if (functionPerRoute === true) { - logger.warn( - // biome-ignore lint/style/noUnusedTemplateLiteral: <explanation> - `\n` + - `\tVercel's hosting plans might have limits to the number of functions you can create.\n` + - // biome-ignore lint/style/noUnusedTemplateLiteral: <explanation> - `\tMake sure to check your plan carefully to avoid incurring additional costs.\n` + - // biome-ignore lint/style/noUnusedTemplateLiteral: <explanation> - `\tYou can set functionPerRoute: false to prevent surpassing the limit.\n` - ); - - logger.warn( - // biome-ignore lint/style/noUnusedTemplateLiteral: <explanation> - `\n` + - // biome-ignore lint/style/noUnusedTemplateLiteral: <explanation> - `\t\`functionPerRoute\` is deprecated and will be removed in a future version of the adapter.\n` - ); - } - - setAdapter( - getAdapter({ functionPerRoute, edgeMiddleware, middlewareSecret, skewProtection }) - ); - - _config = config; - _buildTempFolder = config.build.server; - _serverEntry = config.build.serverEntry; - - if (config.output === 'static') { - throw new AstroError( - '`output: "server"` or `output: "hybrid"` is required to use the serverless adapter.' - ); - } - }, - 'astro:build:ssr': async ({ entryPoints, middlewareEntryPoint }) => { - _entryPoints = new Map( - Array.from(entryPoints).filter(([routeData]) => !routeData.prerender) - ); - _middlewareEntryPoint = middlewareEntryPoint; - }, - 'astro:build:done': async ({ routes, logger }) => { - // Merge any includes from `vite.assetsInclude - if (_config.vite.assetsInclude) { - const mergeGlobbedIncludes = (globPattern: unknown) => { - if (typeof globPattern === 'string') { - const entries = glob.sync(globPattern).map((p) => pathToFileURL(p)); - extraFilesToInclude.push(...entries); - } else if (Array.isArray(globPattern)) { - for (const pattern of globPattern) { - mergeGlobbedIncludes(pattern); - } - } - }; - - mergeGlobbedIncludes(_config.vite.assetsInclude); - } - - const routeDefinitions: Array<{ - src: string; - dest: string; - middlewarePath?: string; - }> = []; - - const includeFiles = _includeFiles - .map((file) => new URL(file, _config.root)) - .concat(extraFilesToInclude); - const excludeFiles = _excludeFiles.map((file) => new URL(file, _config.root)); - - const builder = new VercelBuilder(_config, excludeFiles, includeFiles, logger, maxDuration); - - // Multiple entrypoint support - if (_entryPoints.size) { - const getRouteFuncName = (route: RouteData) => route.component.replace('src/pages/', ''); - - const getFallbackFuncName = (entryFile: URL) => - basename(entryFile.toString()) - .replace('entry.', '') - .replace(/\.mjs$/, ''); - - for (const [route, entryFile] of _entryPoints) { - const func = route.component.startsWith('src/pages/') - ? getRouteFuncName(route) - : getFallbackFuncName(entryFile); - - await builder.buildServerlessFolder(entryFile, func, _config.root); - - routeDefinitions.push({ - src: route.pattern.source, - dest: func, - }); - } - } else { - const entryFile = new URL(_serverEntry, _buildTempFolder); - if (isr) { - const isrConfig = typeof isr === 'object' ? isr : {}; - await builder.buildServerlessFolder(entryFile, NODE_PATH, _config.root); - if (isrConfig.exclude?.length) { - const dest = _middlewareEntryPoint ? MIDDLEWARE_PATH : NODE_PATH; - for (const route of isrConfig.exclude) { - // vercel interprets src as a regex pattern, so we need to escape it - routeDefinitions.push({ src: escapeRegex(route), dest }); - } - } - await builder.buildISRFolder(entryFile, '_isr', isrConfig, _config.root); - for (const route of routes) { - const src = route.pattern.source; - const dest = src.startsWith('^\\/_image') ? NODE_PATH : ISR_PATH; - if (!route.prerender) routeDefinitions.push({ src, dest }); - } - } else { - await builder.buildServerlessFolder(entryFile, NODE_PATH, _config.root); - const dest = _middlewareEntryPoint ? MIDDLEWARE_PATH : NODE_PATH; - for (const route of routes) { - if (!route.prerender) routeDefinitions.push({ src: route.pattern.source, dest }); - } - } - } - if (_middlewareEntryPoint) { - await builder.buildMiddlewareFolder( - _middlewareEntryPoint, - MIDDLEWARE_PATH, - middlewareSecret - ); - } - const fourOhFourRoute = routes.find((route) => route.pathname === '/404'); - // Output configuration - // https://vercel.com/docs/build-output-api/v3#build-output-configuration - // biome-ignore lint/style/noUnusedTemplateLiteral: <explanation> - await writeJson(new URL(`./config.json`, _config.outDir), { - version: 3, - routes: [ - ...getRedirects(routes, _config), - { - src: `^/${_config.build.assets}/(.*)$`, - headers: { 'cache-control': 'public, max-age=31536000, immutable' }, - continue: true, - }, - { handle: 'filesystem' }, - ...routeDefinitions, - ...(fourOhFourRoute - ? [ - { - src: '/.*', - dest: fourOhFourRoute.prerender - ? '/404.html' - : _middlewareEntryPoint - ? MIDDLEWARE_PATH - : NODE_PATH, - status: 404, - }, - ] - : []), - ], - ...(imageService || imagesConfig - ? { - images: imagesConfig - ? { - ...imagesConfig, - domains: [...imagesConfig.domains, ..._config.image.domains], - remotePatterns: [ - ...(imagesConfig.remotePatterns ?? []), - ..._config.image.remotePatterns, - ], - } - : getDefaultImageConfig(_config.image), - } - : {}), - }); - - // Remove temporary folder - await removeDir(_buildTempFolder); - }, - }, - }; -} - -type Runtime = `nodejs${string}.x`; - -// TODO: remove once we don't use a TLA anymore -async function shouldExternalizeAstroEnvSetup() { - try { - await import('astro/env/setup'); - return false; - } catch { - return true; - } -} - -class VercelBuilder { - readonly NTF_CACHE = {}; - - constructor( - readonly config: AstroConfig, - readonly excludeFiles: URL[], - readonly includeFiles: URL[], - readonly logger: AstroIntegrationLogger, - readonly maxDuration?: number, - readonly runtime = getRuntime(process, logger) - ) {} - - async buildServerlessFolder(entry: URL, functionName: string, root: URL) { - const { config, includeFiles, excludeFiles, logger, NTF_CACHE, runtime, maxDuration } = this; - // .vercel/output/functions/<name>.func/ - const functionFolder = new URL(`./functions/${functionName}.func/`, config.outDir); - const packageJson = new URL(`./functions/${functionName}.func/package.json`, config.outDir); - const vcConfig = new URL(`./functions/${functionName}.func/.vc-config.json`, config.outDir); - - // Copy necessary files (e.g. node_modules/) - const { handler } = await copyDependenciesToFunction( - { - entry, - outDir: functionFolder, - includeFiles, - excludeFiles, - logger, - root, - }, - NTF_CACHE - ); - - // Enable ESM - // https://aws.amazon.com/blogs/compute/using-node-js-es-modules-and-top-level-await-in-aws-lambda/ - await writeJson(packageJson, { type: 'module' }); - - // Serverless function config - // https://vercel.com/docs/build-output-api/v3#vercel-primitives/serverless-functions/configuration - await writeJson(vcConfig, { - runtime, - handler: handler.replaceAll('\\', '/'), - launcherType: 'Nodejs', - maxDuration, - supportsResponseStreaming: true, - }); - } - - async buildISRFolder(entry: URL, functionName: string, isr: VercelISRConfig, root: URL) { - await this.buildServerlessFolder(entry, functionName, root); - const prerenderConfig = new URL( - `./functions/${functionName}.prerender-config.json`, - this.config.outDir - ); - // https://vercel.com/docs/build-output-api/v3/primitives#prerender-configuration-file - await writeJson(prerenderConfig, { - expiration: isr.expiration ?? false, - bypassToken: isr.bypassToken, - allowQuery: [ASTRO_PATH_PARAM], - passQuery: true, - }); - } - - async buildMiddlewareFolder(entry: URL, functionName: string, middlewareSecret: string) { - const functionFolder = new URL(`./functions/${functionName}.func/`, this.config.outDir); - - await generateEdgeMiddleware( - entry, - this.config.root, - new URL(VERCEL_EDGE_MIDDLEWARE_FILE, this.config.srcDir), - new URL('./middleware.mjs', functionFolder), - middlewareSecret, - this.logger - ); - - // biome-ignore lint/style/noUnusedTemplateLiteral: <explanation> - await writeJson(new URL(`./.vc-config.json`, functionFolder), { - runtime: 'edge', - entrypoint: 'middleware.mjs', - }); - } -} - -function getRuntime(process: NodeJS.Process, logger: AstroIntegrationLogger): Runtime { - const version = process.version.slice(1); // 'v18.19.0' --> '18.19.0' - const major = version.split('.')[0]; // '18.19.0' --> '18' - const support = SUPPORTED_NODE_VERSIONS[major]; - if (support === undefined) { - logger.warn( - // biome-ignore lint/style/noUnusedTemplateLiteral: <explanation> - // biome-ignore lint/style/useTemplate: <explanation> - `\n` + - `\tThe local Node.js version (${major}) is not supported by Vercel Serverless Functions.\n` + - // biome-ignore lint/style/noUnusedTemplateLiteral: <explanation> - `\tYour project will use Node.js 18 as the runtime instead.\n` + - // biome-ignore lint/style/noUnusedTemplateLiteral: <explanation> - `\tConsider switching your local version to 18.\n` - ); - return 'nodejs18.x'; - } - if (support.status === 'default') { - return `nodejs${major}.x`; - } - if (support.status === 'retiring') { - if (support.warnDate && new Date() >= support.warnDate) { - logger.warn( - `Your project is being built for Node.js ${major} as the runtime, which is retiring by ${support.removal}.` - ); - } - return `nodejs${major}.x`; - } - if (support.status === 'beta') { - logger.warn( - `Your project is being built for Node.js ${major} as the runtime, which is currently in beta for Vercel Serverless Functions.` - ); - return `nodejs${major}.x`; - } - if (support.status === 'deprecated') { - const removeDate = new Intl.DateTimeFormat(undefined, { dateStyle: 'long' }).format( - support.removal - ); - logger.warn( - // biome-ignore lint/style/noUnusedTemplateLiteral: <explanation> - // biome-ignore lint/style/useTemplate: <explanation> - `\n` + - `\tYour project is being built for Node.js ${major} as the runtime.\n` + - `\tThis version is deprecated by Vercel Serverless Functions, and scheduled to be disabled on ${removeDate}.\n` + - // biome-ignore lint/style/noUnusedTemplateLiteral: <explanation> - `\tConsider upgrading your local version to 18.\n` - ); - return `nodejs${major}.x`; - } - return 'nodejs18.x'; +import type { AstroIntegration } from 'astro'; +import type { VercelServerlessConfig } from '../index.js'; +import vercelIntegration from '../index.js'; + +export default function serverless(config: VercelServerlessConfig): AstroIntegration { + console.warn( + 'The "@astrojs/vercel/serverless" import is deprecated and will be removed in a future release. Please import from "@astrojs/vercel" instead.' + ); + return vercelIntegration(config); } diff --git a/packages/integrations/vercel/src/serverless/entrypoint.ts b/packages/integrations/vercel/src/serverless/entrypoint.ts index 31f78bb8a..f1f1f256c 100644 --- a/packages/integrations/vercel/src/serverless/entrypoint.ts +++ b/packages/integrations/vercel/src/serverless/entrypoint.ts @@ -1,21 +1,17 @@ +// Keep at the top +import './polyfill.js'; import type { IncomingMessage, ServerResponse } from 'node:http'; import type { SSRManifest } from 'astro'; -import { NodeApp, applyPolyfills } from 'astro/app/node'; +import { NodeApp } from 'astro/app/node'; +import { setGetEnv } from 'astro/env/setup'; import { ASTRO_LOCALS_HEADER, ASTRO_MIDDLEWARE_SECRET_HEADER, ASTRO_PATH_HEADER, ASTRO_PATH_PARAM, -} from './adapter.js'; +} from '../index.js'; -// Run polyfills immediately so any dependent code can use the globals -applyPolyfills(); - -// Won't throw if the virtual module is not available because it's not supported in -// the users's astro version or if astro:env is not enabled in the project -await import('astro/env/setup') - .then((mod) => mod.setGetEnv((key) => process.env[key])) - .catch(() => {}); +setGetEnv((key) => process.env[key]); export const createExports = ( manifest: SSRManifest, diff --git a/packages/integrations/vercel/src/serverless/middleware.ts b/packages/integrations/vercel/src/serverless/middleware.ts index ca84bff33..6663731b7 100644 --- a/packages/integrations/vercel/src/serverless/middleware.ts +++ b/packages/integrations/vercel/src/serverless/middleware.ts @@ -7,7 +7,7 @@ import { ASTRO_MIDDLEWARE_SECRET_HEADER, ASTRO_PATH_HEADER, NODE_PATH, -} from './adapter.js'; +} from '../index.js'; /** * It generates the Vercel Edge Middleware file. @@ -98,7 +98,7 @@ export default async function middleware(request, context) { request, params: {} }); - ctx.locals = { vercel: { edge: context }, ...${handlerTemplateCall} }; + Object.assign(ctx.locals, { vercel: { edge: context }, ...${handlerTemplateCall} }); const { origin } = new URL(request.url); const next = async () => { const { vercel, ...locals } = ctx.locals; diff --git a/packages/integrations/vercel/src/serverless/polyfill.ts b/packages/integrations/vercel/src/serverless/polyfill.ts new file mode 100644 index 000000000..dc00f45d7 --- /dev/null +++ b/packages/integrations/vercel/src/serverless/polyfill.ts @@ -0,0 +1,3 @@ +import { applyPolyfills } from 'astro/app/node'; + +applyPolyfills(); diff --git a/packages/integrations/vercel/src/speed-insights.ts b/packages/integrations/vercel/src/speed-insights.ts deleted file mode 100644 index 84aadfc7b..000000000 --- a/packages/integrations/vercel/src/speed-insights.ts +++ /dev/null @@ -1,68 +0,0 @@ -import type { Metric } from 'web-vitals'; -import { onCLS, onFCP, onFID, onLCP, onTTFB } from 'web-vitals'; - -const SPEED_INSIGHTS_INTAKE = 'https://vitals.vercel-analytics.com/v1/vitals'; - -type Options = { path: string; analyticsId: string }; - -const getConnectionSpeed = () => { - return 'connection' in navigator && - // biome-ignore lint/complexity/useLiteralKeys: <explanation> - navigator['connection'] && - // biome-ignore lint/complexity/useLiteralKeys: <explanation> - 'effectiveType' in (navigator['connection'] as unknown as { effectiveType: string }) - ? // biome-ignore lint/complexity/useLiteralKeys: <explanation> - (navigator['connection'] as unknown as { effectiveType: string })['effectiveType'] - : ''; -}; - -const sendToSpeedInsights = (metric: Metric, options: Options) => { - const body = { - dsn: options.analyticsId, - id: metric.id, - page: options.path, - href: location.href, - event_name: metric.name, - value: metric.value.toString(), - speed: getConnectionSpeed(), - }; - const blob = new Blob([new URLSearchParams(body).toString()], { - type: 'application/x-www-form-urlencoded', - }); - if (navigator.sendBeacon) { - navigator.sendBeacon(SPEED_INSIGHTS_INTAKE, blob); - } else - fetch(SPEED_INSIGHTS_INTAKE, { - body: blob, - method: 'POST', - credentials: 'omit', - keepalive: true, - }); -}; - -function collectWebVitals() { - const analyticsId = (import.meta as any).env.PUBLIC_VERCEL_ANALYTICS_ID; - - if (!analyticsId) { - console.error('[Speed Insights] VERCEL_ANALYTICS_ID not found'); - return; - } - - const options: Options = { path: window.location.pathname, analyticsId }; - - try { - onFID((metric) => sendToSpeedInsights(metric, options)); - onTTFB((metric) => sendToSpeedInsights(metric, options)); - onLCP((metric) => sendToSpeedInsights(metric, options)); - onCLS((metric) => sendToSpeedInsights(metric, options)); - onFCP((metric) => sendToSpeedInsights(metric, options)); - } catch (err) { - console.error('[Speed Insights]', err); - } -} - -const mode = (import.meta as any).env.MODE as 'development' | 'production'; - -if (mode === 'production') { - collectWebVitals(); -} diff --git a/packages/integrations/vercel/src/static/adapter.ts b/packages/integrations/vercel/src/static/adapter.ts index 4a5bdf966..348994902 100644 --- a/packages/integrations/vercel/src/static/adapter.ts +++ b/packages/integrations/vercel/src/static/adapter.ts @@ -1,159 +1,10 @@ -import type { AstroAdapter, AstroConfig, AstroIntegration } from 'astro'; - -import { emptyDir, writeJson } from '@astrojs/internal-helpers/fs'; -import { - type DevImageService, - type VercelImageConfig, - getAstroImageConfig, - getDefaultImageConfig, -} from '../image/shared.js'; -import { isServerLikeOutput } from '../lib/prerender.js'; -import { getRedirects } from '../lib/redirects.js'; -import { - type VercelSpeedInsightsConfig, - getSpeedInsightsViteConfig, -} from '../lib/speed-insights.js'; -import { - type VercelWebAnalyticsConfig, - getInjectableWebAnalyticsContent, -} from '../lib/web-analytics.js'; - -const PACKAGE_NAME = '@astrojs/vercel/static'; - -function getAdapter(): AstroAdapter { - return { - name: PACKAGE_NAME, - supportedAstroFeatures: { - assets: { - supportKind: 'stable', - isSquooshCompatible: true, - isSharpCompatible: true, - }, - staticOutput: 'stable', - serverOutput: 'unsupported', - hybridOutput: 'unsupported', - envGetSecret: 'unsupported', - }, - adapterFeatures: { - edgeMiddleware: false, - functionPerRoute: false, - }, - }; -} - -export interface VercelStaticConfig { - webAnalytics?: VercelWebAnalyticsConfig; - /** - * @deprecated This option lets you configure the legacy speed insights API which is now deprecated by Vercel. - * - * See [Vercel Speed Insights Quickstart](https://vercel.com/docs/speed-insights/quickstart) for instructions on how to use the library instead. - * - * https://vercel.com/docs/speed-insights/quickstart - */ - speedInsights?: VercelSpeedInsightsConfig; - imageService?: boolean; - imagesConfig?: VercelImageConfig; - devImageService?: DevImageService; -} - -export default function vercelStatic({ - webAnalytics, - speedInsights, - imageService, - imagesConfig, - devImageService = 'sharp', -}: VercelStaticConfig = {}): AstroIntegration { - let _config: AstroConfig; - - return { - name: '@astrojs/vercel', - hooks: { - 'astro:config:setup': async ({ command, config, injectScript, updateConfig }) => { - if (webAnalytics?.enabled) { - injectScript( - 'head-inline', - await getInjectableWebAnalyticsContent({ - mode: command === 'dev' ? 'development' : 'production', - }) - ); - } - if (command === 'build' && speedInsights?.enabled) { - injectScript('page', 'import "@astrojs/vercel/speed-insights"'); - } - const outDir = new URL('./.vercel/output/static/', config.root); - updateConfig({ - outDir, - build: { - format: 'directory', - redirects: false, - }, - vite: { - ...getSpeedInsightsViteConfig(speedInsights?.enabled), - }, - ...getAstroImageConfig( - imageService, - imagesConfig, - command, - devImageService, - config.image - ), - }); - }, - 'astro:config:done': ({ setAdapter, config }) => { - setAdapter(getAdapter()); - _config = config; - - if (isServerLikeOutput(config)) { - throw new Error(`${PACKAGE_NAME} should be used with output: 'static'`); - } - }, - 'astro:build:start': async () => { - // Ensure to have `.vercel/output` empty. - // This is because, when building to static, outDir = .vercel/output/static/, - // so .vercel/output itself won't get cleaned. - await emptyDir(new URL('./.vercel/output/', _config.root)); - }, - 'astro:build:done': async ({ routes }) => { - // Output configuration - // https://vercel.com/docs/build-output-api/v3#build-output-configuration - await writeJson(new URL('./.vercel/output/config.json', _config.root), { - version: 3, - routes: [ - ...getRedirects(routes, _config), - { - src: `^/${_config.build.assets}/(.*)$`, - headers: { 'cache-control': 'public, max-age=31536000, immutable' }, - continue: true, - }, - { handle: 'filesystem' }, - ...(routes.find((route) => route.pathname === '/404') - ? [ - { - // biome-ignore lint/style/noUnusedTemplateLiteral: <explanation> - src: `/.*`, - // biome-ignore lint/style/noUnusedTemplateLiteral: <explanation> - dest: `/404.html`, - status: 404, - }, - ] - : []), - ], - ...(imageService || imagesConfig - ? { - images: imagesConfig - ? { - ...imagesConfig, - domains: [...imagesConfig.domains, ..._config.image.domains], - remotePatterns: [ - ...(imagesConfig.remotePatterns ?? []), - ..._config.image.remotePatterns, - ], - } - : getDefaultImageConfig(_config.image), - } - : {}), - }); - }, - }, - }; +import type { AstroIntegration } from 'astro'; +import type { VercelServerlessConfig } from '../index.js'; +import vercelIntegration from '../index.js'; + +export default function staticAdapter(config: VercelServerlessConfig): AstroIntegration { + console.warn( + 'The "@astrojs/vercel/static" import is deprecated and will be removed in a future release. Please import from "@astrojs/vercel" instead.' + ); + return vercelIntegration(config); } |