puppeteer-core
Version:
A high-level API to control headless Chrome over the DevTools Protocol
209 lines • 10.9 kB
JavaScript
"use strict";
/**
* @license
* Copyright 2024 Google Inc.
* SPDX-License-Identifier: Apache-2.0
*/
var __runInitializers = (this && this.__runInitializers) || function (thisArg, initializers, value) {
var useValue = arguments.length > 2;
for (var i = 0; i < initializers.length; i++) {
value = useValue ? initializers[i].call(thisArg, value) : initializers[i].call(thisArg);
}
return useValue ? value : void 0;
};
var __esDecorate = (this && this.__esDecorate) || function (ctor, descriptorIn, decorators, contextIn, initializers, extraInitializers) {
function accept(f) { if (f !== void 0 && typeof f !== "function") throw new TypeError("Function expected"); return f; }
var kind = contextIn.kind, key = kind === "getter" ? "get" : kind === "setter" ? "set" : "value";
var target = !descriptorIn && ctor ? contextIn["static"] ? ctor : ctor.prototype : null;
var descriptor = descriptorIn || (target ? Object.getOwnPropertyDescriptor(target, contextIn.name) : {});
var _, done = false;
for (var i = decorators.length - 1; i >= 0; i--) {
var context = {};
for (var p in contextIn) context[p] = p === "access" ? {} : contextIn[p];
for (var p in contextIn.access) context.access[p] = contextIn.access[p];
context.addInitializer = function (f) { if (done) throw new TypeError("Cannot add initializers after decoration has completed"); extraInitializers.push(accept(f || null)); };
var result = (0, decorators[i])(kind === "accessor" ? { get: descriptor.get, set: descriptor.set } : descriptor[key], context);
if (kind === "accessor") {
if (result === void 0) continue;
if (result === null || typeof result !== "object") throw new TypeError("Object expected");
if (_ = accept(result.get)) descriptor.get = _;
if (_ = accept(result.set)) descriptor.set = _;
if (_ = accept(result.init)) initializers.unshift(_);
}
else if (_ = accept(result)) {
if (kind === "field") initializers.unshift(_);
else descriptor[key] = _;
}
}
if (target) Object.defineProperty(target, contextIn.name, descriptor);
done = true;
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.UserContext = void 0;
const EventEmitter_js_1 = require("../../common/EventEmitter.js");
const assert_js_1 = require("../../util/assert.js");
const decorators_js_1 = require("../../util/decorators.js");
const disposable_js_1 = require("../../util/disposable.js");
const BrowsingContext_js_1 = require("./BrowsingContext.js");
/**
* @internal
*/
let UserContext = (() => {
let _classSuper = EventEmitter_js_1.EventEmitter;
let _instanceExtraInitializers = [];
let _dispose_decorators;
let _createBrowsingContext_decorators;
let _remove_decorators;
let _getCookies_decorators;
let _setCookie_decorators;
let _setPermissions_decorators;
return class UserContext extends _classSuper {
static {
const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(_classSuper[Symbol.metadata] ?? null) : void 0;
__esDecorate(this, null, _dispose_decorators, { kind: "method", name: "dispose", static: false, private: false, access: { has: obj => "dispose" in obj, get: obj => obj.dispose }, metadata: _metadata }, null, _instanceExtraInitializers);
__esDecorate(this, null, _createBrowsingContext_decorators, { kind: "method", name: "createBrowsingContext", static: false, private: false, access: { has: obj => "createBrowsingContext" in obj, get: obj => obj.createBrowsingContext }, metadata: _metadata }, null, _instanceExtraInitializers);
__esDecorate(this, null, _remove_decorators, { kind: "method", name: "remove", static: false, private: false, access: { has: obj => "remove" in obj, get: obj => obj.remove }, metadata: _metadata }, null, _instanceExtraInitializers);
__esDecorate(this, null, _getCookies_decorators, { kind: "method", name: "getCookies", static: false, private: false, access: { has: obj => "getCookies" in obj, get: obj => obj.getCookies }, metadata: _metadata }, null, _instanceExtraInitializers);
__esDecorate(this, null, _setCookie_decorators, { kind: "method", name: "setCookie", static: false, private: false, access: { has: obj => "setCookie" in obj, get: obj => obj.setCookie }, metadata: _metadata }, null, _instanceExtraInitializers);
__esDecorate(this, null, _setPermissions_decorators, { kind: "method", name: "setPermissions", static: false, private: false, access: { has: obj => "setPermissions" in obj, get: obj => obj.setPermissions }, metadata: _metadata }, null, _instanceExtraInitializers);
if (_metadata) Object.defineProperty(this, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
}
static DEFAULT = 'default';
static create(browser, id) {
const context = new UserContext(browser, id);
context.#initialize();
return context;
}
#reason = __runInitializers(this, _instanceExtraInitializers);
// Note these are only top-level contexts.
#browsingContexts = new Map();
#disposables = new disposable_js_1.DisposableStack();
#id;
browser;
constructor(browser, id) {
super();
this.#id = id;
this.browser = browser;
}
#initialize() {
const browserEmitter = this.#disposables.use(new EventEmitter_js_1.EventEmitter(this.browser));
browserEmitter.once('closed', ({ reason }) => {
this.dispose(`User context was closed: ${reason}`);
});
browserEmitter.once('disconnected', ({ reason }) => {
this.dispose(`User context was closed: ${reason}`);
});
const sessionEmitter = this.#disposables.use(new EventEmitter_js_1.EventEmitter(this.#session));
sessionEmitter.on('browsingContext.contextCreated', info => {
if (info.parent) {
return;
}
if (info.userContext !== this.#id) {
return;
}
const browsingContext = BrowsingContext_js_1.BrowsingContext.from(this, undefined, info.context, info.url, info.originalOpener);
this.#browsingContexts.set(browsingContext.id, browsingContext);
const browsingContextEmitter = this.#disposables.use(new EventEmitter_js_1.EventEmitter(browsingContext));
browsingContextEmitter.on('closed', () => {
browsingContextEmitter.removeAllListeners();
this.#browsingContexts.delete(browsingContext.id);
});
this.emit('browsingcontext', { browsingContext });
});
}
get #session() {
return this.browser.session;
}
get browsingContexts() {
return this.#browsingContexts.values();
}
get closed() {
return this.#reason !== undefined;
}
get disposed() {
return this.closed;
}
get id() {
return this.#id;
}
dispose(reason) {
this.#reason = reason;
this[disposable_js_1.disposeSymbol]();
}
async createBrowsingContext(type, options = {}) {
const { result: { context: contextId }, } = await this.#session.send('browsingContext.create', {
type,
...options,
referenceContext: options.referenceContext?.id,
userContext: this.#id,
});
const browsingContext = this.#browsingContexts.get(contextId);
(0, assert_js_1.assert)(browsingContext, 'The WebDriver BiDi implementation is failing to create a browsing context correctly.');
// We use an array to avoid the promise from being awaited.
return browsingContext;
}
async remove() {
try {
await this.#session.send('browser.removeUserContext', {
userContext: this.#id,
});
}
finally {
this.dispose('User context already closed.');
}
}
async getCookies(options = {}, sourceOrigin = undefined) {
const { result: { cookies }, } = await this.#session.send('storage.getCookies', {
...options,
partition: {
type: 'storageKey',
userContext: this.#id,
sourceOrigin,
},
});
return cookies;
}
async setCookie(cookie, sourceOrigin) {
await this.#session.send('storage.setCookie', {
cookie,
partition: {
type: 'storageKey',
sourceOrigin,
userContext: this.id,
},
});
}
async setPermissions(origin, descriptor, state) {
await this.#session.send('permissions.setPermission', {
origin,
descriptor,
state,
userContext: this.#id,
});
}
[(_dispose_decorators = [decorators_js_1.inertIfDisposed], _createBrowsingContext_decorators = [(0, decorators_js_1.throwIfDisposed)(context => {
// SAFETY: Disposal implies this exists.
return context.#reason;
})], _remove_decorators = [(0, decorators_js_1.throwIfDisposed)(context => {
// SAFETY: Disposal implies this exists.
return context.#reason;
})], _getCookies_decorators = [(0, decorators_js_1.throwIfDisposed)(context => {
// SAFETY: Disposal implies this exists.
return context.#reason;
})], _setCookie_decorators = [(0, decorators_js_1.throwIfDisposed)(context => {
// SAFETY: Disposal implies this exists.
return context.#reason;
})], _setPermissions_decorators = [(0, decorators_js_1.throwIfDisposed)(context => {
// SAFETY: Disposal implies this exists.
return context.#reason;
})], disposable_js_1.disposeSymbol)]() {
this.#reason ??=
'User context already closed, probably because the browser disconnected/closed.';
this.emit('closed', { reason: this.#reason });
this.#disposables.dispose();
super[disposable_js_1.disposeSymbol]();
}
};
})();
exports.UserContext = UserContext;
//# sourceMappingURL=UserContext.js.map