fix(nix): pin playwright to nixpkgs version

Playwright doesn't play that nice with NixOS because it downloads binaries that require libs that aren't always available. Nix has a special package with playwright browsers.

We don't use the latest features of Playwright, so lagging behind is fine and it limits the downloads required.

Author: wmertens

.envrc

@@ -1,3 +1,3 @@
+# shellcheck shell=bash
 use flake
-PATH_add ./node_modules/.bin
 watch_file rust-toolchain

flake.lock

@@ -1,6 +1,16 @@
+# This is a Nix configuration file. It is used to define the environment
+# for the project. It is a declarative way to define the dependencies.
+# It is used by the `nix develop` command to create a development environment
+# with all the dependencies needed for the project.
+
+# To update the dependencies, run `nix flake update`.
+
+# Note: keep the playwright version in package.json syncpack the same as the nix version
+# We don't need to have the latest playwright all the time so not having to download
+# all the browsers on every version bump is a good thing.
 {
   inputs = {
-    nixpkgs.url = "github:NixOS/nixpkgs/nixos-23.11";
+    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
     rust-overlay.url = "github:oxalica/rust-overlay";
   };
 
@@ -23,6 +33,9 @@
               nodejs_20
               corepack_20
 
+              # Playwright for the end-to-end tests
+              playwright-driver.browsers
+
               # Qwik optimizer deps
               wasm-pack
               # Provides rustc and cargo
@@ -34,6 +47,17 @@
                 targets = [ "wasm32-unknown-unknown" ];
               })
             ];
+            # https://github.com/microsoft/playwright/issues/5501
+            shellHook = ''
+              export PATH=$PWD/node_modules/.bin:$PATH
+              export PLAYWRIGHT_BROWSERS_PATH=${pkgs.playwright-driver.browsers}
+              export PLAYWRIGHT_SKIP_VALIDATE_HOST_REQUIREMENTS=true
+              pwNixVersion=${pkgs.playwright-driver.version}
+              pwNpmVersion=$(${pkgs.jq}/bin/jq -r .version node_modules/@playwright/test/package.json 2>/dev/null)
+              if [ -n "$pwNpmVersion" ] && [ "$pwNpmVersion" != "$pwNixVersion" ]; then
+                echo "!!! Playwright version mismatch: $pwNpmVersion (nodejs) != $pwNixVersion (nix). Please fix." >&2
+              fi
+            '';
           };
         };
     in

flake.nix

@@ -21,6 +21,13 @@
             "!local"
           ],
           "pinVersion": "workspace:^"
+        },
+        {
+          "label": "Playwright should have the same version as in flake.nix",
+          "dependencies": [
+            "@playwright/test"
+          ],
+          "pinVersion": "1.40.0"
         }
       ],
       "semverGroups": [
@@ -67,7 +74,7 @@
     "@napi-rs/triples": "^1.2.0",
     "@node-rs/helper": "^1.5.0",
     "@octokit/action": "6.0.7",
-    "@playwright/test": "^1.42.1",
+    "@playwright/test": "1.40.0",
     "@types/brotli": "^1.3.4",
     "@types/bun": "^1.1.0",
     "@types/cross-spawn": "^6.0.6",