This repository was archived by the owner on Oct 29, 2024. It is now read-only.
Releases: launchdarkly/react-native-client-sdk
Releases · launchdarkly/react-native-client-sdk
6.1.1
[6.1.1] - 2022-03-18
Fixed:
- iOS: Fixed race condition in
LDSwiftEventSourcethat could cause a crash if the stream is explicitly stopped (such as whenidentifyis called) while the stream is waiting to reconnect.
6.1.0
[6.1.0] - 2022-02-25
Added:
- Added
privateAttributeNamesconfiguration option forLDConfigallowing the configuration of private attributes for all users. (#102)
Fixed:
6.0.0
[6.0.0] - 2022-02-10
Added:
- Expanded supported versions of React Native to include 0.65, 0.66, and 0.67 releases.
- Added a manual testing application to the repository.
- Extensive testing of build configurations in CI to allow quicker validation of compatibility against multiple React Native releases and XCode versions.
Changed:
- iOS: The native
podspecfor iOS has been renamed to fix automatic linking. Updating may require removing references to the oldpodspec.
Fixed:
- iOS: Fixed an issue that prevented using
jsonVariationandjsonVariationDetailwith array default values. (#112)
Removed:
- Support for React Native 0.63.
5.1.1
[5.1.1] - 2022-01-21
Changed:
- The
keyproperty onLDUserobjects is now optional, if it is not provided the SDK will automatically generate a key and mark the user as anonymous. See the API documentation for more details. - Updated native Android and iOS SDK to the 3.1.2 release and 5.4.4 release respectively.
Fixed:
- Android: Removed reference of
jcenterfrom the Gradle build to reflect the shutdown of the JCenter artifact repository. - iOS:
isOfflinehas been corrected to no longer returntruewhen online andfalsewhen offline. - iOS: Fixed memory leak when stream connections are terminated caused by the native server sent events implementation.
5.1.0
[5.1.0] - 2021-09-30
Added:
- Added the
inlineUsersInEventsconfiguration option which can be used to configure the SDK to include full user details in all analytics events.
Changed:
- Restored compatibility with React Native 0.63, this version of the SDK can be used with either 0.63 or 0.64 React Native releases.
Fixed:
- Added missing TypeScript definition for
autoAliasingOptOutconfiguration field. - Fixed an outdated
LDClient#isInitializeddescription (thanks, christophby!)
5.0.1
[5.0.1] - 2021-09-03
Fixed:
- Android: Fixed an inconsistency in the argument type given to all flags listeners. On Android the callback was given a string with a JSON representation of an array of strings, rather than an actual array of strings. (Thanks, rodperottoni!) (#89)
- Android: Fixed runtime crashes caused by code shrinking when compiling with Proguard/R8. The SDK now specifies consumer Proguard rules for Android SDK methods accessed with runtime reflection.
- Android: Removed the
android:allowBackuptag from the SDK'sAndroidManifest.xmlfile to avoid requiring applications to explicitly replace the tag if given a different value. (#138) - Android: Changed the SDK's network detection check to consider network transport over a VPN as a connected state. This fixes an issue where the SDK would prevent network requests on a VPN due to considering the network to be unavailable. (Thanks, lguipeng!)
5.0.0
[5.0.0] - 2021-08-20
Added:
- The SDK now supports the ability to control the proportion of traffic allocation to an experiment. This works in conjunction with a new platform feature now available to early access customers.
- Added
numberVariationandnumberVariationDetailto LDClient. - Added the
aliasmethod to LDClient. This can be used to associate two user objects for analytics purposes with an alias event. - Added the
autoAliasingOptOutconfiguration option. This can be used to control the new automatic aliasing behavior of theidentifymethod; by settingautoAliasingOptOutto true,identifywill not automatically generate alias events. - Improved testing of JavaScript wrapper using mock native modules.
Changed (requirements/dependencies/build):
- iOS: The underlying SDK version has been updated from 5.4.1 to 5.4.3. See the release notes for details.
- Android: The underlying SDK version has been updated from 2.14.1 to 3.1.0. See the release notes for details.
- Android: Migrated from using the Android Support Libraries to using AndroidX from Jetpack.
- Android: The minimum API version has been raised from API level 16 (Android 4.1 Jelly Bean) to API level 21 (Android 5.0 Lollipop).
- Android: The SDK no longer has a dependency on Google Play Services. This dependency was only used on pre-21 Android API levels to improve TLS 1.2 compatibility, as the minimum Android version has been raised to 21, the dependency is no longer necessary.
- Android: The SDK is now built with modern Gradle (6.7, Android plugin 4.1.3) and uses Java 8.
Changed (API/behavioral):
- The
LDClient.identifymethod 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. This behavior can be disabled with theautoAliasingOptOutconfiguration option. - The
LDClient<type>Variationand<type>VariationDetailmethods (e.g.boolVariation) now validate that default values are the correct type. If the default value fails validation thePromisewill be rejected. - The primitive variation methods,
LDClient.boolVariation,LDClient.boolVariationDetail,LDClient.numberVariation, andLDClient.numberVariationDetail, now require a default value parameter (rather than being optional). If missing, thePromisewill be rejected. - Android:
LDClient.allFlagswill no longer convertStringflags into JSONArrays orObjects when the value can be parsed into JSONArrays orObjects. - Android: For compatibility with older SDK behavior, the
LDClient.stringVariationmethod could be used to retrieve JSON flags in a serialized representation. This compatibility behavior has been removed, and attempts to request a JSON valued flag using stringVariation will behave the same as other mismatched type variation calls. - Android: All log messages are now tagged
LaunchDarklySdkfor easier filtering. Thanks to @valeriyo for the suggestion (#113). - Android: The when the
countryuser is set, the SDK will no longer attempt to look up the country from the providedString(attempting to match it as an ISO-3166-1 alpha-2, alpha-3 code; or a country name) and set the country to the resultant IOS-3166-1 alpha-2 only if successful. The SDK no longer gives this attribute special behavior, and sets the user's country attribute directly as the providedString. - Android: If the
debugModeconfiguration option is set totrue, the SDK will now enable detailed timber logging. - Android: Custom user attributes that are
Objects will no longer be ignored. - Android: Elements of
Arraycustom user attributes will no longer be ignored if they are notStrings orNumbers. - Android:
Arraycustom user attributes with mixed types will no longer ignore non-Stringelements.
Fixed (Android):
- Catch
SecurityExceptionwhen thrown on call togetNetworkCapabilitiesused to detect current network availability. (#129) - Explicitly flag
PendingIntents asFLAG_IMMUTABLEon Android SDK versions that support doing so. Explicitly specifying mutability is required when targeting Android S+. (#133) - Increased the compile-time dependency on
jackson-databindto 2.10.5.1, due to CVE-2020-25649. - Update the dependency on the shared launchdarkly/java-sdk-common to 1.1.2 to prevent Jackson from showing up as a transitive dependency in tools that inspect module metadata.
- The Android manifest has been updated to explicitly specify the
android:exportedattribute on declaredreceiverelements. This is to meet new requirements in the upcoming Android 12 release. - Fixed an issue where the SDK could log error level messages when attempting to send diagnostic events without an internet connection. The SDK will no longer attempt to send diagnostic events when an internet connection is known to be unavailable, and will not log an error level message if the connection fails. Thanks to @valeriyo for reporting (#107).
- Fixed an issue where flags listeners would be informed of changes to unchanged flags whenever the SDK receives an entire flag set (on a new stream connection, a poll request, or any stream updates behind a relay proxy).
- Fixed an issue where a
NullPointerExceptionis thrown ifLDClient.close()is called multiple times. - Improved the proguard/R8 configuration to allow more optimization. Thanks to @valeriyo for requesting (#106)
- Fixed a potential issue where the SDK could cause additional throttling on requests to the backend service when previously throttled requests had been cancelled before completion.
Fixed (iOS):
- Fixed an issue where
304 NOT_MODIFIEDresponses to SDK polling mode requests would be considered error responses. This could cause the completion on aidentifyrequest to not complete, and gave erroneous connection information data and logging output. - Fixed a crash when attempting to cache flag data containing variation JSON values containing a JSON
nullvalue nested within a JSON array. - Avoid crash when timeout/interval configuration options are set to sufficiently large values. This was caused when converting these values to an
Intvalue of milliseconds. (Thanks, @delannoyk!) - Update
Quicktest dependency to 3.1.2 to avoid build warnings and adopt security fixes. (#243) - Use
AnyObjectoverclassin protocol inheritance to avoid compiler warnings. (#247)
Removed:
LDClient.intVariationandLDClient.floatVariation. Please useLDClient.numberVariationinstead.LDClient.intVariationDetailandLDClient.floatVariationDetail. Please useLDClient.numberVariationDetailinstead.
4.2.2
4.0.4
4.2.1
[4.2.1] - 2021-06-01
Fixed:
- iOS: Fixed an issue where an exception was thrown when calling
LDClient.configurewith an optionaltimeout(#80). - iOS: Improved consistency with Android for
LDClient.isInitialized. Both implementations will now reject the promise if the client has not been configured. - iOS: Avoid exceptions on iOS when certain methods are called after
LDClient.close. (Thanks, andvalsol)! (#75) - Android: Fixed an issue where the promise for
LDClient.configurecould be resolved before the client had finished initializing when not providing the optionaltimeoutparameter. - Android: Fixed an issue where
LDClient.allFlagswould reject the promise when the client was configured but not yet initialized, rather than resolving with any cached flags.