@sveltejs/adapter-netlify 1.0.0-next.7 → 1.0.0-next.70

package/index.d.ts

@@ -0,0 +1,4 @@
+import { Adapter } from '@sveltejs/kit';
+import './ambient.js';
+
+export default function plugin(opts?: { split?: boolean; edge?: boolean }): Adapter;

package/index.js

@@ -1,72 +1,320 @@
-const { existsSync, readFileSync, writeFileSync } = require('fs');
-const { join } = require('path');
-const esbuild = require('esbuild');
-const toml = require('toml');
-
-module.exports = function () {
-	/** @type {import('@sveltejs/kit').Adapter} */
-	const adapter = {
+import { appendFileSync, existsSync, readFileSync, writeFileSync } from 'fs';
+import { dirname, join, resolve, posix } from 'path';
+import { fileURLToPath } from 'url';
+import glob from 'tiny-glob/sync.js';
+import esbuild from 'esbuild';
+import toml from '@iarna/toml';
+
+/**
+ * @typedef {{
+ *   build?: { publish?: string }
+ *   functions?: { node_bundler?: 'zisi' | 'esbuild' }
+ * } & toml.JsonMap} NetlifyConfig
+ */
+
+/**
+ * @typedef {{
+ *	 functions: Array<
+ *		 | {
+ *				 function: string;
+ *				 path: string;
+ *		   }
+ *		 | {
+ *				 function: string;
+ *				 pattern: string;
+ *		   }
+ *	 >;
+ *	 version: 1;
+ *	 }} HandlerManifest
+ */
+
+const files = fileURLToPath(new URL('./files', import.meta.url).href);
+
+const edge_set_in_env_var =
+	process.env.NETLIFY_SVELTEKIT_USE_EDGE === 'true' ||
+	process.env.NETLIFY_SVELTEKIT_USE_EDGE === '1';
+
+/** @type {import('.').default} */
+export default function ({ split = false, edge = edge_set_in_env_var } = {}) {
+	return {
 		name: '@sveltejs/adapter-netlify',
 
-		async adapt(utils) {
-			const { publish, functions } = validate_config().build;
+		async adapt(builder) {
+			const netlify_config = get_netlify_config();
 
-			utils.rimraf(publish);
-			utils.rimraf(functions);
+			// "build" is the default publish directory when Netlify detects SvelteKit
+			const publish = get_publish_directory(netlify_config, builder) || 'build';
 
-			const files = join(__dirname, 'files');
+			// empty out existing build directories
+			builder.rimraf('.netlify/edge-functions');
+			builder.rimraf('.netlify/functions-internal');
+			builder.rimraf('.netlify/server');
+			builder.rimraf('.netlify/package.json');
+			builder.rimraf('.netlify/serverless.js');
 
-			utils.log.minor('Generating serverless function...');
-			utils.copy(join(files, 'entry.js'), '.svelte/netlify/entry.js');
+			builder.log.minor(`Publishing to "${publish}"`);
 
-			await esbuild.build({
-				entryPoints: ['.svelte/netlify/entry.js'],
-				outfile: join(functions, 'render/index.js'),
-				bundle: true,
-				platform: 'node'
-			});
+			builder.log.minor('Copying assets...');
+			builder.writeClient(publish);
+			builder.writePrerendered(publish);
 
-			writeFileSync(join(functions, 'package.json'), JSON.stringify({ type: 'commonjs' }));
+			builder.log.minor('Writing custom headers...');
+			const headers_file = join(publish, '_headers');
+			builder.copy('_headers', headers_file);
+			appendFileSync(
+				headers_file,
+				`\n\n/${builder.config.kit.appDir}/immutable/*\n  cache-control: public\n  cache-control: immutable\n  cache-control: max-age=31536000\n`
+			);
 
-			utils.log.info('Prerendering static pages...');
-			await utils.prerender({
-				dest: publish
-			});
+			// for esbuild, use ESM
+			// for zip-it-and-ship-it, use CJS until https://github.com/netlify/zip-it-and-ship-it/issues/750
+			const esm = netlify_config?.functions?.node_bundler === 'esbuild';
 
-			utils.log.minor('Copying assets...');
-			utils.copy_static_files(publish);
-			utils.copy_client_files(publish);
+			if (edge) {
+				if (split) {
+					throw new Error('Cannot use `split: true` alongside `edge: true`');
+				}
 
-			utils.log.minor('Writing redirects...');
-			utils.copy(`${files}/_redirects`, `${publish}/_redirects`);
+				await generate_edge_functions({ builder });
+			} else {
+				await generate_lambda_functions({ builder, esm, split, publish });
+			}
 		}
 	};
+}
+/**
+ * @param { object } params
+ * @param {import('@sveltejs/kit').Builder} params.builder
+ */
+async function generate_edge_functions({ builder }) {
+	const tmp = builder.getBuildDirectory('netlify-tmp');
+	builder.rimraf(tmp);
+	builder.mkdirp(tmp);
+
+	builder.mkdirp('.netlify/edge-functions');
 
-	return adapter;
-};
+	// Don't match the static directory
+	const pattern = '^/.*$';
 
-function validate_config() {
-	if (existsSync('netlify.toml')) {
-		let netlify_config;
+	// Go doesn't support lookarounds, so we can't do this
+	// const pattern = appDir ? `^/(?!${escapeStringRegexp(appDir)}).*$` : '^/.*$';
 
-		try {
-			netlify_config = toml.parse(readFileSync('netlify.toml', 'utf-8'));
-		} catch (err) {
-			err.message = `Error parsing netlify.toml: ${err.message}`;
-			throw err;
+	/** @type {HandlerManifest} */
+	const edge_manifest = {
+		functions: [
+			{
+				function: 'render',
+				pattern
+			}
+		],
+		version: 1
+	};
+
+	builder.log.minor('Generating Edge Function...');
+	const relativePath = posix.relative(tmp, builder.getServerDirectory());
+
+	builder.copy(`${files}/edge.js`, `${tmp}/entry.js`, {
+		replace: {
+			'0SERVER': `${relativePath}/index.js`,
+			MANIFEST: './manifest.js'
 		}
+	});
+
+	const manifest = builder.generateManifest({
+		relativePath
+	});
+
+	writeFileSync(
+		`${tmp}/manifest.js`,
+		`export const manifest = ${manifest};\n\nexport const prerendered = new Set(${JSON.stringify(
+			builder.prerendered.paths
+		)});\n`
+	);
+
+	await esbuild.build({
+		entryPoints: [`${tmp}/entry.js`],
+		outfile: '.netlify/edge-functions/render.js',
+		bundle: true,
+		format: 'esm',
+		platform: 'browser',
+		sourcemap: 'linked',
+		target: 'es2020'
+	});
+
+	writeFileSync('.netlify/edge-functions/manifest.json', JSON.stringify(edge_manifest));
+}
+/**
+ * @param { object } params
+ * @param {import('@sveltejs/kit').Builder} params.builder
+ * @param { string } params.publish
+ * @param { boolean } params.split
+ * @param { boolean } params.esm
+ */
+async function generate_lambda_functions({ builder, publish, split, esm }) {
+	builder.mkdirp('.netlify/functions-internal');
+
+	/** @type {string[]} */
+	const redirects = [];
+	builder.writeServer('.netlify/server');
+
+	const replace = {
+		'0SERVER': './server/index.js' // digit prefix prevents CJS build from using this as a variable name, which would also get replaced
+	};
+	if (esm) {
+		builder.copy(`${files}/esm`, '.netlify', { replace });
+	} else {
+		glob('**/*.js', { cwd: '.netlify/server' }).forEach((file) => {
+			const filepath = `.netlify/server/${file}`;
+			const input = readFileSync(filepath, 'utf8');
+			const output = esbuild.transformSync(input, { format: 'cjs', target: 'node12' }).code;
+			writeFileSync(filepath, output);
+		});
+
+		builder.copy(`${files}/cjs`, '.netlify', { replace });
+		writeFileSync(join('.netlify', 'package.json'), JSON.stringify({ type: 'commonjs' }));
+	}
+
+	if (split) {
+		builder.log.minor('Generating serverless functions...');
+
+		await builder.createEntries((route) => {
+			const parts = [];
+			// Netlify's syntax uses '*' and ':param' as "splats" and "placeholders"
+			// https://docs.netlify.com/routing/redirects/redirect-options/#splats
+			for (const segment of route.segments) {
+				if (segment.rest) {
+					parts.push('*');
+					break; // Netlify redirects don't allow anything after a *
+				} else if (segment.dynamic) {
+					parts.push(`:${parts.length}`);
+				} else {
+					parts.push(segment.content);
+				}
+			}
+
+			const pattern = `/${parts.join('/')}`;
+			const name = parts.join('-').replace(/[:.]/g, '_').replace('*', '__rest') || 'index';
+
+			return {
+				id: pattern,
+				filter: (other) => matches(route.segments, other.segments),
+				complete: (entry) => {
+					const manifest = entry.generateManifest({
+						relativePath: '../server',
+						format: esm ? 'esm' : 'cjs'
+					});
+
+					const fn = esm
+						? `import { init } from '../serverless.js';\n\nexport const handler = init(${manifest});\n`
+						: `const { init } = require('../serverless.js');\n\nexports.handler = init(${manifest});\n`;
+
+					writeFileSync(`.netlify/functions-internal/${name}.js`, fn);
+
+					redirects.push(`${pattern} /.netlify/functions/${name} 200`);
+					redirects.push(`${pattern}/__data.json /.netlify/functions/${name} 200`);
+				}
+			};
+		});
+	} else {
+		builder.log.minor('Generating serverless functions...');
 
-		if (!netlify_config.build || !netlify_config.build.publish || !netlify_config.build.functions) {
+		const manifest = builder.generateManifest({
+			relativePath: '../server',
+			format: esm ? 'esm' : 'cjs'
+		});
+
+		const fn = esm
+			? `import { init } from '../serverless.js';\n\nexport const handler = init(${manifest});\n`
+			: `const { init } = require('../serverless.js');\n\nexports.handler = init(${manifest});\n`;
+
+		writeFileSync('.netlify/functions-internal/render.js', fn);
+		redirects.push('* /.netlify/functions/render 200');
+	}
+
+	// this should happen at the end, after builder.writeClient(...),
+	// so that generated redirects are appended to custom redirects
+	// rather than replaced by them
+	builder.log.minor('Writing redirects...');
+	const redirect_file = join(publish, '_redirects');
+	if (existsSync('_redirects')) {
+		builder.copy('_redirects', redirect_file);
+	}
+	builder.mkdirp(dirname(redirect_file));
+	appendFileSync(redirect_file, `\n\n${redirects.join('\n')}`);
+}
+
+function get_netlify_config() {
+	if (!existsSync('netlify.toml')) return null;
+
+	try {
+		return /** @type {NetlifyConfig} */ (toml.parse(readFileSync('netlify.toml', 'utf-8')));
+	} catch (err) {
+		err.message = `Error parsing netlify.toml: ${err.message}`;
+		throw err;
+	}
+}
+
+/**
+ * @param {NetlifyConfig} netlify_config
+ * @param {import('@sveltejs/kit').Builder} builder
+ **/
+function get_publish_directory(netlify_config, builder) {
+	if (netlify_config) {
+		if (!netlify_config.build?.publish) {
+			builder.log.minor('No publish directory specified in netlify.toml, using default');
+			return;
+		}
+
+		if (netlify_config.redirects) {
 			throw new Error(
-				'You must specify build.publish and build.functions in netlify.toml. Consult https://github.com/sveltejs/kit/tree/master/packages/adapter-netlify#configuration'
+				"Redirects are not supported in netlify.toml. Use _redirects instead. For more details consult the readme's troubleshooting section."
 			);
 		}
-
-		return netlify_config;
+		if (resolve(netlify_config.build.publish) === process.cwd()) {
+			throw new Error(
+				'The publish directory cannot be set to the site root. Please change it to another value such as "build" in netlify.toml.'
+			);
+		}
+		return netlify_config.build.publish;
 	}
 
-	// TODO offer to create one?
-	throw new Error(
-		'Missing a netlify.toml file. Consult https://github.com/sveltejs/kit/tree/master/packages/adapter-netlify#configuration'
+	builder.log.warn(
+		'No netlify.toml found. Using default publish directory. Consult https://github.com/sveltejs/kit/tree/master/packages/adapter-netlify#configuration for more details '
 	);
 }
+
+/**
+ * @typedef {{ rest: boolean, dynamic: boolean, content: string }} RouteSegment
+ */
+
+/**
+ * @param {RouteSegment[]} a
+ * @param {RouteSegment[]} b
+ * @returns {boolean}
+ */
+function matches(a, b) {
+	if (a[0] && b[0]) {
+		if (b[0].rest) {
+			if (b.length === 1) return true;
+
+			const next_b = b.slice(1);
+
+			for (let i = 0; i < a.length; i += 1) {
+				if (matches(a.slice(i), next_b)) return true;
+			}
+
+			return false;
+		}
+
+		if (!b[0].dynamic) {
+			if (!a[0].dynamic && a[0].content !== b[0].content) return false;
+		}
+
+		if (a.length === 1 && b.length === 1) return true;
+		return matches(a.slice(1), b.slice(1));
+	} else if (a[0]) {
+		return a.length === 1 && a[0].rest;
+	} else {
+		return b.length === 1 && b[0].rest;
+	}
+}

package/package.json

@@ -1,20 +1,52 @@
 {
-	"name": "@sveltejs/adapter-netlify",
-	"version": "1.0.0-next.7",
-	"main": "index.js",
-	"files": [
-		"files"
-	],
-	"dependencies": {
-		"toml": "^3.0.0"
-	},
-	"devDependencies": {
-		"@sveltejs/kit": "1.0.0-next.80",
-		"typescript": "^4.2.3"
-	},
-	"scripts": {
-		"lint": "eslint --ignore-path .gitignore \"**/*.{ts,js,svelte}\" && npm run check-format",
-		"format": "prettier --write . --config ../../.prettierrc --ignore-path .gitignore",
-		"check-format": "prettier --check . --config ../../.prettierrc --ignore-path .gitignore"
-	}
-}
+  "name": "@sveltejs/adapter-netlify",
+  "version": "1.0.0-next.70",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/sveltejs/kit",
+    "directory": "packages/adapter-netlify"
+  },
+  "license": "MIT",
+  "homepage": "https://kit.svelte.dev",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "index.js",
+  "types": "index.d.ts",
+  "files": [
+    "files",
+    "index.d.ts"
+  ],
+  "dependencies": {
+    "@iarna/toml": "^2.2.5",
+    "esbuild": "^0.14.48",
+    "set-cookie-parser": "^2.4.8",
+    "tiny-glob": "^0.2.9"
+  },
+  "devDependencies": {
+    "@netlify/functions": "^1.0.0",
+    "@rollup/plugin-commonjs": "^22.0.1",
+    "@rollup/plugin-json": "^4.1.0",
+    "@rollup/plugin-node-resolve": "^13.3.0",
+    "@sveltejs/kit": "1.0.0-next.380",
+    "@types/node": "^16.11.36",
+    "@types/set-cookie-parser": "^2.4.2",
+    "rimraf": "^3.0.2",
+    "rollup": "^2.75.7",
+    "typescript": "^4.7.4",
+    "uvu": "^0.5.3"
+  },
+  "scripts": {
+    "dev": "rimraf files && rollup -cw",
+    "build": "rimraf files && rollup -c && cp src/edge.js files/edge.js",
+    "test": "uvu src \"(spec\\.js|test[\\\\/]index\\.js)\"",
+    "check": "tsc",
+    "lint": "prettier --check . --config ../../.prettierrc --ignore-path .gitignore",
+    "format": "npm run check-format -- --write"
+  }
+}

package/CHANGELOG.md

@@ -1,80 +0,0 @@
-# @sveltejs/adapter-netlify
-
-## 1.0.0-next.7
-
-### Patch Changes
-
-- 0db2cf7: Fix serverless function
-
-## 1.0.0-next.6
-
-### Patch Changes
-
-- 7a4b351: Bundle serverless functions with esbuild
-
-## 1.0.0-next.5
-
-### Patch Changes
-
-- 6e27880: Move server-side fetch to adapters instead of build step
-
-## 1.0.0-next.4
-
-### Patch Changes
-
-- 8805c6d: Pass adapters directly to svelte.config.cjs
-
-## 1.0.0-next.3
-
-### Patch Changes
-
-- f35a5cd: Change adapter signature
-
-## 1.0.0-next.2
-
-### Patch Changes
-
-- 512b8c9: adapter-netlify: Use CJS entrypoint
-
-## 1.0.0-next.1
-
-### Patch Changes
-
-- Fix adapters and convert to ES modules
-
-## 0.0.13
-
-### Patch Changes
-
-- Add svelte-kit start command
-
-## 0.0.12
-
-### Patch Changes
-
-- b475ed4: Overhaul adapter API - fixes #166
-
-## 0.0.11
-
-### Patch Changes
-
-- 67eaeea: Move app-utils stuff into subpackages
-
-## 0.0.10
-
-### Patch Changes
-
-- Use setup
-
-## 0.0.9
-
-### Patch Changes
-
-- 0320208: Rename 'server route' to 'endpoint'
-- 5ca907c: Use shared mkdirp helper
-
-## 0.0.8
-
-### Patch Changes
-
-- various

package/files/_redirects

@@ -1 +0,0 @@
-/* /.netlify/functions/render 200

package/files/entry.js

@@ -1,44 +0,0 @@
-import '@sveltejs/kit/install-fetch'; // eslint-disable-line import/no-unresolved
-
-// TODO hardcoding the relative location makes this brittle
-import { render } from '../output/server/app.js'; // eslint-disable-line import/no-unresolved
-
-export async function handler(event) {
-	const {
-		path,
-		httpMethod,
-		headers,
-		queryStringParameters
-		// body, // TODO pass this to renderer
-		// isBase64Encoded // TODO is this useful?
-	} = event;
-
-	const query = new URLSearchParams();
-	for (const k in queryStringParameters) {
-		const value = queryStringParameters[k];
-		value.split(', ').forEach((v) => {
-			query.append(k, v);
-		});
-	}
-
-	const rendered = await render({
-		method: httpMethod,
-		headers,
-		path,
-		query
-	});
-
-	if (rendered) {
-		return {
-			isBase64Encoded: false,
-			statusCode: rendered.status,
-			headers: rendered.headers,
-			body: rendered.body
-		};
-	}
-
-	return {
-		statusCode: 404,
-		body: 'Not found'
-	};
-}