ui: fail storybook tests if playwright version mismatch

pkgs/clan-app/flake-module.nix

@@ -1,9 +1,11 @@
+{ lib, ... }:
 {
   perSystem =
     {
       self',
       pkgs,
       config,
+      system,
       ...
     }:
     {
@@ -41,6 +43,11 @@
         inherit (config.packages) clan-ts-api;
       };
 
-      checks = config.packages.clan-app.tests // config.packages.clan-app-ui.tests;
+      checks =
+        config.packages.clan-app.tests
+        # Clan's darwin CI is a sandbox too limiting to spawn a headless brwoser
+        // lib.optionalAttrs (!lib.hasSuffix system "darwin") {
+          inherit (config.packages.clan-app-ui.tests) clan-app-ui-storybook;
+        };
     };
 }

pkgs/clan-app/shell.nix

@@ -14,9 +14,11 @@
   json2ts,
   playwright,
   luakit,
+  jq,
   self',
 }:
 let
+  RED = "\\033[1;31m";
   GREEN = "\\033[1;32m";
   NC = "\\033[0m";
 
@@ -100,7 +102,7 @@ mkShell {
     chmod -R +w api
     popd
 
-    # configure process-compose
+    # configure process-compospe
     if test -f "$CLAN_CORE_PATH/pkgs/clan-app/.local.env"; then
       source "$CLAN_CORE_PATH/pkgs/clan-app/.local.env"
     fi
@@ -112,19 +114,35 @@ mkShell {
     # configure playwright for storybook snapshot testing
     # we only want webkit as that matches what the app is rendered with
 
-    export PLAYWRIGHT_BROWSERS_PATH=${
+
-      playwright.browsers.override {
+    playwright_ver=$(${jq}/bin/jq --raw-output .devDependencies.playwright ${./ui/package.json})
-        withFfmpeg = false;
+    if [[ $playwright_ver != '${playwright.version}' ]]; then
-        withFirefox = false;
+      echo >&2 -en '${RED}'
-        withWebkit = true;
+      echo >&2 "Error: playwright npm package version ($playwright_ver) is different from that from the nixpkgs (${playwright.version})"
-        withChromium = false;
+      echo >&2 "Run this command to update the npm package version"
-        withChromiumHeadlessShell = false;
+      echo >&2
+      echo >&2 "  npm i -D --save-exact playwright@${playwright.version}"
+      echo >&2
+      echo >&2 -en '${NC}'
+    else
+      export PLAYWRIGHT_BROWSERS_PATH=${
+        playwright.browsers.override {
+          withFfmpeg = false;
+          withFirefox = false;
+          withWebkit = true;
+          withChromium = false;
+          withChromiumHeadlessShell = false;
+        }
       }
-    }
 
-    # stop playwright from trying to validate it has downloaded the necessary browsers
+      # This is needed to disable revisionOverrides in browsers.json which
-    # we are providing them manually via nix
+      # the playwright nix package does not support
+      # https://github.com/NixOS/nixpkgs/blob/f9c3b27aa3f9caac6717973abcc549dbde16bdd4/pkgs/development/web/playwright/driver.nix#L261
+      export PLAYWRIGHT_HOST_PLATFORM_OVERRIDE=nixos
 
-    export PLAYWRIGHT_SKIP_VALIDATE_HOST_REQUIREMENTS=true
+      # stop playwright from trying to validate it has downloaded the necessary browsers
+      # we are providing them manually via nix
+      export PLAYWRIGHT_SKIP_VALIDATE_HOST_REQUIREMENTS=true
+    fi
   '';
 }

pkgs/clan-app/ui.nix

@@ -5,7 +5,8 @@
   clan-ts-api,
   fonts,
   ps,
-  playwright-driver,
+  jq,
+  playwright,
 }:
 buildNpmPackage (finalAttrs: {
   pname = "clan-app-ui";
@@ -49,12 +50,13 @@ buildNpmPackage (finalAttrs: {
 
         nativeBuildInputs = finalAttrs.nativeBuildInputs ++ [
           ps
+          jq
         ];
 
         npmBuildScript = "test-storybook";
 
         env = {
-          PLAYWRIGHT_BROWSERS_PATH = "${playwright-driver.browsers.override {
+          PLAYWRIGHT_BROWSERS_PATH = "${playwright.browsers.override {
             withFfmpeg = false;
             withFirefox = false;
             withWebkit = true;
@@ -62,7 +64,22 @@ buildNpmPackage (finalAttrs: {
             withChromiumHeadlessShell = false;
           }}";
           PLAYWRIGHT_SKIP_VALIDATE_HOST_REQUIREMENTS = true;
+          # This is needed to disable revisionOverrides in browsers.json which
+          # the playwright nix package does not support:
+          # https://github.com/NixOS/nixpkgs/blob/f9c3b27aa3f9caac6717973abcc549dbde16bdd4/pkgs/development/web/playwright/driver.nix#L261
+          PLAYWRIGHT_HOST_PLATFORM_OVERRIDE = "nixos";
         };
+        preBuild = finalAttrs.preBuild + ''
+          playwright_ver=$(jq --raw-output .devDependencies.playwright ${./ui/package.json})
+          if [[ $playwright_ver != '${playwright.version}' ]]; then
+            echo >&2 "playwright npm package version ($playwright_ver) is different from that from the nixpkgs (${playwright.version})"
+            echo >&2 "Run this command to update the npm package version"
+            echo >&2
+            echo >&2 "  npm i -D --save-exact playwright@${playwright.version}"
+            echo >&2
+            exit 1
+          fi
+        '';
       };
     };
   };