Background Updates - Revision history

Ehsan: /* Background updates */

2011-10-20T15:57:49Z

Background updates

← Older revision		Revision as of 15:57, 20 October 2011
Line 34:		Line 34:
	* The updater binary checks to see if there is an existing <code>FIREFOX_NEW</code> directory.		* The updater binary checks to see if there is an existing <code>FIREFOX_NEW</code> directory.
	** If this directory exists, it will be removed.		** If this directory exists, it will be removed.
	* ~~In case of a partial update, the~~ existing installation will be copied into <code>FIREFOX_NEW</code>.		* The existing installation will be copied into <code>FIREFOX_NEW</code>.
	* The updater binary will go ahead and apply the update to the <code>FIREFOX_NEW</code> directory using the existing installation directory as the base. Any errors happening during this phase (such as running out of disk space or failing to write to disk) will be handled by the updater process by removing the <code>FIREFOX_NEW</code> directory and aborting. The updater binary will also write to the manifest file "failed: n" where n is the reason code.		* The updater binary will go ahead and apply the update to the <code>FIREFOX_NEW</code> directory using the existing installation directory as the base. Any errors happening during this phase (such as running out of disk space or failing to write to disk) will be handled by the updater process by removing the <code>FIREFOX_NEW</code> directory and aborting. The updater binary will also write to the manifest file "failed: n" where n is the reason code.
	* The updater binary will write "applied" to the manifest file.		* The updater binary will write "applied" to the manifest file.

Ehsan: /* Firefox startup */

2011-10-19T15:15:51Z

Firefox startup

← Older revision		Revision as of 15:15, 19 October 2011
Line 43:		Line 43:
	The following needs to happen at Firefox startup time in order for the applied update to be used.		The following needs to happen at Firefox startup time in order for the applied update to be used.

	* Firefox checks for the manifest file in the installation directory. If it's not found, or its content does not equal "applied", then startup continues as normal.		* ''Firefox checks for the manifest file in the installation directory.'' If it's not found, or its content does not equal "applied", then startup continues as normal.
	* If the manifest file is found and its content is "applied", Firefox looks for the known <code>FIREFOX_NEW</code> directory. If that directory is not found, Firefox writes "failed: ERROR_CODE" to the manifest file and continues to startup as normal.		* If the manifest file is found and its content is "applied", Firefox looks for the known <code>FIREFOX_NEW</code> directory. If that directory is not found, Firefox writes "failed: ERROR_CODE" to the manifest file and continues to startup as normal.
	* If the <code>FIREFOX_NEW</code> is found, Firefox "replaces" the existing installation direcotry with the new <code>FIREFOX_NEW</code> directory, and removes the <code>FIREFOX_NEW</code> directory, and restarts using the new binary. The details of this phase depends on the platform, and is documented below.		* If the <code>FIREFOX_NEW</code> is found, Firefox "replaces" the existing installation direcotry with the new <code>FIREFOX_NEW</code> directory, and removes the <code>FIREFOX_NEW</code> directory, and restarts using the new binary. The details of this phase depends on the platform, and is documented below.

Ehsan: /* Implementation */

2011-10-19T15:15:08Z

Implementation

← Older revision		Revision as of 15:15, 19 October 2011
Line 18:		Line 18:
	==Implementation==		==Implementation==
	===Background updates===		===Background updates===
	Here is a proposal for how background updates will be implemented.		Here is a proposal for how background updates will be implemented. Please note that the parts in ''italics'' explain what currently happens, and those parts are not changed under this proposal. They are only mentioned here for completeness.

	* The process will start by Firefox checking for an update in the foreground or background.		* ''The process will start by Firefox checking for an update in the foreground or background.''
	* Once an update is found		* ''Once an update is found ''
	** If the user needs to prompted for some reason, we show that prompt at the normal time. (e.g, on idle). If the user declines, we bail out.		** ''If the user needs to prompted for some reason, we show that prompt at the normal time. (e.g, on idle). If the user declines, we bail out. ''
	** Otherwise, we go ahead and download the update (as a complete/partial MAR file).		** ''Otherwise, we go ahead and download the update (as a complete/partial MAR file). ''
	* Once the download is finished, Firefox launches the updater binary in the background with the UI display disabled. Searching for new updates will be paused during this time.		* Once the download is finished, Firefox launches the updater binary in the background with the UI display disabled. Searching for new updates will be paused during this time.
	** The target of the update will be known <code>FIREFOX_NEW</code> from now on.		** The target of the update will be known <code>FIREFOX_NEW</code> from now on.

Ehsan: /* Non-Goals */

2011-10-19T14:57:55Z

Non-Goals

← Older revision		Revision as of 14:57, 19 October 2011
Line 10:		Line 10:
	==Non-Goals==		==Non-Goals==
	# Handling UAC prompts on Windows (covered in [[Silent_Update_OS_Dialogs\|this project]])		# Handling UAC prompts on Windows (covered in [[Silent_Update_OS_Dialogs\|this project]])
	# Changing the frequency of checking for updates, our handling of major/minor updates, or the way we check for add-ons compatibility (covered in [[Features/Add-ons/Add-ons_Default_to_Compatible\|this project])		# Changing the frequency of checking for updates, our handling of major/minor updates, or the way we check for add-ons compatibility (covered in [[Features/Add-ons/Add-ons_Default_to_Compatible\|this project]])
	# Eliminating the UI we display in Item 2 (parts of it covered in [[Silent_Update_not_now_prompt\|this project])		# Eliminating the UI we display in Item 2 (parts of it covered in [[Silent_Update_not_now_prompt\|this project]])
	# Changing how updates work on Android		# Changing how updates work on Android
	# Downloading and/or apply update while Firefox is not running		# Downloading and/or apply update while Firefox is not running

Ehsan: /* Non-Goals */

2011-10-19T14:57:32Z

Non-Goals

← Older revision		Revision as of 14:57, 19 October 2011
Line 10:		Line 10:
	==Non-Goals==		==Non-Goals==
	# Handling UAC prompts on Windows (covered in [[Silent_Update_OS_Dialogs\|this project]])		# Handling UAC prompts on Windows (covered in [[Silent_Update_OS_Dialogs\|this project]])
	# Changing the frequency of checking for updates, our handling of major/minor updates, or the way we check for add-ons compatibility		# Changing the frequency of checking for updates, our handling of major/minor updates, or the way we check for add-ons compatibility (covered in [[Features/Add-ons/Add-ons_Default_to_Compatible\|this project])
	# Eliminating the UI we display in Item 2		# Eliminating the UI we display in Item 2 (parts of it covered in [[Silent_Update_not_now_prompt\|this project])
	# Changing how updates work on Android		# Changing how updates work on Android
	# Downloading and/or apply update while Firefox is not running		# Downloading and/or apply update while Firefox is not running
	# Any of the other projects falling under the [~~https://wiki.mozilla.org/~~Silent_Update "silent update" umbrella]		# Any of the other projects falling under the [[Silent_Update\|"silent update" umbrella]]

	==Implementation==		==Implementation==

Ehsan: /* Non-Goals */

2011-10-19T14:46:10Z

Non-Goals

← Older revision		Revision as of 14:46, 19 October 2011
Line 9:		Line 9:

	==Non-Goals==		==Non-Goals==
	# Handling UAC prompts on Windows		# Handling UAC prompts on Windows (covered in [[Silent_Update_OS_Dialogs\|this project]])
	# Changing the frequency of checking for updates, our handling of major/minor updates, or the way we check for add-ons compatibility		# Changing the frequency of checking for updates, our handling of major/minor updates, or the way we check for add-ons compatibility
	# Eliminating the UI we display in Item 2		# Eliminating the UI we display in Item 2

Jesse: /* Non-Goals */

2011-10-19T01:08:28Z

Non-Goals

← Older revision		Revision as of 01:08, 19 October 2011
Line 14:		Line 14:
	# Changing how updates work on Android		# Changing how updates work on Android
	# Downloading and/or apply update while Firefox is not running		# Downloading and/or apply update while Firefox is not running
	# Any of the other projects falling under the "silent update" umbrella		# Any of the other projects falling under the [https://wiki.mozilla.org/Silent_Update "silent update" umbrella]

	==Implementation==		==Implementation==

Ehsan: /* Non-Goals */

2011-10-18T20:35:32Z

Non-Goals

← Older revision		Revision as of 20:35, 18 October 2011
Line 13:		Line 13:
	# Eliminating the UI we display in Item 2		# Eliminating the UI we display in Item 2
	# Changing how updates work on Android		# Changing how updates work on Android
			# Downloading and/or apply update while Firefox is not running
	# Any of the other projects falling under the "silent update" umbrella		# Any of the other projects falling under the "silent update" umbrella

Mephiles: corrected wiki syntax

2011-10-18T19:20:37Z

corrected wiki syntax

← Older revision		Revision as of 19:20, 18 October 2011
Line 1:		Line 1:
	This page describes the technical plan to move the process of applying the updates in Firefox to the background as opposed to at startup. In order to get a clear idea about the scope of the project, please see the Goals and Non-Goals sections below.		This page describes the technical plan to move the process of applying the updates in Firefox to the background as opposed to at startup. In order to get a clear idea about the scope of the project, please see the Goals and Non-Goals sections below.

	= Goals =		==Goals==

	# Moving the update process to the background		# Moving the update process to the background
	# Initiating the update process as soon as an update is downloaded		# Initiating the update process as soon as an update is downloaded
Line 9:		Line 8:
	# Eliminate the progress bar UI that the current updater shows		# Eliminate the progress bar UI that the current updater shows

	= Non-Goals =		==Non-Goals==

	# Handling UAC prompts on Windows		# Handling UAC prompts on Windows
	# Changing the frequency of checking for updates, our handling of major/minor updates, or the way we check for add-ons compatibility		# Changing the frequency of checking for updates, our handling of major/minor updates, or the way we check for add-ons compatibility
Line 17:		Line 15:
	# Any of the other projects falling under the "silent update" umbrella		# Any of the other projects falling under the "silent update" umbrella

	= Implementation =		==Implementation==
	== Background updates ==		===Background updates===
	Here is a proposal for how background updates will be implemented.		Here is a proposal for how background updates will be implemented.

Line 41:		Line 39:
	* The Firefox main process will search for new updates when the next update interval is reached.		* The Firefox main process will search for new updates when the next update interval is reached.

	== Firefox startup ==		===Firefox startup===
	The following needs to happen at Firefox startup time in order for the applied update to be used.		The following needs to happen at Firefox startup time in order for the applied update to be used.

Line 48:		Line 46:
	* If the <code>FIREFOX_NEW</code> is found, Firefox "replaces" the existing installation direcotry with the new <code>FIREFOX_NEW</code> directory, and removes the <code>FIREFOX_NEW</code> directory, and restarts using the new binary. The details of this phase depends on the platform, and is documented below.		* If the <code>FIREFOX_NEW</code> is found, Firefox "replaces" the existing installation direcotry with the new <code>FIREFOX_NEW</code> directory, and removes the <code>FIREFOX_NEW</code> directory, and restarts using the new binary. The details of this phase depends on the platform, and is documented below.

	== Replacing the existing installation ==		===Replacing the existing installation===
	=== Windows ===		====Windows====
	On Windows, it is not possible to remove or rename files and directories which are being used. In order to handle this, we need to add a little complexity.		On Windows, it is not possible to remove or rename files and directories which are being used. In order to handle this, we need to add a little complexity.

Line 58:		Line 56:
	* At the end of its run, the helper app relaunches Firefox as a non elevated process from the path name of the existing installation, whatever it was.		* At the end of its run, the helper app relaunches Firefox as a non elevated process from the path name of the existing installation, whatever it was.

	=== Mac ===		====Mac====
	On Mac, we basically move the Contents directory in the <code>FIREFOX_NEW</code> directory over to the Contents directory in the existing installation, remove the now empty <code>FIREFOX_NEW</code> directory, write "succeeded" to the manifest file, and restart Firefox.		On Mac, we basically move the Contents directory in the <code>FIREFOX_NEW</code> directory over to the Contents directory in the existing installation, remove the now empty <code>FIREFOX_NEW</code> directory, write "succeeded" to the manifest file, and restart Firefox.

	=== Linux ===		====Linux====
	On Linux, we basically move the <code>FIREFOX_NEW</code> over the existing installation directory, write "succeeded" to the manifest file, and restart Firefox.		On Linux, we basically move the <code>FIREFOX_NEW</code> over the existing installation directory, write "succeeded" to the manifest file, and restart Firefox.

	== Considered alternatives ==		===Considered alternatives===
	A number of other approaches have been considered before writing this proposal. One such approach is to make <code>FIREFOX_NEW</code> live inside the existing installation directory. That will cause a lot of pain on Windows where we can't overwrite files that are currently open in another application.		A number of other approaches have been considered before writing this proposal. One such approach is to make <code>FIREFOX_NEW</code> live inside the existing installation directory. That will cause a lot of pain on Windows where we can't overwrite files that are currently open in another application.

	We have also considered keeping two versions of Firefox in versioned side-by-side directory. That will also lead into a number of problems because the directory from which Firefox is going to be launched is going to change over and over again.		We have also considered keeping two versions of Firefox in versioned side-by-side directory. That will also lead into a number of problems because the directory from which Firefox is going to be launched is going to change over and over again.

	= Downgrade =		==Downgrade==
	Firefox currently supports downgrading to older versions by installing an old installer over the new installation directory. The way that it works is that the Firefox installer first uninstalls the old version and then proceeds with the rest of the installation. This can be made possible in the face of background updates by relying on the uninstaller to know about the manifest file, and making the installer aware of the <code>FIREFOX_NEW</code> directory. The uninstaller should remove the <code>FIREFOX_NEW</code> directory as part of the uninstall process. The same handling is enough to correctly handle Firefox being uninstalled explicitly as well.		Firefox currently supports downgrading to older versions by installing an old installer over the new installation directory. The way that it works is that the Firefox installer first uninstalls the old version and then proceeds with the rest of the installation. This can be made possible in the face of background updates by relying on the uninstaller to know about the manifest file, and making the installer aware of the <code>FIREFOX_NEW</code> directory. The uninstaller should remove the <code>FIREFOX_NEW</code> directory as part of the uninstall process. The same handling is enough to correctly handle Firefox being uninstalled explicitly as well.

Ehsan: /* Background updates */

2011-10-18T18:02:33Z

Background updates

← Older revision		Revision as of 18:02, 18 October 2011
Line 35:		Line 35:
	* The updater binary checks to see if there is an existing <code>FIREFOX_NEW</code> directory.		* The updater binary checks to see if there is an existing <code>FIREFOX_NEW</code> directory.
	** If this directory exists, it will be removed.		** If this directory exists, it will be removed.
			* In case of a partial update, the existing installation will be copied into <code>FIREFOX_NEW</code>.
	* The updater binary will go ahead and apply the update to the <code>FIREFOX_NEW</code> directory using the existing installation directory as the base. Any errors happening during this phase (such as running out of disk space or failing to write to disk) will be handled by the updater process by removing the <code>FIREFOX_NEW</code> directory and aborting. The updater binary will also write to the manifest file "failed: n" where n is the reason code.		* The updater binary will go ahead and apply the update to the <code>FIREFOX_NEW</code> directory using the existing installation directory as the base. Any errors happening during this phase (such as running out of disk space or failing to write to disk) will be handled by the updater process by removing the <code>FIREFOX_NEW</code> directory and aborting. The updater binary will also write to the manifest file "failed: n" where n is the reason code.
	* The updater binary will write "applied" to the manifest file.		* The updater binary will write "applied" to the manifest file.