[rb][bidi] completed events with tests

Author: TamsilAmani

rb/lib/selenium/webdriver/bidi/network_inspector.rb

@@ -36,12 +36,20 @@ def initialize(driver, browsing_context_ids = nil)
 
           @bidi = driver.bidi
           @bidi.session.subscribe('network.beforeRequestSent', browsing_context_ids)
+          @bidi.session.subscribe('network.responseStarted', browsing_context_ids)
+          @bidi.session.subscribe('network.responseCompleted', browsing_context_ids)
         end
 
         def before_request_sent(&block)
-          on(:before_request_sent) do |params|
-            before_request_sent_event(params, &block)
-          end
+          on(:before_request_sent, &block)
+        end
+
+        def response_started(&block)
+          on(:response_started, &block)
+        end
+
+        def response_completed(&block)
+          on(:response_started, &block)
         end
 
         private
@@ -50,10 +58,6 @@ def on(event, &block)
           event = EVENTS[event] if event.is_a?(Symbol)
           @bidi.callbacks["network.#{event}"] << block
         end
-
-        def before_request_sent_event(params)
-          yield(params)
-        end
       end # NetworkInspector
     end # Bidi
   end # WebDriver

rb/spec/integration/selenium/webdriver/bidi/network_inspector_spec.rb

@@ -29,35 +29,148 @@ class BiDi
 
         it 'can listen to event before request is sent' do
           reset_driver!(web_socket_url: true) do |driver|
-            before_request_event = []
+            before_request_event = nil
             inspector = described_class.new(driver)
-            inspector.before_request_sent { |event| before_request_event.push(event) }
+            inspector.before_request_sent { |event| before_request_event = event }
 
             driver.navigate.to url_for(empty_page)
-
             wait.until { !before_request_event.nil? }
 
-            expect(before_request_event[0].dig('request', 'method')).to eq 'GET'
-            url = before_request_event[0].dig('request', 'url')
-            expect(url).to eq driver.current_url
+            expect(before_request_event.dig('request', 'method')).to eq 'GET'
+            expect(before_request_event.dig('request', 'url')).to eq driver.current_url
           end
         end
 
         it 'can request cookies' do
           reset_driver!(web_socket_url: true) do |driver|
-            before_request_event = []
+            before_request_event = nil
             inspector = described_class.new(driver)
-            inspector.before_request_sent { |event| before_request_event.push(event) }
+            inspector.before_request_sent { |event| before_request_event = event }
 
             driver.navigate.to url_for(empty_text)
             driver.manage.add_cookie name: 'north',
                                      value: 'biryani'
             driver.navigate.refresh
             wait.until { !before_request_event.nil? }
 
-            cookies = before_request_event[0]['request']['cookies']
-            puts "cookies = \n", cookies # prints nil
+            expect(before_request_event.dig('request', 'method')).to eq 'GET'
+            expect(before_request_event.dig('request', 'url')).to eq driver.current_url
+            expect(before_request_event.dig('request', 'cookies', 0, 'name')).to eq 'north'
+            expect(before_request_event.dig('request', 'cookies', 0, 'value')).to eq 'biryani'
+
+            driver.manage.add_cookie name: 'south',
+                                     value: 'dosa'
+            driver.navigate.refresh
+            wait.until { !before_request_event.nil? }
+            expect(before_request_event.dig('request', 'cookies', 1, 'name')).to eq 'south'
+            expect(before_request_event.dig('request', 'cookies', 1, 'value')).to eq 'dosa'
+          end
+        end
+
+        it 'can redirect http equiv' do
+          reset_driver!(web_socket_url: true) do |driver|
+            before_request_event = []
+            inspector = described_class.new(driver)
+            inspector.before_request_sent { |event| before_request_event.push(event) }
+
+            driver.navigate.to url_for(redirected_http_equiv)
+            wait.until { driver.current_url.include? 'redirected.html' }
+
             expect(before_request_event[0].dig('request', 'method')).to eq 'GET'
+            expect(before_request_event[0].dig('request', 'url')).to include 'redirected_http_equiv.html'
+            expect(before_request_event[2].dig('request', 'method')).to eq 'GET'
+            expect(before_request_event[2].dig('request', 'url')).to include 'redirected.html'
+          end
+        end
+
+        it 'can subscribe to response started' do
+          reset_driver!(web_socket_url: true) do |driver|
+            on_response_started = []
+            inspector = described_class.new(driver)
+            inspector.response_started { |event| on_response_started.push(event) }
+
+            driver.navigate.to url_for(empty_text)
+            wait.until { !on_response_started.nil? }
+
+            expect(on_response_started[0].dig('request', 'method')).to eq 'GET'
+            expect(on_response_started[0].dig('request', 'url')).to eq driver.current_url
+            expect(on_response_started[0].dig('response', 'url')).to eq driver.current_url
+            expect(on_response_started[0].dig('response', 'fromCache')).to be false
+            expect(on_response_started[0].dig('response', 'mimeType')).to include 'text/plain'
+            expect(on_response_started[0].dig('response', 'status')).to eq 200
+            expect(on_response_started[0].dig('response', 'statusText')).to eq 'OK'
+          end
+        end
+
+        it 'test response started mime type' do
+          reset_driver!(web_socket_url: true) do |driver|
+            on_response_started = []
+            inspector = described_class.new(driver)
+            inspector.response_started { |event| on_response_started.push(event) }
+
+            # Checking mime type for 'html' text
+            driver.navigate.to url_for(empty_page)
+            wait.until { !on_response_started.nil? }
+
+            expect(on_response_started[0].dig('request', 'method')).to eq 'GET'
+            expect(on_response_started[0].dig('request', 'url')).to eq driver.current_url
+            expect(on_response_started[0].dig('response', 'url')).to eq driver.current_url
+            expect(on_response_started[0].dig('response', 'mimeType')).to include 'text/html'
+
+            # Checking mime type for 'plain' text
+            on_response_started = []
+            driver.navigate.to url_for(empty_text)
+            wait.until { !on_response_started.nil? }
+            expect(on_response_started[0].dig('request', 'method')).to eq 'GET'
+            expect(on_response_started[0].dig('request', 'url')).to eq driver.current_url
+            expect(on_response_started[0].dig('response', 'url')).to eq driver.current_url
+            expect(on_response_started[0].dig('response', 'mimeType')).to include 'text/plain'
+          end
+        end
+
+        it 'can subscribe to response completed' do
+          reset_driver!(web_socket_url: true) do |driver|
+            on_response_completed = []
+            inspector = described_class.new(driver)
+            inspector.response_completed { |event| on_response_completed.push(event) }
+
+            driver.navigate.to url_for(empty_page)
+            wait.until { !on_response_completed.nil? }
+
+            expect(on_response_completed[0].dig('request', 'method')).to eq 'GET'
+            expect(on_response_completed[0].dig('request', 'url')).to eq driver.current_url
+            expect(on_response_completed[0].dig('response', 'url')).to eq driver.current_url
+            expect(on_response_completed[0].dig('response', 'fromCache')).to be false
+            expect(on_response_completed[0].dig('response', 'mimeType')).to include 'text/html'
+            expect(on_response_completed[0].dig('response', 'status')).to eq 200
+            expect(on_response_completed[0].dig('response', 'statusText')).to eq 'OK'
+            expect(on_response_completed[0]['redirectCount']).to eq 0
+          end
+        end
+
+        it 'test response completed mime type' do
+          reset_driver!(web_socket_url: true) do |driver|
+            on_response_completed = []
+            inspector = described_class.new(driver)
+            inspector.response_completed { |event| on_response_completed.push(event) }
+
+            # Checking mime type for 'html' text
+            driver.navigate.to url_for(empty_page)
+            wait.until { !on_response_completed.nil? }
+
+            expect(on_response_completed[0].dig('request', 'method')).to eq 'GET'
+            expect(on_response_completed[0].dig('request', 'url')).to eq driver.current_url
+            expect(on_response_completed[0].dig('response', 'url')).to eq driver.current_url
+            expect(on_response_completed[0].dig('response', 'mimeType')).to include 'text/html'
+
+            # Checking mime type for 'plain' text
+            on_response_completed = []
+            driver.navigate.to url_for(empty_text)
+            wait.until { !on_response_completed.nil? }
+            expect(on_response_completed[0].dig('request', 'method')).to eq 'GET'
+            expect(on_response_completed[0].dig('request', 'url')).to eq driver.current_url
+            expect(on_response_completed[0].dig('response', 'url')).to eq driver.current_url
+            expect(on_response_completed[0].dig('response', 'mimeType')).to include 'text/plain'
           end
         end
       end