playwright-ruby-client 1.15.beta2 → 1.16.0

data/lib/playwright/channel_owners/api_request_context.rb

@@ -0,0 +1,4 @@
+module Playwright
+  define_channel_owner :APIRequestContext do
+  end
+end

data/lib/playwright/channel_owners/browser_context.rb

@@ -72,6 +72,11 @@ module Playwright
 
       if @routes.none? { |handler_entry| handler_entry.handle(wrapped_route, wrapped_request) }
         route.continue
+      else
+        @routes.reject!(&:expired?)
+        if @routes.count == 0
+          @channel.async_send_message_to_server('setNetworkInterceptionEnabled', enabled: false)
+        end
       end
     end
 

data/lib/playwright/channel_owners/fetch_request.rb

@@ -0,0 +1,6 @@
+module Playwright
+  module ChannelOwners
+    class FetchRequest < APIRequestContext
+    end
+  end
+end

data/lib/playwright/channel_owners/frame.rb

@@ -593,7 +593,9 @@ module Playwright
     end
 
     def wait_for_timeout(timeout)
-      sleep(timeout / 1000.0)
+      @channel.send_message_to_server('waitForTimeout', timeout: timeout)
+
+      nil
     end
 
     def wait_for_function(pageFunction, arg: nil, polling: nil, timeout: nil)

data/lib/playwright/channel_owners/page.rb

@@ -100,6 +100,11 @@ module Playwright
 
       if @routes.none? { |handler_entry| handler_entry.handle(wrapped_route, wrapped_request) }
         @browser_context.send(:on_route, route, request)
+      else
+        @routes.reject!(&:expired?)
+        if @routes.count == 0
+          @channel.async_send_message_to_server('setNetworkInterceptionEnabled', enabled: false)
+        end
       end
     end
 

data/lib/playwright/channel_owners/request.rb

@@ -1,14 +1,12 @@
 require 'base64'
-require_relative '../http_headers'
 
 module Playwright
   # @ref https://github.com/microsoft/playwright-python/blob/master/playwright/_impl/_network.py
   define_channel_owner :Request do
-    include HttpHeaders::Parser
-
     private def after_initialize
       @redirected_from = ChannelOwners::Request.from_nullable(@initializer['redirectedFrom'])
       @redirected_from&.send(:update_redirected_to, self)
+      @provisional_headers = RawHeaders.new(@initializer['headers'])
       @timing = {
         startTime: 0,
         domainLookupStart: -1,
@@ -81,27 +79,32 @@ module Playwright
     attr_reader :redirected_from, :redirected_to, :timing
 
     def headers
-      parse_headers_as_array(@initializer['headers'], true).to_h
+      @provisional_headers.headers
+    end
+
+    # @return [RawHeaders|nil]
+    private def actual_headers
+      @actual_headers ||= raw_request_headers
     end
 
-    private def raw_headers
-      @raw_headers ||= response&.send(:raw_request_headers)
+    private def raw_request_headers
+      RawHeaders.new(@channel.send_message_to_server('rawRequestHeaders'))
     end
 
     def all_headers
-      if raw_headers
-        parse_headers_as_array(raw_headers, true).to_h
-      else
-        parse_headers_as_array(@initializer['headers'], true).to_h
-      end
+      actual_headers.headers
     end
 
     def headers_array
-      if raw_headers
-        parse_headers_as_array(raw_headers, false)
-      else
-        parse_headers_as_array(@initializer['headers'], false)
-      end
+      actual_headers.headers_array
+    end
+
+    def header_value(name)
+      actual_headers.get(name)
+    end
+
+    def header_values(name)
+      actual_headers.get_all(name)
     end
 
     def sizes

data/lib/playwright/channel_owners/response.rb

@@ -1,13 +1,11 @@
 require 'base64'
 require 'json'
-require_relative '../http_headers'
 
 module Playwright
   # @ref https://github.com/microsoft/playwright-python/blob/master/playwright/_impl/_network.py
   define_channel_owner :Response do
-    include HttpHeaders::Parser
-
     private def after_initialize
+      @provisional_headers = RawHeaders.new(@initializer['headers'])
       @request = ChannelOwners::Request.from(@initializer['request'])
       timing = @initializer['timing']
       @request.send(:update_timings,
@@ -42,27 +40,32 @@ module Playwright
     end
 
     def headers
-      parse_headers_as_array(@initializer['headers'], true).to_h
-    end
-
-    private def raw_headers
-      @raw_headers ||= raw_response_headers
+      @provisional_headers.headers
     end
 
-    private def raw_request_headers
-      @channel.send_message_to_server('rawRequestHeaders')
+    # @return [RawHeaders]
+    private def actual_headers
+      @actual_headers ||= raw_response_headers
     end
 
     private def raw_response_headers
-      @channel.send_message_to_server('rawResponseHeaders')
+      RawHeaders.new(@channel.send_message_to_server('rawResponseHeaders'))
     end
 
     def all_headers
-      parse_headers_as_array(raw_headers, true).to_h
+      actual_headers.headers
     end
 
     def headers_array
-      parse_headers_as_array(raw_headers, false)
+      actual_headers.headers_array
+    end
+
+    def header_value(name)
+      actual_headers.get(name)
+    end
+
+    def header_values(name)
+      actual_headers.get_all(name)
     end
 
     def server_addr

data/lib/playwright/http_headers.rb

@@ -10,16 +10,5 @@ module Playwright
         { name: key, value: value }
       end
     end
-
-    module Parser
-      def parse_headers_as_array(serialized_headers, downcase)
-        serialized_headers.map do |header|
-          name = downcase ? header['name'].downcase : header['name']
-          value = header['value']
-
-          [name, value]
-        end
-      end
-    end
   end
 end

data/lib/playwright/locator_impl.rb

@@ -303,6 +303,10 @@ module Playwright
         trial: trial)
     end
 
+    def wait_for(state: nil, timeout: nil)
+      @frame.wait_for_selector(@selector, strict: true, state: state, timeout: timeout)
+    end
+
     def set_checked(checked, **options)
       if checked
         check(**options)

data/lib/playwright/mouse_impl.rb

@@ -44,5 +44,14 @@ module Playwright
     def dblclick(x, y, button: nil, delay: nil)
       click(x, y, button: button, clickCount: 2, delay: delay)
     end
+
+    def wheel(deltaX, deltaY)
+      params = {
+        deltaX: deltaX,
+        deltaY: deltaY,
+      }
+      @channel.send_message_to_server('mouseWheel', params)
+      nil
+    end
   end
 end

data/lib/playwright/raw_headers.rb

@@ -0,0 +1,61 @@
+module Playwright
+  class RawHeaders
+    def initialize(headers_array)
+      h_array = []
+      h_map = {}
+      headers_array.each do |header|
+        name = header['name']
+        key = name.downcase
+        value = header['value']
+
+        h_array << [name, value]
+        h_map[key] ||= []
+        h_map[key] << value
+      end
+
+      @headers_array = h_array
+      @headers_map = h_map
+    end
+
+    # @return [String|nil]
+    def get(name)
+      key = name.downcase
+      values = @headers_map[key]
+      if values
+        join(key, values)
+      else
+        nil
+      end
+    end
+
+    # @return [Array<String>]
+    def get_all(name)
+      values = @headers_map[name.downcase]
+      if values
+        values.dup
+      else
+        []
+      end
+    end
+
+    def headers
+      @headers_map.map do |key, values|
+        [key, join(key, values)]
+      end.to_h
+    end
+
+    def headers_array
+      @headers_array.map do |name, value|
+        { name: name, value: value }
+      end
+    end
+
+    private def join(key, values)
+      if key == 'set-cookie'
+        values.join("\n")
+      else
+        values.join(", ")
+      end
+    end
+  end
+end

data/lib/playwright/route_handler.rb

@@ -6,17 +6,25 @@ module Playwright
       end
 
       def handle
-        return false if @count <= 0
+        return false if expired?
 
         @count = @count - 1
         true
       end
+
+      def expired?
+        @count <= 0
+      end
     end
 
     class StubCounter
       def handle
         true
       end
+
+      def expired?
+        false
+      end
     end
 
     # @param url [String]
@@ -46,6 +54,10 @@ module Playwright
       end
     end
 
+    def expired?
+      @counter.expired?
+    end
+
     def same_value?(url:, handler: nil)
       if handler
         @url_value == url && @handler == handler

data/lib/playwright/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Playwright
-  VERSION = '1.15.beta2'
-  COMPATIBLE_PLAYWRIGHT_VERSION = '1.15.0'
+  VERSION = '1.16.0'
+  COMPATIBLE_PLAYWRIGHT_VERSION = '1.16.0'
 end

data/lib/playwright.rb

@@ -20,6 +20,7 @@ require 'playwright/channel_owner'
 require 'playwright/http_headers'
 require 'playwright/input_files'
 require 'playwright/connection'
+require 'playwright/raw_headers'
 require 'playwright/route_handler'
 require 'playwright/select_option_values'
 require 'playwright/timeout_settings'

data/lib/playwright_api/android.rb

@@ -36,12 +36,6 @@ module Playwright
     end
     alias_method :default_timeout=, :set_default_timeout
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def once(event, callback)
@@ -54,6 +48,12 @@ module Playwright
       event_emitter_proxy.on(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/android_device.rb

@@ -174,12 +174,6 @@ module Playwright
       wrap_impl(@impl.tap_on(unwrap_impl(selector), duration: unwrap_impl(duration), timeout: unwrap_impl(timeout)))
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def once(event, callback)
@@ -192,6 +186,12 @@ module Playwright
       event_emitter_proxy.on(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/api_request_context.rb

@@ -0,0 +1,146 @@
+module Playwright
+  # This API is used for the Web API testing. You can use it to trigger API endpoints, configure micro-services, prepare
+  # environment or the service to your e2e test. When used on `Page` or a `BrowserContext`, this API will automatically use
+  # the cookies from the corresponding `BrowserContext`. This means that if you log in using this API, your e2e test will be
+  # logged in and vice versa.
+  class APIRequestContext < PlaywrightApi
+
+    # Sends HTTP(S) [DELETE](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/DELETE) request and returns its
+    # response. The method will populate request cookies from the context and update context cookies from the response. The
+    # method will automatically follow redirects.
+    def delete(
+          url,
+          failOnStatusCode: nil,
+          headers: nil,
+          ignoreHTTPSErrors: nil,
+          params: nil,
+          timeout: nil)
+      raise NotImplementedError.new('delete is not implemented yet.')
+    end
+
+    # All responses returned by [`method: APIRequestContext.get`] and similar methods are stored in the memory, so that you
+    # can later call [`method: APIResponse.body`]. This method discards all stored responses, and makes
+    # [`method: APIResponse.body`] throw "Response disposed" error.
+    def dispose
+      raise NotImplementedError.new('dispose is not implemented yet.')
+    end
+
+    # Sends HTTP(S) request and returns its response. The method will populate request cookies from the context and update
+    # context cookies from the response. The method will automatically follow redirects.
+    def fetch(
+          urlOrRequest,
+          data: nil,
+          failOnStatusCode: nil,
+          form: nil,
+          headers: nil,
+          ignoreHTTPSErrors: nil,
+          method: nil,
+          multipart: nil,
+          params: nil,
+          timeout: nil)
+      raise NotImplementedError.new('fetch is not implemented yet.')
+    end
+
+    # Sends HTTP(S) [GET](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/GET) request and returns its response. The
+    # method will populate request cookies from the context and update context cookies from the response. The method will
+    # automatically follow redirects.
+    def get(
+          url,
+          failOnStatusCode: nil,
+          headers: nil,
+          ignoreHTTPSErrors: nil,
+          params: nil,
+          timeout: nil)
+      raise NotImplementedError.new('get is not implemented yet.')
+    end
+
+    # Sends HTTP(S) [HEAD](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/HEAD) request and returns its response.
+    # The method will populate request cookies from the context and update context cookies from the response. The method will
+    # automatically follow redirects.
+    def head(
+          url,
+          failOnStatusCode: nil,
+          headers: nil,
+          ignoreHTTPSErrors: nil,
+          params: nil,
+          timeout: nil)
+      raise NotImplementedError.new('head is not implemented yet.')
+    end
+
+    # Sends HTTP(S) [PATCH](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PATCH) request and returns its response.
+    # The method will populate request cookies from the context and update context cookies from the response. The method will
+    # automatically follow redirects.
+    def patch(
+          url,
+          data: nil,
+          failOnStatusCode: nil,
+          form: nil,
+          headers: nil,
+          ignoreHTTPSErrors: nil,
+          multipart: nil,
+          params: nil,
+          timeout: nil)
+      raise NotImplementedError.new('patch is not implemented yet.')
+    end
+
+    # Sends HTTP(S) [POST](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST) request and returns its response.
+    # The method will populate request cookies from the context and update context cookies from the response. The method will
+    # automatically follow redirects.
+    def post(
+          url,
+          data: nil,
+          failOnStatusCode: nil,
+          form: nil,
+          headers: nil,
+          ignoreHTTPSErrors: nil,
+          multipart: nil,
+          params: nil,
+          timeout: nil)
+      raise NotImplementedError.new('post is not implemented yet.')
+    end
+
+    # Sends HTTP(S) [PUT](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PUT) request and returns its response. The
+    # method will populate request cookies from the context and update context cookies from the response. The method will
+    # automatically follow redirects.
+    def put(
+          url,
+          data: nil,
+          failOnStatusCode: nil,
+          form: nil,
+          headers: nil,
+          ignoreHTTPSErrors: nil,
+          multipart: nil,
+          params: nil,
+          timeout: nil)
+      raise NotImplementedError.new('put is not implemented yet.')
+    end
+
+    # Returns storage state for this request context, contains current cookies and local storage snapshot if it was passed to
+    # the constructor.
+    def storage_state(path: nil)
+      raise NotImplementedError.new('storage_state is not implemented yet.')
+    end
+
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
+    end
+
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
+    end
+
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
+    end
+
+    private def event_emitter_proxy
+      @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
+    end
+  end
+end

data/lib/playwright_api/browser.rb

@@ -166,12 +166,6 @@ module Playwright
       wrap_impl(@impl.version)
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def once(event, callback)
@@ -184,6 +178,12 @@ module Playwright
       event_emitter_proxy.on(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/browser_context.rb

@@ -6,7 +6,7 @@ module Playwright
   # If a page opens another page, e.g. with a `window.open` call, the popup will belong to the parent page's browser
   # context.
   #
-  # Playwright allows creation of "incognito" browser contexts with `browser.newContext()` method. "Incognito" browser
+  # Playwright allows creating "incognito" browser contexts with [`method: Browser.newContext`] method. "Incognito" browser
   # contexts don't write any browsing data to disk.
   #
   # ```python sync
@@ -391,12 +391,6 @@ module Playwright
       wrap_impl(@impl.options=(unwrap_impl(req)))
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def once(event, callback)
@@ -409,6 +403,12 @@ module Playwright
       event_emitter_proxy.on(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/browser_type.rb

@@ -146,12 +146,6 @@ module Playwright
       wrap_impl(@impl.name)
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def once(event, callback)
@@ -164,6 +158,12 @@ module Playwright
       event_emitter_proxy.on(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/cdp_session.rb

@@ -12,7 +12,7 @@ module Playwright
   #   https://github.com/aslushnikov/getting-started-with-cdp/blob/master/README.md
   #
   # ```python sync
-  # client = page.context().new_cdp_session(page)
+  # client = page.context.new_cdp_session(page)
   # client.send("Animation.enable")
   # client.on("Animation.animationCreated", lambda: print("animation created!"))
   # response = client.send("Animation.getPlaybackRate")
@@ -33,12 +33,6 @@ module Playwright
       wrap_impl(@impl.send_message(unwrap_impl(method), params: unwrap_impl(params)))
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def once(event, callback)
@@ -51,6 +45,12 @@ module Playwright
       event_emitter_proxy.on(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/console_message.rb

@@ -23,12 +23,6 @@ module Playwright
       wrap_impl(@impl.type)
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def once(event, callback)
@@ -41,6 +35,12 @@ module Playwright
       event_emitter_proxy.on(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end