Merge branch 'update_version_overwriting' into add_hooks

Author: EmilianoSanchez

.eslintrc.js

@@ -35,6 +35,9 @@ module.exports = {
     '@typescript-eslint/no-explicit-any': 'off',
     '@typescript-eslint/no-non-null-assertion': 'off',
     '@typescript-eslint/no-unused-vars': ['warn', { 'argsIgnorePattern': '^_' }],
+    'prefer-const': ['error', {
+      'destructuring': 'all'
+    }]
   },
   'overrides': [{
     'files': ['src/**/*.ts', 'src/**/*.tsx'],

.github/CODEOWNERS

@@ -0,0 +1 @@
+* @splitio/sdk

src/SplitFactory.tsx

@@ -2,7 +2,7 @@ import React from 'react';
 
 import { SplitComponent } from './SplitClient';
 import { ISplitFactoryProps } from './types';
-import { VERSION, WARN_SF_CONFIG_AND_FACTORY, ERROR_SF_NO_CONFIG_AND_FACTORY } from './constants';
+import { WARN_SF_CONFIG_AND_FACTORY, ERROR_SF_NO_CONFIG_AND_FACTORY } from './constants';
 import { getSplitFactory, destroySplitFactory, IFactoryWithClients } from './utils';
 
 /**
@@ -46,8 +46,6 @@ class SplitFactory extends React.Component<ISplitFactoryProps, { factory: SplitI
       factory = propFactory;
     } else {
       if (config) {
-        // Don't try this at home. Used to overwrite the settings version when we create our own factory.
-        (config as any).version = VERSION;
         // We use an idempotent variant of the Split factory builder (i.e., given the same config, it returns the same already
         // created instance), since React component constructors is part of render-phase and can be invoked multiple times.
         factory = getSplitFactory(config);

src/__tests__/SplitClient.test.tsx

@@ -1,5 +1,5 @@
 import React from 'react';
-import { render, RenderResult, act } from '@testing-library/react';
+import { render, act } from '@testing-library/react';
 
 /** Mocks and test utils */
 import { mockSdk, Event, assertNoListeners, clientListenerCount } from './testUtils/mockSplitSdk';
@@ -263,8 +263,7 @@ describe('SplitClient', () => {
   test(`passes a new client if re-rendered with a different splitKey.
         Only updates the state if the new client triggers an event, but not the previous one.`, (done) => {
     const outerFactory = SplitSdk(sdkBrowser);
-    let renderTimes = 0; // eslint-disable-next-line prefer-const
-    let wrapper: RenderResult;
+    let renderTimes = 0;
 
     class InnerComponent extends React.Component<any, { splitKey: string }> {
 
@@ -294,6 +293,7 @@ describe('SplitClient', () => {
                           expect(renderTimes).toBe(6);
 
                           // check that outerFactory's clients have no event listeners
+                          // eslint-disable-next-line no-use-before-define
                           wrapper.unmount();
                           assertNoListeners(outerFactory);
                           done();
@@ -352,7 +352,7 @@ describe('SplitClient', () => {
       }
     }
 
-    wrapper = render(
+    const wrapper = render(
       <SplitFactory factory={outerFactory} >
         <InnerComponent />
       </SplitFactory>);

src/__tests__/testUtils/mockSplitSdk.ts

@@ -108,7 +108,7 @@ function mockClient(_key: SplitIO.SplitKey, _trafficType?: string) {
 
 export function mockSdk() {
 
-  return jest.fn((config: SplitIO.IBrowserSettings) => {
+  return jest.fn((config: SplitIO.IBrowserSettings, __updateModules) => {
 
     // Manager
     const names: jest.Mock = jest.fn().mockReturnValue([]);
@@ -134,6 +134,8 @@ export function mockSdk() {
       }, config),
     };
 
+    if (__updateModules) __updateModules(factory);
+
     return factory;
   });
 

src/useClientAndContext.ts

@@ -13,7 +13,7 @@ import { getSplitSharedClient, checkHooks, initAttributes, IClientWithContext }
 export function useClientAndContext(key?: SplitIO.SplitKey, trafficType?: string, attributes?: SplitIO.Attributes): ISplitContextValues {
   if (!checkHooks(ERROR_UC_NO_USECONTEXT)) return INITIAL_CONTEXT;
 
-  const context = React.useContext(SplitContext); // eslint-disable-next-line prefer-const
+  const context = React.useContext(SplitContext);
   let { factory, client } = context;
   if (key && factory) {
     client = getSplitSharedClient(factory, key, trafficType, attributes);

src/utils.ts

@@ -1,5 +1,6 @@
 import React from 'react';
 import { SplitFactory as SplitSdk } from '@splitsoftware/splitio/client';
+import { VERSION } from './constants';
 
 // Utils used to access singleton instances of Split factories and clients, and to gracefully shutdown all clients together.
 
@@ -31,7 +32,10 @@ export const __factories: Map<SplitIO.IBrowserSettings, IFactoryWithClients> = n
 export function getSplitFactory(config: SplitIO.IBrowserSettings): IFactoryWithClients {
   if (!__factories.has(config)) {
     // SplitSDK is not an idempotent operation
-    const newFactory = SplitSdk(config) as IFactoryWithClients;
+    // @ts-expect-error. 2nd param is not part of type definitions. Used to overwrite the SDK version
+    const newFactory = SplitSdk(config, (modules) => {
+      modules.settings.version = VERSION;
+    }) as IFactoryWithClients;
     newFactory.sharedClientInstances = new Set();
     newFactory.config = config;
     __factories.set(config, newFactory);

types/SplitTreatments.d.ts

@@ -7,9 +7,9 @@ import { ISplitTreatmentsProps } from './types';
  * @see {@link https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK#get-treatments-with-configurations}
  */
 declare class SplitTreatments extends React.Component<ISplitTreatmentsProps> {
-  private logWarning?;
-  private evaluateFeatureFlags;
-  render(): JSX.Element;
-  componentDidMount(): void;
+    private logWarning?;
+    private evaluateFeatureFlags;
+    render(): JSX.Element;
+    componentDidMount(): void;
 }
 export default SplitTreatments;