feat: Router should sort routes by specificity (#14)

* chore: Update eslint

* feat: Router should sort routes by specificity

* chore: move types to the end

.eslintrc

@@ -3,7 +3,6 @@
   "parserOptions": {
     "project": "tsconfig.eslint.json"
   },
-  "plugins": ["@typeofweb/eslint-plugin"],
   "extends": ["plugin:@typeofweb/recommended"],
   "overrides": [
     {

CODE_OF_CONDUCT.md

@@ -1,76 +1,132 @@
-# Przymierze Współpracy — Kodeks Postępowania
-
-## Nasza Przysięga
-
-W celu wspierania otwartego i przyjaznego środowiska, my — jako współpracownicy i
-opiekunowie projektu — zobowiązujemy się dopilnować, aby uczestnictwo w naszym projekcie
-oraz przynależność do jego społeczności były pozbawione nękania bez względu na budowę
-ciała, doświadczenie, kolor skóry, narodowość, niepełnosprawność, orientację i
-identyfikację seksualną, pochodzenie etniczne, religię, wiek czy wygląd zewnętrzny.
-
-## Nasze Standardy
-
-Wśród przykładów zachowania, które przyczyniają się do tworzenia pozytywnego
-środowiska, są:
-
-- Używanie języka, który jest przyjazny i nie wyklucza innych uczestników projektu,
-- Okazywanie szacunku dla różnych punktów widzenia i osobistych doświadczeń,
-- Przyjmowanie konstruktywnej krytyki z wdzięcznością,
-- Skupianie się na tym, co dobre dla społeczności projektu,
-- Wykazywanie empatii wobec innych członków społeczności.
-
-Wśród przykładów zachowania, którego nie będziemy akceptować, są:
-
-- Używanie języka i grafik o podtekście seksualnym, okazywanie
-  niepożądanego zainteresowania seksualnego, a także zaloty,
-- Trollowanie, obraźliwe bądź urągające komentarze oraz ataki osobiste bądź
-  polityczne,
-- Nękanie, zarówno na forum publicznym jak i prywatnym,
-- Publikowanie danych osobistych innych osób — takich jak
-  adres fizyczny czy elektroniczny — bez ich wyraźnej zgody,
-- Inne zachowania, które mogłyby zostać uznane za nieodpowiednie w kontekście
-  profesjonalnym.
-
-## Nasza Odpowiedzialność
-
-Opiekunowie projektu są odpowiedzialni za objaśnianie standardów akceptowalnego
-zachowania i reagowanie na wszelkie przypadki nieodpowiedniego zachowania, w sposób
-sprawiedliwy i adekwatny do sytuacji.
-
-Opiekunowie projektu mają prawo do i są odpowiedzialni za usuwanie, edycję oraz odrzucanie
-komentarzy, zmian w kodzie (ang. _commit_), edycji Wiki, oraz innych treści, które
-łamią niniejszy Kodeks Postępowania, oraz mają prawo tymczasowo lub na stałe zablokować
-dostęp do projektu każdemu ze współpracowników: w przypadku gróźb bądź obraźliwych
-komentarzy pod adresem innych współpracowników, a także innych zachowań, które uznają
-za nieodpowiednie lub szkodliwe.
-
-## Zakres działania
-
-Ten Kodeks Postępowania ma zastosowanie wewnątrz projektu, a w przypadku
-reprezentowania projektu lub jego społeczności przez współpracownika — także na zewnątrz
-projektu. Do przykładów reprezentowania projektu zalicza się używanie oficjalnego adresu
-e-mail projektu, publikowanie na oficjalnym koncie w mediach społecznościowych lub branie
-udziału w wydarzeniu (zarówno w Internecie, jak i poza nim) jako oficjalny przedstawiciel
-projektu. Dokładny zakres pojęcia reprezentowania projektu może zostać objaśniony
-w bardziej szczegółowy sposób przez opiekunów projektu.
-
-## Egzekwowanie
-
-Przypadki nękania, gróźb oraz innych form nieakceptowalnego zachowania mogą
-być zgłaszane do zespołu projektu pod adresem [email protected]. Wszystkie
-skargi zostaną odpowiednio rozpatrzone oraz podjęte zostaną działania uznane za
-konieczne i odpowiednie do sytuacji. Zespół projektu ma obowiązek zachowania tożsamości
-osoby zgłaszającej incydent w tajemnicy. Bardziej szczegółowe zasady egzekwowania Kodeksu
-Postępowania mogą zostać udostępnione w osobnym dokumencie.
-
-Opiekunowie projektu, którzy nie respektują i nie egzekwują w dobrej wierze Kodeksu Postępowania,
-mogą zostać na stałe lub tymczasowo ukarani, zgodnie z decyzją innych liderów projektu.
-
-## Autorstwo
-
-Ten Kodeks Postępowania został zaadaptowany z [Contributor Covenant][homepage] w
-wersji 1.4, dostępnej pod adresem https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
-(w języku angielskim) oraz https://www.contributor-covenant.org/pl/version/1/4/code-of-conduct.html
-(w języku polskim).
-
-[homepage]: https://www.contributor-covenant.org/
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][mozilla coc].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][faq]. Translations are available
+at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
+[mozilla coc]: https://github.com/mozilla/diversity
+[faq]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

__tests__/routeSpecificity.test.ts

@@ -0,0 +1,31 @@
+import { calculateSpecificity } from '../src/utils/routeSpecificity';
+
+describe('routeSpecificity', () => {
+  test.each(
+    // prettier-ignore
+    [
+      ['/',               '0'],
+      ['/a',              '1'],
+      ['/b',              '1'],
+      ['/ab',             '1'],
+      ['/:p',             '2'],
+      ['/a/b',           '11'],
+      ['/a/:p',          '12'],
+      ['/b/',            '10'],
+      ['/a/b/c',        '111'],
+      ['/a/b/:p',       '112'],
+      ['/a/:p/b',       '121'],
+      ['/a/:p/c',       '121'],
+      ['/a/b/c/d',     '1111'],
+      ['/a/:p/b/:x',   '1212'],
+      ['/a/b/*',        '113'],
+      ['/:a/b/*',       '213'],
+      ['/*',              '3'],
+      ['/m/n/*',        '113'],
+      ['/m/:n/:o',      '122'],
+      ['/n/:p/*',       '123'],
+    ],
+  )('calculateSpecificity(%s)', (route, expected) => {
+    expect(calculateSpecificity(route)).toEqual(expected);
+  });
+});

__tests__/router.test.ts

@@ -135,4 +135,91 @@ describe('router', () => {
       expect(result.statusCode).toEqual(202);
     });
   });
+
+  describe('specificity', () => {
+    const routePaths = [
+      '/',
+      '/a',
+      '/b',
+      '/ab',
+      '/:p',
+      '/a/b',
+      '/a/:p',
+      '/b/',
+      '/a/b/c',
+      '/a/b/:p',
+      '/a/:p/b',
+      '/a/:p/c',
+      '/a/b/c/d',
+      '/a/:p/b/:x',
+      '/a/b/*',
+      '/:a/b/*',
+      '/*',
+      '/m/n/*',
+      '/m/:n/:o',
+      '/n/:p/*',
+    ].sort(() => Math.random() - 0.5);
+
+    const requests = [
+      ['/', '/'],
+      ['/a', '/a'],
+      ['/b', '/b'],
+      ['/ab', '/ab'],
+      ['/c', '/:p'],
+      ['/a/b', '/a/b'],
+      ['/a/c', '/a/:p'],
+      ['/b/', '/b/'],
+      ['/a/b/c', '/a/b/c'],
+      ['/a/b/d', '/a/b/:p'],
+      ['/a/a/b', '/a/:p/b'],
+      ['/a/d/c', '/a/:p/c'],
+      ['/a/b/c/d', '/a/b/c/d'],
+      ['/a/c/b/d', '/a/:p/b/:x'],
+      ['/a/b/c/d/e', '/a/b/*'],
+      ['/a/b/c/d/e/f', '/a/b/*'],
+      ['/x/b/c/d/e/f/g', '/:a/b/*'],
+      ['/x/y/c/d/e/f/g', '/*'],
+      ['/m/n/o', '/m/n/*'],
+      ['/m/o/p', '/m/:n/:o'],
+      ['/n/a/b/c', '/n/:p/*'],
+      ['/n/a/', '/n/:p/*'],
+    ];
+
+    const strictApp = createApp({ router: { strictTrailingSlash: true } });
+    routePaths.forEach((routePath) =>
+      strictApp.route({
+        path: routePath,
+        method: 'get',
+        validation: {},
+        handler: (req) => req.path,
+      }),
+    );
+
+    const looseApp = createApp({ router: { strictTrailingSlash: false } });
+    routePaths.forEach((routePath) =>
+      looseApp.route({
+        path: routePath,
+        method: 'get',
+        validation: {},
+        handler: (req) => req.path,
+      }),
+    );
+
+    it.each(requests)('strict: %p → %p', async (requestPath, requestRoute) => {
+      const result = await strictApp.inject({
+        method: 'get',
+        path: requestPath,
+      });
+      expect(result.body).toEqual(requestRoute);
+    });
+
+    it.each(requests)('loose: %p → %p', async (requestPath, requestRoute) => {
+      const result = await looseApp.inject({
+        method: 'get',
+        path: requestPath,
+      });
+      // trim trailing slash
+      expect(result.body).toEqual(requestRoute.replace(/(.+)\/$/, '$1'));
+    });
+  });
 });

package.json

@@ -50,24 +50,24 @@
     "@rollup/plugin-commonjs": "19.0.0",
     "@rollup/plugin-json": "4.1.0",
     "@rollup/plugin-typescript": "8.2.1",
-    "@tsconfig/node12": "1.0.8",
+    "@tsconfig/node12": "1.0.9",
     "@tsconfig/node14": "1.0.1",
-    "@typeofweb/eslint-plugin": "0.1.10",
+    "@typeofweb/eslint-plugin": "0.2.2",
     "@types/jest": "26.0.23",
     "@types/node": "12",
     "@types/stoppable": "1.1.1",
     "all-contributors-cli": "6.20.0",
     "builtin-modules": "3.2.0",
-    "eslint": "7.28.0",
+    "eslint": "7.29.0",
     "fast-check": "2.16.0",
-    "globby": "11.0.3",
+    "globby": "11.0.4",
     "husky": "6.0.0",
     "jest": "27.0.4",
     "lint-staged": "11.0.0",
     "nodemon": "2.0.7",
     "prettier": "2.3.1",
     "rimraf": "3.0.2",
-    "rollup": "2.51.2",
+    "rollup": "2.52.2",
     "rollup-plugin-filesize": "9.1.1",
     "rollup-plugin-license": "2.5.0",
     "rollup-plugin-prettier": "2.1.0",
@@ -76,7 +76,7 @@
     "ts-node": "10.0.0",
     "tsd": "https://github.com/typeofweb/tsd#pkg",
     "tslib": "2.3.0",
-    "typescript": "4.3.2"
+    "typescript": "4.3.4"
   },
   "scripts": {
     "prejest": "yarn build",

src/modules/app.ts

@@ -31,6 +31,9 @@ const defaultAppOptions: AppOptions = {
     sameSite: 'lax',
     secret: '',
   },
+  router: {
+    strictTrailingSlash: false,
+  },
 };
 
 export function createApp(opts: DeepPartial<AppOptions>): TypeOfWebApp {

src/modules/http.ts

@@ -8,6 +8,7 @@ export const initApp = () => {
   const app = Express();
 
   app.use(BodyParser.json());
+  app.disable('x-powered-by');
 
   return app;
 };