Skip to content

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

chore: do not use electron sandbox on linux by default (#38997)

Pavel Feldman67c285700b8e
diff --git a/docs/src/api/class-electron.md b/docs/src/api/class-electron.md
index d9d32f2c08..90c41de84e 100644
--- a/docs/src/api/class-electron.md
+++ b/docs/src/api/class-electron.md
@@ -139,3 +139,6 @@ Maximum time in milliseconds to wait for the application to start. Defaults to `
### option: Electron.launch.tracesDir = %%-browser-option-tracesdir-%%
* since: v1.36
+
+### option: Electron.launch.chromiumSandbox = %%-browser-option-chromiumsandbox-%%
+* since: v1.59
diff --git a/packages/playwright-client/types/types.d.ts b/packages/playwright-client/types/types.d.ts
index 32c41bb2fa..f174c4344d 100644
--- a/packages/playwright-client/types/types.d.ts
+++ b/packages/playwright-client/types/types.d.ts
@@ -19634,6 +19634,11 @@ export interface Electron {
*/
bypassCSP?: boolean;
+ /**
+ * Enable Chromium sandboxing. Defaults to `false`.
+ */
+ chromiumSandbox?: boolean;
+
/**
* Emulates [prefers-colors-scheme](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme)
* media feature, supported values are `'light'` and `'dark'`. See
diff --git a/packages/playwright-core/src/protocol/validator.ts b/packages/playwright-core/src/protocol/validator.ts
index 11fbca82e9..ea14d13902 100644
--- a/packages/playwright-core/src/protocol/validator.ts
+++ b/packages/playwright-core/src/protocol/validator.ts
@@ -2545,6 +2545,7 @@ scheme.ElectronInitializer = tOptional(tObject({}));
scheme.ElectronLaunchParams = tObject({
executablePath: tOptional(tString),
args: tOptional(tArray(tString)),
+ chromiumSandbox: tOptional(tBoolean),
cwd: tOptional(tString),
env: tOptional(tArray(tType('NameValue'))),
timeout: tFloat,
diff --git a/packages/playwright-core/src/server/electron/electron.ts b/packages/playwright-core/src/server/electron/electron.ts
index c84076b624..98ab309f28 100644
--- a/packages/playwright-core/src/server/electron/electron.ts
+++ b/packages/playwright-core/src/server/electron/electron.ts
@@ -160,8 +160,7 @@ export class Electron extends SdkObject {
let electronArguments = ['--inspect=0', '--remote-debugging-port=0', ...(options.args || [])];
if (os.platform() === 'linux') {
- const runningAsRoot = process.geteuid && process.geteuid() === 0;
- if (runningAsRoot && electronArguments.indexOf('--no-sandbox') === -1)
+ if (!options.chromiumSandbox && electronArguments.indexOf('--no-sandbox') === -1)
electronArguments.unshift('--no-sandbox');
}
diff --git a/packages/playwright-core/types/types.d.ts b/packages/playwright-core/types/types.d.ts
index 32c41bb2fa..f174c4344d 100644
--- a/packages/playwright-core/types/types.d.ts
+++ b/packages/playwright-core/types/types.d.ts
@@ -19634,6 +19634,11 @@ export interface Electron {
*/
bypassCSP?: boolean;
+ /**
+ * Enable Chromium sandboxing. Defaults to `false`.
+ */
+ chromiumSandbox?: boolean;
+
/**
* Emulates [prefers-colors-scheme](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme)
* media feature, supported values are `'light'` and `'dark'`. See
diff --git a/packages/protocol/src/channels.d.ts b/packages/protocol/src/channels.d.ts
index 2c9eb3345f..9944fb2aa9 100644
--- a/packages/protocol/src/channels.d.ts
+++ b/packages/protocol/src/channels.d.ts
@@ -4461,6 +4461,7 @@ export interface ElectronChannel extends ElectronEventTarget, Channel {
export type ElectronLaunchParams = {
executablePath?: string,
args?: string[],
+ chromiumSandbox?: boolean,
cwd?: string,
env?: NameValue[],
timeout: number,
@@ -4497,6 +4498,7 @@ export type ElectronLaunchParams = {
export type ElectronLaunchOptions = {
executablePath?: string,
args?: string[],
+ chromiumSandbox?: boolean,
cwd?: string,
env?: NameValue[],
acceptDownloads?: 'accept' | 'deny' | 'internal-browser-default',
diff --git a/packages/protocol/src/protocol.yml b/packages/protocol/src/protocol.yml
index cc1a23646a..4b19f911c9 100644
--- a/packages/protocol/src/protocol.yml
+++ b/packages/protocol/src/protocol.yml
@@ -3899,6 +3899,7 @@ Electron:
args:
type: array?
items: string
+ chromiumSandbox: boolean?
cwd: string?
env:
type: array?