playwright-ruby-client 1.17.beta1 → 1.18.1

data/lib/playwright/channel_owners/api_request_context.rb

@@ -1,4 +1,236 @@
+require 'base64'
+
 module Playwright
   define_channel_owner :APIRequestContext do
+    def dispose
+      @channel.send_message_to_server('dispose')
+    end
+
+    def delete(
+          url,
+          data: nil,
+          failOnStatusCode: nil,
+          form: nil,
+          headers: nil,
+          ignoreHTTPSErrors: nil,
+          multipart: nil,
+          params: nil,
+          timeout: nil)
+      fetch(
+        url,
+        method: 'DELETE',
+        data: data,
+        failOnStatusCode: failOnStatusCode,
+        form: form,
+        headers: headers,
+        ignoreHTTPSErrors: ignoreHTTPSErrors,
+        multipart: multipart,
+        params: params,
+        timeout: timeout,
+      )
+    end
+
+    def head(
+          url,
+          failOnStatusCode: nil,
+          headers: nil,
+          ignoreHTTPSErrors: nil,
+          params: nil,
+          timeout: nil)
+      fetch(
+        url,
+        method: 'HEAD',
+        failOnStatusCode: failOnStatusCode,
+        headers: headers,
+        ignoreHTTPSErrors: ignoreHTTPSErrors,
+        params: params,
+        timeout: timeout,
+      )
+    end
+
+    def get(
+          url,
+          failOnStatusCode: nil,
+          headers: nil,
+          ignoreHTTPSErrors: nil,
+          params: nil,
+          timeout: nil)
+      fetch(
+        url,
+        method: 'GET',
+        failOnStatusCode: failOnStatusCode,
+        headers: headers,
+        ignoreHTTPSErrors: ignoreHTTPSErrors,
+        params: params,
+        timeout: timeout,
+      )
+    end
+
+    def patch(
+          url,
+          data: nil,
+          failOnStatusCode: nil,
+          form: nil,
+          headers: nil,
+          ignoreHTTPSErrors: nil,
+          multipart: nil,
+          params: nil,
+          timeout: nil)
+      fetch(
+        url,
+        method: 'PATCH',
+        data: data,
+        failOnStatusCode: failOnStatusCode,
+        form: form,
+        headers: headers,
+        ignoreHTTPSErrors: ignoreHTTPSErrors,
+        multipart: multipart,
+        params: params,
+        timeout: timeout,
+      )
+    end
+
+    def put(
+          url,
+          data: nil,
+          failOnStatusCode: nil,
+          form: nil,
+          headers: nil,
+          ignoreHTTPSErrors: nil,
+          multipart: nil,
+          params: nil,
+          timeout: nil)
+      fetch(
+        url,
+        method: 'PUT',
+        data: data,
+        failOnStatusCode: failOnStatusCode,
+        form: form,
+        headers: headers,
+        ignoreHTTPSErrors: ignoreHTTPSErrors,
+        multipart: multipart,
+        params: params,
+        timeout: timeout,
+      )
+    end
+
+    def post(
+          url,
+          data: nil,
+          failOnStatusCode: nil,
+          form: nil,
+          headers: nil,
+          ignoreHTTPSErrors: nil,
+          multipart: nil,
+          params: nil,
+          timeout: nil)
+      fetch(
+        url,
+        method: 'POST',
+        data: data,
+        failOnStatusCode: failOnStatusCode,
+        form: form,
+        headers: headers,
+        ignoreHTTPSErrors: ignoreHTTPSErrors,
+        multipart: multipart,
+        params: params,
+        timeout: timeout,
+      )
+    end
+
+    def fetch(
+          urlOrRequest,
+          data: nil,
+          failOnStatusCode: nil,
+          form: nil,
+          headers: nil,
+          ignoreHTTPSErrors: nil,
+          method: nil,
+          multipart: nil,
+          params: nil,
+          timeout: nil)
+
+      if [ChannelOwners::Request, String].none? { |type| urlOrRequest.is_a?(type) }
+        raise ArgumentError.new("First argument must be either URL string or Request")
+      end
+      if [data, form, multipart].compact.count > 1
+        raise ArgumentError.new("Only one of 'data', 'form' or 'multipart' can be specified")
+      end
+
+      request = urlOrRequest.is_a?(ChannelOwners::Request) ? urlOrRequest : nil
+      headers_obj = headers || request&.headers
+      fetch_params = {
+        url: request&.url || urlOrRequest,
+        params: object_to_array(params),
+        method: method || request&.method || 'GET',
+        headers: headers_obj ? HttpHeaders.new(headers_obj).as_serialized : nil,
+      }
+
+      json_data = nil
+      form_data = nil
+      multipart_data = nil
+      post_data_buffer = nil
+      if data
+        case data
+        when String
+          if headers_obj&.any? { |key, value| key.downcase == 'content-type' && value == 'application/json' }
+            json_data = data
+          else
+            post_data_buffer = data
+          end
+        when Hash, Array, Numeric, true, false
+          json_data = data
+        else
+          raise ArgumentError.new("Unsupported 'data' type: #{data.class}")
+        end
+      elsif form
+        form_data = object_to_array(form)
+      elsif multipart
+        multipart_data = multipart.map do |name, value|
+          if file_payload?(value)
+            { name: name, file: file_payload_to_json(value) }
+          else
+            { name: name, value: value.to_s }
+          end
+        end
+      end
+
+      if !json_data && !form_data && !multipart_data
+        post_data_buffer ||= request&.post_data_buffer
+      end
+      if post_data_buffer
+        fetch_params[:postData] = Base64.strict_encode64(post_data_buffer)
+      end
+
+      fetch_params[:jsonData] = json_data
+      fetch_params[:formData] = form_data
+      fetch_params[:multipartData] = multipart_data
+      fetch_params[:timeout] = timeout
+      fetch_params[:failOnStatusCode] = failOnStatusCode
+      fetch_params[:ignoreHTTPSErrors] = ignoreHTTPSErrors
+      fetch_params.compact!
+      response = @channel.send_message_to_server('fetch', fetch_params)
+
+      APIResponseImpl.new(self, response)
+    end
+
+    private def file_payload?(value)
+      value.is_a?(Hash) &&
+        %w(name mimeType buffer).all? { |key| value.has_key?(key) || value.has_key?(key.to_sym) }
+    end
+
+    private def file_payload_to_json(payload)
+      {
+        name: payload[:name] || payload['name'],
+        mimeType: payload[:mimeType] || payload['mimeType'],
+        buffer: Base64.strict_encode64(payload[:buffer] || payload['buffer'])
+      }
+    end
+
+    private def object_to_array(hash)
+      hash&.map do |key, value|
+        { name: key, value: value.to_s }
+      end
+    end
   end
 end

data/lib/playwright/channel_owners/browser_context.rb

@@ -4,7 +4,7 @@ module Playwright
     include Utils::Errors::SafeCloseError
     attr_accessor :browser
     attr_writer :owner_page, :options
-    attr_reader :tracing
+    attr_reader :tracing, :request
 
     private def after_initialize
       @pages = Set.new
@@ -15,6 +15,8 @@ module Playwright
       @background_pages = Set.new
 
       @tracing = TracingImpl.new(@channel, self)
+      @request = ChannelOwners::APIRequestContext.from(@initializer['APIRequestContext'])
+
       @channel.on('bindingCall', ->(params) { on_binding(ChannelOwners::BindingCall.from(params['binding'])) })
       @channel.once('close', ->(_) { on_close })
       @channel.on('page', ->(params) { on_page(ChannelOwners::Page.from(params['page']) )})
@@ -358,5 +360,10 @@ module Playwright
     private def base_url
       @options[:baseURL]
     end
+
+    # called from Tracing
+    private def remote_connection?
+      @connection.remote?
+    end
   end
 end

data/lib/playwright/channel_owners/frame.rb

@@ -400,8 +400,8 @@ module Playwright
       nil
     end
 
-    def locator(selector)
-      LocatorImpl.new(frame: self, timeout_settings: @page.send(:timeout_settings), selector: selector)
+    def locator(selector, hasText: nil)
+      LocatorImpl.new(frame: self, timeout_settings: @page.send(:timeout_settings), selector: selector, hasText: hasText)
     end
 
     def frame_locator(selector)

data/lib/playwright/channel_owners/local_utils.rb

@@ -0,0 +1,14 @@
+module Playwright
+  define_channel_owner :LocalUtils do
+    # @param zip_file [String]
+    # @param name_value_array [Array<Hash<{name: string, value: string}>>]
+    def zip(zip_file, name_value_array)
+      params = {
+        zipFile: zip_file,
+        entries: name_value_array,
+      }
+      @channel.send_message_to_server('zip', params)
+      nil
+    end
+  end
+end

data/lib/playwright/channel_owners/page.rb

@@ -558,8 +558,8 @@ module Playwright
         timeout: timeout)
     end
 
-    def locator(selector)
-      @main_frame.locator(selector)
+    def locator(selector, hasText: nil)
+      @main_frame.locator(selector, hasText: hasText)
     end
 
     def frame_locator(selector)
@@ -733,6 +733,10 @@ module Playwright
       @workers.to_a
     end
 
+    def request
+      @browser_context.request
+    end
+
     def pause
       @browser_context.send(:pause)
     end

data/lib/playwright/frame_locator_impl.rb

@@ -6,11 +6,12 @@ module Playwright
       @frame_selector = frame_selector
     end
 
-    def locator(selector)
+    def locator(selector, hasText: nil)
       LocatorImpl.new(
         frame: @frame,
         timeout_settings: @timeout_settings,
         selector: "#{@frame_selector} >> control=enter-frame >> #{selector}",
+        hasText: hasText,
       )
     end
 

data/lib/playwright/locator_impl.rb

@@ -1,9 +1,46 @@
+require 'json'
+
 module Playwright
+  class EscapeWithQuotes
+    def initialize(text, char = "'")
+      stringified = text.to_json
+      escaped_text = stringified[1...-1].gsub(/\\"/, '"')
+
+      case char
+      when '"'
+        text = escaped_text.gsub(/["]/, '\\"')
+        @text = "\"#{text}\""
+      when "'"
+        text = escaped_text.gsub(/[']/, '\\\'')
+        @text = "'#{text}'"
+      else
+        raise ArgumentError.new('Invalid escape char')
+      end
+    end
+
+    def to_s
+      @text
+    end
+  end
+
   define_api_implementation :LocatorImpl do
-    def initialize(frame:, timeout_settings:, selector:)
+    def initialize(frame:, timeout_settings:, selector:, hasText: nil)
       @frame = frame
       @timeout_settings = timeout_settings
-      @selector = selector
+      @selector =
+        case hasText
+        when Regexp
+          source = EscapeWithQuotes.new(hasText.source, '"')
+          flags = []
+          flags << 'ms' if (hasText.options & Regexp::MULTILINE) != 0
+          flags << 'i' if (hasText.options & Regexp::IGNORECASE) != 0
+          "#{selector} >> :scope:text-matches(#{source}, \"#{flags.join('')}\")"
+        when String
+          text = EscapeWithQuotes.new(hasText, '"')
+          "#{selector} >> :scope:has-text(#{text})"
+        else
+          selector
+        end
     end
 
     def to_s
@@ -102,6 +139,27 @@ module Playwright
       @frame.dispatch_event(@selector, type, strict: true, eventInit: eventInit, timeout: timeout)
     end
 
+    def drag_to(target,
+          force: nil,
+          noWaitAfter: nil,
+          sourcePosition: nil,
+          targetPosition: nil,
+          timeout: nil,
+          trial: nil)
+
+      @frame.drag_and_drop(
+        @selector,
+        target.instance_variable_get(:@selector),
+        force: force,
+        noWaitAfter: noWaitAfter,
+        sourcePosition: sourcePosition,
+        targetPosition: targetPosition,
+        timeout: timeout,
+        trial: trial,
+        strict: true,
+      )
+    end
+
     def evaluate(expression, arg: nil, timeout: nil)
       with_element(timeout: timeout) do |handle|
         handle.evaluate(expression, arg: arg)
@@ -122,11 +180,12 @@ module Playwright
       @frame.fill(@selector, value, strict: true, force: force, noWaitAfter: noWaitAfter, timeout: timeout)
     end
 
-    def locator(selector)
+    def locator(selector, hasText: nil)
       LocatorImpl.new(
         frame: @frame,
         timeout_settings: @timeout_settings,
         selector: "#{@selector} >> #{selector}",
+        hasText: hasText,
       )
     end
 

data/lib/playwright/tracing_impl.rb

@@ -20,21 +20,35 @@ module Playwright
     end
 
     def stop_chunk(path: nil)
-      do_stop_chunk(path: path)
+      do_stop_chunk(file_path: path)
     end
 
     def stop(path: nil)
-      do_stop_chunk(path: path)
+      do_stop_chunk(file_path: path)
       @channel.send_message_to_server('tracingStop')
     end
 
-    private def do_stop_chunk(path:)
-      result = @channel.send_message_to_server_result('tracingStopChunk', save: !path.nil?, skipCompress: false)
-      artifact = ChannelOwners::Artifact.from_nullable(result['artifact'])
-      return unless artifact
+    private def do_stop_chunk(file_path:)
+      mode = 'doNotSave'
+      if file_path
+        if @context.send(:remote_connection?)
+          mode = 'compressTrace'
+        else
+          mode = 'compressTraceAndSources'
+        end
+      end
 
-      artifact.save_as(path)
+      result = @channel.send_message_to_server_result('tracingStopChunk', mode: mode)
+      return unless file_path # Not interested in artifacts.
+      return unless result['artifact'] # The artifact may be missing if the browser closed while stopping tracing.
+
+      artifact = ChannelOwners::Artifact.from(result['artifact'])
+      artifact.save_as(file_path)
       artifact.delete
+
+      # // Add local sources to the remote trace if necessary.
+      # if (result.sourceEntries?.length)
+      #   await this._context._localUtils.zip(filePath, result.sourceEntries);
     end
   end
 end

data/lib/playwright/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Playwright
-  VERSION = '1.17.beta1'
-  COMPATIBLE_PLAYWRIGHT_VERSION = '1.17.0'
+  VERSION = '1.18.1'
+  COMPATIBLE_PLAYWRIGHT_VERSION = '1.18.1'
 end

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

@@ -164,20 +164,14 @@ module Playwright
       raise NotImplementedError.new('web_views is not implemented yet.')
     end
 
-    # @nodoc
-    def tree
-      wrap_impl(@impl.tree)
-    end
-
     # @nodoc
     def tap_on(selector, duration: nil, timeout: nil)
       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)
+    def tree
+      wrap_impl(@impl.tree)
     end
 
     # -- inherited from EventEmitter --
@@ -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.rb

@@ -0,0 +1,20 @@
+module Playwright
+  # Exposes API that can be used for the Web API testing. Each Playwright browser context has a APIRequestContext instance
+  # attached which shares cookies with the page context. Its also possible to create a new APIRequestContext instance
+  # manually. For more information see [here](./class-apirequestcontext).
+  class APIRequest < PlaywrightApi
+
+    # Creates new instances of `APIRequestContext`.
+    def new_context(
+          baseURL: nil,
+          extraHTTPHeaders: nil,
+          httpCredentials: nil,
+          ignoreHTTPSErrors: nil,
+          proxy: nil,
+          storageState: nil,
+          timeout: nil,
+          userAgent: nil)
+      raise NotImplementedError.new('new_context is not implemented yet.')
+    end
+  end
+end