msw plugin

[mrlubos]

Closes #1486

• ability to override response or parts of it (separate argument for success/error?), needs to be type-safe
• ability to specify number of array items (dot based notation for granular selection?)
• ability to skip optional arguments (aka minimal response), offer the opposite (ridiculous amount of array items, additional object properties, etc)
• move response type behind debug flag (makes life easier as there'll be no need to import TypeScript enums and fight with File type or overridden interfaces)

[bolt-new-by-stackblitz]

Run & review this pull request in StackBlitz Codeflow.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 67d8678

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

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
hey-api-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 24, 2025 3:38am

[codecov]

Codecov Report

❌ Patch coverage is 20.11070% with 433 lines in your changes missing coverage. Please review.
✅ Project coverage is 55.48%. Comparing base (3d17490) to head (67d8678).
⚠️ Report is 2355 commits behind head on main.

Files with missing lines	Patch %	Lines
packages/openapi-ts/src/plugins/msw/plugin.ts	17.00%	166 Missing ⚠️
packages/openapi-ts/src/plugins/msw/schema.ts	11.18%	127 Missing ⚠️
packages/openapi-ts/src/plugins/msw/interfaces.ts	16.66%	105 Missing ⚠️
packages/openapi-ts/src/plugins/msw/response.ts	30.43%	32 Missing ⚠️
packages/openapi-ts/src/plugins/msw/config.ts	83.33%	3 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1614      +/-   ##
==========================================
- Coverage   56.26%   55.48%   -0.79%     
==========================================
  Files         158      164       +6     
  Lines       24875    25407     +532     
  Branches     1816     1816              
==========================================
+ Hits        13997    14096      +99     
- Misses      10868    11301     +433     
  Partials       10       10              

Flag	Coverage Δ
unittests	55.48% <20.11%> (-0.79%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[pkg-pr-new]

Open in Stackblitz

npm i https://pkg.pr.new/hey-api/openapi-ts/@hey-api/openapi-ts@1614

commit: dbe4e0d

[ahmedrowaihi]

Hey, I have a cool idea,
Is it possible to create a type-safe "router" that proxies another server ?

for example:

Hidden Backend Spec <- OpenAPI-Proxy <- Client

there are many libs, but most of them are very bad

there has to be a lib that offers:

• selective endpoints interception
• allows a passthrough for the non intercepted ones.
• you either make block all and whilst or the opposite.

do you think this can be part of hey, or a new adapter to msw itself ?

[mrlubos]

I don't see why not. Which libraries are you referring to?

[wn-mitch]

Morning! What else is still remaining on this plugin to bring this to fruition? I'm looking at this hungrily and want to help out if I can, as leveraging MSW would be an absolute boon for our playwright suite

[malcolm-kee]

I took the liberty to create a first iteration of MSW plugin.

• feat: implement msw plugin #3570

It doesn't include all the checklist above, because I think there are a lot overlaps with the faker plugin that's also coming soon, so right now it's just provide type-safety while abstract away the path config from OpenAPI spec.