[grid] Add BiDi enable flag. Add "se:bidi" from local node.

Author: pujagani

java/src/org/openqa/selenium/grid/node/config/NodeFlags.java

@@ -34,6 +34,7 @@
 import static org.openqa.selenium.grid.config.StandardGridRoles.NODE_ROLE;
 import static org.openqa.selenium.grid.node.config.NodeOptions.DEFAULT_DETECT_DRIVERS;
 import static org.openqa.selenium.grid.node.config.NodeOptions.DEFAULT_DRAIN_AFTER_SESSION_COUNT;
+import static org.openqa.selenium.grid.node.config.NodeOptions.DEFAULT_ENABLE_BIDI;
 import static org.openqa.selenium.grid.node.config.NodeOptions.DEFAULT_ENABLE_CDP;
 import static org.openqa.selenium.grid.node.config.NodeOptions.DEFAULT_HEARTBEAT_PERIOD;
 import static org.openqa.selenium.grid.node.config.NodeOptions.DEFAULT_MAX_SESSIONS;
@@ -204,6 +205,14 @@ public class NodeFlags implements HasRoles {
   @ConfigValue(section = NODE_SECTION, name = "enable-cdp", example = "true")
   public Boolean enableCdp = DEFAULT_ENABLE_CDP;
 
+  @Parameter(
+    names = {"--enable-bidi"},
+    arity = 1,
+    description = "Enable BiDi proxying in Grid. A Grid admin can disable BiDi if the network does "
+                  + "not allow websockets. True by default")
+  @ConfigValue(section = NODE_SECTION, name = "enable-bidi", example = "true")
+  public Boolean enableBiDi = DEFAULT_ENABLE_BIDI;
+
   @Parameter(
     names = {"--node-implementation"},
     description = "Full classname of non-default Node implementation. This is used to manage "

java/src/org/openqa/selenium/grid/node/config/NodeOptions.java

@@ -71,6 +71,7 @@ public class NodeOptions {
   public static final int DEFAULT_SESSION_TIMEOUT = 300;
   public static final int DEFAULT_DRAIN_AFTER_SESSION_COUNT = 0;
   public static final boolean DEFAULT_ENABLE_CDP = true;
+  public static final boolean DEFAULT_ENABLE_BIDI = true;
   static final String NODE_SECTION = "node";
   static final boolean DEFAULT_DETECT_DRIVERS = true;
   static final boolean OVERRIDE_MAX_SESSIONS = false;
@@ -238,6 +239,10 @@ public boolean isCdpEnabled() {
     return config.getBool(NODE_SECTION, "enable-cdp").orElse(DEFAULT_ENABLE_CDP);
   }
 
+  public boolean isBiDiEnabled() {
+    return config.getBool(NODE_SECTION, "enable-bidi").orElse(DEFAULT_ENABLE_BIDI);
+  }
+
   public int getDrainAfterSessionCount() {
     return Math.max(
       config.getInt(NODE_SECTION, "drain-after-session-count")

java/src/org/openqa/selenium/grid/node/local/LocalNode.java

@@ -121,6 +121,8 @@ public class LocalNode extends Node {
   private final int maxSessionCount;
   private final int configuredSessionCount;
   private final boolean cdpEnabled;
+
+  private final boolean bidiEnabled;
   private final AtomicBoolean drainAfterSessions = new AtomicBoolean();
   private final List<SessionSlot> factories;
   private final Cache<SessionId, SessionSlot> currentSessions;
@@ -137,6 +139,7 @@ private LocalNode(
     int maxSessionCount,
     int drainAfterSessionCount,
     boolean cdpEnabled,
+    boolean bidiEnabled,
     Ticker ticker,
     Duration sessionTimeout,
     Duration heartbeatPeriod,
@@ -157,6 +160,7 @@ private LocalNode(
     this.drainAfterSessions.set(this.configuredSessionCount > 0);
     this.sessionCount.set(drainAfterSessionCount);
     this.cdpEnabled = cdpEnabled;
+    this.bidiEnabled = bidiEnabled;
 
     this.healthCheck = healthCheck == null ?
                        () -> {
@@ -390,6 +394,7 @@ public Either<WebDriverException, CreateSessionResponse> newSession(CreateSessio
           session,
           externalUri,
           slotToUse.isSupportingCdp(),
+          slotToUse.isSupportingBiDi(),
           sessionRequest.getDesiredCapabilities());
 
         String sessionCreatedMessage = "Session created by the Node";
@@ -427,6 +432,7 @@ public Session getSession(SessionId id) throws NoSuchSessionException {
       slot.getSession(),
       externalUri,
       slot.isSupportingCdp(),
+      slot.isSupportingBiDi(),
       slot.getSession().getCapabilities());
   }
 
@@ -515,8 +521,11 @@ private void stopAllSessions() {
     }
   }
 
-  private Session createExternalSession(ActiveSession other, URI externalUri,
-                                        boolean isSupportingCdp, Capabilities requestCapabilities) {
+  private Session createExternalSession(ActiveSession other,
+                                        URI externalUri,
+                                        boolean isSupportingCdp,
+                                        boolean isSupportingBiDi,
+                                        Capabilities requestCapabilities) {
     // We merge the session request capabilities and the session ones to keep the values sent
     // by the user in the session information
     Capabilities toUse = ImmutableCapabilities
@@ -535,6 +544,21 @@ private Session createExternalSession(ActiveSession other, URI externalUri,
         }
       });
       toUse = new PersistentCapabilities(cdpFiltered).setCapability("se:cdpEnabled", false);
+      }
+
+      // Add se:bidi if necessary to send the bidi url back
+      if ((isSupportingBiDi || toUse.getCapability("se:bidi") != null) && bidiEnabled) {
+        String bidiPath = String.format("/session/%s/se/bidi", other.getId());
+        toUse = new PersistentCapabilities(toUse).setCapability("se:bidi", rewrite(bidiPath));
+      } else {
+        // Remove any se:bidi* from the response, BiDi is not supported nor enabled
+        MutableCapabilities bidiFiltered = new MutableCapabilities();
+        toUse.asMap().forEach((key, value) -> {
+          if (!key.startsWith("se:bidi")) {
+            bidiFiltered.setCapability(key, value);
+          }
+        });
+      toUse = new PersistentCapabilities(bidiFiltered).setCapability("se:bidiEnabled", false);
     }
 
     // If enabled, set the VNC endpoint for live view
@@ -665,6 +689,7 @@ public static class Builder {
     private int maxSessions = NodeOptions.DEFAULT_MAX_SESSIONS;
     private int drainAfterSessionCount = NodeOptions.DEFAULT_DRAIN_AFTER_SESSION_COUNT;
     private boolean cdpEnabled = NodeOptions.DEFAULT_ENABLE_CDP;
+    private boolean bidiEnabled = NodeOptions.DEFAULT_ENABLE_BIDI;
     private Ticker ticker = Ticker.systemTicker();
     private Duration sessionTimeout = Duration.ofSeconds(NodeOptions.DEFAULT_SESSION_TIMEOUT);
     private HealthCheck healthCheck;
@@ -708,6 +733,11 @@ public Builder enableCdp(boolean cdpEnabled) {
       return this;
     }
 
+    public Builder enableBiDi(boolean bidiEnabled) {
+      this.bidiEnabled = bidiEnabled;
+      return this;
+    }
+
     public Builder sessionTimeout(Duration timeout) {
       sessionTimeout = timeout;
       return this;
@@ -728,6 +758,7 @@ public LocalNode build() {
         maxSessions,
         drainAfterSessionCount,
         cdpEnabled,
+        bidiEnabled,
         ticker,
         sessionTimeout,
         heartbeatPeriod,

java/src/org/openqa/selenium/grid/node/local/LocalNodeFactory.java

@@ -70,6 +70,7 @@ public static Node create(Config config) {
       .sessionTimeout(sessionTimeout)
       .drainAfterSessionCount(nodeOptions.getDrainAfterSessionCount())
       .enableCdp(nodeOptions.isCdpEnabled())
+      .enableBiDi(nodeOptions.isBiDiEnabled())
       .heartbeatPeriod(nodeOptions.getHeartbeatPeriod());
 
     List<DriverService.Builder<?, ?>> builders = new ArrayList<>();

java/test/org/openqa/selenium/grid/node/local/LocalNodeTest.java

@@ -302,4 +302,32 @@ void cdpIsDisabledAndResponseCapsShowThat() throws URISyntaxException {
     assertThat(cdpEnabled).isNotNull();
     assertThat(Boolean.parseBoolean(cdpEnabled.toString())).isFalse();
   }
+
+  @Test
+  void bidiIsDisabledAndResponseCapsShowThat() throws URISyntaxException {
+    Tracer tracer = DefaultTestTracer.createTracer();
+    EventBus bus = new GuavaEventBus();
+    URI uri = new URI("http://localhost:7890");
+    Capabilities stereotype = new ImmutableCapabilities("browserName", "cheese");
+
+    LocalNode.Builder builder = LocalNode.builder(tracer, bus, uri, uri, registrationSecret)
+      .enableBiDi(false)
+      .add(stereotype,
+           new TestSessionFactory((id, caps)
+                                    -> new Session(id, uri, stereotype, caps, Instant.now())));
+    LocalNode localNode = builder.build();
+
+    Either<WebDriverException, CreateSessionResponse> response = localNode.newSession(
+      new CreateSessionRequest(
+        ImmutableSet.of(W3C),
+        stereotype,
+        ImmutableMap.of()));
+    assertThat(response.isRight()).isTrue();
+
+    CreateSessionResponse sessionResponse = response.right();
+    Capabilities capabilities = sessionResponse.getSession().getCapabilities();
+    Object bidiEnabled = capabilities.getCapability("se:bidiEnabled");
+    assertThat(bidiEnabled).isNotNull();
+    assertThat(Boolean.parseBoolean(bidiEnabled.toString())).isFalse();
+  }
 }