fix(flake.nix): synchronize playwright version in nix and package.json (coder#16715)

ThomasK33 · web-flow · commit 9ded2cc7ecea · 2025-03-11T13:49:03.000+01:00
Ensure that the version of Playwright installed with the Nix flake is
equal to the one specified in `site/package.json.` -- This assertion
ensures that `pnpm playwright:install` will not attempt to download
newer browser versions not present in the Nix image, fixing the startup
script and reducing the startup time, as `pnpm playwright:install` will
not download or install anything.

We also pre-install the required Playwright web browsers in the dogfood
Dockerfile. This change prevents us from redownloading system
dependencies and Google Chrome each time a workspace starts.

Change-Id: I8cc78e842f7d0b1d2a90a4517a186a03636c5559
Signed-off-by: Thomas Kosiewski &lt;tk@coder.com&gt;

Signed-off-by: Thomas Kosiewski &lt;tk@coder.com&gt;
diff --git a/dogfood/contents/Dockerfile b/dogfood/contents/Dockerfile
@@ -244,6 +244,8 @@ ENV PATH=$NVM_DIR/versions/node/v$NODE_VERSION/bin:$PATH
 RUN npm install -g npm@^10.8
 RUN npm install -g pnpm@^9.6
 
+RUN pnpx playwright@1.47.0 install --with-deps chromium
+
 # Ensure PostgreSQL binaries are in the users $PATH.
 RUN update-alternatives --install /usr/local/bin/initdb initdb /usr/lib/postgresql/16/bin/initdb 100 && \
 	update-alternatives --install /usr/local/bin/postgres postgres /usr/lib/postgresql/16/bin/postgres 100
diff --git a/dogfood/contents/main.tf b/dogfood/contents/main.tf
@@ -351,7 +351,7 @@ resource "coder_agent" "dev" {
       sleep 1
     done
     cd "${local.repo_dir}" && make clean
-    cd "${local.repo_dir}/site" && pnpm install && pnpm playwright:install
+    cd "${local.repo_dir}/site" && pnpm install
   EOT
 }
 
diff --git a/flake.nix b/flake.nix
@@ -121,6 +121,7 @@
             (pinnedPkgs.golangci-lint)
             gopls
             gotestsum
+            hadolint
             jq
             kubectl
             kubectx
@@ -216,6 +217,14 @@
             '';
           };
       in
+      # "Keep in mind that you need to use the same version of playwright in your node playwright project as in your nixpkgs, or else playwright will try to use browsers versions that aren't installed!"
+      # - https://nixos.wiki/wiki/Playwright
+      assert pkgs.lib.assertMsg
+        (
+          (pkgs.lib.importJSON ./site/package.json).devDependencies."@playwright/test"
+          == pkgs.playwright-driver.version
+        )
+        "There is a mismatch between the playwright versions in the ./nix.flake and the ./site/package.json file. Please make sure that they use the exact same version.";
       rec {
         inherit formatter;
 
@@ -261,12 +270,13 @@
 
               uname = "coder";
               homeDirectory = "/home/${uname}";
+              releaseName = version;
 
               drv = devShells.default.overrideAttrs (oldAttrs: {
                 buildInputs =
                   (with pkgs; [
                     coreutils
-                    nix
+                    nix.out
                     curl.bin # Ensure the actual curl binary is included in the PATH
                     glibc.bin # Ensure the glibc binaries are included in the PATH
                     jq.bin
diff --git a/nix/docker.nix b/nix/docker.nix
@@ -50,10 +50,6 @@ let
     experimental-features = nix-command flakes
   '';
 
-  etcReleaseName = writeTextDir "etc/coderniximage-release" ''
-    0.0.0
-  '';
-
   etcPamdSudoFile = writeText "pam-sudo" ''
     # Allow root to bypass authentication (optional)
     auth      sufficient pam_rootok.so
@@ -115,6 +111,7 @@ let
       run ? null,
       maxLayers ? 100,
       uname ? "nixbld",
+      releaseName ? "0.0.0",
     }:
     assert lib.assertMsg (!(drv.drvAttrs.__structuredAttrs or false))
       "streamNixShellImage: Does not work with the derivation ${drv.name} because it uses __structuredAttrs";
@@ -207,6 +204,10 @@ let
         '';
       };
 
+      etcReleaseName = writeTextDir "etc/coderniximage-release" ''
+        ${releaseName}
+      '';
+
       # https://github.com/NixOS/nix/blob/2.8.0/src/libstore/globals.hh#L464-L465
       sandboxBuildDir = "/build";
 
diff --git a/site/package.json b/site/package.json
@@ -126,7 +126,7 @@
 		"@biomejs/biome": "1.9.4",
 		"@chromatic-com/storybook": "3.2.2",
 		"@octokit/types": "12.3.0",
-		"@playwright/test": "1.47.2",
+		"@playwright/test": "1.47.0",
 		"@storybook/addon-actions": "8.5.2",
 		"@storybook/addon-essentials": "8.4.6",
 		"@storybook/addon-interactions": "8.5.3",
diff --git a/site/pnpm-lock.yaml b/site/pnpm-lock.yaml

Original file line number	Diff line number	Diff line change
`@@ -351,7 +351,7 @@ resource "coder_agent" "dev" {`
`351`	`351`	`sleep 1`
`352`	`352`	`done`
`353`	`353`	`cd "${local.repo_dir}" && make clean`
`354`		`- cd "${local.repo_dir}/site" && pnpm install && pnpm playwright:install`
	`354`	`+ cd "${local.repo_dir}/site" && pnpm install`
`355`	`355`	`EOT`
`356`	`356`	`}`
`357`	`357`