Bypassing MSW does not work with MSW 2.X

[Jokinen]

This is more of a FYI.

In version 3.1.0, the x-msw-bypass header was introduced in order to have better out of the box support for MSW.

MSW released a new version two weeks ago. Version 2.0 no longer respects the x-msw-bypass header. It seems that this header was considered to be an implementation detail as it's not documented as a breaking change.

MSW 2.0 has a new utility called bypass. Based on the implementation, it seems that the new header that gets bypassed is:

'x-msw-intention': 'bypass'

I'm not suggesting similar support should be implemented for MSW 2.x as existed fro MSW 1.x. I just want to bring this change into your attention.

Alternatives and workarounds

As a workaround, the old header can be respected in userland:

  server.listen({
    onUnhandledRequest(request, print) {
      if (request.headers.get('x-msw-bypass') === 'true') {
        return;
      }

      print.warning();
    },
  })
);

Not sure if the new bypass utility can be used in some way that allows the implementation to not depend on implementation details.

[Xunnamius]

Thanks for this! I'll release an update shortly.

UPDATE: I was thinking my unit tests should have caught this, but it turns out I wasn't testing the MSW integration. New regression test should catch this going forward.

[Xunnamius]

🎉 This issue has been resolved in version 3.2.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀