Part 2 - Bug 951662 - remove test code that is no longer needed and change background to staging for consistency. r=bbondy

Author: Robert Strong

toolkit/xre/nsUpdateDriver.cpp

@@ -368,8 +368,8 @@ CopyUpdaterIntoUpdateDir(nsIFile *greDir, nsIFile *appDir, nsIFile *updateDir,
 }
 
 /**
- * Switch an existing application directory to an updated version which has been
- * previously constructed in the background.
+ * Switch an existing application directory to an updated version that has been
+ * staged.
  *
  * @param greDir the GRE dir
  * @param updateDir the update root dir
@@ -640,7 +640,7 @@ SetOSApplyToDir(nsIUpdate* update, const nsACString& osApplyToDir)
 #endif
 
 /**
- * Apply an update, possibly in the background.
+ * Apply an update. This applies to both normal and staged updates.
  *
  * @param greDir the GRE dir
  * @param updateDir the update root dir
@@ -649,10 +649,10 @@ SetOSApplyToDir(nsIUpdate* update, const nsACString& osApplyToDir)
  * @param appArgc the number of args to the application
  * @param appArgv the args to the application, used for restarting if needed
  * @param restart if true, apply the update in the foreground and restart the
- *                application when done.  otherwise, apply the update in the
- *                background and don't restart the application.
+ *                application when done.  otherwise, stage the update and don't
+ *                restart the application.
  * @param outpid out parameter holding the handle to the updater application for
- *               background updates.
+ *               staging updates.
  */
 static void
 ApplyUpdate(nsIFile *greDir, nsIFile *updateDir, nsIFile *statusFile,
@@ -731,8 +731,7 @@ ApplyUpdate(nsIFile *greDir, nsIFile *updateDir, nsIFile *statusFile,
     if (NS_FAILED(rv))
       return;
     if (restart) {
-      // Use the correct directory if we're not applying the update in the
-      // background.
+      // Use the correct directory if we're not staging the update.
       rv = parentDir2->GetNativePath(applyToDir);
     } else {
       if (!GetFile(parentDir2, NS_LITERAL_CSTRING("Updated.app"), updatedDir))
@@ -742,8 +741,7 @@ ApplyUpdate(nsIFile *greDir, nsIFile *updateDir, nsIFile *statusFile,
   }
 #else
   if (restart) {
-    // Use the correct directory if we're not applying the update in the
-    // background.
+    // Use the correct directory if we're not staging the update.
     updatedDir = do_QueryInterface(appDir);
   } else if (!GetFile(appDir, NS_LITERAL_CSTRING("updated"), updatedDir)) {
     return;
@@ -807,8 +805,7 @@ ApplyUpdate(nsIFile *greDir, nsIFile *updateDir, nsIFile *statusFile,
   // we pass "0" which is then ignored by the updater.
   nsAutoCString pid;
   if (!restart) {
-    // Signal the updater application that it should apply the update in the
-    // background.
+    // Signal the updater application that it should stage the update.
     pid.AssignASCII("-1");
   } else {
 #if defined(USE_EXECV)
@@ -876,7 +873,7 @@ ApplyUpdate(nsIFile *greDir, nsIFile *updateDir, nsIFile *statusFile,
   LOG(("spawning updater process [%s]\n", updaterPath.get()));
 
 #if defined(USE_EXECV)
-  // Don't use execv for background updates.
+  // Don't use execv when staging updates.
   if (restart) {
     execv(updaterPath.get(), argv);
   } else {
@@ -950,34 +947,12 @@ ProcessUpdates(nsIFile *greDir, nsIFile *appDir, nsIFile *updRootDir,
   if (NS_FAILED(rv))
     return rv;
 
-  ProcessType dummyPID; // this will only be used for MOZ_UPDATE_BACKGROUND
+  ProcessType dummyPID; // this will only be used for MOZ_UPDATE_STAGING
   const char *processingUpdates = PR_GetEnv("MOZ_PROCESS_UPDATES");
   if (processingUpdates && *processingUpdates) {
-    // Enable the tests to request us to use a different update root directory
-    const char *updRootOverride = PR_GetEnv("MOZ_UPDATE_ROOT_OVERRIDE");
-    if (updRootOverride && *updRootOverride) {
-      nsCOMPtr<nsIFile> overrideDir;
-      nsAutoCString path(updRootOverride);
-      rv = NS_NewNativeLocalFile(path, false, getter_AddRefs(overrideDir));
-      if (NS_FAILED(rv)) {
-        return rv;
-      }
-      updatesDir = do_QueryInterface(overrideDir);
-    }
-    // Enable the tests to request us to use a different app directory
-    const char *appDirOverride = PR_GetEnv("MOZ_UPDATE_APPDIR_OVERRIDE");
-    if (appDirOverride && *appDirOverride) {
-      nsCOMPtr<nsIFile> overrideDir;
-      nsAutoCString path(appDirOverride);
-      rv = NS_NewNativeLocalFile(path, false, getter_AddRefs(overrideDir));
-      if (NS_FAILED(rv)) {
-        return rv;
-      }
-      NS_ADDREF(appDir = overrideDir);
-    }
-    // Enable the tests to request us to perform a background update
-    const char *backgroundUpdate = PR_GetEnv("MOZ_UPDATE_BACKGROUND");
-    if (backgroundUpdate && *backgroundUpdate) {
+    // Enable the tests to request an update to be staged.
+    const char *stagingUpdate = PR_GetEnv("MOZ_UPDATE_STAGING");
+    if (stagingUpdate && *stagingUpdate) {
       restart = false;
       pid = &dummyPID;
     }
@@ -1003,8 +978,8 @@ ProcessUpdates(nsIFile *greDir, nsIFile *appDir, nsIFile *updRootDir,
   }
   case eAppliedUpdate:
   case eAppliedService:
-    // An update was applied in the background, so we need to switch to using
-    // it now.
+    // An update was staged and needs to be switched so the updated application
+    // is used.
     SwitchToUpdatedApp(greDir, updatesDir, statusFile,
                        appDir, argc, argv);
     break;
@@ -1108,7 +1083,7 @@ nsUpdateProcessor::ProcessUpdate(nsIUpdate* aUpdate)
     binary->GetNativePath(binPath);
   }
 
-  // Copy the parameters to the BackgroundUpdateInfo structure shared with the
+  // Copy the parameters to the StagedUpdateInfo structure shared with the
   // watcher thread.
   mInfo.mGREDir = greDir;
   mInfo.mAppDir = appDir;
@@ -1155,13 +1130,13 @@ nsUpdateProcessor::ProcessUpdate(nsIUpdate* aUpdate)
 
   NS_ABORT_IF_FALSE(NS_IsMainThread(), "not main thread");
   return NS_NewThread(getter_AddRefs(mProcessWatcher),
-                      NS_NewRunnableMethod(this, &nsUpdateProcessor::StartBackgroundUpdate));
+                      NS_NewRunnableMethod(this, &nsUpdateProcessor::StartStagedUpdate));
 }
 
 
 
 void
-nsUpdateProcessor::StartBackgroundUpdate()
+nsUpdateProcessor::StartStagedUpdate()
 {
   NS_ABORT_IF_FALSE(!NS_IsMainThread(), "main thread");
 
@@ -1178,11 +1153,11 @@ nsUpdateProcessor::StartBackgroundUpdate()
   NS_ENSURE_SUCCESS_VOID(rv);
 
   if (mUpdaterPID) {
-    // Track the state of the background updater process
+    // Track the state of the updater process while it is staging an update.
     rv = NS_DispatchToCurrentThread(NS_NewRunnableMethod(this, &nsUpdateProcessor::WaitForProcess));
     NS_ENSURE_SUCCESS_VOID(rv);
   } else {
-    // Failed to launch the background updater process for some reason.
+    // Failed to launch the updater process for some reason.
     // We need to shutdown the current thread as there isn't anything more for
     // us to do...
     rv = NS_DispatchToMainThread(NS_NewRunnableMethod(this, &nsUpdateProcessor::ShutdownWatcherThread));

toolkit/xre/nsUpdateDriver.h

@@ -59,7 +59,7 @@ NS_HIDDEN_(nsresult) ProcessUpdates(nsIFile *greDir, nsIFile *appDir,
 
 #ifdef MOZ_UPDATER
 // The implementation of the update processor handles the task of loading the
-// updater application in the background for applying an update.
+// updater application for staging an update.
 // XXX ehsan this is living in this file in order to make use of the existing
 // stuff here, we might want to move it elsewhere in the future.
 class nsUpdateProcessor MOZ_FINAL : public nsIUpdateProcessor
@@ -71,13 +71,13 @@ class nsUpdateProcessor MOZ_FINAL : public nsIUpdateProcessor
   NS_DECL_NSIUPDATEPROCESSOR
 
 private:
-  struct BackgroundUpdateInfo {
-    BackgroundUpdateInfo()
+  struct StagedUpdateInfo {
+    StagedUpdateInfo()
       : mArgc(0),
         mArgv(nullptr),
         mIsOSUpdate(false)
     {}
-    ~BackgroundUpdateInfo() {
+    ~StagedUpdateInfo() {
       for (int i = 0; i < mArgc; ++i) {
         delete[] mArgv[i];
       }
@@ -95,7 +95,7 @@ class nsUpdateProcessor MOZ_FINAL : public nsIUpdateProcessor
   };
 
 private:
-  void StartBackgroundUpdate();
+  void StartStagedUpdate();
   void WaitForProcess();
   void UpdateDone();
   void ShutdownWatcherThread();
@@ -104,7 +104,7 @@ class nsUpdateProcessor MOZ_FINAL : public nsIUpdateProcessor
   ProcessType mUpdaterPID;
   nsCOMPtr<nsIThread> mProcessWatcher;
   nsCOMPtr<nsIUpdate> mUpdate;
-  BackgroundUpdateInfo mInfo;
+  StagedUpdateInfo mInfo;
 };
 #endif
 

toolkit/xre/nsXREDirProvider.cpp

@@ -1003,8 +1003,7 @@ nsXREDirProvider::GetUpdateRootDir(nsIFile* *aResult)
   bool pathHashResult = false;
 
   nsAutoString appDirPath;
-  if (gAppData->vendor && !getenv("MOZ_UPDATE_NO_HASH_DIR") &&
-      SUCCEEDED(updRoot->GetPath(appDirPath))) {
+  if (gAppData->vendor && SUCCEEDED(updRoot->GetPath(appDirPath))) {
 
     // Figure out where we should check for a cached hash value
     wchar_t regPath[1024] = { L'\0' };