Merge pull request #184 from storyofams/fix/route-matching

[fix] route matching
instantcommerce · Jul 2, 2021 · ce4b67d · ce4b67d
2 parents 29c2a41 + 7f09043
commit ce4b67d
Show file tree

Hide file tree

Showing 5 changed files with 71 additions and 18 deletions.
diff --git a/lib/createHandler.ts b/lib/createHandler.ts
@@ -1,6 +1,6 @@
 import type { NextApiHandler, NextApiRequest, NextApiResponse } from 'next';
 import { findRoute } from './internals/findRoute';
-import { getFileDirectory } from './internals/getFileDirectory';
+import { getCallerInfo } from './internals/getCallerInfo';
 import { getParams } from './internals/getParams';
 import { notFound } from './internals/notFound';
 import { parseRequestUrl } from './internals/parseRequestUrl';
@@ -26,14 +26,14 @@ import { parseRequestUrl } from './internals/parseRequestUrl';
  */
 export function createHandler(cls: new (...args: any[]) => any): NextApiHandler {
   const instance = new cls();
-  const directory = getFileDirectory();
+  const [directory, fileName] = getCallerInfo();
 
   return (req: NextApiRequest, res: NextApiResponse) => {
     if (!req.url || !req.method) {
       return notFound(req, res);
     }
 
-    const path = parseRequestUrl(req.url, directory);
+    const path = parseRequestUrl(req, directory, fileName);
     const [keys, match, method] = findRoute(cls, req.method, path);
     if (!method) {
       return notFound(req, res);

diff --git a/lib/internals/getFileDirectory.spec.ts → lib/internals/getCallerInfo.spec.ts b/lib/internals/getFileDirectory.spec.ts → lib/internals/getCallerInfo.spec.ts
@@ -1,4 +1,4 @@
-import { getFileDirectory } from './getFileDirectory';
+import { getCallerInfo } from './getCallerInfo';
 
 it('getFileDirectory', () => {
   const spyError = jest.spyOn(global, 'Error');
@@ -11,8 +11,8 @@ it('getFileDirectory', () => {
     return err;
   });
 
-  const dir = getFileDirectory();
-  expect(dir).toStrictEqual('/example-path/.next/server/pages/api/tags/[id]');
+  const dir = getCallerInfo();
+  expect(dir).toStrictEqual(['/example-path/.next/server/pages/api/tags/[id]', '[[...params]].ts']);
 
   spyError.mockRestore();
 });
diff --git a/lib/internals/getFileDirectory.ts → lib/internals/getCallerInfo.ts b/lib/internals/getFileDirectory.ts → lib/internals/getCallerInfo.ts
@@ -1,7 +1,8 @@
-import { dirname } from 'path';
+import { basename, dirname } from 'path';
 
-export function getFileDirectory(): string | undefined {
+export function getCallerInfo(): [directoryPath: string | undefined, fileName: string | undefined] {
   let directoryPath: string | undefined;
+  let fileName: string | undefined;
 
   const parenthesisRegExp = /\(([^)]+)\)/;
   const pathInError = new Error().stack
@@ -13,9 +14,11 @@ export function getFileDirectory(): string | undefined {
     const [, pathWithRowCol] = parenthesisRegExp.exec(pathInError) ?? [];
     /* istanbul ignore else */
     if (pathWithRowCol) {
-      directoryPath = dirname(pathWithRowCol.replace(/:(\d+):(\d+)$/, ''));
+      const fullPath = pathWithRowCol.replace(/:(\d+):(\d+)$/, '');
+      directoryPath = dirname(fullPath);
+      fileName = basename(fullPath);
     }
   }
 
-  return directoryPath;
+  return [directoryPath, fileName];
 }
diff --git a/lib/internals/parseRequestUrl.spec.ts b/lib/internals/parseRequestUrl.spec.ts
@@ -2,22 +2,52 @@ import { parseRequestUrl } from './parseRequestUrl';
 
 describe('parseRequestUrl', () => {
   it('Should return "/"', () => {
-    expect(parseRequestUrl('/api/user')).toStrictEqual('/');
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore
+    expect(parseRequestUrl({ url: '/api/user' })).toStrictEqual('/');
   });
 
   it('Should return "/1"', () => {
-    expect(parseRequestUrl('/api/user/1')).toStrictEqual('/1');
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore
+    expect(parseRequestUrl({ url: '/api/user/1' })).toStrictEqual('/1');
   });
 
   it('Should return "/1/articles"', () => {
-    expect(parseRequestUrl('/api/user/1/articles')).toStrictEqual('/1/articles');
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore
+    expect(parseRequestUrl({ url: '/api/user/1/articles' })).toStrictEqual('/1/articles');
   });
 
   it('Should return "/" when directory name is a paremeter ([id])', () =>
-    expect(parseRequestUrl('/api/user/1', '/next-api-decorators/.next/server/pages/api/user/[id]')).toStrictEqual('/'));
+    expect(
+      // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+      // @ts-ignore
+      parseRequestUrl({ url: '/api/user/1' }, '/next-api-decorators/.next/server/pages/api/user/[id]')
+    ).toStrictEqual('/'));
 
   it('Should return "/articles" when directory name is a paremeter ([id])', () =>
     expect(
-      parseRequestUrl('/api/user/1/articles', '/next-api-decorators/.next/server/pages/api/user/[id]')
+      // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+      // @ts-ignore
+      parseRequestUrl({ url: '/api/user/1/articles' }, '/next-api-decorators/.next/server/pages/api/user/[id]')
     ).toStrictEqual('/articles'));
+
+  it('Should return "/" when the file name is "articles.js" which gets compiled from "articles/index.ts"', () =>
+    expect(
+      // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+      // @ts-ignore
+      parseRequestUrl({ url: '/api/articles' }, '/next-api-decorators/.next/server/pages/api', 'articles.js')
+    ).toStrictEqual('/'));
+
+  it('Should return "/" when the file name starts with "[..."', () =>
+    expect(
+      parseRequestUrl(
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        // @ts-ignore
+        { url: '/api/article/1', query: { id: '1' } },
+        '/next-api-decorators/.next/server/pages/api/article',
+        '[...id].js'
+      )
+    ).toStrictEqual('/'));
 });
diff --git a/lib/internals/parseRequestUrl.ts b/lib/internals/parseRequestUrl.ts
@@ -1,8 +1,28 @@
-export function parseRequestUrl(url: string, directoryPath?: string): string {
+import { basename, extname } from 'path';
+import type { NextApiRequest } from 'next';
+
+export function parseRequestUrl(req: NextApiRequest, directoryPath?: string, fileName?: string): string {
+  // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+  const url = req.url!;
   let path = url.split('?')[0].split('/').slice(3).join('/');
 
-  if (directoryPath) {
-    const pathRegExp = new RegExp(directoryPath.split('/.next/server/pages')[1].replace(/(\[\w+\])/, '(\\w+)'));
+  // In order for the main method (e.g: `@Get()`) to be matched,
+  // the path for catch all routes should be set to "/"
+  if (fileName?.startsWith('[...')) {
+    const qsKey = basename(fileName.replace('[...', '').replace(']', ''), extname(fileName));
+    /* istanbul ignore else */
+    if (req.query[qsKey]) {
+      path = '';
+    }
+  }
+
+  if (directoryPath && !fileName?.startsWith('[...')) {
+    const pathRegExp = new RegExp(
+      // "pages/api/articles/index.ts" is compiled into "pages/api/articles.js" which has to be appended to the directory path for parsing
+      (directoryPath + (fileName && !fileName.startsWith('[') ? basename(fileName, extname(fileName)) : ''))
+        .split('/.next/server/pages')[1]
+        .replace(/(\[\w+\])/, '(\\w+)')
+    );
     /* istanbul ignore else */
     if (pathRegExp.test(url)) {
       path = url.replace(pathRegExp, '');