Exact paths with colon

[SimeonRolev]

Hi, guys!
I checked the documentation, sorry if I missed it. I didn't find a simple way to pass exact path, that includes colons. Can I bypass the Path with parameters parsing that is described here https://mswjs.io/docs/basics/request-matching ?

For example, I'd like a handler like this:

rest.get('/rest/o:exampleUser/p:folder/', (req, res, ctx) => {
    return res(ctx.json({ "example": 1 }));
});

I want it to behave like an exact path, without parsing the o: and p: as parameters.

Thanks in advance!

---

As a workaround, I came up with this. Create a response map with <url>:<data> and do the match yourself inside the handler.

const responseMap = {
    '/rest/o:example/p:example/': {
        example: 1
    }
}

return [
    rest.get('/rest/*', (req, res, ctx) => {
        return res(ctx.json(responseMap[decodeURI(req.url.pathname)]));
    })
];

[kettanaito]

Hey, @SimeonRolev. Thanks for reaching out.

Colons are reserved for URL path parameters, so :exampleUser will turn into req.params.exampleUser with the corresponding portion of the actual request URL being its value.

While a colon (:) is a valid character to use in a URL, it often bears a reserved value:

• Denotes a port number.
• Separates user credentials in a user:password auth pair.

Perhaps consider remodeling your resource URLs to drop the colons, if possible?

The only way to allow exact colons in a request handler's URL, for now, is to convert the entire URL string into a RegExp:

rest.get(/\/rest\/o:example\/p:example/, (req, res, ctx) => {})

We are unlikely to handle colons exactly because they are reserved for path parameters. Deciding between an exact usage and a parameter is a guessing game that the library mustn't do.

[SimeonRolev]

Thanks for the reply.

I agree, it shouldn't be a guessing game. But it shouldn't be a restriction either. imo. There are different options in most reslovers, ex. using :: or [:]. An option would be nice. Tried something like:

return Object.entries(responseMap).map(([url, expectedResponse]) => {
    const regex = new RegExp(
        `^${decodeURI(url).replace('/', '\\/')}$`
    );
    console.log(regex);
    return rest.get(regex, (req, res, ctx) => res(ctx.json(expectedResponse)));
});

But that didn't work and I don't know why:

• I get this console logged: /^\/rest\/o:example\/p:example\/$/.
• When I "/rest/o:example/p:example/".match(/^\/rest\/o:example\/p:example\/$/) in console, there is a match.
• But server still returns 404.

[FullBeardDev]

For anyone struggling with this, you can escape the colon by prepending two forward slashes to it.

// Used to match '/api/v1/resource:action'
rest.post('/api/v1/resource\\:action', (req, res, ctx) => res(ctx.json({ ... })))

This method of escaping the character is used internally in the library to escape the colon before the protocol and the one before the port number see here

There's little choice for me as my company follows this google standards for custom methods to build its APIs, hence, I have to intercept many endpoints with colons in them.