Fix mockServiceWorker.js reformatting (#6526)

# Description of Changes
`mockServiceWorker.js` is a third-party managed file, which is included
in our `.prettierignore` file, and is rewritten to be in the module's
standard format whenever `msw` runs. At some point, it was reformatted
in our style, but shouldn't have been. This puts it back to `msw`'s
style, which should make it stop appearing in diffs.
This commit is contained in:
James Brunton
2026-06-03 15:47:03 +00:00
committed by GitHub
parent 895dcbbafd
commit 7f3ca7ea70
+95 -95
View File
@@ -7,114 +7,114 @@
* - Please do NOT modify this file. * - Please do NOT modify this file.
*/ */
const PACKAGE_VERSION = "2.14.6"; const PACKAGE_VERSION = '2.14.6'
const INTEGRITY_CHECKSUM = "4db4a41e972cec1b64cc569c66952d82"; const INTEGRITY_CHECKSUM = '4db4a41e972cec1b64cc569c66952d82'
const IS_MOCKED_RESPONSE = Symbol("isMockedResponse"); const IS_MOCKED_RESPONSE = Symbol('isMockedResponse')
const activeClientIds = new Set(); const activeClientIds = new Set()
addEventListener("install", function () { addEventListener('install', function () {
self.skipWaiting(); self.skipWaiting()
}); })
addEventListener("activate", function (event) { addEventListener('activate', function (event) {
event.waitUntil(self.clients.claim()); event.waitUntil(self.clients.claim())
}); })
addEventListener("message", async function (event) { addEventListener('message', async function (event) {
const clientId = Reflect.get(event.source || {}, "id"); const clientId = Reflect.get(event.source || {}, 'id')
if (!clientId || !self.clients) { if (!clientId || !self.clients) {
return; return
} }
const client = await self.clients.get(clientId); const client = await self.clients.get(clientId)
if (!client) { if (!client) {
return; return
} }
const allClients = await self.clients.matchAll({ const allClients = await self.clients.matchAll({
type: "window", type: 'window',
}); })
switch (event.data) { switch (event.data) {
case "KEEPALIVE_REQUEST": { case 'KEEPALIVE_REQUEST': {
sendToClient(client, { sendToClient(client, {
type: "KEEPALIVE_RESPONSE", type: 'KEEPALIVE_RESPONSE',
}); })
break; break
} }
case "INTEGRITY_CHECK_REQUEST": { case 'INTEGRITY_CHECK_REQUEST': {
sendToClient(client, { sendToClient(client, {
type: "INTEGRITY_CHECK_RESPONSE", type: 'INTEGRITY_CHECK_RESPONSE',
payload: { payload: {
packageVersion: PACKAGE_VERSION, packageVersion: PACKAGE_VERSION,
checksum: INTEGRITY_CHECKSUM, checksum: INTEGRITY_CHECKSUM,
}, },
}); })
break; break
} }
case "MOCK_ACTIVATE": { case 'MOCK_ACTIVATE': {
activeClientIds.add(clientId); activeClientIds.add(clientId)
sendToClient(client, { sendToClient(client, {
type: "MOCKING_ENABLED", type: 'MOCKING_ENABLED',
payload: { payload: {
client: { client: {
id: client.id, id: client.id,
frameType: client.frameType, frameType: client.frameType,
}, },
}, },
}); })
break; break
} }
case "CLIENT_CLOSED": { case 'CLIENT_CLOSED': {
activeClientIds.delete(clientId); activeClientIds.delete(clientId)
const remainingClients = allClients.filter((client) => { const remainingClients = allClients.filter((client) => {
return client.id !== clientId; return client.id !== clientId
}); })
// Unregister itself when there are no more clients // Unregister itself when there are no more clients
if (remainingClients.length === 0) { if (remainingClients.length === 0) {
self.registration.unregister(); self.registration.unregister()
} }
break; break
} }
} }
}); })
addEventListener("fetch", function (event) { addEventListener('fetch', function (event) {
const requestInterceptedAt = Date.now(); const requestInterceptedAt = Date.now()
// Bypass navigation requests. // Bypass navigation requests.
if (event.request.mode === "navigate") { if (event.request.mode === 'navigate') {
return; return
} }
// Opening the DevTools triggers the "only-if-cached" request // Opening the DevTools triggers the "only-if-cached" request
// that cannot be handled by the worker. Bypass such requests. // that cannot be handled by the worker. Bypass such requests.
if ( if (
event.request.cache === "only-if-cached" && event.request.cache === 'only-if-cached' &&
event.request.mode !== "same-origin" event.request.mode !== 'same-origin'
) { ) {
return; return
} }
// Bypass all requests when there are no active clients. // Bypass all requests when there are no active clients.
// Prevents the self-unregistered worked from handling requests // Prevents the self-unregistered worked from handling requests
// after it's been terminated (still remains active until the next reload). // after it's been terminated (still remains active until the next reload).
if (activeClientIds.size === 0) { if (activeClientIds.size === 0) {
return; return
} }
const requestId = crypto.randomUUID(); const requestId = crypto.randomUUID()
event.respondWith(handleRequest(event, requestId, requestInterceptedAt)); event.respondWith(handleRequest(event, requestId, requestInterceptedAt))
}); })
/** /**
* @param {FetchEvent} event * @param {FetchEvent} event
@@ -122,28 +122,28 @@ addEventListener("fetch", function (event) {
* @param {number} requestInterceptedAt * @param {number} requestInterceptedAt
*/ */
async function handleRequest(event, requestId, requestInterceptedAt) { async function handleRequest(event, requestId, requestInterceptedAt) {
const client = await resolveMainClient(event); const client = await resolveMainClient(event)
const requestCloneForEvents = event.request.clone(); const requestCloneForEvents = event.request.clone()
const response = await getResponse( const response = await getResponse(
event, event,
client, client,
requestId, requestId,
requestInterceptedAt, requestInterceptedAt,
); )
// Send back the response clone for the "response:*" life-cycle events. // Send back the response clone for the "response:*" life-cycle events.
// Ensure MSW is active and ready to handle the message, otherwise // Ensure MSW is active and ready to handle the message, otherwise
// this message will pend indefinitely. // this message will pend indefinitely.
if (client && activeClientIds.has(client.id)) { if (client && activeClientIds.has(client.id)) {
const serializedRequest = await serializeRequest(requestCloneForEvents); const serializedRequest = await serializeRequest(requestCloneForEvents)
// Clone the response so both the client and the library could consume it. // Clone the response so both the client and the library could consume it.
const responseClone = response.clone(); const responseClone = response.clone()
sendToClient( sendToClient(
client, client,
{ {
type: "RESPONSE", type: 'RESPONSE',
payload: { payload: {
isMockedResponse: IS_MOCKED_RESPONSE in response, isMockedResponse: IS_MOCKED_RESPONSE in response,
request: { request: {
@@ -160,10 +160,10 @@ async function handleRequest(event, requestId, requestInterceptedAt) {
}, },
}, },
responseClone.body ? [serializedRequest.body, responseClone.body] : [], responseClone.body ? [serializedRequest.body, responseClone.body] : [],
); )
} }
return response; return response
} }
/** /**
@@ -175,30 +175,30 @@ async function handleRequest(event, requestId, requestInterceptedAt) {
* @returns {Promise<Client | undefined>} * @returns {Promise<Client | undefined>}
*/ */
async function resolveMainClient(event) { async function resolveMainClient(event) {
const client = await self.clients.get(event.clientId); const client = await self.clients.get(event.clientId)
if (activeClientIds.has(event.clientId)) { if (activeClientIds.has(event.clientId)) {
return client; return client
} }
if (client?.frameType === "top-level") { if (client?.frameType === 'top-level') {
return client; return client
} }
const allClients = await self.clients.matchAll({ const allClients = await self.clients.matchAll({
type: "window", type: 'window',
}); })
return allClients return allClients
.filter((client) => { .filter((client) => {
// Get only those clients that are currently visible. // Get only those clients that are currently visible.
return client.visibilityState === "visible"; return client.visibilityState === 'visible'
}) })
.find((client) => { .find((client) => {
// Find the client ID that's recorded in the // Find the client ID that's recorded in the
// set of clients that have registered the worker. // set of clients that have registered the worker.
return activeClientIds.has(client.id); return activeClientIds.has(client.id)
}); })
} }
/** /**
@@ -211,36 +211,36 @@ async function resolveMainClient(event) {
async function getResponse(event, client, requestId, requestInterceptedAt) { async function getResponse(event, client, requestId, requestInterceptedAt) {
// Clone the request because it might've been already used // Clone the request because it might've been already used
// (i.e. its body has been read and sent to the client). // (i.e. its body has been read and sent to the client).
const requestClone = event.request.clone(); const requestClone = event.request.clone()
function passthrough() { function passthrough() {
// Cast the request headers to a new Headers instance // Cast the request headers to a new Headers instance
// so the headers can be manipulated with. // so the headers can be manipulated with.
const headers = new Headers(requestClone.headers); const headers = new Headers(requestClone.headers)
// Remove the "accept" header value that marked this request as passthrough. // Remove the "accept" header value that marked this request as passthrough.
// This prevents request alteration and also keeps it compliant with the // This prevents request alteration and also keeps it compliant with the
// user-defined CORS policies. // user-defined CORS policies.
const acceptHeader = headers.get("accept"); const acceptHeader = headers.get('accept')
if (acceptHeader) { if (acceptHeader) {
const values = acceptHeader.split(",").map((value) => value.trim()); const values = acceptHeader.split(',').map((value) => value.trim())
const filteredValues = values.filter( const filteredValues = values.filter(
(value) => value !== "msw/passthrough", (value) => value !== 'msw/passthrough',
); )
if (filteredValues.length > 0) { if (filteredValues.length > 0) {
headers.set("accept", filteredValues.join(", ")); headers.set('accept', filteredValues.join(', '))
} else { } else {
headers.delete("accept"); headers.delete('accept')
} }
} }
return fetch(requestClone, { headers }); return fetch(requestClone, { headers })
} }
// Bypass mocking when the client is not active. // Bypass mocking when the client is not active.
if (!client) { if (!client) {
return passthrough(); return passthrough()
} }
// Bypass initial page load requests (i.e. static assets). // Bypass initial page load requests (i.e. static assets).
@@ -248,15 +248,15 @@ async function getResponse(event, client, requestId, requestInterceptedAt) {
// means that MSW hasn't dispatched the "MOCK_ACTIVATE" event yet // means that MSW hasn't dispatched the "MOCK_ACTIVATE" event yet
// and is not ready to handle requests. // and is not ready to handle requests.
if (!activeClientIds.has(client.id)) { if (!activeClientIds.has(client.id)) {
return passthrough(); return passthrough()
} }
// Notify the client that a request has been intercepted. // Notify the client that a request has been intercepted.
const serializedRequest = await serializeRequest(event.request); const serializedRequest = await serializeRequest(event.request)
const clientMessage = await sendToClient( const clientMessage = await sendToClient(
client, client,
{ {
type: "REQUEST", type: 'REQUEST',
payload: { payload: {
id: requestId, id: requestId,
interceptedAt: requestInterceptedAt, interceptedAt: requestInterceptedAt,
@@ -264,19 +264,19 @@ async function getResponse(event, client, requestId, requestInterceptedAt) {
}, },
}, },
[serializedRequest.body], [serializedRequest.body],
); )
switch (clientMessage.type) { switch (clientMessage.type) {
case "MOCK_RESPONSE": { case 'MOCK_RESPONSE': {
return respondWithMock(clientMessage.data); return respondWithMock(clientMessage.data)
} }
case "PASSTHROUGH": { case 'PASSTHROUGH': {
return passthrough(); return passthrough()
} }
} }
return passthrough(); return passthrough()
} }
/** /**
@@ -287,21 +287,21 @@ async function getResponse(event, client, requestId, requestInterceptedAt) {
*/ */
function sendToClient(client, message, transferrables = []) { function sendToClient(client, message, transferrables = []) {
return new Promise((resolve, reject) => { return new Promise((resolve, reject) => {
const channel = new MessageChannel(); const channel = new MessageChannel()
channel.port1.onmessage = (event) => { channel.port1.onmessage = (event) => {
if (event.data && event.data.error) { if (event.data && event.data.error) {
return reject(event.data.error); return reject(event.data.error)
} }
resolve(event.data); resolve(event.data)
}; }
client.postMessage(message, [ client.postMessage(message, [
channel.port2, channel.port2,
...transferrables.filter(Boolean), ...transferrables.filter(Boolean),
]); ])
}); })
} }
/** /**
@@ -314,17 +314,17 @@ function respondWithMock(response) {
// instance will have status code set to 0. Since it's not possible to create // instance will have status code set to 0. Since it's not possible to create
// a Response instance with status code 0, handle that use-case separately. // a Response instance with status code 0, handle that use-case separately.
if (response.status === 0) { if (response.status === 0) {
return Response.error(); return Response.error()
} }
const mockedResponse = new Response(response.body, response); const mockedResponse = new Response(response.body, response)
Reflect.defineProperty(mockedResponse, IS_MOCKED_RESPONSE, { Reflect.defineProperty(mockedResponse, IS_MOCKED_RESPONSE, {
value: true, value: true,
enumerable: true, enumerable: true,
}); })
return mockedResponse; return mockedResponse
} }
/** /**
@@ -345,5 +345,5 @@ async function serializeRequest(request) {
referrerPolicy: request.referrerPolicy, referrerPolicy: request.referrerPolicy,
body: await request.arrayBuffer(), body: await request.arrayBuffer(),
keepalive: request.keepalive, keepalive: request.keepalive,
}; }
} }