@browserless.io/browserless 2.0.0-beta-1

package/extensions/ublock/js/vapi-client-extra.js

@@ -0,0 +1,312 @@
+/*******************************************************************************
+
+    uBlock Origin - a browser extension to block requests.
+    Copyright (C) 2019-present Raymond Hill
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see {http://www.gnu.org/licenses/}.
+
+    Home: https://github.com/gorhill/uBlock
+*/
+
+// For non-background page
+
+'use strict';
+
+/******************************************************************************/
+
+// Direct messaging connection ability
+
+(( ) => {
+// >>>>>>>> start of private namespace
+
+if (
+    typeof vAPI !== 'object' ||
+    vAPI.messaging instanceof Object === false ||
+    vAPI.MessagingConnection instanceof Function
+) {
+    return;
+}
+
+const listeners = new Set();
+const connections = new Map();
+
+vAPI.MessagingConnection = class {
+    constructor(handler, details) {
+        this.messaging = vAPI.messaging;
+        this.handler = handler;
+        this.id = details.id;
+        this.to = details.to;
+        this.toToken = details.toToken;
+        this.from = details.from;
+        this.fromToken = details.fromToken;
+        this.checkTimer = undefined;
+        // On Firefox it appears ports are not automatically disconnected
+        // when navigating to another page.
+        const ctor = vAPI.MessagingConnection;
+        if ( ctor.pagehide !== undefined ) { return; }
+        ctor.pagehide = ( ) => {
+            for ( const connection of connections.values() ) {
+                connection.disconnect();
+                connection.handler(
+                    connection.toDetails('connectionBroken')
+                );
+            }
+        };
+        window.addEventListener('pagehide', ctor.pagehide);
+    }
+    toDetails(what, payload) {
+        return {
+            what: what,
+            id: this.id,
+            from: this.from,
+            fromToken: this.fromToken,
+            to: this.to,
+            toToken: this.toToken,
+            payload: payload
+        };
+    }
+    disconnect() {
+        if ( this.checkTimer !== undefined ) {
+            clearTimeout(this.checkTimer);
+            this.checkTimer = undefined;
+        }
+        connections.delete(this.id);
+        const port = this.messaging.getPort();
+        if ( port === null ) { return; }
+        port.postMessage({
+            channel: 'vapi',
+            msg:  this.toDetails('connectionBroken'),
+        });
+    }
+    checkAsync() {
+        if ( this.checkTimer !== undefined ) {
+            clearTimeout(this.checkTimer);
+        }
+        this.checkTimer = vAPI.setTimeout(
+            ( ) => { this.check(); },
+            499
+        );
+    }
+    check() {
+        this.checkTimer = undefined;
+        if ( connections.has(this.id) === false ) { return; }
+        const port = this.messaging.getPort();
+        if ( port === null ) { return; }
+        port.postMessage({
+            channel: 'vapi',
+            msg: this.toDetails('connectionCheck'),
+        });
+        this.checkAsync();
+    }
+    receive(details) {
+        switch ( details.what ) {
+        case 'connectionAccepted':
+            this.toToken = details.toToken;
+            this.handler(details);
+            this.checkAsync();
+            break;
+        case 'connectionBroken':
+            connections.delete(this.id);
+            this.handler(details);
+            break;
+        case 'connectionMessage':
+            this.handler(details);
+            this.checkAsync();
+            break;
+        case 'connectionCheck':
+            const port = this.messaging.getPort();
+            if ( port === null ) { return; }
+            if ( connections.has(this.id) ) {
+                this.checkAsync();
+            } else {
+                details.what = 'connectionBroken';
+                port.postMessage({ channel: 'vapi', msg: details });
+            }
+            break;
+        case 'connectionRefused':
+            connections.delete(this.id);
+            this.handler(details);
+            break;
+        }
+    }
+    send(payload) {
+        const port = this.messaging.getPort();
+        if ( port === null ) { return; }
+        port.postMessage({
+            channel: 'vapi',
+            msg: this.toDetails('connectionMessage', payload),
+        });
+    }
+
+    static addListener(listener) {
+        listeners.add(listener);
+        vAPI.messaging.getPort(); // Ensure a port instance exists
+    }
+    static removeListener(listener) {
+        listeners.delete(listener);
+    }
+    static connectTo(from, to, handler) {
+        const port = vAPI.messaging.getPort();
+        if ( port === null ) { return; }
+        const connection = new vAPI.MessagingConnection(handler, {
+            id: `${from}-${to}-${vAPI.sessionId}`,
+            to: to,
+            from: from,
+            fromToken: port.name
+        });
+        connections.set(connection.id, connection);
+        port.postMessage({
+            channel: 'vapi',
+            msg: {
+                what: 'connectionRequested',
+                id: connection.id,
+                from: from,
+                fromToken: port.name,
+                to: to,
+            }
+        });
+        return connection.id;
+    }
+    static disconnectFrom(connectionId) {
+        const connection = connections.get(connectionId);
+        if ( connection === undefined ) { return; }
+        connection.disconnect();
+    }
+    static sendTo(connectionId, payload) {
+        const connection = connections.get(connectionId);
+        if ( connection === undefined ) { return; }
+        connection.send(payload);
+    }
+    static canDestroyPort() {
+        return listeners.length === 0 && connections.size === 0;
+    }
+    static mustDestroyPort() {
+        if ( connections.size === 0 ) { return; }
+        for ( const connection of connections.values() ) {
+            connection.receive({ what: 'connectionBroken' });
+        }
+        connections.clear();
+    }
+    static canProcessMessage(details) {
+        if ( details.channel !== 'vapi' ) { return; }
+        switch ( details.msg.what ) {
+        case 'connectionAccepted':
+        case 'connectionBroken':
+        case 'connectionCheck':
+        case 'connectionMessage':
+        case 'connectionRefused': {
+            const connection = connections.get(details.msg.id);
+            if ( connection === undefined ) { break; }
+            connection.receive(details.msg);
+            return true;
+        }
+        case 'connectionRequested':
+            if ( listeners.length === 0 ) { return; }
+            const port = vAPI.messaging.getPort();
+            if ( port === null ) { break; }
+            let listener, result;
+            for ( listener of listeners ) {
+                result = listener(details.msg);
+                if ( result !== undefined ) { break; }
+            }
+            if ( result === undefined ) { break; }
+            if ( result === true ) {
+                details.msg.what = 'connectionAccepted';
+                details.msg.toToken = port.name;
+                const connection = new vAPI.MessagingConnection(
+                    listener,
+                    details.msg
+                );
+                connections.set(connection.id, connection);
+            } else {
+                details.msg.what = 'connectionRefused';
+            }
+            port.postMessage(details);
+            return true;
+        default:
+            break;
+        }
+    }
+};
+
+vAPI.messaging.extensions.push(vAPI.MessagingConnection);
+
+// <<<<<<<< end of private namespace
+})();
+
+/******************************************************************************/
+
+// Broadcast listening ability
+
+(( ) => {
+// >>>>>>>> start of private namespace
+
+if (
+    typeof vAPI !== 'object' ||
+    vAPI.messaging instanceof Object === false ||
+    vAPI.broadcastListener instanceof Object
+) {
+    return;
+}
+
+const listeners = new Set();
+
+vAPI.broadcastListener =  {
+    add: function(listener) {
+        listeners.add(listener);
+        vAPI.messaging.getPort();
+    },
+    remove: function(listener) {
+        listeners.delete(listener);
+    },
+    canDestroyPort() {
+        return listeners.size === 0;
+    },
+    mustDestroyPort() {
+        listeners.clear();
+    },
+    canProcessMessage(details) {
+        if ( details.broadcast === false ) { return; }
+        for ( const listener of listeners ) {
+             listener(details.msg);
+        }
+    },
+};
+
+vAPI.messaging.extensions.push(vAPI.broadcastListener);
+
+// <<<<<<<< end of private namespace
+})();
+
+/******************************************************************************/
+
+
+
+
+
+
+
+
+/*******************************************************************************
+
+    DO NOT:
+    - Remove the following code
+    - Add code beyond the following code
+    Reason:
+    - https://github.com/gorhill/uBlock/pull/3721
+    - uBO never uses the return value from injected content scripts
+
+**/
+
+void 0;

package/extensions/ublock/js/vapi-client.js

@@ -0,0 +1,280 @@
+/*******************************************************************************
+
+    uBlock Origin - a browser extension to block requests.
+    Copyright (C) 2014-2015 The uBlock Origin authors
+    Copyright (C) 2014-present Raymond Hill
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see {http://www.gnu.org/licenses/}.
+
+    Home: https://github.com/gorhill/uBlock
+*/
+
+// For non-background page
+
+'use strict';
+
+/******************************************************************************/
+
+// https://github.com/chrisaljoudi/uBlock/issues/456
+//   Skip if already injected.
+
+// >>>>>>>> start of HUGE-IF-BLOCK
+if (
+    typeof vAPI === 'object' &&
+    vAPI.randomToken instanceof Function === false
+) {
+
+/******************************************************************************/
+/******************************************************************************/
+
+vAPI.randomToken = function() {
+    const n = Math.random();
+    return String.fromCharCode(n * 25 + 97) +
+        Math.floor(
+            (0.25 + n * 0.75) * Number.MAX_SAFE_INTEGER
+        ).toString(36).slice(-8);
+};
+
+vAPI.sessionId = vAPI.randomToken();
+vAPI.setTimeout = vAPI.setTimeout || self.setTimeout.bind(self);
+
+/******************************************************************************/
+
+vAPI.shutdown = {
+    jobs: [],
+    add: function(job) {
+        this.jobs.push(job);
+    },
+    exec: function() {
+        // Shutdown asynchronously, to ensure shutdown jobs are called from
+        // the top context.
+        self.requestIdleCallback(( ) => {
+            const jobs = this.jobs.slice();
+            this.jobs.length = 0;
+            while ( jobs.length !== 0 ) {
+                (jobs.pop())();
+            }
+        });
+    },
+    remove: function(job) {
+        let pos;
+        while ( (pos = this.jobs.indexOf(job)) !== -1 ) {
+            this.jobs.splice(pos, 1);
+        }
+    }
+};
+
+/******************************************************************************/
+
+vAPI.messaging = {
+    port: null,
+    portTimer: null,
+    portTimerDelay: 10000,
+    extended: undefined,
+    extensions: [],
+    msgIdGenerator: 1,
+    pending: new Map(),
+    shuttingDown: false,
+
+    shutdown: function() {
+        this.shuttingDown = true;
+        this.destroyPort();
+    },
+
+    // https://github.com/uBlockOrigin/uBlock-issues/issues/403
+    //   Spurious disconnection can happen, so do not consider such events
+    //   as world-ending, i.e. stay around. Except for embedded frames.
+
+    disconnectListener: function() {
+        void browser.runtime.lastError;
+        this.port = null;
+        if ( window !== window.top ) {
+            vAPI.shutdown.exec();
+        } else {
+            this.destroyPort();
+        }
+    },
+    disconnectListenerBound: null,
+
+    // 2020-09-01:
+    //   In Firefox, `details instanceof Object` resolves to `false` despite
+    //   `details` being a valid object. Consequently, falling back to use
+    //   `typeof details`.
+    //   This is an issue which surfaced when the element picker code was
+    //   revisited to isolate the picker dialog DOM from the page DOM.
+    messageListener: function(details) {
+        if ( typeof details !== 'object' || details === null ) { return; }
+
+        // Response to specific message previously sent
+        if ( details.msgId !== undefined ) {
+            const resolver = this.pending.get(details.msgId);
+            if ( resolver !== undefined ) {
+                this.pending.delete(details.msgId);
+                resolver(details.msg);
+                return;
+            }
+        }
+
+        // Unhandled messages
+        this.extensions.every(ext => ext.canProcessMessage(details) !== true);
+    },
+    messageListenerBound: null,
+
+    canDestroyPort: function() {
+        return this.pending.size === 0 && (
+            this.extensions.length === 0 ||
+            this.extensions.every(e => e.canDestroyPort())
+        );
+    },
+
+    mustDestroyPort: function() {
+        if ( this.extensions.length === 0 ) { return; }
+        this.extensions.forEach(e => e.mustDestroyPort());
+        this.extensions.length = 0;
+    },
+
+    portPoller: function() {
+        this.portTimer = null;
+        if ( this.port !== null && this.canDestroyPort() ) {
+            return this.destroyPort();
+        }
+        this.portTimer = vAPI.setTimeout(this.portPollerBound, this.portTimerDelay);
+        this.portTimerDelay = Math.min(this.portTimerDelay * 2, 60 * 60 * 1000);
+    },
+    portPollerBound: null,
+
+    destroyPort: function() {
+        if ( this.portTimer !== null ) {
+            clearTimeout(this.portTimer);
+            this.portTimer = null;
+        }
+        const port = this.port;
+        if ( port !== null ) {
+            port.disconnect();
+            port.onMessage.removeListener(this.messageListenerBound);
+            port.onDisconnect.removeListener(this.disconnectListenerBound);
+            this.port = null;
+        }
+        this.mustDestroyPort();
+        // service pending callbacks
+        if ( this.pending.size !== 0 ) {
+            const pending = this.pending;
+            this.pending = new Map();
+            for ( const resolver of pending.values() ) {
+                resolver();
+            }
+        }
+    },
+
+    createPort: function() {
+        if ( this.shuttingDown ) { return null; }
+        if ( this.messageListenerBound === null ) {
+            this.messageListenerBound = this.messageListener.bind(this);
+            this.disconnectListenerBound = this.disconnectListener.bind(this);
+            this.portPollerBound = this.portPoller.bind(this);
+        }
+        try {
+            this.port = browser.runtime.connect({name: vAPI.sessionId}) || null;
+        } catch (ex) {
+            this.port = null;
+        }
+        // Not having a valid port at this point means the main process is
+        // not available: no point keeping the content scripts alive.
+        if ( this.port === null ) {
+            vAPI.shutdown.exec();
+            return null;
+        }
+        this.port.onMessage.addListener(this.messageListenerBound);
+        this.port.onDisconnect.addListener(this.disconnectListenerBound);
+        this.portTimerDelay = 10000;
+        if ( this.portTimer === null ) {
+            this.portTimer = vAPI.setTimeout(
+                this.portPollerBound,
+                this.portTimerDelay
+            );
+        }
+        return this.port;
+    },
+
+    getPort: function() {
+        return this.port !== null ? this.port : this.createPort();
+    },
+
+    send: function(channel, msg) {
+        // Too large a gap between the last request and the last response means
+        // the main process is no longer reachable: memory leaks and bad
+        // performance become a risk -- especially for long-lived, dynamic
+        // pages. Guard against this.
+        if ( this.pending.size > 50 ) {
+            vAPI.shutdown.exec();
+        }
+        const port = this.getPort();
+        if ( port === null ) {
+            return Promise.resolve();
+        }
+        const msgId = this.msgIdGenerator++;
+        const promise = new Promise(resolve => {
+            this.pending.set(msgId, resolve);
+        });
+        port.postMessage({ channel, msgId, msg });
+        return promise;
+    },
+
+    // Dynamically extend capabilities.
+    //
+    // https://github.com/uBlockOrigin/uBlock-issues/issues/1571
+    //   Don't use `self` to access `vAPI`.
+    extend: function() {
+        if ( this.extended === undefined ) {
+            this.extended = vAPI.messaging.send('vapi', {
+                what: 'extendClient'
+            }).then(( ) =>
+                typeof vAPI === 'object' && this.extensions.length !== 0
+            ).catch(( ) => {
+            });
+        }
+        return this.extended;
+    },
+};
+
+vAPI.shutdown.add(( ) => {
+    vAPI.messaging.shutdown();
+    window.vAPI = undefined;
+});
+
+/******************************************************************************/
+/******************************************************************************/
+
+}
+// <<<<<<<< end of HUGE-IF-BLOCK
+
+
+
+
+
+
+
+
+/*******************************************************************************
+
+    DO NOT:
+    - Remove the following code
+    - Add code beyond the following code
+    Reason:
+    - https://github.com/gorhill/uBlock/pull/3721
+    - uBO never uses the return value from injected content scripts
+
+**/
+
+void 0;