prepare 5.1.0 release

.circleci/config.yml

@@ -1,6 +1,9 @@
-version: 2
+version: 2.1
 jobs:
   android:
+    parameters:
+      hello-app-branch:
+        type: string
     docker:
       - image: circleci/android@sha256:9d2e4571898fd9b1dc97bfb9da942aaeea46859eb5b1e4cfc85a44c42733643c
     environment:
@@ -26,7 +29,7 @@ jobs:
           no_output_timeout: 20m
       - run: sudo npm install -g react-native-cli
       - run: cd .. && git clone https://github.com/launchdarkly/hello-react-native.git
-      - run: cd ../hello-react-native && npm install
+      - run: cd ../hello-react-native && git checkout <<parameters.hello-app-branch>> && npm install
       - run: cp -r ../project/ ../hello-react-native/node_modules/launchdarkly-react-native-client-sdk/
       - run: circle-android wait-for-boot
       - run: 
@@ -35,6 +38,9 @@ jobs:
           timeout: 1200
 
   ios:
+    parameters:
+      hello-app-branch:
+        type: string
     macos:
       xcode: "11.4"
     steps:
@@ -43,14 +49,14 @@ jobs:
       - run: xcrun simctl create rn-ios com.apple.CoreSimulator.SimDeviceType.iPhone-X com.apple.CoreSimulator.SimRuntime.iOS-12-2
       - run: xcrun simctl boot rn-ios
       - run: cd .. && git clone https://github.com/launchdarkly/hello-react-native.git
-      - run: cd ../hello-react-native && npm install
+      - run: cd ../hello-react-native && git checkout <<parameters.hello-app-branch>> && npm install
       - run: sudo npm install -g react-native-cli
       - run: cp -r ../project/ ../hello-react-native/node_modules/launchdarkly-react-native-client-sdk/
       # Newer cocoapods required for following pod install
       - run: sudo gem install cocoapods
       # RN 0.64 has an issue with embedding absolute paths in the cocoapods generated build files, so must regenerate.
       # https://github.com/facebook/react-native/issues/31121
-      - run: cd ../hello-react-native/ios && pod install
+      - run: cd ../hello-react-native/ios && pod update && pod install
       - run: cd ../hello-react-native && react-native run-ios --configuration Release --simulator rn-ios
 
   common:
@@ -77,8 +83,23 @@ workflows:
     jobs:
       - common
       - android:
+          name: Android + RN 0.63
+          hello-app-branch: rn-0.63
           requires:
             - common
       - ios:
+          name: iOS + RN 0.63
+          hello-app-branch: rn-0.63
           requires:
             - common
+      - android:
+          name: Android + RN 0.64
+          hello-app-branch: rn-0.64
+          requires:
+            - common
+      - ios:
+          name: iOS + RN 0.64
+          hello-app-branch: rn-0.64
+          requires:
+            - common
+

CHANGELOG.md

@@ -80,7 +80,7 @@ All notable changes to the LaunchDarkly React Native SDK will be documented in t
 
 ## [4.2.0] - 2021-05-19
 ### Added:
-- `LDUser` now has an optional `secondary` attribute to match other LaunchDarkly SDKs. For more on the behavior of this attribute see [the documentation on targeting users](https://docs.launchdarkly.com/home/managing-flags/targeting-users).
+- `LDUser` now has an optional `secondary` attribute to match other LaunchDarkly SDKs. For more on the behavior of this attribute see [the documentation on targeting users](https://docs.launchdarkly.com/home/flags/targeting-users).
 - Support for multiple LaunchDarkly projects or environments. Each set of feature flags associated with a mobile key is called an environment. ([#10](https://github.com/launchdarkly/react-native-client-sdk/issues/10))
   - `secondaryMobileKeys` is now a config option which allows a mapping of names to the SDK keys for each additional environment. `mobileKey` is still required, and represents the primary environment.
   - Many methods including variations, track, and listeners now support an optional `environment` parameter to evaluate the method against the given `environment`.

README.md

@@ -14,13 +14,13 @@ LaunchDarkly overview
 Supported versions
 -------------------------
 
-This SDK is currently compatible with React Native 0.64.x and Xcode 12 and is tested in Android 30 and iOS 14. Earlier versions of this SDK are compatible with prior versions of React Native, Android, and iOS.
+This SDK is currently compatible with React Native 0.63.x - 0.64.x and Xcode 12 and is tested in Android 30 and iOS 14. Earlier versions of this SDK are compatible with prior versions of React Native, Android, and iOS.
 
-| SDK version     | React Native version |
-|-----------------|----------------------|
-| 4.1.x - current | 0.64.x               |
-| 3.2.x - 4.0.x   | 0.63.x               |
-| 3.1.x           | 0.62.x               |
+| SDK version                      | React Native version |
+|----------------------------------|----------------------|
+| 4.1.x - current                  | 0.64.x               |
+| 5.1.0 - current<br>3.2.x - 4.0.x | 0.63.x               |
+| 3.1.x                            | 0.62.x               |
 
 Getting started
 ---------------
@@ -50,7 +50,7 @@ About LaunchDarkly
     * Gradually roll out a feature to an increasing percentage of users, and track the effect that the feature has on key metrics (for instance, how likely is a user to complete a purchase if they have feature A versus feature B?).
     * Turn off a feature that you realize is causing performance problems in production, without needing to re-deploy, or even restart the application with a changed configuration file.
     * Grant access to certain features based on user attributes, like payment plan (eg: users on the ‘gold’ plan get access to more features than users in the ‘silver’ plan). Disable parts of your application to facilitate maintenance, without taking everything offline.
-* LaunchDarkly provides feature flag SDKs for a wide variety of languages and technologies. Check out [our documentation](https://docs.launchdarkly.com) for a complete list.
+* LaunchDarkly provides feature flag SDKs for a wide variety of languages and technologies. Read [our documentation](https://docs.launchdarkly.com/sdk) for a complete list.
 * Explore LaunchDarkly
     * [launchdarkly.com](https://www.launchdarkly.com/ "LaunchDarkly Main Website") for more information
     * [docs.launchdarkly.com](https://docs.launchdarkly.com/  "LaunchDarkly Documentation") for our documentation and SDK reference guides

android/src/main/java/com/launchdarkly/reactnative/LaunchdarklyReactNativeClientModule.java

@@ -74,7 +74,8 @@ enum ConfigMapping {
         CONFIG_DIAGNOSTIC_OPT_OUT("diagnosticOptOut", ConfigEntryType.Boolean),
         CONFIG_DIAGNOSTIC_RECORDING_INTERVAL("diagnosticRecordingIntervalMillis", ConfigEntryType.Integer),
         CONFIG_SECONDARY_MOBILE_KEYS("secondaryMobileKeys", ConfigEntryType.Map),
-        CONFIG_AUTO_ALIASING_OPT_OUT("autoAliasingOptOut", ConfigEntryType.Boolean);
+        CONFIG_AUTO_ALIASING_OPT_OUT("autoAliasingOptOut", ConfigEntryType.Boolean),
+        CONFIG_INLINE_USERS_IN_EVENTS("inlineUsersInEvents", ConfigEntryType.Boolean);
 
         final String key;
         final ConfigEntryType type;

index.d.ts

@@ -172,6 +172,22 @@ declare module 'launchdarkly-react-native-client-sdk' {
          * The default is false.
          */
         allUserAttributesPrivate?: boolean;
+
+        /**
+         * Whether to disable the automatic sending of an alias event when [[LDClient.identify]] is
+         * called with a non-anonymous user when the previous user is anonymous.
+         *
+         * The default value is `false`.
+         */
+        autoAliasingOptOut?: boolean;
+
+        /**
+         * Whether to include full user details in every analytics event.
+         *
+         * The default is `false`: events will only include the user key, except for one "identify" event
+         * that provides the full details for the user.
+         */
+        inlineUsersInEvents?: boolean;
     };
 
     /**
@@ -186,7 +202,7 @@ declare module 'launchdarkly-react-native-client-sdk' {
 
         /**
          * The secondary key for the user. See the 
-         * [documentation](https://docs.launchdarkly.com/home/managing-flags/targeting-users#percentage-rollout-logic) 
+         * [documentation](https://docs.launchdarkly.com/home/flags/targeting-users#percentage-rollouts) 
          * for more information on it's use for percentage rollout bucketing.
          */
         secondary?: string;
@@ -660,12 +676,12 @@ declare module 'launchdarkly-react-native-client-sdk' {
          * the client has successfully connected to LaunchDarkly and received feature flags, or the
          * client has been put into offline mode (in which case it will return only default flag values).
          * 
-         * This function will return a rejected promise in case it has not been isInitialized.
+         * This function will return a rejected promise in case the client has not been initialized.
          *
          * @param environment
          *   Optional environment name to obtain the result from the corresponding secondary environment
          * @returns 
-         *   A promise contianing true if the client is initialized or offline, otherwise a rejected promise
+         *   A promise containing true if the client is initialized or offline, otherwise a rejected promise
          */
         isInitialized(environment?: string): Promise<boolean>;
 

ios/LaunchdarklyReactNativeClient.swift

@@ -89,6 +89,7 @@ class LaunchdarklyReactNativeClient: RCTEventEmitter {
         configField(&ldConfig.diagnosticRecordingInterval, config["diagnosticRecordingIntervalMillis"], millis)
         configField(&ldConfig.allUserAttributesPrivate, config["allUserAttributesPrivate"], id)
         configField(&ldConfig.autoAliasingOptOut, config["autoAliasingOptOut"], id)
+        configField(&ldConfig.inlineUserInEvents, config["inlineUsersInEvents"], id)
 
         if let val = config["secondaryMobileKeys"] as? [String: String] {
             try! ldConfig.setSecondaryMobileKeys(val)