prepare 2.25.2 release (#131)

LaunchDarklyReleaseBot · yusinto · bwoskow-ld · web-flow · commit 16376fe948e8 · 2022-04-15T14:43:49.000-07:00
* Initial commit * Delete extraneous files from lib. * Update initLDClient.test.ts * Update withLDProvider.tsx (#18) * update JS SDK dependency to 2.16.3 * use JS SDK 2.17.0 * improve tests to clarify which options we're passing in and which ones are added by the wrapper * set wrapperName to react-client-sdk * lint * Update withLDProvider.test.tsx * update JS SDK to 2.17.5 + a few dev dependency bumps (#21) * downgrade typescript to 3.8.3 (#22) * [Fixes for] Expose LDProvider as a standalone component (#31) * remove startsWith usage (#23) * Fix the broken build (#24) * Expose ld provider (#40) * Add tests for the LDProvider * Add LDProvider component * Add LDProvider to main export * Update provider tests * Remove unused EnhancedComponent * Abstract function to generate react options * add waitForUserToInitializeClient flag to Provider * rename to LDProvider.tsx * fix tests * remove async from componentDidMount * fixes from CR * add test * cleanup * update types for componentDidUpdate * await initLDClient Co-authored-by: Nicholas Mitchell <nicholas@netlify.com> Co-authored-by: Martin Heller <mheller@testo.de> * update to JS SDK 2.18.0 (adds disableSyncEventPost) (#25) * 45 fix providers to respect subscribed flags (#46) * Fixed asyncWithLDProvider.tsx and provider.tsx so that they only provide flag changes for subscribed flags. * Removed unused imports. * Addressed PR feedback. Fixed linting errors. Co-authored-by: Clay Embry <cembry@atlassian.com> * targetflags simplified logic (#26) * remove client-side ids from examples (#27) * update JS SDK to 2.18.1 * Fixing camelCaseKeys export (#44) * new js-common-sdk version (#30) * adding alias functionality (#31) * pin typedoc to unblock our releases (#32) * Removed the guides link * add inlineUsersToEvents to TypeScript defs by updating js-client-sdk (#33) * debugging * Fix linting errors * [ch103643] Fix examples to use local sdk * Remove unwanted changes. * Update package.json * Update yarn.lock * Update lock files. * Update package-lock.json * Update package-lock.json * Update package.json * Update link-dev.sh Co-authored-by: Ben Woskow <48036130+bwoskow-ld@users.noreply.github.com> * Update link-dev.sh * Update yarn.lock * Add react 17 peer dep (#61) * Update common JS SDK library to use fixes for debug event generation issues. (#36) * HOC static hoisting (#71) * Added a test for hoisting react statics in withLDProvider HOC * Fixed linting errors * Fixed more linting errors * update example app deps (#38) * Updated asyncWithLDProvider to fetch latest flag values when the Provider renders (#39) * Updated asyncWithLDProvider to fetch latest flag values when the Provider renders * Fixed linting * Updates docs URLs * fix: improve types of withLDProvider (#97) * [sc-107070] Include src for sourcemaps to work * [sc-127032] Omit deferInitialization from asyncWithLDProvider config * Removed and ignored lock files. * Update types.ts * Update typescript version (#44) * Update Makefile * Update Makefile * Deleting test-types.ts (#45) * [sc-132394] Add typedoc for AsyncProviderConfig (#47) Co-authored-by: Molly <molly.jones@launchdarkly.com> * Pass in client (#105) * [sc134057] Fix react sdk lint errors (#48) * remove custom TypeDoc build, use Releaser's standard logic (#49) * update js-client-sdk to 2.20.1 for localstorage error-handling fix and others * export more public symbols from entry point * [sc134364] Upgrade typescript, tslint and jest. (#50) Co-authored-by: Eli Bishop <eli@launchdarkly.com> * update js-client-sdk to 2.20.2 for sc-142333 fix (#53) * First commit. TODO: migrate enzyme to rtl. * Removed enzyme. Fixed prettier parentheses rule. * Fixed broken snapshot tests. Removed unused imports. * Update package.json Co-authored-by: Yusinto Ngadiman <yusinto@gmail.com> Co-authored-by: Ben Woskow <48036130+bwoskow-ld@users.noreply.github.com> Co-authored-by: Eli Bishop <eli@launchdarkly.com> Co-authored-by: LaunchDarklyCI <dev@launchdarkly.com> Co-authored-by: Martin Heller <github@technopolis.de> Co-authored-by: Ben Woskow <bwoskow@launchdarkly.com> Co-authored-by: bezreyhan <bezreyhan@gmail.com> Co-authored-by: Nicholas Mitchell <nicholas@netlify.com> Co-authored-by: Martin Heller <mheller@testo.de> Co-authored-by: clayembry <clayembry@yahoo.com> Co-authored-by: Clay Embry <cembry@atlassian.com> Co-authored-by: Jonathan Felchlin <jonathan@xgecko.com> Co-authored-by: Mac Lockard <maclockard@gmail.com> Co-authored-by: Gavin Whelan <gwhelan@launchdarkly.com> Co-authored-by: Nathan Waddell <45477581+NathanWaddell121107@users.noreply.github.com> Co-authored-by: Clifford Tawiah <ctawiah@launchdarkly.com> Co-authored-by: Cliff Tawiah <82856282+ctawiah@users.noreply.github.com> Co-authored-by: LaunchDarklyReleaseBot <launchdarklyreleasebot@launchdarkly.com> Co-authored-by: Ember Stevens <ember.stevens@launchdarkly.com> Co-authored-by: ember-stevens <79482775+ember-stevens@users.noreply.github.com> Co-authored-by: Derek Sifford <dereksifford@gmail.com> Co-authored-by: Jaz White <jwhite@launchdarkly.com> Co-authored-by: Molly <molly.jones@launchdarkly.com> Co-authored-by: Tim Lee <tim.lee@red-badger.com> Co-authored-by: Louis Chan <91093020+louis-launchdarkly@users.noreply.github.com> Co-authored-by: Louis Chan <lchan@launchdarkly.com>
diff --git a/.prettierrc b/.prettierrc
@@ -1,5 +1,6 @@
 {
   "singleQuote": true,
   "trailingComma": "all",
-  "printWidth": 120
+  "printWidth": 120,
+  "arrowParens": "always"
 }
diff --git a/package.json b/package.json
@@ -37,27 +37,24 @@
   },
   "homepage": "https://github.com/launchdarkly/react-client-sdk",
   "devDependencies": {
-    "@testing-library/jest-dom": "^5.16.1",
-    "@testing-library/react": "^12.1.2",
-    "@types/enzyme": "^3.10.3",
+    "@testing-library/jest-dom": "^5.16.4",
+    "@testing-library/react": "^13.0.1",
     "@types/hoist-non-react-statics": "^3.3.1",
     "@types/jest": "^27.0.3",
     "@types/lodash.camelcase": "^4.3.6",
     "@types/prop-types": "^15.7.4",
-    "@types/react": "^17.0.37",
-    "@types/react-dom": "^17.0.11",
-    "@types/react-test-renderer": "^17.0.1",
+    "@types/react": "^18.0.3",
+    "@types/react-dom": "^18.0.0",
+    "@types/react-test-renderer": "^18.0.0",
     "@types/uuid": "^3.4.5",
-    "enzyme": "^3.10.0",
-    "enzyme-adapter-react-16": "^1.14.0",
     "jest": "^27.4.4",
     "jest-environment-jsdom-global": "^3.0.0",
     "jest-junit": "^13.0.0",
     "prettier": "^1.18.2",
     "prop-types": "^15.7.2",
-    "react": "^17.0.0",
-    "react-dom": "^17.0.0",
-    "react-test-renderer": "^17.0.2",
+    "react": "^18.0.0",
+    "react-dom": "^18.0.0",
+    "react-test-renderer": "^18.0.0",
     "rimraf": "^3.0.0",
     "ts-jest": "^27.1.1",
     "tslint": "^6.1.3",
@@ -72,7 +69,7 @@
     "uuid": "^3.3.2"
   },
   "peerDependencies": {
-    "react": "^16.6.3 || ^17.0.0",
-    "react-dom": "^16.8.4 || ^17.0.0"
+    "react": "^16.6.3 || ^17.0.0 || ^18.0.0",
+    "react-dom": "^16.8.4 || ^17.0.0 || ^18.0.0"
   }
 }
diff --git a/setupTests.js b/setupTests.js
@@ -1,5 +1 @@
-const enzyme = require('enzyme');
-const Adapter = require('enzyme-adapter-react-16');
 require('@testing-library/jest-dom/extend-expect');
-
-enzyme.configure({ adapter: new Adapter() });
diff --git a/src/asyncWithLDProvider.test.tsx b/src/asyncWithLDProvider.test.tsx
@@ -30,7 +30,7 @@ const renderWithConfig = async (config: AsyncProviderConfig) => {
 
   const { getByText } = render(
     <LDProvider>
-      <Consumer>{value => <span>Received: {JSON.stringify(value.flags)}</span>}</Consumer>
+      <Consumer>{(value) => <span>Received: {JSON.stringify(value.flags)}</span>}</Consumer>
     </LDProvider>,
   );
 
diff --git a/src/asyncWithLDProvider.tsx b/src/asyncWithLDProvider.tsx
@@ -1,4 +1,4 @@
-import React, { useState, useEffect, FunctionComponent } from 'react';
+import React, { useState, useEffect, ReactNode } from 'react';
 import { LDFlagSet, LDFlagChangeset } from 'launchdarkly-js-client-sdk';
 import { AsyncProviderConfig, defaultReactOptions } from './types';
 import { Provider } from './context';
@@ -34,7 +34,7 @@ export default async function asyncWithLDProvider(config: AsyncProviderConfig) {
   const reactOptions = { ...defaultReactOptions, ...userReactOptions };
   const { ldClient } = await initLDClient(clientSideID, user, reactOptions, options, targetFlags);
 
-  const LDProvider: FunctionComponent = ({ children }) => {
+  const LDProvider = ({ children }: { children: ReactNode }) => {
     const [ldData, setLDData] = useState({
       flags: fetchFlags(ldClient, reactOptions, targetFlags),
       ldClient,
@@ -45,14 +45,14 @@ export default async function asyncWithLDProvider(config: AsyncProviderConfig) {
         const { bootstrap } = options;
         if (bootstrap && bootstrap !== 'localStorage') {
           const bootstrappedFlags = reactOptions.useCamelCaseFlagKeys ? camelCaseKeys(bootstrap) : bootstrap;
-          setLDData(prev => ({ ...prev, flags: bootstrappedFlags }));
+          setLDData((prev) => ({ ...prev, flags: bootstrappedFlags }));
         }
       }
 
       ldClient.on('change', (changes: LDFlagChangeset) => {
         const flattened: LDFlagSet = getFlattenedFlagsFromChangeset(changes, targetFlags, reactOptions);
         if (Object.keys(flattened).length > 0) {
-          setLDData(prev => ({ ...prev, flags: { ...prev.flags, ...flattened } }));
+          setLDData((prev) => ({ ...prev, flags: { ...prev.flags, ...flattened } }));
         }
       });
     }, []);
diff --git a/src/initLDClient.ts b/src/initLDClient.ts
@@ -25,7 +25,7 @@ const initLDClient = async (
   const allOptions = { wrapperName: 'react-client-sdk', wrapperVersion: version, ...options };
   const ldClient = ldClientInitialize(clientSideID, user, allOptions);
 
-  return new Promise<AllFlagsLDClient>(resolve => {
+  return new Promise<AllFlagsLDClient>((resolve) => {
     ldClient.on('ready', () => {
       const flags = fetchFlags(ldClient, reactOptions, targetFlags);
       resolve({ flags, ldClient });
diff --git a/src/provider.test.tsx b/src/provider.test.tsx
@@ -1,9 +1,8 @@
 jest.mock('./initLDClient', () => jest.fn());
 jest.mock('./context', () => ({ Provider: 'Provider' }));
 
-import * as React from 'react';
+import React, { Component } from 'react';
 import { create } from 'react-test-renderer';
-import { shallow } from 'enzyme';
 import { LDClient, LDFlagChangeset, LDFlagSet, LDOptions, LDUser } from 'launchdarkly-js-client-sdk';
 import initLDClient from './initLDClient';
 import { LDReactOptions, EnhancedComponent, defaultReactOptions, ProviderConfig } from './types';
@@ -80,7 +79,7 @@ describe('LDProvider', () => {
     const user1: LDUser = { key: 'yus', name: 'yus ng' };
     const user2: LDUser = { key: 'launch', name: 'darkly' };
     const options: LDOptions = { bootstrap: {} };
-    const ldClient: Promise<LDClient> = new Promise(async resolve => {
+    const ldClient: Promise<LDClient> = new Promise(async (resolve) => {
       resolve((await initLDClient(clientSideID, user1, defaultReactOptions, options, undefined)).ldClient);
 
       return;
@@ -101,7 +100,7 @@ describe('LDProvider', () => {
   test('ld client is created if passed in promise resolves as undefined', async () => {
     const user: LDUser = { key: 'yus', name: 'yus ng' };
     const options: LDOptions = { bootstrap: {} };
-    const ldClient: Promise<undefined> = new Promise(async resolve => {
+    const ldClient: Promise<undefined> = new Promise(async (resolve) => {
       resolve(undefined);
 
       return;
@@ -129,8 +128,8 @@ describe('LDProvider', () => {
         <App />
       </LDProvider>
     );
-    const component = shallow(LaunchDarklyApp, { disableLifecycleMethods: true });
-    const initialState = component.state() as HocState;
+    const component = create(LaunchDarklyApp).toTree()?.instance as Component;
+    const initialState = component.state as HocState;
 
     expect(initialState.flags).toEqual({});
   });
@@ -154,8 +153,8 @@ describe('LDProvider', () => {
         <App />
       </LDProvider>
     );
-    const component = shallow(LaunchDarklyApp, { disableLifecycleMethods: true });
-    const initialState = component.state() as HocState;
+    const component = create(LaunchDarklyApp).toTree()?.instance as Component;
+    const initialState = component.state as HocState;
 
     expect(mockInitLDClient).not.toHaveBeenCalled();
     expect(initialState.flags).toEqual({ testFlag: true, anotherTestFlag: false });
@@ -178,8 +177,8 @@ describe('LDProvider', () => {
         <App />
       </LDProvider>
     );
-    const component = shallow(LaunchDarklyApp, { disableLifecycleMethods: true });
-    const initialState = component.state() as HocState;
+    const component = create(LaunchDarklyApp).toTree()?.instance as Component;
+    const initialState = component.state as HocState;
 
     expect(mockInitLDClient).not.toHaveBeenCalled();
     expect(initialState.flags).toEqual({ 'test-flag': true, 'another-test-flag': false });
@@ -200,8 +199,8 @@ describe('LDProvider', () => {
         <App />
       </LDProvider>
     );
-    const component = shallow(LaunchDarklyApp, { disableLifecycleMethods: true });
-    const initialState = component.state() as HocState;
+    const component = create(LaunchDarklyApp).toTree()?.instance as Component;
+    const initialState = component.state as HocState;
 
     expect(mockInitLDClient).not.toHaveBeenCalled();
     expect(initialState.flags).toEqual({ testFlag: true, anotherTestFlag: false });
@@ -221,8 +220,8 @@ describe('LDProvider', () => {
         <App />
       </LDProvider>
     );
-    const component = shallow(LaunchDarklyApp, { disableLifecycleMethods: true });
-    const initialState = component.state() as HocState;
+    const component = create(LaunchDarklyApp).toTree()?.instance as Component;
+    const initialState = component.state as HocState;
 
     expect(mockInitLDClient).not.toHaveBeenCalled();
     expect(initialState.flags).toEqual({ testFlag: true, anotherTestFlag: false });
@@ -239,8 +238,8 @@ describe('LDProvider', () => {
         <App />
       </LDProvider>
     );
-    const component = shallow(LaunchDarklyApp, { disableLifecycleMethods: true });
-    const initialState = component.state() as HocState;
+    const component = create(LaunchDarklyApp).toTree()?.instance as Component;
+    const initialState = component.state as HocState;
 
     expect(mockInitLDClient).not.toHaveBeenCalled();
     expect(initialState.flags).toEqual({});
diff --git a/src/provider.tsx b/src/provider.tsx
@@ -1,4 +1,4 @@
-import * as React from 'react';
+import React, { Component, PropsWithChildren } from 'react';
 import { LDClient, LDFlagSet, LDFlagChangeset } from 'launchdarkly-js-client-sdk';
 import { EnhancedComponent, ProviderConfig, defaultReactOptions } from './types';
 import { Provider, LDContext as HocState } from './context';
@@ -22,7 +22,7 @@ import { camelCaseKeys, fetchFlags, getFlattenedFlagsFromChangeset } from './uti
  * within your application. This provider is used inside the `withLDProviderHOC` and can be used instead to initialize
  * the `launchdarkly-js-client-sdk`. For async initialization, check out the `asyncWithLDProvider` function
  */
-class LDProvider extends React.Component<ProviderConfig, HocState> implements EnhancedComponent {
+class LDProvider extends Component<PropsWithChildren<ProviderConfig>, HocState> implements EnhancedComponent {
   readonly state: Readonly<HocState>;
 
   constructor(props: ProviderConfig) {

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"singleQuote": true,`
`3`	`3`	`"trailingComma": "all",`
`4`		`- "printWidth": 120`
	`4`	`+ "printWidth": 120,`
	`5`	`+ "arrowParens": "always"`
`5`	`6`	`}`