feat: Support seamless integration with amplitude experiment SDK (#378)

bgiori · web-flow · commit 26e78304f643 · 2022-02-04T16:00:00.000-08:00
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -37,6 +37,9 @@ jobs:
         run: |
           sudo xcode-select -switch /Applications/Xcode_12.app
 
+      - name: Carthage Bootstrap
+        run: carthage bootstrap --use-xcframeworks
+
       - name: Setup Ruby
         uses: actions/setup-ruby@v1
         with:
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -17,6 +17,9 @@ jobs:
         run: |
           sudo xcode-select -switch /Applications/Xcode_12.app
 
+      - name: Carthage Bootstrap
+        run: carthage bootstrap --use-xcframeworks
+
       - name: Setup Ruby
         uses: actions/setup-ruby@v1
         with:
diff --git a/.gitignore b/.gitignore
@@ -2,7 +2,7 @@
 /Pods
 /Build/
 /DerivedData/
-Carthage/Build
+Carthage/
 
 doc/
 .swiftpm
@@ -28,4 +28,4 @@ DerivedData/
 !default.perspectivev3
 
 ## Gcc Patch
-/*.gcno
+/*.gcno
diff --git a/Amplitude.podspec b/Amplitude.podspec
@@ -11,6 +11,8 @@ Pod::Spec.new do |s|
   s.requires_arc           = true
   s.library                = 'sqlite3.0'
 
+  s.swift_version = '4.1'
+  
   s.ios.deployment_target  = '10.0'
   s.ios.source_files       = 'Sources/Amplitude/**/*.{h,m}'
   s.ios.resources          = 'Sources/Resources/*.{der}'
@@ -26,6 +28,8 @@ Pod::Spec.new do |s|
   s.watchos.deployment_target  = '3.0'
   s.watchos.source_files       = 'Sources/Amplitude/**/*.{h,m}'
   s.watchos.resources          = 'Sources/Resources/*.{der}'
+  
+  s.dependency 'AnalyticsConnector', '~> 1.0.0'
 
   s.pod_target_xcconfig = { 'DEFINES_MODULE' => 'YES' }
 end
diff --git a/Amplitude.xcodeproj/project.pbxproj b/Amplitude.xcodeproj/project.pbxproj
diff --git a/Cartfile b/Cartfile
@@ -0,0 +1 @@
+github "amplitude/analytics-connector-ios" ~> 1.0.0
diff --git a/Cartfile.resolved b/Cartfile.resolved
@@ -0,0 +1 @@
+github "amplitude/analytics-connector-ios" "v1.0.0"
diff --git a/Package.swift b/Package.swift
@@ -13,6 +13,9 @@ let package = Package(
     products: [
         .library(name: "Amplitude", targets: ["Amplitude"]),
     ],
+    dependencies: [
+        .package(url: "https://github.com/amplitude/amplitude-ios-core.git", from: "1.0.0")
+    ],
     targets: [
         .target(
             name: "Amplitude",
@@ -21,3 +24,4 @@ let package = Package(
             publicHeadersPath: "Amplitude/Public"),
     ]
 )
+
diff --git a/Podfile b/Podfile
@@ -3,7 +3,7 @@ project 'Amplitude'
 abstract_target 'shared' do
   
   pod 'OCMock', '~> 3.2.1'
-  
+
   target 'Amplitude_iOSTests' do
       platform :ios, '10.0'
   end
diff --git a/Podfile.lock b/Podfile.lock
@@ -11,6 +11,6 @@ SPEC REPOS:
 SPEC CHECKSUMS:
   OCMock: 18c9b7e67d4c2770e95bb77a9cc1ae0c91fe3835
 
-PODFILE CHECKSUM: c234af1832073dccffe31825daef96d6b0eb126c
+PODFILE CHECKSUM: f4462aedc7398f89b3216737d86da7f673eb4649
 
 COCOAPODS: 1.11.2
diff --git a/README.md b/README.md
@@ -23,6 +23,21 @@ iOS/tvOS/macOS SDK for tracking events and revenue to [Amplitude](https://www.am
 * A [demo application](https://github.com/amplitude/iOS-Extension-Demo) showing an integration in an iOS extension.
 * A [demo application](https://github.com/amplitude/GTM-iOS-Demo) demonstrating a potential integration with Google Tag Manager.
 
+## Developing
+
+Prerequisites
+ * [Cocoapods](https://cocoapods.org/)
+ * [Carthage](https://github.com/Carthage/Carthage)
+
+1. Install Dependencies via Carthage
+    ```
+    carthage update --use-xcframeworks
+    ```
+2. Install Test Dependencies via CocoaPods
+    ```
+    pod install
+    ```
+
 ## Contributors
 <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
 <!-- prettier-ignore-start -->
diff --git a/Sources/Amplitude/Amplitude.m b/Sources/Amplitude/Amplitude.m
@@ -81,6 +81,8 @@
 #import <Cocoa/Cocoa.h>
 #endif
 
+@import AnalyticsConnector;
+
 @interface Amplitude ()
 
 @property (nonatomic, strong) NSOperationQueue *backgroundQueue;
@@ -221,6 +223,11 @@ - (instancetype)initWithInstanceName:(NSString *)instanceName {
         self.eventUploadPeriodSeconds = kAMPEventUploadPeriodSeconds;
         self.minTimeBetweenSessionsMillis = kAMPMinTimeBetweenSessionsMillis;
         _backoffUploadBatchSize = self.eventUploadMaxBatchSize;
+        
+        // Set the event receiver to forward events generated by Experiment SDK
+        [[[AnalyticsConnector getInstance:self.instanceName] eventBridge] setEventReceiver:^(AnalyticsEvent * _Nonnull event) {
+            [self logEvent:[event eventType] withEventProperties:[event eventProperties] withApiProperties:nil withUserProperties:[event userProperties] withGroups:nil withGroupProperties:nil withTimestamp:nil outOfSession:false];
+        }];
 
         _initializerQueue = [[NSOperationQueue alloc] init];
         _backgroundQueue = [[NSOperationQueue alloc] init];
@@ -448,6 +455,10 @@ - (void)initializeApiKey:(NSString *)apiKey
             } else {
                 self.userId = [self.dbHelper getValue:USER_ID];
             }
+            // Set the user ID and device ID in the amplitude core instance. This is used to share user identity and user properties
+            // between Analytics and Experiment SDKs.
+            id<IdentityStoreEditor> identityStoreEditor = [[[AnalyticsConnector getInstance:self.instanceName] identityStore] editIdentity];
+            [[[identityStoreEditor setUserId:self.userId] setDeviceId:self.deviceId] commit];
             if (self.initCompletionBlock != nil) {
                 self.initCompletionBlock();
             }
@@ -626,6 +637,12 @@ - (void)logEvent:(NSString *)eventType withEventProperties:(NSDictionary *)event
         } else {
             (void) [self.dbHelper addEvent:jsonString];
         }
+        
+        // Apply identify events to amplitude core to notify experiment SDK that user properties have changed.
+        if ([eventType isEqualToString:IDENTIFY_EVENT]) {
+            id<IdentityStoreEditor> editor = [[[AnalyticsConnector getInstance:self.instanceName] identityStore] editIdentity];
+            [[editor updateUserProperties:[event valueForKey:@"user_properties"]] commit];
+        }
 
         AMPLITUDE_LOG(@"Logged %@ Event", event[@"event_type"]);
 
@@ -1376,6 +1393,11 @@ - (void)setUserId:(NSString *)userId startNewSession:(BOOL)startNewSession {
 
         self->_userId = userId;
         [self.dbHelper insertOrReplaceKeyValue:USER_ID value:self.userId];
+        
+        // Set the user ID amplitude core instance. This is used to share user identity
+        // between Analytics and Experiment SDKs.
+        id<IdentityStoreEditor> identityStoreEditor = [[[AnalyticsConnector getInstance:self.instanceName] identityStore] editIdentity];
+        [[identityStoreEditor setUserId:self.userId] commit];
 
         if (startNewSession) {
             NSNumber *timestamp = [NSNumber numberWithLongLong:[[self currentTime] timeIntervalSince1970] * 1000];
@@ -1444,6 +1466,10 @@ - (void)setDeviceId:(NSString *)deviceId {
     [self runOnBackgroundQueue:^{
         self->_deviceId = deviceId;
         [self.dbHelper insertOrReplaceKeyValue:DEVICE_ID value:deviceId];
+        // Set the device ID in the amplitude core instance. This is used to share user identity
+        // between Analytics and Experiment SDKs.
+        id<IdentityStoreEditor> identityStoreEditor = [[[AnalyticsConnector getInstance:self.instanceName] identityStore] editIdentity];
+        [[identityStoreEditor setDeviceId:self.deviceId] commit];
     }];
 }
 

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+github "amplitude/analytics-connector-ios" ~> 1.0.0`
Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,9 @@ let package = Package(`
`13`	`13`	`products: [`
`14`	`14`	`.library(name: "Amplitude", targets: ["Amplitude"]),`
`15`	`15`	`],`
	`16`	`+ dependencies: [`
	`17`	`+ .package(url: "https://github.com/amplitude/amplitude-ios-core.git", from: "1.0.0")`
	`18`	`+ ],`
`16`	`19`	`targets: [`
`17`	`20`	`.target(`
`18`	`21`	`name: "Amplitude",`
`@@ -21,3 +24,4 @@ let package = Package(`
`21`	`24`	`publicHeadersPath: "Amplitude/Public"),`
`22`	`25`	`]`
`23`	`26`	`)`
	`27`	`+`