test: add testing for HookFlagQuery (#922)

<!-- Please use this template for your pull request. -->
<!-- Please use the sections that you need and delete other sections -->

## This PR
<!-- add the description of the PR here -->

- introduces tests for `HookFlagQuery`

### Related Issues
<!-- add here the GitHub issue that this PR resolves if applicable -->

Resolves #915 

### Notes
Placed these tests within `evaluation.spec.tsx`, happy to move them into
their own file if more appropriate

---------

Signed-off-by: Rowan Heptinstall <[email protected]>
Signed-off-by: Rowan Heptinstall <[email protected]>
Signed-off-by: Todd Baert <[email protected]>
Co-authored-by: Todd Baert <[email protected]>

Author: ro1hep

packages/react/src/evaluation/hook-flag-query.ts

@@ -0,0 +1,56 @@
+import {
+  EvaluationDetails,
+  FlagValue,
+  StandardResolutionReasons
+} from '@openfeature/web-sdk';
+import { FlagQuery } from '../query';
+
+
+// FlagQuery implementation, do not export
+export class HookFlagQuery<T extends FlagValue = FlagValue> implements FlagQuery {
+  constructor(private _details: EvaluationDetails<T>) {}
+
+  get details() {
+    return this._details;
+  }
+
+  get value() {
+    return this._details?.value;
+  }
+
+  get variant() {
+    return this._details.variant;
+  }
+
+  get flagMetadata() {
+    return this._details.flagMetadata;
+  }
+
+  get reason() {
+    return this._details.reason;
+  }
+
+  get isError() {
+    return !!this._details?.errorCode || this._details.reason == StandardResolutionReasons.ERROR;
+  }
+
+  get errorCode() {
+    return this._details?.errorCode;
+  }
+
+  get errorMessage() {
+    return this._details?.errorMessage;
+  }
+
+  get isAuthoritative() {
+    return (
+      !this.isError &&
+      this._details.reason != StandardResolutionReasons.STALE &&
+      this._details.reason != StandardResolutionReasons.DISABLED
+    );
+  }
+
+  get type() {
+    return typeof this._details.value;
+  }
+}

packages/react/src/evaluation/use-feature-flag.ts

@@ -6,7 +6,6 @@ import {
   JsonValue,
   ProviderEvents,
   ProviderStatus,
-  StandardResolutionReasons
 } from '@openfeature/web-sdk';
 import { useEffect, useState } from 'react';
 import { DEFAULT_OPTIONS, ReactFlagEvaluationOptions, normalizeOptions } from '../common/options';
@@ -15,6 +14,7 @@ import { useProviderOptions } from '../provider/context';
 import { useOpenFeatureClient } from '../provider/use-open-feature-client';
 import { useOpenFeatureClientStatus } from '../provider/use-open-feature-client-status';
 import { FlagQuery } from '../query';
+import { HookFlagQuery } from './hook-flag-query';
 
 // This type is a bit wild-looking, but I think we need it.
 // We have to use the conditional, because otherwise useFlag('key', false) would return false, not boolean (too constrained).
@@ -298,52 +298,3 @@ function attachHandlersAndResolve<T extends FlagValue>(
 
   return evalutationDetails;
 }
-
-// FlagQuery implementation, do not export
-class HookFlagQuery<T extends FlagValue = FlagValue> implements FlagQuery {
-  constructor(private _details: EvaluationDetails<T>) {}
-
-  get details() {
-    return this._details;
-  }
-
-  get value() {
-    return this._details?.value;
-  }
-
-  get variant() {
-    return this._details.variant;
-  }
-
-  get flagMetadata() {
-    return this._details.flagMetadata;
-  }
-
-  get reason() {
-    return this._details.reason;
-  }
-
-  get isError() {
-    return !!this._details?.errorCode || this._details.reason == StandardResolutionReasons.ERROR;
-  }
-
-  get errorCode() {
-    return this._details?.errorCode;
-  }
-
-  get errorMessage() {
-    return this._details?.errorMessage;
-  }
-
-  get isAuthoritative() {
-    return (
-      !this.isError &&
-      this._details.reason != StandardResolutionReasons.STALE &&
-      this._details.reason != StandardResolutionReasons.DISABLED
-    );
-  }
-
-  get type() {
-    return typeof this._details.value;
-  }
-}

packages/react/test/evaluation.spec.tsx

@@ -4,6 +4,8 @@ import {
   InMemoryProvider,
   OpenFeature,
   StandardResolutionReasons,
+  EvaluationDetails,
+  ErrorCode,
 } from '@openfeature/web-sdk';
 import '@testing-library/jest-dom'; // see: https://testing-library.com/docs/react-testing-library/setup
 import { act, render, renderHook, screen, waitFor } from '@testing-library/react';
@@ -21,6 +23,7 @@ import {
   useStringFlagValue,
 } from '../src/';
 import { TestingProvider } from './test.utils';
+import { HookFlagQuery } from '../src/evaluation/hook-flag-query';
 import { startTransition, useState } from 'react';
 
 describe('evaluation', () => {
@@ -681,5 +684,82 @@ describe('evaluation', () => {
         );
       });
     });
+
+    describe('HookFlagQuery',  () => {
+      it('should return details', () => {
+        const details: EvaluationDetails<string> = {
+          flagKey: 'flag-key',
+          flagMetadata : {},
+          value: 'string'
+        };
+        const hookFlagQuery = new HookFlagQuery(details);
+        expect(hookFlagQuery.details).toEqual(details);
+      });
+
+      it('should return flag metadata', () => {
+        const flagMetadata = {
+          'ping': 'pong'
+        };
+        const details: EvaluationDetails<boolean> = {
+          flagKey: 'with-flagMetadata',
+          flagMetadata,
+          value: true,
+        };
+        const hookFlagQuery = new HookFlagQuery(details);
+        expect(hookFlagQuery.flagMetadata).toEqual(expect.objectContaining(flagMetadata));
+      });
+
+      it.each([
+        [{
+          flagKey: 'i-dont-exist',
+          flagMetadata: {},
+          errorMessage: 'no flag found with key i-dont-exist',
+          errorCode: ErrorCode.FLAG_NOT_FOUND,
+          value: true
+        }],
+        [{
+          flagKey: 'i-dont-exist',
+          flagMetadata: {},
+          errorMessage: 'no flag found with key i-dont-exist',
+          errorCode: undefined,
+          reason: StandardResolutionReasons.ERROR,
+          value: true
+        }],
+      ])('should return errors if reason is error or errorCode is set',(details) => {;
+        const hookFlagQuery = new HookFlagQuery(details);
+        expect(hookFlagQuery.isError).toEqual(true);
+        expect(hookFlagQuery.errorCode).toEqual(details.errorCode);
+        expect(hookFlagQuery.errorMessage).toEqual(details.errorMessage);
+      });
+
+      it.each([
+        [{
+          flagKey: 'isAuthorative-true',
+          flagMetadata : {},
+          value: 7,
+        }, true],
+        [{
+          flagKey: 'with-error',
+          flagMetadata : {},
+          value: 7,
+          errorCode: ErrorCode.FLAG_NOT_FOUND
+        }, false],
+        [{
+          flagKey: 'with-reason-stale',
+          flagMetadata : {},
+          value: 7,
+          reason: StandardResolutionReasons.STALE
+        }, false],
+        [{
+          flagKey: 'with-reason-disabled',
+          flagMetadata : {},
+          value: 7,
+          reason: StandardResolutionReasons.DISABLED
+        }, false],
+      ])('should return isAuthorative if Reason != STALE/DISABLED and errorCode unset',(details, expected) => {
+        const hookFlagQuery = new HookFlagQuery(details);
+        expect(hookFlagQuery.isAuthoritative).toEqual(expected);
+      });
+    });
   });
 });