feat: configurable base path

closes #3

Author: antongolub

README.md

@@ -127,7 +127,13 @@ await app.start()
       "secure": {
         "cert": "ssl/cert.pem",
         "key": "ssl/key.pem"
-      }
+      },
+      // Optional. Defaults to '/'
+      "base": "/",
+      // Optional. Defaults to '/'
+      "api": "/",
+      // Optional. Defaults to '/healthcheck'. Pass null to disable
+      "healthcheck": "/health"
     }
   ],
   // Remote registry

config.json

@@ -6,7 +6,9 @@
       "secure": {
         "cert": "ssl/cert.pem",
         "key": "ssl/key.pem"
-      }
+      },
+      "healthcheck": null,
+      "api": "/registry"
     }
   ],
   "registry": "https://registry.npmmirror.com",

src/main/js/app.js

@@ -16,11 +16,7 @@ import { getConfig } from './config.js'
 export const createApp = (cfg) => {
   const config = getConfig(cfg)
   const servers = config.server.map(s => {
-    const router = createRouter([
-      [ ctx({...config, server: s}) ],
-      [ timeout ],
-      [ trace ],
-      ['GET', '/healthcheck/', healthcheck],
+    const api = createRouter([
       [
         '*',
         [
@@ -37,10 +33,20 @@ export const createApp = (cfg) => {
         ],
         firewall
       ],
-      [ proxy ],
-      [ notFound ],
-      [ errorBoundary ],
-    ])
+      proxy,
+      errorBoundary,
+    ], s.api)
+
+    const router = createRouter([
+      ctx({...config, server: s}),
+      timeout,
+      trace,
+      ['GET', s.healthcheck, healthcheck],
+      api,
+      notFound,
+      errorBoundary,
+    ], s.base)
+
     return createServer({...s, router})
   })
   return {

src/main/js/config.js

@@ -1,6 +1,6 @@
 import fs from 'node:fs'
 import {strict as assert} from 'node:assert'
-import {asRegExp, asArray} from './util.js'
+import {asRegExp, asArray, normalizePath} from './util.js'
 import { semver } from './semver.js'
 
 const populate = (config) => {
@@ -9,6 +9,9 @@ const populate = (config) => {
   const server = asArray(config.server).map(({
     host,
     port,
+    base = '/',
+    api = '/',
+    healthcheck = '/healthcheck',
     secure: _secure,
     keepAliveTimeout = 61_000,
     headersTimeout = 62_000,
@@ -22,12 +25,15 @@ const populate = (config) => {
         key: fs.readFileSync(_secure.key, 'utf8'),
         cert: fs.readFileSync(_secure.cert, 'utf8'),
       } : null
-    const entrypoint = `${secure ? 'https' : 'http'}://${host}:${port}`
+    const entrypoint = normalizePath(`${secure ? 'https' : 'http'}://${host}:${port}${base}${api}`)
 
     return {
       secure,
       host,
       port,
+      base,
+      healthcheck,
+      api,
       entrypoint,
       requestTimeout,
       headersTimeout,

src/main/js/http/router.js

@@ -1,12 +1,14 @@
-import {asArray, once} from '../util.js'
+import {asArray, normalizePath, once} from '../util.js'
+
+const normalizeRoute = (item) => {
+  const [m, p, cb] = asArray(item)
 
-const normalizeRoute = ([m, p, cb]) => {
   if (typeof m === 'function') {
-    return ['*', [null], m]
+    return ['*', [true], m]
   }
 
   if (typeof p === 'function') {
-    return [m, [null], p]
+    return [m, [true], p]
   }
 
   return [m, asArray(p), cb]
@@ -16,8 +18,12 @@ const matchMethod = (method, expected) =>
   method === expected || expected === '*' || expected === 'ALL'
 
 const matchUrl = (url, [pattern]) => {
+  if (pattern === null) {
+    return false
+  }
+
   if (typeof pattern === 'string') {
-    return url.startsWith(pattern)
+    return url === pattern || url.startsWith(pattern) && url.charAt(pattern.length) === '/'
   }
 
   if (pattern instanceof RegExp) {
@@ -27,8 +33,14 @@ const matchUrl = (url, [pattern]) => {
   return true
 }
 
-export const createRouter = (routes) => async (req, res) => {
-  const url = req.url
+export const createRouter = (routes, base = '/') => async (req, res, next = () => {}) => {
+  if (req.url.startsWith(base)) {
+    req.url = req.url.replace(base, '/')
+  } else {
+    return next()
+  }
+
+  const url = normalizePath(req.url)
   const matched = routes
     .map(normalizeRoute)
     .filter(([method, pattern]) => matchMethod(req.method, method) && matchUrl(url, pattern))

src/main/js/util.js

@@ -18,3 +18,10 @@ export const asArray = v => Array.isArray(v) ? v : [v]
 export const asRegExp = v => v instanceof RegExp
   ? v
   : new RegExp(`^${v.replace(/\*/g, '.+')}$`, 'i')
+
+export const normalizePath = (url) => url.length > 1
+  ? (url + '/')
+    .replace(/\/+/g, '/')
+    .replace(':/', '://')
+    .slice(0, -1)
+  : url