[PHP-wasm] allow requests to follow redirects

packages/php-wasm/universal/src/lib/php-request-handler.ts

@@ -316,6 +316,8 @@ export class PHPRequestHandler {
 	 * ```
 	 *
 	 * @param  request - PHP Request data.
+	 * @param  followRedirects - Follow redirects when the response code is 301 or 302.
+	 * @returns The response.
 	 */
 	async request(request: PHPRequest): Promise<PHPResponse> {
 		const isAbsolute = URL.canParse(request.url);
@@ -410,10 +412,43 @@ export class PHPRequestHandler {
 					// Pass along URL with the #fragment filtered out
 					url: requestedUrl.toString(),
 				};
-				return this.#spawnPHPAndDispatchRequest(
+				const response = await this.#spawnPHPAndDispatchRequest(
 					effectiveRequest,
 					fsPath
 				);
+
+				/**
+				 * If the response is a redirect, and the request is configured to
+				 * follow redirects, we need to recursively call request() with the
+				 * new URL.
+				 *
+				 * If the response is a redirect, and the request is configured to
+				 * error on redirects, we need to throw an error.
+				 *
+				 * Otherwise, we return the response.
+				 *
+				 * This matches the behavior of the JavaScript fetch API.
+				 * https://developer.mozilla.org/en-US/docs/Web/API/Request/redirect
+				 */
+				if (
+					response.headers['location'] &&
+					response.headers['location'].length === 1 &&
+					[301, 302].includes(response.httpStatusCode)
+				) {
+					if (request.redirect === 'error') {
+						return Promise.reject(
+							new Error(
+								'TypeError: NetworkError when attempting to fetch resource.'
+							)
+						);
+					} else if (request.redirect === 'follow') {
+						return await this.request({
+							url: response.headers['location'][0],
+							redirect: request.redirect,
+						});
+					}
+				}
+				return response;
 			} else {
 				return this.#serveStaticFile(primaryPhp, fsPath);
 			}

packages/php-wasm/universal/src/lib/universal-php.ts

@@ -93,6 +93,14 @@ export interface PHPRequest {
 	 * and sent with a `multipart/form-data` header.
 	 */
 	body?: string | Uint8Array | Record<string, string | Uint8Array | File>;
+
+	/**
+	 * Whether to follow redirects.
+	 * - `follow`: Follow redirects.
+	 * - `manual`: Return the redirect response. (Default)
+	 * - `error`: Throw an error if a redirect is encountered.
+	 */
+	redirect?: 'follow' | 'manual' | 'error';
 }
 
 export interface PHPRunOptions {

packages/playground/blueprints/src/lib/steps/enable-multisite.spec.ts

@@ -9,7 +9,7 @@ import { loadNodeRuntime } from '@php-wasm/node';
 import { readFileSync } from 'fs';
 import { join } from 'path';
 import { login } from './login';
-import { PHPRequest, PHPRequestHandler } from '@php-wasm/universal';
+import { PHPRequestHandler } from '@php-wasm/universal';
 
 describe('Blueprint step enableMultisite', () => {
 	let handler: PHPRequestHandler;
@@ -33,16 +33,6 @@ describe('Blueprint step enableMultisite', () => {
 		return { php, handler };
 	}
 
-	const requestFollowRedirects = async (request: PHPRequest) => {
-		let response = await handler.request(request);
-		while (response.httpStatusCode === 302) {
-			response = await handler.request({
-				url: response.headers['location'][0],
-			});
-		}
-		return response;
-	};
-
 	[
 		{
 			absoluteUrl: 'http://playground-domain/scope:987987/',
@@ -81,8 +71,9 @@ describe('Blueprint step enableMultisite', () => {
 			 * the admin bar includes the multisite menu.
 			 */
 			await login(php, {});
-			const response = await requestFollowRedirects({
+			const response = await handler.request({
 				url: '/',
+				redirect: 'follow',
 			});
 			expect(response.httpStatusCode).toEqual(200);
 			expect(response.text).toContain('My Sites');

packages/playground/blueprints/src/lib/steps/login.spec.ts

@@ -1,4 +1,4 @@
-import { PHP, PHPRequest } from '@php-wasm/universal';
+import { PHP } from '@php-wasm/universal';
 import { RecommendedPHPVersion } from '@wp-playground/common';
 import {
 	getSqliteDatabaseModule,
@@ -26,29 +26,21 @@ describe('Blueprint step login', () => {
 		php = await handler.getPrimaryPhp();
 	});
 
-	const requestFollowRedirects = async (request: PHPRequest) => {
-		let response = await handler.request(request);
-		while (response.httpStatusCode === 302) {
-			response = await handler.request({
-				url: response.headers['location'][0],
-			});
-		}
-		return response;
-	};
-
 	it('should log the user in', async () => {
 		await login(php, {});
-		const response = await requestFollowRedirects({
+		const response = await handler.request({
 			url: '/',
+			redirect: 'follow',
 		});
 		expect(response.httpStatusCode).toBe(200);
-		expect(response.text).toContain('Edit site');
+		expect(response.text).toContain('Edit Site');
 	});
 
 	it('should log the user into wp-admin', async () => {
 		await login(php, {});
-		const response = await requestFollowRedirects({
+		const response = await handler.request({
 			url: '/wp-admin/',
+			redirect: 'follow',
 		});
 		expect(response.httpStatusCode).toBe(200);
 		expect(response.text).toContain('Dashboard');
@@ -60,8 +52,9 @@ describe('Blueprint step login', () => {
 				PLAYGROUND_FORCE_AUTO_LOGIN_ENABLED: true,
 			},
 		});
-		const response = await requestFollowRedirects({
+		const response = await handler.request({
 			url: '/?playground_force_auto_login_as_user=admin',
+			redirect: 'follow',
 		});
 		expect(response.httpStatusCode).toBe(200);
 		expect(response.text).toContain('Dashboard');
@@ -81,8 +74,9 @@ describe('Blueprint step login', () => {
 				}
 			`
 		);
-		const response = await requestFollowRedirects({
+		const response = await handler.request({
 			url: '/nonce-test.php',
+			redirect: 'follow',
 		});
 		expect(response.text).toBe('1');
 	});

packages/playground/cli/package.json

@@ -21,7 +21,7 @@
 	},
 	"license": "GPL-2.0-or-later",
 	"type": "module",
-	"main": "main.js",
+	"main": "index.js",
 	"bin": "wp-playground.js",
 	"gitHead": "2f8d8f3cea548fbd75111e8659a92f601cddc593"
 }

packages/playground/cli/project.json

@@ -71,11 +71,14 @@
 			}
 		},
 		"test": {
-			"executor": "@nx/jest:jest",
-			"outputs": ["{workspaceRoot}/coverage/{projectRoot}"],
+			"executor": "@nx/vite:test",
+			"outputs": ["{workspaceRoot}/coverage/playground/cli"],
 			"options": {
-				"jestConfig": "packages/playground/cli/jest.config.ts",
-				"passWithNoTests": true
+				"passWithNoTests": true,
+				"reportsDirectory": "../../../coverage/packages/playground/cli",
+				"typecheck": {
+					"tsconfig": "{projectRoot}/tsconfig.spec.json"
+				}
 			},
 			"configurations": {
 				"ci": {