Merge pull request #150 from Microsoft/report-acquisition-status

Report Acquisition Status

Author: geof90

CodePush.js

@@ -60,8 +60,9 @@ async function checkForUpdate(deploymentKey = null) {
   if (!update || update.updateAppVersion || (update.packageHash === localPackage.packageHash)) {
     return null;
   } else {     
-    const remotePackage = { ...update, ...PackageMixins.remote };
+    const remotePackage = { ...update, ...PackageMixins.remote(sdk.reportStatusDownload) };
     remotePackage.failedInstall = await NativeCodePush.isFailedUpdate(remotePackage.packageHash);
+    remotePackage.deploymentKey = deploymentKey || nativeConfig.deploymentKey;
     return remotePackage;
   }
 }
@@ -101,7 +102,31 @@ function getPromisifiedSdk(requestFetchAdapter, config) {
       }); 
     });
   };
-  
+
+  sdk.reportStatusDeploy = (deployedPackage, status) => {
+    return new Promise((resolve, reject) => {
+      module.exports.AcquisitionSdk.prototype.reportStatusDeploy.call(sdk, deployedPackage, status, (err) => {
+        if (err) {
+          reject(err);
+        } else {
+          resolve();
+        }
+      }); 
+    });
+  };
+
+  sdk.reportStatusDownload = (downloadedPackage) => {
+    return new Promise((resolve, reject) => {
+      module.exports.AcquisitionSdk.prototype.reportStatusDownload.call(sdk, downloadedPackage, (err) => {
+        if (err) {
+          reject(err);
+        } else {
+          resolve();
+        }
+      }); 
+    });
+  };
+
   return sdk;
 }
 
@@ -110,6 +135,22 @@ function log(message) {
   console.log(`[CodePush] ${message}`)
 }
 
+async function notifyApplicationReady() {
+  await NativeCodePush.notifyApplicationReady();
+  const statusReport = await NativeCodePush.getNewStatusReport();
+  if (statusReport) {
+    const config = await getConfiguration();
+    if (statusReport.appVersion) {
+      const sdk = getPromisifiedSdk(requestFetchAdapter, config);
+      sdk.reportStatusDeploy();
+    } else {
+      config.deploymentKey = statusReport.package.deploymentKey;
+      const sdk = getPromisifiedSdk(requestFetchAdapter, config);
+      sdk.reportStatusDeploy(statusReport.package, statusReport.status);
+    }
+  }
+}
+
 function restartApp(onlyIfUpdateIsPending = false) {
   NativeCodePush.restartApp(onlyIfUpdateIsPending);
 }
@@ -269,7 +310,7 @@ const CodePush = {
   getConfiguration,
   getCurrentPackage,
   log,
-  notifyApplicationReady: NativeCodePush.notifyApplicationReady,
+  notifyApplicationReady,
   restartApp,
   setUpTestDependencies,
   sync,

CodePush.m

@@ -13,10 +13,17 @@ @implementation CodePush {
 
 RCT_EXPORT_MODULE()
 
+static BOOL needToReportRollback = NO;
+static BOOL isRunningBinaryVersion = NO;
 static BOOL testConfigurationFlag = NO;
 
+// These constants represent valid deployment statuses
+static NSString *const DeploymentFailed = @"DeploymentFailed";
+static NSString *const DeploymentSucceeded = @"DeploymentSucceeded";
+
 // 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
@@ -26,6 +33,8 @@ @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";
 
@@ -54,6 +63,7 @@ + (NSURL *)bundleURLForResource:(NSString *)resourceName
 
     if (error || !packageFile) {
         NSLog(logMessageFormat, binaryJsBundleUrl);
+        isRunningBinaryVersion = YES;
         return binaryJsBundleUrl;
     }
 
@@ -65,22 +75,25 @@ + (NSURL *)bundleURLForResource:(NSString *)resourceName
     NSDictionary *currentPackageMetadata = [CodePushPackage getCurrentPackage:&error];
     if (error || !currentPackageMetadata) {
         NSLog(logMessageFormat, binaryJsBundleUrl);
+        isRunningBinaryVersion = YES;
         return binaryJsBundleUrl;
     }
 
     NSString *packageAppVersion = [currentPackageMetadata objectForKey:@"appVersion"];
 
-    if ([binaryDate compare:packageDate] == NSOrderedAscending && [binaryAppVersion isEqualToString:packageAppVersion]) {
+    if ([binaryDate compare:packageDate] == NSOrderedAscending && ([CodePush isUsingTestConfiguration] ||[binaryAppVersion isEqualToString:packageAppVersion])) {
         // Return package file because it is newer than the app store binary's JS bundle
         NSURL *packageUrl = [[NSURL alloc] initFileURLWithPath:packageFile];
         NSLog(logMessageFormat, packageUrl);
+        isRunningBinaryVersion = NO;
         return packageUrl;
     } else {
 #ifndef DEBUG
         [CodePush clearUpdates];
 #endif
 
         NSLog(logMessageFormat, binaryJsBundleUrl);
+        isRunningBinaryVersion = YES;
         return binaryJsBundleUrl;
     }
 }
@@ -148,6 +161,19 @@ - (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];
@@ -175,6 +201,7 @@ - (void)initializeUpdateAfterRestart
             // Pending update was initialized, but notifyApplicationReady was not called.
             // Therefore, deduce that it is a broken update and rollback.
             NSLog(@"Update did not finish loading the last time, rolling back to a previous version.");
+            needToReportRollback = YES;
             [self rollbackPackage];
         } else {
             // Mark that we tried to initialize the new update, so that if it crashes,
@@ -185,6 +212,13 @@ - (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.
@@ -193,7 +227,25 @@ - (BOOL)isFailedHash:(NSString*)packageHash
 {
     NSUserDefaults *preferences = [NSUserDefaults standardUserDefaults];
     NSMutableArray *failedUpdates = [preferences objectForKey:FailedUpdatesKey];
-    return (failedUpdates != nil && [failedUpdates containsObject:packageHash]);
+    if (failedUpdates == nil || packageHash == nil) {
+        return NO;
+    } else {
+        for (NSDictionary *failedPackage in failedUpdates)
+        {
+            // Type check is needed for backwards compatibility, where we used to just store
+            // the failed package hash instead of the metadata. This only impacts "dev"
+            // scenarios, since in production we clear out old information whenever a new
+            // binary is applied.
+            if ([failedPackage isKindOfClass:[NSDictionary class]]) {
+                NSString *failedPackageHash = [failedPackage objectForKey:PackageHashKey];
+                if ([packageHash isEqualToString:failedPackageHash]) {
+                    return YES;
+                }
+            }
+        }
+        
+        return NO;
+    }
 }
 
 /*
@@ -237,6 +289,13 @@ - (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.
@@ -247,10 +306,10 @@ - (void)loadBundle
 - (void)rollbackPackage
 {
     NSError *error;
-    NSString *packageHash = [CodePushPackage getCurrentPackageHash:&error];
+    NSDictionary *failedPackage = [CodePushPackage getCurrentPackage:&error];
 
-    // Write the current package's hash to the "failed list"
-    [self saveFailedUpdate:packageHash];
+    // Write the current package's metadata to the "failed list"
+    [self saveFailedUpdate:failedPackage];
 
     // Rollback to the previous version and de-register the new update
     [CodePushPackage rollbackPackage];
@@ -263,7 +322,7 @@ - (void)rollbackPackage
  * to store its hash so that it can be ignored on future
  * attempts to check the server for an update.
  */
-- (void)saveFailedUpdate:(NSString *)packageHash
+- (void)saveFailedUpdate:(NSDictionary *)failedPackage
 {
     NSUserDefaults *preferences = [NSUserDefaults standardUserDefaults];
     NSMutableArray *failedUpdates = [preferences objectForKey:FailedUpdatesKey];
@@ -275,7 +334,7 @@ - (void)saveFailedUpdate:(NSString *)packageHash
         failedUpdates = [failedUpdates mutableCopy];
     }
 
-    [failedUpdates addObject:packageHash];
+    [failedUpdates addObject:failedPackage];
     [preferences setObject:failedUpdates forKey:FailedUpdatesKey];
     [preferences synchronize];
 }
@@ -467,6 +526,54 @@ - (void)savePendingUpdate:(NSString *)packageHash
     resolve([NSNull null]);
 }
 
+/*
+ * This method is checks if a new status update exists (new version was installed, 
+ * or an update failed) and return its details (version label, status).
+ */
+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 });
+                    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 });
+                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 });
+            return;
+        }
+    }
+    
+    resolve([NSNull null]);
+}
+
 /*
  * This method is the native side of the CodePush.restartApp() method.
  */

CodePushConfig.m

@@ -1,4 +1,5 @@
 #import "CodePush.h"
+#import <UIKit/UIKit.h>
 
 @implementation CodePushConfig {
     NSMutableDictionary *_configDictionary;
@@ -8,6 +9,7 @@ @implementation CodePushConfig {
 
 static NSString * const AppVersionConfigKey = @"appVersion";
 static NSString * const BuildVdersionConfigKey = @"buildVersion";
+static NSString * const ClientUniqueIDConfigKey = @"clientUniqueId";
 static NSString * const DeploymentKeyConfigKey = @"deploymentKey";
 static NSString * const ServerURLConfigKey = @"serverUrl";
 
@@ -31,6 +33,14 @@ - (instancetype)init
     NSString *deploymentKey = [infoDictionary objectForKey:@"CodePushDeploymentKey"];
     NSString *serverURL = [infoDictionary objectForKey:@"CodePushServerURL"];
 
+    NSUserDefaults *userDefaults = [NSUserDefaults standardUserDefaults];
+    NSString *clientUniqueId = [userDefaults stringForKey:ClientUniqueIDConfigKey];
+    if (clientUniqueId == nil) {
+        clientUniqueId = [[[UIDevice currentDevice] identifierForVendor] UUIDString];
+        [userDefaults setObject:clientUniqueId forKey:ClientUniqueIDConfigKey];
+        [userDefaults synchronize];
+    }
+    
     if (!serverURL) {
         serverURL = @"https://codepush.azurewebsites.net/";
     }
@@ -39,6 +49,7 @@ - (instancetype)init
                             appVersion,AppVersionConfigKey,
                             buildVersion,BuildVdersionConfigKey,
                             serverURL,ServerURLConfigKey,
+                            clientUniqueId,ClientUniqueIDConfigKey,
                             deploymentKey,DeploymentKeyConfigKey,
                             nil];
 
@@ -70,6 +81,11 @@ - (NSString *)serverURL
     return [_configDictionary objectForKey:ServerURLConfigKey];
 }
 
+- (NSString *)clientUniqueId
+{
+    return [_configDictionary objectForKey:ClientUniqueIDConfigKey];
+}
+
 - (void)setDeploymentKey:(NSString *)deploymentKey
 {
     [_configDictionary setValue:deploymentKey forKey:DeploymentKeyConfigKey];

Examples/CodePushDemoApp/CodePushDemoAppTests/CheckForUpdateTests/testcases/FirstUpdateTest.js

@@ -24,7 +24,7 @@ let FirstUpdateTest = createTestCaseComponent(
   },
   async () => {
     let update = await CodePush.checkForUpdate();
-    assert.equal(JSON.stringify(update), JSON.stringify({ ...serverPackage, ...PackageMixins.remote, failedInstall: false }), "checkForUpdate did not return the update from the server");
+    assert.equal(JSON.stringify(update), JSON.stringify({ ...serverPackage, ...PackageMixins.remote(), failedInstall: false }), "checkForUpdate did not return the update from the server");
   }
 );
 

Examples/CodePushDemoApp/CodePushDemoAppTests/CheckForUpdateTests/testcases/NewUpdateTest.js

@@ -23,7 +23,7 @@ let NewUpdateTest = createTestCaseComponent(
   },
   async () => {
     let update = await CodePush.checkForUpdate();
-    assert.equal(JSON.stringify(update), JSON.stringify({ ...serverPackage, ...PackageMixins.remote, failedInstall: false }), "checkForUpdate did not return the update from the server");
+    assert.equal(JSON.stringify(update), JSON.stringify({ ...serverPackage, ...PackageMixins.remote(), failedInstall: false }), "checkForUpdate did not return the update from the server");
   }
 );
 

Examples/CodePushDemoApp/CodePushDemoAppTests/CheckForUpdateTests/testcases/SwitchDeploymentKeyTest.js

@@ -25,7 +25,7 @@ let SwitchDeploymentKeyTest = createTestCaseComponent(
   },
   async () => {
     let update = await CodePush.checkForUpdate(deploymentKey);
-    assert.equal(JSON.stringify(update), JSON.stringify({ ...serverPackage, ...PackageMixins.remote, failedInstall: false }), "checkForUpdate did not return the update from the server");
+    assert.equal(JSON.stringify(update), JSON.stringify({ ...serverPackage, ...PackageMixins.remote(), failedInstall: false, deploymentKey }), "checkForUpdate did not return the update from the server");
   }
 );
 

Examples/CodePushDemoApp/CodePushDemoAppTests/DownloadProgressTests/testcases/DownloadProgressTest.js

@@ -28,7 +28,7 @@ let DownloadProgressTest = createTestCaseComponent(
   "should successfully download all the bytes contained in the test packages",
   () => {
     testPackages.forEach((aPackage, index) => {
-      testPackages[index] = Object.assign(aPackage, PackageMixins.remote);
+      testPackages[index] = Object.assign(aPackage, PackageMixins.remote());
     });
     return Promise.resolve();
   },