Enable mobile emulation #527

duncan-bayne · 2025-03-21T00:55:06Z

There is a request on Cuprite to support mobile emulation: rubycdp/cuprite#216

A prerequisite for this is for Ferrum to support mobile: true in Page#resize. This PR adds that support.

Note that passing mobile: true also sets the screen resolution to that of an iPhone 14; see this comment. Perhaps there's a nicer way of doing this?

Merging this should let us close #94.

This provides an LSP interface to the codebase, allowing for easier navigation, searching, etc. in editors that support LSP.

This will make debugging rspec examples easier.

Note that when mobile is true, *both* mobile emulation and touch support are enabled. The spec checks whether mobile support has been enabled by checking for touch support with JavaScript.

This way we can use Cuprite to register a driver that in turn enables mobile emulation in the browser.

This is a bit hacky; ideally, a caller wouldn't both specify a non-mobile size *and* mobile: true.

Add details of resize and mobile behavior to the README. Note that the behaviour on height or width of 0 was pre-existing; I just documented it and added a spec.

duncan-bayne · 2025-03-24T00:30:05Z

lib/ferrum/page.rb

+          maxTouchPoints: 1
+        )
+
+        command(


I'm uncertain about this. Ideally the caller would always specify a mobile height, width, and scale factor. But in principle that doesn't always happen, so I decided to override them here.

Perhaps we should raise an exception if a height and width other than 0 are passed along with mobile: true?

Why setting it hard in the first place?

It isn't, but it's also surprising - if we didn't hard-code the resolution here, users would have to know:

That they need to set the resolution at the same time as enabling mobile, and

What the right resolution is for mobile devices.

Hence my suggestion that perhaps I should make this raise an exception if the user also passes height or width? That way it should be really clear.

The more I think about it, the more I like the exception idea - I'll add one in. LMK what you think.

Have made it raise an exception now, so the behaviour is:

context "when a width is passed" do it "raises an error" do expect do page.resize(width: 100, height: 0, mobile: true) end.to raise_error("specifying `mobile: true` causes automatic resizing to mobile dimensions") end end

After reviewing with @DanielHeath, will not implement hard-coded resizing in Ferrum, but instead provide common mobile devices in Cuprite to choose from.

duncan-bayne · 2025-03-24T00:30:52Z

spec/page_spec.rb

+      }
+    end
+
+    def is_mobile?


This doesn't really test whether mobile emulation is enabled, but I couldn't find a good way of doing that directly via JavaScript evaluation. So we use touch emulation as a proxy.

route · 2025-03-24T08:10:42Z

Gemfile

@@ -4,6 +4,7 @@ source "https://rubygems.org"

 gem "byebug", "~> 11.0", platforms: %i[mri mingw x64_mingw]
 gem "chunky_png", "~> 1.3"
+gem "debug", "~> 1.10", require: false, platform: :mri


Please remove unnecessary changes not related to Enable mobile emulation

Sure - would you like me to raise it as a separate PR? I found both deubgger and LSP support handy while developing this PR.

route · 2025-03-24T08:11:22Z

README.md

@@ -194,7 +194,7 @@ Ferrum::Browser.new(options)
  * `:proxy` (Hash) - Specify proxy settings, [read more](https://github.com/rubycdp/ferrum#proxy)
  * `:save_path` (String) - Path to save attachments with [Content-Disposition](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition) header.
  * `:env` (Hash) - Environment variables you'd like to pass through to the process
-
+  * `:mobile` (Boolean) - Specify whether to enable mobile emulation and touch UI.


I don't think we need flag for browser instantiation.

My intent was to expose this via driver registration, as per Selenium.

I have a draft PR open for Cuprite that uses this; see e.g.:

https://github.com/rubycdp/cuprite/pull/292/files#diff-89eebfcbc0f14b6d989517837ca1e94fce4e2ce9a03233641cd936f2b8d2ed94

Capybara.register_driver(:cuprite_mobile) do |app| options = { mobile: true } options.merge!(inspector: true) if ENV["INSPECTOR"] options.merge!(logger: StringIO.new) if ENV["CI"] options.merge!(headless: false) if ENV["HEADLESS"] == "false" Capybara::Cuprite::Driver.new(app, options) end

route · 2025-03-24T08:20:00Z

lib/ferrum/page.rb

+          maxTouchPoints: 1
+        )
+
+        command(


Why setting it hard in the first place?

This reverts commit 42184d6.

This reverts commit dd15f1a.

duncan-bayne · 2025-03-27T12:16:04Z

Moving this back to draft, for now, while I clean up following a move of the mobile specific stuff into Cuprite.

This should really live at the Cuprite level, emulating specific devices.

duncan-bayne · 2025-04-03T23:33:08Z

Okay I think this is good for review again :)

Note the new, improved, and not-hard-coded API. In Cuprite you'd do:

Capybara.register_driver :custom_cuprite_mobile do |app|
  mobile_cuprite_options = cuprite_options.merge(Capybara::Cuprite::Devices::IPHONE_14)
  Capybara::Cuprite::Driver.new(app, mobile_cuprite_options)
end

duncan-bayne added 7 commits March 20, 2025 14:32

Add ruby-lsp as an optional dependency

dd15f1a

This provides an LSP interface to the codebase, allowing for easier navigation, searching, etc. in editors that support LSP.

Add debug Gem

42184d6

This will make debugging rspec examples easier.

Add mobile support to Page

6312a9d

Note that when mobile is true, *both* mobile emulation and touch support are enabled. The spec checks whether mobile support has been enabled by checking for touch support with JavaScript.

Add documentation for mobile option

a071969

Add mobile to browser options

33b16bd

This way we can use Cuprite to register a driver that in turn enables mobile emulation in the browser.

Override the viewport size when mobile: true

d950aad

This is a bit hacky; ideally, a caller wouldn't both specify a non-mobile size *and* mobile: true.

Update README

6753f84

Add details of resize and mobile behavior to the README. Note that the behaviour on height or width of 0 was pre-existing; I just documented it and added a spec.

duncan-bayne force-pushed the 94-expose-mobile branch from f5aa29f to 6753f84 Compare March 21, 2025 01:02

Fix Rubocop offenses

024dcc8

duncan-bayne commented Mar 24, 2025

View reviewed changes

duncan-bayne marked this pull request as ready for review March 24, 2025 01:40

Tweak README to include mobile example

3dd7cc7

route reviewed Mar 24, 2025

View reviewed changes

duncan-bayne added 2 commits March 25, 2025 17:51

Revert "Add debug Gem"

5524262

This reverts commit 42184d6.

Revert "Add ruby-lsp as an optional dependency"

1560ecd

This reverts commit dd15f1a.

duncan-bayne mentioned this pull request Mar 25, 2025

Enable mobile emulation rubycdp/cuprite#292

Draft

duncan-bayne force-pushed the 94-expose-mobile branch 2 times, most recently from dffdd4e to 06ca9b4 Compare March 27, 2025 11:39

duncan-bayne marked this pull request as draft March 27, 2025 12:15

duncan-bayne force-pushed the 94-expose-mobile branch from 06ca9b4 to f6a5577 Compare March 27, 2025 12:19

Remove automatic resizing from Ferrum

bd578fb

This should really live at the Cuprite level, emulating specific devices.

duncan-bayne force-pushed the 94-expose-mobile branch from f6a5577 to bd578fb Compare March 27, 2025 12:20

duncan-bayne marked this pull request as ready for review April 3, 2025 23:32

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enable mobile emulation #527

Enable mobile emulation #527

duncan-bayne commented Mar 21, 2025 •

edited

Loading

duncan-bayne Mar 24, 2025

route Mar 24, 2025

duncan-bayne Mar 25, 2025

duncan-bayne Mar 25, 2025 •

edited

Loading

duncan-bayne Mar 25, 2025

duncan-bayne Mar 27, 2025

duncan-bayne Mar 24, 2025

route Mar 24, 2025

duncan-bayne Mar 25, 2025

route Mar 24, 2025

duncan-bayne Mar 25, 2025

route Mar 24, 2025

duncan-bayne commented Mar 27, 2025

duncan-bayne commented Apr 3, 2025

Enable mobile emulation #527

Are you sure you want to change the base?

Enable mobile emulation #527

Conversation

duncan-bayne commented Mar 21, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

duncan-bayne Mar 25, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

duncan-bayne commented Mar 27, 2025

duncan-bayne commented Apr 3, 2025

duncan-bayne commented Mar 21, 2025 •

edited

Loading

duncan-bayne Mar 25, 2025 •

edited

Loading