Merge pull request #6 from Alpha018/fix/module

Alpha018 · web-flow · commit 86a7af8f0538 · 2025-10-09T16:05:24.000-03:00
refactor: reorganize unleash error handling and enhance decorator functionality
diff --git a/package.json b/package.json
@@ -5,6 +5,7 @@
   "author": "Tomás Alegre <tomas.sa467@gmail.com>",
   "readmeFilename": "README.md",
   "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "license": "MIT",
   "engines": {
     "node": ">=20"
diff --git a/src/error/exceptions/base.exception.spec.ts b/src/error/exceptions/base.exception.spec.ts
diff --git a/src/error/exceptions/base.exception.ts b/src/error/exceptions/base.exception.ts
diff --git a/src/error/exceptions/code/index.ts b/src/error/exceptions/code/index.ts
@@ -0,0 +1 @@
+export * from './unleash.code';
diff --git a/src/error/exceptions/code/unleash.code.ts b/src/error/exceptions/code/unleash.code.ts
@@ -1,4 +1,6 @@
 export enum UnleashErrorCode {
+  STRATEGY_INVALID_PARAMETER = 'STRATEGY_INVALID_PARAMETER',
+  STRATEGY_MISSING_PARAMETER = 'STRATEGY_MISSING_PARAMETER',
   UNEXPECTED_UNLEASH_ERROR = 'UNEXPECTED_UNLEASH_ERROR',
   NOT_FOUND_UNLEASH_ERROR = 'NOT_FOUND_UNLEASH_ERROR',
 }
diff --git a/src/error/exceptions/index.ts b/src/error/exceptions/index.ts
@@ -0,0 +1,3 @@
+export * from './base.exception';
+export * from './provider';
+export * from './code';
diff --git a/src/error/exceptions/provider/index.ts b/src/error/exceptions/provider/index.ts
@@ -0,0 +1 @@
+export * from './unleash.exceptions';
diff --git a/src/error/exceptions/provider/unleash.exceptions.spec.ts b/src/error/exceptions/provider/unleash.exceptions.spec.ts
@@ -1,7 +1,7 @@
 import { HttpStatus } from '@nestjs/common';
 
 import { UnexpectedUnleashException, NotFoundUnleashException } from './unleash.exceptions';
-import { UnleashErrorCode } from '../code/unleash.code';
+import { UnleashErrorCode } from '../code';
 
 describe('Unleash Exceptions', () => {
   describe('UnexpectedUnleashException', () => {
diff --git a/src/error/exceptions/provider/unleash.exceptions.ts b/src/error/exceptions/provider/unleash.exceptions.ts
@@ -1,7 +1,7 @@
 import { HttpStatus } from '@nestjs/common';
 
-import { UnleashErrorCode } from '../code/unleash.code';
 import { BaseException } from '../base.exception';
+import { UnleashErrorCode } from '../code';
 
 /**
  * Base exception for Unleash-related errors.
@@ -17,6 +17,24 @@ export class UnexpectedUnleashException extends UnleashException {
   static override readonly status = HttpStatus.INTERNAL_SERVER_ERROR;
 }
 
+/**
+ * Represents an error where a strategy parameter is missing.
+ */
+export class StrategyMissingParameterException extends UnleashException {
+  static override readonly code = UnleashErrorCode.STRATEGY_MISSING_PARAMETER;
+  static override readonly message = 'Strategy parameter is missing';
+  static override readonly status = HttpStatus.BAD_REQUEST;
+}
+
+/**
+ * Represents an error where a strategy parameter is invalid.
+ */
+export class StrategyInvalidParameterException extends UnleashException {
+  static override readonly code = UnleashErrorCode.STRATEGY_INVALID_PARAMETER;
+  static override readonly message = 'Strategy parameter is invalid';
+  static override readonly status = HttpStatus.BAD_REQUEST;
+}
+
 /**
  * Represents an error where a requested feature was not found in Unleash.
  */
diff --git a/src/index.ts b/src/index.ts
@@ -3,3 +3,4 @@ export * from './unleash/decorators/unleash.decorator';
 export * from './unleash/constant/unleash.constant';
 export * from './unleash/unleash-client.module';
 export * from './unleash/guards/unleash.guard';
+export * from './error/exceptions';
diff --git a/src/unleash/decorators/unleash.decorator.ts b/src/unleash/decorators/unleash.decorator.ts
@@ -1,10 +1,21 @@
-import { SetMetadata } from '@nestjs/common';
+import { applyDecorators, SetMetadata, UseGuards } from '@nestjs/common';
+import { Context } from 'unleash-client';
 
-export const UNLEASH_TOGGLE_KEY = 'UnleashToggle';
+import { UnleashGuard } from '../guards/unleash.guard';
+
+export const UNLEASH_TOGGLE_KEY = 'UnleashToggleName';
+export const UNLEASH_TOGGLE_CONTEXT = 'UnleashToggleContext';
 
 /**
  * Decorator that marks a route as being controlled by a feature toggle.
  *
- * @param {string} name - The name of the feature toggle to check.
+ * @param {string} toggleName - The name of the feature toggle to check.
+ * @param {Context} context - Additional Context of the feature toggle to check.
  */
-export const UnleashToggle = (name: string) => SetMetadata(UNLEASH_TOGGLE_KEY, name);
+export const UnleashToggle = (toggleName: string, context?: Context) => {
+  return applyDecorators(
+    SetMetadata(UNLEASH_TOGGLE_KEY, toggleName),
+    SetMetadata(UNLEASH_TOGGLE_CONTEXT, context),
+    UseGuards(UnleashGuard),
+  );
+};
diff --git a/src/unleash/guards/unleash.guard.spec.ts b/src/unleash/guards/unleash.guard.spec.ts
@@ -3,9 +3,9 @@ import { ExecutionContext } from '@nestjs/common';
 import { createMock } from '@golevelup/ts-jest';
 import { Reflector } from '@nestjs/core';
 
-import { UnexpectedUnleashException } from '../error-handler/exceptions/provider/unleash.exceptions';
 import { UnleashClientProvider } from '../provider/unleash-client.provider';
 import { UNLEASH_TOGGLE_KEY } from '../decorators/unleash.decorator';
+import { UnexpectedUnleashException } from '../../error/exceptions';
 import { UnleashGuard } from './unleash.guard';
 
 describe('UnleashGuard', () => {
@@ -41,21 +41,14 @@ describe('UnleashGuard', () => {
     expect(guard).toBeDefined();
   });
 
-  it('should return true when no toggle is required', () => {
-    const context = createMock<ExecutionContext>();
-    jest.spyOn(reflector, 'get').mockReturnValue(undefined);
-
-    expect(guard.canActivate(context)).toBe(true);
-  });
-
   it('should return true when toggle is enabled', () => {
     const context = createMock<ExecutionContext>();
     jest.spyOn(reflector, 'get').mockReturnValue('test-toggle');
     jest.spyOn(unleashClientProvider, 'isEnabled').mockReturnValue(true);
 
     expect(guard.canActivate(context)).toBe(true);
     expect(reflector.get).toHaveBeenCalledWith(UNLEASH_TOGGLE_KEY, context.getHandler());
-    expect(unleashClientProvider.isEnabled).toHaveBeenCalledWith('test-toggle');
+    expect(unleashClientProvider.isEnabled).toHaveBeenCalledWith('test-toggle', 'test-toggle');
   });
 
   it('should return false when toggle is disabled', () => {
diff --git a/src/unleash/guards/unleash.guard.ts b/src/unleash/guards/unleash.guard.ts
@@ -1,9 +1,10 @@
 import { ExecutionContext, CanActivate, Injectable } from '@nestjs/common';
 import { Reflector } from '@nestjs/core';
+import { Context } from 'unleash-client';
 
-import { UnexpectedUnleashException } from '../error-handler/exceptions/provider/unleash.exceptions';
+import { UNLEASH_TOGGLE_CONTEXT, UNLEASH_TOGGLE_KEY } from '../decorators/unleash.decorator';
 import { UnleashClientProvider } from '../provider/unleash-client.provider';
-import { UNLEASH_TOGGLE_KEY } from '../decorators/unleash.decorator';
+import { UnexpectedUnleashException } from '../../error/exceptions';
 
 @Injectable()
 export class UnleashGuard implements CanActivate {
@@ -26,18 +27,19 @@ export class UnleashGuard implements CanActivate {
    */
   canActivate(context: ExecutionContext): boolean {
     const toggleName = this.reflector.get<string>(UNLEASH_TOGGLE_KEY, context.getHandler());
+    const toggleContext: undefined | Context = this.reflector.get<Context>(
+      UNLEASH_TOGGLE_CONTEXT,
+      context.getHandler(),
+    );
 
-    if (!toggleName) {
-      return true;
-    }
+    let enableFeature: boolean;
 
-    let data: boolean;
     try {
-      data = this.unleashClientProvider.isEnabled(toggleName);
+      enableFeature = this.unleashClientProvider.isEnabled(toggleName, toggleContext);
     } catch {
       throw new UnexpectedUnleashException();
     }
 
-    return data;
+    return enableFeature;
   }
 }
diff --git a/src/unleash/provider/unleash-client.provider.ts b/src/unleash/provider/unleash-client.provider.ts
@@ -1,5 +1,6 @@
 import { OnModuleDestroy, OnModuleInit, Injectable, Logger } from '@nestjs/common';
 import { UnleashConfig, Unleash, Context } from 'unleash-client';
+import { FeatureInterface } from 'unleash-client/lib/feature';
 
 @Injectable()
 export class UnleashClientProvider implements OnModuleDestroy, OnModuleInit {
@@ -37,7 +38,7 @@ export class UnleashClientProvider implements OnModuleDestroy, OnModuleInit {
    * @param {string} toggleName - The name of the feature toggle to retrieve.
    * @returns {any} - The feature toggle definition.
    */
-  getFeatureToggleDefinition(toggleName: string) {
+  getFeatureToggleDefinition(toggleName: string): FeatureInterface | undefined {
     return this._unleashClient.getFeatureToggleDefinition(toggleName);
   }
 
diff --git a/src/unleash/unleash-client.module.ts b/src/unleash/unleash-client.module.ts
@@ -1,5 +1,5 @@
 import { FactoryProvider, DynamicModule, Provider, Module } from '@nestjs/common';
-import { APP_GUARD, Reflector } from '@nestjs/core';
+import { Reflector } from '@nestjs/core';
 
 import { UnleashClientConstructorInterface } from './interface/unleash-client-constructor.interface';
 import { UNLEASH_CLIENT_MODULE_OPTIONS, UNLEASH_CLIENT_CONFIG } from './constant/unleash.constant';
@@ -32,10 +32,6 @@ export class UnleashClientModule {
       inject: [UNLEASH_CLIENT_MODULE_OPTIONS],
       provide: UNLEASH_CLIENT_CONFIG,
     };
-    const reflectorProvider: FactoryProvider<Reflector> = {
-      useFactory: () => new Reflector(),
-      provide: Reflector,
-    };
 
     const providers: Provider[] = [
       ...this.createAsyncProviders(options),
@@ -45,17 +41,13 @@ export class UnleashClientModule {
         inject: [UNLEASH_CLIENT_MODULE_OPTIONS],
         provide: UnleashClientProvider,
       },
-      reflectorProvider,
+      Reflector,
       configProvider,
       UnleashGuard,
-      {
-        useClass: UnleashGuard,
-        provide: APP_GUARD,
-      },
     ];
 
     return {
-      exports: [UnleashClientProvider, UNLEASH_CLIENT_CONFIG],
+      exports: [UnleashClientProvider, UNLEASH_CLIENT_CONFIG, Reflector],
       imports: options.imports || [],
       module: UnleashClientModule,
       global: options.isGlobal,
@@ -85,14 +77,10 @@ export class UnleashClientModule {
       },
       Reflector,
       UnleashGuard,
-      {
-        useClass: UnleashGuard,
-        provide: APP_GUARD,
-      },
     ];
 
     return {
-      exports: [UnleashClientProvider, UNLEASH_CLIENT_CONFIG],
+      exports: [UnleashClientProvider, UNLEASH_CLIENT_CONFIG, Reflector],
       module: UnleashClientModule,
       global: config.isGlobal,
       providers,

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,6 @@`
`1`	`1`	`export enum UnleashErrorCode {`
	`2`	`+ STRATEGY_INVALID_PARAMETER = 'STRATEGY_INVALID_PARAMETER',`
	`3`	`+ STRATEGY_MISSING_PARAMETER = 'STRATEGY_MISSING_PARAMETER',`
`2`	`4`	`UNEXPECTED_UNLEASH_ERROR = 'UNEXPECTED_UNLEASH_ERROR',`
`3`	`5`	`NOT_FOUND_UNLEASH_ERROR = 'NOT_FOUND_UNLEASH_ERROR',`
`4`	`6`	`}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+export * from './base.exception';`
	`2`	`+export * from './provider';`
	`3`	`+export * from './code';`