Version 4.0.0

Author: torchhound

.circleci/config.yml

@@ -1,8 +1,8 @@
-# config file version: 1.1.0
+# config file version: 1.2.0
 version: 2
 jobs:
   build:
-    working_directory: /Users/distiller/launchdarkly/ios-client/tmp
+    working_directory: /Users/distiller/launchdarkly/ios-swift-client-sdk-private/tmp
     parallelism: 1    # controls the # of containers for the job. In theory, adding another container should halve the number of tests run in each container, but instead appears to run all tests in both containers.
     shell: /bin/bash --login
 
@@ -12,7 +12,7 @@ jobs:
       FL_OUTPUT_DIR: output
 
     macos:
-      xcode: '10.1.0'
+      xcode: '10.2.0'
 
     steps:
     - checkout
@@ -47,7 +47,7 @@ jobs:
 
     - run:
         name: Clean, Build, & Test LaunchDarkly_iOS
-        command: set -o pipefail && xcodebuild clean build test -workspace 'LaunchDarkly.xcworkspace' -scheme 'LaunchDarkly_iOS' -sdk iphonesimulator -destination 'platform=iOS Simulator,name=iPhone XS,OS=latest' CODE_SIGNING_REQUIRED=NO CODE_SIGN_IDENTITY= PROVISIONING_PROFILE= | tee 'xcode_raw.log' | xcpretty --color --report html --output '/Users/distiller/launchdarkly/ios-client/tmp/output/report.html' --report junit --output '/Users/distiller/launchdarkly/ios-client/tmp/output/xcode/report.junit'
+        command: set -o pipefail && xcodebuild clean build test -workspace 'LaunchDarkly.xcworkspace' -scheme 'LaunchDarkly_iOS' -sdk iphonesimulator -destination 'platform=iOS Simulator,name=iPhone XS,OS=latest' CODE_SIGNING_REQUIRED=NO CODE_SIGN_IDENTITY= PROVISIONING_PROFILE= | tee 'xcode_raw.log' | xcpretty --color --report html --output '/Users/distiller/launchdarkly/ios-swift-client-sdk-private/tmp/output/report.html' --report junit --output '/Users/distiller/launchdarkly/ios-swift-client-sdk-private/tmp/output/xcode/report.junit'
 
     - run:
         name: Clean & Build LaunchDarkly_watchOS

.circleci/run-build-locally.sh

@@ -1,6 +1,6 @@
 # A script that triggers a circleci build from the command line
 # Script from https://circleci.com/docs/2.0/examples/#video-test-your-config-file-locally
-# Usage: From the project folder (e.g. 'ios-client') run 'bash .circleci/run-build-locally.sh'
+# Usage: From the project folder (e.g. 'ios-swift-client-sdk-private') run 'bash .circleci/run-build-locally.sh'
 #   Set the url to run in this format
 #   https://circleci.com/api/v1.1/project/<source, eg. github>/<user name>/<project name>/tree/<branch name>
 # Dependencies:
@@ -10,4 +10,4 @@ curl --user ${CIRCLE_TOKEN}: \
      --request POST \
      --form config=@.circleci/config.yml \
      --form notify=false \
-        https://circleci.com/api/v1.1/project/github/launchdarkly/ios-client/tree/master
+        https://circleci.com/api/v1.1/project/github/launchdarkly/ios-swift-client-sdk-private/tree/master

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,37 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is this a support request?**
+This issue tracker is maintained by LaunchDarkly SDK developers and is intended for feedback on the SDK code. If you're not sure whether the problem you are having is specifically related to the SDK, or to the LaunchDarkly service overall, it may be more appropriate to contact the LaunchDarkly support team; they can help to investigate the problem and will consult the SDK team if necessary. You can submit a support request by going [here](https://support.launchdarkly.com/) and clicking "submit a request", or by emailing support@launchdarkly.com.
+
+Note that issues filed on this issue tracker are publicly accessible. Do not provide any private account information on your issues. If your problem is specific to your account, you should submit a support request as described above.
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To reproduce**
+Steps to reproduce the behavior.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Logs**
+If applicable, add any log output related to your problem.
+
+**SDK version**
+The version of this SDK that you are using.
+
+**Language version, developer tools**
+For instance, Go 1.11 or Ruby 2.5.3. If you are using a language that requires a separate compiler, such as C, please include the name and version of the compiler too.
+
+**OS/platform**
+For instance, Ubuntu 16.04, Windows 10, or Android 4.0.3. If your code is running in a browser, please also include the browser type and version.
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I would love to see the SDK [...does something new...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context about the feature request here.

.jazzy.yaml

@@ -1,7 +1,7 @@
 module: LaunchDarkly
 author: LaunchDarkly
 author_url: http://launchdarkly.com
-github_url: https://github.com/launchdarkly/ios-client
+github_url: https://github.com/launchdarkly/ios-client-sdk
 clean: true
 include:
   - "LaunchDarkly/LaunchDarkly/**"

.swift-version

@@ -1 +1 @@
-4.2
+5.0

CHANGELOG.md

@@ -2,7 +2,25 @@
 
 All notable changes to the LaunchDarkly iOS SDK will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org).
 
-## [3.0.0-beta.3] - 2019-03-07
+### Multiple Environment clients
+Version 4.0.0 does not support multiple environments. If you use version `2.14.0` or later and set `LDConfig`'s `secondaryMobileKeys` you will not be able to migrate to version `4.0.0`. Multiple Environments will be added in a future release to the Swift SDK.
+
+## [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>`.
@@ -15,7 +33,8 @@ All notable changes to the LaunchDarkly iOS SDK will be documented in this file.
 - 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
 
-## [3.0.0-beta.2] - 2019-02-06
+## [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.
@@ -24,7 +43,8 @@ All notable changes to the LaunchDarkly iOS SDK will be documented in this file.
 - `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.
 
-## [3.0.0-beta.1] - 2018-12-11
+## [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`
@@ -38,8 +58,49 @@ All notable changes to the LaunchDarkly iOS SDK will be documented in this file.
 - `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.
 
-### Multiple Environment clients
-Version 3.0.0 does not support multiple environments. If you use version 2.14.0 or later and set `LDConfig`'s `secondaryMobileKeys` you will not be able to migrate to version 3.0.0. Multiple Environments will be added in a future release to the Swift SDK.
+## [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](#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](#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](#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

CONTRIBUTING.md

@@ -1,5 +1,31 @@
-Contributing to LaunchDarkly SDK for iOS
-=========================================
+Contributing to the LaunchDarkly SDK for iOS
+================================================
+ 
+LaunchDarkly has published an [SDK contributor's guide](https://docs.launchdarkly.com/docs/sdk-contributors-guide) that provides a detailed explanation of how our SDKs work. See below for additional information on how to contribute to this SDK.
+ 
+Submitting bug reports and feature requests
+------------------
 
-We encourage pull-requests and other contributions from the community. We've also published an [SDK contributor's guide](http://docs.launchdarkly.com/docs/sdk-contributors-guide) that provides a detailed explanation of how our SDKs work.
+The LaunchDarkly SDK team monitors the [issue tracker](https://github.com/launchdarkly/ios-client-sdk/issues) in the SDK repository. Bug reports and feature requests specific to this SDK should be filed in this issue tracker. The SDK team will respond to all newly filed issues within two business days.
+ 
+Submitting pull requests
+------------------
+ 
+We encourage pull requests and other contributions from the community. Before submitting pull requests, ensure that all temporary or unintended code is removed. Don't worry about adding reviewers to the pull request; the LaunchDarkly SDK team will add themselves. The SDK team will acknowledge all pull requests within two business days.
+ 
+Build instructions
+------------------
+ 
+### Prerequisites
+ 
+This SDK is built with [XCode](https://developer.apple.com/xcode/). This version is compatible with XCode 10.2.
+ 
+### Building
+ 
+The exact command used to build the SDK depends on where you want to use it (for example -- iOS, watchOS, etc.). Refer to the `xcodebuild` commands in the SDK's [continuous integration build configuration](.circleci/config.yml) for examples on how to build for the different platforms.
 
+If you wish to clean your working directory between builds, include the `clean` goal in your `xcodebuild` command(s).
+ 
+### Testing
+ 
+To build the SDK and run all unit tests, include the `test` goal in your `xcodebuild` command(s).