feat(nestjs)!: add domains (#831)

lukas-reining · beeme1mr · web-flow · commit 840d7acaa372 · 2024-02-25T12:01:55.000Z
## This PR  - adds support for domains - removes named clients ### Related Issues  relates to open-feature/spec#229 --------- Signed-off-by: Lukas Reining <lukas.reining@codecentric.de> Co-authored-by: Michael Beemer <beeme1mr@users.noreply.github.com>
diff --git a/packages/nest/README.md b/packages/nest/README.md
@@ -126,7 +126,7 @@ export class OpenFeatureController {
 }
 ```
 
-It is also possible to inject the default or named OpenFeature clients into a service via Nest dependency injection system.
+It is also possible to inject the default or domain scoped OpenFeature clients into a service via Nest dependency injection system.
 
 ```ts
 import { Injectable } from '@nestjs/common';
@@ -136,7 +136,7 @@ import { FeatureClient, Client } from '@openfeature/nestjs-sdk';
 export class OpenFeatureTestService {
   constructor(
     @FeatureClient() private defaultClient: Client,
-    @FeatureClient({ name: 'differentProvider' }) private namedClient: Client,
+    @FeatureClient({ domain: 'my-domain' }) private scopedClient: Client,
   ) {}
 
   public async getBoolean() {
diff --git a/packages/nest/src/feature.decorator.ts b/packages/nest/src/feature.decorator.ts
@@ -15,28 +15,28 @@ import { from, Observable } from 'rxjs';
  */
 interface FeatureClientProps {
   /**
-   * The name of the OpenFeature client, if a named client should be used.
+   * The domain of the OpenFeature client, if a domain scoped client should be used.
    * @see {@link Client.getBooleanDetails}
    */
-  name?: string;
+  domain?: string;
 }
 
 /**
  * Injects a feature client into a constructor or property of a class.
  * @param {FeatureClientProps} [props] The options for injecting the client.
  * @returns {PropertyDecorator & ParameterDecorator} The decorator function.
  */
-export const FeatureClient = (props?: FeatureClientProps) => Inject(getOpenFeatureClientToken(props?.name));
+export const FeatureClient = (props?: FeatureClientProps) => Inject(getOpenFeatureClientToken(props?.domain));
 
 /**
  * Options for injecting a feature flag into a route handler.
  */
 interface FeatureProps<T extends FlagValue> {
   /**
-   * The name of the OpenFeature client, if a named client should be used.
+   * The domain of the OpenFeature client, if a domain scoped client should be used.
    * @see {@link OpenFeature#getClient}
    */
-  clientName?: string;
+  domain?: string;
   /**
    * The key of the feature flag.
    * @see {@link Client#getBooleanDetails}
@@ -55,19 +55,19 @@ interface FeatureProps<T extends FlagValue> {
 }
 
 /**
- * Returns a named or unnamed OpenFeature client with the given context.
- * @param {string} clientName The name of the OpenFeature client.
+ * Returns a domain scoped or the default OpenFeature client with the given context.
+ * @param {string} clientDomain The domain of the OpenFeature client.
  * @param {EvaluationContext} context The evaluation context of the client.
  * @returns {Client} The OpenFeature client.
  */
-function getClientForEvaluation(clientName?: string, context?: EvaluationContext) {
-  return clientName ? OpenFeature.getClient(clientName, context) : OpenFeature.getClient(context);
+function getClientForEvaluation(domain?: string, context?: EvaluationContext) {
+  return domain ? OpenFeature.getClient(domain, context) : OpenFeature.getClient(context);
 }
 
 /**
  * Route handler parameter decorator.
  *
- * Gets the {@link EvaluationDetails} for given feature flag from a named or unnamed OpenFeature
+ * Gets the {@link EvaluationDetails} for given feature flag from a domain scoped or the default OpenFeature
  * client and populates the annotated parameter with the {@link EvaluationDetails} wrapped in an {@link Observable}.
  *
  * For example:
@@ -82,16 +82,16 @@ function getClientForEvaluation(clientName?: string, context?: EvaluationContext
  * @returns {ParameterDecorator}
  */
 export const BooleanFeatureFlag = createParamDecorator(
-  ({ clientName, flagKey, defaultValue, context }: FeatureProps<boolean>): Observable<EvaluationDetails<boolean>> => {
-    const client = getClientForEvaluation(clientName, context);
+  ({ domain, flagKey, defaultValue, context }: FeatureProps<boolean>): Observable<EvaluationDetails<boolean>> => {
+    const client = getClientForEvaluation(domain, context);
     return from(client.getBooleanDetails(flagKey, defaultValue));
   },
 );
 
 /**
  * Route handler parameter decorator.
  *
- * Gets the {@link EvaluationDetails} for given feature flag from a named or unnamed OpenFeature
+ * Gets the {@link EvaluationDetails} for given feature flag from a domain scoped or the default OpenFeature
  * client and populates the annotated parameter with the {@link EvaluationDetails} wrapped in an {@link Observable}.
  *
  * For example:
@@ -106,16 +106,16 @@ export const BooleanFeatureFlag = createParamDecorator(
  * @returns {ParameterDecorator}
  */
 export const StringFeatureFlag = createParamDecorator(
-  ({ clientName, flagKey, defaultValue, context }: FeatureProps<string>): Observable<EvaluationDetails<string>> => {
-    const client = getClientForEvaluation(clientName, context);
+  ({ domain, flagKey, defaultValue, context }: FeatureProps<string>): Observable<EvaluationDetails<string>> => {
+    const client = getClientForEvaluation(domain, context);
     return from(client.getStringDetails(flagKey, defaultValue));
   },
 );
 
 /**
  * Route handler parameter decorator.
  *
- * Gets the {@link EvaluationDetails} for given feature flag from a named or unnamed OpenFeature
+ * Gets the {@link EvaluationDetails} for given feature flag from a domain scoped or the default OpenFeature
  * client and populates the annotated parameter with the {@link EvaluationDetails} wrapped in an {@link Observable}.
  *
  * For example:
@@ -130,16 +130,16 @@ export const StringFeatureFlag = createParamDecorator(
  * @returns {ParameterDecorator}
  */
 export const NumberFeatureFlag = createParamDecorator(
-  ({ clientName, flagKey, defaultValue, context }: FeatureProps<number>): Observable<EvaluationDetails<number>> => {
-    const client = getClientForEvaluation(clientName, context);
+  ({ domain, flagKey, defaultValue, context }: FeatureProps<number>): Observable<EvaluationDetails<number>> => {
+    const client = getClientForEvaluation(domain, context);
     return from(client.getNumberDetails(flagKey, defaultValue));
   },
 );
 
 /**
  * Route handler parameter decorator.
  *
- * Gets the {@link EvaluationDetails} for given feature flag from a named or unnamed OpenFeature
+ * Gets the {@link EvaluationDetails} for given feature flag from a domain scoped or the default OpenFeature
  * client and populates the annotated parameter with the {@link EvaluationDetails} wrapped in an {@link Observable}.
  *
  * For example:
@@ -154,13 +154,8 @@ export const NumberFeatureFlag = createParamDecorator(
  * @returns {ParameterDecorator}
  */
 export const ObjectFeatureFlag = createParamDecorator(
-  ({
-    clientName,
-    flagKey,
-    defaultValue,
-    context,
-  }: FeatureProps<JsonValue>): Observable<EvaluationDetails<JsonValue>> => {
-    const client = getClientForEvaluation(clientName, context);
+  ({ domain, flagKey, defaultValue, context }: FeatureProps<JsonValue>): Observable<EvaluationDetails<JsonValue>> => {
+    const client = getClientForEvaluation(domain, context);
     return from(client.getObjectDetails(flagKey, defaultValue));
   },
 );
diff --git a/packages/nest/src/open-feature.module.ts b/packages/nest/src/open-feature.module.ts
@@ -55,11 +55,11 @@ export class OpenFeatureModule {
     }
 
     if (options?.providers) {
-      Object.entries(options.providers).forEach(([name, provider]) => {
-        OpenFeature.setProvider(name, provider);
+      Object.entries(options.providers).forEach(([domain, provider]) => {
+        OpenFeature.setProvider(domain, provider);
         clientValueProviders.push({
-          provide: getOpenFeatureClientToken(name),
-          useFactory: () => OpenFeature.getClient(name),
+          provide: getOpenFeatureClientToken(domain),
+          useFactory: () => OpenFeature.getClient(domain),
         });
       });
     }
@@ -100,11 +100,11 @@ export interface OpenFeatureModuleOptions {
    */
   defaultProvider?: Provider;
   /**
-   * Named providers to set to OpenFeature.
+   * Domain scoped providers to set to OpenFeature.
    * @see {@link OpenFeature#setProvider}
    */
   providers?: {
-    [providerName: string]: Provider;
+    [domain: string]: Provider;
   };
   /**
    * Global {@link Logger} for OpenFeature.
@@ -149,10 +149,10 @@ export interface OpenFeatureModuleOptions {
 }
 
 /**
- * Returns an injection token for a (named) OpenFeature client.
- * @param {string} name The name of the OpenFeature client.
+ * Returns an injection token for a (domain scoped) OpenFeature client.
+ * @param {string} domain The domain of the OpenFeature client.
  * @returns {Client} The injection token.
  */
-export function getOpenFeatureClientToken(name?: string): string {
-  return name ? `OpenFeatureClient_${name}` : 'OpenFeatureClient_default';
+export function getOpenFeatureClientToken(domain?: string): string {
+  return domain ? `OpenFeatureClient_${domain}` : 'OpenFeatureClient_default';
 }
diff --git a/packages/nest/test/fixtures.ts b/packages/nest/test/fixtures.ts
@@ -25,17 +25,16 @@ export const defaultProvider = new InMemoryProvider({
   },
 });
 
-
 export const providers = {
-  namedClient: new InMemoryProvider({
+  domainScopedClient: new InMemoryProvider({
     testBooleanFlag: {
       defaultVariant: 'default',
       variants: { default: true },
       disabled: false,
     },
     testStringFlag: {
       defaultVariant: 'default',
-      variants: { default: 'expected-string-value-named' },
+      variants: { default: 'expected-string-value-scoped' },
       disabled: false,
     },
     testNumberFlag: {
@@ -45,13 +44,12 @@ export const providers = {
     },
     testObjectFlag: {
       defaultVariant: 'default',
-      variants: { default: { client: 'named' } },
+      variants: { default: { client: 'scoped' } },
       disabled: false,
     },
   }),
 };
 
-
 export const exampleContextFactory = async (context: ExecutionContext) => {
   const request = await context.switchToHttp().getRequest();
 
@@ -70,6 +68,6 @@ export const getOpenFeatureDefaultTestModule = () => {
   return OpenFeatureModule.forRoot({
     contextFactory: exampleContextFactory,
     defaultProvider,
-    providers
+    providers,
   });
 };
diff --git a/packages/nest/test/open-feature-sdk.spec.ts b/packages/nest/test/open-feature-sdk.spec.ts
@@ -35,9 +35,9 @@ describe('OpenFeature SDK', () => {
           'expected-string-value-default',
         );
 
-        expect(testService.namedClient).toBeDefined();
-        expect(await testService.namedClient.getStringValue('testStringFlag', 'wrong-value')).toEqual(
-          'expected-string-value-named',
+        expect(testService.domainScopedClient).toBeDefined();
+        expect(await testService.domainScopedClient.getStringValue('testStringFlag', 'wrong-value')).toEqual(
+          'expected-string-value-scoped',
         );
       });
     });
diff --git a/packages/nest/test/open-feature.module.spec.ts b/packages/nest/test/open-feature.module.spec.ts
@@ -42,10 +42,10 @@ describe('OpenFeatureModule', () => {
       expect(await client.getStringValue('testStringFlag', '')).toEqual('expected-string-value-default');
     });
 
-    it('should inject the client with the given name', async () => {
-      const client = moduleRef.get<OpenFeatureClient>(getOpenFeatureClientToken('namedClient'));
+    it('should inject the client with the given scope', async () => {
+      const client = moduleRef.get<OpenFeatureClient>(getOpenFeatureClientToken('domainScopedClient'));
       expect(client).toBeDefined();
-      expect(await client.getStringValue('testStringFlag', '')).toEqual('expected-string-value-named');
+      expect(await client.getStringValue('testStringFlag', '')).toEqual('expected-string-value-scoped');
     });
   });
 
diff --git a/packages/nest/test/test-app.ts b/packages/nest/test/test-app.ts
@@ -8,7 +8,7 @@ import { EvaluationContextInterceptor } from '../src';
 export class OpenFeatureTestService {
   constructor(
     @FeatureClient() public defaultClient: OpenFeatureClient,
-    @FeatureClient({ name: 'namedClient' }) public namedClient: OpenFeatureClient,
+    @FeatureClient({ domain: 'domainScopedClient' }) public domainScopedClient: OpenFeatureClient,
   ) {}
 
   public async serviceMethod(flag: EvaluationDetails<FlagValue>) {
