playwright-ruby-client 1.16.0 → 1.18.beta1

data/lib/playwright/channel_owners/fetch_request.rb

@@ -1,3 +1,5 @@
+require_relative './api_request_context'
+
 module Playwright
   module ChannelOwners
     class FetchRequest < APIRequestContext

data/lib/playwright/channel_owners/frame.rb

@@ -110,8 +110,8 @@ module Playwright
     def wait_for_load_state(state: nil, timeout: nil)
       option_state = state || 'load'
       option_timeout = timeout || @page.send(:timeout_settings).navigation_timeout
-      unless %w(load domcontentloaded networkidle).include?(option_state)
-        raise ArgumentError.new('state: expected one of (load|domcontentloaded|networkidle)')
+      unless %w(load domcontentloaded networkidle commit).include?(option_state)
+        raise ArgumentError.new('state: expected one of (load|domcontentloaded|networkidle|commit)')
       end
       if @load_states.include?(option_state)
         return
@@ -191,10 +191,6 @@ module Playwright
       @channel.send_message_to_server('isVisible', params)
     end
 
-    def locator(selector)
-      LocatorImpl.new(frame: self, timeout_settings: @page.send(:timeout_settings), selector: selector)
-    end
-
     def dispatch_event(selector, type, eventInit: nil, strict: nil, timeout: nil)
       params = {
         selector: selector,
@@ -404,6 +400,14 @@ module Playwright
       nil
     end
 
+    def locator(selector, hasText: nil)
+      LocatorImpl.new(frame: self, timeout_settings: @page.send(:timeout_settings), selector: selector, hasText: hasText)
+    end
+
+    def frame_locator(selector)
+      FrameLocatorImpl.new(frame: self, timeout_settings: @page.send(:timeout_settings), frame_selector: selector)
+    end
+
     def focus(selector, strict: nil, timeout: nil)
       params = { selector: selector, strict: strict, timeout: timeout }.compact
       @channel.send_message_to_server('focus', params)

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

@@ -138,9 +138,6 @@ module Playwright
 
     private def on_download(params)
       artifact = ChannelOwners::Artifact.from(params['artifact'])
-      if @browser_context.browser.send(:remote?)
-        artifact.update_as_remote
-      end
       download = DownloadImpl.new(
         page: self,
         url: params['url'],
@@ -152,9 +149,6 @@ module Playwright
 
     private def on_video(params)
       artifact = ChannelOwners::Artifact.from(params['artifact'])
-      if @browser_context.browser.send(:remote?)
-        artifact.update_as_remote
-      end
       video.send(:set_artifact, artifact)
     end
 
@@ -261,10 +255,6 @@ module Playwright
       @main_frame.visible?(selector, strict: strict, timeout: timeout)
     end
 
-    def locator(selector)
-      @main_frame.locator(selector)
-    end
-
     def dispatch_event(selector, type, eventInit: nil, strict: nil, timeout: nil)
       @main_frame.dispatch_event(selector, type, eventInit: eventInit, strict: strict, timeout: timeout)
     end
@@ -568,6 +558,14 @@ module Playwright
         timeout: timeout)
     end
 
+    def locator(selector, hasText: nil)
+      @main_frame.locator(selector, hasText: hasText)
+    end
+
+    def frame_locator(selector)
+      @main_frame.frame_locator(selector)
+    end
+
     def focus(selector, strict: nil, timeout: nil)
       @main_frame.focus(selector, strict: strict, timeout: timeout)
     end
@@ -925,6 +923,11 @@ module Playwright
       @workers.delete(worker)
     end
 
+    # called from Video
+    private def remote_connection?
+      @connection.remote?
+    end
+
     # Expose guid for library developers.
     # Not intended to be used by users.
     def guid

data/lib/playwright/connection.rb

@@ -21,6 +21,15 @@ module Playwright
       @waiting_for_object = {} # Hash[ guid => Promise<ChannelOwner> ]
       @callbacks = {} # Hash [ guid => Promise<ChannelOwner> ]
       @root_object = RootChannelOwner.new(self)
+      @remote = false
+    end
+
+    def mark_as_remote
+      @remote = true
+    end
+
+    def remote?
+      @remote
     end
 
     def async_run

data/lib/playwright/frame_locator_impl.rb

@@ -0,0 +1,50 @@
+module Playwright
+  define_api_implementation :FrameLocatorImpl do
+    def initialize(frame:, timeout_settings:, frame_selector:)
+      @frame = frame
+      @timeout_settings = timeout_settings
+      @frame_selector = frame_selector
+    end
+
+    def locator(selector, hasText: nil)
+      LocatorImpl.new(
+        frame: @frame,
+        timeout_settings: @timeout_settings,
+        selector: "#{@frame_selector} >> control=enter-frame >> #{selector}",
+        hasText: hasText,
+      )
+    end
+
+    def frame_locator(selector)
+      FrameLocatorImpl.new(
+        frame: @frame,
+        timeout_settings: @timeout_settings,
+        frame_selector: "#{@frame_selector} >> control=enter-frame >> #{selector}",
+      )
+    end
+
+    def first
+      FrameLocatorImpl.new(
+        frame: @frame,
+        timeout_settings: @timeout_settings,
+        frame_selector: "#{@frame_selector} >> nth=0",
+      )
+    end
+
+    def last
+      FrameLocatorImpl.new(
+        frame: @frame,
+        timeout_settings: @timeout_settings,
+        frame_selector: "#{@frame_selector} >> nth=-1",
+      )
+    end
+
+    def nth(index)
+      FrameLocatorImpl.new(
+        frame: @frame,
+        timeout_settings: @timeout_settings,
+        frame_selector: "#{@frame_selector} >> nth=#{index}",
+      )
+    end
+  end
+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
@@ -11,17 +48,17 @@ module Playwright
     end
 
     private def with_element(timeout: nil, &block)
+      timeout_or_default = @timeout_settings.timeout(timeout)
       start_time = Time.now
 
-      handle = @frame.wait_for_selector(@selector, strict: true, state: 'attached', timeout: timeout)
+      handle = @frame.wait_for_selector(@selector, strict: true, state: 'attached', timeout: timeout_or_default)
       unless handle
         raise "Could not resolve #{@selector} to DOM Element"
       end
 
-      call_options = {}
-      if timeout
-        call_options[:timeout] = (timeout - (Time.now - start_time) * 1000).to_i
-      end
+      call_options = {
+        timeout: (timeout_or_default - (Time.now - start_time) * 1000).to_i,
+      }
 
       begin
         block.call(handle, call_options)
@@ -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,20 @@ 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
+
+    def frame_locator(selector)
+      FrameLocatorImpl.new(
+        frame: @frame,
+        timeout_settings: @timeout_settings,
+        frame_selector: "#{@selector} >> #{selector}",
       )
     end
 

data/lib/playwright/tracing_impl.rb

@@ -5,39 +5,50 @@ module Playwright
       @context = context
     end
 
-    def start(name: nil, screenshots: nil, snapshots: nil)
+    def start(name: nil, title: nil, screenshots: nil, snapshots: nil)
       params = {
         name: name,
         screenshots: screenshots,
         snapshots: snapshots,
       }.compact
       @channel.send_message_to_server('tracingStart', params)
-      @channel.send_message_to_server('tracingStartChunk')
+      @channel.send_message_to_server('tracingStartChunk', { title: title }.compact)
     end
 
-    def start_chunk
-      @channel.send_message_to_server('tracingStartChunk')
+    def start_chunk(title: nil)
+      @channel.send_message_to_server('tracingStartChunk', { title: title }.compact)
     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:)
-      resp = @channel.send_message_to_server('tracingStopChunk', save: !path.nil?)
-      artifact = ChannelOwners::Artifact.from_nullable(resp)
-      return unless artifact
-
-      if @context.browser.send(:remote?)
-        artifact.update_as_remote
+    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.16.0'
-  COMPATIBLE_PLAYWRIGHT_VERSION = '1.16.0'
+  VERSION = '1.18.beta1'
+  COMPATIBLE_PLAYWRIGHT_VERSION = '1.18.0'
 end

data/lib/playwright/video.rb

@@ -22,6 +22,9 @@ module Playwright
     end
 
     def path
+      if @page.send(:remote_connection?)
+        raise 'Path is not available when using browserType.connect(). Use save_as() to save a local copy.'
+      end
       wait_for_artifact_and do |artifact|
         artifact.absolute_path
       end

data/lib/playwright.rb

@@ -135,13 +135,14 @@ module Playwright
 
     transport = WebSocketTransport.new(ws_endpoint: ws_endpoint)
     connection = Connection.new(transport)
+    connection.mark_as_remote
     connection.async_run
 
     execution =
       begin
         playwright = connection.initialize_playwright
         browser = playwright.send(:pre_launched_browser)
-        browser.send(:update_as_remote)
+        browser.should_close_connection_on_close!
         Execution.new(connection, PlaywrightApi.wrap(playwright), PlaywrightApi.wrap(browser))
       rescue
         connection.stop

data/lib/playwright_api/android_device.rb

@@ -165,13 +165,13 @@ module Playwright
     end
 
     # @nodoc
-    def tree
-      wrap_impl(@impl.tree)
+    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
 
     # @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)))
+    def tree
+      wrap_impl(@impl.tree)
     end
 
     # -- inherited from EventEmitter --

data/lib/playwright_api/api_request_context.rb

@@ -3,6 +3,53 @@ module Playwright
   # 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.
+  #
+  # ```python sync
+  # import os
+  # from playwright.sync_api import sync_playwright
+  #
+  # REPO = "test-repo-1"
+  # USER = "github-username"
+  # API_TOKEN = os.getenv("GITHUB_API_TOKEN")
+  #
+  # with sync_playwright() as p:
+  #     # This will launch a new browser, create a context and page. When making HTTP
+  #     # requests with the internal APIRequestContext (e.g. `context.request` or `page.request`)
+  #     # it will automatically set the cookies to the browser page and vise versa.
+  #     browser = playwright.chromium.launch()
+  #     context = browser.new_context(base_url="https://api.github.com")
+  #     api_request_context = context.request
+  #     page = context.new_page()
+  #
+  #     # Alternatively you can create a APIRequestContext manually without having a browser context attached:
+  #     # api_request_context = playwright.request.new_context(base_url="https://api.github.com")
+  #
+  #
+  #     # Create a repository.
+  #     response = api_request_context.post(
+  #         "/user/repos",
+  #         headers={
+  #             "Accept": "application/vnd.github.v3+json",
+  #             # Add GitHub personal access token.
+  #             "Authorization": f"token {API_TOKEN}",
+  #         },
+  #         data={"name": REPO},
+  #     )
+  #     assert response.ok
+  #     assert response.json()["name"] == REPO
+  #
+  #     # Delete a repository.
+  #     response = api_request_context.delete(
+  #         f"/repos/{USER}/{REPO}",
+  #         headers={
+  #             "Accept": "application/vnd.github.v3+json",
+  #             # Add GitHub personal access token.
+  #             "Authorization": f"token {API_TOKEN}",
+  #         },
+  #     )
+  #     assert response.ok
+  #     assert await response.body() == '{"status": "ok"}'
+  # ```
   class APIRequestContext < PlaywrightApi
 
     # Sends HTTP(S) [DELETE](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/DELETE) request and returns its
@@ -10,9 +57,12 @@ module Playwright
     # method will automatically follow redirects.
     def delete(
           url,
+          data: nil,
           failOnStatusCode: nil,
+          form: nil,
           headers: nil,
           ignoreHTTPSErrors: nil,
+          multipart: nil,
           params: nil,
           timeout: nil)
       raise NotImplementedError.new('delete is not implemented yet.')

data/lib/playwright_api/browser_context.rb

@@ -20,6 +20,11 @@ module Playwright
   # ```
   class BrowserContext < PlaywrightApi
 
+    # API testing helper associated with this context. Requests made with this API will use context cookies.
+    def request # property
+      raise NotImplementedError.new('request is not implemented yet.')
+    end
+
     def tracing # property
       wrap_impl(@impl.tracing)
     end
@@ -367,8 +372,8 @@ module Playwright
     end
 
     # @nodoc
-    def enable_debug_console!
-      wrap_impl(@impl.enable_debug_console!)
+    def pause
+      wrap_impl(@impl.pause)
     end
 
     # @nodoc
@@ -382,13 +387,13 @@ module Playwright
     end
 
     # @nodoc
-    def pause
-      wrap_impl(@impl.pause)
+    def options=(req)
+      wrap_impl(@impl.options=(unwrap_impl(req)))
     end
 
     # @nodoc
-    def options=(req)
-      wrap_impl(@impl.options=(unwrap_impl(req)))
+    def enable_debug_console!
+      wrap_impl(@impl.enable_debug_console!)
     end
 
     # -- inherited from EventEmitter --

data/lib/playwright_api/download.rb

@@ -12,10 +12,6 @@ module Playwright
   # # wait for download to complete
   # path = download.path()
   # ```
-  #
-  # > NOTE: Browser context **must** be created with the `acceptDownloads` set to `true` when user needs access to the
-  # downloaded content. If `acceptDownloads` is not set, download events are emitted, but the actual download is not
-  # performed and user has no access to the downloaded files.
   class Download < PlaywrightApi
 
     # Cancels a download. Will not fail if the download is already finished or canceled. Upon successful cancellations,

data/lib/playwright_api/element_handle.rb

@@ -6,6 +6,8 @@ module Playwright
   # ElementHandle represents an in-page DOM element. ElementHandles can be created with the [`method: Page.querySelector`]
   # method.
   #
+  # > NOTE: The use of ElementHandle is discouraged, use `Locator` objects and web-first assertions instead.
+  #
   # ```python sync
   # href_element = page.query_selector("a")
   # href_element.click()
@@ -17,9 +19,6 @@ module Playwright
   # ElementHandle instances can be used as an argument in [`method: Page.evalOnSelector`] and [`method: Page.evaluate`]
   # methods.
   #
-  # > NOTE: In most cases, you would want to use the `Locator` object instead. You should only use `ElementHandle` if you
-  # want to retain a handle to a particular DOM Node that you intend to pass into [`method: Page.evaluate`] as an argument.
-  #
   # The difference between the `Locator` and ElementHandle is that the ElementHandle points to a particular element, while
   # `Locator` captures the logic of how to retrieve an element.
   #

data/lib/playwright_api/frame.rb

@@ -183,6 +183,9 @@ module Playwright
 
     # Returns the return value of `expression`.
     #
+    # > NOTE: This method does not wait for the element to pass actionability checks and therefore can lead to the flaky
+    # tests. Use [`method: Locator.evaluate`], other `Locator` helper methods or web-first assertions instead.
+    #
     # The method finds an element matching the specified selector within the frame and passes it as a first argument to
     # `expression`. See [Working with selectors](./selectors.md) for more details. If no elements match the selector, the
     # method throws an error.
@@ -203,6 +206,9 @@ module Playwright
 
     # Returns the return value of `expression`.
     #
+    # > NOTE: In most cases, [`method: Locator.evaluateAll`], other `Locator` helper methods and web-first assertions do a
+    # better job.
+    #
     # The method finds all elements matching the specified selector within the frame and passes an array of matched elements
     # as a first argument to `expression`. See [Working with selectors](./selectors.md) for more details.
     #
@@ -243,7 +249,7 @@ module Playwright
     # `ElementHandle` instances can be passed as an argument to the [`method: Frame.evaluate`]:
     #
     # ```python sync
-    # body_handle = frame.query_selector("body")
+    # body_handle = frame.evaluate("document.body")
     # html = frame.evaluate("([body, suffix]) => body.innerHTML + suffix", [body_handle, "hello"])
     # body_handle.dispose()
     # ```
@@ -324,6 +330,18 @@ module Playwright
       wrap_impl(@impl.frame_element)
     end
 
+    # When working with iframes, you can create a frame locator that will enter the iframe and allow selecting elements in
+    # that iframe. Following snippet locates element with text "Submit" in the iframe with id `my-frame`, like `<iframe
+    # id="my-frame">`:
+    #
+    # ```python sync
+    # locator = frame.frame_locator("#my-iframe").locator("text=Submit")
+    # locator.click()
+    # ```
+    def frame_locator(selector)
+      wrap_impl(@impl.frame_locator(unwrap_impl(selector)))
+    end
+
     # Returns element attribute value.
     def get_attribute(selector, name, strict: nil, timeout: nil)
       wrap_impl(@impl.get_attribute(unwrap_impl(selector), unwrap_impl(name), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout)))
@@ -427,8 +445,8 @@ module Playwright
     # The method returns an element locator that can be used to perform actions in the frame. Locator is resolved to the
     # element immediately before performing an action, so a series of actions on the same locator can in fact be performed on
     # different DOM elements. That would happen if the DOM structure between those actions has changed.
-    def locator(selector)
-      wrap_impl(@impl.locator(unwrap_impl(selector)))
+    def locator(selector, hasText: nil)
+      wrap_impl(@impl.locator(unwrap_impl(selector), hasText: unwrap_impl(hasText)))
     end
 
     # Returns frame's name attribute as specified in the tag.
@@ -478,6 +496,8 @@ module Playwright
 
     # Returns the ElementHandle pointing to the frame element.
     #
+    # > NOTE: The use of `ElementHandle` is discouraged, use `Locator` objects and web-first assertions instead.
+    #
     # The method finds an element matching the specified selector within the frame. See
     # [Working with selectors](./selectors.md) for more details. If no elements match the selector, returns `null`.
     def query_selector(selector, strict: nil)
@@ -486,6 +506,8 @@ module Playwright
 
     # Returns the ElementHandles pointing to the frame elements.
     #
+    # > NOTE: The use of `ElementHandle` is discouraged, use `Locator` objects instead.
+    #
     # The method finds all elements matching the specified selector within the frame. See
     # [Working with selectors](./selectors.md) for more details. If no elements match the selector, returns empty array.
     def query_selector_all(selector)
@@ -714,6 +736,9 @@ module Playwright
     # Returns when element specified by selector satisfies `state` option. Returns `null` if waiting for `hidden` or
     # `detached`.
     #
+    # > NOTE: Playwright automatically waits for element to be ready before performing an action. Using `Locator` objects and
+    # web-first assertions make the code wait-for-selector-free.
+    #
     # Wait for the `selector` to satisfy `state` option (either appear/disappear from dom, or become visible/hidden). If at
     # the moment of calling the method `selector` already satisfies the condition, the method will return immediately. If the
     # selector doesn't satisfy the condition for the `timeout` milliseconds, the function will throw.