@cloudflare/pages-shared 0.0.9 → 0.0.11

package/asset-server/handler.ts

@@ -12,12 +12,15 @@ import {
 	TemporaryRedirectResponse,
 } from "./responses";
 import { generateRulesMatcher, replacer } from "./rulesEngine";
+import { stringifyURLToRootRelativePathname } from "./url";
 import type {
 	Metadata,
 	MetadataHeadersEntries,
 	MetadataHeadersRulesV2,
 	MetadataHeadersV1,
 	MetadataHeadersV2,
+	MetadataStaticRedirectEntry,
+	MetadataRedirectEntry,
 } from "./metadata";
 
 type BodyEncoding = "manual" | "automatic";
@@ -97,7 +100,16 @@ type FullHandlerContext<AssetEntry, ContentNegotiation, Asset> = {
 	waitUntil: (promise: Promise<unknown>) => void;
 };
 
-export type HandlerContext<AssetEntry, ContentNegotiation, Asset> =
+export type HandlerContext<
+	AssetEntry,
+	ContentNegotiation extends { encoding: string | null } = {
+		encoding: string | null;
+	},
+	Asset extends { body: ReadableStream | null; contentType: string } = {
+		body: ReadableStream | null;
+		contentType: string;
+	}
+> =
 	| FullHandlerContext<AssetEntry, ContentNegotiation, Asset>
 	| (Omit<
 			FullHandlerContext<AssetEntry, ContentNegotiation, Asset>,
@@ -192,29 +204,7 @@ export async function generateHandler<
 			staticRedirectsMatcher() || generateRedirectsMatcher()({ request })[0];
 
 		if (match) {
-			const { status, to } = match;
-			const destination = new URL(to, request.url);
-			const location =
-				destination.origin === new URL(request.url).origin
-					? `${destination.pathname}${destination.search || search}${
-							destination.hash
-					  }`
-					: `${destination.href}${destination.search ? "" : search}${
-							destination.hash
-					  }`;
-			switch (status) {
-				case 301:
-					return new MovedPermanentlyResponse(location);
-				case 303:
-					return new SeeOtherResponse(location);
-				case 307:
-					return new TemporaryRedirectResponse(location);
-				case 308:
-					return new PermanentRedirectResponse(location);
-				case 302:
-				default:
-					return new FoundResponse(location);
-			}
+			return getResponseFromMatch(match, url);
 		}
 
 		if (!request.method.match(/^(get|head)$/i)) {
@@ -582,6 +572,49 @@ export async function generateHandler<
 	}
 }
 
+/**
+ * Given a redirect match and the request URL, returns the response
+ * for the redirect. This function will convert the Location header
+ * to be a root-relative path URL if the request origin and destination
+ * origins are the same. This is so that if the project is served
+ * on multiple domains, the redirects won't take the client off of their current domain.
+ */
+export function getResponseFromMatch(
+	{
+		status,
+		to,
+	}: Pick<MetadataStaticRedirectEntry | MetadataRedirectEntry, "status" | "to">,
+	requestUrl: URL
+) {
+	// Inherit origin from the request URL if not specified in _redirects
+	const destination = new URL(to, requestUrl);
+	// If _redirects doesn't specify a search, inherit from the request
+	destination.search = destination.search || requestUrl.search;
+
+	// If the redirect destination origin matches the incoming request origin
+	// we stringify destination to be a root-relative path, e.g.:
+	//   https://example.com/foo/bar?baz=1 -> /foo/bar/?baz=1
+	// This way, the project can more easily be hosted on multiple domains
+	const location =
+		destination.origin === requestUrl.origin
+			? stringifyURLToRootRelativePathname(destination)
+			: destination.toString();
+
+	switch (status) {
+		case 301:
+			return new MovedPermanentlyResponse(location);
+		case 303:
+			return new SeeOtherResponse(location);
+		case 307:
+			return new TemporaryRedirectResponse(location);
+		case 308:
+			return new PermanentRedirectResponse(location);
+		case 302:
+		default:
+			return new FoundResponse(location);
+	}
+}
+
 // Parses a list such as "deflate, gzip;q=1.0, *;q=0.5" into
 //   {deflate: 1, gzip: 1, *: 0.5}
 export function parseQualityWeightedList(list = "") {

package/asset-server/metadata.ts

@@ -63,4 +63,5 @@ export type Metadata = {
 		token: string;
 	};
 	deploymentId?: string;
+	failOpen?: boolean;
 };

package/asset-server/url.ts

@@ -0,0 +1,8 @@
+/**
+ * Stringifies a URL instance to a root-relative path string
+ * @param url The URL to stringify
+ * @returns A root-relative path string
+ */
+export function stringifyURLToRootRelativePathname(url: URL): string {
+	return `${url.pathname}${url.search}${url.hash}`;
+}

package/environment-polyfills/miniflare-tre.ts

@@ -0,0 +1,14 @@
+import {
+	fetch as miniflareFetch,
+	Headers as MiniflareHeaders,
+	Request as MiniflareRequest,
+	Response as MiniflareResponse,
+} from "@miniflare/tre";
+import { polyfill } from ".";
+
+polyfill({
+	fetch: miniflareFetch,
+	Headers: MiniflareHeaders,
+	Request: MiniflareRequest,
+	Response: MiniflareResponse,
+});

package/metadata-generator/createMetadataObject.ts

@@ -5,6 +5,7 @@ import {
 	SPLAT_REGEX,
 	PLACEHOLDER_REGEX,
 } from "./constants";
+import type { MetadataStaticRedirects } from "../asset-server/metadata";
 import type {
 	Metadata,
 	MetadataRedirects,
@@ -19,12 +20,14 @@ export function createMetadataObject({
 	headers,
 	webAnalyticsToken,
 	deploymentId,
+	failOpen,
 	logger = (_message: string) => {},
 }: {
 	redirects?: ParsedRedirects;
 	headers?: ParsedHeaders;
 	webAnalyticsToken?: string;
 	deploymentId?: string;
+	failOpen?: boolean;
 	logger?: Logger;
 }): Metadata {
 	return {
@@ -32,6 +35,7 @@ export function createMetadataObject({
 		...constructHeaders({ headers, logger }),
 		...constructWebAnalytics({ webAnalyticsToken, logger }),
 		deploymentId,
+		failOpen,
 	};
 }
 
@@ -64,13 +68,17 @@ function constructRedirects({
 		return {};
 	}
 
-	const staticRedirects: MetadataRedirects = {};
+	const staticRedirects: MetadataStaticRedirects = {};
 	const dynamicRedirects: MetadataRedirects = {};
 	let canCreateStaticRule = true;
 	for (const rule of redirects.rules) {
 		if (!rule.from.match(SPLAT_REGEX) && !rule.from.match(PLACEHOLDER_REGEX)) {
 			if (canCreateStaticRule) {
-				staticRedirects[rule.from] = { status: rule.status, to: rule.to };
+				staticRedirects[rule.from] = {
+					status: rule.status,
+					to: rule.to,
+					lineNumber: rule.lineNumber,
+				};
 				continue;
 			} else {
 				logger(

package/metadata-generator/types.ts

@@ -84,6 +84,7 @@ export type Metadata = {
 		token: string;
 	};
 	deploymentId?: string;
+	failOpen?: boolean;
 };
 
 export type Logger = (message: string) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@cloudflare/pages-shared",
-	"version": "0.0.9",
+	"version": "0.0.11",
 	"repository": {
 		"type": "git",
 		"url": "https://github.com/cloudflare/wrangler2.git",
@@ -13,7 +13,8 @@
 		"metadata-generator/**/*"
 	],
 	"scripts": {
-		"check:type": "tsc"
+		"check:type": "tsc",
+		"test": "jest"
 	},
 	"jest": {
 		"coverageReporters": [