Skip to content

Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.

fix(route): preserve fulfilled body (#37141)

Yury Semikhatsky3eeccaa499e1
diff --git a/packages/playwright-core/src/server/network.ts b/packages/playwright-core/src/server/network.ts
index a34050b022..21253fdac9 100644
--- a/packages/playwright-core/src/server/network.ts
+++ b/packages/playwright-core/src/server/network.ts
@@ -115,6 +115,7 @@ export class Request extends SdkObject {
_responseEndTiming = -1;
private _overrides: NormalizedContinueOverrides | undefined;
private _bodySize: number | undefined;
+ _responseBodyOverride: { body: string; isBase64: boolean; } | undefined;
constructor(context: contexts.BrowserContext, frame: frames.Frame | null, serviceWorker: pages.Worker | null, redirectedFrom: Request | null, documentId: string | undefined,
url: string, resourceType: string, method: string, postData: Buffer | null, headers: HeadersArray) {
@@ -311,6 +312,8 @@ export class Route extends SdkObject {
body = '';
isBase64 = false;
}
+ } else if (!overrides.status || overrides.status < 200 || overrides.status >= 400) {
+ this._request._responseBodyOverride = { body, isBase64 };
}
const headers = [...(overrides.headers || [])];
this._maybeAddCorsHeaders(headers);
@@ -535,6 +538,10 @@ export class Response extends SdkObject {
this._contentPromise = this._finishedPromise.then(async () => {
if (this._status >= 300 && this._status <= 399)
throw new Error('Response body is unavailable for redirect responses');
+ if (this._request._responseBodyOverride) {
+ const { body, isBase64 } = this._request._responseBodyOverride;
+ return Buffer.from(body, isBase64 ? 'base64' : 'utf-8');
+ }
return this._getResponseBodyCallback();
});
}
diff --git a/tests/page/page-request-fulfill.spec.ts b/tests/page/page-request-fulfill.spec.ts
index 0d939a0a5c..6eef1eb9bd 100644
--- a/tests/page/page-request-fulfill.spec.ts
+++ b/tests/page/page-request-fulfill.spec.ts
@@ -462,7 +462,7 @@ it('should fulfill with gzip and readback', {
it('should not go to the network for fulfilled requests body', {
annotation: { type: 'issue', description: 'https://github.com/microsoft/playwright/issues/30760' },
-}, async ({ page, server, browserName }) => {
+}, async ({ page, server }) => {
await page.route('**/one-style.css', async route => {
return route.fulfill({
status: 404,
@@ -482,6 +482,30 @@ it('should not go to the network for fulfilled requests body', {
await page.goto(server.PREFIX + '/one-style.html');
const response = await responsePromise;
const body = await response.body();
- expect(body).toBeTruthy();
+ expect(body.toString()).toBe('Not Found! (mocked)');
expect(serverHit).toBe(false);
});
+
+it('should return body for fulfilled responses', {
+ annotation: { type: 'issue', description: 'https://github.com/microsoft/playwright-java/issues/1792' },
+}, async ({ page, server }) => {
+ for (const status of [100, 200, 404, 500]) {
+ await it.step(`status ${status}`, async () => {
+ const bodyOverride = `Custom body ${status}`;
+ await page.route('**/one-style.css', async route => {
+ return route.fulfill({
+ status,
+ contentType: 'text/plain',
+ body: bodyOverride,
+ });
+ });
+
+ const responsePromise = page.waitForResponse('**/one-style.css');
+ await page.goto(server.PREFIX + '/one-style.html');
+ const response = await responsePromise;
+ const body = await response.body();
+ expect(body.toString()).toBe(bodyOverride);
+ });
+ await page.unrouteAll();
+ }
+});