#1816 allow clipboard operations in remote Chromium browsers

asolntsev · asolntsev · commit a003f94112e6 · 2024-07-25T23:38:20.000+03:00
Theoretically, this solution should work for Chrome, but didn't work for me:
  driver.setPermission("clipboard-read", "granted");
  driver.setPermission("clipboard-write", "granted");
diff --git a/src/main/java/com/codeborne/selenide/DefaultClipboard.java b/src/main/java/com/codeborne/selenide/DefaultClipboard.java
@@ -1,5 +1,10 @@
 package com.codeborne.selenide;
 
+import org.openqa.selenium.chromium.ChromiumDriver;
+import org.openqa.selenium.devtools.DevTools;
+import org.openqa.selenium.devtools.HasDevTools;
+import org.openqa.selenium.devtools.v127.browser.Browser;
+
 import javax.annotation.CheckReturnValue;
 import javax.annotation.Nonnull;
 import javax.annotation.ParametersAreNonnullByDefault;
@@ -8,6 +13,14 @@
 import java.awt.datatransfer.StringSelection;
 import java.awt.datatransfer.UnsupportedFlavorException;
 import java.io.IOException;
+import java.util.List;
+import java.util.Optional;
+
+import static com.codeborne.selenide.impl.WebdriverUnwrapper.cast;
+import static com.codeborne.selenide.impl.WebdriverUnwrapper.instanceOf;
+import static java.util.Optional.empty;
+import static org.openqa.selenium.devtools.v127.browser.model.PermissionType.CLIPBOARDREADWRITE;
+import static org.openqa.selenium.devtools.v127.browser.model.PermissionType.CLIPBOARDSANITIZEDWRITE;
 
 @ParametersAreNonnullByDefault
 public class DefaultClipboard implements Clipboard {
@@ -31,12 +44,25 @@ public Clipboard object() {
     return this;
   }
 
+  private boolean grantPermission() {
+    Optional<HasDevTools> cdpBrowser = cast(driver, HasDevTools.class);
+    if (cdpBrowser.isPresent() && instanceOf(driver, ChromiumDriver.class)) {
+      DevTools devTools = cdpBrowser.get().getDevTools();
+      devTools.send(Browser.grantPermissions(List.of(CLIPBOARDREADWRITE, CLIPBOARDSANITIZEDWRITE), empty(), empty()));
+      return true;
+    }
+    return false;
+  }
+
   @CheckReturnValue
   @Nonnull
   @Override
   public String getText() {
-    assertRemoteState();
+    if (grantPermission()) {
+      return driver.executeJavaScript("return await navigator.clipboard.readText()");
+    }
     try {
+      assertLocalBrowser();
       return Toolkit.getDefaultToolkit().getSystemClipboard().getData(DataFlavor.stringFlavor).toString();
     }
     catch (UnsupportedFlavorException | IOException e) {
@@ -46,11 +72,16 @@ public String getText() {
 
   @Override
   public void setText(String text) {
-    assertRemoteState();
-    Toolkit.getDefaultToolkit().getSystemClipboard().setContents(new StringSelection(text), new StringSelection(text));
+    if (grantPermission()) {
+      driver.executeJavaScript("await navigator.clipboard.writeText(arguments[0])", text);
+    }
+    else {
+      assertLocalBrowser();
+      Toolkit.getDefaultToolkit().getSystemClipboard().setContents(new StringSelection(text), new StringSelection(text));
+    }
   }
 
-  private void assertRemoteState() {
+  private void assertLocalBrowser() {
     if (driver.config().remote() != null)
       throw new IllegalStateException("Remote driver url detected! Please use remote clipboard.");
   }
diff --git a/statics/src/test/java/integration/IntegrationTest.java b/statics/src/test/java/integration/IntegrationTest.java
@@ -36,6 +36,8 @@
 import static com.codeborne.selenide.TextCheck.FULL_TEXT;
 import static com.codeborne.selenide.WebDriverRunner.closeWebDriver;
 import static com.codeborne.selenide.WebDriverRunner.hasWebDriverStarted;
+import static com.codeborne.selenide.WebDriverRunner.isChrome;
+import static com.codeborne.selenide.WebDriverRunner.isEdge;
 import static com.codeborne.selenide.WebDriverRunner.isIE;
 import static org.assertj.core.api.Assumptions.assumeThat;
 import static org.openqa.selenium.remote.CapabilityType.ACCEPT_INSECURE_CERTS;
@@ -173,6 +175,11 @@ protected static FirefoxOptions firefoxOptions(@Nullable SelenideProxyServer pro
   }
 
   protected void assumeClipboardSupported() {
+    if (isChrome() || isEdge()) {
+      // in Chromium browsers, we grant permissions via DevTools and access clipboard via JS
+      return;
+    }
+
     assumeThat(headless).isFalse();
     assumeThat(GraphicsEnvironment.isHeadless()).isFalse();
     try {
