Skip to content

Latest commit

 

History

History
263 lines (203 loc) · 11.4 KB

CHANGELOG.md

File metadata and controls

263 lines (203 loc) · 11.4 KB

Change log

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

[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 Analytics Data Stream Reference.
  • 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