Merge pull request #116 from Microsoft/tests

Tests + Bugfix

Author: geof90

CodePush.h

@@ -22,6 +22,11 @@
 
 + (NSString *)getApplicationSupportDirectory;
 
+// The below methods are only used during tests.
++ (BOOL)isUsingTestConfiguration;
++ (void)setUsingTestConfiguration:(BOOL)shouldUseTestConfiguration;
++ (void)clearTestUpdates;
+
 @end
 
 @interface CodePushConfig : NSObject
@@ -77,6 +82,10 @@ failCallback:(void (^)(NSError *err))failCallback;
 
 + (void)rollbackPackage;
 
+// The below methods are only used during tests.
++ (void)downloadAndReplaceCurrentBundle:(NSString *)remoteBundleUrl;
++ (void)clearTestUpdates;
+
 @end
 
 typedef NS_ENUM(NSInteger, CodePushInstallMode) {

CodePush.js

@@ -20,75 +20,75 @@ function checkForUpdate(deploymentKey = null) {
    * different from the CodePush update they have already installed.
    */
   return getConfiguration()
-          .then((configResult) => {            
-            /*
-             * If a deployment key was explicitly provided,
-             * then let's override the one we retrieved
-             * from the native-side of the app. This allows
-             * dynamically "redirecting" end-users at different
-             * deployments (e.g. an early access deployment for insiders).
-             */
-            if (deploymentKey) {
-              config = Object.assign({}, configResult, { deploymentKey });
-            } else {
-              config = configResult;
-            }
-            
-            sdk = getSDK(config);
-            
-            // Allow dynamic overwrite of function. This is only to be used for tests.
-            return module.exports.getCurrentPackage();
-          })
-          .then((localPackage) => {
-            var queryPackage = { appVersion: config.appVersion };
-            
-            /*
-             * If the app has a previously installed update, and that update
-             * was targetted at the same app version that is currently running,
-             * then we want to use its package hash to determine whether a new
-             * release has been made on the server. Otherwise, we only need
-             * to send the app version to the server, since we are interested
-             * in any updates for current app store version, regardless of hash.
-             */
-            if (localPackage && localPackage.appVersion && semver.compare(localPackage.appVersion, config.appVersion) === 0) {
-              queryPackage = localPackage;
-            }
-            
-            return new Promise((resolve, reject) => {
-              sdk.queryUpdateWithCurrentPackage(queryPackage, (err, update) => {
-                if (err) {
-                  return reject(err);
-                }
-                
-                /*
-                 * There are three cases where checkForUpdate will resolve to null:
-                 * ----------------------------------------------------------------
-                 * 1) The server said there isn't an update. This is the most common case.
-                 * 2) The server said there is an update but it requires a newer binary version.
-                 *    This would occur when end-users are running an older app store version than
-                 *    is available, and CodePush is making sure they don't get an update that
-                 *    potentially wouldn't be compatible with what they are running.
-                 * 3) The server said there is an update, but the update's hash is the same as
-                 *    the currently running update. This should _never_ happen, unless there is a
-                 *    bug in the server, but we're adding this check just to double-check that the
-                 *    client app is resilient to a potential issue with the update check.
-                 */
-                if (!update || update.updateAppVersion || (update.packageHash === localPackage.packageHash)) {
-                  return resolve(null);
-                } 
+    .then((configResult) => {            
+      /*
+       * If a deployment key was explicitly provided,
+       * then let's override the one we retrieved
+       * from the native-side of the app. This allows
+       * dynamically "redirecting" end-users at different
+       * deployments (e.g. an early access deployment for insiders).
+       */
+      if (deploymentKey) {
+        config = Object.assign({}, configResult, { deploymentKey });
+      } else {
+        config = configResult;
+      }
+      
+      sdk = new module.exports.AcquisitionSdk(requestFetchAdapter, config);
+      
+      // Allow dynamic overwrite of function. This is only to be used for tests.
+      return module.exports.getCurrentPackage();
+    })
+    .then((localPackage) => {
+      var queryPackage = { appVersion: config.appVersion };
+      
+      /*
+       * If the app has a previously installed update, and that update
+       * was targetted at the same app version that is currently running,
+       * then we want to use its package hash to determine whether a new
+       * release has been made on the server. Otherwise, we only need
+       * to send the app version to the server, since we are interested
+       * in any updates for current app store version, regardless of hash.
+       */
+      if (localPackage && localPackage.appVersion && semver.compare(localPackage.appVersion, config.appVersion) === 0) {
+        queryPackage = localPackage;
+      }
+      
+      return new Promise((resolve, reject) => {
+        sdk.queryUpdateWithCurrentPackage(queryPackage, (err, update) => {
+          if (err) {
+            return reject(err);
+          }
+          
+          /*
+           * There are three cases where checkForUpdate will resolve to null:
+           * ----------------------------------------------------------------
+           * 1) The server said there isn't an update. This is the most common case.
+           * 2) The server said there is an update but it requires a newer binary version.
+           *    This would occur when end-users are running an older app store version than
+           *    is available, and CodePush is making sure they don't get an update that
+           *    potentially wouldn't be compatible with what they are running.
+           * 3) The server said there is an update, but the update's hash is the same as
+           *    the currently running update. This should _never_ happen, unless there is a
+           *    bug in the server, but we're adding this check just to double-check that the
+           *    client app is resilient to a potential issue with the update check.
+           */
+          if (!update || update.updateAppVersion || (update.packageHash === localPackage.packageHash)) {
+            return resolve(null);
+          } 
 
-                update = Object.assign(update, PackageMixins.remote);
-                
-                NativeCodePush.isFailedUpdate(update.packageHash)
-                  .then((isFailedHash) => {
-                    update.failedInstall = isFailedHash;
-                    resolve(update);
-                  })
-                  .catch(reject)
-                  .done();
-              })
-            });
-          });
+          update = Object.assign(update, PackageMixins.remote);
+          
+          NativeCodePush.isFailedUpdate(update.packageHash)
+            .then((isFailedHash) => {
+              update.failedInstall = isFailedHash;
+              resolve(update);
+            })
+            .catch(reject)
+            .done();
+        })
+      });
+    });
 }
 
 var getConfiguration = (() => {
@@ -129,30 +129,21 @@ function getCurrentPackage() {
   });
 }
 
-function getSDK(config) {
-   if (testSdk) {
-      return testSdk;
-   } else {
-      return new Sdk(requestFetchAdapter, config);
-   }
-}
-
 /* Logs messages to console with the [CodePush] prefix */
 function log(message) {
   console.log(`[CodePush] ${message}`)
 }
 
 var testConfig;
-var testSdk;
 
 // This function is only used for tests. Replaces the default SDK, configuration and native bridge
-function setUpTestDependencies(providedTestSdk, providedTestConfig, testNativeBridge) {
-  if (providedTestSdk) testSdk = providedTestSdk;
+function setUpTestDependencies(testSdk, providedTestConfig, testNativeBridge) {
+  if (testSdk) module.exports.AcquisitionSdk = testSdk;
   if (providedTestConfig) testConfig = providedTestConfig;
   if (testNativeBridge) NativeCodePush = testNativeBridge;
 }
 
-/**
+/*
  * The sync method provides a simple, one-line experience for
  * incorporating the check, download and application of an update.
  * 
@@ -303,6 +294,7 @@ function sync(options = {}, syncStatusChangeCallback, downloadProgressCallback)
 };
 
 var CodePush = {
+  AcquisitionSdk: Sdk,
   checkForUpdate: checkForUpdate,
   getConfiguration: getConfiguration,
   getCurrentPackage: getCurrentPackage,

CodePush.m

@@ -13,7 +13,7 @@ @implementation CodePush {
 
 RCT_EXPORT_MODULE()
 
-static BOOL usingTestFolder = NO;
+static BOOL testConfigurationFlag = NO;
 
 // These keys represent the names we use to store data in NSUserDefaults
 static NSString *const FailedUpdatesKey = @"CODE_PUSH_FAILED_UPDATES";
@@ -50,7 +50,10 @@ + (NSURL *)bundleURLForResource:(NSString *)resourceName
     NSString *packageFile = [CodePushPackage getCurrentPackageBundlePath:&error];
     NSURL *binaryJsBundleUrl = [[NSBundle mainBundle] URLForResource:resourceName withExtension:resourceExtension];
 
+    NSString *logMessageFormat = @"Loading JS bundle from %@";
+    
     if (error || !packageFile) {
+        NSLog(logMessageFormat, binaryJsBundleUrl);
         return binaryJsBundleUrl;
     }
 
@@ -61,8 +64,11 @@ + (NSURL *)bundleURLForResource:(NSString *)resourceName
 
     if ([binaryDate compare:packageDate] == NSOrderedAscending) {
         // Return package file because it is newer than the app store binary's JS bundle
-        return [[NSURL alloc] initFileURLWithPath:packageFile];
+        NSURL *packageUrl = [[NSURL alloc] initFileURLWithPath:packageFile];
+        NSLog(logMessageFormat, packageUrl);
+        return packageUrl;
     } else {
+        NSLog(logMessageFormat, binaryJsBundleUrl);
         return binaryJsBundleUrl;
     }
 }
@@ -73,6 +79,40 @@ + (NSString *)getApplicationSupportDirectory
     return applicationSupportDirectory;
 }
 
+/*
+ * This returns a boolean value indicating whether CodePush has
+ * been set to run under a test configuration.
+ */
++ (BOOL)isUsingTestConfiguration
+{
+    return testConfigurationFlag;
+}
+
+/* 
+ * This is used to enable an environment in which tests can be run.
+ * Specifically, it flips a boolean flag that causes bundles to be
+ * saved to a test folder and enables the ability to modify
+ * installed bundles on the fly from JavaScript.
+ */
++ (void)setUsingTestConfiguration:(BOOL)shouldUseTestConfiguration
+{
+    testConfigurationFlag = shouldUseTestConfiguration;
+}
+
+/*
+ * This is used to clean up all test updates. It can only be used
+ * when the testConfigurationFlag is set to YES, otherwise it will
+ * simply no-op.
+ */
++ (void)clearTestUpdates
+{
+    if ([CodePush isUsingTestConfiguration]) {
+        [CodePushPackage clearTestUpdates];
+        [self removePendingUpdate];
+    }
+}
+
+
 // Private API methods
 
 /*
@@ -125,6 +165,7 @@ - (void)initializeUpdateAfterRestart
         if (updateIsLoading) {
             // 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.");
             [self rollbackPackage];
         } else {
             // Mark that we tried to initialize the new update, so that if it crashes,
@@ -179,7 +220,7 @@ - (void)loadBundle
         // is debugging and therefore, shouldn't be redirected to a local
         // file (since Chrome wouldn't support it). Otherwise, update
         // the current bundle URL to point at the latest update
-        if (![_bridge.bundleURL.scheme hasPrefix:@"http"]) {
+        if ([CodePush isUsingTestConfiguration] || ![_bridge.bundleURL.scheme hasPrefix:@"http"]) {
             _bridge.bundleURL = [CodePush bundleURL];
         }
 
@@ -204,7 +245,7 @@ - (void)rollbackPackage
 
     // Rollback to the previous version and de-register the new update
     [CodePushPackage rollbackPackage];
-    [self removePendingUpdate];
+    [CodePush removePendingUpdate];
     [self loadBundle];
 }
 
@@ -231,10 +272,10 @@ - (void)saveFailedUpdate:(NSString *)packageHash
 }
 
 /*
- * This method  is used to register the fact that a pending
+ * This method is used to register the fact that a pending
  * update succeeded and therefore can be removed.
  */
-- (void)removePendingUpdate
++ (void)removePendingUpdate
 {
     NSUserDefaults *preferences = [NSUserDefaults standardUserDefaults];
     [preferences removeObjectForKey:PendingUpdateKey];
@@ -351,19 +392,15 @@ - (void)savePendingUpdate:(NSString *)packageHash
             [self savePendingUpdate:updatePackage[PackageHashKey]
                           isLoading:NO];
 
-            if (installMode == CodePushInstallModeImmediate) {
-                [self loadBundle];
-            } else if (installMode == CodePushInstallModeOnNextResume) {
+            if (installMode == CodePushInstallModeOnNextResume && !_hasResumeListener) {
                 // Ensure we do not add the listener twice.
-                if (!_hasResumeListener) {
-                    // Register for app resume notifications so that we
-                    // can check for pending updates which support "restart on resume"
-                    [[NSNotificationCenter defaultCenter] addObserver:self
-                                                             selector:@selector(loadBundle)
-                                                                 name:UIApplicationWillEnterForegroundNotification
-                                                               object:[UIApplication sharedApplication]];
-                    _hasResumeListener = YES;
-                }
+                // Register for app resume notifications so that we
+                // can check for pending updates which support "restart on resume"
+                [[NSNotificationCenter defaultCenter] addObserver:self
+                                                         selector:@selector(loadBundle)
+                                                             name:UIApplicationWillEnterForegroundNotification
+                                                           object:[UIApplication sharedApplication]];
+                _hasResumeListener = YES;
             }
             // Signal to JS that the update has been applied.
             resolve(nil);
@@ -406,7 +443,7 @@ - (void)savePendingUpdate:(NSString *)packageHash
 RCT_EXPORT_METHOD(notifyApplicationReady:(RCTPromiseResolveBlock)resolve
                                 rejecter:(RCTPromiseRejectBlock)reject)
 {
-    [self removePendingUpdate];
+    [CodePush removePendingUpdate];
     resolve([NSNull null]);
 }
 
@@ -418,9 +455,17 @@ - (void)savePendingUpdate:(NSString *)packageHash
     [self loadBundle];
 }
 
-RCT_EXPORT_METHOD(setUsingTestFolder:(BOOL)shouldUseTestFolder)
+/*
+ * This method is the native side of the CodePush.downloadAndReplaceCurrentBundle()
+ * method, which replaces the current bundle with the one downloaded from
+ * removeBundleUrl. It is only to be used during tests and no-ops if the test 
+ * configuration flag is not set.
+ */
+RCT_EXPORT_METHOD(downloadAndReplaceCurrentBundle:(NSString *)remoteBundleUrl)
 {
-    usingTestFolder = shouldUseTestFolder;
+    if ([CodePush isUsingTestConfiguration]) {
+        [CodePushPackage downloadAndReplaceCurrentBundle:remoteBundleUrl];
+    }
 }
 
 @end