Merge branch 'master' into vnext_minor

baumatron · baumatron · commit ba7e7e4b9b07 · 2017-06-09T21:06:58.000-05:00
diff --git a/.travis.yml b/.travis.yml
@@ -9,14 +9,14 @@ xcode_scheme:
   - KeenClientFramework
 xcode_sdk: iphonesimulator10.3
 env:
-  - XCODEBUILD_PLATFORM='iOS Simulator' XCODEBUILD_SIM_OS=10.3 XCODEBUILD_DEVICE='iPhone 6' XCODEBUILD_ACTION=build
+  - XCODEBUILD_PLATFORM='iOS Simulator' XCODEBUILD_SIM_OS=10.3.1 XCODEBUILD_DEVICE='iPhone 6' XCODEBUILD_ACTION=build
 
 matrix:
   include:
     - xcode_scheme: KeenClient
       xcode_sdk: iphonesimulator10.3
       env:
-        - XCODEBUILD_PLATFORM='iOS Simulator' XCODEBUILD_SIM_OS=10.3 XCODEBUILD_DEVICE='iPhone 6' XCODEBUILD_ACTION=test
+        - XCODEBUILD_PLATFORM='iOS Simulator' XCODEBUILD_SIM_OS=10.3.1 XCODEBUILD_DEVICE='iPhone 6' XCODEBUILD_ACTION=test
     - xcode_scheme: KeenClient
       xcode_sdk: iphonesimulator10.3
       env:
@@ -31,20 +31,20 @@ matrix:
         - XCODEBUILD_PLATFORM='OS X' XCODEBUILD_ACTION=build
     - xcode_scheme: KeenClientExampleObjCCocoaPods
       xcode_sdk: iphonesimulator10.3
-      env: POD_INSTALL=true XCODEBUILD_WORKSPACE=Examples/objc/cocoapods/KeenClientExampleObjCCocoaPods.xcworkspace XCODEBUILD_PLATFORM='iOS Simulator' XCODEBUILD_SIM_OS=10.3 XCODEBUILD_DEVICE='iPhone 6' XCODEBUILD_ACTION=build
+      env: POD_INSTALL=true XCODEBUILD_WORKSPACE=Examples/objc/cocoapods/KeenClientExampleObjCCocoaPods.xcworkspace XCODEBUILD_PLATFORM='iOS Simulator' XCODEBUILD_SIM_OS=10.3.1 XCODEBUILD_DEVICE='iPhone 6' XCODEBUILD_ACTION=build
     - xcode_scheme: KeenClientExampleObjCCarthage
       xcode_sdk: iphonesimulator10.3
-      env: CARTHAGE_INSTALL=true XCODEBUILD_PROJECT=Examples/objc/carthage/KeenClientExampleObjCCarthage.xcodeproj XCODEBUILD_PROJECT_TARGET=KeenClientExampleObjCCarthage XCODEBUILD_PLATFORM='iOS Simulator' XCODEBUILD_SIM_OS=10.3 XCODEBUILD_DEVICE='iPhone 6' XCODEBUILD_ACTION=build
+      env: CARTHAGE_INSTALL=true XCODEBUILD_PROJECT=Examples/objc/carthage/KeenClientExampleObjCCarthage.xcodeproj XCODEBUILD_PROJECT_TARGET=KeenClientExampleObjCCarthage XCODEBUILD_PLATFORM='iOS Simulator' XCODEBUILD_SIM_OS=10.3.1 XCODEBUILD_DEVICE='iPhone 6' XCODEBUILD_ACTION=build
     - xcode_scheme: KeenClientExampleSwiftCocoaPods
       xcode_sdk: iphonesimulator10.3
-      env: POD_INSTALL=true XCODEBUILD_WORKSPACE=Examples/swift/cocoapods/KeenClientExampleSwiftCocoaPods.xcworkspace XCODEBUILD_PLATFORM='iOS Simulator' XCODEBUILD_SIM_OS=10.3 XCODEBUILD_DEVICE='iPhone 6' XCODEBUILD_ACTION=build
+      env: POD_INSTALL=true XCODEBUILD_WORKSPACE=Examples/swift/cocoapods/KeenClientExampleSwiftCocoaPods.xcworkspace XCODEBUILD_PLATFORM='iOS Simulator' XCODEBUILD_SIM_OS=10.3.1 XCODEBUILD_DEVICE='iPhone 6' XCODEBUILD_ACTION=build
     - xcode_scheme: KeenClientExampleSwiftCarthage
       xcode_sdk: iphonesimulator10.3
-      env: CARTHAGE_INSTALL=true XCODEBUILD_PROJECT=Examples/swift/carthage/KeenClientExampleSwiftCarthage.xcodeproj XCODEBUILD_PROJECT_TARGET=KeenClientExampleSwiftCarthage XCODEBUILD_PLATFORM='iOS Simulator' XCODEBUILD_SIM_OS=10.3 XCODEBUILD_DEVICE='iPhone 6' XCODEBUILD_ACTION=build
+      env: CARTHAGE_INSTALL=true XCODEBUILD_PROJECT=Examples/swift/carthage/KeenClientExampleSwiftCarthage.xcodeproj XCODEBUILD_PROJECT_TARGET=KeenClientExampleSwiftCarthage XCODEBUILD_PLATFORM='iOS Simulator' XCODEBUILD_SIM_OS=10.3.1 XCODEBUILD_DEVICE='iPhone 6' XCODEBUILD_ACTION=build
 
 before_install:
   - gem install bundler
-  - rvm use 2.3.0
+  - rvm use 2.4.1
 
 script: ./bin/test.sh
 
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,10 @@ All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
 
+## [3.6.2] - 2017-06-08
+### Fixed
+- Fixed issue where calling `uploadWithFinishedBlock:` quickly in succession could cause duplicate event uploads.
+
 ## [3.6.1] - 2017-05-12
 ### Fixed
 - Fixed missing headers from framework build
diff --git a/Examples/objc/carthage/Cartfile b/Examples/objc/carthage/Cartfile
@@ -1 +1 @@
-git "keenlabs/KeenClient-iOS"
+github "keenlabs/KeenClient-iOS"
diff --git a/Examples/swift/carthage/Cartfile b/Examples/swift/carthage/Cartfile
@@ -1 +1 @@
-git "keenlabs/KeenClient-iOS"
+github "keenlabs/KeenClient-iOS"
diff --git a/Gemfile b/Gemfile
@@ -1,5 +1,5 @@
 source 'https://rubygems.org'
-ruby '2.3.0'
+ruby '2.4.1'
 
 gem 'slather'
 gem 'xcpretty'
diff --git a/KeenClient.podspec b/KeenClient.podspec
@@ -1,6 +1,6 @@
 Pod::Spec.new do |spec|
   spec.name         = 'KeenClient'
-  spec.version      = '3.6.1'
+  spec.version      = '3.6.2'
   spec.license      = { :type => 'MIT' }
   spec.ios.deployment_target = '6.0'
   spec.osx.deployment_target = '10.9'
diff --git a/KeenClient.xcodeproj/project.pbxproj b/KeenClient.xcodeproj/project.pbxproj
@@ -75,6 +75,7 @@
 		480FEB751E846F7500641112 /* KIOUtil.m in Sources */ = {isa = PBXBuildFile; fileRef = 480FEB701E846F7500641112 /* KIOUtil.m */; };
 		480FEB761E846F7500641112 /* KIOUtil.m in Sources */ = {isa = PBXBuildFile; fileRef = 480FEB701E846F7500641112 /* KIOUtil.m */; };
 		481496EC1EC3832C00A9DEED /* SavedQueryTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 481496EB1EC3832C00A9DEED /* SavedQueryTests.m */; };
+		481794741EE8F66500586007 /* MockNSURLSession.m in Sources */ = {isa = PBXBuildFile; fileRef = 481794731EE8F66500586007 /* MockNSURLSession.m */; };
 		481A9B7C1E5690950094B985 /* KeenLogSinkNSLog.h in Headers */ = {isa = PBXBuildFile; fileRef = 481A9B7A1E5690950094B985 /* KeenLogSinkNSLog.h */; };
 		481A9B7D1E5690950094B985 /* KeenLogSinkNSLog.m in Sources */ = {isa = PBXBuildFile; fileRef = 481A9B7B1E5690950094B985 /* KeenLogSinkNSLog.m */; };
 		481A9B7E1E5691270094B985 /* KeenLogSink.h in Headers */ = {isa = PBXBuildFile; fileRef = 481A9B711E5687EA0094B985 /* KeenLogSink.h */; settings = {ATTRIBUTES = (Public, ); }; };
@@ -206,6 +207,8 @@
 		480FEB701E846F7500641112 /* KIOUtil.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = KIOUtil.m; sourceTree = "<group>"; };
 		481496EA1EC3832C00A9DEED /* SavedQueryTests.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SavedQueryTests.h; sourceTree = "<group>"; };
 		481496EB1EC3832C00A9DEED /* SavedQueryTests.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SavedQueryTests.m; sourceTree = "<group>"; };
+		481794721EE8F66500586007 /* MockNSURLSession.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = MockNSURLSession.h; sourceTree = "<group>"; };
+		481794731EE8F66500586007 /* MockNSURLSession.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = MockNSURLSession.m; sourceTree = "<group>"; };
 		481A9B711E5687EA0094B985 /* KeenLogSink.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = KeenLogSink.h; sourceTree = "<group>"; };
 		481A9B7A1E5690950094B985 /* KeenLogSinkNSLog.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = KeenLogSinkNSLog.h; sourceTree = "<group>"; };
 		481A9B7B1E5690950094B985 /* KeenLogSinkNSLog.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = KeenLogSinkNSLog.m; sourceTree = "<group>"; };
@@ -468,6 +471,8 @@
 				486B59711EB29C5200D5251D /* KIOUploaderTestable.h */,
 				4888924B1EC13C21008C6024 /* TestDatabaseRequirement.h */,
 				4888924C1EC13C21008C6024 /* TestDatabaseRequirement.m */,
+				481794721EE8F66500586007 /* MockNSURLSession.h */,
+				481794731EE8F66500586007 /* MockNSURLSession.m */,
 			);
 			name = Shared;
 			sourceTree = "<group>";
@@ -783,6 +788,7 @@
 			isa = PBXSourcesBuildPhase;
 			buildActionMask = 2147483647;
 			files = (
+				481794741EE8F66500586007 /* MockNSURLSession.m in Sources */,
 				CA6410E218E39F3A00E53E3C /* KIODBStoreTests.m in Sources */,
 				486B596E1EB29B0A00D5251D /* KeenTestCaseBase.m in Sources */,
 				48CAA1781ED60792003C2008 /* DatasetTests.m in Sources */,
diff --git a/KeenClient/KIOUploader.m b/KeenClient/KIOUploader.m
@@ -40,6 +40,10 @@ - (void)handleEventAPIResponse:(NSURLResponse *)response
 
 @property (nonatomic) KIONetwork *network;
 
+@property BOOL isUploading;
+
+@property NSCondition *isUploadingCondition;
+
 @end
 
 @implementation KIOUploader
@@ -71,6 +75,9 @@ - (instancetype)initWithNetwork:(KIONetwork *)network andStore:(KIODBStore *)sto
 
         self.maxEventUploadAttempts = 3;
 
+        self.isUploadingCondition = [NSCondition new];
+        self.isUploading = NO;
+
         self.network = network;
 
         self.store = store;
@@ -170,6 +177,10 @@ - (void)uploadEventsForConfig:(KeenClientConfig *)config completionHandler:(void
                 }
             }
 
+            [self.isUploadingCondition lock];
+            self.isUploading = YES;
+            [self.isUploadingCondition unlock];
+
             // then make an http request to the keen server.
             [self.network sendEvents:data
                               config:config
@@ -178,7 +189,20 @@ - (void)uploadEventsForConfig:(KeenClientConfig *)config completionHandler:(void
                        [self handleEventAPIResponse:response andData:data forEvents:eventIDs];
 
                        [self runUploadFinishedBlock:completionHandler];
+
+                       [self.isUploadingCondition lock];
+                       self.isUploading = NO;
+                       [self.isUploadingCondition signal];
+                       [self.isUploadingCondition unlock];
                    }];
+
+            // Block the queue until uploading has finished.
+            // Otherwise we'll pick up events that are in flight and try to upload them again
+            [self.isUploadingCondition lock];
+            while (self.isUploading) {
+                [self.isUploadingCondition waitUntilDate:[NSDate dateWithTimeIntervalSinceNow:60]];
+            }
+            [self.isUploadingCondition unlock];
         }
     });
 }
diff --git a/KeenClient/KeenConstants.h b/KeenClient/KeenConstants.h
@@ -8,7 +8,7 @@
 
 #import <Foundation/Foundation.h>
 
-#define kKeenSdkVersion @"3.6.1"
+#define kKeenSdkVersion @"3.6.2"
 
 extern NSString * const kKeenServerAddress;
 extern NSString * const kKeenApiVersion;
diff --git a/KeenClientFramework/Info.plist b/KeenClientFramework/Info.plist
@@ -15,11 +15,11 @@
 	<key>CFBundlePackageType</key>
 	<string>FMWK</string>
 	<key>CFBundleShortVersionString</key>
-	<string>3.6.1</string>
+	<string>3.6.2</string>
 	<key>CFBundleSignature</key>
 	<string>????</string>
 	<key>CFBundleVersion</key>
-	<string>3.6.1</string>
+	<string>3.6.2</string>
 	<key>NSPrincipalClass</key>
 	<string></string>
 </dict>
diff --git a/KeenClientTests/KeenEventTests.m b/KeenClientTests/KeenEventTests.m
@@ -901,6 +901,46 @@ - (void)testUploadMultipleTimesInstanceClient {
     [self waitForExpectationsWithTimeout:kTestExpectationTimeoutInterval handler:nil];
 }
 
+- (void)testUploadEventDoesntDuplicateWithMultipleCallsToUpload {
+    NSDictionary *eventResult = [self buildResultWithSuccess:YES andErrorCode:nil andDescription:nil];
+    NSDictionary *result =
+        [NSDictionary dictionaryWithObject:[NSArray arrayWithObjects:eventResult, nil] forKey:@"foo"];
+
+    __block NSInteger requestCount = 0;
+    __block NSInteger uploadCallCount = 0;
+    const NSInteger totalUploadCallCount = 10;
+    KeenClient* client = [self createClientWithResponseData:result andStatusCode:HTTPCode200OK andNetworkConnected:@YES andRequestValidator:^BOOL(id obj) {
+        requestCount++;
+        return @YES;
+    }];
+
+    // add an event
+    [client addEvent:[NSDictionary dictionaryWithObject:@"apple" forKey:@"a"] toEventCollection:@"foo" error:nil];
+
+    NSUInteger pendingEvents = [client.store getTotalEventCountWithProjectID:kDefaultProjectID];
+    XCTAssertEqual(pendingEvents, 1, @"There should be an event awaiting upload.");
+
+    // and "upload" it
+    XCTestExpectation *responseArrived = [self expectationWithDescription:@"response of async request has arrived"];
+    for (int i = 0; i < totalUploadCallCount; ++i) {
+        [client uploadWithFinishedBlock:^{
+            uploadCallCount++;
+            if (uploadCallCount == totalUploadCallCount) {
+                [responseArrived fulfill];
+            }
+        }];
+    }
+
+    [self waitForExpectationsWithTimeout:_asyncTimeInterval
+                                 handler:^(NSError *_Nullable error) {
+                                     // make sure the events were deleted locally
+                                     XCTAssertTrue([client.store getTotalEventCountWithProjectID:nil] == 0,
+                                                   @"There should be no files after a successful upload.");
+                                 }];
+
+    XCTAssertEqual(requestCount, 1, @"Only one request should have been made");
+}
+
 - (void)testTooManyEventsCached {
     KeenClient *client = [KeenClient sharedClientWithProjectID:kDefaultProjectID
                                                    andWriteKey:kDefaultWriteKey
diff --git a/KeenClientTests/KeenTestCaseBase.m b/KeenClientTests/KeenTestCaseBase.m
@@ -20,6 +20,7 @@
 #import "HTTPCodes.h"
 #import "TestDatabaseRequirement.h"
 #import "KIODBStoreTestable.h"
+#import "MockNSURLSession.h"
 
 #import "KeenTestCaseBase.h"
 
@@ -126,26 +127,12 @@ - (id)createClientWithResponseData:(id)data
                           andRequestValidator:nil];
 }
 
-- (id)mockUrlSessionWithResponse:(NSHTTPURLResponse *)response
-                 andResponseData:(NSData *)responseData
+- (id)mockUrlSessionWithResponse:(NSHTTPURLResponse*)response
+                 andResponseData:(NSData*)responseData
              andRequestValidator:(BOOL (^)(id requestObject))requestValidator {
     // Mock the NSURLSession to be used for the request
-    id urlSessionMock = [OCMockObject partialMockForObject:[[NSURLSession alloc] init]];
-
-    // Set up fake response data and request validation
-    if (nil != requestValidator) {
-        // Set up validation of the request
-        [[urlSessionMock expect]
-            dataTaskWithRequest:[OCMArg checkWithBlock:requestValidator]
-              completionHandler:[OCMArg invokeBlockWithArgs:responseData, response, [NSNull null], nil]];
-    } else {
-        // We won't check that the request contained anything specific
-        [[urlSessionMock stub]
-            dataTaskWithRequest:[OCMArg any]
-              completionHandler:[OCMArg invokeBlockWithArgs:responseData, response, [NSNull null], nil]];
-    }
-
-    return urlSessionMock;
+    // If a validator is provided, it will check the actual request made
+    return [[MockNSURLSession alloc] initWithValidator:requestValidator data:responseData response:response error:nil];
 }
 
 - (id)createClientWithResponseData:(id)data
@@ -167,11 +154,11 @@ - (id)createClientWithResponseData:(id)data
     // Get mock NSURLSession
     id mockSession =
         [self mockUrlSessionWithResponse:response andResponseData:serializedData andRequestValidator:requestValidator];
-    
+
     id mockSessionFactory = OCMProtocolMock(@protocol(KIONSURLSessionFactory));
     OCMStub([mockSessionFactory session]).andReturn(mockSession);
     OCMStub([mockSessionFactory sessionWithConfiguration:[OCMArg any]]).andReturn(mockSession);
-    
+
     // Create/get store
     KIODBStore *store = KIODBStore.sharedInstance;
 
diff --git a/KeenClientTests/MockNSURLSession.h b/KeenClientTests/MockNSURLSession.h
@@ -0,0 +1,21 @@
+//
+//  MockNSURLSession.h
+//  KeenClient
+//
+//  Created by Brian Baumhover on 6/7/17.
+//  Copyright © 2017 Keen Labs. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+
+@interface MockNSURLSession : NSObject
+
+- (instancetype)initWithValidator:(BOOL (^)(id requestObject))validator data:(NSData *)data response:(NSURLResponse *)response error:(NSError *)error;
+
+- (NSURLSessionDataTask *)dataTaskWithRequest:(NSURLRequest *)request
+                            completionHandler:(void (^)(NSData *_Nullable data,
+                                                        NSURLResponse *_Nullable response,
+                                                        NSError *_Nullable error))completionHandler;
+
+@end
+
diff --git a/KeenClientTests/MockNSURLSession.m b/KeenClientTests/MockNSURLSession.m
@@ -0,0 +1,53 @@
+//
+//  MockNSURLSession.m
+//  KeenClient
+//
+//  Created by Brian Baumhover on 6/7/17.
+//  Copyright © 2017 Keen Labs. All rights reserved.
+//
+
+#import <XCTest/XCTest.h>
+
+#import "MockNSURLSession.h"
+
+@interface MockNSURLSession ()
+
+@property NSData* data;
+@property NSURLResponse* response;
+@property NSError* error;
+@property BOOL (^validator)(id requestObject);
+
+@end
+
+@implementation MockNSURLSession
+
+- (instancetype)initWithValidator:(BOOL (^)(id requestObject))validator data:(NSData *)data response:(NSURLResponse *)response error:(NSError *)error {
+    self = [super init];
+
+    if (self) {
+        self.validator = validator;
+        self.data = data;
+        self.response = response;
+        self.error = error;
+    }
+
+    return self;
+}
+
+- (NSURLSessionDataTask *)dataTaskWithRequest:(NSURLRequest *)request
+                            completionHandler:(void (^)(NSData *_Nullable data,
+                                                        NSURLResponse *_Nullable response,
+                                                        NSError *_Nullable error))completionHandler {
+    dispatch_after(dispatch_time(DISPATCH_TIME_NOW, (int64_t)(10 * NSEC_PER_MSEC)), dispatch_get_main_queue(), ^{
+        if (self.validator) {
+            if (!self.validator(request)) {
+                [NSException raise:@"TestException" format:@"Request validator failed validation."];
+            }
+        }
+        completionHandler(self.data, self.response, self.error);
+    });
+
+    return nil;
+}
+
+@end
diff --git a/KeenClientTests/SdkTrackingHeaderTests.m b/KeenClientTests/SdkTrackingHeaderTests.m

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-git "keenlabs/KeenClient-iOS"`
	`1`	`+github "keenlabs/KeenClient-iOS"`