update tests

Author: James Fox

src/Feature.spec.tsx

@@ -110,6 +110,30 @@ describe('<OptimizelyFeature>', () => {
       expect(component.text()).toBe('true|bar');
     });
 
+    it('should pass the values for clientReady and didTimeout', async () => {
+      const component = mount(
+        <OptimizelyProvider optimizely={optimizelyMock} timeout={200}>
+          <OptimizelyFeature feature="feature1" timeout={100}>
+            {(isEnabled, variables, clientReady, didTimeout) =>
+              `${isEnabled ? 'true' : 'false'}|${variables.foo}|${clientReady}|${didTimeout}`
+            }
+          </OptimizelyFeature>
+        </OptimizelyProvider>
+      );
+
+      // while it's waiting for onReady()
+      expect(component.text()).toBe('');
+      resolver.resolve({ success: true });
+
+      await optimizelyMock.onReady();
+
+      component.update();
+
+      expect(optimizelyMock.isFeatureEnabled).toHaveBeenCalledWith('feature1', undefined, undefined);
+      expect(optimizelyMock.getFeatureVariables).toHaveBeenCalledWith('feature1', undefined, undefined);
+      expect(component.text()).toBe('true|bar|true|false');
+    });
+
     it('should respect a locally passed timeout prop', async () => {
       const component = mount(
         <OptimizelyProvider optimizely={optimizelyMock} timeout={200}>
@@ -134,6 +158,28 @@ describe('<OptimizelyFeature>', () => {
       expect(component.text()).toBe('true|bar');
     });
 
+    it('should pass the override props through', async () => {
+      const component = mount(
+        <OptimizelyProvider optimizely={optimizelyMock} timeout={200}>
+          <OptimizelyFeature feature="feature1" overrideUserId="james123" overrideAttributes={{ betaUser: true }}>
+            {(isEnabled, variables) => `${isEnabled ? 'true' : 'false'}|${variables.foo}`}
+          </OptimizelyFeature>
+        </OptimizelyProvider>
+      );
+
+      // while it's waiting for onReady()
+      expect(component.text()).toBe('');
+      resolver.resolve({ success: true });
+
+      await optimizelyMock.onReady();
+
+      component.update();
+
+      expect(optimizelyMock.isFeatureEnabled).toHaveBeenCalledWith('feature1', 'james123', { betaUser: true });
+      expect(optimizelyMock.getFeatureVariables).toHaveBeenCalledWith('feature1', 'james123', { betaUser: true });
+      expect(component.text()).toBe('true|bar');
+    });
+
     describe(`when the "autoUpdate" prop is true`, () => {
       it('should update when the OPTIMIZELY_CONFIG_UPDATE handler is called', async () => {
         const component = mount(

src/Feature.tsx

@@ -26,10 +26,15 @@ export interface FeatureProps extends WithOptimizelyProps {
   autoUpdate?: boolean;
   overrideUserId?: string;
   overrideAttributes?: UserAttributes;
-  children: (isEnabled: boolean, variables: VariableValuesObject) => React.ReactNode;
+  children: (
+    isEnabled: boolean,
+    variables: VariableValuesObject,
+    clientReady: boolean,
+    didTimeout: boolean
+  ) => React.ReactNode;
 }
 
-const FeatureComponent = (props: FeatureProps): any => {
+const FeatureComponent: React.FunctionComponent<FeatureProps> = props => {
   const { feature, timeout, autoUpdate, children, overrideUserId, overrideAttributes } = props;
   const [isEnabled, variables, clientReady, didTimeout] = useFeature(
     feature,
@@ -42,7 +47,9 @@ const FeatureComponent = (props: FeatureProps): any => {
     return null;
   }
 
-  return children(isEnabled, variables);
+  // Wrap the return value here in a Fragment to please the HOC's expected React.ComponentType
+  // See https://github.com/DefinitelyTyped/DefinitelyTyped/issues/18051
+  return <>{children(isEnabled, variables, clientReady, didTimeout)}</>;
 };
 
 export const OptimizelyFeature = withOptimizely(FeatureComponent);

src/hooks.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 import { useCallback, useContext, useEffect, useState } from 'react';
-import * as optimizely from '@optimizely/optimizely-sdk';
+import { UserAttributes } from '@optimizely/optimizely-sdk';
 import { getLogger } from '@optimizely/js-sdk-logging';
 
 import { setupAutoUpdateListeners } from './autoUpdate';
@@ -38,7 +38,7 @@ type UseFeatureOptions = {
 
 type UseFeatureOverrides = {
   overrideUserId?: string;
-  overrideAttributes?: optimizely.UserAttributes;
+  overrideAttributes?: UserAttributes;
 };
 
 interface UseFeature {