@szymonrybczak/playwright-mcp 0.0.2 → 0.0.4

package/lib/context.js

@@ -1,291 +0,0 @@
-/**
- * Copyright (c) Microsoft Corporation.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import debug from 'debug';
-import { callOnPageNoTrace, waitForCompletion } from './tools/utils.js';
-import { ManualPromise } from './manualPromise.js';
-import { Tab } from './tab.js';
-import { outputFile } from './config.js';
-const testDebug = debug('pw:mcp:test');
-export class Context {
-    tools;
-    config;
-    _browserContextPromise;
-    _browserContextFactory;
-    _tabs = [];
-    _currentTab;
-    _modalStates = [];
-    _pendingAction;
-    _downloads = [];
-    clientVersion;
-    constructor(tools, config, browserContextFactory) {
-        this.tools = tools;
-        this.config = config;
-        this._browserContextFactory = browserContextFactory;
-        testDebug('create context');
-    }
-    clientSupportsImages() {
-        if (this.config.imageResponses === 'allow')
-            return true;
-        if (this.config.imageResponses === 'omit')
-            return false;
-        return !this.clientVersion?.name.includes('cursor');
-    }
-    modalStates() {
-        return this._modalStates;
-    }
-    setModalState(modalState, inTab) {
-        this._modalStates.push({ ...modalState, tab: inTab });
-    }
-    clearModalState(modalState) {
-        this._modalStates = this._modalStates.filter(state => state !== modalState);
-    }
-    modalStatesMarkdown() {
-        const result = ['### Modal state'];
-        if (this._modalStates.length === 0)
-            result.push('- There is no modal state present');
-        for (const state of this._modalStates) {
-            const tool = this.tools.find(tool => tool.clearsModalState === state.type);
-            result.push(`- [${state.description}]: can be handled by the "${tool?.schema.name}" tool`);
-        }
-        return result;
-    }
-    tabs() {
-        return this._tabs;
-    }
-    currentTabOrDie() {
-        if (!this._currentTab)
-            throw new Error('No current snapshot available. Capture a snapshot or navigate to a new location first.');
-        return this._currentTab;
-    }
-    async newTab() {
-        const { browserContext } = await this._ensureBrowserContext();
-        const page = await browserContext.newPage();
-        this._currentTab = this._tabs.find(t => t.page === page);
-        return this._currentTab;
-    }
-    async selectTab(index) {
-        this._currentTab = this._tabs[index - 1];
-        await this._currentTab.page.bringToFront();
-    }
-    async ensureTab() {
-        const { browserContext } = await this._ensureBrowserContext();
-        if (!this._currentTab)
-            await browserContext.newPage();
-        return this._currentTab;
-    }
-    async listTabsMarkdown() {
-        if (!this._tabs.length)
-            return '### No tabs open';
-        const lines = ['### Open tabs'];
-        for (let i = 0; i < this._tabs.length; i++) {
-            const tab = this._tabs[i];
-            const title = await tab.title();
-            const url = tab.page.url();
-            const current = tab === this._currentTab ? ' (current)' : '';
-            lines.push(`- ${i + 1}:${current} [${title}] (${url})`);
-        }
-        return lines.join('\n');
-    }
-    async closeTab(index) {
-        const tab = index === undefined ? this._currentTab : this._tabs[index - 1];
-        await tab?.page.close();
-        return await this.listTabsMarkdown();
-    }
-    async run(tool, params) {
-        // Tab management is done outside of the action() call.
-        const toolResult = await tool.handle(this, tool.schema.inputSchema.parse(params || {}));
-        const { code, action, waitForNetwork, captureSnapshot, resultOverride } = toolResult;
-        const racingAction = action ? () => this._raceAgainstModalDialogs(action) : undefined;
-        if (resultOverride)
-            return resultOverride;
-        if (!this._currentTab) {
-            return {
-                content: [{
-                        type: 'text',
-                        text: 'No open pages available. Use the "browser_navigate" tool to navigate to a page first.',
-                    }],
-            };
-        }
-        const tab = this.currentTabOrDie();
-        // TODO: race against modal dialogs to resolve clicks.
-        let actionResult;
-        try {
-            if (waitForNetwork)
-                actionResult = await waitForCompletion(this, tab, async () => racingAction?.()) ?? undefined;
-            else
-                actionResult = await racingAction?.() ?? undefined;
-        }
-        finally {
-            if (captureSnapshot && !this._javaScriptBlocked())
-                await tab.captureSnapshot();
-        }
-        const result = [];
-        result.push(`- Ran Playwright code:
-\`\`\`js
-${code.join('\n')}
-\`\`\`
-`);
-        if (this.modalStates().length) {
-            result.push(...this.modalStatesMarkdown());
-            return {
-                content: [{
-                        type: 'text',
-                        text: result.join('\n'),
-                    }],
-            };
-        }
-        if (this._downloads.length) {
-            result.push('', '### Downloads');
-            for (const entry of this._downloads) {
-                if (entry.finished)
-                    result.push(`- Downloaded file ${entry.download.suggestedFilename()} to ${entry.outputFile}`);
-                else
-                    result.push(`- Downloading file ${entry.download.suggestedFilename()} ...`);
-            }
-            result.push('');
-        }
-        if (this.tabs().length > 1)
-            result.push(await this.listTabsMarkdown(), '');
-        if (this.tabs().length > 1)
-            result.push('### Current tab');
-        result.push(`- Page URL: ${tab.page.url()}`, `- Page Title: ${await tab.title()}`);
-        if (captureSnapshot && tab.hasSnapshot())
-            result.push(tab.snapshotOrDie().text());
-        const content = actionResult?.content ?? [];
-        return {
-            content: [
-                ...content,
-                {
-                    type: 'text',
-                    text: result.join('\n'),
-                }
-            ],
-        };
-    }
-    async waitForTimeout(time) {
-        if (!this._currentTab || this._javaScriptBlocked()) {
-            await new Promise(f => setTimeout(f, time));
-            return;
-        }
-        await callOnPageNoTrace(this._currentTab.page, page => {
-            return page.evaluate(() => new Promise(f => setTimeout(f, 1000)));
-        });
-    }
-    async _raceAgainstModalDialogs(action) {
-        this._pendingAction = {
-            dialogShown: new ManualPromise(),
-        };
-        let result;
-        try {
-            await Promise.race([
-                action().then(r => result = r),
-                this._pendingAction.dialogShown,
-            ]);
-        }
-        finally {
-            this._pendingAction = undefined;
-        }
-        return result;
-    }
-    _javaScriptBlocked() {
-        return this._modalStates.some(state => state.type === 'dialog');
-    }
-    dialogShown(tab, dialog) {
-        this.setModalState({
-            type: 'dialog',
-            description: `"${dialog.type()}" dialog with message "${dialog.message()}"`,
-            dialog,
-        }, tab);
-        this._pendingAction?.dialogShown.resolve();
-    }
-    async downloadStarted(tab, download) {
-        const entry = {
-            download,
-            finished: false,
-            outputFile: await outputFile(this.config, download.suggestedFilename())
-        };
-        this._downloads.push(entry);
-        await download.saveAs(entry.outputFile);
-        entry.finished = true;
-    }
-    _onPageCreated(page) {
-        const tab = new Tab(this, page, tab => this._onPageClosed(tab));
-        this._tabs.push(tab);
-        if (!this._currentTab)
-            this._currentTab = tab;
-    }
-    _onPageClosed(tab) {
-        this._modalStates = this._modalStates.filter(state => state.tab !== tab);
-        const index = this._tabs.indexOf(tab);
-        if (index === -1)
-            return;
-        this._tabs.splice(index, 1);
-        if (this._currentTab === tab)
-            this._currentTab = this._tabs[Math.min(index, this._tabs.length - 1)];
-        if (!this._tabs.length)
-            void this.close();
-    }
-    async close() {
-        if (!this._browserContextPromise)
-            return;
-        testDebug('close context');
-        const promise = this._browserContextPromise;
-        this._browserContextPromise = undefined;
-        await promise.then(async ({ browserContext, close }) => {
-            if (this.config.saveTrace)
-                await browserContext.tracing.stop();
-            await close();
-        });
-    }
-    async _setupRequestInterception(context) {
-        if (this.config.network?.allowedOrigins?.length) {
-            await context.route('**', route => route.abort('blockedbyclient'));
-            for (const origin of this.config.network.allowedOrigins)
-                await context.route(`*://${origin}/**`, route => route.continue());
-        }
-        if (this.config.network?.blockedOrigins?.length) {
-            for (const origin of this.config.network.blockedOrigins)
-                await context.route(`*://${origin}/**`, route => route.abort('blockedbyclient'));
-        }
-    }
-    _ensureBrowserContext() {
-        if (!this._browserContextPromise) {
-            this._browserContextPromise = this._setupBrowserContext();
-            this._browserContextPromise.catch(() => {
-                this._browserContextPromise = undefined;
-            });
-        }
-        return this._browserContextPromise;
-    }
-    async _setupBrowserContext() {
-        // TODO: move to the browser context factory to make it based on isolation mode.
-        const result = await this._browserContextFactory.createContext();
-        const { browserContext } = result;
-        await this._setupRequestInterception(browserContext);
-        for (const page of browserContext.pages())
-            this._onPageCreated(page);
-        browserContext.on('page', page => this._onPageCreated(page));
-        if (this.config.saveTrace) {
-            await browserContext.tracing.start({
-                name: 'trace',
-                screenshots: false,
-                snapshots: true,
-                sources: false,
-            });
-        }
-        return result;
-    }
-}

package/lib/fileUtils.js

@@ -1,32 +0,0 @@
-/**
- * Copyright (c) Microsoft Corporation.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import os from 'node:os';
-import path from 'node:path';
-export function cacheDir() {
-    let cacheDirectory;
-    if (process.platform === 'linux')
-        cacheDirectory = process.env.XDG_CACHE_HOME || path.join(os.homedir(), '.cache');
-    else if (process.platform === 'darwin')
-        cacheDirectory = path.join(os.homedir(), 'Library', 'Caches');
-    else if (process.platform === 'win32')
-        cacheDirectory = process.env.LOCALAPPDATA || path.join(os.homedir(), 'AppData', 'Local');
-    else
-        throw new Error('Unsupported platform: ' + process.platform);
-    return path.join(cacheDirectory, 'ms-playwright');
-}
-export async function userDataDir(browserConfig) {
-    return path.join(cacheDir(), 'ms-playwright', `mcp-${browserConfig.launchOptions?.channel ?? browserConfig?.browserName}-profile`);
-}

package/lib/httpServer.js

@@ -1,201 +0,0 @@
-/**
- * Copyright (c) Microsoft Corporation.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import fs from 'fs';
-import path from 'path';
-import http from 'http';
-import mime from 'mime';
-import { ManualPromise } from './manualPromise.js';
-export class HttpServer {
-    _server;
-    _urlPrefixPrecise = '';
-    _urlPrefixHumanReadable = '';
-    _port = 0;
-    _routes = [];
-    constructor() {
-        this._server = http.createServer(this._onRequest.bind(this));
-        decorateServer(this._server);
-    }
-    server() {
-        return this._server;
-    }
-    routePrefix(prefix, handler) {
-        this._routes.push({ prefix, handler });
-    }
-    routePath(path, handler) {
-        this._routes.push({ exact: path, handler });
-    }
-    port() {
-        return this._port;
-    }
-    async _tryStart(port, host) {
-        const errorPromise = new ManualPromise();
-        const errorListener = (error) => errorPromise.reject(error);
-        this._server.on('error', errorListener);
-        try {
-            this._server.listen(port, host);
-            await Promise.race([
-                new Promise(cb => this._server.once('listening', cb)),
-                errorPromise,
-            ]);
-        }
-        finally {
-            this._server.removeListener('error', errorListener);
-        }
-    }
-    async start(options = {}) {
-        const host = options.host || 'localhost';
-        if (options.preferredPort) {
-            try {
-                await this._tryStart(options.preferredPort, host);
-            }
-            catch (e) {
-                if (!e || !e.message || !e.message.includes('EADDRINUSE'))
-                    throw e;
-                await this._tryStart(undefined, host);
-            }
-        }
-        else {
-            await this._tryStart(options.port, host);
-        }
-        const address = this._server.address();
-        if (typeof address === 'string') {
-            this._urlPrefixPrecise = address;
-            this._urlPrefixHumanReadable = address;
-        }
-        else {
-            this._port = address.port;
-            const resolvedHost = address.family === 'IPv4' ? address.address : `[${address.address}]`;
-            this._urlPrefixPrecise = `http://${resolvedHost}:${address.port}`;
-            this._urlPrefixHumanReadable = `http://${host}:${address.port}`;
-        }
-    }
-    async stop() {
-        await new Promise(cb => this._server.close(cb));
-    }
-    urlPrefix(purpose) {
-        return purpose === 'human-readable' ? this._urlPrefixHumanReadable : this._urlPrefixPrecise;
-    }
-    serveFile(request, response, absoluteFilePath, headers) {
-        try {
-            for (const [name, value] of Object.entries(headers || {}))
-                response.setHeader(name, value);
-            if (request.headers.range)
-                this._serveRangeFile(request, response, absoluteFilePath);
-            else
-                this._serveFile(response, absoluteFilePath);
-            return true;
-        }
-        catch (e) {
-            return false;
-        }
-    }
-    _serveFile(response, absoluteFilePath) {
-        const content = fs.readFileSync(absoluteFilePath);
-        response.statusCode = 200;
-        const contentType = mime.getType(path.extname(absoluteFilePath)) || 'application/octet-stream';
-        response.setHeader('Content-Type', contentType);
-        response.setHeader('Content-Length', content.byteLength);
-        response.end(content);
-    }
-    _serveRangeFile(request, response, absoluteFilePath) {
-        const range = request.headers.range;
-        if (!range || !range.startsWith('bytes=') || range.includes(', ') || [...range].filter(char => char === '-').length !== 1) {
-            response.statusCode = 400;
-            return response.end('Bad request');
-        }
-        // Parse the range header: https://datatracker.ietf.org/doc/html/rfc7233#section-2.1
-        const [startStr, endStr] = range.replace(/bytes=/, '').split('-');
-        // Both start and end (when passing to fs.createReadStream) and the range header are inclusive and start counting at 0.
-        let start;
-        let end;
-        const size = fs.statSync(absoluteFilePath).size;
-        if (startStr !== '' && endStr === '') {
-            // No end specified: use the whole file
-            start = +startStr;
-            end = size - 1;
-        }
-        else if (startStr === '' && endStr !== '') {
-            // No start specified: calculate start manually
-            start = size - +endStr;
-            end = size - 1;
-        }
-        else {
-            start = +startStr;
-            end = +endStr;
-        }
-        // Handle unavailable range request
-        if (Number.isNaN(start) || Number.isNaN(end) || start >= size || end >= size || start > end) {
-            // Return the 416 Range Not Satisfiable: https://datatracker.ietf.org/doc/html/rfc7233#section-4.4
-            response.writeHead(416, {
-                'Content-Range': `bytes */${size}`
-            });
-            return response.end();
-        }
-        // Sending Partial Content: https://datatracker.ietf.org/doc/html/rfc7233#section-4.1
-        response.writeHead(206, {
-            'Content-Range': `bytes ${start}-${end}/${size}`,
-            'Accept-Ranges': 'bytes',
-            'Content-Length': end - start + 1,
-            'Content-Type': mime.getType(path.extname(absoluteFilePath)),
-        });
-        const readable = fs.createReadStream(absoluteFilePath, { start, end });
-        readable.pipe(response);
-    }
-    _onRequest(request, response) {
-        if (request.method === 'OPTIONS') {
-            response.writeHead(200);
-            response.end();
-            return;
-        }
-        request.on('error', () => response.end());
-        try {
-            if (!request.url) {
-                response.end();
-                return;
-            }
-            const url = new URL('http://localhost' + request.url);
-            for (const route of this._routes) {
-                if (route.exact && url.pathname === route.exact) {
-                    route.handler(request, response);
-                    return;
-                }
-                if (route.prefix && url.pathname.startsWith(route.prefix)) {
-                    route.handler(request, response);
-                    return;
-                }
-            }
-            response.statusCode = 404;
-            response.end();
-        }
-        catch (e) {
-            response.end();
-        }
-    }
-}
-function decorateServer(server) {
-    const sockets = new Set();
-    server.on('connection', socket => {
-        sockets.add(socket);
-        socket.once('close', () => sockets.delete(socket));
-    });
-    const close = server.close;
-    server.close = (callback) => {
-        for (const socket of sockets)
-            socket.destroy();
-        sockets.clear();
-        return close.call(server, callback);
-    };
-}

package/lib/index.js

@@ -1,36 +0,0 @@
-/**
- * Copyright (c) Microsoft Corporation.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import { createConnection as createConnectionImpl } from './connection.js';
-import { resolveConfig } from './config.js';
-import { contextFactory } from './browserContextFactory.js';
-export async function createConnection(userConfig = {}, contextGetter) {
-    const config = await resolveConfig(userConfig);
-    const factory = contextGetter ? new SimpleBrowserContextFactory(contextGetter) : contextFactory(config.browser);
-    return createConnectionImpl(config, factory);
-}
-class SimpleBrowserContextFactory {
-    _contextGetter;
-    constructor(contextGetter) {
-        this._contextGetter = contextGetter;
-    }
-    async createContext() {
-        const browserContext = await this._contextGetter();
-        return {
-            browserContext,
-            close: () => browserContext.close()
-        };
-    }
-}

package/lib/javascript.js

@@ -1,49 +0,0 @@
-/**
- * Copyright (c) Microsoft Corporation.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-// adapted from:
-// - https://github.com/microsoft/playwright/blob/76ee48dc9d4034536e3ec5b2c7ce8be3b79418a8/packages/playwright-core/src/utils/isomorphic/stringUtils.ts
-// - https://github.com/microsoft/playwright/blob/76ee48dc9d4034536e3ec5b2c7ce8be3b79418a8/packages/playwright-core/src/server/codegen/javascript.ts
-// NOTE: this function should not be used to escape any selectors.
-export function escapeWithQuotes(text, char = '\'') {
-    const stringified = JSON.stringify(text);
-    const escapedText = stringified.substring(1, stringified.length - 1).replace(/\\"/g, '"');
-    if (char === '\'')
-        return char + escapedText.replace(/[']/g, '\\\'') + char;
-    if (char === '"')
-        return char + escapedText.replace(/["]/g, '\\"') + char;
-    if (char === '`')
-        return char + escapedText.replace(/[`]/g, '`') + char;
-    throw new Error('Invalid escape char');
-}
-export function quote(text) {
-    return escapeWithQuotes(text, '\'');
-}
-export function formatObject(value, indent = '  ') {
-    if (typeof value === 'string')
-        return quote(value);
-    if (Array.isArray(value))
-        return `[${value.map(o => formatObject(o)).join(', ')}]`;
-    if (typeof value === 'object') {
-        const keys = Object.keys(value).filter(key => value[key] !== undefined).sort();
-        if (!keys.length)
-            return '{}';
-        const tokens = [];
-        for (const key of keys)
-            tokens.push(`${key}: ${formatObject(value[key])}`);
-        return `{\n${indent}${tokens.join(`,\n${indent}`)}\n}`;
-    }
-    return String(value);
-}