Add --websocket-port parameter to firefox service

Author: aguspe

rb/lib/selenium/webdriver/firefox/service.rb

@@ -25,6 +25,15 @@ class Service < WebDriver::Service
         EXECUTABLE = 'geckodriver'
         SHUTDOWN_SUPPORTED = false
         DRIVER_PATH_ENV_KEY = 'SE_GECKODRIVER'
+
+        def initialize(path: nil, port: nil, log: nil, args: nil)
+          args ||= []
+          unless args.any? { |arg| arg.include?('--connect-existing') }
+            args << '--websocket-port'
+            args << Support::Sockets.free_port.to_s
+          end
+          super
+        end
       end # Service
     end # Firefox
   end # WebDriver

rb/lib/selenium/webdriver/support.rb

@@ -24,3 +24,4 @@
 require 'selenium/webdriver/support/select'
 require 'selenium/webdriver/support/color'
 require 'selenium/webdriver/support/relative_locator'
+require 'selenium/webdriver/support/sockets'

rb/lib/selenium/webdriver/support/sockets.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you 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.
+
+require 'socket'
+
+module Selenium
+  module WebDriver
+    module Support
+      module Sockets
+        def self.free_port
+          server = TCPServer.new('127.0.0.1', 0)
+          port = server.addr[1]
+          server.close
+          port
+        end
+      end # Sockets
+    end # Support
+  end # WebDriver
+end # Selenium

rb/sig/selenium/web_driver/support/sockets.rbs

@@ -0,0 +1,9 @@
+module Selenium
+  module WebDriver
+    module Support
+      module Sockets
+        def self.free_port: -> Integer
+      end
+    end
+  end
+end

rb/spec/integration/selenium/webdriver/firefox/service_spec.rb

@@ -37,6 +37,21 @@ module Firefox
         it 'can be started outside driver' do
           expect(service_manager.uri).to be_a(URI)
         end
+
+        context 'with BiDi enabled (websocket port)' do
+          it 'ensures two service instances use different websocket port' do
+            service1 = described_class.new
+            service2 = described_class.new
+
+            ws_index1 = service1.args.index('--websocket-port')
+            ws_index2 = service2.args.index('--websocket-port')
+
+            port1 = service1.args[ws_index1 + 1].to_i
+            port2 = service2.args[ws_index2 + 1].to_i
+
+            expect(port1).not_to eq(port2)
+          end
+        end
       end
     end # Firefox
   end # WebDriver

rb/spec/unit/selenium/webdriver/firefox/service_spec.rb

@@ -51,7 +51,7 @@ module Firefox
           it 'does not create args by default' do
             service = described_class.new
 
-            expect(service.extra_args).to be_empty
+            expect(service.extra_args.count).to eq 2
           end
 
           it 'uses sets log path to stdout' do
@@ -73,17 +73,32 @@ module Firefox
           end
 
           it 'uses provided args' do
-            service = described_class.new(args: ['--foo', '--bar'])
+            service = described_class.new(args: %w[--foo --bar])
+            expect(service.extra_args).to include(*%w[--foo --bar])
+          end
+
+          context 'with websocket parameter' do
+            it 'validates the websocket parameter is present and there is a random port' do
+              service = described_class.new
+              ws_index = service.extra_args.index('--websocket-port')
+              port = service.extra_args[ws_index + 1].to_i
+              expect(port).to be > 0
+              expect(port).to be < 65_536
+            end
 
-            expect(service.extra_args).to eq ['--foo', '--bar']
+            it 'validates with --connect-existing that there is no --websocket-port and the port is not random' do
+              service = described_class.new(args: ['--connect-existing'])
+              expect(service.extra_args).not_to include('--websocket-port')
+              expect(service.extra_args).to eq(['--connect-existing'])
+            end
           end
         end
 
         context 'when initializing driver' do
           let(:driver) { Firefox::Driver }
           let(:service) do
             instance_double(described_class, launch: service_manager, executable_path: nil, 'executable_path=': nil,
-                                             class: described_class)
+                            class: described_class)
           end
           let(:service_manager) { instance_double(ServiceManager, uri: 'http://example.com') }
           let(:bridge) { instance_double(Remote::Bridge, quit: nil, create_session: {}) }