@element-hq/element-web-playwright-common 2.2.5 → 2.2.7

package/Dockerfile

@@ -6,4 +6,13 @@ WORKDIR /work
 # fonts-dejavu is needed for the same RTL rendering as on CI
 RUN apt-get update && apt-get -y install docker.io fonts-dejavu
 
-ENTRYPOINT ["npx", "playwright", "test", "--update-snapshots", "--reporter", "line"]
+# Set up corepack
+RUN corepack enable
+ENV COREPACK_ENABLE_DOWNLOAD_PROMPT=0
+
+# Add environment variable so consumers can skip developer-centric scripts
+ENV PLAYWRIGHT_COMMON_DOCKER=1
+
+COPY docker-entrypoint.sh /docker-entrypoint.sh
+
+ENTRYPOINT ["/docker-entrypoint.sh"]

package/docker-entrypoint.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+set -e
+
+if [[ "$YARN_INSTALL" == "true" ]]; then
+  yarn install --frozen-lockfile
+fi
+
+npx playwright test --update-snapshots --reporter line "$@"

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@element-hq/element-web-playwright-common",
     "type": "module",
-    "version": "2.2.5",
+    "version": "2.2.7",
     "license": "SEE LICENSE IN README.md",
     "repository": {
         "type": "git",
@@ -31,7 +31,7 @@
     "dependencies": {
         "@axe-core/playwright": "^4.10.1",
         "@testcontainers/postgresql": "^11.0.0",
-        "glob": "^13.0.0",
+        "glob": "^13.0.1",
         "lodash-es": "^4.17.23",
         "mailpit-api": "^1.2.0",
         "strip-ansi": "^7.1.0",

package/playwright-screenshots.sh

@@ -8,11 +8,18 @@ SCRIPT_DIR=$(dirname "$SCRIPT_PATH")
 
 IMAGE_NAME="element-web-playwright-common"
 
+if docker --version | grep -q podman; then docker_is_podman=1; fi
+
 build_image() {
   echo "Building $IMAGE_NAME image in $SCRIPT_DIR"
 
   # Check the playwright version
-  PW_VERSION=$(yarn list --pattern @playwright/test --depth=0 --json --non-interactive --no-progress | jq -r '.data.trees[].name | split("@") | last')
+  PM=$(cat package.json | jq -r '.packageManager')
+  if [[ $PM == "pnpm@"* ]]; then
+    PW_VERSION=$(pnpm list @playwright/test --depth=0 --json | jq -r '.[].devDependencies["@playwright/test"].version')
+  else
+    PW_VERSION=$(yarn list --pattern @playwright/test --depth=0 --json --non-interactive --no-progress | jq -r '.data.trees[].name | split("@") | last')
+  fi
   echo "with Playwright version $PW_VERSION"
 
   # Build image
@@ -49,6 +56,7 @@ RUN_ARGS=(
 )
 
 DEFAULT_ARGS=(--grep @screenshot)
+LINK_MODULES=true
 
 # Some arguments to customise behaviour so the same script / image can be
 # re-used for other screenshot generation.
@@ -59,7 +67,15 @@ while [[ $# -gt 0 ]]; do
     # It's a volume rather than a directory because otherwise things tend to start picking up
     # files from it in the native environment and break.
     --with-node-modules)
-      RUN_ARGS+=(--mount "type=volume,src=ew-docker-node-modules,dst=/work/node_modules,volume-nocopy")
+      mount_param="type=volume,src=ew-docker-node-modules,dst=/work/node_modules"
+      # podman doesn't support `volume-nocopy`
+      if [ -z "$docker_is_podman" ]; then mount_param+=",volume-nocopy"; fi
+      RUN_ARGS+=(--mount "${mount_param}" -e YARN_INSTALL=true)
+      shift
+      ;;
+    # Disables the automatic detection & linking of node_modules which can clash with developer tooling e.g. pnpm-link
+    --no-link-modules)
+      LINK_MODULES=false
       shift
       ;;
     # Sets a different entrypoint (in which case the default arguments to the script will be ignored)
@@ -77,16 +93,17 @@ done
 
 build_image
 
-# Ensure we pass all symlinked node_modules to the container
-pushd node_modules > /dev/null
-SYMLINKS=$(find . -maxdepth 2 -type l -not -path "./.bin/*")
-popd > /dev/null
-for LINK in $SYMLINKS; do
-  TARGET=$(readlink -f "node_modules/$LINK") || true
-  if [ -d "$TARGET" ]; then
-     if docker --version | grep -q podman; then
-        echo -e "\033[31m" >&2
-        cat <<'EOF' >&2
+if [[ $LINK_MODULES == true ]]; then
+  # Ensure we pass all symlinked node_modules to the container
+  pushd node_modules > /dev/null
+  SYMLINKS=$(find . -maxdepth 2 -type l -not -path "./.bin/*")
+  popd > /dev/null
+  for LINK in $SYMLINKS; do
+    TARGET=$(readlink -f "node_modules/$LINK") || true
+    if [ -d "$TARGET" ]; then
+       if [ -n "$docker_is_podman" ]; then
+          echo -e "\033[31m" >&2
+          cat <<'EOF' >&2
 WARNING: `node_modules` contains symlinks, and the support for this in
 `playwright-screenshots.sh` is broken under podman due to
 https://github.com/containers/podman/issues/25947.
@@ -94,12 +111,13 @@ https://github.com/containers/podman/issues/25947.
 If you get errors such as 'Error: crun: creating `<path>`', then retry this
 having `yarn unlink`ed the relevant node modules.
 EOF
-      echo -e "\033[0m" >&2
+        echo -e "\033[0m" >&2
+      fi
+      echo "mounting linked package ${LINK:2} in container"
+      RUN_ARGS+=( "-v" "$TARGET:/work/node_modules/${LINK:2}" )
     fi
-    echo "mounting linked package ${LINK:2} in container"
-    RUN_ARGS+=( "-v" "$TARGET:/work/node_modules/${LINK:2}" )
-  fi
-done
+  done
+fi
 
 # Our Playwright fixtures use Testcontainers [1], which uses a docker image
 # called Ryuk [2], which will clean up any dangling containers/networks/etc