Skip to content

Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.

fix(bidi): do not break bundlers when chromium-bidi is not installed (#43193)

Yury Semikhatskybdd5cc154c39
diff --git a/packages/playwright-core/src/server/bidi/bidiOverCdp.ts b/packages/playwright-core/src/server/bidi/bidiOverCdp.ts
index 21095afc44..e664b937df 100644
--- a/packages/playwright-core/src/server/bidi/bidiOverCdp.ts
+++ b/packages/playwright-core/src/server/bidi/bidiOverCdp.ts
@@ -14,12 +14,11 @@
* limitations under the License.
*/
-import * as bidiMapper from 'chromium-bidi/lib/cjs/bidiMapper/BidiMapper';
-import * as bidiCdpConnection from 'chromium-bidi/lib/cjs/cdp/CdpConnection';
-
import { debugLogger } from '@utils/debugLogger';
import type { ConnectionTransport, ProtocolRequest, ProtocolResponse } from '../transport';
+import type * as bidiMapper from 'chromium-bidi/lib/cjs/bidiMapper/BidiMapper';
+import type * as bidiCdpConnection from 'chromium-bidi/lib/cjs/cdp/CdpConnection';
import type { ChromiumBidi } from 'chromium-bidi/lib/cjs/protocol/protocol';
import type * as bidiTransport from 'chromium-bidi/lib/cjs/utils/transport';
@@ -28,14 +27,24 @@ const bidiServerLogger = (prefix: string, ...args: unknown[]): void => {
};
export async function connectBidiOverCdp(cdp: ConnectionTransport): Promise<ConnectionTransport> {
+ // chromium-bidi is not in our dependencies. Bundlers do not fail on a
+ // missing module if its require() is inside a try block.
+ let bidiMapperModule: typeof bidiMapper;
+ let bidiCdpConnectionModule: typeof bidiCdpConnection;
+ try {
+ bidiMapperModule = require('chromium-bidi/lib/cjs/bidiMapper/BidiMapper');
+ bidiCdpConnectionModule = require('chromium-bidi/lib/cjs/cdp/CdpConnection');
+ } catch (error) {
+ throw error;
+ }
let server: bidiMapper.BidiServer | undefined = undefined;
const bidiTransport = new BidiTransportImpl();
const bidiConnection = new BidiConnection(bidiTransport, () => server?.close());
const cdpTransportImpl = new CdpTransportImpl(cdp);
- const cdpConnection = new bidiCdpConnection.MapperCdpConnection(cdpTransportImpl, bidiServerLogger);
+ const cdpConnection = new bidiCdpConnectionModule.MapperCdpConnection(cdpTransportImpl, bidiServerLogger);
// Make sure onclose event is propagated.
cdp.onclose = () => bidiConnection.onclose?.();
- server = await bidiMapper.BidiServer.createAndStart(
+ server = await bidiMapperModule.BidiServer.createAndStart(
bidiTransport,
cdpConnection,
await cdpConnection.createBrowserSession(),
diff --git a/tests/installation/bundle-with-esbuild.spec.ts b/tests/installation/bundle-with-esbuild.spec.ts
new file mode 100644
index 0000000000..54a7a6e6a8
--- /dev/null
+++ b/tests/installation/bundle-with-esbuild.spec.ts
@@ -0,0 +1,25 @@
+/**
+ * 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 { test } from './npmTest';
+
+test('playwright-core should bundle with esbuild', async ({ exec, writeFiles }) => {
+ test.info().annotations.push({ type: 'issue', description: 'https://github.com/microsoft/playwright/issues/43190' });
+ await exec('npm i playwright-core [email protected]');
+ await writeFiles({
+ 'main.js': `const { chromium } = require('playwright-core');\nconsole.log(typeof chromium.launch);\n`,
+ });
+ await exec('npx esbuild main.js --bundle --platform=node --outfile=out.js');
+});