[Bugfix] Version & Build for Application Installed and `Application…

… Updated`

CHANGELOG.md

@@ -68,3 +68,7 @@ All notable changes to this project will be documented in this file.
 ## Version - 1.6.0 - 2022-05-04
 ### Feature
 - Flush API
+
+## Version - 1.6.1 - 2022-06-20
+- Included Build Number as well in the life cycle events Application Installed & Application Updated.
+- Accepting path as well as part of the url for both control plane url and data plane url.

README.md

@@ -8,7 +8,7 @@
 
 <p align="center">
   <a href="https://cocoapods.org/pods/Rudder">
-    <img src="https://img.shields.io/cocoapods/v/Rudder.svg?style=flat">
+    <img src="https://img.shields.io/static/v1?label=pod&message=v1.6.1&color=blue&style=flat">
     </a>
 </p>
 
@@ -39,15 +39,15 @@ The iOS SDK is available through [**CocoaPods**](https://cocoapods.org), [**Cart
 To install the SDK, simply add the following line to your Podfile:
 
 ```xcode
-pod 'Rudder', '1.6.0'
+pod 'Rudder', '1.6.1'
 ```
 
 ### Carthage
 
 For Carthage support, add the following line to your `Cartfile`:
 
 ```xcode
-github "rudderlabs/rudder-sdk-ios" "v1.6.0"
+github "rudderlabs/rudder-sdk-ios" "v1.6.1"
 ```
 
 > Remember to include the following code in all `.m` and `.h` files where you want to refer to or use the RudderStack SDK classes, as shown:
@@ -71,7 +71,7 @@ You can also add the RudderStack iOS SDK via Swift Package Mangaer, via one of t
 
 * Enter the package repository (`git@github.com:rudderlabs/rudder-sdk-ios.git`) in the search bar.
 
-* In **Dependency Rule**, select **Up to Next Major Version** and enter `1.6.0` as the value, as shown:
+* In **Dependency Rule**, select **Up to Next Major Version** and enter `1.6.1` as the value, as shown:
 
 ![Setting dependency](https://user-images.githubusercontent.com/59817155/145574696-8c849749-13e0-40d5-aacb-3fccb5c8e67d.png)
 
@@ -99,7 +99,7 @@ let package = Package(
     ],
     dependencies: [
         // Dependencies declare other packages that this package depends on.
-        .package(url: "git@github.com:rudderlabs/rudder-sdk-ios.git", from: "1.6.0")
+        .package(url: "git@github.com:rudderlabs/rudder-sdk-ios.git", from: "1.6.1")
     ],
     targets: [
         // Targets are the basic building blocks of a package. A target can define a module or a test suite.

Rudder.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name             = 'Rudder'
-  s.version          = "1.6.0"
+  s.version          = "1.6.1"
   s.summary          = "Privacy and Security focused Segment-alternative. iOS ,tvOS and watchOS SDK"
   s.description      = <<-DESC
   Rudder is a platform for collecting, storing and routing customer event data to dozens of tools. Rudder is open-source, can run in your cloud environment (AWS, GCP, Azure or even your data-centre) and provides a powerful transformation framework to process your event data on the fly.

Rudder.xcodeproj/project.pbxproj

@@ -1021,7 +1021,7 @@
 					"@executable_path/Frameworks",
 					"@loader_path/Frameworks",
 				);
-				MARKETING_VERSION = 1.5.3;
+				MARKETING_VERSION = 1.6.1;
 				PRODUCT_BUNDLE_IDENTIFIER = com.rudderstack.Rudder;
 				PRODUCT_NAME = "$(TARGET_NAME:c99extidentifier)";
 				SKIP_INSTALL = YES;
@@ -1055,7 +1055,7 @@
 					"@executable_path/Frameworks",
 					"@loader_path/Frameworks",
 				);
-				MARKETING_VERSION = 1.5.3;
+				MARKETING_VERSION = 1.6.1;
 				PRODUCT_BUNDLE_IDENTIFIER = com.rudderstack.Rudder;
 				PRODUCT_NAME = "$(TARGET_NAME:c99extidentifier)";
 				SKIP_INSTALL = YES;

Sources/Classes/Public/RSPreferenceManager.h

@@ -33,8 +33,17 @@ extern NSString *const RSOptOutTimeKey;
 - (void) saveTraits: (NSString* __nonnull) traits;
 - (NSString* __nonnull) getTraits;
 
-- (NSString* __nullable) getBuildVersionCode;
-- (void) saveBuildVersionCode: (NSString* __nonnull) versionCode;
+- (void) saveBuildVersionCode:(NSString* __nonnull)versionCode;
+- (NSString* __nullable) getBuildVersionCode; 
+- (void) deleteBuildVersionCode;
+
+- (void) performMigration;
+
+- (NSString* __nullable) getBuildNumber;
+- (void) saveBuildNumber: (NSString* __nonnull) buildNumber;
+
+- (NSString* __nullable) getVersionNumber;
+- (void) saveVersionNumber: (NSString* __nonnull) versionNumber;
 
 - (NSString* __nullable) getExternalIds;
 - (void) saveExternalIds: (NSString* __nonnull) externalIdsJson;

Sources/Classes/Public/RSUtils.h

@@ -24,6 +24,7 @@ NS_ASSUME_NONNULL_BEGIN
 + (NSArray*) serializeArray: (NSArray*) array;
 + (int) getNumberOfBatches:(RSDBMessage*) dbMessage withFlushQueueSize: (int) queueSize;
 + (NSMutableArray<NSString *>*) getBatch:(NSMutableArray<NSString *>*) messageDetails withQueueSize: (int) queueSize;
++ (BOOL) isValidURL:(NSURL*) url;
 
 extern unsigned int MAX_EVENT_SIZE;
 extern unsigned int MAX_BATCH_SIZE;

Sources/Classes/RSConfigBuilder.m

@@ -9,18 +9,17 @@
 #import "RSConfigBuilder.h"
 #import "RSLogger.h"
 #import "RSConstants.h"
+#import "RSUtils.h"
 
 @implementation RSConfigBuilder
 
-- (instancetype) withEndPointUrl:(NSString *)endPointUrl{
+- (instancetype) withEndPointUrl:(NSString *) endPointUrl{
     if (config == nil) {
         config = [[RSConfig alloc] init];
     }
     NSURL *url = [[NSURL alloc] initWithString:endPointUrl];
-    if ([url port]) {
-        config.dataPlaneUrl = [[NSString alloc] initWithFormat:@"%@://%@:%@", [url scheme], [url host], [url port]];
-    } else {
-        config.dataPlaneUrl = [[NSString alloc] initWithFormat:@"%@://%@", [url scheme], [url host]];
+    if([RSUtils isValidURL:url]) {
+        config.dataPlaneUrl = url.absoluteString;
     }
     return self;
 }
@@ -31,10 +30,8 @@ - (instancetype) withDataPlaneUrl: (NSString*) dataPlaneUrl {
     }
 
     NSURL *url = [[NSURL alloc] initWithString:dataPlaneUrl];
-    if ([url port]) {
-        config.dataPlaneUrl = [[NSString alloc] initWithFormat:@"%@://%@:%@", [url scheme], [url host], [url port]];
-    } else {
-        config.dataPlaneUrl = [[NSString alloc] initWithFormat:@"%@://%@", [url scheme], [url host]];
+    if([RSUtils isValidURL:url]) {
+        config.dataPlaneUrl = url.absoluteString;
     }
     return self;
 }
@@ -43,10 +40,8 @@ - (instancetype)withDataPlaneURL:(NSURL *) dataPlaneURL {
     if (config == nil) {
         config = [[RSConfig alloc] init];
     }
-    if ([dataPlaneURL port]) {
-        config.dataPlaneUrl = [[NSString alloc] initWithFormat:@"%@://%@:%@", [dataPlaneURL scheme], [dataPlaneURL host] ,[dataPlaneURL port]];
-    } else {
-        config.dataPlaneUrl = [[NSString alloc] initWithFormat:@"%@://%@", [dataPlaneURL scheme], [dataPlaneURL host]];
+    if([RSUtils isValidURL:dataPlaneURL]) {
+        config.dataPlaneUrl = dataPlaneURL.absoluteString;
     }
     return self;
 }
@@ -146,11 +141,9 @@ -(instancetype)withConfigPlaneUrl:(NSString *) configPlaneUrl {
         config = [[RSConfig alloc] init];
     }
     NSURL *url = [[NSURL alloc] initWithString:configPlaneUrl];
-    if([url path]){
-        config.controlPlaneUrl = [[NSString alloc] initWithFormat:@"%@://%@%@", [url scheme], [url host], [url path]];
-        return self;
+    if([RSUtils isValidURL:url]) {
+        config.controlPlaneUrl = url.absoluteString;
     }
-    config.controlPlaneUrl = [[NSString alloc] initWithFormat:@"%@://%@", [url scheme], [url host]];
     return self;
 }
 
@@ -159,23 +152,19 @@ - (instancetype)withControlPlaneUrl:(NSString *) controlPlaneUrl {
         config = [[RSConfig alloc] init];
     }
     NSURL *url = [[NSURL alloc] initWithString:controlPlaneUrl];
-    if([url path]){
-        config.controlPlaneUrl = [[NSString alloc] initWithFormat:@"%@://%@%@", [url scheme], [url host], [url path]];
-        return self;
+    if([RSUtils isValidURL:url]) {
+        config.controlPlaneUrl = url.absoluteString;
     }
-    config.controlPlaneUrl = [[NSString alloc] initWithFormat:@"%@://%@", [url scheme], [url host]];
     return self;
 }
 
 - (instancetype)withControlPlaneURL:(NSURL *) controlPlaneURL {
     if (config == nil) {
         config = [[RSConfig alloc] init];
     }
-    if([controlPlaneURL path]){
-        config.controlPlaneUrl = [[NSString alloc] initWithFormat:@"%@://%@%@", [controlPlaneURL scheme], [controlPlaneURL host], [controlPlaneURL path]];
-        return self;
+    if([RSUtils isValidURL:controlPlaneURL]) {
+        config.controlPlaneUrl = controlPlaneURL.absoluteString;
     }
-    config.controlPlaneUrl = [[NSString alloc] initWithFormat:@"%@://%@", [controlPlaneURL scheme], [controlPlaneURL host]];
     return self;
 }
 

Sources/Classes/RSConstants.m

@@ -18,7 +18,7 @@ @implementation RSConstants
 bool const RSTrackLifeCycleEvents = YES;
 bool const RSRecordScreenViews = NO;
 bool const RSEnableBackgroundMode = NO;
-NSString *const RS_VERSION = @"1.6.0";
+NSString *const RS_VERSION = @"1.6.1";
 NSString* const DISABLE = @"disable";
 NSString* const WHITELISTED_EVENTS = @"whitelistedEvents";
 NSString* const BLACKLISTED_EVENTS = @"blacklistedEvents";

Sources/Classes/RSEventRepository.m

@@ -88,6 +88,7 @@ - (instancetype)init : (NSString*) _writeKey config:(RSConfig*) _config {
 
         [RSLogger logDebug:@"EventRepository: initiating preferenceManager"];
         self->preferenceManager = [RSPreferenceManager getInstance];
+        [self->preferenceManager performMigration];
 
         [RSLogger logDebug:@"EventRepository: initiating processor and factories"];
         [self __initiateSDK];
@@ -621,20 +622,28 @@ - (void)_applicationDidFinishLaunchingWithOptions:(NSDictionary *)launchOptions
     if (!self->config.trackLifecycleEvents) {
         return;
     }
-    NSString *previousVersion = [preferenceManager getBuildVersionCode];
+    NSString *previousVersion = [preferenceManager getVersionNumber];
     NSString *currentVersion = [[NSBundle mainBundle] infoDictionary][@"CFBundleShortVersionString"];
 
+    NSString* previousBuildNumber = [preferenceManager getBuildNumber];
+    NSString *currentBuildNumber = [[NSBundle mainBundle] infoDictionary][@"CFBundleVersion"];
+
     if (!previousVersion) {
         [[RSClient sharedInstance] track:@"Application Installed" properties:@{
-            @"version": currentVersion
+            @"version": currentVersion,
+            @"build": currentBuildNumber
         }];
-        [preferenceManager saveBuildVersionCode:currentVersion];
-    } else if (![currentVersion isEqualToString:previousVersion]) {
+        [preferenceManager saveVersionNumber:currentVersion];
+        [preferenceManager saveBuildNumber:currentBuildNumber];
+    } else if (![previousVersion isEqualToString:currentVersion]) {
         [[RSClient sharedInstance] track:@"Application Updated" properties:@{
             @"previous_version" : previousVersion ?: @"",
-            @"version": currentVersion
+            @"version": currentVersion,
+            @"previous_build": previousBuildNumber ?: @"",
+            @"build": currentBuildNumber
         }];
-        [preferenceManager saveBuildVersionCode:currentVersion];
+        [preferenceManager saveVersionNumber:currentVersion];
+        [preferenceManager saveBuildNumber:currentBuildNumber];
     }
 
     NSMutableDictionary *applicationOpenedProperties = [[NSMutableDictionary alloc] init];

Sources/Classes/RSPreferenceManager.m

@@ -6,6 +6,7 @@
 //
 
 #import "RSPreferenceManager.h"
+#import "RSLogger.h"
 #if TARGET_OS_WATCH
 #import <WatchKit/WKInterfaceDevice.h>
 #endif
@@ -18,6 +19,8 @@ @implementation RSPreferenceManager
 NSString *const RSServerConfigKey = @"rl_server_config";
 NSString *const RSServerLastUpdatedKey = @"rl_server_last_updated";
 NSString *const RSTraitsKey = @"rl_traits";
+NSString *const RSApplicationBuildKey = @"rl_application_build_key";
+NSString *const RSApplicationVersionKey = @"rl_application_version_key";
 NSString *const RSApplicationInfoKey = @"rl_application_info_key";
 NSString *const RSExternalIdKey =  @"rl_external_id";
 NSString *const RSAnonymousIdKey =  @"rl_anonymous_id";
@@ -64,6 +67,11 @@ - (NSString *)getTraits {
     return [[NSUserDefaults standardUserDefaults] valueForKey:RSTraitsKey];
 }
 
+- (NSString* __nullable) getBuildNumber {
+    return [[NSUserDefaults standardUserDefaults] valueForKey:RSApplicationBuildKey];
+}
+
+// saving the version number to the NSUserDefaults
 - (void)saveBuildVersionCode:(NSString *)versionCode {
     [[NSUserDefaults standardUserDefaults] setValue:versionCode forKey:RSApplicationInfoKey];
     [[NSUserDefaults standardUserDefaults] synchronize];
@@ -73,6 +81,27 @@ - (NSString *)getBuildVersionCode {
     return [[NSUserDefaults standardUserDefaults] valueForKey:RSApplicationInfoKey];
 }
 
+- (void) deleteBuildVersionCode {
+    [[NSUserDefaults standardUserDefaults] removeObjectForKey:RSApplicationInfoKey];
+    [[NSUserDefaults standardUserDefaults] synchronize];
+}
+
+// saving the build number  to the NSUserDefaults
+- (void) saveBuildNumber: (NSString* __nonnull) buildNumber {
+    [[NSUserDefaults standardUserDefaults] setValue:buildNumber forKey:RSApplicationBuildKey];
+    [[NSUserDefaults standardUserDefaults] synchronize];
+}
+
+// saving the version number to the NSUserDefaults
+- (NSString* __nullable) getVersionNumber {
+    return [[NSUserDefaults standardUserDefaults] valueForKey:RSApplicationVersionKey];
+}
+
+- (void) saveVersionNumber: (NSString* __nonnull) versionNumber {
+    [[NSUserDefaults standardUserDefaults] setValue:versionNumber forKey:RSApplicationVersionKey];
+    [[NSUserDefaults standardUserDefaults] synchronize];
+}
+
 - (NSString *)getExternalIds {
     return [[NSUserDefaults standardUserDefaults] valueForKey:RSExternalIdKey];
 }
@@ -145,4 +174,13 @@ - (long)getOptOutTime {
     }
 }
 
+- (void) performMigration {
+    NSString* versionNumber = [self getBuildVersionCode];
+    if(versionNumber != nil) {
+        [RSLogger logDebug:[[NSString alloc] initWithFormat:@"RSPreferenceManager: performMigration: buildNumber stored in %@ key, migrating it to %@", RSApplicationInfoKey, RSApplicationBuildKey]];
+        [self deleteBuildVersionCode];
+        [self saveVersionNumber:versionNumber];
+    }
+}
+
 @end

Sources/Classes/RSUtils.m

@@ -135,6 +135,10 @@ + (int) getNumberOfBatches:(RSDBMessage*) dbMessage withFlushQueueSize: (int) qu
     return [messageDetails subarrayWithRange:NSMakeRange(0, queueSize)];
 }
 
++ (BOOL) isValidURL:(NSURL*) url {
+    return url && [url scheme] && [url host];
+}
+
 unsigned int MAX_EVENT_SIZE = 32 * 1024; // 32 KB
 unsigned int MAX_BATCH_SIZE = 500 * 1024; // 500 KB