Remix/Single Fetch/New Response To Response

Last update

May 9, 2024

Remix / Single Fetch / new Response() to response

This codemod removes new Response() calls in actions and loaders and replaces them with mutations to the new response arg from Single Fetch.

Usage

You can use this codemod with the following command:

codemod remix/single-fetch/new-response-to-response

Examples

Input:

export async function loader({}: LoaderFunctionArgs) {
	return new Response(
		JSON.stringify({
			session: getSession(),
		}),
		{
			status: 200,
			headers: {
				'Content-Type': 'application/json',
			},
		},
	)
}

Output:

export async function loader({ response }: LoaderFunctionArgs) {
	response!.status = 200
	response!.headers.set('Content-Type', 'application/json')
	return JSON.stringify({
		session: getSession(),
	})
}

Thrown responses are ignored

If you throw new Response() in an action or loader, it will be ignored and not transformed, since this use case is still supported.

Headers can't be set to a function

If headers are set by a function, we can't automatically map that to the response object.

In this case it'll leave a TODO comment so this can be resolved manually

export async function action({ request }: ActionFunctionArgs) {
	const toastHeaders = createToastHeaders({
		title: 'Deleted',
		description: 'Your connection has been deleted.',
	})

	return new Response('success', { headers: toastHeaders })
}

export async function action({ request, response }: ActionFunctionArgs) {
	const toastHeaders = createToastHeaders({
		title: 'Deleted',
		description: 'Your connection has been deleted.',
	})
	// TODO: response!.headers = toastHeaders
	return 'success'
}

If response is already in scope

If the function already has a variable named response, such as from another fetch operation, it will conflict with the new response argument.

In this case, it will rename your existing response to response2, which you may want to rename manually to fetchResponse or something more descriptive.

export async function loader({ request }: LoaderFunctionArgs) {
	const response = await fetch(process.env.DATABASE_URL).then(r => r.json())

	return new Response(
		JSON.stringify({
			session: response.data,
		}),
		{
			status: 200,
			headers: {
				'Content-Type': 'application/json',
			},
		},
	)
}

will be transformed to

export async function loader({ request, response }: LoaderFunctionArgs) {
	const response2 = await fetch(process.env.DATABASE_URL).then(r => r.json())
	response!.status = 200
	response!.headers.set('Content-Type', 'application/json')

	return JSON.stringify({ session: response2.data })
}