Skip to content

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

docs: add warnings for Chrome remote debugging and user profile automation changes (#37052)

Max Schmitteba48996b67c
diff --git a/docs/src/api/class-browsertype.md b/docs/src/api/class-browsertype.md
index 55014ad9a4..1d658a5b5f 100644
--- a/docs/src/api/class-browsertype.md
+++ b/docs/src/api/class-browsertype.md
@@ -333,6 +333,10 @@ More details for
Note that browsers do not allow launching multiple instances with the same User Data Directory.
+:::warning
+Chromium/Chrome: Due to recent Chrome policy changes, automating the default Chrome user profile is not supported. Pointing `userDataDir` to Chrome's main "User Data" directory (the profile used for your regular browsing) may result in pages not loading or the browser exiting. Create and use a separate directory (for example, an empty folder) as your automation profile instead. See https://developer.chrome.com/blog/remote-debugging-port for details.
+:::
+
### option: BrowserType.launchPersistentContext.-inline- = %%-shared-browser-options-list-v1.8-%%
* since: v1.8
diff --git a/packages/playwright-client/types/types.d.ts b/packages/playwright-client/types/types.d.ts
index cc18a9ec89..9d759a2bc2 100644
--- a/packages/playwright-client/types/types.d.ts
+++ b/packages/playwright-client/types/types.d.ts
@@ -14761,6 +14761,13 @@ export interface BrowserType<Unused = {}> {
* **parent** directory of the "Profile Path" seen at `chrome://version`.
*
* Note that browsers do not allow launching multiple instances with the same User Data Directory.
+ *
+ * **NOTE** Chromium/Chrome: Due to recent Chrome policy changes, automating the default Chrome user profile is not
+ * supported. Pointing `userDataDir` to Chrome's main "User Data" directory (the profile used for your regular
+ * browsing) may result in pages not loading or the browser exiting. Create and use a separate directory (for example,
+ * an empty folder) as your automation profile instead. See https://developer.chrome.com/blog/remote-debugging-port
+ * for details.
+ *
* @param options
*/
launchPersistentContext(userDataDir: string, options?: {
diff --git a/packages/playwright-core/types/types.d.ts b/packages/playwright-core/types/types.d.ts
index cc18a9ec89..9d759a2bc2 100644
--- a/packages/playwright-core/types/types.d.ts
+++ b/packages/playwright-core/types/types.d.ts
@@ -14761,6 +14761,13 @@ export interface BrowserType<Unused = {}> {
* **parent** directory of the "Profile Path" seen at `chrome://version`.
*
* Note that browsers do not allow launching multiple instances with the same User Data Directory.
+ *
+ * **NOTE** Chromium/Chrome: Due to recent Chrome policy changes, automating the default Chrome user profile is not
+ * supported. Pointing `userDataDir` to Chrome's main "User Data" directory (the profile used for your regular
+ * browsing) may result in pages not loading or the browser exiting. Create and use a separate directory (for example,
+ * an empty folder) as your automation profile instead. See https://developer.chrome.com/blog/remote-debugging-port
+ * for details.
+ *
* @param options
*/
launchPersistentContext(userDataDir: string, options?: {