-
Notifications
You must be signed in to change notification settings - Fork 620
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Migrate from ember-cli-mirage
to msw
and @mswjs/data
#10393
Merged
Merged
Conversation
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
Turbo87
added
A-frontend 🐹
C-internal 🔧
Category: Nonessential work that would make the codebase more consistent or clear
labels
Jan 15, 2025
Turbo87
force-pushed
the
msw
branch
5 times, most recently
from
January 17, 2025 10:35
87a8963
to
400fa6c
Compare
Hmm, since // ember-cli-build.js
...
return require('@embroider/compat').compatBuild(app, Webpack, {
extraPublicTrees,
staticAddonTrees: true,
staticAddonTestSupportTrees: true,
staticModifiers: true,
packagerOptions: {
webpackConfig: {
resolve: {
fallback: {
// disables `crypto` import warning in `axe-core`
crypto: false,
// disables `timers` import warning in `@sinon/fake-timers`
timers: false,
},
},
externals: ({ request, context }, callback) => {
if (request == 'msw' && context.includes('@mswjs/data')) {
return callback(null, request, 'global');
}
callback();
},
},
},
}); I'm not sure if this is more better than the patch approach though 😅 |
Turbo87
force-pushed
the
msw
branch
22 times, most recently
from
January 27, 2025 10:09
7b13aa9
to
331b2d5
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
A-frontend 🐹
C-internal 🔧
Category: Nonessential work that would make the codebase more consistent or clear
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.
As discussed in #10357,
ember-cli-mirage
isn't particularly well maintained anymore and blocking a couple of dependency updates.This PR migrates us from using
ember-cli-mirage
for the mock API in the frontend test suites towards usingmsw
and@mswjs/data
.I've used a pnpm workspace to add a subpackage at
packages/crates-io-msw
, that is roughly equivalent to the previous top-levelmirage
folder. This package contains:msw
request handlers to simulate our crates.io API (exported ashandlers
)@mswjs/data
database with all of the models that support the above request handlers (exported asdb
)mirage/fixtures/
and aloadFixtures()
functionThe package also contains its own dedicated test suite. The test suite is essentially a vitest port of the previous
tests/mirage/
tests, but running in Node.js to simplify their development.The
@crates-io/msw
package is integrated into the QUnit test suite by asetupMsw()
function (similar to the previoussetupMirage()
). This function sets up the mock service worker and database for each test and ensures proper cleanup of both after the test has finished.The package is also integrated into the Playwright test suite (at
e2e/
). Here, it is using amsw
fixture, that can be used in tests and sets upplaywright-msw
which transforms themsw
request handlers into Playwright request handlers. Themsw
fixture has three properties,worker
is controlling the HTTP mocking,db
is the@mswjs/data
database mentioned above, andauthenticateAs()
is roughly equivalent to the similarly-named function from before. Since the mocking is now running on the Playwright side instead of inside the browser the test code could be simplified significantly.I'm aware that the diff is big, and I'm happy to split it up into more manageable chunks if it helps. I definitely recommend reviewing in "ignore whitespace changes" mode. I've tried to group the commits thematically so that the can be reviewed in smaller chunks too. Let me know if/how I can help in getting this reviewed! :)
Closes #10357
Related:
ember-cli-mirage
with directmiragejs
usage #10357