- Fixed an issue where
304 NOT_MODIFIEDresponses to SDK polling mode requests would be considered error responses. This could cause the completion on a
identifyrequest 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
TimeIntervalconfiguration options are set to sufficiently large values. This was caused when converting these values to an
Intvalue of milliseconds. (Thanks, @delannoyk!)
Package.swiftto use SwiftPM tools version 5.2. This prevents test dependencies from being included transitively. (Thanks, @escakot!)
Quicktest dependency to 3.1.2 to avoid build warnings and adopt security fixes. (#243)
classin protocol inheritance to avoid compiler warnings. (#247)
- Improve CI to test against multiple supported Xcode and Swift language versions.
- Restored test suite compatibility with Xcode 11.4 and Swift 5.2.
- Internal throttling logic would sometimes delay new poll or stream connections even when there were no recent connections. This caused switching active user contexts using
identifyto sometimes delay retrieving the most recent flags and calling the completion.
- Added the
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 the
identifymethod; by setting
identifywill not automatically generate alias events.
- Added the
LDClient. Unless the client has been set offline, this property's value is
falseuntil the client receives an initial set of flag values from the LaunchDarkly service. If the client is offline, the value will be
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.
- Updated to prevent a crash in
dispatch_group_leave.cold.1that would rarely occur as the SDK transitioned to an online state for a given configuration or user. This issue may have been exacerbated for a short period due to a temporary change in the behavior of the LaunchDarkly service streaming endpoint. Thanks to all the users who reported (#235).
LDSwiftEventSourcedependency to correct an issue where a streaming connection could sometimes reconnect after being set offline.
LDUsernow has an optional
secondaryattribute to match other LaunchDarkly SDKs. For more on the behavior of this attribute see the documentation on targeting users.
- Corrected a bug preventing private custom attribute names being recorded in events when all custom attributes are set to be private by including "custom" in the
- Update Nimble to 9.0 and Quick to 3.0 to fix tests when run with Swift 5.3.
- Fixes build warnings in Xcode 12.0.0.
- The ability to specify additional headers to be included on HTTP requests to LaunchDarkly services using
LDConfig.additionalHeaders. This feature is to enable certain proxy configurations, and is not needed for normal use.
- Support for building docs with jazzy. These docs will be available through GitHub Pages.
- SDK causing nested bundles in archived product when including the SDK through Carthage. This caused rejections when submitted to the App Store. Thanks to @spr for reporting (#217).
- SDK causing application to expect LDSwiftEventSource dynamic framework when built with SwiftPM, which does not include the dynamic framework in the resulting application. This causes the application to be rejected when submitted to the App Store. Thanks to @spr for reporting (#216).
Note that this release contains the notes for the 5.0.0 release, which should not be used.
This major version has an accompanying Migration Guide. Please see the guide for more information on updating to this version of the SDK, as the following is just a summary of the changes.
- Support for multiple LaunchDarkly projects or environments. Each set of feature flags associated with a mobile key is called an environment. This adds:
LDConfig.getSecondaryMobileKeyswhich allows configuring a mapping of names to the SDK keys for each additional environment.
LDConfig.mobileKeyis still required, and represents the primary environment.
LDClient.get(environment: )which allows retrieving an LDClient instance for a given environment after the SDK has been initialized.
- Equivalent methods have been added to the Objective-C bindings for
- The SDK now periodically sends diagnostic data to LaunchDarkly, describing the version and configuration of the SDK, the operating system the SDK is running on, the device type (such as "iPad"), and performance statistics. No credentials, device IDs, or other identifiable values are included. This behavior can be disabled or configured with the new
- The SDK can now be configured with
LDConfig.wrapperVersionto send an additional header (
X-LaunchDarkly-Wrapper) in requests to LaunchDarkly. This was added so that the usage of wrapper libraries (such as the React Native SDK) could be recorded independently.
- Added the
evaluationReasonsfield to the Objective-C bindings for
LDConfigto allow configuring the SDK to request evaluation reasons when the application is written in Objective-C.
- The SDK now supports using the Swift Package Manager to include the SDK as a dependency.
LDInvalidArgumentErrorthat is thrown on incorrect API usage.
ObjcLD<T>ChangedFlagclasses (bound to
LD<T>ChangedFlagin Objective-C) that is
YESwhen the flag value did not match the registered observer.
- Minimum deployment targets have been changed as follows:
- iOS 8.0 -> 10.0
- macOS 10.10 -> 10.12
- tvOS 9.0 -> 10.0
- watchOS 2.0 -> 3.0
- The SDK has replaced the internal dependency on the Objective-C eventsource implementation DarklyEventSource with a pure Swift implementation LDSwiftEventSource. Build configurations that manually specify the DarklyEventSource dependency framework may require additional upgrade steps. See the Migration Guide for more information.
- Internally, the SDK no longer includes its dependencies using CocoaPods and Carthage. This simplifies including the SDK as a subproject of your application for integrating the SDK without a package manager.
starthas been replaced with a static method
LDClient.startfor initializing all configured environments.
LDChangedFlagno longer includes the
- The following were renamed for consistency internally and with other SDKs:
LDClient.reportEvents()has been renamed to
LDClient.stop()has been renamed to
LDClient.trackEvent(key: data: )method have been renamed to
LDClient.track(key: data: )
LDClient.allFlagValueshas been renamed to
EvaluationDetailhas been renamed to
ObjC<T>EvaluationDetailclasses have been renamed to corresponding
ObjcLD<T>EvaluationDetail. The names when exposed in Objective-C have been updated to replace the
LDClient.trackno longer throws
JSONErrorand instead throws
fallbackparameter of all
ObjcLDClientvariation methods has been renamed to
defaultValueto help distinguish it from
fallbackvalues in rules specified in the LaunchDarkly dashboard.
- The maximum backoff delay between failed streaming connections has been reduced from an hour to 30 seconds. This is to prevent being unable to receive new flag values for up to an hour if the SDK has reached its maximum backoff due to a period of network connectivity loss.
- The backoff on streaming connections will not be reset after just a successful connection, rather waiting for a healthy connection for one minute after receiving flags. This is to reduce congestion in poor network conditions or if extreme load prevents the LaunchDarkly service from maintaining an active streaming connection.
- When sending events to LaunchDarkly, the SDK will now retry the request after a one second delay if it fails.
- When events fail to be sent to LaunchDarkly, the SDK will no longer retain the events. This prevents double recording events when the LaunchDarkly service received the event but the SDK failed to receive the acknowledgement.
LDClient.closeinstance methods now operate on all configured environments. Any completion arguments will complete when the operation has completed for all configured environments.
LDClient.sharedstatic property and its
ObjcLDClient.sharedInstancewrapper property has been removed. After calling
LDClient.start, the initialized instances can be retrieved with
ObjcLDClient.configwrapper property has been removed, configuration of the SDK should be done with
ObjcLDClient.userwrapper property has been removed. The initial user should be configured with
LDClient.start, and updates to the user should be performed with
ObjcLDFlagValueSourcewere removed in favor of using
- The Objective-C wrapper classes
ObjcLD<T>VariationValue(bound in Objective-C to
LD<T>VariationValue), which wrapped a flag value and its source, have been removed.
variationAndSourcemethods were removed from
ObjcLDClientwrapper in favor of
LDUser.init?(object: )and corresponding
ObjcLDUserfailable initializers were removed.
Array, this was only intended for internal SDK use.
Optional<[String: Any]>(note that this was not declared as
Equatableconformance). This extension was only intended for internal SDK use.
LDFlagValueenum and the
ObjcLDFlagValuewrapper which were exposed but not used in any public APIs.
Sysctlstruct (only available on macOS) which was only intended for internal SDK use.