playwright-ruby-client 1.17.0 → 1.18.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35d4a4e4ac3aa460997a5a9cd44b5272142ba89b480908f0e429fb97d7968337
-  data.tar.gz: 2a577b8683a2eba60ed97b88b183bd351477cbde0874b8d06d287be0ec4664e8
+  metadata.gz: 36a3c1f293b4d9a4a27ac780ebce4eb4098af2cefeba6d4e66f4ddb8c49490d7
+  data.tar.gz: 3520c8afc689c71a27d9af6516461cb1871a206bc6c416aee5f99742217191c8
 SHA512:
-  metadata.gz: 283b87141e9ab9090488684973741983506da16d9ea991945589a1177cd99a5cf2c3b65b35770cc95a6ed3645514c35c9925e75aaffb949d58cbe6a47380c334
-  data.tar.gz: 7a6071b83e537784b58e6b350c1654a7dfa90bc99576f8ae1780c2104b30242ddd2e9651f6eb9f880a3a777e9345a5706373fbd66b64cc32739ce10cb389b5fb
+  metadata.gz: 69a7ff8c2880d9ce5bad599f102e5a0c4e710eaa25f9d5c9323cbd579cfaac6a4252eef9321a0ee453f0200fb2ac985f79f00c5ddb5717549a8d78c5f3348afe
+  data.tar.gz: b589f69e462f5dfba205af8ee98cb58a6bcb35b4ea6742fa8bd3f3bc26e4783e9ee7cbed2fe8dced6272c64de144465d767b00859e32f602ecb08b28b2cfc399

data/documentation/docs/api/api_request_context.md

@@ -8,3 +8,52 @@ This API is used for the Web API testing. You can use it to trigger API endpoint
 environment or the service to your e2e test. When used on [Page](./page) or a [BrowserContext](./browser_context), this API will automatically use
 the cookies from the corresponding [BrowserContext](./browser_context). This means that if you log in using this API, your e2e test will be
 logged in and vice versa.
+
+```python sync title=example_6db210740dd2dcb4551c2207b3204fde7127b24c7850226b273d15c0d6624ba5.py
+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"}'
+
+```
+

data/documentation/docs/api/download.md

@@ -19,9 +19,7 @@ end
 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.
+
 
 ## cancel
 

data/documentation/docs/api/frame.md

@@ -549,7 +549,7 @@ considered not visible.
 ## locator
 
 ```
-def locator(selector)
+def locator(selector, hasText: nil)
 ```
 
 The method returns an element locator that can be used to perform actions in the frame. Locator is resolved to the

data/documentation/docs/api/frame_locator.md

@@ -26,6 +26,15 @@ page.frame_locator('.result-frame').locator('button').click
 page.frame_locator('.result-frame').first.locator('button').click
 ```
 
+**Converting Locator to FrameLocator**
+
+If you have a [Locator](./locator) object pointing to an `iframe` it can be converted to [FrameLocator](./frame_locator) using
+[`:scope`](https://developer.mozilla.org/en-US/docs/Web/CSS/:scope) CSS selector:
+
+```ruby
+frame_locator = locator.frame_locator(':scope')
+```
+
 
 
 ## first
@@ -56,7 +65,7 @@ Returns locator to the last matching frame.
 ## locator
 
 ```
-def locator(selector)
+def locator(selector, hasText: nil)
 ```
 
 The method finds an element matching the specified selector in the FrameLocator's subtree.

data/documentation/docs/api/locator.md

@@ -4,53 +4,10 @@ sidebar_position: 10
 
 # Locator
 
-Locator represents a view to the element(s) on the page. It captures the logic sufficient to retrieve the element at any
-given moment. Locator can be created with the [Page#locator](./page#locator) method.
-
-```ruby
-locator = page.locator("text=Submit")
-locator.click
-```
-
-The difference between the Locator and [ElementHandle](./element_handle) is that the latter points to a particular element, while Locator
-captures the logic of how to retrieve that element.
-
-In the example below, handle points to a particular DOM element on page. If that element changes text or is used by
-React to render an entirely different component, handle is still pointing to that very DOM element. This can lead to
-unexpected behaviors.
-
-```ruby
-handle = page.query_selector("text=Submit")
-handle.hover
-handle.click
-```
-
-With the locator, every time the `element` is used, up-to-date DOM element is located in the page using the selector. So
-in the snippet below, underlying DOM element is going to be located twice.
-
-```ruby
-locator = page.locator("text=Submit")
-locator.hover
-locator.click
-```
-
-**Strictness**
-
-Locators are strict. This means that all operations on locators that imply some target DOM element will throw if more
-than one element matches given selector.
-
-```ruby
-# Throws if there are several buttons in DOM:
-page.locator('button').click
-
-# Works because we explicitly tell locator to pick the first element:
-page.locator('button').first.click
-
-# Works because count knows what to do with multiple matches:
-page.locator('button').count
-```
-
+Locators are the central piece of Playwright's auto-waiting and retry-ability. In a nutshell, locators represent a way
+to find element(s) on the page at any moment. Locator can be created with the [Page#locator](./page#locator) method.
 
+[Learn more about locators](https://playwright.dev/python/docs/locators).
 
 ## all_inner_texts
 
@@ -220,6 +177,21 @@ element.dispatch_event("dragstart", eventInit: { dataTransfer: data_transfer })
 
 
 
+## drag_to
+
+```
+def drag_to(
+      target,
+      force: nil,
+      noWaitAfter: nil,
+      sourcePosition: nil,
+      targetPosition: nil,
+      timeout: nil,
+      trial: nil)
+```
+
+
+
 ## element_handle
 
 ```
@@ -458,7 +430,7 @@ Returns locator to the last matching element.
 ## locator
 
 ```
-def locator(selector)
+def locator(selector, hasText: nil)
 ```
 
 The method finds an element matching the specified selector in the [Locator](./locator)'s subtree.

data/documentation/docs/api/page.md

@@ -774,7 +774,7 @@ considered not visible.
 ## locator
 
 ```
-def locator(selector)
+def locator(selector, hasText: nil)
 ```
 
 The method returns an element locator that can be used to perform actions on the page. Locator is resolved to the

data/documentation/docs/include/api_coverage.md

@@ -331,6 +331,7 @@
 * accessibility
 * keyboard
 * mouse
+* ~~request~~
 * touchscreen
 
 ## BrowserContext
@@ -417,6 +418,7 @@
 * count
 * dblclick
 * dispatch_event
+* drag_to
 * element_handle
 * element_handles
 * evaluate
@@ -461,6 +463,9 @@
 * locator
 * nth
 
+## LocalUtils
+
+
 ## Android
 
 * devices

data/lib/playwright/channel_owners/browser_context.rb

@@ -358,5 +358,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)

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.0'
-  COMPATIBLE_PLAYWRIGHT_VERSION = '1.17.0'
+  VERSION = '1.18.beta1'
+  COMPATIBLE_PLAYWRIGHT_VERSION = '1.18.0'
 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_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
@@ -124,12 +171,6 @@ module Playwright
       raise NotImplementedError.new('storage_state is not implemented yet.')
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def once(event, callback)
@@ -142,6 +183,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.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

@@ -372,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
@@ -386,20 +386,14 @@ module Playwright
       wrap_impl(@impl.owner_page=(unwrap_impl(req)))
     end
 
-    # @nodoc
-    def pause
-      wrap_impl(@impl.pause)
-    end
-
     # @nodoc
     def options=(req)
       wrap_impl(@impl.options=(unwrap_impl(req)))
     end
 
-    # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
+    def enable_debug_console!
+      wrap_impl(@impl.enable_debug_console!)
     end
 
     # -- inherited from EventEmitter --
@@ -414,6 +408,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