Support tvOS (#90)

- Add support to tvOS
- Update KeenClientTD to 3.3.0
- Add TVOS example app
- Update CircleCI config to support CircleCI 2.0 and `commands` feature

Author: tung-vu-td

.circleci/config.yml

@@ -1,173 +1,182 @@
-version: 2
-
-_defaults:
-
-  - &auxiliary_setup
-    run:
-      name: Auxiliary setup
-      command: |
-        gem install xcpretty --user-install
-        HOMEBREW_NO_AUTO_UPDATE=1 brew install gnu-sed # for ci_test script
-        mkdir logs test_results
-
-  - &restore_pods_cache
-    restore_cache:
-      name: Restore Pods cache
-      keys:
-        - v3-pods-{{ checksum "Podfile.lock" }}
-
-  - &install_pods
-    run:
-      name: Install Pods
-      command: ./scripts/ci_pod_install
-
-  - &save_pods_cache
-    save_cache:
-      name: Saving Pods cache
-      key: v3-pods-{{ checksum "Podfile.lock" }}
-      paths:
-        - Pods
-        - TreasureData.xcworkspace
-
-  - &store_artifacts
-    store_artifacts:
-      path: ./logs
-      destination: logs
-
-  - &store_test_results
-    store_test_results:
-      path: ./test_results
-
-  - &ios9_install_and_workaround
-    run:
-      name: iOS 9 Install and  Workaround
-      command: |
-        xcversion simulators --install='iOS 9.3' --no-progress
-        sudo mkdir '/Library/Developer/CoreSimulator/Profiles/Runtimes/iOS 9.3.simruntime/Contents/Resources/RuntimeRoot/usr/lib/swift'
-
-  - &ios8_install_and_workaround
-    run:
-      name: iOS 8 Install and Workaround
-      command: |
-        xcversion simulators --install='iOS 8.4' --no-progress
-        sudo mkdir '/Library/Developer/CoreSimulator/Profiles/Runtimes/iOS 8.4.simruntime/Contents/Resources/RuntimeRoot/usr/lib/swift'
+version: 2.1
+
+
+commands:
+  auxiliary_setup:
+    description: "Various setup before running tests"
+    steps:
+      - run:
+          name: Auxiliary setup
+          command: |
+            gem install xcpretty --user-install
+            HOMEBREW_NO_AUTO_UPDATE=1 brew install gnu-sed # for ci_test script
+            mkdir logs test_results
+
+  install_cocoapods:
+    description: "Command to install and cache Cocoapods"
+    steps:
+      - restore_cache:
+          key: 1-gems-{{ checksum "Gemfile.lock" }}
+      - run: bundle check || bundle install --path vendor/bundle --clean
+      - save_cache:
+          key: 1-gems-{{ checksum "Gemfile.lock" }}
+          paths:
+            - vendor/bundle
+
+  install_pods:
+    description: "Command to install and cache pods"
+    steps:
+      - restore_cache:
+          name: Restore Pods cache
+          keys:
+            - v3-pods-{{ checksum "Podfile.lock" }}
+      - run:
+          name: Install Pods
+          command: ./scripts/ci_pod_install
+      - save_cache:
+          name: Saving Pods cache
+          key: v3-pods-{{ checksum "Podfile.lock" }}
+          paths:
+            - Pods
+            - TreasureData.xcworkspace
+
+  run_tests:
+    description: ""
+    parameters:
+      version_name:
+        type: "string"
+      os:
+        type: "string"
+      simulator:
+        type: "string"
+        default: "iphone 11"
+      no_output_timeout:
+        type: integer
+        default: 1800
+    steps:
+      - run:
+          name: Test on iOS <<parameters.version_name>>
+          no_output_timeout: <<parameters.no_output_timeout>>
+          command: ./scripts/ci_test 'platform=iOS Simulator,name=<<parameters.simulator>>,OS=<<parameters.os>>' logs/xcbuild_ios_<<parameters.version_name>>.log test_results/ios_<<parameters.version_name>>.xml
+
+  store_results:
+    description: "Command to store artifacts and test results"
+    steps:
+      - store_artifacts:
+          path: ./logs
+          destination: logs
+      - store_test_results:
+          path: ./test_results
+
+  ios9_install_and_workaround:
+    description: "Command for iOS 9 workaround"
+    steps:
+      - run:
+          name: iOS 9 Install and  Workaround
+          command: |
+            xcversion simulators --install='iOS 9.3' --no-progress
+            sudo mkdir '/Library/Developer/CoreSimulator/Profiles/Runtimes/iOS 9.3.simruntime/Contents/Resources/RuntimeRoot/usr/lib/swift'
+
+  ios8_install_and_workaround:
+    description: "Command for iOS 8 workaround"
+    steps:
+      - run:
+          name: iOS 8 Install and Workaround
+          command: |
+            xcversion simulators --install='iOS 8.4' --no-progress
+            sudo mkdir '/Library/Developer/CoreSimulator/Profiles/Runtimes/iOS 8.4.simruntime/Contents/Resources/RuntimeRoot/usr/lib/swift'
+
+  run_tests_flow:
+    description: "Single flow for running tests targetting specified iOS"
+    parameters:
+      version_name:
+        type: "string"
+      os:
+        type: "string"
+      simulator:
+        type: "string"
+        default: "iphone 11"
+      no_output_timeout:
+        type: integer
+        default: 1800
+    steps:
+      - checkout
+      - auxiliary_setup
+      - install_cocoapods
+      - install_pods
+      - run_tests:
+          version_name: <<parameters.version_name>>
+          os: <<parameters.os>>
+          simulator: <<parameters.simulator>>
+      - store_results
+
 
 jobs:
   test_ios14:
     macos:
       xcode: "12.0.0"
     steps:
-      - checkout
-      - *auxiliary_setup
-      - *restore_pods_cache
-      - *install_pods
-      - *save_pods_cache
-      - run:
-          name: Test on iOS 14
-          no_output_timeout: 1800
-          command: ./scripts/ci_test 'platform=iOS Simulator,name=iPhone 11,OS=14.0' logs/xcbuild_ios_14.log test_results/ios_14.xml
-      - *store_artifacts
-      - *store_test_results
-
+      - run_tests_flow:
+          version_name: "14"
+          os: "14.0"
+          simulator: "iPhone 11"
 
   test_ios13:
     macos:
       xcode: "11.6.0"
     steps:
-      - checkout
-      - *auxiliary_setup
-      - *restore_pods_cache
-      - *install_pods
-      - *save_pods_cache
-      - run:
-          name: Test on iOS 13
-          no_output_timeout: 1800
-          command: ./scripts/ci_test 'platform=iOS Simulator,name=iPhone 11,OS=13.6' logs/xcbuild_ios_13.log test_results/ios_13.xml
-      - *store_artifacts
-      - *store_test_results
+      - run_tests_flow:
+          version_name: "13"
+          os: "13.6"
+          simulator: "iPhone 11"
 
   test_ios12:
     macos:
       xcode: "10.2.1" 
     steps:
-      - checkout
-      - *auxiliary_setup
-      - *restore_pods_cache
-      - *install_pods
-      - *save_pods_cache
-      - run:
-          name: Test on iOS 12
-          no_output_timeout: 1800
-          command: ./scripts/ci_test 'platform=iOS Simulator,name=iPhone 7,OS=12.2' logs/xcbuild_ios_12.log test_results/ios_12.xml
-      - *store_artifacts
-      - *store_test_results
+      - run_tests_flow:
+          version_name: "12"
+          os: "12.2"
+          simulator: "iPhone 7"
 
   test_ios11:
     macos:
       xcode: "10.2.1"
     steps:
-      - checkout
-      - *auxiliary_setup
-      - *restore_pods_cache
-      - *install_pods
-      - *save_pods_cache
-      - run:
-          name: Test on iOS 11
-          no_output_timeout: 1800
-          command: ./scripts/ci_test 'platform=iOS Simulator,name=iPhone 7,OS=11.4' logs/xcbuild_ios_10.log test_results/ios_10.xml
-      - *store_artifacts
-      - *store_test_results
+      - run_tests_flow:
+          version_name: "11"
+          os: "11.4"
+          simulator: "iPhone 7"
 
   test_ios10:
     macos:
       xcode: "10.2.1"
 
     steps:
-      - checkout
-      - *auxiliary_setup
-      - *restore_pods_cache
-      - *install_pods
-      - *save_pods_cache
-      - run:
-          name: Test on iOS 10
-          no_output_timeout: 1800
-          command: ./scripts/ci_test 'platform=iOS Simulator,name=iPhone 7,OS=10.3.1' logs/xcbuild_ios_10.log test_results/ios_10.xml
-      - *store_artifacts
-      - *store_test_results
+      - run_tests_flow:
+          version_name: "10"
+          os: "10.3.1"
+          simulator: "iPhone 7"
 
   test_ios9:
     macos:
       xcode: "10.2.1"
     steps:
-      - checkout
-      - *ios9_install_and_workaround
-      - *auxiliary_setup
-      - *restore_pods_cache
-      - *install_pods
-      - *save_pods_cache
-      - run:
-          name: Test on iOS 9
-          no_output_timeout: 1800
-          command: ./scripts/ci_test 'platform=iOS Simulator,name=iPhone 6s,OS=9.3' logs/xcbuild_ios_9.log test_results/ios_9.xml
-      - *store_artifacts
-      - *store_test_results
+      - ios9_install_and_workaround
+      - run_tests_flow:
+          version_name: "9"
+          os: "9.3"
+          simulator: "iPhone 6s"
 
   test_ios8:
     macos:
       xcode: "10.2.1"
     steps:
-      - checkout
-      - *ios8_install_and_workaround
-      - *auxiliary_setup
-      - *restore_pods_cache
-      - *install_pods
-      - *save_pods_cache
-      - run:
-          name: Test on iOS 8
-          no_output_timeout: 1800
-          command: ./scripts/ci_test 'platform=iOS Simulator,name=iPhone 6,OS=8.4' logs/xcbuild_ios_8.log test_results/ios_8.xml
-      - *store_artifacts
-      - *store_test_results
+      - ios8_install_and_workaround
+      - run_tests_flow:
+          version_name: "8"
+          os: "8.4"
+          simulator: "iPhone 6"
 
 
 workflows:

Gemfile

@@ -1,4 +1,4 @@
 source 'https://rubygems.org'
 
 gem "rake"
-gem "cocoapods", '= 1.1.1'
+gem "cocoapods", '= 1.9.3'

Podfile

@@ -1,7 +1,7 @@
 platform :ios, '7.0'
 
 target 'TreasureData' do
-  pod 'KeenClientTD', '= 3.2.35'
+  pod 'KeenClientTD', '= 3.3.0'
 end
 
 target 'TreasureDataTests' do

Podfile.lock

@@ -1,18 +1,18 @@
 PODS:
-  - KeenClientTD (3.2.35):
-    - KeenClientTD/keen_sqlite (= 3.2.35)
-  - KeenClientTD/keen_sqlite (3.2.35)
+  - KeenClientTD (3.3.0):
+    - KeenClientTD/keen_sqlite (= 3.3.0)
+  - KeenClientTD/keen_sqlite (3.3.0)
 
 DEPENDENCIES:
-  - KeenClientTD (= 3.2.35)
+  - KeenClientTD (= 3.3.0)
 
 SPEC REPOS:
-  https://github.com/cocoapods/specs.git:
+  https://cdn.cocoapods.org/:
     - KeenClientTD
 
 SPEC CHECKSUMS:
-  KeenClientTD: dc8f7d3948b650b6c04a3be73f947bb757467efd
+  KeenClientTD: 0e0399a8e5030890ace84644cea0bd39463c3ad4
 
-PODFILE CHECKSUM: 7148f57bcf4b8488673f52ee710cf2de23769865
+PODFILE CHECKSUM: 1f896df3bc3ce253b645f6fffc7b165c2819c6b7
 
-COCOAPODS: 1.7.5
+COCOAPODS: 1.9.3

README.md

@@ -1,7 +1,7 @@
 Treasure Data iOS SDK
 ===============
 
-iOS SDK for [Treasure Data](http://www.treasuredata.com/). With this SDK, you can import the events on your applications into Treasure Data easily. Technically, this library supports iOS 7 and later, but we only execute OS coverage tests for iOS 8, 9, 10, 11, 12, 13 and 14.
+iOS and tvOS SDK for [Treasure Data](http://www.treasuredata.com/). With this SDK, you can import the events on your applications into Treasure Data easily. Technically, this library supports iOS 7 and later, but we only execute OS coverage tests for iOS 8, 9, 10, 11, 12, 13 and 14. This SDK also support Apple tvOS 12 and up.
 
 Also, there is an alternative SDK written in Swift [https://github.com/recruit-lifestyle/TreasureDataSDK](https://github.com/recruit-lifestyle/TreasureDataSDK). Note, however, that it does not support current GDPR functionality in the mainstream TD SDKs.
 
@@ -135,6 +135,8 @@ It depends on the characteristic of your application when to upload and how ofte
 
 The sent events is going to be buffered for a few minutes before they get imported into Treasure Data storage.
 
+In tvOS, cache storage is stored in cache directory which can be purged at any time. It is highly recommended to call upload events APIs as requently as possible to prevent loss of data.
+
 ### Retry uploading and deduplication
 
 This SDK imports events in exactly once style with the combination of these features.
@@ -516,6 +518,13 @@ These can be opted back in by calling `enableCustomEvent` or `enableAppLifecycle
 
 - Use `resetUniqId` to reset the identification of device on subsequent events. `td_uuid` will be randomized to another value and an extra event is captured with `{"td_ios_event":  "forget_device_id", "td_uuid": <old_uuid>}` to the `defaultTable`.
 
+## tvOS
+
+This SDK supports Apple tvOS version 12 and up. APIs and their behaviors are largely the same as being used in iOS application, except:
+
+! In tvOS, cache storage is stored in cache directory which can be purged at any time. It is highly recommended to call upload events APIs as requently as possible to prevent loss of data.
+
+
 ## Troubleshooting
 
 #### With "Data Protection" enabled, TD iOS SDK occasionally crashes