browser/components/sessionstore

firefox-main/browser/components/sessionstore

	Name	Description	Size	Coverage
	components.conf		503	-
	content			84 %
	docs			-
	GlobalState.sys.mjs	Module that contains global session data.	1611	-
	jar.mn		398	-
	metrics.yaml		39054	-
	moz.build		1355	-
	PageWireframes.sys.mjs	Returns the wireframe object for the current index of the session history for the given tab. The wireframe will only exist with browser.history.collectWireframes. @param {object} tab @return {object} wireframe See dom/webidl/Document.webidl for the Wireframe dictionary	3886	-
	RecentlyClosedTabsAndWindowsMenuUtils.sys.mjs	@returns {Map<TabGroupId, ClosedTabGroupStateData>} Map of closed tab groups keyed by tab group ID	20949	-
	RunState.sys.mjs	This module keeps track of SessionStore's current run state. We will always start out at STATE_STOPPED. After the session was read from disk and the initial browser window has loaded we switch to STATE_RUNNING. On the first notice that a browser shutdown was granted we switch to STATE_QUITTING.	3341	-
	session.schema.json		19226	-
	SessionCookies.sys.mjs	The external API implemented by the SessionCookies module.	8052	-
	SessionFile.sys.mjs	Implementation of all the disk I/O required by the session store. This is a private API, meant to be used only by the session store. It will change. Do not use it for any other purpose. Note that this module depends on SessionWriter and that it enqueues its I/O requests and never attempts to simultaneously execute two I/O requests on the files used by this module from two distinct threads. Otherwise, we could encounter bugs, especially under Windows, e.g. if a request attempts to write sessionstore.js while another attempts to copy that file.	23077	-
	SessionLogger.sys.mjs		4531	-
	SessionMigration.sys.mjs	Convert the original session restore state into a minimal state. It will only contain: - open windows - with tabs - with history entries with only title, url, triggeringPrincipal - with pinned state - with tab group info - with selected tab info - with selected window info - saved tab groups The complete state is then wrapped into the "about:welcomeback" page as form field info to be restored when restoring the state.	5112	-
	SessionSaver.sys.mjs	Minimal interval between two save operations (in milliseconds). To save system resources, we generally do not save changes immediately when a change is detected. Rather, we wait a little to see if this change is followed by other changes, in which case only the last write is necessary. This delay is defined by "browser.sessionstore.interval". Furthermore, when the user is not actively using the computer, webpages may still perform changes that require (re)writing to sessionstore, e.g. updating Session Cookies or DOM Session Storage, or refreshing, etc. We expect that these changes are much less critical to the user and do not need to be saved as often. In such cases, we increase the delay to "browser.sessionstore.interval.idle". When the user returns to the computer, if a save is pending, we reschedule it to happen soon, with "browser.sessionstore.interval".	14207	-
	SessionStartup.sys.mjs	Session Storage and Restoration Overview This service reads user's session file at startup, and makes a determination as to whether the session should be restored. It will restore the session under the circumstances described below. If the auto-start Private Browsing mode is active, however, the session is never restored. Crash Detection The CrashMonitor is used to check if the final session state was successfully written at shutdown of the last session. If we did not reach 'sessionstore-final-state-write-complete', then it's assumed that the browser has previously crashed and we should restore the session. Forced Restarts In the event that a restart is required due to application update or extension installation, set the browser.sessionstore.resume_session_once pref to true, and the session will be restored the next time the browser starts. Always Resume This service will always resume the session if the integer pref browser.startup.page is set to 3.	17848	-
	SessionStore.sys.mjs	@typedef {string} WindowID ID SessionStore assigns to a window, unique within the session.	332064	-
	SessionStoreFunctions.sys.mjs		1964	-
	SessionWindowUI.sys.mjs	This module handles UI interactions for session restore features, primarily for interacting with browser windows to restore closed tabs and sessions.	7958	-
	SessionWriter.sys.mjs	We just started (we haven't written anything to disk yet) from `Paths.clean`. The backup directory may not exist.	15811	-
	StartupPerformance.sys.mjs	Once we have finished restoring initial tabs, we broadcast on this topic.	9377	-
	TabAttributes.sys.mjs		980	-
	TabGroupState.sys.mjs	@typedef {string} TabGroupId Unique ID of a tab group.	6835	-
	TabState.sys.mjs	@typedef {object} TabStateData State of a tab, validated in the session file by the `tab` definition in `session.schema.json`. @property {object[]} entries Session history entries, oldest first, matching the schema's `entry` definition. @property {number} lastAccessed Timestamp from `Date.now()` of when the tab was last selected. @property {number} [index] 1-based index of the active entry in `entries`. @property {number} [requestedIndex] 1-based index of the entry a pending restore is navigating to. @property {boolean} [hidden] Whether the tab is hidden from the tab strip. @property {boolean} [pinned] Whether the tab is pinned. @property {boolean} [muted] Whether the tab was muted through the tab, i.e. by the user or an extension, as opposed to a mute the browser applies internally, such as the one a closing tab gets. @property {string} [muteReason] Extension that muted the tab, if an extension did. @property {TabGroupId} [groupId] Tab group the tab belongs to. @property {number} [splitViewId] Split view the tab belongs to. @property {string} [canonicalUrl] Canonical URL of the tab's document, subject to the privacy level. @property {object} [searchMode] Address bar search mode the tab is in. @property {number} [userContextId] Container the tab is in, 0 for the default context. @property {Record<string, string>} [attributes] Persisted tab attributes, collected by `TabAttributes`. @property {Record<string, string>} [extData] Values set through `SessionStore.setCustomTabValue`. @property {string} [image] URL of the tab's icon. @property {string} [userTypedValue] Address bar input that hasn't been loaded. @property {number} [userTypedClear] 1 if a load started after `userTypedValue` was typed, 0 otherwise. @property {object} [storage] Session storage of the tab's document, keyed by origin. @property {object} [formdata] Form data of the tab's document. @property {object} [scroll] Scroll position of the tab's document. @property {string} [disallow] Comma-separated docshell capabilities to turn off on restore. @property {boolean} [isPrivate] Whether the tab belongs to a private window. @property {boolean} [connectionPrepared] Whether a speculative connection has been made for the pending restore. @property {boolean} [removeAfterRestore] Whether the tab is to be closed once it has been restored.	13108	-
	TabStateCache.sys.mjs	A cache for tabs data. This cache implements a weak map from tabs (as XUL elements) to tab data (as objects). Note that we should never cache private data, as: - that data is used very seldom by SessionStore; - caching private data in addition to public data is memory consuming.	4103	-
	TabStateFlusher.sys.mjs	A module that enables async flushes. Content processes buffer tab state updates for up to `browser.sessionstore.interval` milliseconds before sending them. If an action wants a tab's latest state without waiting for that then it can request an async flush and wait until the content processes reported back. At this point the parent has the latest data and the action can continue.	3895	-
<1%	test			-
	triage.json		2243	-
	tsconfig.json		511	-
	types			-

Revision control

Other Tools