feat: support metadata (go feature flag provider) (#410)

Signed-off-by: Thomas Poignant <[email protected]>
Co-authored-by: Todd Baert <[email protected]>

Author: thomaspoignant

libs/providers/go-feature-flag/package.json

@@ -6,6 +6,6 @@
     "current-version": "echo $npm_package_version"
   },
   "peerDependencies": {
-    "@openfeature/js-sdk": "^1.0.0"
+    "@openfeature/js-sdk": "^1.3.0"
   }
 }

libs/providers/go-feature-flag/src/lib/go-feature-flag-provider.spec.ts

@@ -625,5 +625,37 @@ describe('GoFeatureFlagProvider', () => {
           } as ResolutionDetails<object>);
         });
     });
+    it('should return metadata associated to the flag', async () => {
+      const flagName = 'random-flag';
+      const targetingKey = 'user-key';
+      const dns = `${endpoint}v1/feature/${flagName}/eval`;
+
+      axiosMock.onPost(dns).reply(200, {
+        value: true,
+        variationType: 'trueVariation',
+        reason: StandardResolutionReasons.TARGETING_MATCH,
+        failed: false,
+        trackEvents: true,
+        version: '1.0.0',
+        metadata: {
+          description: 'a description of the flag',
+          issue_number: 1,
+        }
+      } as GoFeatureFlagProxyResponse<boolean>);
+
+      await goff
+        .resolveBooleanEvaluation(flagName, false, { targetingKey })
+        .then((res) => {
+          expect(res).toEqual({
+            reason: StandardResolutionReasons.TARGETING_MATCH,
+            value: true,
+            variant: 'trueVariation',
+            flagMetadata: {
+              description: 'a description of the flag',
+              issue_number: 1,
+            }
+          } as ResolutionDetails<boolean>);
+        });
+    });
   });
 });

libs/providers/go-feature-flag/src/lib/go-feature-flag-provider.ts

@@ -8,7 +8,7 @@ import {
   StandardResolutionReasons,
   TypeMismatchError,
 } from '@openfeature/js-sdk';
-import axios, { AxiosRequestConfig } from 'axios';
+import axios from 'axios';
 import { transformContext } from './context-transformer';
 import { ProxyNotReady } from './errors/proxyNotReady';
 import { ProxyTimeout } from './errors/proxyTimeout';
@@ -55,7 +55,7 @@ export class GoFeatureFlagProvider implements Provider {
    * @throws {ProxyTimeout} When the HTTP call is timing out
    * @throws {UnknownError} When an unknown error occurs
    * @throws {TypeMismatchError} When the type of the variation is not the one expected
-   * @throws {FlagNotFoundError} When the flag does not exists
+   * @throws {FlagNotFoundError} When the flag does not exist
    */
   async resolveBooleanEvaluation(
     flagKey: string,
@@ -80,7 +80,7 @@ export class GoFeatureFlagProvider implements Provider {
    * @throws {ProxyTimeout} When the HTTP call is timing out
    * @throws {UnknownError} When an unknown error occurs
    * @throws {TypeMismatchError} When the type of the variation is not the one expected
-   * @throws {FlagNotFoundError} When the flag does not exists
+   * @throws {FlagNotFoundError} When the flag does not exist
    */
   async resolveStringEvaluation(
     flagKey: string,
@@ -105,7 +105,7 @@ export class GoFeatureFlagProvider implements Provider {
    * @throws {ProxyTimeout} When the HTTP call is timing out
    * @throws {UnknownError} When an unknown error occurs
    * @throws {TypeMismatchError} When the type of the variation is not the one expected
-   * @throws {FlagNotFoundError} When the flag does not exists
+   * @throws {FlagNotFoundError} When the flag does not exist
    */
   async resolveNumberEvaluation(
     flagKey: string,
@@ -130,7 +130,7 @@ export class GoFeatureFlagProvider implements Provider {
    * @throws {ProxyTimeout} When the HTTP call is timing out
    * @throws {UnknownError} When an unknown error occurs
    * @throws {TypeMismatchError} When the type of the variation is not the one expected
-   * @throws {FlagNotFoundError} When the flag does not exists
+   * @throws {FlagNotFoundError} When the flag does not exist
    */
   async resolveObjectEvaluation<U extends JsonValue>(
     flagKey: string,
@@ -227,15 +227,16 @@ export class GoFeatureFlagProvider implements Provider {
 
     // Case of the flag is disabled
     if (apiResponseData.reason === StandardResolutionReasons.DISABLED) {
-      // we don't set a variant since we are using the default value and we are not able to know
+      // we don't set a variant since we are using the default value, and we are not able to know
       // which variant it is.
       return { value: defaultValue, reason: apiResponseData.reason };
     }
 
     const sdkResponse: ResolutionDetails<T> = {
       value: apiResponseData.value,
       variant: apiResponseData.variationType,
-      reason: apiResponseData.reason?.toString() || 'UNKNOWN'
+      reason: apiResponseData.reason?.toString() || 'UNKNOWN',
+      flagMetadata: apiResponseData.metadata || undefined,
     };
     if (Object.values(ErrorCode).includes(apiResponseData.errorCode as ErrorCode)) {
       sdkResponse.errorCode = ErrorCode[apiResponseData.errorCode as ErrorCode];

libs/providers/go-feature-flag/src/lib/model.ts

@@ -37,6 +37,7 @@ export interface GoFeatureFlagProxyResponse<T> {
   variationType: string;
   version?: string;
   reason: string | GOFeatureFlagResolutionReasons;
+  metadata: Record<string, string | number | boolean>;
   errorCode?: ErrorCode | GOFeatureFlagErrorCode;
 }
 

package-lock.json

@@ -38,7 +38,7 @@
     "@nx/rollup": "16.2.2",
     "@nx/web": "16.2.2",
     "@nx/workspace": "16.2.2",
-    "@openfeature/js-sdk": "^1.1.0",
+    "@openfeature/js-sdk": "^1.3.1",
     "@swc-node/register": "~1.6.0",
     "@swc/cli": "~0.1.62",
     "@swc/core": "~1.3.51",