Merge pull request nestjs#3727 from prateekkathal/feature/disable-global-prefix

feat(common/core): Added useGlobalPrefix option for Controllers

Author: kamilmysliwiec

packages/common/constants.ts

@@ -8,6 +8,7 @@ export const METADATA = {
 export const SHARED_MODULE_METADATA = '__module:shared__';
 export const GLOBAL_MODULE_METADATA = '__module:global__';
 export const PATH_METADATA = 'path';
+export const PATH_PREFIX_METADATA = 'path:globalPrefix';
 export const PARAMTYPES_METADATA = 'design:paramtypes';
 export const SELF_DECLARED_DEPS_METADATA = 'self:paramtypes';
 export const OPTIONAL_DEPS_METADATA = 'optional:paramtypes';

packages/common/decorators/core/controller.decorator.ts

@@ -1,4 +1,8 @@
-import { PATH_METADATA, SCOPE_OPTIONS_METADATA } from '../../constants';
+import {
+  PATH_METADATA,
+  PATH_PREFIX_METADATA,
+  SCOPE_OPTIONS_METADATA,
+} from '../../constants';
 import { isString, isUndefined } from '../../utils/shared.utils';
 import { ScopeOptions } from '../../interfaces/scope-options.interface';
 
@@ -9,12 +13,22 @@ import { ScopeOptions } from '../../interfaces/scope-options.interface';
  */
 export interface ControllerOptions extends ScopeOptions {
   /**
-   * Specifies an optional `route path prefix`.  The prefix is pre-pended to the
+   * Specifies an optional `route path prefix`. The prefix is pre-pended to the
    * path specified in any request decorator in the class.
    *
    * @see [Routing](https://docs.nestjs.com/controllers#routing)
    */
   path?: string;
+
+  /**
+   * Specifies an optional setting for enabling/disabling the use of app's
+   * GlobalPrefix. In other words, a switch to remove the prefix set using
+   * `setGlobalPrefix()` only for this controller.
+   *
+   * @see [Routing](https://docs.nestjs.com/controllers#routing)
+   * @see [Global path prefix](https://docs.nestjs.com/faq/global-prefix)
+   */
+  useGlobalPrefix?: boolean;
 }
 
 /**
@@ -113,8 +127,10 @@ export function Controller(options: ControllerOptions): ClassDecorator;
  * - `scope` - symbol that determines the lifetime of a Controller instance.
  * [See Scope](https://docs.nestjs.com/fundamentals/injection-scopes#usage) for
  * more details.
- * - `prefix` - string that defines a `route path prefix`.  The prefix
+ * - `path` - string that defines a `route path prefix`. The prefix
  * is pre-pended to the path specified in any request decorator in the class.
+ * - `useGlobalPrefix` - a boolean value that enables/disables the setting done
+ * using `setGlobalPrefix()`.
  *
  * @see [Routing](https://docs.nestjs.com/controllers#routing)
  * @see [Controllers](https://docs.nestjs.com/controllers)
@@ -127,14 +143,22 @@ export function Controller(
   prefixOrOptions?: string | ControllerOptions,
 ): ClassDecorator {
   const defaultPath = '/';
-  const [path, scopeOptions] = isUndefined(prefixOrOptions)
-    ? [defaultPath, undefined]
+  const defaultUseGlobalPrefix = true;
+  const [path, useGlobalPrefix, scopeOptions] = isUndefined(prefixOrOptions)
+    ? [defaultPath, defaultUseGlobalPrefix, undefined]
     : isString(prefixOrOptions)
-    ? [prefixOrOptions, undefined]
-    : [prefixOrOptions.path || defaultPath, { scope: prefixOrOptions.scope }];
+    ? [prefixOrOptions, defaultUseGlobalPrefix, undefined]
+    : [
+        prefixOrOptions.path || defaultPath,
+        !isUndefined(prefixOrOptions)
+          ? Boolean(prefixOrOptions.useGlobalPrefix)
+          : defaultUseGlobalPrefix,
+        { scope: prefixOrOptions.scope },
+      ];
 
   return (target: object) => {
     Reflect.defineMetadata(PATH_METADATA, path, target);
     Reflect.defineMetadata(SCOPE_OPTIONS_METADATA, scopeOptions, target);
+    Reflect.defineMetadata(PATH_PREFIX_METADATA, useGlobalPrefix, target);
   };
 }

packages/core/router/router-explorer.ts

@@ -1,5 +1,9 @@
 import { HttpServer } from '@nestjs/common';
-import { METHOD_METADATA, PATH_METADATA } from '@nestjs/common/constants';
+import {
+  PATH_METADATA,
+  METHOD_METADATA,
+  PATH_PREFIX_METADATA,
+} from '@nestjs/common/constants';
 import { RequestMethod } from '@nestjs/common/enums/request-method.enum';
 import { Controller } from '@nestjs/common/interfaces/controllers/controller.interface';
 import { Type } from '@nestjs/common/interfaces/type.interface';
@@ -88,7 +92,8 @@ export class RouterExplorer {
     prefix?: string,
   ): string {
     let path = Reflect.getMetadata(PATH_METADATA, metatype);
-    if (prefix) path = prefix + this.validateRoutePath(path);
+    const usePrefix = Reflect.getMetadata(PATH_PREFIX_METADATA, metatype);
+    if (prefix && usePrefix) path = prefix + this.validateRoutePath(path);
     return this.validateRoutePath(path);
   }