feat: Add regex support to match urls

Author: igorjacauna

src/runtime/handler.ts

@@ -12,11 +12,16 @@ export default class Handler {
 
   verb!: string;
 
-  path!: string;
+  path!: string | RegExp;
 
   params?: object;
 
-  constructor(scope: Proxy, verb: string, path: string, params?: object) {
+  constructor(
+    scope: Proxy,
+    verb: string,
+    path: string | RegExp,
+    params?: object,
+  ) {
     this.scope = scope;
     this.verb = verb;
     this.path = path;

src/runtime/helpers.ts

@@ -2,6 +2,15 @@ import type { AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios';
 import { isEqual } from 'ohash';
 import { $URL } from 'ufo';
 
+function matchPaths(path: string | RegExp, url: string) {
+  if (typeof path === 'string') {
+    const requestURL = new $URL(url);
+    const matchURL = new $URL(path);
+    return requestURL.pathname === matchURL.pathname;
+  }
+  return path.exec(url);
+}
+
 export function hasSameParams(requestParams: object, proxyParams?: object) {
   if (!proxyParams) return true;
   return isEqual(requestParams, proxyParams);
@@ -10,15 +19,15 @@ export function hasSameParams(requestParams: object, proxyParams?: object) {
 // eslint-disable-next-line complexity
 export function matchRequest(
   verb: string,
-  path: string,
+  path: string | RegExp,
   config: AxiosRequestConfig,
   params?: object,
 ) {
+  if (!config.url) return false;
+  const samePath = matchPaths(path, config.url);
   const requestURL = new $URL(config.url);
-  const matchURL = new $URL(path);
 
   const sameMethod = config.method === verb;
-  const samePath = requestURL.pathname === matchURL.pathname;
 
   if (!sameMethod) return false;
   if (!samePath) return false;

src/runtime/proxy.ts

@@ -15,7 +15,7 @@ export default class Proxy {
     this.axios = axios;
   }
 
-  private setup(verb: string, path: string, params?: object) {
+  private setup(verb: string, path: string | RegExp, params?: object) {
     const handler = new Handler(this, verb, path, params);
     return handler;
   }
@@ -24,19 +24,19 @@ export default class Proxy {
     clearAll(this.axios);
   }
 
-  onGet(path: string, params?: object) {
+  onGet(path: string | RegExp, params?: object) {
     return this.setup('get', path, params);
   }
 
-  onPost(path: string, params?: object) {
+  onPost(path: string | RegExp, params?: object) {
     return this.setup('post', path, params);
   }
 
-  onPut(path: string, params?: object) {
+  onPut(path: string | RegExp, params?: object) {
     return this.setup('put', path, params);
   }
 
-  onPatch(path: string, params?: object) {
+  onPatch(path: string | RegExp, params?: object) {
     return this.setup('patch', path, params);
   }
 }

test/index.test.ts

@@ -1,13 +1,17 @@
+/* eslint-disable max-lines */
 import axios from 'axios';
 import nock from 'nock';
 import { expect, it, describe, beforeEach, vi } from 'vitest';
 import { defineProxy } from '../src';
 
 const BASE_URL = 'https://api.com.br';
-function to(promise: Promise<unknown>) {
-  return promise
-    .then(value => [undefined, value])
-    .catch(error => [error, undefined]);
+async function to(promise: Promise<unknown>) {
+  try {
+    const value = await promise;
+    return [undefined, value];
+  } catch (error) {
+    return [error, undefined];
+  }
 }
 
 describe('axios-dev-proxy tests', () => {
@@ -212,6 +216,17 @@ describe('axios-dev-proxy tests', () => {
       expect(response2.data).toEqual({ data: 2 });
       expect(response2.status).toEqual(201);
     });
+
+    it('should modify response for regex route', async () => {
+      server.get('/test/2?q=2').reply(200, { data: 1 });
+
+      proxy.onGet(/\/test\/\d+/).replyOnce(201, {
+        data: 2,
+      });
+      const response = await api.get('/test/2?q=2');
+      expect(response.data).toEqual({ data: 2 });
+      expect(response.status).toEqual(201);
+    });
   });
 
   describe('always GET configs', () => {