Skip to content
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.

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

feat: pass our domains and remote config to the Vercel config #8452

Merged
merged 4 commits into from
Sep 7, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions .changeset/forty-hotels-itch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@astrojs/vercel': patch
---

Fix Astro's `domains` and `remotePatterns` not being used by Vercel when using Vercel Image Optimization
2 changes: 2 additions & 0 deletions packages/integrations/vercel/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,8 @@ export default defineConfig({

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.

The `domains` and `remotePatterns` properties will automatically be filled using [the Astro corresponding `image` settings](https://docs.astro.build/en/reference/configuration-reference/#image-options).

```js
// astro.config.mjs
import { defineConfig } from 'astro/config';
Expand Down
23 changes: 14 additions & 9 deletions packages/integrations/vercel/src/image/shared.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
import type { ImageMetadata, ImageQualityPreset, ImageTransform } from 'astro';

export const defaultImageConfig: VercelImageConfig = {
sizes: [640, 750, 828, 1080, 1200, 1920, 2048, 3840],
domains: [],
};
import type { AstroConfig, ImageMetadata, ImageQualityPreset, ImageTransform } from 'astro';

export function getDefaultImageConfig(astroImageConfig: AstroConfig['image']): VercelImageConfig {
return {
sizes: [640, 750, 828, 1080, 1200, 1920, 2048, 3840],
domains: astroImageConfig.domains ?? [],
// Cast is necessary here because Vercel's types are slightly different from ours regarding allowed protocols. Behavior should be the same, however.
remotePatterns: (astroImageConfig.remotePatterns as VercelImageConfig['remotePatterns']) ?? [],
};
}

export function isESMImportedImage(src: ImageMetadata | string): src is ImageMetadata {
return typeof src === 'object';
Expand Down Expand Up @@ -56,10 +60,11 @@ export const qualityTable: Record<ImageQualityPreset, number> = {
max: 100,
};

export function getImageConfig(
export function getAstroImageConfig(
images: boolean | undefined,
imagesConfig: VercelImageConfig | undefined,
command: string
command: string,
astroImageConfig: AstroConfig['image']
) {
if (images) {
return {
Expand All @@ -69,7 +74,7 @@ export function getImageConfig(
command === 'dev'
? '@astrojs/vercel/dev-image-service'
: '@astrojs/vercel/build-image-service',
config: imagesConfig ? imagesConfig : defaultImageConfig,
config: imagesConfig ? imagesConfig : getDefaultImageConfig(astroImageConfig),
},
},
};
Expand Down
21 changes: 18 additions & 3 deletions packages/integrations/vercel/src/serverless/adapter.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,11 @@ import { AstroError } from 'astro/errors';
import glob from 'fast-glob';
import { basename } from 'node:path';
import { fileURLToPath, pathToFileURL } from 'node:url';
import { defaultImageConfig, getImageConfig, type VercelImageConfig } from '../image/shared.js';
import {
getAstroImageConfig,
getDefaultImageConfig,
type VercelImageConfig,
} from '../image/shared.js';
import { exposeEnv } from '../lib/env.js';
import { getVercelOutput, removeDir, writeJson } from '../lib/fs.js';
import { copyDependenciesToFunction } from '../lib/nft.js';
Expand Down Expand Up @@ -143,7 +147,7 @@ export default function vercelServerless({
external: ['@vercel/nft'],
},
},
...getImageConfig(imageService, imagesConfig, command),
...getAstroImageConfig(imageService, imagesConfig, command, config.image),
});
},
'astro:config:done': ({ setAdapter, config, logger }) => {
Expand Down Expand Up @@ -250,7 +254,18 @@ You can set functionPerRoute: false to prevent surpassing the limit.`
...routeDefinitions,
],
...(imageService || imagesConfig
? { images: imagesConfig ? imagesConfig : defaultImageConfig }
? {
images: imagesConfig
? {
...imagesConfig,
domains: [...imagesConfig.domains, ..._config.image.domains],
remotePatterns: [
...(imagesConfig.remotePatterns ?? []),
..._config.image.remotePatterns,
],
}
: getDefaultImageConfig(_config.image),
}
: {}),
});

Expand Down
21 changes: 18 additions & 3 deletions packages/integrations/vercel/src/static/adapter.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
import type { AstroAdapter, AstroConfig, AstroIntegration } from 'astro';

import { defaultImageConfig, getImageConfig, type VercelImageConfig } from '../image/shared.js';
import {
getAstroImageConfig,
getDefaultImageConfig,
type VercelImageConfig,
} from '../image/shared.js';
import { exposeEnv } from '../lib/env.js';
import { emptyDir, getVercelOutput, writeJson } from '../lib/fs.js';
import { isServerLikeOutput } from '../lib/prerender.js';
Expand Down Expand Up @@ -59,7 +63,7 @@ export default function vercelStatic({
vite: {
define: viteDefine,
},
...getImageConfig(imageService, imagesConfig, command),
...getAstroImageConfig(imageService, imagesConfig, command, config.image),
});
},
'astro:config:done': ({ setAdapter, config }) => {
Expand Down Expand Up @@ -91,7 +95,18 @@ export default function vercelStatic({
{ handle: 'filesystem' },
],
...(imageService || imagesConfig
? { images: imagesConfig ? imagesConfig : defaultImageConfig }
? {
images: imagesConfig
? {
...imagesConfig,
domains: [...imagesConfig.domains, ..._config.image.domains],
remotePatterns: [
...(imagesConfig.remotePatterns ?? []),
..._config.image.remotePatterns,
],
}
: getDefaultImageConfig(_config.image),
}
: {}),
});
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,10 @@ export default defineConfig({
adapter: vercel({imageService: true}),
image: {
service: testImageService(),
domains: ['astro.build'],
remotePatterns: [{
protocol: 'https',
hostname: '**.amazonaws.com',
}],
},
});
8 changes: 7 additions & 1 deletion packages/integrations/vercel/test/image.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,13 @@ describe('Image', () => {

expect(vercelConfig.images).to.deep.equal({
sizes: [640, 750, 828, 1080, 1200, 1920, 2048, 3840],
domains: [],
domains: ['astro.build'],
remotePatterns: [
{
protocol: 'https',
hostname: '**.amazonaws.com',
},
],
});
});

Expand Down
Loading