-
Notifications
You must be signed in to change notification settings - Fork 3.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(ct): experimental
route fixture (#31554)
This fixture accepts the same arguments as `context.route()`, but also supports request handlers compatible with msw syntax.
- Loading branch information
Showing
7 changed files
with
469 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,181 @@ | ||
| /** | ||
| * Copyright (c) Microsoft Corporation. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| import type * as playwright from 'playwright/test'; | ||
|
|
||
| interface RequestHandler { | ||
| run(args: { request: Request, requestId?: string, resolutionContext?: { baseUrl?: string } }): Promise<{ response?: Response } | null>; | ||
| } | ||
|
|
||
| type RouteArgs = Parameters<playwright.BrowserContext['route']>; | ||
|
|
||
| let lastRequestId = 0; | ||
| let fetchOverrideCounter = 0; | ||
| const currentlyInterceptingInContexts = new Map<playwright.BrowserContext, number>(); | ||
| const originalFetch = globalThis.fetch; | ||
|
|
||
| async function executeRequestHandlers(request: Request, handlers: RequestHandler[], baseUrl: string | undefined): Promise<Response | undefined> { | ||
| const requestId = String(++lastRequestId); | ||
| const resolutionContext = { baseUrl }; | ||
| for (const handler of handlers) { | ||
| const result = await handler.run({ request, requestId, resolutionContext }); | ||
| if (result?.response) | ||
| return result.response; | ||
| } | ||
| } | ||
|
|
||
| async function globalFetch(...args: Parameters<typeof globalThis.fetch>) { | ||
| if (args[0] && args[0] instanceof Request) { | ||
| const request = args[0]; | ||
| if (request.headers.get('x-msw-intention') === 'bypass') { | ||
| const cookieHeaders = await Promise.all([...currentlyInterceptingInContexts.keys()].map(async context => { | ||
| const cookies = await context.cookies(request.url); | ||
| if (!cookies.length) | ||
| return undefined; | ||
| return cookies.map(c => `${c.name}=${c.value}`).join('; '); | ||
| })); | ||
|
|
||
| if (!cookieHeaders.length) | ||
| throw new Error(`Cannot call fetch(bypass()) outside of a request handler`); | ||
|
|
||
| if (cookieHeaders.some(h => h !== cookieHeaders[0])) | ||
| throw new Error(`Cannot call fetch(bypass()) while concurrently handling multiple requests from different browser contexts`); | ||
|
|
||
| const headers = new Headers(request.headers); | ||
| headers.set('cookie', cookieHeaders[0]!); | ||
| headers.delete('x-msw-intention'); | ||
| args[0] = new Request(request.clone(), { headers }); | ||
| } | ||
| } | ||
| return originalFetch(...args); | ||
| } | ||
|
|
||
| export class Router { | ||
| private _context: playwright.BrowserContext; | ||
| private _requestHandlers: RequestHandler[] = []; | ||
| private _requestHandlersRoute: (route: playwright.Route) => Promise<void>; | ||
| private _requestHandlersActive = false; | ||
| private _routes: RouteArgs[] = []; | ||
|
|
||
| constructor(context: playwright.BrowserContext, baseURL: string | undefined) { | ||
| this._context = context; | ||
|
|
||
| this._requestHandlersRoute = async route => { | ||
| if (route.request().isNavigationRequest()) { | ||
| await route.fallback(); | ||
| return; | ||
| } | ||
|
|
||
| const request = route.request(); | ||
| const headersArray = await request.headersArray(); | ||
| const headers = new Headers(); | ||
| for (const { name, value } of headersArray) | ||
| headers.append(name, value); | ||
|
|
||
| const buffer = request.postDataBuffer(); | ||
| const body = buffer?.byteLength ? new Int8Array(buffer.buffer, buffer.byteOffset, buffer.length) : undefined; | ||
|
|
||
| const newRequest = new Request(request.url(), { | ||
| body: body, | ||
| headers: headers, | ||
| method: request.method(), | ||
| referrer: headersArray.find(h => h.name.toLowerCase() === 'referer')?.value, | ||
| }); | ||
|
|
||
| currentlyInterceptingInContexts.set(context, 1 + (currentlyInterceptingInContexts.get(context) || 0)); | ||
| const response = await executeRequestHandlers(newRequest, this._requestHandlers, baseURL).finally(() => { | ||
| const value = currentlyInterceptingInContexts.get(context)! - 1; | ||
| if (value) | ||
| currentlyInterceptingInContexts.set(context, value); | ||
| else | ||
| currentlyInterceptingInContexts.delete(context); | ||
| }); | ||
|
|
||
| if (!response) { | ||
| await route.fallback(); | ||
| return; | ||
| } | ||
|
|
||
| if (response.status === 302 && response.headers.get('x-msw-intention') === 'passthrough') { | ||
| await route.continue(); | ||
| return; | ||
| } | ||
|
|
||
| if (response.type === 'error') { | ||
| await route.abort(); | ||
| return; | ||
| } | ||
|
|
||
| const responseHeaders: Record<string, string> = {}; | ||
| for (const [name, value] of response.headers.entries()) { | ||
| if (responseHeaders[name]) | ||
| responseHeaders[name] = responseHeaders[name] + (name.toLowerCase() === 'set-cookie' ? '\n' : ', ') + value; | ||
| else | ||
| responseHeaders[name] = value; | ||
| } | ||
| await route.fulfill({ | ||
| status: response.status, | ||
| body: Buffer.from(await response.arrayBuffer()), | ||
| headers: responseHeaders, | ||
| }); | ||
| }; | ||
| } | ||
|
|
||
| async handle(...args: any[]) { | ||
| // Multiple RequestHandlers. | ||
| if (Array.isArray(args[0])) { | ||
| const handlers = args[0] as RequestHandler[]; | ||
| this._requestHandlers = handlers.concat(this._requestHandlers); | ||
| await this._updateRequestHandlersRoute(); | ||
| return; | ||
| } | ||
| // Single RequestHandler. | ||
| if (args.length === 1 && typeof args[0] === 'object') { | ||
| const handlers = [args[0] as RequestHandler]; | ||
| this._requestHandlers = handlers.concat(this._requestHandlers); | ||
| await this._updateRequestHandlersRoute(); | ||
| return; | ||
| } | ||
| // Arguments of BrowserContext.route(url, handler, options?). | ||
| const routeArgs = args as RouteArgs; | ||
| this._routes.push(routeArgs); | ||
| await this._context.route(...routeArgs); | ||
| } | ||
|
|
||
| async dispose() { | ||
| this._requestHandlers = []; | ||
| await this._updateRequestHandlersRoute(); | ||
| for (const route of this._routes) | ||
| await this._context.unroute(route[0], route[1]); | ||
| } | ||
|
|
||
| private async _updateRequestHandlersRoute() { | ||
| if (this._requestHandlers.length && !this._requestHandlersActive) { | ||
| await this._context.route('**/*', this._requestHandlersRoute); | ||
| if (!fetchOverrideCounter) | ||
| globalThis.fetch = globalFetch; | ||
| ++fetchOverrideCounter; | ||
| this._requestHandlersActive = true; | ||
| } | ||
| if (!this._requestHandlers.length && this._requestHandlersActive) { | ||
| await this._context.unroute('**/*', this._requestHandlersRoute); | ||
| this._requestHandlersActive = false; | ||
| --fetchOverrideCounter; | ||
| if (!fetchOverrideCounter) | ||
| globalThis.fetch = originalFetch; | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| import { useEffect, useState } from "react" | ||
|
|
||
| export default function Fetcher() { | ||
| const [data, setData] = useState<{ name: string }>({ name: '<none>' }); | ||
| const [fetched, setFetched] = useState(false); | ||
|
|
||
| useEffect(() => { | ||
| const doFetch = async () => { | ||
| try { | ||
| const response = await fetch('/data.json'); | ||
| setData(await response.json()); | ||
| } catch { | ||
| setData({ name: '<error>' }); | ||
| } | ||
| setFetched(true); | ||
| } | ||
|
|
||
| if (!fetched) | ||
| doFetch(); | ||
| }, [fetched, setFetched, setData]); | ||
|
|
||
| return <div> | ||
| <div data-testId='name'>{data.name}</div> | ||
| <button onClick={() => { | ||
| setFetched(false); | ||
| setData({ name: '<none>' }); | ||
| }}>Reset</button> | ||
| <button onClick={() => { | ||
| fetch('/post', { method: 'POST', body: 'hello from the page' }); | ||
| }}>Post it</button> | ||
| </div>; | ||
| } |
Oops, something went wrong.