chore: migrate to pnpm (#139)

Author: ruocco-l

.github/workflows/checks.yml

@@ -13,23 +13,26 @@ jobs:
     steps:
     - uses: actions/checkout@v4
 
+    - name: Install pnpm
+      uses: pnpm/action-setup@v4
+
     - name: Setup Node.js
       uses: actions/setup-node@v4
       with:
         node-version: 22
-        cache: 'npm'
+        cache: 'pnpm'
 
     - name: Install dependencies
-      run: npm ci
+      run: pnpm install --frozen-lockfile
 
     - name: Build
-      run: npm run build
+      run: pnpm run build
 
     - name: Lint
-      run: npm run lint
+      run: pnpm run lint
 
     - name: Install Playwright
-      run: npx playwright install firefox --with-deps
+      run: pnpm exec playwright install firefox --with-deps
 
     - name: Test
-      run: npm run test
+      run: pnpm run test

Dockerfile

@@ -6,45 +6,61 @@ FROM apify/actor-node:22 AS builder
 # override the default working directory set in the base image
 WORKDIR /home/myuser
 
-# Copy just package.json and package-lock.json
+# Enable pnpm through Corepack. The base image runs as the non-root `myuser`, and the default
+# Corepack shim location (/usr/local/bin) is root-owned, so install the shims into a
+# user-writable directory and put it on PATH. The exact pnpm version comes from the
+# "packageManager" field in package.json.
+ENV PATH=/home/myuser/bin:$PATH
+ENV COREPACK_ENABLE_DOWNLOAD_PROMPT=0
+RUN mkdir -p /home/myuser/bin && corepack enable --install-directory /home/myuser/bin pnpm
+
+# Copy just package.json, the lockfile, the workspace config and patches
 # to speed up the build using Docker layer cache.
-COPY --chown=myuser package*.json ./
+COPY --chown=myuser package.json pnpm-lock.yaml pnpm-workspace.yaml ./
+COPY --chown=myuser patches ./patches
 
-# Install all dependencies. Don't audit to speed up the installation.
-RUN npm install --include=dev --audit=false
+# The base image ships a preinstalled node_modules. Remove it first so pnpm's isolated layout
+# doesn't get confused by a preexisting non-pnpm node_modules. `npm install` used to overwrite it
+# implicitly; pnpm does not.
+RUN rm -rf node_modules && pnpm install --frozen-lockfile
 
 # Next, copy the source files using the user set
 # in the base image.
 COPY --chown=myuser . ./
 
-# Install all dependencies and build the project.
-# Don't audit to speed up the installation.
-RUN npm run build
+# Build the project.
+RUN pnpm run build
 
 # Build Ghostery blockers for content filtering
-RUN npm run build:playwright-blockers
+RUN pnpm run build:playwright-blockers
 
 # Create final image
 FROM apify/actor-node-playwright-firefox:22-1.55.1
 
-# Copy just package.json and package-lock.json
+# Enable pnpm through Corepack (see the builder stage for why we use a custom install directory).
+ENV PATH=/home/myuser/bin:$PATH
+ENV COREPACK_ENABLE_DOWNLOAD_PROMPT=0
+RUN mkdir -p /home/myuser/bin && corepack enable --install-directory /home/myuser/bin pnpm
+
+# Copy just package.json, the lockfile, the workspace config and patches
 # to speed up the build using Docker layer cache.
-COPY --chown=myuser package*.json ./
+COPY --chown=myuser package.json pnpm-lock.yaml pnpm-workspace.yaml ./
 COPY --chown=myuser policies.json ./
 COPY --chown=myuser patches ./patches
 
-# Install NPM packages, skip development dependencies to keep the image small. Avoid logging too
+# Install packages, skip development dependencies to keep the image small. Avoid logging too
 # much and print the dependency tree for debugging. Optional dependencies are needed - `impit`
-# ships its native bindings as one.
-RUN npm --quiet set progress=false \
-    && npm install --omit=dev \
-    && echo "Installed NPM packages:" \
-    && (npm list --omit=dev --all || true) \
+# ships its native bindings as one. Remove the base image's preinstalled node_modules first
+# (see builder stage).
+RUN rm -rf node_modules \
+    && pnpm install --prod --frozen-lockfile \
+    && echo "Installed packages:" \
+    && (pnpm list --prod --depth Infinity || true) \
     && echo "Node.js version:" \
     && node --version \
-    && echo "NPM version:" \
-    && npm --version \
-    && rm -r ~/.npm
+    && echo "pnpm version:" \
+    && pnpm --version \
+    && pnpm store prune
 
 # Copy built JS files from builder image
 COPY --from=builder --chown=myuser /home/myuser/dist ./dist
@@ -53,7 +69,7 @@ COPY --from=builder --chown=myuser /home/myuser/dist ./dist
 COPY --from=builder --chown=myuser /home/myuser/blockers ./blockers
 
 # Next, copy the remaining files and directories with the source code.
-# Since we do this after NPM install, quick build will be really fast
+# Since we do this after pnpm install, quick build will be really fast
 # for most source file changes.
 COPY --chown=myuser . ./
 
@@ -69,4 +85,4 @@ ENV PLAYWRIGHT_FIREFOX_POLICIES_JSON="/home/myuser/policies.json"
 ENV NODE_NO_WARNINGS=1
 
 # Run the image.
-CMD ["npm", "run", "start:prod", "--silent"]
+CMD ["pnpm", "run", "start:prod", "--silent"]