expose event.clientAddress

packages/adapter-netlify/src/handler.js

@@ -10,7 +10,12 @@ export function init(manifest) {
 	const server = new Server(manifest);
 
 	return async (event, context) => {
-		const rendered = await server.respond(to_request(event), { platform: { context } });
+		const rendered = await server.respond(to_request(event), {
+			platform: { context },
+			getClientAddress() {
+				return event.headers['x-nf-client-connection-ip'];
+			}
+		});
 
 		const partial_response = {
 			statusCode: rendered.status,

packages/kit/src/core/build/prerender/prerender.js

@@ -130,6 +130,7 @@ export async function prerender({ config, entries, files, log }) {
 		const dependencies = new Map();
 
 		const response = await server.respond(new Request(`http://sveltekit-prerender${encoded}`), {
+			getClientAddress,
 			prerender: {
 				default: config.kit.prerender.default,
 				dependencies
@@ -268,6 +269,7 @@ export async function prerender({ config, entries, files, log }) {
 	}
 
 	const rendered = await server.respond(new Request('http://sveltekit-prerender/[fallback]'), {
+		getClientAddress,
 		prerender: {
 			fallback: true,
 			default: false,
@@ -281,3 +283,8 @@ export async function prerender({ config, entries, files, log }) {
 
 	return prerendered;
 }
+
+/** @return {string} */
+function getClientAddress() {
+	throw new Error('Cannot read clientAddress during prerendering');
+}

packages/kit/src/core/dev/plugin.js

@@ -259,62 +259,72 @@ export async function create_plugin(config, cwd) {
 
 						const template = load_template(cwd, config);
 
-						const rendered = await respond(request, {
-							amp: config.kit.amp,
-							csp: config.kit.csp,
-							dev: true,
-							floc: config.kit.floc,
-							get_stack: (error) => {
-								return fix_stack_trace(error);
-							},
-							handle_error: (error, event) => {
-								hooks.handleError({
-									error: new Proxy(error, {
-										get: (target, property) => {
-											if (property === 'stack') {
-												return fix_stack_trace(error);
+						const rendered = await respond(
+							request,
+							{
+								amp: config.kit.amp,
+								csp: config.kit.csp,
+								dev: true,
+								floc: config.kit.floc,
+								get_stack: (error) => {
+									return fix_stack_trace(error);
+								},
+								handle_error: (error, event) => {
+									hooks.handleError({
+										error: new Proxy(error, {
+											get: (target, property) => {
+												if (property === 'stack') {
+													return fix_stack_trace(error);
+												}
+
+												return Reflect.get(target, property, target);
 											}
-
-											return Reflect.get(target, property, target);
+										}),
+										event,
+
+										// TODO remove for 1.0
+										// @ts-expect-error
+										get request() {
+											throw new Error(
+												'request in handleError has been replaced with event. See https://github.com/sveltejs/kit/pull/3384 for details'
+											);
 										}
-									}),
-									event,
-
-									// TODO remove for 1.0
-									// @ts-expect-error
-									get request() {
-										throw new Error(
-											'request in handleError has been replaced with event. See https://github.com/sveltejs/kit/pull/3384 for details'
-										);
-									}
-								});
-							},
-							hooks,
-							hydrate: config.kit.browser.hydrate,
-							manifest,
-							method_override: config.kit.methodOverride,
-							paths: {
-								base: config.kit.paths.base,
-								assets
-							},
-							prefix: '',
-							prerender: config.kit.prerender.enabled,
-							read: (file) => fs.readFileSync(path.join(config.kit.files.assets, file)),
-							root,
-							router: config.kit.browser.router,
-							template: ({ head, body, assets, nonce }) => {
-								return (
-									template
-										.replace(/%svelte\.assets%/g, assets)
-										.replace(/%svelte\.nonce%/g, nonce)
-										// head and body must be replaced last, in case someone tries to sneak in %svelte.assets% etc
-										.replace('%svelte.head%', () => head)
-										.replace('%svelte.body%', () => body)
-								);
+									});
+								},
+								hooks,
+								hydrate: config.kit.browser.hydrate,
+								manifest,
+								method_override: config.kit.methodOverride,
+								paths: {
+									base: config.kit.paths.base,
+									assets
+								},
+								prefix: '',
+								prerender: config.kit.prerender.enabled,
+								read: (file) => fs.readFileSync(path.join(config.kit.files.assets, file)),
+								root,
+								router: config.kit.browser.router,
+								template: ({ head, body, assets, nonce }) => {
+									return (
+										template
+											.replace(/%svelte\.assets%/g, assets)
+											.replace(/%svelte\.nonce%/g, nonce)
+											// head and body must be replaced last, in case someone tries to sneak in %svelte.assets% etc
+											.replace('%svelte.head%', () => head)
+											.replace('%svelte.body%', () => body)
+									);
+								},
+								template_contains_nonce: template.includes('%svelte.nonce%'),
+								trailing_slash: config.kit.trailingSlash
 							},
-							template_contains_nonce: template.includes('%svelte.nonce%'),
-							trailing_slash: config.kit.trailingSlash
-						});
+							{
+								getClientAddress: () => {
+									const { remoteAddress } = req.socket;
+									if (remoteAddress) return remoteAddress;
+									throw new Error('Could not determine clientAddress');
+								}
+							}
+						);
 
 						if (rendered) {
 							setResponse(res, rendered);

packages/kit/src/core/preview/index.js

@@ -137,7 +137,16 @@ export async function preview({ port, host, config, https: use_https = false })
 				return res.end(err.reason || 'Invalid request body');
 			}
 
-			setResponse(res, await server.respond(request));
+			setResponse(
+				res,
+				await server.respond(request, {
+					getClientAddress: () => {
+						const { remoteAddress } = req.socket;
+						if (remoteAddress) return remoteAddress;
+						throw new Error('Could not determine clientAddress');
+					}
+				})
+			);
 		}
 	]);
 

packages/kit/src/runtime/server/index.js

@@ -12,7 +12,7 @@ const DATA_SUFFIX = '/__data.json';
 const default_transform = ({ html }) => html;
 
 /** @type {import('types').Respond} */
-export async function respond(request, options, state = {}) {
+export async function respond(request, options, state) {
 	const url = new URL(request.url);
 
 	const normalized = normalize_path(url.pathname, options.trailing_slash);
@@ -53,11 +53,14 @@ export async function respond(request, options, state = {}) {
 
 	/** @type {import('types').RequestEvent} */
 	const event = {
-		request,
-		url,
-		params: {},
+		get clientAddress() {
+			return (event.clientAddress = state.getClientAddress());
+		},
 		locals: {},
-		platform: state.platform
+		params: {},
+		platform: state.platform,
+		request,
+		url
 	};
 
 	// TODO remove this for 1.0

packages/kit/src/runtime/server/page/load_node.js

@@ -190,6 +190,7 @@ export async function load_node({
 
 					response = await respond(new Request(new URL(requested, event.url).href, opts), options, {
 						fetched: requested,
+						getClientAddress: state.getClientAddress,
 						initiator: route
 					});
 

packages/kit/types/internal.d.ts

@@ -92,7 +92,7 @@ export interface Hooks {
 export class InternalServer extends Server {
 	respond(
 		request: Request,
-		options?: RequestOptions & {
+		options: RequestOptions & {
 			prerender?: PrerenderOptions;
 		}
 	): Promise<Response>;
@@ -164,7 +164,7 @@ export type RecursiveRequired<T> = {
 export type RequiredResolveOptions = Required<ResolveOptions>;
 
 export interface Respond {
-	(request: Request, options: SSROptions, state?: SSRState): Promise<Response>;
+	(request: Request, options: SSROptions, state: SSRState): Promise<Response>;
 }
 
 export type RouteData = PageData | EndpointData;
@@ -302,11 +302,12 @@ export interface SSRPagePart {
 export type SSRRoute = SSREndpoint | SSRPage;
 
 export interface SSRState {
+	fallback?: string;
 	fetched?: string;
+	getClientAddress: () => string;
 	initiator?: SSRPage | null;
 	platform?: any;
 	prerender?: PrerenderOptions;
-	fallback?: string;
 }
 
 export type StrictBody = string | Uint8Array;

packages/kit/types/private.d.ts

@@ -234,14 +234,16 @@ export interface PrerenderErrorHandler {
 export type PrerenderOnErrorValue = 'fail' | 'continue' | PrerenderErrorHandler;
 
 export interface RequestEvent<Params = Record<string, string>> {
-	request: Request;
-	url: URL;
-	params: Params;
+	clientAddress: string;
 	locals: App.Locals;
+	params: Params;
 	platform: Readonly<App.Platform>;
+	request: Request;
+	url: URL;
 }
 
 export interface RequestOptions {
+	getClientAddress: () => string;
 	platform?: App.Platform;
 }