The shouldSkip attribute in v2 is not available anymore

[flaviodelgrosso]

Hi everyone,

I've noticed that the shouldSkip boolean attribute for request handlers is no longer used in v2. Specifically, this refers to RequestHandler<RestHandlerInfo, MockedRequest<DefaultBodyType>, Match, RestRequest<DefaultBodyType, PathParams<string>>>.shouldSkip: boolean.

Is there an alternative approach available for this in the new version?

Thanks!

[kettanaito]

Hi, @flaviodelgrosso. Can you tell me more about what you are trying to do here?

The .shouldSkip property of the request handler has been replaced with the .isUsed property:

msw/src/core/handlers/RequestHandler.ts

Lines 113 to 117 in bed402c

	/**
	* Indicates whether this request handler has been used
	* (its resolver has successfully executed).
	*/
	public isUsed: boolean

I'm tempted to say "just use that instead" but let's double-check with what you want to achieve here.

[kettanaito]

Not sure how correct that was but .isUsed is the new .shouldSkip.

[flaviodelgrosso]

Not sure how correct that was but .isUsed is the new .shouldSkip.

Thanks, I'll give a look at that

[flaviodelgrosso]

Little update @kettanaito, at the end I've just recreated a little utility to skip some handlers while running Cypress:

export function skipHandlersForCypress(handlers: HttpHandler[], skippedPaths: Path[]): HttpHandler[] {
  if (window.Cypress) {
    return handlers.filter((handler) => skippedPaths.includes(handler.info.path));
  }
  return handlers;
}

.isUsed does not fit my needs at the moment, maybe the .shouldSkip could be reintroduced :)

[kettanaito]

Nice! Good job solving that!

Can you share more details why .isUsed doesn't suit your needs?

[flaviodelgrosso]

Sometimes I need to disable some MSW handlers during specific E2E tests so I can use cy.intercept API to stub native fetch and manipulate data in different ways and for different assertions without relying on the service worker and fixtures controlled by the handlers. The .shouldSkip method previously worked well to avoid registering certain handlers during tests, but the new isUsed method doesn't seem to achieve the same effect.

This is how I used the old method:

import * as handlers from '@/examples/handlers';

handlers.handlerA.shouldSkip = !!window.Cypress;
handlers.handlerB.shouldSkip = !!window.Cypress;
handlers.handlerC.shouldSkip = !!window.Cypress;

export const examplesHandlers = [...Object.values(handlers)];

This is my utility to reach the same behavior:

import * as handlers from '@/examples/handlers';

const skippedPaths = ['/my/path/to/skip'];

export const examplesHandlers = skipHandlersForCypress(handlers, skippedPaths);

If there's a better solution or if I'm missing something, I'd appreciate your input. Thanks for your interest!