Merge pull request #926 from thomaschaaf/disable-stage-prefix-in-routes

Add option to disable prefixing of routes with stage name

README.md

@@ -102,6 +102,7 @@ All CLI options are optional:
 --httpPort                  Http port to listen on. Default: 3000
 --httpsProtocol         -H  To enable HTTPS, specify directory (relative to your cwd, typically your project dir) for both cert.pem and key.pem files
 --lambdaPort                Lambda http port to listen on. Default: 3002
+--noPrependStageInUrl       Don't prepend http routes with the stage.
 --noAuth                    Turns off all authorizers
 --noTimeout             -t  Disables the timeout feature.
 --printOutput               Turns on logging of your lambda outputs in the terminal.

src/config/commandOptions.js

@@ -43,6 +43,9 @@ export default {
   lambdaPort: {
     usage: 'Lambda http port to listen on. Default: 3002',
   },
+  noPrependStageInUrl: {
+    usage: "Don't prepend http routes with the stage.",
+  },
   noAuth: {
     usage: 'Turns off all authorizers',
   },

src/config/defaultOptions.js

@@ -13,6 +13,7 @@ export default {
   httpPort: 3000,
   httpsProtocol: '',
   lambdaPort: 3002,
+  noPrependStageInUrl: false,
   noAuth: false,
   noTimeout: false,
   printOutput: false,

src/events/http/HttpServer.js

@@ -250,13 +250,13 @@ export default class HttpServer {
     // path must start with '/'
     let hapiPath = path.startsWith('/') ? path : `/${path}`
 
-    const _path = hapiPath
-
     // prepend stage to path
     const stage = this.#options.stage || this.#serverless.service.provider.stage
 
-    // prepend stage to path
-    hapiPath = `/${stage}${hapiPath}`
+    if (!this.#options.noPrependStageInUrl) {
+      // prepend stage to path
+      hapiPath = `/${stage}${hapiPath}`
+    }
 
     // but must not end with '/'
     if (hapiPath !== '/' && hapiPath.endsWith('/')) {
@@ -276,9 +276,8 @@ export default class HttpServer {
 
     this.#terminalInfo.push({
       method,
-      path: _path,
+      path: hapiPath,
       server,
-      stage,
     })
 
     // If the endpoint has an authorization function, create an authStrategy for the route

src/serverlessLog.js

@@ -36,12 +36,12 @@ export function setLog(serverlessLogRef) {
 // logs based on:
 // https://github.com/serverless/serverless/blob/master/lib/classes/CLI.js
 
-function logRoute(method, server, stage, path, maxLength) {
+function logRoute(method, server, path, maxLength) {
   const methodColor = colorMethodMapping.get(method) ?? peachpuff
   const methodFormatted = method.padEnd(maxLength, ' ')
 
   return `${methodColor(methodFormatted)} ${yellow.dim('|')} ${grey.dim(
-    `${server}/${stage}`,
+    server,
   )}${lime(path)}`
 }
 
@@ -61,8 +61,8 @@ export function logRoutes(routeInfo) {
   console.log(
     boxen(
       routeInfo
-        .map(({ method, path, server, stage }) =>
-          logRoute(method, server, stage, path, maxLength),
+        .map(({ method, path, server }) =>
+          logRoute(method, server, path, maxLength),
         )
         .join('\n'),
       boxenOptions,

tests/integration/uncategorized/uncategorized.test.js

@@ -35,3 +35,32 @@ describe('uncategorized tests', () => {
     expect(json).toEqual({ foo: 'bar' })
   })
 })
+
+describe('noPrependStageInUrl tests', () => {
+  // init
+  beforeAll(() =>
+    setup({
+      servicePath: resolve(__dirname),
+      args: ['--noPrependStageInUrl'],
+    }),
+  )
+
+  // cleanup
+  afterAll(() => teardown())
+
+  test('noPrependStageInUrl 1', async () => {
+    const url = joinUrl(TEST_BASE_URL, '/uncategorized-1')
+    const response = await fetch(url)
+    const json = await response.json()
+
+    expect(json).toEqual({ foo: 'bar' })
+  })
+
+  test('noPrependStageInUrl 2', async () => {
+    const url = joinUrl(TEST_BASE_URL, '/dev/uncategorized-1')
+    const response = await fetch(url)
+    const json = await response.json()
+
+    expect(json.statusCode).toEqual(404)
+  })
+})