chore: WebKit support (development-only) #15533

flotwig · 2021-03-16T22:39:59Z

For Safari (WebKit) Support #6422

User facing changelog

n/a - does not expose WebKit in production yet, only in development

Additional details

This PR adds development-only support for the WebKit browser. It will detect playwright-webkit installed in a project and if it is found, it will be made available in Cypress as --browser webkit
See Safari (WebKit) Support #6422 for remaining work - trying to keep PRs in this epic small since there's a lot to parse

Pre-merge tasks:

Merge with latest develop
Add driver test CI job
Double-check that --headless works w/o Xvfb

How has the user experience changed?

In development only, WebKit will be detected in run/open mode if playwright-webkit is installed.

PR Tasks

Have tests been added/updated?
- Only tests relating to browser detection have been added/updated. Future test updates will come as remaining functionality is fixed, see Safari (WebKit) Support #6422 for details.
[na] Has the original issue or this PR been tagged with a release in ZenHub?
[na] Has a PR for user-facing changes been opened in cypress-documentation?
[na] Have API changes been updated in the type definitions?
- Public type changes will come in the last PR for experimentalWebKitSupport, see Safari (WebKit) Support #6422

Co-authored-by: Weyert de Boer [email protected]

cypress-bot · 2021-03-16T22:40:01Z

Thanks for taking the time to open a PR!

Create a Draft Pull Request if your PR is not ready for review. Mark the PR as Ready for Review when you're ready for a Cypress team member to review the PR.
Become familiar with the Code Review Checklist for guidelines on coding standards and what needs to be done before a PR can be merged.

jonatan-mobal · 2022-06-14T11:40:08Z

Any updates on this?

cypress · 2022-08-08T19:10:18Z

Test summary

37828 • 0 • 615 • 0 • 7

Run details


Project	cypress
Status	Passed
Commit	`ac70fc8`
Started	Aug 15, 2022 10:39 PM
Ended	Aug 15, 2022 11:01 PM
Duration	21:41 💡
OS	Linux Debian - 11.3
Browser	Multiple

View run in Cypress Dashboard ➡️

Flakiness

	cypress/e2e/commands/net_stubbing.cy.ts		5
1	network stubbing > intercepting request > can delay with deprecated delayMs param
2	network stubbing > intercepting request > can delay with deprecated delayMs param
3	network stubbing > intercepting request > can delay with deprecated delayMs param
4	network stubbing > intercepting request > can delay with deprecated delayMs param
5	network stubbing > intercepting request > can delay with deprecated delayMs param
This comment includes only the first 5 flaky tests. See all 7 flaky tests in the Cypress Dashboard.

This comment has been generated by cypress-bot as a result of this project's GitHub integration settings. You can manage this integration in this project's settings in the Cypress Dashboard

packages/app/src/runner/index.ts

lmiller1990 · 2022-08-10T05:14:50Z

Still going over the code, but I took it for a test drive. It functions like it should, but I am noticing everything in the webkit driver is kind of blurry.

Compare the text from GH (left) and the spec list (right). I am guessing this isn't on our end, but the webkit-playwright code? Either way, users might notice this - we might want to include a note in the experimental release (unless the bug is localised to my machine?)

I am on an M1 running under arm64 if that is relevant.

I will continue the code review tomorrow. I am excited for WebKit support!

Image: text in webkit browser is a bit blurry (compare to address bar or GH text in background).

lmiller1990

I'm still working through the code - posted my finding so far, but functionality seems to work as expected.

tbiethman · 2022-08-10T15:01:19Z

@lmiller1990 I can confirm I see the same blurry rendering on my Macbook display, but it looks crisp on my external display (with a much lower pixel density).

flotwig · 2022-08-10T15:06:38Z

@lmiller1990 @tbiethman We check and set 2x pixel density on other browsers but not in WebKit. I can add it to the list of things to fix in the parent epic, but in the spirit of keeping this PR minimal let's not worry about it here. It seems like we can set devicePixelRatio, but not in browserType.launch, so it requires some further investigation as to how to do this with WebKit: https://playwright.dev/docs/api/class-browsertype#browser-type-launch-persistent-context

tbiethman · 2022-08-10T16:02:50Z

Code looks good in this initial state. Here are a couple functional findings that don't necessarily need to hold up this initial PR, but I'll let you be the judge:

macOS

Focus button in launchpad does not focus Webkit browser.
I'm seeing GraphQL errors that are only present within the Webkit browser. Both e2e/component testing projects seem to be effected, but it can take longer for the error to be presented in component tests.

Using the Tab key only seems to focus certain elements within the Webkit browser. I imagine this is related to the Safari setting to "Press Tab to highlight each item on a webpage", which must be enabled to behave similar to Chrome/Firefox. Not sure if there's a corresponding launch flag (or if this has any impact on our .focus() command)?

Windows

Seeing various failures in both e2e and component tests in our internal projects. I'm sure there are incompatibilities we'll want to document, not sure if these are known about or not:

flotwig · 2022-08-10T16:58:53Z

@tbiethman Thanks for the detailed feedback!

* `Focus` button in launchpad does not focus Webkit browser.

Marked it as "less critical" here: #6422 I'm using page.bringToFront to focus but it seems to not behave the same as Chrome.

* I'm seeing GraphQL errors that are only present within the Webkit browser. Both e2e/component testing projects seem to be effected, but it can take longer for the error to be presented in component tests.

Added as a must-fix to #6422

* Using the Tab key only seems to focus certain elements within the Webkit browser. I imagine this is related to the Safari setting to "Press Tab to highlight each item on a webpage", which must be enabled to behave similar to Chrome/Firefox. Not sure if there's a corresponding launch flag (or if this has any impact on our `.focus()` command)?

I have noticed some failures in the driver tests related to focus, thanks for the tip on this. I'll keep this in mind when looking at those.

* Seeing various failures in both e2e and component tests in our internal projects. I'm sure there are incompatibilities we'll want to document, not sure if these are known about or not:

Not known to me yet - I've been working on fixing the driver tests first before checking out other projects, since that should resolve most common issues. I plan on also adding certain system-tests. Limitations that come from those will be documented.

packages/app/src/runner/index.ts

lmiller1990

Left some comments, they are mainly related to style, though - still trying the functionality out.

packages/server/lib/browsers/utils.ts

packages/server/lib/browsers/webkit-automation.ts

packages/server/lib/browsers/webkit.ts

lmiller1990 · 2022-08-11T03:04:27Z

I found something strange. I don't think it needs to block this, but if I start run mode, then cancel it mid-run, global mode opens after a few seconds.

It's also kind of slow (I guess this is just how it is, at least for now). Since this is development only, I think it's fine to merge up, I'll keep posting things I notice as I continue to play around with it (which will be easier once it's merged).

bug.mov

lmiller1990

Left some potential improvements to code and noted a weird bug I encountered.

flotwig · 2022-08-15T18:24:26Z

@lmiller1990 I've noticed that too. Haven't been able to track it down yet, but it's super annoying. I have it captured as a must-fix here: #6422

weyert · 2022-08-22T09:09:42Z

Any plans to mention my name when release this feature?

BlueWinds · 2022-08-22T13:52:12Z

@weyert - Traditionally we'd do something like this: https://docs.cypress.io/api/commands/selectFile#Community-Recognition. @flotwig - I don't see that we have a docs PR for this, just a reasonable reminder to make sure we mention community contributions when it's ready!

flotwig · 2022-08-22T14:52:00Z

Any plans to mention my name when release this feature?

@weyert I was planning on it, since this does use your initial approach of driving PW. I actually meant to have you as a Co-authored-by on this PR but I guess I managed to merge without including the PR message in the commit message - oops. I'll credit you in the release announcement and docs, unless you don't want to be recognized.

weyert · 2022-08-22T15:20:33Z

I would greatly appreciate that, if you would do that. Thank you 🤗❤️

flotwig and others added 3 commits March 16, 2021 17:56

detect playwright-webkit browser

de8e6c3

fix: use stdio for CDP instead of TCP (#14348)

d0d1736

wip: begin launchin webkit

818c7de

jennifer-shehane mentioned this pull request Mar 27, 2021

Safari (WebKit) Support #6422

Closed

21 tasks

weyert mentioned this pull request Aug 16, 2021

feat: Add playwright support #17002

Closed

5 tasks

flotwig added 3 commits August 2, 2022 16:25

Merge remote-tracking branch 'origin/develop' into cy-webkit

a7279e5

run mode works w webkit in 10.0

45b5286

reset previous cdp changes

ecd6f0f

flotwig force-pushed the cy-webkit branch from 52a8fc7 to ecd6f0f Compare August 4, 2022 18:03

run driver webkit tests

505c0dd

flotwig force-pushed the cy-webkit branch from ba3cd1e to dbd9246 Compare August 4, 2022 19:04

flotwig added 3 commits August 5, 2022 13:12

always detect webkit in non-prod

35b4039

fix version detection

ceba06f

actually run new job

68ebaca

flotwig force-pushed the cy-webkit branch from 2ff6f0d to 68ebaca Compare August 5, 2022 17:22

flotwig added 6 commits August 5, 2022 13:24

Merge remote-tracking branch 'origin/develop' into cy-webkit

a5a0fc6

cleanup

f974e99

fix run

25b8fc9

try caching pw binary

411a2f1

npx install pw binary

83c58d5

install-deps

def14cc

flotwig force-pushed the cy-webkit branch from b5103f9 to def14cc Compare August 5, 2022 18:39

flotwig added 2 commits August 5, 2022 14:58

add experimentalSessionAndOrigin wk tests

e85025c

wk experimentalSessionAndOrigin tests

53db500

flotwig requested review from tbiethman and BlueWinds August 8, 2022 15:38

flotwig added 2 commits August 8, 2022 13:13

browser icon

12b3cab

fix some tests

37de56a

fix websockets_spec

406d8ec

flotwig marked this pull request as ready for review August 8, 2022 20:11

flotwig requested review from a team as code owners August 8, 2022 20:11

tbiethman reviewed Aug 9, 2022

View reviewed changes

packages/app/src/runner/index.ts Show resolved Hide resolved

flotwig mentioned this pull request Aug 9, 2022

chore(webkit): fix WebKit network-related driver tests #23232

Merged

2 tasks

lmiller1990 reviewed Aug 10, 2022

View reviewed changes

lmiller1990 requested a review from a team August 10, 2022 10:42

tbiethman approved these changes Aug 10, 2022

View reviewed changes

lmiller1990 reviewed Aug 11, 2022

View reviewed changes

packages/app/src/runner/index.ts Show resolved Hide resolved

lmiller1990 reviewed Aug 11, 2022

View reviewed changes

lmiller1990 self-requested a review August 11, 2022 03:04

lmiller1990 approved these changes Aug 11, 2022

View reviewed changes

flotwig added 2 commits August 15, 2022 14:31

Suggestions from code review

9ac53fd

Merge branch 'develop' into cy-webkit

ac70fc8

flotwig merged commit 4580330 into develop Aug 15, 2022

flotwig deleted the cy-webkit branch August 15, 2022 22:53

lmiller1990 mentioned this pull request Jul 11, 2023

Issue with Github Actions not closing/finishing when testing with playwright-webkit (Safari) #27141

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: WebKit support (development-only) #15533

chore: WebKit support (development-only) #15533

flotwig commented Mar 16, 2021 •

edited

Loading

cypress-bot bot commented Mar 16, 2021

jonatan-mobal commented Jun 14, 2022

cypress bot commented Aug 8, 2022 •

edited

Loading

lmiller1990 commented Aug 10, 2022 •

edited

Loading

lmiller1990 left a comment

tbiethman commented Aug 10, 2022

flotwig commented Aug 10, 2022

tbiethman commented Aug 10, 2022 •

edited

Loading

flotwig commented Aug 10, 2022

lmiller1990 left a comment

lmiller1990 commented Aug 11, 2022

lmiller1990 left a comment

flotwig commented Aug 15, 2022

weyert commented Aug 22, 2022

BlueWinds commented Aug 22, 2022

flotwig commented Aug 22, 2022

weyert commented Aug 22, 2022

chore: WebKit support (development-only) #15533

chore: WebKit support (development-only) #15533

Conversation

flotwig commented Mar 16, 2021 • edited Loading

User facing changelog

Additional details

How has the user experience changed?

PR Tasks

cypress-bot bot commented Mar 16, 2021

jonatan-mobal commented Jun 14, 2022

cypress bot commented Aug 8, 2022 • edited Loading

Test summary

Run details

Flakiness

lmiller1990 commented Aug 10, 2022 • edited Loading

Image: text in webkit browser is a bit blurry (compare to address bar or GH text in background).

lmiller1990 left a comment

Choose a reason for hiding this comment

tbiethman commented Aug 10, 2022

flotwig commented Aug 10, 2022

tbiethman commented Aug 10, 2022 • edited Loading

flotwig commented Aug 10, 2022

lmiller1990 left a comment

Choose a reason for hiding this comment

lmiller1990 commented Aug 11, 2022

lmiller1990 left a comment

Choose a reason for hiding this comment

flotwig commented Aug 15, 2022

weyert commented Aug 22, 2022

BlueWinds commented Aug 22, 2022

flotwig commented Aug 22, 2022

weyert commented Aug 22, 2022

flotwig commented Mar 16, 2021 •

edited

Loading

cypress bot commented Aug 8, 2022 •

edited

Loading

lmiller1990 commented Aug 10, 2022 •

edited

Loading

tbiethman commented Aug 10, 2022 •

edited

Loading