react-client-sdk

[2.22.3] - 2021-06-09

Fixed:

• Events for the LaunchDarkly debugger are now properly pre-processed to omit private user attributes, as well as enforce only expected top level attributes are sent.
• Events for the LaunchDarkly debugger now include the index of the variation responsible for the evaluation result.

[2.22.2] - 2021-04-06

Changed:

• Updated the SDK's peer dependencies so that it can run in an application with React 17 (thanks, maclockard!)

[2.22.1] - 2021-04-02

Fixed:

• The property LDOptions.inlineUsersInEvents was not included in the TypeScript definitions for the JavaScript SDK.

[2.22.0] - 2021-01-27

Added:

• Added the alias method to LDClient. This method can be used to associate two user objects for analytics purposes. When invoked, this method will queue a new alias event to be sent to LaunchDarkly.
• Added the autoAliasingOptOut configuration option. This can be used to control the new automatic aliasing behavior of the identify method; by passing autoAliasingOptOut: true, identify will not automatically generate alias events.

Changed:

• LDClient's identify method will now automatically generate an alias event when switching from an anonymous to a known user. This event associates the two users for analytics purposes as they most likely represent a single person.

[2.21.0] - 2020-11-17

Fixed:

• The camelCaseKeys utility function is now exported as a function instead of as an object containing a camelCaseKeys function. camelCaseKeys.camelCaseKeys remains for backwards compatibility.
• Updated the LDEvaluationDetail.reason type definition to be nullable. This value will be null when LDOptions.evaluationReasons is false.

Deprecated:

• camelCaseKeys.camelCaseKeys is now deprecated-- see the note above.

[2.20.2] - 2020-09-14

Fixed:

• In streaming mode, when connecting to the Relay Proxy rather than directly to the LaunchDarkly streaming service, if the current user was changed twice within a short time it was possible for the SDK to revert to flag values from the previous user. (Fixed in JS SDK 2.18.1)

[2.20.1] - 2020-08-19

Fixed:

• Fixed an issue where change listeners would update the component state when any flag was modified, even if the client instance was configured such that it was not subscribed for the modified flag. (Thanks, clayembry!)

[2.20.0] - 2020-07-17

Changed:

• Updated launchdarkly-js-client-sdk version to 2.18.0, which adds the disable-sync-event-post option.

[2.19.0] - 2020-07-15

Added:

• Exposed LDProvider as a standalone component. (Thanks, nimi and morton!)
• A new configuration option, deferInitialization, allows LDClient initialization to be deferred until the user object is defined. (Thanks, bezreyhan!)

Fixed:

• Removed uses of String.startsWith that caused errors in Internet Explorer unless a polyfill for that function was present.

[2.18.2] - 2020-05-27

Fixed:

• Fixed a TypeError where TypeScript attempted to redefine the default property on withLDProvider. This issue was introduced in version 2.18.1 of this SDK. (#36)

[2.18.1] - 2020-05-19

Fixed:

• Updated JS SDK version to 2.17.5, to pick up bug fixes in 2.17.5, 2.17.4, 2.17.3, 2.17.2, and 2.17.1. The intended practice is to release a new React SDK patch every time there is a JS SDK patch (unless several JS SDK patches are released very close together), but this had fallen behind.

[2.18.0] - 2020-02-19

Note: if you are using the LaunchDarkly Relay Proxy to forward events, update the Relay to version 5.10.0 or later before updating to this React SDK version.

Added:

• The SDK now periodically sends diagnostic data to LaunchDarkly, describing the version and configuration of the SDK, the architecture and version of the runtime platform, and performance statistics. No credentials, hostnames, or other identifiable values are included. This behavior can be disabled with the diagnosticOptOut option, or configured with diagnosticRecordingInterval.

Fixed:

• Updated JS SDK dependency version to 2.17.0, which includes a fix for streaming mode failing when used with secure mode. See release notes for JS SDK 2.17.0 fror details.

[2.17.1] - 2020-02-11

Fixed:

• Updated JS SDK dependency version from 2.16.0 to 2.16.3 for several recent fixes. See release notes for 2.16.1, 2.16.2, 2.16.3.

Note that while some transitive dependencies have been changed from exact versions to "best compatible" versions, the dependency on js-client-sdk is still an exact version dependency so that each release of react-client-sdk has well-defined behavior.

[2.17.0] - 2019-12-18

Added:

• The camelCaseKeys utility function is now exposed as part of the SDK API. This function can be called from customers' code to work around the fact that ldClient functionality does not automatically camel-case keys in the same manner as the React SDK's props and hooks features.

[2.16.2] - 2019-12-17

Fixed:

• Turned off the default setting of the wrapperName property because the LaunchDarkly service does not support it yet; it was causing CORS errors.

[2.16.1] - 2019-12-17

The 2.16.0 release was unpublished due to a packaging error. This is a rerelease containing the same changes but fixing the packaging.

Added:

• Configuration property eventCapacity: the maximum number of analytics events (not counting evaluation counters) that can be held at once, to prevent the SDK from consuming unexpected amounts of memory in case an application generates events unusually rapidly. In JavaScript code this would not normally be an issue, since the SDK flushes events every two seconds by default, but you may wish to increase this value if you will intentionally be generating a high volume of custom or identify events. The default value is 100.
• Configuration properties wrapperName and wrapperVersion: used by the React SDK to identify a JS SDK instance that is being used with a wrapper API.

Changed:

• The SDK now logs a warning if any configuration property has an inappropriate type, such as baseUri:3 or sendEvents:"no" (normally not possible in TypeScript, but could happen if an arbitrary object is cast to LDOptions). For boolean properties, the SDK will still interpret the value in terms of truthiness, which was the previous behavior. For all other types, since there's no such commonly accepted way to coerce the type, it will fall back to the default setting for that property; previously, the behavior was undefined but most such mistakes would have caused the SDK to throw an exception at some later point.

Fixed:

• When calling identify, the current user (as reported by getUser()) was being updated before the SDK had received the new flag values for that user, causing the client to be temporarily in an inconsistent state where flag evaluations would be associated with the wrong user in analytics events. Now, the current-user state will stay in sync with the flags and change only when they have finished changing. (Thanks, edvinerikson!)

Deprecated:

• The samplingInterval configuration property was deprecated in the code in the previous minor version release, and in the changelog, but the deprecation notice was accidentally omitted from the documentation comments. It is hereby deprecated again.

[2.16.0] - 2019-12-16

This release was broken and has been removed.

[2.15.1] - 2019-11-14

Fixed:

• Fixed a bug where, when bootstrapping flag data, subsequent flag changes were incorrectly applied to the original bootstrapped data instead of the latest known flag data.
• Fixed browser warnings and errors in the sample application.

[2.15.0] - 2019-11-06

Changed:

• Changed the behavior of the warning message that is logged on failing to establish a streaming connection. Rather than the current behavior where the warning message appears upon each failed attempt, it will now only appear on the first failure in each series of attempts. Also, the message has been changed to mention that retries will occur. (#182)

Fixed:

• The beforeunload event handler no longer calls close on the client, which was causing the SDK to become unusable if the page did not actually close after this event fired (for instance if the browser navigated to a URL that launched an external application, or if another beforeunload handler cancelled leaving the page). Instead, it now only flushes events. There is also an unload handler that flushes any additional events that might have been created by any code that ran during the beforeunload stage. (#181)
• Removed uses of Object.assign that caused errors in Internet Explorer unless a polyfill for that function was present. These were removed earlier in the 2.1.1 release, but had been mistakenly added again.
• Removed development dependency on typedoc which caused some vulnerability warnings.

Deprecated:

• The samplingInterval configuration property is deprecated and will be removed in a future version. The intended use case for the samplingInterval feature was to reduce analytics event network usage in high-traffic applications. This feature is being deprecated in favor of summary counters, which are meant to track all events.

[2.14.0] - 2019-09-12

Added:

• TypeDoc-generated documentation for all public types and methods is now online.
• The asyncWithLDProvider function to allow for your flags and the LDClient to be ready for use at the beginning of your app's lifecycle.

Changed:

• The launchdarkly-react-client-sdk package has been moved from the js-client-sdk monorepo into its own repository. All subsequent releases will be made from this new repository.