fix: update docs for context definition on RequireFlagsEnabledProps. add tests with targeting rules defined for the InMemoryProvider

Signed-off-by: Kaushal Kapasi <[email protected]>

Author: kaushalkapasi

packages/nest/src/require-flags-enabled.decorator.ts

@@ -33,7 +33,7 @@ interface RequireFlagsEnabledProps {
   domain?: string;
 
   /**
-   * Global {@link EvaluationContext} for OpenFeature.
+   * The {@link EvaluationContext} for evaluating the feature flag.
    * @see {@link OpenFeature#setContext}
    */
   context?: EvaluationContext;

packages/nest/test/fixtures.ts

@@ -1,4 +1,5 @@
 import { InMemoryProvider } from '@openfeature/server-sdk';
+import type { EvaluationContext } from '@openfeature/server-sdk';
 import type { ExecutionContext } from '@nestjs/common';
 import { OpenFeatureModule } from '../src';
 
@@ -27,6 +28,12 @@ export const defaultProvider = new InMemoryProvider({
     defaultVariant: 'default',
     variants: { default: false, enabled: true },
     disabled: false,
+    contextEvaluator: (ctx: EvaluationContext) => {
+      if (ctx.targetingKey === '123') {
+        return 'enabled';
+      }
+      return 'default';
+    },
   },
 });
 

packages/nest/test/open-feature-sdk.spec.ts

@@ -149,10 +149,6 @@ describe('OpenFeature SDK', () => {
         });
 
         it('should throw a custom exception if the flag is disabled with context', async () => {
-          jest.spyOn(defaultProvider, 'resolveBooleanEvaluation').mockResolvedValueOnce({
-            value: false,
-            reason: 'DISABLED',
-          });
           await supertest(app.getHttpServer())
             .get('/flags-enabled-custom-exception-with-context')
             .set('x-user-id', '123')
@@ -161,21 +157,24 @@ describe('OpenFeature SDK', () => {
       });
 
       describe('OpenFeatureControllerRequireFlagsEnabled', () => {
-        it('should allow access to the RequireFlagsEnabled controller', async () => {
-          // Only mock the first flag evaluation for Flag with key `testBooleanFlag2`, the second flag evaluation will use the default variation for flag with key `testBooleanFlag`
-          jest.spyOn(defaultProvider, 'resolveBooleanEvaluation').mockResolvedValueOnce({
-            value: true,
-            reason: 'TARGETING_MATCH',
-          });
-          await supertest(app.getHttpServer()).get('/require-flags-enabled').expect(200).expect('Hello, world!');
+        it('should allow access to the RequireFlagsEnabled controller with global context interceptor', async () => {
+          await supertest(app.getHttpServer())
+            .get('/require-flags-enabled')
+            .set('x-user-id', '123')
+            .expect(200)
+            .expect('Hello, world!');
+        });
+
+        it('should throw a 403 - Forbidden exception if user does not match targeting requirements', async () => {
+          await supertest(app.getHttpServer()).get('/require-flags-enabled').set('x-user-id', 'not-123').expect(403);
         });
 
-        it('should throw a 403 - Forbidden exception if the flag is disabled', async () => {
+        it('should throw a 403 - Forbidden exception if one of the flags is disabled', async () => {
           jest.spyOn(defaultProvider, 'resolveBooleanEvaluation').mockResolvedValueOnce({
             value: false,
             reason: 'DISABLED',
           });
-          await supertest(app.getHttpServer()).get('/require-flags-enabled').expect(403);
+          await supertest(app.getHttpServer()).get('/require-flags-enabled').set('x-user-id', '123').expect(403);
         });
       });
     });

packages/nest/test/test-app.ts

@@ -110,7 +110,7 @@ export class OpenFeatureController {
   }
 
   @RequireFlagsEnabled({
-    flags: [{ flagKey: 'testBooleanFlag' }],
+    flags: [{ flagKey: 'testBooleanFlag2' }],
     exception: new ForbiddenException(),
     context: {
       targetingKey: 'user-id',
@@ -150,7 +150,7 @@ export class OpenFeatureContextScopedController {
 
 @Controller('require-flags-enabled')
 @RequireFlagsEnabled({
-  flags: [{ flagKey: 'testBooleanFlag2', defaultValue: true }, { flagKey: 'testBooleanFlag' }],
+  flags: [{ flagKey: 'testBooleanFlag', defaultValue: false }, { flagKey: 'testBooleanFlag2' }],
   exception: new ForbiddenException(),
 })
 export class OpenFeatureRequireFlagsEnabledController {