chore: cleanup promise handling (#12297)

Co-authored-by: Ben McCann <322311+benmccann@users.noreply.github.com>
sveltejs · Jun 5, 2024 · 8967235 · 8967235
1 parent 7133648
commit 8967235
Show file tree

Hide file tree

Showing 26 changed files with 100 additions and 74 deletions.
diff --git a/.changeset/modern-deers-grab.md b/.changeset/modern-deers-grab.md
@@ -0,0 +1,5 @@
+---
+'@sveltejs/enhanced-img': minor
+---
+
+breaking: return plugin synchronously from `enhancedImages()`
diff --git a/eslint.config.js b/eslint.config.js
@@ -4,8 +4,15 @@ import svelte_config from '@sveltejs/eslint-config';
 export default [
 	...svelte_config,
 	{
+		languageOptions: {
+			parserOptions: {
+				project: true
+			}
+		},
 		rules: {
+			'@typescript-eslint/await-thenable': 'error',
 			'@typescript-eslint/no-unused-expressions': 'off',
+			'@typescript-eslint/require-await': 'error',
 			'no-undef': 'off'
 		}
 	},
@@ -15,7 +22,19 @@ export default [
 			'packages/adapter-static/test/apps/*/build',
 			'packages/adapter-cloudflare/files',
 			'packages/adapter-netlify/files',
-			'packages/adapter-node/files'
+			'packages/adapter-node/files',
+			// TODO: figure out if we can ignore these only for @typescript-eslint
+			'packages/adapter-node/rollup.config.js',
+			'packages/adapter-node/tests/smoke.spec.js',
+			'packages/adapter-static/test/apps',
+			'packages/create-svelte/shared',
+			'packages/create-svelte/templates',
+			'packages/kit/src/core/sync/create_manifest_data/test/samples',
+			'packages/kit/test/apps',
+			'packages/kit/test/build-errors',
+			'packages/kit/test/prerendering',
+			'packages/package/test/errors',
+			'packages/package/test/fixtures'
 		]
 	}
 ];
diff --git a/packages/adapter-auto/index.js b/packages/adapter-auto/index.js
@@ -36,9 +36,9 @@ function detect_package_manager() {
 }
 
 /** @param {string} name */
-async function import_from_cwd(name) {
+function import_from_cwd(name) {
 	const cwd = pathToFileURL(process.cwd()).href;
-	const url = await resolve(name, cwd + '/x.js');
+	const url = resolve(name, cwd + '/x.js');
 
 	return import(url);
 }

diff --git a/packages/adapter-netlify/index.js b/packages/adapter-netlify/index.js
@@ -92,7 +92,7 @@ export default function ({ split = false, edge = edge_set_in_env_var } = {}) {
 
 				await generate_edge_functions({ builder });
 			} else {
-				await generate_lambda_functions({ builder, split, publish });
+				generate_lambda_functions({ builder, split, publish });
 			}
 		},
 
@@ -182,7 +182,7 @@ async function generate_edge_functions({ builder }) {
  * @param { string } params.publish
  * @param { boolean } params.split
  */
-async function generate_lambda_functions({ builder, publish, split }) {
+function generate_lambda_functions({ builder, publish, split }) {
 	builder.mkdirp('.netlify/functions-internal/.svelte-kit');
 
 	/** @type {string[]} */

diff --git a/packages/create-svelte/index.js b/packages/create-svelte/index.js
@@ -3,6 +3,7 @@ import path from 'node:path';
 import { mkdirp, copy, dist } from './utils.js';
 
 /** @type {import('./types/index.js').create} */
+// eslint-disable-next-line @typescript-eslint/require-await
 export async function create(cwd, options) {
 	mkdirp(cwd);
 

diff --git a/packages/enhanced-img/src/index.js b/packages/enhanced-img/src/index.js
@@ -3,10 +3,10 @@ import { imagetools } from 'vite-imagetools';
 import { image } from './preprocessor.js';
 
 /**
- * @returns {Promise<import('vite').Plugin[]>}
+ * @returns {import('vite').Plugin[]}
  */
-export async function enhancedImages() {
-	const imagetools_instance = await imagetools_plugin();
+export function enhancedImages() {
+	const imagetools_instance = imagetools_plugin();
 	return !process.versions.webcontainer
 		? [image_plugin(imagetools_instance), imagetools_instance]
 		: [];
@@ -60,7 +60,7 @@ const fallback = {
 	'.webp': 'png'
 };
 
-async function imagetools_plugin() {
+function imagetools_plugin() {
 	/** @type {Partial<import('vite-imagetools').VitePluginOptions>} */
 	const imagetools_opts = {
 		defaultDirectives: async ({ pathname, searchParams: qs }, metadata) => {

diff --git a/packages/kit/postinstall.js b/packages/kit/postinstall.js
@@ -40,7 +40,7 @@ try {
 
 			try {
 				const config = await load_config();
-				await sync.all(config, 'development');
+				sync.all(config, 'development');
 			} catch (error) {
 				console.error('Error while trying to sync SvelteKit config');
 				console.error(error);

diff --git a/packages/kit/src/cli.js b/packages/kit/src/cli.js
@@ -35,7 +35,7 @@ prog
 		try {
 			const config = await load_config();
 			const sync = await import('./core/sync/sync.js');
-			await sync.all_types(config, mode);
+			sync.all_types(config, mode);
 		} catch (error) {
 			handle_error(error);
 		}

diff --git a/packages/kit/src/core/sync/sync.js b/packages/kit/src/core/sync/sync.js
@@ -23,15 +23,15 @@ export function init(config, mode) {
  * Update SvelteKit's generated files
  * @param {import('types').ValidatedConfig} config
  */
-export async function create(config) {
+export function create(config) {
 	const manifest_data = create_manifest_data({ config });
 
 	const output = path.join(config.kit.outDir, 'generated');
 
 	write_client_manifest(config.kit, manifest_data, `${output}/client`);
 	write_server(config, output);
 	write_root(manifest_data, output);
-	await write_all_types(config, manifest_data);
+	write_all_types(config, manifest_data);
 
 	return { manifest_data };
 }
@@ -44,31 +44,29 @@ export async function create(config) {
  * @param {import('types').ManifestData} manifest_data
  * @param {string} file
  */
-export async function update(config, manifest_data, file) {
-	await write_types(config, manifest_data, file);
-
-	return { manifest_data };
+export function update(config, manifest_data, file) {
+	write_types(config, manifest_data, file);
 }
 
 /**
  * Run sync.init and sync.create in series, returning the result from sync.create.
  * @param {import('types').ValidatedConfig} config
  * @param {string} mode The Vite mode
  */
-export async function all(config, mode) {
+export function all(config, mode) {
 	init(config, mode);
-	return await create(config);
+	return create(config);
 }
 
 /**
  * Run sync.init and then generate all type files.
  * @param {import('types').ValidatedConfig} config
  * @param {string} mode The Vite mode
  */
-export async function all_types(config, mode) {
+export function all_types(config, mode) {
 	init(config, mode);
 	const manifest_data = create_manifest_data({ config });
-	await write_all_types(config, manifest_data);
+	write_all_types(config, manifest_data);
 }
 
 /**

diff --git a/packages/kit/src/core/sync/write_types/index.js b/packages/kit/src/core/sync/write_types/index.js
@@ -28,7 +28,7 @@ const cwd = process.cwd();
  * @param {import('types').ValidatedConfig} config
  * @param {import('types').ManifestData} manifest_data
  */
-export async function write_all_types(config, manifest_data) {
+export function write_all_types(config, manifest_data) {
 	if (!ts) return;
 
 	const types_dir = `${config.kit.outDir}/types`;
@@ -133,7 +133,7 @@ export async function write_all_types(config, manifest_data) {
  * @param {import('types').ManifestData} manifest_data
  * @param {string} file
  */
-export async function write_types(config, manifest_data, file) {
+export function write_types(config, manifest_data, file) {
 	if (!ts) return;
 
 	if (!path.basename(file).startsWith('+')) {

diff --git a/packages/kit/src/core/sync/write_types/index.spec.js b/packages/kit/src/core/sync/write_types/index.spec.js
@@ -12,7 +12,7 @@ const cwd = fileURLToPath(new URL('./test', import.meta.url));
 /**
  * @param {string} dir
  */
-async function run_test(dir) {
+function run_test(dir) {
 	rimraf(path.join(cwd, dir, '.svelte-kit'));
 
 	const initial = options({}, 'config');
@@ -25,22 +25,23 @@ async function run_test(dir) {
 	const manifest = create_manifest_data({
 		config: /** @type {import('types').ValidatedConfig} */ (initial)
 	});
-	await write_all_types(initial, manifest);
+
+	write_all_types(initial, manifest);
 }
 
-test('Creates correct $types', async () => {
+test('Creates correct $types', () => {
 	// To save us from creating a real SvelteKit project for each of the tests,
 	// we first run the type generation directly for each test case, and then
 	// call `tsc` to check that the generated types are valid.
-	await run_test('actions');
-	await run_test('simple-page-shared-only');
-	await run_test('simple-page-server-only');
-	await run_test('simple-page-server-and-shared');
-	await run_test('layout');
-	await run_test('layout-advanced');
-	await run_test('slugs');
-	await run_test('slugs-layout-not-all-pages-have-load');
-	await run_test('param-type-inference');
+	run_test('actions');
+	run_test('simple-page-shared-only');
+	run_test('simple-page-server-only');
+	run_test('simple-page-server-and-shared');
+	run_test('layout');
+	run_test('layout-advanced');
+	run_test('slugs');
+	run_test('slugs-layout-not-all-pages-have-load');
+	run_test('param-type-inference');
 	try {
 		execSync('pnpm testtypes', { cwd });
 	} catch (e) {

diff --git a/packages/kit/src/exports/hooks/sequence.spec.js b/packages/kit/src/exports/hooks/sequence.spec.js
@@ -120,7 +120,7 @@ test('uses first defined preload option', async () => {
 	const event = /** @type {import('@sveltejs/kit').RequestEvent} */ ({});
 	const response = await handler({
 		event,
-		resolve: async (_event, opts = {}) => {
+		resolve: (_event, opts = {}) => {
 			let html = '';
 
 			const { preload = () => false } = opts;
@@ -153,7 +153,7 @@ test('uses first defined filterSerializedResponseHeaders option', async () => {
 	const event = /** @type {import('@sveltejs/kit').RequestEvent} */ ({});
 	const response = await handler({
 		event,
-		resolve: async (_event, opts = {}) => {
+		resolve: (_event, opts = {}) => {
 			let html = '';
 
 			const { filterSerializedResponseHeaders = () => false } = opts;

diff --git a/packages/kit/src/exports/node/index.js b/packages/kit/src/exports/node/index.js
@@ -103,6 +103,8 @@ function get_raw_body(req, body_size_limit) {
  * }} options
  * @returns {Promise<Request>}
  */
+// TODO 3.0 make the signature synchronous?
+// eslint-disable-next-line @typescript-eslint/require-await
 export async function getRequest({ request, base, bodySizeLimit }) {
 	return new Request(base + request.url, {
 		// @ts-expect-error
@@ -121,6 +123,8 @@ export async function getRequest({ request, base, bodySizeLimit }) {
  * @param {Response} response
  * @returns {Promise<void>}
  */
+// TODO 3.0 make the signature synchronous?
+// eslint-disable-next-line @typescript-eslint/require-await
 export async function setResponse(res, response) {
 	for (const [key, value] of response.headers) {
 		try {

diff --git a/packages/kit/src/exports/vite/build/build_service_worker.js b/packages/kit/src/exports/vite/build/build_service_worker.js
@@ -66,13 +66,13 @@ export async function build_service_worker(
 	 */
 	const sw_virtual_modules = {
 		name: 'service-worker-build-virtual-modules',
-		async resolveId(id) {
+		resolveId(id) {
 			if (id.startsWith('$env/') || id.startsWith('$app/') || id === '$service-worker') {
 				return `\0virtual:${id}`;
 			}
 		},
 
-		async load(id) {
+		load(id) {
 			if (!id.startsWith('\0virtual:')) return;
 
 			if (id === service_worker) {

diff --git a/packages/kit/src/exports/vite/dev/index.js b/packages/kit/src/exports/vite/dev/index.js
@@ -97,9 +97,9 @@ export async function dev(vite, vite_config, svelte_config) {
 		return { module, module_node, url };
 	}
 
-	async function update_manifest() {
+	function update_manifest() {
 		try {
-			({ manifest_data } = await sync.create(svelte_config));
+			({ manifest_data } = sync.create(svelte_config));
 
 			if (manifest_error) {
 				manifest_error = null;
@@ -273,7 +273,7 @@ export async function dev(vite, vite_config, svelte_config) {
 		return error.stack;
 	}
 
-	await update_manifest();
+	update_manifest();
 
 	/**
 	 * @param {string} event
@@ -389,7 +389,7 @@ export async function dev(vite, vite_config, svelte_config) {
 		return ws_send.apply(vite.ws, args);
 	};
 
-	vite.middlewares.use(async (req, res, next) => {
+	vite.middlewares.use((req, res, next) => {
 		try {
 			const base = `${vite.config.server.https ? 'https' : 'http'}://${
 				req.headers[':authority'] || req.headers.host

diff --git a/packages/kit/src/exports/vite/index.js b/packages/kit/src/exports/vite/index.js
@@ -131,7 +131,7 @@ const warning_preprocessor = {
 async function resolve_peer_dependency(dependency) {
 	try {
 		// @ts-expect-error the types are wrong
-		const resolved = await imr.resolve(dependency, pathToFileURL(process.cwd() + '/dummy.js'));
+		const resolved = imr.resolve(dependency, pathToFileURL(process.cwd() + '/dummy.js'));
 		return import(resolved);
 	} catch {
 		throw new Error(
@@ -242,7 +242,7 @@ async function kit({ svelte_config }) {
 		 * Build the SvelteKit-provided Vite config to be merged with the user's vite.config.js file.
 		 * @see https://vitejs.dev/guide/api-plugin.html#config
 		 */
-		async config(config, config_env) {
+		config(config, config_env) {
 			initial_config = config;
 			vite_config_env = config_env;
 			is_build = config_env.command === 'build';
@@ -339,7 +339,7 @@ async function kit({ svelte_config }) {
 				};
 
 				if (!secondary_build_started) {
-					manifest_data = (await sync.all(svelte_config, config_env.mode)).manifest_data;
+					manifest_data = sync.all(svelte_config, config_env.mode).manifest_data;
 				}
 			} else {
 				new_config.define = {
@@ -373,7 +373,7 @@ async function kit({ svelte_config }) {
 	const plugin_virtual_modules = {
 		name: 'vite-plugin-sveltekit-virtual-modules',
 
-		async resolveId(id, importer) {
+		resolveId(id, importer) {
 			// If importing from a service-worker, only allow $service-worker & $env/static/public, but none of the other virtual modules.
 			// This check won't catch transitive imports, but it will warn when the import comes from a service-worker directly.
 			// Transitive imports will be caught during the build.
@@ -397,7 +397,7 @@ async function kit({ svelte_config }) {
 			}
 		},
 
-		async load(id, options) {
+		load(id, options) {
 			const browser = !options?.ssr;
 
 			const global = is_build
@@ -533,7 +533,7 @@ async function kit({ svelte_config }) {
 
 		writeBundle: {
 			sequential: true,
-			async handler(_options) {
+			handler(_options) {
 				if (vite_config.build.ssr) return;
 
 				const guard = module_guard(this, {
@@ -560,7 +560,7 @@ async function kit({ svelte_config }) {
 		 * Build the SvelteKit-provided Vite config to be merged with the user's vite.config.js file.
 		 * @see https://vitejs.dev/guide/api-plugin.html#config
 		 */
-		async config(config) {
+		config(config) {
 			/** @type {import('vite').UserConfig} */
 			let new_config;