You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
[!IMPORTANT] This release is a BREAKING CHANGE. Please follow the Migration guidelines to upgrade. This release took a lot of effort to make, and I expect a bit of that effort on your part while upgrading. Most of the changes are mechanical, and a simple Find/Replace All will get you a long way. For the rest of it, you will learn how to handle requests and responses using the standard JavaScript API. Thank you!
Breaking changes
Drops support for Node.js 16. Please upgrade to Node.js 18 or later to use the global Fetch API.
Drops support for TypeScript < 4.7.
All browser-side exports, like setupWorker, SetupWorkerApi, etc., must be imported from msw/browser now.
Renames the rest object to http (rest.get -> http.get).
Response resolver call signature is no longer (req, res, ctx) => res() but instead ({ request }) => new Response().
The following exports are removed due to no longer being needed:
response
context and related exports (defaultContext, restContext, graphqlContext).
compose and createResponseComposition
res.once() is removed in favor of the { once: boolean } option on the request handler.
Replaces the .printHandlers() method with .listHandlers().
Removes the NetworkError class in favor of the standard Response.error().
Moves request error handling from the worker thread to the client thread.
Changes the call signature of the Life-cycle Events API to accept a single object argument.
Uses crypto.randomUUID() instead of Math.random() in the worker.
For the full list of changes and detailed instructions on how to upgrade please see the Migration guidelines.
Features
Adopts Fetch API primitives. Represent intercepted requests and mocked responses as Request and Response instances respectively.
Supports Node.js v18.
Supports ReadableStream as a mocked response body.
Supports reading the intercepted request body as FormData.
Supports FormData as a mocked response body.
Uses File polyfill in Node.js.
Supports XMLHttpRequest “upload” events when responding with a mocked stream response.
Allows mocking a network error once using the { once: true } request handler option.
Makes the RequestHandler API public.
Bug fixes
Fixes the issue where the request body couldn’t be properly read as FormData.
Fixes a set of issues related to response patching when using the FormData response body.
Fixes the issue where URLSearchParams as the request body couldn’t be read.
Fixes the issue where a bypassed request’s referrerPolicy was reset to a different value than the original.
Fixes the wrong order of XMLHttpRequest events and readyState changes.
Fixes the issue when reading an XMLHttpRequest body of responseType equal to "arraybuffer" as an incorrect buffer (previously, always assumed to be a string).
Fixes the order of XMLHttpRequest events when the request fails.
Keeps XMLHttpRequest status equal to 0 until the request actually resolves.
Fixes the issue when the onload event callback was called twice for XMLHttpRequest.
Various improvements in Node.js network behavior compliance.
Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.
This PR includes no changesets
When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
![renovate[bot]](https://avatars.githubusercontent.com/in/2740?s=60&v=4){kind=small}
This PR contains the following updates:
^1.3.1->^2.0.0Release Notes
mswjs/msw (msw)
v2.0.0Compare Source
v2.0.0 (2023-10-23)
Breaking changes
< 4.7.setupWorker,SetupWorkerApi, etc., must be imported frommsw/browsernow.restobject tohttp(rest.get->http.get).(req, res, ctx) => res()but instead({ request }) => new Response().responsecontextand related exports (defaultContext,restContext,graphqlContext).composeandcreateResponseCompositionres.once()is removed in favor of the{ once: boolean }option on the request handler..printHandlers()method with.listHandlers().NetworkErrorclass in favor of the standardResponse.error().crypto.randomUUID()instead ofMath.random()in the worker.Features
RequestandResponseinstances respectively.ReadableStreamas a mocked response body.FormData.FormDataas a mocked response body.Filepolyfill in Node.js.{ once: true }request handler option.RequestHandlerAPI public.Bug fixes
FormData.FormDataresponse body.URLSearchParamsas the request body couldn’t be read.referrerPolicywas reset to a different value than the original.XMLHttpRequestevents andreadyStatechanges.responseTypeequal to"arraybuffer"as an incorrect buffer (previously, always assumed to be a string).XMLHttpRequestevents when the request fails.statusequal to 0 until the request actually resolves.onloadevent callback was called twice forXMLHttpRequest.@dbritto-dev @ddolcimascolo @markwhitfeld @christoph-fricke @thepassle @piotr-cz @mattcosta7 @koddsson @dkobierski @ricardocosta @dxlbnl @zkochan @felipefreitag @weyert @95th @committomaster @Xayer @Kosai106 @colinsullivan @xmlking @thw0rted @lee-reinhardt @wKovacs64 @TeChn4K @cmolina @nickrttn @thomasbertet @mscottnelson @jonnedeprez @negabaro @the-ult @WesleyYue @cwagner22 @skvale @alawiii521 @csantos1113 @elliotgonzalez123 @committomaster @tsteckenborn @xxleyi @jonnedeprez @danny-does-stuff @lemcii @mattrodak @luisr-carrillo @lee-reinhardt @ealejandrootalvaro @tomdglenn91
v1.3.2Compare Source
v1.3.2 (2023-10-01)
Bug Fixes
0a857f6) @kettanaitoConfiguration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR has been generated by Mend Renovate. View repository job log here.