summaryrefslogtreecommitdiffstats
path: root/application/basilisk/components/sessionstore/TabStateFlusher.jsm
diff options
context:
space:
mode:
authorMatt A. Tobin <email@mattatobin.com>2018-02-02 05:06:10 -0500
committerMatt A. Tobin <email@mattatobin.com>2018-02-02 05:06:10 -0500
commit6d614170cbfa958564eb5f824234ad5a9e484344 (patch)
tree3e1eb384382f30987cb2e64bd654afa8b74fd06b /application/basilisk/components/sessionstore/TabStateFlusher.jsm
parent2a6b605d64b19411a300efdbbd7f78c349f90206 (diff)
downloadUXP-6d614170cbfa958564eb5f824234ad5a9e484344.tar
UXP-6d614170cbfa958564eb5f824234ad5a9e484344.tar.gz
UXP-6d614170cbfa958564eb5f824234ad5a9e484344.tar.lz
UXP-6d614170cbfa958564eb5f824234ad5a9e484344.tar.xz
UXP-6d614170cbfa958564eb5f824234ad5a9e484344.zip
Revert "Add Basilisk"
This reverts commit e72ef92b5bdc43cd2584198e2e54e951b70299e8.
Diffstat (limited to 'application/basilisk/components/sessionstore/TabStateFlusher.jsm')
-rw-r--r--application/basilisk/components/sessionstore/TabStateFlusher.jsm184
1 files changed, 0 insertions, 184 deletions
diff --git a/application/basilisk/components/sessionstore/TabStateFlusher.jsm b/application/basilisk/components/sessionstore/TabStateFlusher.jsm
deleted file mode 100644
index 6397efe9d..000000000
--- a/application/basilisk/components/sessionstore/TabStateFlusher.jsm
+++ /dev/null
@@ -1,184 +0,0 @@
-/* This Source Code Form is subject to the terms of the Mozilla Public
- * License, v. 2.0. If a copy of the MPL was not distributed with this file,
- * You can obtain one at http://mozilla.org/MPL/2.0/. */
-
-"use strict";
-
-this.EXPORTED_SYMBOLS = ["TabStateFlusher"];
-
-const Cu = Components.utils;
-
-Cu.import("resource://gre/modules/Promise.jsm", this);
-
-/**
- * A module that enables async flushes. Updates from frame scripts are
- * throttled to be sent only once per second. If an action wants a tab's latest
- * state without waiting for a second then it can request an async flush and
- * wait until the frame scripts reported back. At this point the parent has the
- * latest data and the action can continue.
- */
-this.TabStateFlusher = Object.freeze({
- /**
- * Requests an async flush for the given browser. Returns a promise that will
- * resolve when we heard back from the content process and the parent has
- * all the latest data.
- */
- flush(browser) {
- return TabStateFlusherInternal.flush(browser);
- },
-
- /**
- * Requests an async flush for all browsers of a given window. Returns a Promise
- * that will resolve when we've heard back from all browsers.
- */
- flushWindow(window) {
- return TabStateFlusherInternal.flushWindow(window);
- },
-
- /**
- * Resolves the flush request with the given flush ID.
- *
- * @param browser (<xul:browser>)
- * The browser for which the flush is being resolved.
- * @param flushID (int)
- * The ID of the flush that was sent to the browser.
- * @param success (bool, optional)
- * Whether or not the flush succeeded.
- * @param message (string, optional)
- * An error message that will be sent to the Console in the
- * event that a flush failed.
- */
- resolve(browser, flushID, success=true, message="") {
- TabStateFlusherInternal.resolve(browser, flushID, success, message);
- },
-
- /**
- * Resolves all active flush requests for a given browser. This should be
- * used when the content process crashed or the final update message was
- * seen. In those cases we can't guarantee to ever hear back from the frame
- * script so we just resolve all requests instead of discarding them.
- *
- * @param browser (<xul:browser>)
- * The browser for which all flushes are being resolved.
- * @param success (bool, optional)
- * Whether or not the flushes succeeded.
- * @param message (string, optional)
- * An error message that will be sent to the Console in the
- * event that the flushes failed.
- */
- resolveAll(browser, success=true, message="") {
- TabStateFlusherInternal.resolveAll(browser, success, message);
- }
-});
-
-var TabStateFlusherInternal = {
- // Stores the last request ID.
- _lastRequestID: 0,
-
- // A map storing all active requests per browser.
- _requests: new WeakMap(),
-
- /**
- * Requests an async flush for the given browser. Returns a promise that will
- * resolve when we heard back from the content process and the parent has
- * all the latest data.
- */
- flush(browser) {
- let id = ++this._lastRequestID;
- let mm = browser.messageManager;
- mm.sendAsyncMessage("SessionStore:flush", {id});
-
- // Retrieve active requests for given browser.
- let permanentKey = browser.permanentKey;
- let perBrowserRequests = this._requests.get(permanentKey) || new Map();
-
- return new Promise(resolve => {
- // Store resolve() so that we can resolve the promise later.
- perBrowserRequests.set(id, resolve);
-
- // Update the flush requests stored per browser.
- this._requests.set(permanentKey, perBrowserRequests);
- });
- },
-
- /**
- * Requests an async flush for all browsers of a given window. Returns a Promise
- * that will resolve when we've heard back from all browsers.
- */
- flushWindow(window) {
- let browsers = window.gBrowser.browsers;
- let promises = browsers.map((browser) => this.flush(browser));
- return Promise.all(promises);
- },
-
- /**
- * Resolves the flush request with the given flush ID.
- *
- * @param browser (<xul:browser>)
- * The browser for which the flush is being resolved.
- * @param flushID (int)
- * The ID of the flush that was sent to the browser.
- * @param success (bool, optional)
- * Whether or not the flush succeeded.
- * @param message (string, optional)
- * An error message that will be sent to the Console in the
- * event that a flush failed.
- */
- resolve(browser, flushID, success=true, message="") {
- // Nothing to do if there are no pending flushes for the given browser.
- if (!this._requests.has(browser.permanentKey)) {
- return;
- }
-
- // Retrieve active requests for given browser.
- let perBrowserRequests = this._requests.get(browser.permanentKey);
- if (!perBrowserRequests.has(flushID)) {
- return;
- }
-
- if (!success) {
- Cu.reportError("Failed to flush browser: " + message);
- }
-
- // Resolve the request with the given id.
- let resolve = perBrowserRequests.get(flushID);
- perBrowserRequests.delete(flushID);
- resolve(success);
- },
-
- /**
- * Resolves all active flush requests for a given browser. This should be
- * used when the content process crashed or the final update message was
- * seen. In those cases we can't guarantee to ever hear back from the frame
- * script so we just resolve all requests instead of discarding them.
- *
- * @param browser (<xul:browser>)
- * The browser for which all flushes are being resolved.
- * @param success (bool, optional)
- * Whether or not the flushes succeeded.
- * @param message (string, optional)
- * An error message that will be sent to the Console in the
- * event that the flushes failed.
- */
- resolveAll(browser, success=true, message="") {
- // Nothing to do if there are no pending flushes for the given browser.
- if (!this._requests.has(browser.permanentKey)) {
- return;
- }
-
- // Retrieve active requests for given browser.
- let perBrowserRequests = this._requests.get(browser.permanentKey);
-
- if (!success) {
- Cu.reportError("Failed to flush browser: " + message);
- }
-
- // Resolve all requests.
- for (let resolve of perBrowserRequests.values()) {
- resolve(success);
- }
-
- // Clear active requests.
- perBrowserRequests.clear();
- }
-};