Skip to content

Latest commit

 

History

History
933 lines (686 loc) · 61.8 KB

CHANGELOG.md

File metadata and controls

933 lines (686 loc) · 61.8 KB
Raw

Change log

All notable changes to the LaunchDarkly iOS SDK will be documented in this file. This project adheres to Semantic Versioning.

9.12.0 (2024-11-06)

Features

  • Add LDConfig.sendEvents option to disable all events (#414) (9a51844)
  • Add cache usage option for identify calls (#408) (b928345)

9.11.0 (2024-10-21)

Features

  • Adds support for client-side prerequisite events (#409) (d4ad59c)

9.10.0 (2024-08-07)

Features

  • Update caching strategy to allow for greater cache use (#404) (62587ad)

Bug Fixes

  • Sort private attributes for improved stable encoding (#401) (90bf896)

9.9.0 (2024-08-02)

This release introduces the ability to enable compression of event payloads. When enabled, the SDK will compress events before sending them to the LaunchDarkly servers. This can reduce the bandwidth required to send events, which can be useful in high-traffic environments to reduce egress traffic costs.

Important

Relay Proxy users MUST upgrade to version 8.9 or higher prior to enabling this option to prevent loss of event data.

However, enabling this feature is NOT required when using the Relay Proxy as it will manage compression automatically.

Features

  • Add option to enable compression of event payloads (#399) (ae4131f)

9.8.2 (2024-06-10)

Bug Fixes

  • start time warning log now uses float wildcard for string interpolation of time interval (#393) (573c99b)

9.8.1 (2024-06-03)

Bug Fixes

  • configured logger is now also used for logging LDEventSource log messages (#390) (7a3e67a)

9.8.0 (2024-05-20)

Features

  • adds LD_OBJC_EXCLUDE_PURE_SWIFT_APIS compiler flag. (#386) (fef65f5)

9.7.2 (2024-05-20)

Bug Fixes

  • Add default implementation for hook methods (#384) (4461043)

9.7.1 (2024-05-16)

Bug Fixes

  • adds multithread protections for LDClient.start(...) (#382) (8fd47e4)

9.7.0 (2024-05-02)

Features

9.6.2 (2024-04-03)

Bug Fixes

  • Mark NSPrivacyCollectedDataTypeTracking as false in privacy manifest (#366) (fac9030)

9.6.1 (2024-04-02)

Bug Fixes

  • Add missing privacy manifest resource for SPM (#360) (48f06cf)
  • Add missing privacy tracking fields in manifest (#362) (7439997)
  • Add objective-c binding for LDConfig.logger (#365) (eae8d78)
  • Deprecate calling start without a timeout parameter (#364) (65d88a4)
  • Use resource_bundle for privacy manifest in podspec (#361) (971a4c4)

9.6.0 (2024-03-20)

Features

  • Honor polling interval between restarts (#355) (bd58864)

9.5.1 (2024-03-15)

Bug Fixes

  • Prevent null value changes to observe listeners (#352) (c1f1926)

9.5.0 (2024-03-14)

Features

  • Inline contexts for all evaluation events (#332) (a0f795b)
  • Redact anonymous attributes within feature events (#333) (0fd5dbd)

9.4.1 (2024-03-01)

Bug Fixes

  • Ensure secondary environments use correct mobile key (#347) (e92054c)

9.4.0 (2024-02-21)

Features

  • Add new identify method with time out support (#344) (34ba8ab)
  • Implement shedding identity queue (#343) (393a28c)
  • Introduce variation method with generic return types (#342) (7ff2ffb)

Bug Fixes

9.3.0 (2024-01-02)

Features

  • Store and use e-tag header between SDK initializations (#268) (701aaa8)

Bug Fixes

  • LDContext equality is no longer order dependent (#265) (683e0c3)
  • Use stable encoding format to increase cache hits (#267) (40a5d01)

[9.2.1] - 2023-10-31

Changed:

  • Calling identify() with a context that is identical to the SDK's current context is now more efficient, and no longer results in re-establishing a connection.

Fixed:

  • Fixed issue where flag change listeners were not being triggered when identify() was called.

[9.2.0] - 2023-10-24

Changed:

  • Updated swift-tools-version from 5.2 to 5.3.

Removed:

  • Removed support for iOS 11 and tvOS 11 to support XCode15. This is being released as a minor change because those platforms can no longer use any portion of this SDKs APIs.

[9.1.1] - 2023-09-19

Fixed:

  • Fixed rare bug in key generation in some contexts generated by the Auto Environment Attributes feature.

[9.1.0] - 2023-09-11

Changed:

  • Deprecated LDValue.init(integerLiteral: Double) as this method signature is misleading. A new LDValue.init(integerLiteral: Int) signature has been added for clarity.

Fixed:

  • Adjusted key encoding for some contexts generated by the Auto Environment Attributes feature.

[9.0.2] - 2023-08-25

Fixed:

  • Updated how Auto Environment Attributes sanitizes and validates provided values to provide a more user friendly experience.

[9.0.1] - 2023-08-18

Fixed:

  • Corrected implementation of classes that retrieves ApplicationInfo from package bundle as part of Automatic Mobile Environment Attributes functionality.

[9.0.0] - 2023-08-02

Added:

  • Added Automatic Mobile Environment Attributes functionality which makes it simpler to target your mobile customers based on application name or version, or on device characteristics including manufacturer, model, operating system, locale, and so on. To learn more, read Automatic environment attributes.

Removed

[8.3.1] - 2023-10-31

Changed:

  • Calling identify() with a context that is identical to the SDK's current context is now more efficient, and no longer results in re-establishing a connection.

Fixed:

  • Fixed issue where flag change listeners were not being triggered when identify() was called.

[8.3.0] - 2023-09-08

Changed:

  • Deprecated LDValue.init(integerLiteral: Double) as this method signature is misleading. A new LDValue.init(integerLiteral: Int) signature has been added for clarity.

[8.2.0] - 2023-08-02

Changed:

[8.1.0] - 2023-06-05

Changed:

  • Enforce TLS v1.2 as a required minimum.

Fixed:

  • Allow setting kind through trySet.

[8.0.1] - 2023-02-28

Fixed:

  • Remove the extra privateAttributes meta field from the event payload. This extra field prevented LaunchDarkly services from accepting SDK events when private attributes were specified.

[8.0.0] - 2022-12-07

The latest version of this SDK supports LaunchDarkly's new custom contexts feature. Contexts are an evolution of a previously-existing concept, "users." Contexts let you create targeting rules for feature flags based on a variety of different information, including attributes pertaining to users, organizations, devices, and more. You can even combine contexts to create "multi-contexts."

For detailed information about this version, please refer to the list below. For information on how to upgrade from the previous version, please read the migration guide for Swift or Objective-C.

Added:

  • The type LDContext defines the new context model.
  • For all SDK methods that took an LDUser parameter, there is now an overload that takes an LDContext.

Changed:

  • The secondary attribute which existed in LDUser is no longer a supported feature. If you set an attribute with that name in LDContext, it will simply be a custom attribute like any other.
  • Analytics event data now uses a new JSON schema due to differences between the context model and the old user model.
  • The SDK no longer adds device and os values to the user attributes. Applications that wish to use device/OS information in feature flag rules must explicitly add such information.

Removed:

  • Removed the secondary meta-attribute in LDUser.
  • The alias method no longer exists because alias events are not needed in the new context model.
  • The autoAliasingOptOut and inlineUsersInEvents options no longer exist because they are not relevant in the new context model.

[7.1.0] - 2022-11-08

Added:

  • Added Objective C bindings for ApplicationInfo.

[7.0.0] - 2022-10-12

Changed:

  • Dropped support for older versions in accordance with the new Xcode 14 release.

[6.2.0] - 2022-09-01

Added:

  • CI builds now include a cross-platform test suite implemented in https://github.com/launchdarkly/sdk-test-harness. This covers many test cases that are also implemented in unit tests, but may be extended in the future to ensure consistent behavior across SDKs in other areas.
  • Introduced ApplicationInfo, for configuration of application metadata that may be used in LaunchDarkly analytics or other product features. This does not affect feature flag evaluations.

Changed:

  • Updated LDSwiftEventSource to 2.0.0. We no longer bind to a static product; rather, we let the build determine static vs dynamic linking.

Fixed:

  • Previously a deleted flag could be made available in the SDK if the deletion events were processed out of order. This is no longer the case.

[6.1.0] - 2022-05-17

Added

  • Added the LDUser.isAnonymousNullable property that allows treating the isAnonymous property as nullable.

Fixed

  • Correctly track whether the LDUser.isAnonymous property was set explicitly (or by not specifying a key). The variation result for flag rules targeting the anonymous property can differ depending on whether the property is set explicitly.

[6.0.0] - 2022-05-04

This major version has accompanying migration guides for Swift and Objective-C. 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.

Note that Objective-C bridging types are prefixed by Objc, but that prefix is not exposed to code written in Objective-C. For example, changes listed to ObjcLDClient are changes to the class referred to as LDClient from within Objective-C.

Added

  • Added the LDValue class to represent any data type that is allowed in JSON. This new type is used to provide more type safety when representing complex or non-statically determined data types. The SDK also provides the bridge types ObjcLDValue and ObjcLDValueType for Objective-C interoperability.
  • Added the UserAttribute class which provides a less error-prone way to refer to user attribute names in configuration.
  • Added the type specific variation functions, boolVariation, intVariation, doubleVariation, stringVariation, and jsonVariation, to LDClient.
  • Added the type specific detailed variation functions, boolVariationDetail, intVariationDetail, doubleVariationDetail, stringVariationDetail, and jsonVariationDetail, to LDClient.
  • Added jsonVariation and jsonVariationDetail to ObjcLDClient. These functions allow evaluating feature flags where the provided defaultValue and the resulting variation can be any valid JSON data type.
  • Added ObjcLDJSONEvaluationDetail for retrieving the detailed evaluation information of arbitrary type flag variations.
  • Added ObjcLDChangedFlagHandler type alias for new non-type specific Objective-C flag observers.

Changed (API)

  • LDClient.track(key: data: metricValue:) no longer throws.
  • The type of the data parameter of LDClient.track(key: data: metricValue:) has changed from Any? to LDValue?.
  • ObjcLDClient.track(key: data:) and ObjcLDClient.track(key: data: metricValue:) no longer throws. In Objective-C this change means that the track functions no longer accept a error: parameter.
  • The type of the data parameter of ObjcLDClient.track(key: data:) and ObjcLDClient.track(key: data: metricValue) has changed from Any? to ObjLDValue?. In Objective-C this would be a change from id _Nullable to LDValue * _Nullable.
  • LDClient.allFlags now has the type [LDFlagKey: LDValue]? rather than [LDFlagKey: Any]?.
  • ObjcLDClient.allFlags now has the type [String: ObjcLDValue]? rather than [String: Any]?. In Objective-C this would be a change from NSDictionary<NSString*, id> * _Nullable to NSDictionary<NSString*, LDValue*> * _Nullable.
  • The type of the LDUser.custom dictionary, and the corresponding LDUser.init parameter has been changed from [String: Any]? to [String: LDValue].
  • The type of the ObjcLDUser.custom property has been changed from [String: Any]? to [String: ObjcLDValue]. In Objective-C this would be a change from NSDictionary<NSString*, id> * _Nullable to NSDictionary<NSString*, LDValue*> * _Nonnull.
  • The type of the LDUser.privateAttributes property, and the corresponding LDUser.init parameter, have been changed from [String]? to [UserAttribute].
  • The type of the ObjcLDUser.privateAttributes property has been changed from [String]? to [String]. In Objective-C this would be a change from NSArray<NSString*> * _Nullable to NSArray<NSString*> * _Nonnull.
  • The types of the properties LDChangedFlag.oldValue and LDChangedFlag.newValue have been changed from Any? to LDValue.
  • The type of the LDConfig.privateUserAttributes property has been changed from [String]? to [UserAttribute].
  • ObjcLDConfig.privateUserAttributes now has the non-optional type [String] rather than [String]?. In Objective-C this would be a change from NSArray<NSString*> * _Nullable to NSArray<NSString*> * _Nonnull.
  • The type of the LDEvaluationDetail.reason property has been changed from [String: Any] to [String: LDValue].
  • The type of the reason property of ObjcLDBoolEvaluationDetail, ObjcLDIntegerEvaluationDetail, ObjcLDDoubleEvaluationDetail, and ObjcLDStringEvaluationDetail has been changed from [String: Any]? to [String: ObjcLDValue]?. In Objective-C this would be a change from NSDictionary<NSString*, id> * _Nullable to NSDictionary<NSString*, LDValue*> * _Nullable.

Changed (behavioral)

  • The Equatable instance for LDUser has been changed to compare all user properties, rather than just the key property.
  • Using "custom" as a private attribute name in LDConfig.privateUserAttributes or LDUser.privateAttributes will no longer set all LDUser custom attributes private.
  • The automatically set device and operatingSystem custom attributes can now be set private.
  • SDK versions from 4.0.0 and less than 6.0.0 supported migration of cached flag data from any SDK version of at least 2.3.3. The 6.0.0 release only supports migration of cached flag data from SDK versions of at least 4.0.0.

Removed

  • Removed LDClient.variation(forKey: defaultValue:) and LDClient.variationDetail(forKey: defaultValue:) functions. Please use the new type-specific variation functions instead (e.g. LDClient.boolVariation(forKey: defaultValue:)).
  • Removed the LDFlagValueConvertible protocol which was previously used to constrain the parameters and return types of the variation functions.
  • LDErrorHandler and LDClient.observeError(owner: handler:) have been removed. Please use ConnectionInformation instead.
  • Removed the LDUser.init(userDictionary: ) and ObjcLDUser.init(userDictionary: ) initializers, please use the explicit initializers instead.
  • Removed LDUser.CodingKeys. To refer to user attributes, please use UserAttribute instead.
  • Removed LDUser.privatizableAttributes and ObjcLDUser.privatizableAttributes.
  • Removed ObjcLDUser.attributeCustom.
  • The LDUser.device and LDUser.operatingSystem properties, and the corresponding LDUser.init parameters have been removed. These fields will be included in the LDUser.custom dictionary.
  • The ObjcLDUser.device and ObjcLDUser.operatingSystem properties have been removed. These fields will be included in the ObjcLDUser.custom dictionary.
  • The ObjcLDClient functions, arrayVariation, arrayVariationDetail, dictionaryVariation, and dictionaryVariationDetail, have been removed. Please use ObjcLDClient.jsonVariation and ObjcLDClient.jsonVariationDetail instead.
  • The per-type instances of ObjcLDChangedFlag have been removed. Please use the base class ObjcLDChangedFlag, which now provides oldValue and newValue ObjcLDValue properties. The removed classes are ObjcLDBoolChangedFlag, ObjcLDIntegerChangedFlag, ObjcLDDoubleChangedFlag, ObjcLDStringChangedFlag, ObjcLDArrayChangedFlag, and ObjcLDDictionaryChangedFlag.
  • The classes ObjcLDArrayEvaluationDetail and ObjcLDDictionaryEvaluationDetail have been removed. Please use ObjcLDJSONEvaluationDetail instead.
  • The type aliases, ObjcLDBoolChangedFlagHandler, ObjcLDIntegerChangedFlagHandler, ObjcLDDoubleChangedFlagHandler, ObjcLDStringChangedFlagHandler, ObjcLDArrayChangedFlagHandler, and ObjcLDDictionaryChangedFlagHandler, have been removed. Please use ObjcLDChangedFlagHandler instead.
  • The ObjcLDClient functions, observeBool, observeInteger, observeDouble, observeString, observeArray, and observeDictionary, have been removed. Please use the non-type specific ObjcLDClient.observe(key: owner: handler:) instead.

[5.4.5] - 2022-03-11

Fixed

  • Fixed race condition in LDSwiftEventSource that could cause a crash if the stream is explicitly stopped (such as when identify is called) while the stream is waiting to reconnect.

[5.4.4] - 2022-01-19

Fixed

  • Fixed memory leak when stream connections are terminated by updating LDSwiftEventSource dependency to 1.3.0.
  • The SDK would not allow additional fields on delete flag stream events. This has been updated to allow additional fields for improved future compatibility.
  • Improved internal Throttler implementation to reduce concurrency concerns.
  • Removed unneeded Cartfile definining LDSwiftEventSource dependency, which when bundled could lead to warning messages that LDSwiftEventSource definitions are implemented in multiple frameworks.

[5.4.3] - 2021-08-13

Fixed

  • Fixed an issue where 304 NOT_MODIFIED responses to SDK polling mode requests would be considered error responses. This could cause the completion on a identify request 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 null value nested within a JSON array.

[5.4.2] - 2021-06-17

Fixed

  • Avoid crash when TimeInterval configuration options are set to sufficiently large values. This was caused when converting these values to an Int value of milliseconds. (Thanks, @delannoyk!)
  • Update Package.swift to use SwiftPM tools version 5.2. This prevents test dependencies from being included transitively. (Thanks, @escakot!)
  • Update Quick test dependency to 3.1.2 to avoid build warnings and adopt security fixes. (#243)
  • Use AnyObject over class in 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.

[5.4.1] - 2021-04-06

Fixed

  • 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 identify to sometimes delay retrieving the most recent flags and calling the completion.

[5.4.0] - 2021-02-26

Added

  • Added the alias method to LDClient. This can be used to associate two user objects for analytics purposes with an alias event.
  • Added the autoAliasingOptOut configuration option. This can be used to control the new automatic aliasing behavior of the identify method; by setting autoAliasingOptOut to true, identify will not automatically generate alias events.
  • Added the isInitialized property to LDClient. Unless the client has been set offline, this property's value is false until the client receives an initial set of flag values from the LaunchDarkly service. If the client is offline, the value will be true after initialization.

Changed

  • The 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.

Fixed

  • Some users reported synchronization issues with the internal DiagnosticReporter implementation, which has been reworked to address these issues. Thanks to @provanandparanjape for one such report (#238).

[5.3.2] - 2021-02-11

Fixed

  • Updated to prevent a crash in dispatch_group_leave.cold.1 that 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).
  • Updated LDSwiftEventSource dependency to correct an issue where a streaming connection could sometimes reconnect after being set offline.

[5.3.1] - 2020-12-15

Fixed

  • Decoupled FlagStore from LDUser to fix a bug where multiple environments could overwrite each other's flag values.

[5.3.0] - 2020-11-06

Added

  • Adds to LDConfig the ability to dynamically configure the HTTP headers on requests through the headerDelegate property, which has the type RequestHeaderTransform.

[5.2.0] - 2020-10-09

Added

Fixed

  • 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 LDUser.privateAttributes or LDConfig.privateUserAttributes properties.
  • 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.

[5.1.0] - 2020-08-04

Added

  • 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.

Fixed

  • 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).

[5.0.1] - 2020-07-23

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.

Added

  • Support for multiple LaunchDarkly projects or environments. Each set of feature flags associated with a mobile key is called an environment. This adds:
    • LDConfig.setSecondaryMobileKeys and LDConfig.getSecondaryMobileKeys which allows configuring a mapping of names to the SDK keys for each additional environment. LDConfig.mobileKey is 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 LDConfig and LDClient.
  • 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 LDConfig properties diagnosticOptOut and diagnosticRecordingInterval.
  • The SDK can now be configured with LDConfig.wrapperName and LDConfig.wrapperVersion to 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 evaluationReasons field to the Objective-C bindings for LDConfig to 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.
  • LDInvalidArgumentError that is thrown on incorrect API usage.
  • Added typeMismatch field to ObjcLD<T>ChangedFlag classes (bound to LD<T>ChangedFlag in Objective-C) that is true/YES when the flag value did not match the registered observer.

Changed (build)

  • 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.

Changed (API)

  • The LDClient instance method start has been replaced with a static method LDClient.start for initializing all configured environments.
  • LDChangedFlag no longer includes the oldValueSource and newValueSource properties, as LDFlagValueSource was removed.
  • The following were renamed for consistency internally and with other SDKs:
    • LDClient.reportEvents() has been renamed to LDClient.flush().
    • LDClient.stop() has been renamed to LDClient.close().
    • LDClient.trackEvent(key: data: ) method have been renamed to LDClient.track(key: data: )
    • LDClient.allFlagValues has been renamed to LDClient.allFlags.
    • EvaluationDetail has been renamed to LDEvaluationDetail.
    • The ObjC<T>EvaluationDetail classes have been renamed to corresponding ObjcLD<T>EvaluationDetail. The names when exposed in Objective-C have been updated to replace the ObjC prefix with LD, e.g. ObjCStringEvaluationDetail to LDStringEvaluationDetail.
  • LDClient.track no longer throws JSONError and instead throws LDInvalidArgumentError.
  • The fallback parameter of all LDClient and ObjcLDClient variation methods has been renamed to defaultValue to help distinguish it from fallback values in rules specified in the LaunchDarkly dashboard.

Changed (behavioral)

  • 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.
  • The LDClient.identify, LDClient.flush, LDClient.setOnline, and LDClient.close instance methods now operate on all configured environments. Any completion arguments will complete when the operation has completed for all configured environments.

Removed

  • The LDClient.shared static property and its ObjcLDClient.sharedInstance wrapper property has been removed. After calling LDClient.start, the initialized instances can be retrieved with LDClient.get(environment: ).
  • The LDClient.config and its ObjcLDClient.config wrapper property has been removed, configuration of the SDK should be done with LDClient.start.
  • The LDClient.user and its ObjcLDClient.user wrapper property has been removed. The initial user should be configured with LDClient.start, and updates to the user should be performed with LDClient.identify.
  • LDFlagValueSource and ObjcLDFlagValueSource were removed in favor of using LDEvaluationDetail and ObjcLD<T>EvaluationDetail.
  • 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.
  • variationAndSource methods were removed from LDClient and its ObjcLDClient wrapper in favor of variationDetail methods.
  • LDUser.init?(object: ) and corresponding ObjcLDUser failable initializers were removed.
  • JSONError and JSONErrorDomain extensions on JSONSerialization were removed.
  • Removed isEqual extension to Array, this was only intended for internal SDK use.
  • Removed == and != extension to Optional<[String: Any]> (note that this was not declared as Equatable conformance). This extension was only intended for internal SDK use.
  • Removed LDFlagValue enum and the ObjcLDFlagValue wrapper which were exposed but not used in any public APIs.
  • Removed Sysctl struct (only available on macOS) which was only intended for internal SDK use.

[5.0.0] - 2020-07-23

Please use the 5.0.1 instead. This release incorrectly specifies its version and is unavailable on CocoaPods

[4.7.0] - 2020-06-03

Added

  • Added a new method signature for startCompleteWhenFlagsReceived that accepts an additional argument specifying a maximum time to wait for flags to be received before calling the completion closure. The completion closure on this method will be passed a Bool on completion indication whether the operation timed out.

[4.6.0] - 2020-05-26

Added

  • Added maxCachedUsers option to LDConfig. You can now specify the number of users to be cached or use -1 for unlimited cached users.

Fixed

  • FlagStore properly synchronizes reads and writes to prevent a potential race condition.

[4.5.0] - 2020-03-26

Changed

  • Updated SDK code to build, run, and test on Xcode 11.4.

[4.4.1] - 2020-02-04

Changed

  • The SDK will now retry an event send once when the initial request fails.

[4.4.0] - 2019-12-19

Added

  • Added startCompleteWhenFlagsReceived function which contains modified completion behavior. This new function's completion will only return after flag values are received. Previously the start completion returned when the SDK went online.
  • The SDK now specifies a uniquely identifiable request header when sending events to LaunchDarkly to ensure that events are only processed once, even if the SDK sends them two times due to a failed initial attempt.

[4.3.2] - 2019-12-19

Fixed

  • Flag change listeners will now be called when a flag value changes but a variation number does not change. Previously, flag listeners were not called when a value assigned to a variation was manually edited in the dashboard or via the API.

[4.3.1] - 2019-12-12

Changed

  • Updated to ios-eventsource version 4.1.0. This negates the need to use_frameworks! when using the React Native SDK. This change does not affect the iOS SDK.

[4.3.0] - 2019-12-3

Added

  • Implemented variationDetail which returns an Evaluation Reason giving developers greater insight into why a value was returned.
  • Added support for the latest Experimentation features allowing increased value from A/B/n testing. The track method now supports an additional metricValue parameter.

[4.2.1] - 2019-11-15

Changed

  • Updated to ios-eventsource version 4.0.3. This appends a platform name to bundle identifiers. (Thanks, cswelin!)

Fixed

  • Comparing two nil objects of type [String: Any]? no longer causes a crash. (#197)

[4.2.0] - 2019-10-25

Added

  • The identify function allows a completion to be called after a user is updated.
  • The Connection Status API allows greater introspection into the current LaunchDarkly connection and the health of local flags. • This feature adds a new class called ConnectionInformation that contains properties that keep track of the current connection mode e.g. streaming or polling, when and how a connection failed, and the last time flags were updated. This class can be accessed from LDClient.shared.getConnectionInformation. • Additionally, a new observer function called observeCurrentConnectionMode allows your application to listen to changes in the SDK's connection to LaunchDarkly.

Changed

  • The user property is now deprecated in favor of the identify function.

[4.1.2] - 2019-07-11

Fixed

  • WatchKit is now conditionally imported in WatchOS only, to fix an error in Xcode 11.
  • Comparing two nil objects of type [String: Any]? no longer causes a crash.

[4.1.1] - 2019-07-09

Changed

  • Updated to ios-eventsource version 4.0.2. This fixes a potential hang on LDClient start.

[4.1.0] - 2019-06-19

Changed

  • Installs new deviceModel into EnvironmentReporter and renames old deviceModel to deviceType.
  • Updated MacOS model detection to use CwSysCtl.

Fixed

  • Fixed a concurrency bug that caused crashes in FlagStore.swift. This bug could surface during rapid updates to local flags.

[4.0.0] - 2019-04-18

This is the non-beta first release of the Swift SDK. It follows the beta.3 release from 2019-03-07. Unlike previous Swift SDK releases, this release does not have a 3.0.0 companion tag.

Changed

  • Changes Feature Flag caching so that cached feature flags are associated with a user key and mobile key.
  • Clears new warnings that appear with Xcode 10.2

Added

  • Implements URL caching for REPORT requests.
  • Installs the ability to read cached data in all cached data schemas from 2.3.3 through 3.0.1 and store the feature flags in the 4.0.0 cached data schema.
  • Retains prior cached data for 90 days following upgrade to 4.0.0. Does not keep older cached data up-to-date. Downgrading to a prior version within 90 days allows the downgraded app to read the last cached data from the downgraded version.

Fixed

  • Prevents a log message that incorrectly reported a network error on watchOS

[4.0.0-beta.3] - 2019-03-07

This is part of the Swift SDK beta and was originally released as 3.0.0-beta.3.

Changed

  • Renames SDK frameworks to LaunchDarkly.framework for iOS, and LaunchDarkly_<platform>.framework for non-iOS platforms.
  • Renames targets to LaunchDarkly_<platform>.
  • Renames project and workspace to LaunchDarkly
  • Updates DarklyEventSource to version 4.0.1
  • Updates several internal dependencies to their latest versions
  • Replaces onServerUnavailable with observeError on LDClient

Added

  • Instructions to integrate without a Package Manager to README.md
  • New log entries that tell when the SDK could not find a feature flag, and when the SDK could not convert a feature flag to the requested type

[4.0.0-beta.2] - 2019-02-06

This is part of the Swift SDK beta and was originally released as 3.0.0-beta.2.

Changed

  • LDFlagValueSource is a Swift enum the SDK uses to communicate the source of a feature flag (server, cache, fallback) to the client app. The Objective-C enum was changed to an object to provide Objective-C client apps access to the methods available to the enum.
  • mobileKey was restored to a property within the LDConfig. As a result, LDClient.start() no longer takes a mobileKey parameter, and the config parameter is now required.
  • LDConfig time-based properties (connectionTimeout, eventFlushInterval, flagPollingInterval, and backgroundFlagPollingInterval) were changed to type TimeInterval.
  • Installs DarklyEventSource version 4.0.0.
  • LDClient.trackEvent now accepts any valid json object. If an invalid JSON object is passed, the SDK throws a JSONSerialization.JSONError.invalidJsonObject error at runtime. -LDClient.variation and variationAndSource now accept Optional types and nil for the fallback value. The client app must specify the Optional Type for the compiler. See the migration guide for details.

[4.0.0-beta.1] - 2018-12-11

This is part of the Swift SDK beta and was originally released as 3.0.0-beta.1.

Added

  • LDClient can now provide information about the source of a feature flag, cache, server, and fallback.
  • LDConfig offers some new configuration properties: eventCapacity, startOnline, enableBackgroundUpdates
  • LDUser replaces the builder model from v2.x. This Swift struct has all the v2.x properties, plus support for creating a user from a dictionary.
  • LDClient has a new property allFlagValues which provides the client app with a snapshot of the feature flags available and their values

Changed

  • Replaced Objective-C SDK with Swift SDK. See MigrationGuide.md for details on converting to v3.
  • LDConfig and LDUser are Swift structs, giving you value semantics which makes it easier to control the SDK.
  • LDClient controls remain similar to v2.x. Setting a config or user is possible before, during, and after start.
  • LDClient uses Swift generics to get feature flag values. Swift client apps use a variation method (without the type) to get flag values.
  • LDClientDelegate was removed. Observe feature flags using observe methods on LDClient. Set a closure the LDClient will execute when the server is unavailable.

[3.0.1] - 2019-04-30

Changed

  • Deployed Carthage built DarklyEventSource frameworks as part of the Darkly project.

[3.0.0] - 2019-04-17

Changed

  • Renamed the non-iOS Darkly frameworks to include the platform name. e.g. Darkly_watchOS. Because non-CocoaPods apps will need to update imports for the new modules, advanced to the next major version.
  • Removed DarklyEventSource as a CocoaPods dependency in the podfile. DarklyEventSource remains a dependency in the podspec.

Added

  • Nullability specifiers for items that caused new warnings with Xcode 10.2

[3.0.0-beta.3] - 2019-03-07

This is part of the Swift SDK beta and was renamed to 4.0.0-beta.1. See 4.0.0-beta.3 - 2019-03-07 for details

[3.0.0-beta.2] - 2019-02-06

This is part of the Swift SDK beta and was renamed to 4.0.0-beta.2. See 4.0.0-beta.2 - 2019-02-06 for details

[3.0.0-beta.1] - 2018-12-11

This is part of the Swift SDK beta and was renamed to 4.0.0-beta.1. See 4.0.0-beta.1 - 2018-12-11 for details

[2.14.4] - 2019-02-26

Changed

  • Changed the following to repair macOS builds:
  • Removed extraneous framework reference from Darkly_macOS target
  • Deselected Autocreate schemes in Darkly.xcworkspace

[2.14.3] - 2019-02-25

Changed

  • Added support for integrating without a package manager
  • Updated to DarklyEventSource version 4.0.1, which adds platform specific targets to support integration without a package manager.

[2.14.2] - 2019-01-24

Added

  • Added nullability specifiers to public SDK classes.

Changed

  • Updated to DarklyEventSource version 4.0.0, which eliminates a 1-second delay in SDK initialization.

[2.14.1] - 2018-12-21

Changed

  • Added copy methods to several objects involved in creating a summary event.
  • Added additional synchronization to creating a summary event in order to potentially prevent some crash scenarios.

[2.14.0] - 2018-12-05

Added

  • Added allFlags property to LDClient that provides a dictionary of feature flag keys and values. Accessing feature flags via allFlags does not record any analytics events.
  • Support for multiple LaunchDarkly projects or environments. Each set of feature flags associated with a mobile key is called an environment. • Added secondaryMobileKeys to LDConfig. LDConfig mobileKey refers to the primary environment, and must be present. All entries in secondaryMobileKeys refer to optional secondary environments. NOTE: See LDClient.h for the requirements to add secondaryMobileKeys. The SDK will throw an NSInvalidArgumentException if an attempt is made to set mobile keys that do not meet these requirements. • Installed LDClientInterface protocol used to access secondary environment feature flags. May also be used on the primary environment to provide normalized access to feature flags. • Adds environmentForMobileKeyNamed: to vend an environment (primary or secondary) object conforming to LDClientInterface. Use the vended object to access feature flags for the requested environment. • Adds new constant kLDPrimaryEnvironmentName used to vend the primary environment's LDClientInterface from environmentForMobileKeyNamed:.

Changed

  • LDUserBuilder build method no longer restores cached user attributes. The SDK sets into the LDUserModel object only the attributes in the LDUserBuilder at the time of the build message. On start, the SDK restores the last cached feature flags, which the SDK will use until the first feature flag update from the server.
  • Changed the format for caching feature flags to associate a set of feature flags with a mobile key. Downgrading to an earlier version will be able to store feature flags, but without the environment association. As a result, the SDK will not restore cached feature flags from 2.14.0 if the SDK is downgraded to a version before 2.14.0.
  • Installed a URL cache that does not use the [NSURLSession defaultSession] or the [NSURLCache sharedURLCache], precluding conflicts with custom client app URL caching.

Fixed

  • Fixed defect preventing SDK from calling userUpdated or featureFlagDidUpdate when deleting a feature flag under certain conditions.
  • Fixed defect preventing URL caching for feature flag requests using the REPORT verb.
  • Fixed defect causing the loss of some analytics events when changing users.

[2.13.9] - 2018-11-05

Fixed

  • Fixed defect causing a crash when unknown data exists in a feature flag cache.
  • Renamed function parameters to avoid the use of Objective-C++ reserved words.

[2.13.8] - 2018-10-23

Fixed

  • Fixed defect preventing feature flags cached prior to version 2.11.0 from restoring correctly and possibly crashing

[2.13.7] - 2018-10-15

Changed

  • Initializing LDClient in polling mode no longer blocks the calling thread.

[2.13.6] - 2018-10-05

Fixed

  • LDClient's updateUser did not attempt to retrieve the new user's cached flag values.
  • Fixed defect preventing a user's feature flags from being cached correctly under certain conditions.

[2.13.5] - 2018-09-23

Changed

  • Repairs Carthage build errors caused by higher fidelity checks in Xcode 10's new build engine.
  • Removes CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS from the podspec, allowing Xcode 10's default setting to be used

[2.13.4] - 2018-08-23

Changed

  • Update to DarklyEventSource 3.2.7

[2.13.3] - 2018-08-15

Changed

  • Synchronized summary event creation to limit thread access and protect data integrity
  • Improved the robustness of the code creating summary events to better handle unexpected data

[2.13.2] - 2018-07-27

Fixed

  • Updated DarklyEventSource in order to fix potential flag stream parsing issues.

[2.13.1] - 2018-06-25

Changed

  • Removed early tests for reaching event capacity that caused benign Thread Sanitizer warnings
  • Changed pointer nil tests to clear Static Analyzer pointer comparison warnings

[2.13.0] - 2018-06-01

Added

  • To reduce the network bandwidth used for analytics events, feature request events are now sent as counters rather than individual events, and user details are now sent only at intervals rather than in each event. These behaviors can be modified through the LaunchDarkly UI and with the new configuration option inlineUsersInEvents. For more details, see Data Export.
  • New property inlineUserInEvents in LDConfig. When YES includes the full user (excluding private attributes) in analytics feature and custom events. When NO includes only the userKey. Default: NO.
  • Calling start or updateUser (when started) on LDClient logs an analytics identify event. identify events contain the full user (excluding private attributes) regardless of inlineUserInEvents.
  • Adds analytics summary event used to track feature flag requests to the SDK.
  • Adds analytics debug event available to assist with debugging when requested from the website Debugger.

Changed

  • Changes analytics feature events so that they are only sent when requested via the website Dashboard.
  • Fixed a defect preventing the SDK from updating correctly on a put streaming event when there are no flag changes.
  • Fixed a defect on watchOS causing the SDK to report analytics dates incorrectly.

[2.12.1] - 2018-04-23

Changed

  • Clears selected warnings in CocoaPods project

[2.12.0] - 2018-04-22

Added

  • LDClient isOnline readonly property that reports the online/offline status.
  • LDClient setOnline method to set the online/offline status. setOnline may operate asynchronously, so the client calls an optional completion block when the requested operation completes.

Changed

  • Fixed potential memory leak with DarklyEventSource.

Removed

  • LDClient online and offline methods.

Fixed

  • Calling updateUser on LDClient while streaming no longer causes the SDK to request feature flags. The SDK now disconnects from the LaunchDarkly service and reconnects with the updated user.
  • Calling updateUser on LDClient while polling now resets the polling timer after making a feature flag request.

[2.11.2] - 2018-04-06

Changed

  • Changes the minimum required DarklyEventSource to version 3.2.1 in the CocoaPods podspec
  • The maximum backoff time for reconnecting to the feature stream is now 1 hour.

[2.11.1] - 2018-03-26

Changed

  • Changes the minimum required DarklyEventSource to version 3.2.0 in the CocoaPods podspec

[2.11.0] - 2018-03-15

Added

  • Support for enhanced feature streams, facilitating reduced SDK initialization times.

Changed

  • The streamUrl property on LDConfig now expects a path-less base URI. The default is now "https://clientstream.launchdarkly.com". If you override the default, you may need to modify the property value.

[2.10.1] - 2018-02-15

Changed

  • The minimum polling interval is now 5 minutes.

Fixed

  • Removes user flag config values from event reports
  • Improves SSE connection error handling

[2.10.0] - 2018-02-01

Added

  • Support for specifying private user attributes in order to prevent user attributes from being sent in analytics events back to LaunchDarkly. See the allUserAttributesPrivate and privateUserAttributes properties of LDConfig as well as the privateAttributes property of LDUserBuilder.

[2.9.1] - 2017-12-05

Fixed

  • Carthage builds no longer crash due to a missing DarklyEventSource library.

[2.9.0] - 2017-11-29

Changed

  • LDClientManager no longer extends UIApplicationDelegate. The framework is now marked as extension-safe. Thanks @atlassian-gaustin!

Added

  • Detect 401 Unauthorized response on flag & event requests, and take the client offline when detected.
  • Detect LDEventSource report of 401 Unauthorized response on connection requests, and take the client offline when detected.
  • LDClient delegate method userUnchanged called when the client receives a feature flag update that does not change any flag keys or values. Thanks @atlassian-gaustin!
  • Xcode 9 support

Fixed

  • LDPollingManager now reads the config set at the time of the startPolling message and configures polling timers accordingly.
  • LDRequestManager now reads the config set at the time of the performRequest message to configure the API request.
  • Removes duplicate LDEventSource libraries linked warning
  • updateUser now updates the LDUser anonymous property when using a default user key.

[2.8.0] - 2017-10-13

Added

  • useReport property on LDConfig to allow switching the request verb from GET to REPORT. Do not use unless advised by LaunchDarkly.

[2.7.0] - 2017-09-25

Changed

  • Updated for Xcode 9 support

[2.6.1] - 2017-09-21

Added

-streamUrl property on LDConfig to allow customizing the Server Sent Events engine in streaming mode.

[2.6.0] - 2017-08-25

Added

  • doubleVariation method for double value feature flags, as an alternative to numberVariation. Thanks @atlassian-gaustin!
  • serverConnectionUnavailable ClientDelegate method called when the LDClient receives an error response to a feature flag request. Thanks @atlassian-gaustin!

Changed

  • Prevent creating an EventSource when an EventSource is already running. Thanks @atlassian-gaustin!
  • Move feature flag response processing to the request thread, and once complete return the result on the main thread. Thanks @atlassian-gaustin!

Fixed

  • Array and Dictionary flags now return the array or dictionary when available from the server instead of always returning fallback values. Thanks @atlassian-gaustin!
  • Streaming no longer generates multiple feature flag requests on return to the foreground

[2.5.1] - 2017-08-03

Fixed

  • Feature flag requests for users with non-ASCII data are now encoded correctly
  • UserUpdatedNotification posts only when the feature flag configuration changes for the user
  • Events are no longer added to the event store when capacity is reached
  • Resolve potential symbol conflicts with EventSource
  • Feature flag request payloads are much smaller

[2.5.0] - 2017-07-09

Added

  • The name property in LDUserBuilder, for setting a full name. This property complements the existing firstName and lastName properties.

Changed

  • LDConfig has been refactored to replace the Builder pattern expected with LDConfigBuilder. Thanks @petrucci34!

Deprecated

  • LDConfigBuilder has been deprecated and will be removed in the 3.0 release.
  • The withXXX methods of LDUserBuilder have been deprecated in favor of properties. These methods will be removed in the 3.0 release.

[2.4.2] - 2017-06-20

Fixed

  • Race condition in LDPollingManager identified by Thread Sanitizer

[2.4.1] - 2017-06-15

Fixed

  • Memory leak with NSURLSession in EventSource. Thanks @jimmaye!

[2.4.0] - 2017-06-13

Added

  • The client's background fetch interval can be configured using withBackgroundFetchInterval.

Changed

  • By default, the client allows one background fetch per 60 minutes.

Fixed

  • Memory leak with NSURLSession in LDRequestManager. Thanks @jimmaye!
  • Race condition when the client is used in multiple threads

[2.3.3] - 2017-05-25

Changed

  • Feature flag persistence is now more efficient

Fixed

  • Client crashes if a feature flag is off and no off-variation is specified

[2.3.2] - 2017-05-18

Changed

  • The default connection timeout is now actually 10 seconds, down from the system default of 60 seconds. Use withConnectionTimeout to change the setting.

Fixed

  • Potential race conditions when HTTP requests exceed 10 seconds
  • HTTP requests now honor the configured connection timeout

[2.3.1] - 2017-04-25

Fixed

  • Benign race conditions in LDRequestManager

[2.3.0] - 2017-04-20

Added

  • Support for tvOS 9.0+
  • Support for watchOS 2.0+
  • Support for macOS 10.10+
  • Umbrella header (Darkly/Darkly.h)

Changed

  • Library is now a dynamic framework in order to support the Carthage dependency manager
  • Minimum supported iOS version is now iOS 8.0+
  • Updated streaming host from stream.launchdarkly.com to clientstream.launchdarkly.com
  • Default (foreground) polling interval was reduced to 5 minutes
  • Minimum polling interval was reduced to 1 minute

Fixed

  • Potential range exception issue in event processing

[2.2.0] - 2017-04-05

Added

  • Ability to disable streaming and enable interval-based polling

[2.1.3] - 2017-04-05

Fixed

  • Uncaught exception NSInvalidArgumentException in performEventRequest

[2.1.2] - 2017-03-20

Added

  • Backoff with jitter for connection establishment of eventsource

Fixed

  • Parity for start vs. online and stopClient vs. offline

[2.1.1] - 2017-01-04

Added

  • Method to get notified with the flag key for which the value had changed

Fixed

  • Background fetch issues fixed

[2.1.0] - 2016-12-19

Changed

  • Removed AFNetworking
  • Code optimizations and cleanup

Fixed

  • Optimized events storage and polling algorithms
  • Events generated simultaneously at the same time appear sequentially on web console without events loss

[2.0.3] - 2016-10-26

Changed

  • Updated to use AFNetworking 3.1
  • Minor code cleanup

Fixed

  • DarklyEventSource linker errors patched

[2.0.0] - 2016-09-01

Added

  • Support for multivariate feature flags. New methods for multivariate flags: stringVariation, numberVariation, arrayVariation, and dictionaryVariation have been added to LDClient.
  • Support for streaming and real-time feature flag updates
  • Added support for background fetching

Changed

  • In LDClient, toggle value is now called boolVariation
  • Changed 'default value' to 'fallback value' to represent the value returned if LaunchDarkly is unreachable and no previous settings are stored for the current user (no behavior changed)
  • Improved ability to store multiple unique user contexts per device
  • Improved support to ensure that a user receives the latest flag values even when the app is backgrounded or in airplane mode
  • In LDConfig, withApiKey has been renamed to withMobileKey

[1.1.0] - 2016-08-19

Dependency update

  • Removed dependency on Core Data (no interfaces or behavior changed)

[1.0.3] - 2016-08-17

Fixed

  • Device information is included in user custom attributes in events
  • Actual and default flag values are sent in Feature Request Events
  • Existing flag config data is no longer sent with evaluation requests, which avoids Too long request string errors