Playwright: browser improvements, update #298944

phaer · 2024-03-25T14:58:04Z

Description of changes

Support Firefox & Webkit tests on NixOS (and Ubuntu, i.e. in github actions) - previously only Chromium was supported.
Add data from browsers.json to nixpkgs via update.sh
in order to use patched upstream browsers without IFD
Use autoPatchElfHook to make those browsers run on nixos
Reuses attrs from pkgs.firefox-bin for firefox
browser hashes are updated via update.sh
theres a new nixos vm test for all 3 supported browsers.

TODO long term

Consider using the same approach on darwin, where browser builds are currently impure (using playwright install)
check playwrights browsers patches and consider using nixpkgs browsers to build from source, instead of pulling binaries for firefox, webkit and ffmpeg

Things done

Add a 👍 reaction to pull requests you find important.

pkgs/development/web/playwright/firefox.nix

phaer · 2024-04-02T13:51:03Z

EDIT: Nevermind, I messed up. Going to push a fix right after local tests pass.

nixos-discourse · 2024-04-03T12:09:04Z

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/running-playwright-tests/25655/28

pkgs/development/web/playwright-test/default.nix

nixos-discourse · 2024-05-12T08:09:33Z

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/prs-already-reviewed/2617/1632

wmertens · 2024-05-25T05:20:24Z

LGTM - any reason why this isn't merged? (apart from the conflict)

phaer · 2024-05-25T11:56:13Z

@wmertens None that I am aware of. Just resolved the merge conflict which was due the recent python reformating PR.

gungun974 · 2024-05-25T13:22:42Z

Just a question like that, but I see in that PR you update @playwright/test to version 1.42.1.

Should not update to 1.44.1 instead or it's okay you think ?

phaer · 2024-05-25T14:03:04Z

Yes, this PR is 2 months old already. Could upgrade if needed, but as written in the resolved thread in #298944 (comment) I'd prefer to do so in #302759 in to keep churn to a minimum:)

SuperSandro2000

Please cleanup the commit history

pkgs/development/web/playwright/chromium.nix

pkgs/development/web/playwright/ffmpeg.nix

pkgs/development/web/playwright/firefox.nix

pkgs/development/web/playwright/webkit.nix

…the latest version This should be reverted once NixOS/nixpkgs#298944 is merged.

pkgs/development/web/playwright/chromium.nix

phaer · 2024-09-15T19:01:34Z

Test "Render Nix Manual in firefox" failed with error: "command test_playwright firefox $NIX_MANUAL_DOCROOT failed (exit code 1)"

Hm..I hadn't seen firefox failing in local testing, only chromium.

Chromium seems to work now, due to adding --disable-gpu to the wrapper. This would ideally be optional? Not sure yet what the best pattern for something like this would be.

pkgs/development/web/playwright/chromium.nix

teto · 2024-09-16T11:56:08Z

I think sandro's comment about simplifiying history was adressed. If we can keep the GPU by default while having the test pass, we can merge. It's a nice contribution, we can iterate afterwards.

teto · 2024-09-16T21:42:31Z

the test times out locally too (x86)

phaer · 2024-09-17T07:55:04Z

the test times out locally too (x86)

Hm...I wonder what the issue is here. It just ran successfully for me on two different x86_64-linux nixos machines; one of them not managed by to check whether it's some obscure setting or so ;) It also succeeded on on aarch64-linux in ofborg. Going to ask ofborg to run again to see whether it's flaky?

EDIT: It's either flaky or i misunderstand how the checks are run in CI; can re-produce after a rebase.

@teto At this point I am guessing, but could you check whether adding --disable-gpu to chromiums flags in the test changes something for you?

Just wanted to use firefox with playwright half a year ago, wrote a test and now I am trying to get the test to pass with chromium 😅

phaer · 2024-09-17T07:55:47Z

@ofborg test playwright-python

phaer · 2024-09-17T11:09:56Z

Rebasing on top of the new playwright release in master and using --disable-gpu seem to have fixed the test, @teto?

The webkit minibrowser is broken inside the test, but seems to work outside of it. I excluded it from the test for now, as my priority was to get firefox working and a nixos vm test for the browsers to begin with :)

SuperSandro2000

looks fine to me otherwise, didn't test

pkgs/development/web/playwright/driver.nix

pkgs/development/web/playwright/ffmpeg.nix

pkgs/development/web/playwright/firefox.nix

pkgs/development/web/playwright/webkit.nix

SuperSandro2000 · 2024-09-17T11:31:50Z

pkgs/development/python-modules/playwright/default.nix

+        driver = playwright-driver;
+        browsers = playwright-driver.browsers;
+      }
+      // lib.optionalAttrs stdenv.isLinux {


We could make this unconditional but whatever. Fine by me.

I think it won't hurt to be explicit about supported platforms. :)

phaer · 2024-09-20T10:55:58Z

Applied review suggestions; hope this is finally good to merge 🙏 😉

short rant about late-stage style reviews and workflows here:

I really long for a future where we either have a linter (in CI and locally) for things like sha256->hash when its deemed important enough.
And/or a platform which makes it easier to review rebased commits efficiently. The problem with such reviews late in the cycle is that it technically invalidates prior reviews (and produces additional overhead for a pull, fix, rebase, push cycle compared to a linter).

I also believe we could have done those changes in the next PR (pure macOS browsers are planned and I am interested in browsers built from source, but let's see how long my energy lasts for this 😅 )

the innocent change from sha256 -> hash caused:

ofborg failing to eval because i forgot to update the hashes
me running update.sh to check if it works for the full pipeline
seeing no git diff
discovering that nix-prefetch-url seemingly doesn't support a format fitting hash
rewriting it to use update.sh `nix store prefetch-file --json --hash-type sha256 --unpack "$1" | jq -r .hash
waiting for the downloads
rebasing to squash the commits

and all that for no functional difference while there's about 56k instances of sha256 usage
in master according to rg. 😕

via update.sh. This lets us support playwright with browsers other than chromium on linux. Building them from source would be one step further.

For some reason, chromium, which is still the nixpkgs version hangs inside the normal test vm, while working fine in .driverInteractive. I suspect that might have to do with the existence of a display in .driverInteractive. Neither vm does run X11 or wayland.

teto · 2024-09-20T15:05:41Z

pkgs/development/web/playwright/chromium.nix

+
+    # See here for the Chrome options:
+    # https://github.com/NixOS/nixpkgs/issues/136207#issuecomment-908637738
+    # We add --disable-gpu to be able to run in gpu-less environments such


this comment is outdated but let's remove it in future PRs.

teto · 2024-09-21T19:50:19Z

the test still times out hre for some reason but let's not penalize contributors for adding tests. Considering the effort here, I assume you are in for the long run :)

altano · 2024-09-21T23:02:48Z

🎉🙏

github-actions bot added the 6.topic: python label Mar 25, 2024

ofborg bot requested review from yrd and techknowlogick March 25, 2024 15:25

ofborg bot added 10.rebuild-darwin: 11-100 10.rebuild-linux: 11-100 labels Mar 25, 2024

teto reviewed Mar 25, 2024

View reviewed changes

pkgs/development/web/playwright/firefox.nix Outdated Show resolved Hide resolved

phaer force-pushed the playwright branch from 7e75431 to 279651c Compare April 2, 2024 11:40

github-actions bot added the 6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS label Apr 2, 2024

phaer marked this pull request as ready for review April 2, 2024 11:42

phaer requested a review from teto April 2, 2024 11:42

phaer mentioned this pull request Apr 2, 2024

Package request: playwright-driver: package Firefox and Webkit #288826

Closed

ofborg bot added the 11.by: package-maintainer This PR was created by the maintainer of the package it changes label Apr 2, 2024

phaer force-pushed the playwright branch from c0091dd to 6cf6a92 Compare April 3, 2024 14:24

pbek reviewed Apr 3, 2024

View reviewed changes

pkgs/development/web/playwright-test/default.nix Outdated Show resolved Hide resolved

kalekseev mentioned this pull request Apr 9, 2024

playwright: package with buildNpmPackage #302759

Merged

20 tasks

phaer force-pushed the playwright branch from 6cf6a92 to 846b399 Compare May 2, 2024 22:37

wegank added the 2.status: merge conflict This PR has merge conflicts with the target branch label May 22, 2024

phaer force-pushed the playwright branch 2 times, most recently from 2c61f6f to 231ccc0 Compare May 25, 2024 11:55

ofborg bot removed the 2.status: merge conflict This PR has merge conflicts with the target branch label May 25, 2024

SuperSandro2000 requested changes Jun 2, 2024

View reviewed changes

wegank added the 2.status: merge conflict This PR has merge conflicts with the target branch label Jul 6, 2024

tembleking added a commit to figarocorso/python-bizneo that referenced this pull request Jul 19, 2024

fix(build): add temporary overlay updating the playwright drivers to …

13a2c1e

…the latest version This should be reverted once NixOS/nixpkgs#298944 is merged.

teto reviewed Sep 15, 2024

View reviewed changes

pkgs/development/web/playwright/chromium.nix Outdated Show resolved Hide resolved

phaer force-pushed the playwright branch 3 times, most recently from 56d6335 to 7cd443e Compare September 15, 2024 18:59

phaer force-pushed the playwright branch from 7cd443e to 19d373f Compare September 15, 2024 19:03

teto reviewed Sep 16, 2024

View reviewed changes

pkgs/development/web/playwright/chromium.nix Outdated Show resolved Hide resolved

phaer force-pushed the playwright branch from 19d373f to be110ab Compare September 16, 2024 15:22

phaer force-pushed the playwright branch from be110ab to 420e2aa Compare September 17, 2024 08:47

SuperSandro2000 approved these changes Sep 17, 2024

View reviewed changes

phaer force-pushed the playwright branch from 420e2aa to 7d063fd Compare September 20, 2024 10:50

phaer force-pushed the playwright branch from 7d063fd to 1b89a6d Compare September 20, 2024 11:46

phaer added 2 commits September 20, 2024 14:52

playwright: Use pre-built browsers, update them...

67b5c21

via update.sh. This lets us support playwright with browsers other than chromium on linux. Building them from source would be one step further.

phaer force-pushed the playwright branch from 1b89a6d to 01fd62f Compare September 20, 2024 12:52

teto reviewed Sep 20, 2024

View reviewed changes

kalekseev approved these changes Sep 21, 2024

View reviewed changes

teto merged commit a6df665 into NixOS:master Sep 21, 2024
25 of 27 checks passed

phaer deleted the playwright branch September 21, 2024 21:30

teto mentioned this pull request Oct 2, 2024

playwright: fix firefox #197899

Closed

13 tasks

pietdevries94 mentioned this pull request Oct 3, 2024

Add Firefox and Webkit pietdevries94/playwright-web-flake#7

Open

philiptaron mentioned this pull request Oct 7, 2024

playwright-driver: fix eval on Nix 2.3 #347114

Merged

13 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Playwright: browser improvements, update #298944

Playwright: browser improvements, update #298944

phaer commented Mar 25, 2024 •

edited

Loading

phaer commented Apr 2, 2024 •

edited

Loading

nixos-discourse commented Apr 3, 2024

nixos-discourse commented May 12, 2024

wmertens commented May 25, 2024

phaer commented May 25, 2024

gungun974 commented May 25, 2024

phaer commented May 25, 2024

SuperSandro2000 left a comment

phaer commented Sep 15, 2024

teto commented Sep 16, 2024

teto commented Sep 16, 2024

phaer commented Sep 17, 2024 •

edited

Loading

phaer commented Sep 17, 2024

phaer commented Sep 17, 2024

SuperSandro2000 left a comment

SuperSandro2000 Sep 17, 2024

phaer Sep 20, 2024

phaer commented Sep 20, 2024 •

edited

Loading

teto Sep 20, 2024

teto commented Sep 21, 2024

altano commented Sep 21, 2024

Playwright: browser improvements, update #298944

Playwright: browser improvements, update #298944

Conversation

phaer commented Mar 25, 2024 • edited Loading

Description of changes

Things done

phaer commented Apr 2, 2024 • edited Loading

nixos-discourse commented Apr 3, 2024

nixos-discourse commented May 12, 2024

wmertens commented May 25, 2024

phaer commented May 25, 2024

gungun974 commented May 25, 2024

phaer commented May 25, 2024

SuperSandro2000 left a comment

Choose a reason for hiding this comment

phaer commented Sep 15, 2024

teto commented Sep 16, 2024

teto commented Sep 16, 2024

phaer commented Sep 17, 2024 • edited Loading

phaer commented Sep 17, 2024

phaer commented Sep 17, 2024

SuperSandro2000 left a comment

Choose a reason for hiding this comment

SuperSandro2000 Sep 17, 2024

Choose a reason for hiding this comment

phaer Sep 20, 2024

Choose a reason for hiding this comment

phaer commented Sep 20, 2024 • edited Loading

teto Sep 20, 2024

Choose a reason for hiding this comment

teto commented Sep 21, 2024

altano commented Sep 21, 2024

phaer commented Mar 25, 2024 •

edited

Loading

phaer commented Apr 2, 2024 •

edited

Loading

phaer commented Sep 17, 2024 •

edited

Loading

phaer commented Sep 20, 2024 •

edited

Loading