Merge pull request #166 from Microsoft/metrics-sdk-changes

Metrics SDK Changes

Author: geof90

CodePush.h

@@ -95,6 +95,14 @@ failCallback:(void (^)(NSError *err))failCallback;
 
 @end
 
+@interface CodePushTelemetryManager : NSObject
+
++ (NSDictionary *)getBinaryUpdateReport:(NSString *)appVersion;
++ (NSDictionary *)getRollbackReport:(NSDictionary *)lastFailedPackage;
++ (NSDictionary *)getUpdateReport:(NSDictionary *)currentPackage;
+
+@end
+
 typedef NS_ENUM(NSInteger, CodePushInstallMode) {
     CodePushInstallModeImmediate,
     CodePushInstallModeOnNextRestart,

CodePush.js

@@ -103,9 +103,9 @@ function getPromisifiedSdk(requestFetchAdapter, config) {
     });
   };
 
-  sdk.reportStatusDeploy = (deployedPackage, status) => {
+  sdk.reportStatusDeploy = (deployedPackage, status, previousLabelOrAppVersion, previousDeploymentKey) => {
     return new Promise((resolve, reject) => {
-      module.exports.AcquisitionSdk.prototype.reportStatusDeploy.call(sdk, deployedPackage, status, (err) => {
+      module.exports.AcquisitionSdk.prototype.reportStatusDeploy.call(sdk, deployedPackage, status, previousLabelOrAppVersion, previousDeploymentKey, (err) => {
         if (err) {
           reject(err);
         } else {
@@ -140,13 +140,15 @@ async function notifyApplicationReady() {
   const statusReport = await NativeCodePush.getNewStatusReport();
   if (statusReport) {
     const config = await getConfiguration();
+    const previousLabelOrAppVersion = statusReport.previousLabelOrAppVersion;
+    const previousDeploymentKey = statusReport.previousDeploymentKey || config.deploymentKey;
     if (statusReport.appVersion) {
       const sdk = getPromisifiedSdk(requestFetchAdapter, config);
-      sdk.reportStatusDeploy();
+      sdk.reportStatusDeploy(/* deployedPackage */ null, /* status */ null, previousLabelOrAppVersion, previousDeploymentKey);
     } else {
       config.deploymentKey = statusReport.package.deploymentKey;
       const sdk = getPromisifiedSdk(requestFetchAdapter, config);
-      sdk.reportStatusDeploy(statusReport.package, statusReport.status);
+      sdk.reportStatusDeploy(statusReport.package, statusReport.status, previousLabelOrAppVersion, previousDeploymentKey);
     }
   }
 }

CodePush.m

@@ -25,7 +25,6 @@ @implementation CodePush {
 
 // These keys represent the names we use to store data in NSUserDefaults
 static NSString *const FailedUpdatesKey = @"CODE_PUSH_FAILED_UPDATES";
-static NSString *const LastDeploymentReportKey = @"CODE_PUSH_LAST_DEPLOYMENT_REPORT";
 static NSString *const PendingUpdateKey = @"CODE_PUSH_PENDING_UPDATE";
 
 // These keys are already "namespaced" by the PendingUpdateKey, so
@@ -35,8 +34,6 @@ @implementation CodePush {
 
 // These keys are used to inspect/augment the metadata
 // that is associated with an update's package.
-static NSString *const DeploymentKeyKey = @"deploymentKey";
-static NSString *const LabelKey = @"label";
 static NSString *const PackageHashKey = @"packageHash";
 static NSString *const PackageIsPendingKey = @"isPending";
 
@@ -168,19 +165,6 @@ - (void)dealloc
     [[NSNotificationCenter defaultCenter] removeObserver:self];
 }
 
-- (NSString *)getPackageStatusReportIdentifier:(NSDictionary *)package
-{
-    // Because deploymentKeys can be dynamically switched, we use a
-    // combination of the deploymentKey and label as the packageIdentifier.
-    NSString *deploymentKey = [package objectForKey:DeploymentKeyKey];
-    NSString *label = [package objectForKey:LabelKey];
-    if (deploymentKey && label) {
-        return [[deploymentKey stringByAppendingString:@":"] stringByAppendingString:label];
-    } else {
-        return nil;
-    }
-}
-
 - (instancetype)init
 {
     self = [super init];
@@ -219,13 +203,6 @@ - (void)initializeUpdateAfterRestart
     }
 }
 
-- (BOOL)isDeploymentStatusNotYetReported:(NSString *)appVersionOrPackageIdentifier
-{
-    NSUserDefaults *preferences = [NSUserDefaults standardUserDefaults];
-    NSString *sentStatusReportIdentifier = [preferences objectForKey:LastDeploymentReportKey];
-    return sentStatusReportIdentifier == nil || ![sentStatusReportIdentifier isEqualToString:appVersionOrPackageIdentifier];
-}
-
 /*
  * This method checks to see whether a specific package hash
  * has previously failed installation.
@@ -296,13 +273,6 @@ - (void)loadBundle
     });
 }
 
-- (void)recordDeploymentStatusReported:(NSString *)appVersionOrPackageIdentifier
-{
-    NSUserDefaults *preferences = [NSUserDefaults standardUserDefaults];
-    [preferences setValue:appVersionOrPackageIdentifier forKey:LastDeploymentReportKey];
-    [preferences synchronize];
-}
-
 /*
  * This method is used when an update has failed installation
  * and the app needs to be rolled back to the previous bundle.
@@ -530,7 +500,7 @@ - (void)savePendingUpdate:(NSString *)packageHash
                                 rejecter:(RCTPromiseRejectBlock)reject)
 {
     [CodePush removePendingUpdate];
-    resolve([NSNull null]);
+    resolve(nil);
 }
 
 /*
@@ -540,45 +510,35 @@ - (void)savePendingUpdate:(NSString *)packageHash
 RCT_EXPORT_METHOD(getNewStatusReport:(RCTPromiseResolveBlock)resolve
                             rejecter:(RCTPromiseRejectBlock)reject)
 {
-    if (needToReportRollback) {
-        // Check if there was a rollback that was not yet reported
-        needToReportRollback = NO;
-        NSUserDefaults *preferences = [NSUserDefaults standardUserDefaults];
-        NSMutableArray *failedUpdates = [preferences objectForKey:FailedUpdatesKey];
-        if (failedUpdates) {
-            NSDictionary *lastFailedPackage = [failedUpdates lastObject];
-            if (lastFailedPackage) {
-                NSString *lastFailedPackageIdentifier = [self getPackageStatusReportIdentifier:lastFailedPackage];
-                if (lastFailedPackageIdentifier && [self isDeploymentStatusNotYetReported:lastFailedPackageIdentifier]) {
-                    [self recordDeploymentStatusReported:lastFailedPackageIdentifier];
-                    resolve(@{ @"package": lastFailedPackage, @"status": DeploymentFailed });
+    
+    dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
+        if (needToReportRollback) {
+            needToReportRollback = NO;
+            NSUserDefaults *preferences = [NSUserDefaults standardUserDefaults];
+            NSMutableArray *failedUpdates = [preferences objectForKey:FailedUpdatesKey];
+            if (failedUpdates) {
+                NSDictionary *lastFailedPackage = [failedUpdates lastObject];
+                if (lastFailedPackage) {
+                    resolve([CodePushTelemetryManager getRollbackReport:lastFailedPackage]);
                     return;
                 }
             }
-        }
-    } else if (_isFirstRunAfterUpdate) {
-        // Check if the current CodePush package has been reported
-        NSError *error;
-        NSDictionary *currentPackage = [CodePushPackage getCurrentPackage:&error];
-        if (!error && currentPackage) {
-            NSString *currentPackageIdentifier = [self getPackageStatusReportIdentifier:currentPackage];
-            if (currentPackageIdentifier && [self isDeploymentStatusNotYetReported:currentPackageIdentifier]) {
-                [self recordDeploymentStatusReported:currentPackageIdentifier];
-                resolve(@{ @"package": currentPackage, @"status": DeploymentSucceeded });
+        } else if (_isFirstRunAfterUpdate) {
+            NSError *error;
+            NSDictionary *currentPackage = [CodePushPackage getCurrentPackage:&error];
+            if (!error && currentPackage) {
+                resolve([CodePushTelemetryManager getUpdateReport:currentPackage]);
                 return;
             }
-        }
-    } else if (isRunningBinaryVersion || [_bridge.bundleURL.scheme hasPrefix:@"http"]) {
-        // Check if the current appVersion has been reported.
-        NSString *appVersion = [[CodePushConfig current] appVersion];
-        if ([self isDeploymentStatusNotYetReported:appVersion]) {
-            [self recordDeploymentStatusReported:appVersion];
-            resolve(@{ @"appVersion": appVersion });
+        } else if (isRunningBinaryVersion || [_bridge.bundleURL.scheme hasPrefix:@"http"]) {
+            // Check if the current appVersion has been reported.
+            NSString *appVersion = [[CodePushConfig current] appVersion];
+            resolve([CodePushTelemetryManager getBinaryUpdateReport:appVersion]);
             return;
         }
-    }
-    
-    resolve([NSNull null]);
+        
+        resolve(nil);
+    });
 }
 
 /*

CodePush.xcodeproj/project.pbxproj

@@ -9,6 +9,7 @@
 /* Begin PBXBuildFile section */
 		13BE3DEE1AC21097009241FE /* CodePush.m in Sources */ = {isa = PBXBuildFile; fileRef = 13BE3DED1AC21097009241FE /* CodePush.m */; };
 		1B23B9141BF9267B000BB2F0 /* RCTConvert+CodePushInstallMode.m in Sources */ = {isa = PBXBuildFile; fileRef = 1B23B9131BF9267B000BB2F0 /* RCTConvert+CodePushInstallMode.m */; };
+		5421FE311C58AD5A00986A55 /* CodePushTelemetryManager.m in Sources */ = {isa = PBXBuildFile; fileRef = 5421FE301C58AD5A00986A55 /* CodePushTelemetryManager.m */; };
 		54A0026C1C0E2880004C3CEC /* aescrypt.c in Sources */ = {isa = PBXBuildFile; fileRef = 54A0024C1C0E2880004C3CEC /* aescrypt.c */; };
 		54A0026D1C0E2880004C3CEC /* aeskey.c in Sources */ = {isa = PBXBuildFile; fileRef = 54A0024D1C0E2880004C3CEC /* aeskey.c */; };
 		54A0026E1C0E2880004C3CEC /* aestab.c in Sources */ = {isa = PBXBuildFile; fileRef = 54A0024F1C0E2880004C3CEC /* aestab.c */; };
@@ -45,6 +46,7 @@
 		13BE3DEC1AC21097009241FE /* CodePush.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = CodePush.h; sourceTree = "<group>"; };
 		13BE3DED1AC21097009241FE /* CodePush.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = CodePush.m; sourceTree = "<group>"; };
 		1B23B9131BF9267B000BB2F0 /* RCTConvert+CodePushInstallMode.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = "RCTConvert+CodePushInstallMode.m"; sourceTree = "<group>"; };
+		5421FE301C58AD5A00986A55 /* CodePushTelemetryManager.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = CodePushTelemetryManager.m; sourceTree = "<group>"; };
 		54A0024A1C0E2880004C3CEC /* aes.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = aes.h; sourceTree = "<group>"; };
 		54A0024B1C0E2880004C3CEC /* aes_via_ace.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = aes_via_ace.h; sourceTree = "<group>"; };
 		54A0024C1C0E2880004C3CEC /* aescrypt.c */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.c; path = aescrypt.c; sourceTree = "<group>"; };
@@ -165,6 +167,7 @@
 				1B23B9131BF9267B000BB2F0 /* RCTConvert+CodePushInstallMode.m */,
 				54FFEDDF1BF550630061DD23 /* CodePushDownloadHandler.m */,
 				810D4E6C1B96935000B397E9 /* CodePushPackage.m */,
+				5421FE301C58AD5A00986A55 /* CodePushTelemetryManager.m */,
 				81D51F391B6181C2000DA084 /* CodePushConfig.m */,
 				13BE3DEC1AC21097009241FE /* CodePush.h */,
 				13BE3DED1AC21097009241FE /* CodePush.m */,
@@ -239,6 +242,7 @@
 				54FFEDE01BF550630061DD23 /* CodePushDownloadHandler.m in Sources */,
 				54A002711C0E2880004C3CEC /* hmac.c in Sources */,
 				54A002721C0E2880004C3CEC /* prng.c in Sources */,
+				5421FE311C58AD5A00986A55 /* CodePushTelemetryManager.m in Sources */,
 				54A002731C0E2880004C3CEC /* pwd2key.c in Sources */,
 				54A002751C0E2880004C3CEC /* ioapi.c in Sources */,
 				54A002771C0E2880004C3CEC /* unzip.c in Sources */,

CodePushTelemetryManager.m

@@ -0,0 +1,127 @@
+#import "CodePush.h"
+
+static NSString *const DeploymentFailed = @"DeploymentFailed";
+static NSString *const DeploymentKeyKey = @"deploymentKey";
+static NSString *const DeploymentSucceeded = @"DeploymentSucceeded";
+static NSString *const LabelKey = @"label";
+static NSString *const LastDeploymentReportKey = @"CODE_PUSH_LAST_DEPLOYMENT_REPORT";
+
+@implementation CodePushTelemetryManager
+
++ (NSDictionary *)getBinaryUpdateReport:(NSString *)appVersion
+{
+    NSString *previousStatusReportIdentifier = [self getPreviousStatusReportIdentifier];
+    if (previousStatusReportIdentifier == nil) {
+        [self recordDeploymentStatusReported:appVersion];
+        return @{ @"appVersion": appVersion };
+    } else if (![previousStatusReportIdentifier isEqualToString:appVersion]) {
+        [self recordDeploymentStatusReported:appVersion];
+        if ([self isStatusReportIdentifierCodePushLabel:previousStatusReportIdentifier]) {
+            NSString *previousDeploymentKey = [self getDeploymentKeyFromStatusReportIdentifier:previousStatusReportIdentifier];
+            NSString *previousLabel = [self getVersionLabelFromStatusReportIdentifier:previousStatusReportIdentifier];
+            return @{
+                      @"appVersion": appVersion,
+                      @"previousDeploymentKey": previousDeploymentKey,
+                      @"previousLabelOrAppVersion": previousLabel
+                    };
+        } else {
+            // Previous status report was with a binary app version.
+            return @{
+                      @"appVersion": appVersion,
+                      @"previousLabelOrAppVersion": previousStatusReportIdentifier
+                    };
+        }
+    }
+    
+    return nil;
+}
+
++ (NSDictionary *)getRollbackReport:(NSDictionary *)lastFailedPackage
+{
+    return @{
+              @"package": lastFailedPackage,
+              @"status": DeploymentFailed
+            };
+}
+
++ (NSDictionary *)getUpdateReport:(NSDictionary *)currentPackage
+{
+    NSString *currentPackageIdentifier = [self getPackageStatusReportIdentifier:currentPackage];
+    NSString *previousStatusReportIdentifier = [self getPreviousStatusReportIdentifier];
+    if (currentPackageIdentifier) {
+        if (previousStatusReportIdentifier == nil) {
+            [self recordDeploymentStatusReported:currentPackageIdentifier];
+            return @{
+                      @"package": currentPackage,
+                      @"status": DeploymentSucceeded
+                    };
+        } else if (![previousStatusReportIdentifier isEqualToString:currentPackageIdentifier]) {
+            [self recordDeploymentStatusReported:currentPackageIdentifier];
+            if ([self isStatusReportIdentifierCodePushLabel:previousStatusReportIdentifier]) {
+                NSString *previousDeploymentKey = [self getDeploymentKeyFromStatusReportIdentifier:previousStatusReportIdentifier];
+                NSString *previousLabel = [self getVersionLabelFromStatusReportIdentifier:previousStatusReportIdentifier];
+                return @{
+                          @"package": currentPackage,
+                          @"status": DeploymentSucceeded,
+                          @"previousDeploymentKey": previousDeploymentKey,
+                          @"previousLabelOrAppVersion": previousLabel
+                        };
+            } else {
+                // Previous status report was with a binary app version.
+                return @{
+                          @"package": currentPackage,
+                          @"status": DeploymentSucceeded,
+                          @"previousLabelOrAppVersion": previousStatusReportIdentifier
+                        };
+            }
+        }
+    }
+    
+    return nil;
+}
+
+#pragma mark - private methods
+
++ (NSString *)getDeploymentKeyFromStatusReportIdentifier:(NSString *)statusReportIdentifier
+{
+    return [[statusReportIdentifier componentsSeparatedByString:@":"] firstObject];
+}
+
++ (NSString *)getPackageStatusReportIdentifier:(NSDictionary *)package
+{
+    // Because deploymentKeys can be dynamically switched, we use a
+    // combination of the deploymentKey and label as the packageIdentifier.
+    NSString *deploymentKey = [package objectForKey:DeploymentKeyKey];
+    NSString *label = [package objectForKey:LabelKey];
+    if (deploymentKey && label) {
+        return [[deploymentKey stringByAppendingString:@":"] stringByAppendingString:label];
+    } else {
+        return nil;
+    }
+}
+
++ (NSString *)getPreviousStatusReportIdentifier
+{
+    NSUserDefaults *preferences = [NSUserDefaults standardUserDefaults];
+    NSString *sentStatusReportIdentifier = [preferences objectForKey:LastDeploymentReportKey];
+    return sentStatusReportIdentifier;
+}
+
++ (NSString *)getVersionLabelFromStatusReportIdentifier:(NSString *)statusReportIdentifier
+{
+    return [[statusReportIdentifier componentsSeparatedByString:@":"] lastObject];
+}
+
++ (BOOL)isStatusReportIdentifierCodePushLabel:(NSString *)statusReportIdentifier
+{
+    return statusReportIdentifier != nil && [statusReportIdentifier containsString:@":"];
+}
+
++ (void)recordDeploymentStatusReported:(NSString *)appVersionOrPackageIdentifier
+{
+    NSUserDefaults *preferences = [NSUserDefaults standardUserDefaults];
+    [preferences setValue:appVersionOrPackageIdentifier forKey:LastDeploymentReportKey];
+    [preferences synchronize];
+}
+
+@end