Vercel

Vercel にデプロイする場合は、adapter-vercel を使用します。

adapter-auto を使用している場合、この adapter は自動でインストールされますが、この adapter 自体をプロジェクトに追加すれば Vercel 固有のオプションを指定できるようになります。

使い方permalink

npm i -D @sveltejs/adapter-vercel を実行してインストールし、svelte.config.js にこの adapter を追加します:

ts
import adapter from '@sveltejs/adapter-vercel';

export default {
	kit: {
		adapter: adapter({
			// ここで設定できるオプションについては以下を参照
		})
	}
};

デプロイメントの設定permalink

Vercel にルート(routes)を function としてデプロイする方法をコントロールするには、デプロイメントの設定を、上記に示すオプションか、+server.js、+page(.server).js、+layout(.server).js ファイルの中の export const config を使用して、行うことができます。

例えば、アプリの一部を Edge Functions としてデプロイして…

ts
/** @type {import('@sveltejs/adapter-vercel').Config} */
export const config = {
	runtime: 'edge'
};

ts
import type { Config } from '@sveltejs/adapter-vercel';

export const config: Config = {
	runtime: 'edge',
};

…他の部分を Serverless Functions としてデプロイすることができます (layout の内側の config は、すべての子ページに適用されます):

ts
/** @type {import('@sveltejs/adapter-vercel').Config} */
export const config = {
	runtime: 'nodejs18.x'
};

ts
import type { Config } from '@sveltejs/adapter-vercel';

export const config: Config = {
	runtime: 'nodejs18.x',
};

以下のオプションはすべての function に適用されます:

• runtime: 'edge'、'nodejs18.x'、'nodejs20.x'。デフォルトでは、adapter はプロジェクトの Node のバージョンに対応した 'nodejs<version>.x' を選択します。プロジェクトの Node バージョンは Vercel のダッシュボードから設定することができます。
• regions: edge network regions の配列 (serverless functions のデフォルトは ["iad1"]) か、runtime が edge (デフォルト) の場合は 'all' です。serverless functions の場合の複数の regions のサポートは Enterprise Plan のみです。
• split: true の場合、ルート(route)は個別の function としてデプロイされます。split を adapter レベルで true にする場合、すべてのルート(route)が個別の function としてデプロイされます。

加えて、以下のオプションは edge function に適用されます:

• external: esbuild が function をバンドルする際に外部(external)として扱う依存関係(dependencies)の配列です。Node の外側で実行されないオプションの依存関係(optional dependencies)を除外したいときにのみ使用してください

そして以下のオプションは serverless function に適用されます:

• memory: function で利用できるメモリ量です。デフォルトは 1024 Mb で、128 Mb まで減らすことができます。また、Pro または Enterprise アカウントの場合は、3008 Mb まで増やすことができます。間隔は 64Mb 単位です。
• maxDuration: function の最大実行時間。デフォルトで、Hobby アカウントの場合は 10 秒、Pro の場合は 15、Enterprise の場合は 900 です。
• isr: Incremental Static Regeneration の設定、詳細は後述

function から特定の region のデータにアクセスする必要がある場合は、パフォーマンスを最適化するためそれと同じ region (またはその知覚) にデプロイすることをおすすめします。

Image Optimizationpermalink

You may set the images config to control how Vercel builds your images. See the image configuration reference for full details. As an example, you may set:

{
	sizes: [640, 828, 1200, 1920, 3840],
	formats: ['image/avif', 'image/webp'],
	minimumCacheTTL: 300
}

Incremental Static Regenerationpermalink

Vercel は Incremental Static Regeneration (ISR) をサポートしており、これにより、プリレンダリングコンテンツが持つパフォーマンスとコストの利点と、ダイナミックレンダリングコンテンツが持つ柔軟性の両方を提供することができます。

ISR をルート(route)に追加するには、config オブジェクトに isr プロパティを含めます:

ts
import { BYPASS_TOKEN } from '$env/static/private';

export const config = {
	isr: {
		// キャッシュされたアセットが Serverless Function を呼び出して再生成されるまでの有効期限 (秒単位)。
		// 値に `false` を設定すると、無期限になります。
		expiration: 60,

		// URL で提供されるランダムな token で、アセットへのリクエストに 
		// __prerender_bypass=<token> cookie を用いることで、アセットのキャッシュされたバージョンを回避することができます。
		//
		// `GET` や `HEAD` リクエストに `x-prerender-revalidate: <token>` を付けると、アセットの再バリデート(re-validated)を強制することができます。
		bypassToken: BYPASS_TOKEN,

		// 有効なクエリパラメータのリストです。他のパラメータ (例えば utm tracking codes) は無視され、
		// コンテンツが不必要に再生成されないようにします
		allowQuery: ['search']
	}
};

ts
import { BYPASS_TOKEN } from '$env/static/private';

export const config = {
	isr: {
		// キャッシュされたアセットが Serverless Function を呼び出して再生成されるまでの有効期限 (秒単位)。
		// 値に `false` を設定すると、無期限になります。
		expiration: 60,

		// URL で提供されるランダムな token で、アセットへのリクエストに
		// __prerender_bypass=<token> cookie を用いることで、アセットのキャッシュされたバージョンを回避することができます。
		//
		// `GET` や `HEAD` リクエストに `x-prerender-revalidate: <token>` を付けると、アセットの再バリデート(re-validated)を強制することができます。
		bypassToken: BYPASS_TOKEN,

		// 有効なクエリパラメータのリストです。他のパラメータ (例えば utm tracking codes) は無視され、
		// コンテンツが不必要に再生成されないようにします
		allowQuery: ['search'],
	},
};

expiration プロパティは必須で、その他は任意です。

環境変数permalink

Vercel ではデプロイメント固有の環境変数一式を使用できます。他の環境変数と同様、$env/static/private と $env/dynamic/private からアクセスでき (詳細は後述)、public のほうからはアクセスできません。クライアントからこれらの変数にアクセスするには:

ts
import { VERCEL_COMMIT_REF } from '$env/static/private';

/** @type {import('./$types').LayoutServerLoad} */
export function load() {
	return {
		deploymentGitBranch: VERCEL_COMMIT_REF
	};
}

ts
import { VERCEL_COMMIT_REF } from '$env/static/private';
import type { LayoutServerLoad } from './$types';

export const load: LayoutServerLoad = () => {
	return {
		deploymentGitBranch: VERCEL_COMMIT_REF,
	};
};

<script>
	/** @type {import('./$types').LayoutServerData} */
	export let data;
</script>

<p>This staging environment was deployed from {data.deploymentGitBranch}.</p>

<script lang="ts">
	import type { LayoutServerData } from './$types';
	
	export let data: LayoutServerData;
</script>

<p>This staging environment was deployed from {data.deploymentGitBranch}.</p>

Vercel でビルドする場合、これらの変数は全てビルド時と実行時で変わらないため、$env/dynamic/private ではなく、変数を静的に置換しデッドコードの削除などの最適化ができる $env/static/private の使用をおすすめします。

Notespermalink

Vercel functionspermalink

プロジェクトの root の api ディレクトリに Vercel functions がある場合、/api/* に対するリクエストは SvelteKit で処理されません。Vercel functions に JavaScript 以外の言語を使用する必要が無いのであれば、SvelteKit アプリの API ルート(routes) として実装すると良いでしょう。逆に Vercel functions に JavaScript 以外の言語を使用する必要がある場合は、SvelteKit アプリに /api/* ルート(routes)を含めないようにしてください。

Node versionpermalink

ある時期より前に作成されたプロジェクトは、SvelteKit に必要な Node バージョンより古い Node バージョンを使用しているかもしれません。プロジェクトの設定で Node のバージョンを変更することができます。

トラブルシューティングpermalink

ファイルシステムにアクセスするpermalink

edge functions では fs を使用することはできません。

serverless functions では fs を使用できますが、ファイルがプロジェクトからデプロイメントにコピーされないため、期待通りには動作しないでしょう。代わりに $app/server の read 関数を使用してファイルにアクセスしてください。edge functions にデプロイされたルート(route)では read は動作しません（将来的に変更される可能性があります）。

その代わりに、fs を使用する必要があるルート(route)についてはプリレンダリングする必要があります。