From 4d09651fe1e4add2ed8516d9aba54582f289c76c Mon Sep 17 00:00:00 2001 From: Timo K Date: Tue, 21 Apr 2026 10:00:36 +0200 Subject: [PATCH 01/10] Bump pnpm to v10 --- package.json | 2 +- pnpm-lock.yaml | 20 ++++++++++---------- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/package.json b/package.json index c0f4d505..867822c9 100644 --- a/package.json +++ b/package.json @@ -156,5 +156,5 @@ "esbuild": "^0.27.7" } }, - "packageManager": "pnpm@9.0.0" + "packageManager": "pnpm@10.0.0" } diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index c800b0c2..7bbc1dcb 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -14,7 +14,7 @@ overrides: js-yaml: ^4.1.1 esbuild: ^0.27.7 -pnpmfileChecksum: rxqlpiscahzxqq6bf4el6c6jvu +pnpmfileChecksum: sha256-toM8G/xDIU9KCsLzvrWKlNM+7K7S70ZB0m5kCeEztjs= importers: @@ -190,7 +190,7 @@ importers: version: 6.10.2(eslint@8.57.1) eslint-plugin-matrix-org: specifier: 2.1.0 - version: 2.1.0(@babel/core@7.29.0)(@babel/eslint-parser@7.28.6(@babel/core@7.29.0)(eslint@8.57.1))(@babel/eslint-plugin@7.27.1(@babel/eslint-parser@7.28.6(@babel/core@7.29.0)(eslint@8.57.1))(eslint@8.57.1))(@stylistic/eslint-plugin@3.1.0(eslint@8.57.1)(typescript@5.9.3))(@typescript-eslint/eslint-plugin@8.58.2(@typescript-eslint/parser@8.58.2(eslint@8.57.1)(typescript@5.9.3))(eslint@8.57.1)(typescript@5.9.3))(@typescript-eslint/parser@8.58.2(eslint@8.57.1)(typescript@5.9.3))(eslint-config-google@0.14.0(eslint@8.57.1))(eslint-config-prettier@10.1.8(eslint@8.57.1))(eslint-plugin-deprecate@0.9.0(eslint@8.57.1))(eslint-plugin-import@2.32.0(@typescript-eslint/parser@8.58.2(eslint@8.57.1)(typescript@5.9.3))(eslint@8.57.1))(eslint-plugin-jest@29.15.2(@typescript-eslint/eslint-plugin@8.58.2(@typescript-eslint/parser@8.58.2(eslint@8.57.1)(typescript@5.9.3))(eslint@8.57.1)(typescript@5.9.3))(eslint@8.57.1)(typescript@5.9.3))(eslint-plugin-jsx-a11y@6.10.2(eslint@8.57.1))(eslint-plugin-react-hooks@5.2.0(eslint@8.57.1))(eslint-plugin-react@7.37.5(eslint@8.57.1))(eslint-plugin-unicorn@56.0.1(eslint@8.57.1))(eslint@8.57.1)(prettier@3.8.3)(typescript@5.9.3) + version: 2.1.0(09e41ec1b738154136ea8b36e5821317) eslint-plugin-react: specifier: ^7.29.4 version: 7.37.5(eslint@8.57.1) @@ -238,7 +238,7 @@ importers: version: 1.9.2 matrix-js-sdk: specifier: matrix-org/matrix-js-sdk#develop - version: https://codeload.github.com/matrix-org/matrix-js-sdk/tar.gz/668183d7226ccb4819788018fb48e9a58f85a45b + version: https://codeload.github.com/matrix-org/matrix-js-sdk/tar.gz/4ee3e591bf6498eecc1a92aad92b2ff3fc604fb8 matrix-widget-api: specifier: ^1.16.1 version: 1.17.0 @@ -334,7 +334,7 @@ importers: version: 4.1.4(@types/node@24.12.2)(@vitest/coverage-v8@4.1.4)(jsdom@26.1.0)(vite@8.0.8(@types/node@24.12.2)(esbuild@0.27.7)(jiti@2.6.1)(sass@1.99.0)(terser@5.46.1)(yaml@2.8.3)) vitest-axe: specifier: ^1.0.0-pre.3 - version: 1.0.0-pre.5(vitest@4.1.4(@types/node@24.12.2)(@vitest/coverage-v8@4.1.4)(jsdom@26.1.0)(vite@8.0.8(@types/node@24.12.2)(esbuild@0.27.7)(jiti@2.6.1)(sass@1.99.0)(terser@5.46.1)(yaml@2.8.3))) + version: 1.0.0-pre.5(vitest@4.1.4) packages: @@ -4976,8 +4976,8 @@ packages: matrix-events-sdk@0.0.1: resolution: {integrity: sha512-1QEOsXO+bhyCroIe2/A5OwaxHvBm7EsSQ46DEDn8RBIfQwN5HWBpFvyWWR4QY0KHPPnnJdI99wgRiAl7Ad5qaA==} - matrix-js-sdk@https://codeload.github.com/matrix-org/matrix-js-sdk/tar.gz/668183d7226ccb4819788018fb48e9a58f85a45b: - resolution: {tarball: https://codeload.github.com/matrix-org/matrix-js-sdk/tar.gz/668183d7226ccb4819788018fb48e9a58f85a45b} + matrix-js-sdk@https://codeload.github.com/matrix-org/matrix-js-sdk/tar.gz/4ee3e591bf6498eecc1a92aad92b2ff3fc604fb8: + resolution: {tarball: https://codeload.github.com/matrix-org/matrix-js-sdk/tar.gz/4ee3e591bf6498eecc1a92aad92b2ff3fc604fb8} version: 41.3.0 engines: {node: '>=22.0.0'} @@ -10664,8 +10664,8 @@ snapshots: safe-regex-test: 1.1.0 string.prototype.includes: 2.0.1 - ? eslint-plugin-matrix-org@2.1.0(@babel/core@7.29.0)(@babel/eslint-parser@7.28.6(@babel/core@7.29.0)(eslint@8.57.1))(@babel/eslint-plugin@7.27.1(@babel/eslint-parser@7.28.6(@babel/core@7.29.0)(eslint@8.57.1))(eslint@8.57.1))(@stylistic/eslint-plugin@3.1.0(eslint@8.57.1)(typescript@5.9.3))(@typescript-eslint/eslint-plugin@8.58.2(@typescript-eslint/parser@8.58.2(eslint@8.57.1)(typescript@5.9.3))(eslint@8.57.1)(typescript@5.9.3))(@typescript-eslint/parser@8.58.2(eslint@8.57.1)(typescript@5.9.3))(eslint-config-google@0.14.0(eslint@8.57.1))(eslint-config-prettier@10.1.8(eslint@8.57.1))(eslint-plugin-deprecate@0.9.0(eslint@8.57.1))(eslint-plugin-import@2.32.0(@typescript-eslint/parser@8.58.2(eslint@8.57.1)(typescript@5.9.3))(eslint@8.57.1))(eslint-plugin-jest@29.15.2(@typescript-eslint/eslint-plugin@8.58.2(@typescript-eslint/parser@8.58.2(eslint@8.57.1)(typescript@5.9.3))(eslint@8.57.1)(typescript@5.9.3))(eslint@8.57.1)(typescript@5.9.3))(eslint-plugin-jsx-a11y@6.10.2(eslint@8.57.1))(eslint-plugin-react-hooks@5.2.0(eslint@8.57.1))(eslint-plugin-react@7.37.5(eslint@8.57.1))(eslint-plugin-unicorn@56.0.1(eslint@8.57.1))(eslint@8.57.1)(prettier@3.8.3)(typescript@5.9.3) - : dependencies: + eslint-plugin-matrix-org@2.1.0(09e41ec1b738154136ea8b36e5821317): + dependencies: '@babel/core': 7.29.0 '@babel/eslint-parser': 7.28.6(@babel/core@7.29.0)(eslint@8.57.1) '@babel/eslint-plugin': 7.27.1(@babel/eslint-parser@7.28.6(@babel/core@7.29.0)(eslint@8.57.1))(eslint@8.57.1) @@ -11751,7 +11751,7 @@ snapshots: matrix-events-sdk@0.0.1: {} - matrix-js-sdk@https://codeload.github.com/matrix-org/matrix-js-sdk/tar.gz/668183d7226ccb4819788018fb48e9a58f85a45b: + matrix-js-sdk@https://codeload.github.com/matrix-org/matrix-js-sdk/tar.gz/4ee3e591bf6498eecc1a92aad92b2ff3fc604fb8: dependencies: '@babel/runtime': 7.29.2 '@matrix-org/matrix-sdk-crypto-wasm': 18.1.0 @@ -13542,7 +13542,7 @@ snapshots: terser: 5.46.1 yaml: 2.8.3 - vitest-axe@1.0.0-pre.5(vitest@4.1.4(@types/node@24.12.2)(@vitest/coverage-v8@4.1.4)(jsdom@26.1.0)(vite@8.0.8(@types/node@24.12.2)(esbuild@0.27.7)(jiti@2.6.1)(sass@1.99.0)(terser@5.46.1)(yaml@2.8.3))): + vitest-axe@1.0.0-pre.5(vitest@4.1.4): dependencies: '@vitest/pretty-format': 3.2.4 axe-core: 4.11.3 From 00d6e034a08ca6bcb0e66c195f72498ad84b9ad9 Mon Sep 17 00:00:00 2001 From: Timo K Date: Tue, 21 Apr 2026 10:53:56 +0200 Subject: [PATCH 02/10] fixup some missing yarn -> pnpm transitions --- .githooks/post-commit | 5 ++--- .githooks/pre-commit | 3 +-- README.md | 14 +++++++------- WIDGET_TEST.md | 4 ++-- backend/dev_nginx.conf | 20 ++++++++++---------- docs/linking.md | 6 +++--- docs/self-hosting.md | 4 ++-- embedded/android/publish_android_package.sh | 8 ++++---- knip.ts | 8 +------- renovate.json | 4 ++-- sdk/README.md | 4 ++-- sdk/main.ts | 2 +- src/livekit/BlurBackgroundTransformer.ts | 2 +- 13 files changed, 38 insertions(+), 46 deletions(-) diff --git a/.githooks/post-commit b/.githooks/post-commit index 9054c0e1..243b4f51 100755 --- a/.githooks/post-commit +++ b/.githooks/post-commit @@ -4,9 +4,8 @@ FILE=.links.cjs FILE_DIS=.links.temp-disabled.cjs if test -f "$FILE_DIS"; then # Only do the post-commit hook if the file was temp-disabled by the pre-commit hook. - # Otherwise linking was actively (`yarn links:disable`) disabled and this hook should noop. + # Otherwise linking was actively (`pnpm links:disable`) disabled and this hook should noop. mv $FILE_DIS $FILE - yarnLog=$(yarn) - echo "[yarn-linker] The post-commit hook has re-enabled $FILE" + echo "[pnpm-linker] The post-commit hook has re-enabled $FILE" exit 1 fi diff --git a/.githooks/pre-commit b/.githooks/pre-commit index 6d8d26b0..f8ecfe4d 100755 --- a/.githooks/pre-commit +++ b/.githooks/pre-commit @@ -4,9 +4,8 @@ FILE=.links.cjs FILE_DIS=.links.temp-disabled.cjs if test -f "$FILE"; then mv $FILE .links.temp-disabled.cjs - # echo "running yarn" x=$(pnpm install) y=$(git add pnpm-lock.yaml) - echo "[yarn-linker] The pre-commit hook has disabled $FILE and MODIFIED the pnpm-lock.yaml file. Review the staged changes (the hook added pnpm-lock.yaml, was this desired?) and run \`git commit \` again if they look okay. The post-commit hook will re-enable your links." + echo "[pnpm-linker] The pre-commit hook has disabled $FILE and MODIFIED the pnpm-lock.yaml file. Review the staged changes (the hook added pnpm-lock.yaml, was this desired?) and run \`git commit \` again if they look okay. The post-commit hook will re-enable your links." exit 1 fi diff --git a/README.md b/README.md index 688a7a7f..3685e523 100644 --- a/README.md +++ b/README.md @@ -186,7 +186,7 @@ To get started clone and set up this project: git clone https://github.com/element-hq/element-call.git cd element-call corepack enable -yarn +pnpm install ``` To use it, create a local config by, e.g., @@ -197,7 +197,7 @@ environment as outlined in the next section out of box. You're now ready to launch the development server: ```sh -yarn dev +pnpm dev ``` See also: @@ -230,7 +230,7 @@ only for local development and **_never be exposed to the public Internet._** Run backend components: ```sh -yarn backend +pnpm backend # or for podman-compose # podman-compose -f dev-backend-docker-compose.yml up ``` @@ -260,13 +260,13 @@ on https://localhost:3000 (this is configured in `playwright.config.ts`) - this is what will be tested. The local backend environment should be running for the test to work: -`yarn backend` +`pnpm backend` There are a few different ways to run the tests yourself. The simplest is to run: ```shell -yarn run test:playwright +pnpm run test:playwright ``` This will run the Playwright tests once, non-interactively. @@ -274,7 +274,7 @@ This will run the Playwright tests once, non-interactively. There is a more user-friendly way to run the tests in interactive mode: ```shell -yarn run test:playwright:open +pnpm run test:playwright:open ``` The easiest way to develop new test is to use the codegen feature of Playwright: @@ -316,7 +316,7 @@ To add a new translation key you can do these steps: 1. Add the new key entry to the code where the new key is used: `t("some_new_key")` -1. Run `yarn i18n` to extract the new key and update the translation files. This +1. Run `pnpm i18n` to extract the new key and update the translation files. This will add a skeleton entry to the `locales/en/app.json` file: ```jsonc diff --git a/WIDGET_TEST.md b/WIDGET_TEST.md index 53e26a29..fbad026a 100644 --- a/WIDGET_TEST.md +++ b/WIDGET_TEST.md @@ -1,6 +1,6 @@ # Testing Element-Call in widget mode -When running `yarn backend` the latest element-web develop will be deployed and served on `http://localhost:8081`. +When running `pnpm backend` the latest element-web develop will be deployed and served on `http://localhost:8081`. In a development environment, you might prefer to just use the `element-web` repo directly, but this setup is useful for CI/CD testing. ## Setup @@ -18,7 +18,7 @@ that uses It is part of the existing backend setup. To start the backend, run: ```sh -yarn backend +pnpm backend ``` Then open `http://localhost:8081` in your browser. diff --git a/backend/dev_nginx.conf b/backend/dev_nginx.conf index d3ddbc53..bfd79fa2 100644 --- a/backend/dev_nginx.conf +++ b/backend/dev_nginx.conf @@ -28,11 +28,11 @@ server { # Reason: the lk-jwt-service uses the federation API for the openid token # verification, which requires TLS location ~ ^(/_matrix|/_synapse/client) { - proxy_pass "http://homeserver:8008"; + proxy_pass "http://homeserver:8008"; proxy_http_version 1.1; proxy_set_header X-Forwarded-For $remote_addr; proxy_set_header X-Forwarded-Proto $scheme; - proxy_set_header Host $host; + proxy_set_header Host $host; } error_page 500 502 503 504 /50x.html; @@ -73,7 +73,7 @@ server { proxy_http_version 1.1; proxy_set_header X-Forwarded-For $remote_addr; proxy_set_header X-Forwarded-Proto $scheme; - proxy_set_header Host $host; + proxy_set_header Host $host; } error_page 500 502 503 504 /50x.html; @@ -108,7 +108,7 @@ server { # JWT Service running at port 6080 proxy_pass http://jwt-auth-services/; - + } location ^~ /livekit/sfu/ { @@ -128,7 +128,7 @@ server { # LiveKit SFU websocket connection running at port 7880 proxy_pass http://livekit-sfu:7880/; } - + error_page 500 502 503 504 /50x.html; } @@ -156,7 +156,7 @@ server { # JWT Service running at port 16080 proxy_pass http://auth-service-1:16080/; - + } location ^~ /livekit/sfu/ { @@ -176,14 +176,14 @@ server { # LiveKit SFU websocket connection running at port 17880 proxy_pass http://livekit-sfu-1:17880/; } - + error_page 500 502 503 504 /50x.html; } # Convenience reverse proxy for the call.m.localhost domain to element call # running on the host either via -# - yarn dev --host or +# - pnpm dev --host or # - falling back to http (the element call docker container) server { listen 80; @@ -260,7 +260,7 @@ server { proxy_ssl_verify off; } - + error_page 500 502 503 504 /50x.html; } @@ -293,7 +293,7 @@ server { proxy_ssl_verify off; } - + error_page 500 502 503 504 /50x.html; } diff --git a/docs/linking.md b/docs/linking.md index 689a6f02..4ac6abf7 100644 --- a/docs/linking.md +++ b/docs/linking.md @@ -23,18 +23,18 @@ One always needs to run: ```bash mv .links.cjs .links.disabled.cjs -yarn +pnpm install ``` before committing a change. To make it more convenient to work with this linking system we added git hooks. -A `pre-commit` hook will run `mv .links.yaml .links.disabled.yaml`, `yarn` and `git add yarn.lock` if it detects +A `pre-commit` hook will run `mv .links.yaml .links.disabled.yaml`, `pnpm install` and `git add yarn.lock` if it detects a `.links.yaml` file and abort the commit. You will than need to check if the resulting changes are appropriate and commit again. A `post-commit` hook will setup the linking as it was -before if a `.links.disabled.yaml` is present. It runs `mv .links.disabled.yaml .links.yaml` and `yarn`. +before if a `.links.disabled.cjs` is present. It runs `mv .links.disabled.cjs .links.cjs` and `pnpm install`. To activate the hooks automatically configure git with diff --git a/docs/self-hosting.md b/docs/self-hosting.md index d6d46421..dc1dd687 100644 --- a/docs/self-hosting.md +++ b/docs/self-hosting.md @@ -237,8 +237,8 @@ source. First, clone and install the package: git clone https://github.com/element-hq/element-call.git cd element-call corepack enable -yarn -yarn build +pnpm install +pnpm build ``` If all went well, you can now find the build output under `dist` as a series of diff --git a/embedded/android/publish_android_package.sh b/embedded/android/publish_android_package.sh index 8c310c9b..31693317 100755 --- a/embedded/android/publish_android_package.sh +++ b/embedded/android/publish_android_package.sh @@ -11,7 +11,7 @@ pushd $CURRENT_DIR > /dev/null function build_assets() { echo "Generating Element Call assets..." pushd ../.. > /dev/null - yarn build + pnpm build popd > /dev/null } @@ -26,7 +26,7 @@ function copy_assets() { } getopts :sh opt -case $opt in +case $opt in s) SKIP=1 ;; @@ -41,7 +41,7 @@ if [ ! $SKIP ]; then echo "" if [[ $REPLY =~ ^[Yy]$ ]]; then build_assets - else + else echo "Using existing assets from ../../dist" fi copy_assets @@ -56,4 +56,4 @@ echo "Publishing the Android project" ./gradlew publishAndReleaseToMavenCentral --no-daemon -popd > /dev/null \ No newline at end of file +popd > /dev/null diff --git a/knip.ts b/knip.ts index 3be3e653..aa6aee79 100644 --- a/knip.ts +++ b/knip.ts @@ -30,16 +30,10 @@ export default { "@types/content-type", "@types/sdp-transform", "@types/uuid", - // We obviously use this, but if the package has been linked with yarn link, + // We obviously use this, but if the package has been linked with pnpm link, // then Knip will flag it as a false positive // https://github.com/webpro-nl/knip/issues/766 "@vector-im/compound-web", - // Yarn plugins are allowed to depend on packages provided by the Yarn - // runtime. These shouldn't be listed in package.json, because plugins - // should work before Yarn even installs dependencies for the first time. - // https://yarnpkg.com/advanced/plugin-tutorial#what-does-a-plugin-look-like - "@yarnpkg/core", - "@yarnpkg/parsers", "matrix-widget-api", ], ignoreExportsUsedInFile: true, diff --git a/renovate.json b/renovate.json index 612e6674..39fbf0c1 100644 --- a/renovate.json +++ b/renovate.json @@ -54,8 +54,8 @@ "matchFileNames": ["embedded/**/*"] }, { - "groupName": "Yarn", - "matchDepNames": ["yarn"] + "groupName": "Pnpm", + "matchDepNames": ["pnpm"] } ], "semanticCommits": "disabled", diff --git a/sdk/README.md b/sdk/README.md index ad8ff97e..7102ba29 100644 --- a/sdk/README.md +++ b/sdk/README.md @@ -13,8 +13,8 @@ This folder contains an example index.html file that showcases the sdk in use (h To get started run ``` -yarn -yarn build:sdk +pnpm install +pnpm build:sdk ``` in the repository root. diff --git a/sdk/main.ts b/sdk/main.ts index c65bf4a7..286c16ea 100644 --- a/sdk/main.ts +++ b/sdk/main.ts @@ -8,7 +8,7 @@ Please see LICENSE in the repository root for full details. /** * EXPERIMENTAL * - * This file is the entrypoint for the sdk build of element call: `yarn build:sdk` + * This file is the entrypoint for the sdk build of element call: `pnpm build:sdk` * use in widgets. * It exposes the `createMatrixRTCSdk` which creates the `MatrixRTCSdk` interface (see below) that * can be used to join a rtc session and exchange realtime data. diff --git a/src/livekit/BlurBackgroundTransformer.ts b/src/livekit/BlurBackgroundTransformer.ts index c3d885ba..7bec3cc4 100644 --- a/src/livekit/BlurBackgroundTransformer.ts +++ b/src/livekit/BlurBackgroundTransformer.ts @@ -29,7 +29,7 @@ interface WasmFileset { // MediaPipe and depend on node_modules having this specific structure. It's // easy to see this breaking if our dependencies changed and MediaPipe were // no longer hoisted, or if we switched to another dependency loader such as -// Yarn PnP. +// pnpm PnP. // https://github.com/google-ai-edge/mediapipe/issues/5961 const wasmFileset: WasmFileset = { wasmLoaderPath: new URL( From b58076f1b93bdd17ec33ac0596d11c831b832fec Mon Sep 17 00:00:00 2001 From: Timo K Date: Tue, 21 Apr 2026 15:06:06 +0200 Subject: [PATCH 03/10] remove pnpmfileChecksum and .pnpmfile.cjs --- .pnpmfile.cjs | 58 -------------------------------------------------- pnpm-lock.yaml | 2 -- 2 files changed, 60 deletions(-) delete mode 100644 .pnpmfile.cjs diff --git a/.pnpmfile.cjs b/.pnpmfile.cjs deleted file mode 100644 index f5759c26..00000000 --- a/.pnpmfile.cjs +++ /dev/null @@ -1,58 +0,0 @@ -/* -Copyright 2026 Element Creations Ltd. - -SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial -Please see LICENSE in the repository root for full details. -*/ - -// Created based on https://github.com/element-hq/element-call/blob/60fae70a60e3697eb41210ccf1e400cab37df7c8/.yarn/plugins/linker.cjs -// and the following prompt history: -// - Can you convert this yarn plugin into a pnpm plugin. -// - The goal is to not have modifications to the package.json and lock files so that we do not track links on gh. -// This seems to modify the package.json file. -// What can we do with pnpm to have the link inforamtion in a seperate file -// - why do you cache the loaded links. When does this file get executed? -// Do we need this optimization. -// How do we guarantee, that we aleays use the most recent content from the links file? -// -// Manual transition to cjs. Claude proposed manual yaml parsing. - -const fs = require("fs"); -const path = require("path"); - -function loadLinks() { - try { - return require(path.join(__dirname, ".links.cjs")); - } catch (e) { - return null; - } -} - -function readPackage(pkg, context) { - const links = loadLinks(); - if (!links) return pkg; - - const manifest = JSON.parse( - fs.readFileSync(path.join(__dirname, "package.json"), "utf8"), - ); - if (pkg.name !== manifest.name) return pkg; - - for (const [name, linkPath] of Object.entries(links)) { - const resolved = `link:${path.resolve(__dirname, linkPath)}`; - if (pkg.dependencies && pkg.dependencies[name]) { - context.log(`Linking ${name} -> ${resolved}`); - pkg.dependencies[name] = resolved; - } else if (pkg.devDependencies && pkg.devDependencies[name]) { - context.log(`Linking ${name} -> ${resolved}`); - pkg.devDependencies[name] = resolved; - } - } - - return pkg; -} - -module.exports = { - hooks: { - readPackage, - }, -}; diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 7bbc1dcb..f75fdaa1 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -14,8 +14,6 @@ overrides: js-yaml: ^4.1.1 esbuild: ^0.27.7 -pnpmfileChecksum: sha256-toM8G/xDIU9KCsLzvrWKlNM+7K7S70ZB0m5kCeEztjs= - importers: .: From 741b82b0263ff79c98ac48a0f6ea9dbd7e8b2e95 Mon Sep 17 00:00:00 2001 From: Timo K Date: Tue, 21 Apr 2026 16:06:51 +0200 Subject: [PATCH 04/10] update linking realted logic - remove post-commit hook - remove .links.cjs enable/disable (instead just add/rm .pnpmfile.cjs) - rename pnpm links:enable -> pnpm links:on - rename pnpm links:disable -> pnpm links:off - unify doc filenames `-` -> `_` - add linking_concept_reasoning.md to provide background why the linking is how it is. --- .githooks/post-commit | 11 ---- .githooks/pre-commit | 14 ++--- README.md | 6 +- docs/README.md | 6 +- ...d-standalone.md => embedded_standalone.md} | 6 +- docs/linking.md | 45 +++++++++----- docs/linking_concept_reasoning.md | 27 ++++++++ docs/{self-hosting.md => self_hosting.md} | 0 docs/{url-params.md => url_params.md} | 14 ++--- package.json | 4 +- pnpm-lock.yaml | 8 +-- scripts/.pnpmfile.cjs | 62 +++++++++++++++++++ scripts/setup-linking.sh | 26 ++++++++ 13 files changed, 174 insertions(+), 55 deletions(-) delete mode 100755 .githooks/post-commit rename docs/{embedded-standalone.md => embedded_standalone.md} (97%) create mode 100644 docs/linking_concept_reasoning.md rename docs/{self-hosting.md => self_hosting.md} (100%) rename docs/{url-params.md => url_params.md} (97%) create mode 100644 scripts/.pnpmfile.cjs create mode 100755 scripts/setup-linking.sh diff --git a/.githooks/post-commit b/.githooks/post-commit deleted file mode 100755 index 243b4f51..00000000 --- a/.githooks/post-commit +++ /dev/null @@ -1,11 +0,0 @@ -#!/usr/bin/sh - -FILE=.links.cjs -FILE_DIS=.links.temp-disabled.cjs -if test -f "$FILE_DIS"; then - # Only do the post-commit hook if the file was temp-disabled by the pre-commit hook. - # Otherwise linking was actively (`pnpm links:disable`) disabled and this hook should noop. - mv $FILE_DIS $FILE - echo "[pnpm-linker] The post-commit hook has re-enabled $FILE" - exit 1 -fi diff --git a/.githooks/pre-commit b/.githooks/pre-commit index f8ecfe4d..2656c9b9 100755 --- a/.githooks/pre-commit +++ b/.githooks/pre-commit @@ -1,11 +1,9 @@ -#!/usr/bin/sh +#!/usr/bin/env bash -FILE=.links.cjs -FILE_DIS=.links.temp-disabled.cjs -if test -f "$FILE"; then - mv $FILE .links.temp-disabled.cjs - x=$(pnpm install) - y=$(git add pnpm-lock.yaml) - echo "[pnpm-linker] The pre-commit hook has disabled $FILE and MODIFIED the pnpm-lock.yaml file. Review the staged changes (the hook added pnpm-lock.yaml, was this desired?) and run \`git commit \` again if they look okay. The post-commit hook will re-enable your links." +# Checks if there currently is linking configured. Informs the user to disable linking before committing. + +PNPMFILE=.pnpmfile.cjs +if test -f "$PNPMFILE"; then + echo "[pnpm-linker] The pre-commit hook detected $PNPMFILE which implies you have linked packages in your pnpm-lock.yaml. Run pnpm links:off and commit again. See also linking.md." exit 1 fi diff --git a/README.md b/README.md index 3685e523..0c82e4b0 100644 --- a/README.md +++ b/README.md @@ -108,17 +108,17 @@ recommended method for embedding Element Call.

For more details on the packages, see the -[Embedded vs. Standalone Guide](./docs/embedded-standalone.md). +[Embedded vs. Standalone Guide](./docs/embedded_standalone.md). ## 🛠️ Self-Hosting For operating and deploying Element Call on your own server, refer to the -[**Self-Hosting Guide**](./docs/self-hosting.md). +[**Self-Hosting Guide**](./docs/self_hosting.md). ## 🧭 MatrixRTC Backend Discovery and Selection For proper Element Call operation each site deployment needs a MatrixRTC backend -setup as outlined in the [Self-Hosting](#self-hosting). A typical federated site +setup as outlined in the [Self-Hosting](#self_hosting). A typical federated site deployment for three different sites A, B and C is depicted below.

diff --git a/docs/README.md b/docs/README.md index d97e8d56..e5a5d08a 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,8 +2,8 @@ This folder contains documentation for setup, usage, and development of Element Call. -- [Embedded vs standalone mode](./embedded-standalone.md) -- [Url format and parameters](./url-params.md) +- [Embedded vs standalone mode](./embedded_standalone.md) +- [Url format and parameters](./url_params.md) - [Global JS controls](./controls.md) -- [Self-Hosting](./self-hosting.md) +- [Self-Hosting](./self_hosting.md) - [Developing with linked packages](./linking.md) diff --git a/docs/embedded-standalone.md b/docs/embedded_standalone.md similarity index 97% rename from docs/embedded-standalone.md rename to docs/embedded_standalone.md index 440dfac0..24ad2a7d 100644 --- a/docs/embedded-standalone.md +++ b/docs/embedded_standalone.md @@ -14,7 +14,7 @@ The table below provides a comparison of the two packages: | **Release artifacts** | Docker Image, Tarball | Tarball, NPM for Web, Android AAR, SwiftPM for iOS | | **Recommended for** | Standalone/guest access usage | Embedding within messenger apps | | **Responsibility for regulatory compliance** | The administrator that is deploying the app is responsible for compliance with any applicable regulations (e.g. privacy) | The developer of the messenger app is responsible for compliance | -| **Analytics consent** | Element Call will show a consent UI. | Element Call will not show a consent UI. The messenger app should only provide the embedded Element Call with the [analytics URL parameters](./url-params.md#embedded-only-parameters) if consent has been granted. | +| **Analytics consent** | Element Call will show a consent UI. | Element Call will not show a consent UI. The messenger app should only provide the embedded Element Call with the [analytics URL parameters](./url_params.md#embedded-only-parameters) if consent has been granted. | | **Analytics data** | Element Call will send data to the Posthog, Sentry and Open Telemetry targets specified by the administrator in the `config.json` | Element Call will send data to the Posthog and Sentry targets specified in the URL parameters by the messenger app | ### Using the embedded package within a messenger app @@ -26,7 +26,7 @@ The basics are: 1. Add the appropriate platform dependency as given for a [release](https://github.com/element-hq/element-call/releases), or use the embedded tarball. e.g. `npm install @element-hq/element-call-embedded@0.9.0` 2. Include the assets from the platform dependency in the build process. e.g. copy the assets during a [Webpack](https://github.com/element-hq/element-web/blob/247cd8d56d832d006d7dfb919d1042529d712b59/webpack.config.js#L677-L682) build. 3. Use the `index.html` entrypointof the imported assets when you are constructing the WebView or iframe. e.g. using a [relative path in a webapp](https://github.com/element-hq/element-web/blob/247cd8d56d832d006d7dfb919d1042529d712b59/src/models/Call.ts#L680), or on the the Android [WebViewAssetLoader](https://github.com/element-hq/element-x-android/blob/fe5aab6588ecdcf9354a3bfbd9e97c1b31175a8f/features/call/impl/src/main/kotlin/io/element/android/features/call/impl/utils/DefaultCallWidgetProvider.kt#L20) -4. Set any of the [embedded-only URL parameters](./url-params.md#embedded-only-parameters) that you need. +4. Set any of the [embedded-only URL parameters](./url_params.md#embedded-only-parameters) that you need. ## Widget vs standalone mode @@ -36,4 +36,4 @@ As a widget, the app only uses the core calling (MatrixRTC) parts. The rest (aut Element Call and the hosting client are connected via the widget API. Element Call detects that it is run as a widget if a widgetId is defined in the url parameters. If `widgetId` is present then Element Call will try to connect to the client via the widget postMessage API using the parameters provided in [Url Format and parameters -](./url-params.md). +](./url_params.md). diff --git a/docs/linking.md b/docs/linking.md index 4ac6abf7..b9c62edf 100644 --- a/docs/linking.md +++ b/docs/linking.md @@ -1,8 +1,25 @@ +## Quickstart guide +run +```bash +./scripts/setup-linking.sh +``` +Read the script output: +``` +Setup complete. +Update: .links.cjs to your liking +Run: 'pnpm links:on' to test your .links.cjs +Run: 'git commit' with links enabled to test the git pre-commit hook. +Run: 'pnpm links:off' to be able to commit again +Run: 'git config --local core.hooksPath ""' to allow committing with linking (not recommended) +Run: 'rm links.cjs' & 'git config --local core.hooksPath ""' to fully revert what this script did +``` + + # Developing with linked packages -If you want to make changes to a package that Element Call depends on and see those changes applied in real time, you can create a link to a local copy of the package. Pnpm has a command for this (`pnpm link`), but it's not recommended to use it as it ends up modifying package.json with details specific to your development environment. +If you want to make changes to a package that Element Call depends on and see those changes applied in real time, you can create a link to a local copy of the package. `pnpm` has a command for this (`pnpm link`), but it's not recommended to use it as it ends up modifying package.json with details specific to your development environment. -Instead, you can use our little 'linker' plugin. Create a file named `.links.cjs` in the Element Call project directory, listing the names and paths of any dependencies you want to link. For example: +Instead, create a file named `.links.cjs` in the Element Call project directory (or run `./scripts/setup-linking.sh` to create a template), listing the names and paths of any dependencies you want to link. For example: ```cjs // Packages to link to local checkouts @@ -12,32 +29,32 @@ module.exports = { }; ``` -Then run `pnpm install`. +Then run `pnpm links:on`. (this will activate the pnpm file + run `pnpm install` to setup the linking) ## Hooks -Changes in `.links.yaml` will also update `pnpm-lock.yaml` when `pnpm` is executed. The lockfile will then contain the local +Changes in `.links.cjs` will also update `pnpm-lock.yaml` when `pnpm install` is executed. The lockfile will then contain the local version of the package which would not work on others dev setups or the github CI. -One always needs to run: +One always needs to remove the pnpm `readPackage` script (the `.pnpmfile.cjs`) and run: ```bash -mv .links.cjs .links.disabled.cjs pnpm install ``` before committing a change. -To make it more convenient to work with this linking system we added git hooks. -A `pre-commit` hook will run `mv .links.yaml .links.disabled.yaml`, `pnpm install` and `git add yarn.lock` if it detects -a `.links.yaml` file and abort the commit. -You will than need to check if the resulting changes are appropriate and commit again. +To make this less of a foot gun we added a git hook. +A `pre-commit` hook will check if linking is currently used. If it detects +a `.pnpmfile.cjs` file it will abort the commit with an explanatory message. +You will than need to run `pnpm links:off` and commit again. -A `post-commit` hook will setup the linking as it was -before if a `.links.disabled.cjs` is present. It runs `mv .links.disabled.cjs .links.cjs` and `pnpm install`. - -To activate the hooks automatically configure git with +To activate the hooks configure git with (when using the setup script (`./scripts/setup-linking.sh`) this is already done): ```bash git config --local core.hooksPath .githooks ``` +This will add the hook path for this repository only to .gihooks. which is a tracked (by git) folder containing the pre-commit hook. + +## Background +Information, why this approach is used can be found in the [linking concept reasoning](./linking_concept_reasoning.md) document. diff --git a/docs/linking_concept_reasoning.md b/docs/linking_concept_reasoning.md new file mode 100644 index 00000000..37221344 --- /dev/null +++ b/docs/linking_concept_reasoning.md @@ -0,0 +1,27 @@ + +### Why do we not enable .pnpmfile.cjs by default +Background: The presence of the `.pnpmfile.cjs` adds a field to the `pnpm-lock.yaml` called: `pnpmfileChecksum`. This field is a checksum of the content of the `.pnpmfile.cjs` file. +`pnpm install --frozen-lockfile` **fails** if there is a `.pnpmfile.cjs` but no `pnpmfileChecksum` or vice versa (or on mismatch). + +_TLDR: running with `--ignore-pnpmfile` will fail if `pnpmfileChecksum` is present._ + +#### `pnpmfileChecksum` + renovate bot +When the renovate bot creates a PR it runs `pnpm install --ignore-pnpmfile`. This means that the `pnpmfileChecksum` in the lockfile will be **empty**. +This breaks builds that **don't** ignore the `.pnpmfile.cjs`-file. (CI that runs on the renovate PR) +From here we have two possible paths: + - ignore `.pnpmfile.cjs` in all CI builds CI will also fail if we accidently add it locally. + - fixup the `pnpm-lock.yaml` in the renovate PR to contain the correct `pnpmfileChecksum`. + + Ignoring in all CI builds means that CI will always fail if we enable the linking system. + This is annoying but can be worked around with the git hook we provide that at least lets us know that we are + commiting with enabled linking. + Only if we remember setting it back/disbale linking (or let ourselves remember by the git hook) the CI will work. + + #### Summary + - We will always run into conflicts with the `pnpmfileChecksum` because in renovate prs it will be empty (`--ignore-pnpmfile`) + - To keep it simple we set `--ignore-pnpmfile` in all of ours CI to see issues immediately. + - The only solution is to never have a `.pnpmfile.cjs` in the repository when pushing. + - This way there will never be a commit with `pnpmfileChecksum` in the lockfile. + - renovate (which uses `--ignore-pnpmfile` which we cannot disable) and other CI will work + - We are able to use the linking system locally if we `cp` this file from the scripts folder into `./` on demand. + - `pnpm links:on` and `pnpm links:off` + `./scripts/setup-linking.sh` will help us with this. diff --git a/docs/self-hosting.md b/docs/self_hosting.md similarity index 100% rename from docs/self-hosting.md rename to docs/self_hosting.md diff --git a/docs/url-params.md b/docs/url_params.md similarity index 97% rename from docs/url-params.md rename to docs/url_params.md index a1e4793d..e88e7095 100644 --- a/docs/url-params.md +++ b/docs/url_params.md @@ -4,7 +4,7 @@ There are two formats for Element Call URLs. ## Link for sharing -Requires Element Call to be deployed in [standalone](./embedded-standalone.md) mode. +Requires Element Call to be deployed in [standalone](./embedded_standalone.md) mode. ```text https://element_call.domain/room/# @@ -36,15 +36,15 @@ possible to support encryption. | Package | Deployment | URL | | ------------------------------------ | ----------------------------- | ----------------------------------------------------------------------------- | -| [Full](./embedded-standalone.md) | All | `https://element_call.domain/room` | -| [Embedded](./embedded-standalone.md) | Remote URL | `https://element_call.domain/` n.b. no `/room` part | -| [Embedded](./embedded-standalone.md) | Embedded within messenger app | Platform dependent, but you load the `index.html` file without a `/room` part | +| [Full](./embedded_standalone.md) | All | `https://element_call.domain/room` | +| [Embedded](./embedded_standalone.md) | Remote URL | `https://element_call.domain/` n.b. no `/room` part | +| [Embedded](./embedded_standalone.md) | Embedded within messenger app | Platform dependent, but you load the `index.html` file without a `/room` part | ## Parameters ### Common Parameters -These parameters are relevant to both [widget](./embedded-standalone.md) and [standalone](./embedded-standalone.md) modes: +These parameters are relevant to both [widget](./embedded_standalone.md) and [standalone](./embedded_standalone.md) modes: | Name | Values | Required for widget | Required for SPA | Description | | ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------- | ---------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | @@ -74,7 +74,7 @@ These parameters are relevant to both [widget](./embedded-standalone.md) and [st ### Widget-only parameters -These parameters are only supported in [widget](./embedded-standalone.md) mode. +These parameters are only supported in [widget](./embedded_standalone.md) mode. | Name | Values | Required | Description | | --------------- | ----------------------------------------------------------------------------------------- | ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | @@ -89,7 +89,7 @@ These parameters are only supported in [widget](./embedded-standalone.md) mode. ### Embedded-only parameters -These parameters are only supported in the [embedded](./embedded-standalone.md) package of Element Call and will be ignored in the [full](./embedded-standalone.md) package. +These parameters are only supported in the [embedded](./embedded_standalone.md) package of Element Call and will be ignored in the [full](./embedded_standalone.md) package. | Name | Values | Required | Description | | -------------------- | -------------------------------------------------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------- | diff --git a/package.json b/package.json index 867822c9..da6b7a2d 100644 --- a/package.json +++ b/package.json @@ -32,8 +32,8 @@ "backend-playwright": "docker-compose -f playwright-backend-docker-compose.yml -f playwright-backend-docker-compose.override.yml up", "test:playwright": "playwright test", "test:playwright:open": "pnpm test:playwright --ui", - "links:enable": "mv .links.disabled.cjs .links.cjs & touch .links.cjs", - "links:disable": "mv .links.cjs .links.disabled.cjs", + "links:on": "cp scripts/.pnpmfile.cjs .pnpmfile.cjs & pnpm install", + "links:off": "rm .pnpmfile.cjs & pnpm install", "storybook": "storybook dev -p 6006", "build-storybook": "storybook build" }, diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index f75fdaa1..c9d752ab 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -236,7 +236,7 @@ importers: version: 1.9.2 matrix-js-sdk: specifier: matrix-org/matrix-js-sdk#develop - version: https://codeload.github.com/matrix-org/matrix-js-sdk/tar.gz/4ee3e591bf6498eecc1a92aad92b2ff3fc604fb8 + version: https://codeload.github.com/matrix-org/matrix-js-sdk/tar.gz/d7d771fadb983bf40bed2c97aa31c398d8eec875 matrix-widget-api: specifier: ^1.16.1 version: 1.17.0 @@ -4974,8 +4974,8 @@ packages: matrix-events-sdk@0.0.1: resolution: {integrity: sha512-1QEOsXO+bhyCroIe2/A5OwaxHvBm7EsSQ46DEDn8RBIfQwN5HWBpFvyWWR4QY0KHPPnnJdI99wgRiAl7Ad5qaA==} - matrix-js-sdk@https://codeload.github.com/matrix-org/matrix-js-sdk/tar.gz/4ee3e591bf6498eecc1a92aad92b2ff3fc604fb8: - resolution: {tarball: https://codeload.github.com/matrix-org/matrix-js-sdk/tar.gz/4ee3e591bf6498eecc1a92aad92b2ff3fc604fb8} + matrix-js-sdk@https://codeload.github.com/matrix-org/matrix-js-sdk/tar.gz/d7d771fadb983bf40bed2c97aa31c398d8eec875: + resolution: {tarball: https://codeload.github.com/matrix-org/matrix-js-sdk/tar.gz/d7d771fadb983bf40bed2c97aa31c398d8eec875} version: 41.3.0 engines: {node: '>=22.0.0'} @@ -11749,7 +11749,7 @@ snapshots: matrix-events-sdk@0.0.1: {} - matrix-js-sdk@https://codeload.github.com/matrix-org/matrix-js-sdk/tar.gz/4ee3e591bf6498eecc1a92aad92b2ff3fc604fb8: + matrix-js-sdk@https://codeload.github.com/matrix-org/matrix-js-sdk/tar.gz/d7d771fadb983bf40bed2c97aa31c398d8eec875: dependencies: '@babel/runtime': 7.29.2 '@matrix-org/matrix-sdk-crypto-wasm': 18.1.0 diff --git a/scripts/.pnpmfile.cjs b/scripts/.pnpmfile.cjs new file mode 100644 index 00000000..23b0759f --- /dev/null +++ b/scripts/.pnpmfile.cjs @@ -0,0 +1,62 @@ +/* +Copyright 2026 Element Creations Ltd. + +SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial +Please see LICENSE in the repository root for full details. +*/ +// DONT RUN THIS FILE MANUALLY +// This file is intended to be used with `pnpm links:on` and `pnpm links:off` which will copy this file to the project root. +// See docs/linking.md for details. +// +// +// Created based on https://github.com/element-hq/element-call/blob/60fae70a60e3697eb41210ccf1e400cab37df7c8/.yarn/plugins/linker.cjs +// and the following prompt history: +// - Can you convert this yarn plugin into a pnpm plugin. +// - The goal is to not have modifications to the package.json and lock files so that we do not track links on gh. +// This seems to modify the package.json file. +// What can we do with pnpm to have the link inforamtion in a seperate file +// - why do you cache the loaded links. When does this file get executed? +// Do we need this optimization. +// How do we guarantee, that we aleays use the most recent content from the links file? +// +// Manual transition to cjs. Claude proposed manual yaml parsing. + +const fs = require("fs"); +const path = require("path"); + +function loadLinks() { + try { + return require(path.join(__dirname, ".links.cjs")); + } catch (e) { + return null; + } +} + +function readPackage(pkg, context) { + const links = loadLinks(); + if (!links) return pkg; + + const manifest = JSON.parse( + fs.readFileSync(path.join(__dirname, "package.json"), "utf8"), + ); + if (pkg.name !== manifest.name) return pkg; + + for (const [name, linkPath] of Object.entries(links)) { + const resolved = `link:${path.resolve(__dirname, linkPath)}`; + if (pkg.dependencies && pkg.dependencies[name]) { + context.log(`Linking ${name} -> ${resolved}`); + pkg.dependencies[name] = resolved; + } else if (pkg.devDependencies && pkg.devDependencies[name]) { + context.log(`Linking ${name} -> ${resolved}`); + pkg.devDependencies[name] = resolved; + } + } + + return pkg; +} + +module.exports = { + hooks: { + readPackage, + }, +}; diff --git a/scripts/setup-linking.sh b/scripts/setup-linking.sh new file mode 100755 index 00000000..b20228d6 --- /dev/null +++ b/scripts/setup-linking.sh @@ -0,0 +1,26 @@ +#!/usr/bin/env bash + +# Checks if there currently is linking configured. Informs the user to disable linking before committing. + +LINKSFILE=.links.cjs +echo "Checking for existing linking configuration in $LINKSFILE..." +if test -f "$LINKSFILE"; then +echo "Linking configuration found in $LINKSFILE." +else + echo "No $LINKSFILE -> Creating $LINKSFILE with default values. Please edit this file to point to your local checkouts of the dependencies you want to link." + echo '''// Packages to link to local checkouts +module.exports = { + "matrix-js-sdk": "../your/path/matrix-js-sdk", + "matrix-widget-api": "../your/path/matrix-widget-api", +};''' > $LINKSFILE +fi +echo "updating local git hookPath to .githooks" +git config --local core.hooksPath .githooks +echo "" +echo "Setup complete." +echo "Update: .links.cjs to your liking" +echo "Run: 'pnpm links:on' to test your .links.cjs" +echo "Run: 'git commit' with links enabled to test the git pre-commit hook." +echo "Run: 'pnpm links:off' to be able to commit again" +echo "Run: 'git config --local core.hooksPath \"\"' to allow committing with linking on (not recommended)" +echo "Run: 'rm links.cjs' & 'git config --local core.hooksPath \"\"' to fully revert what this script did" From 8728676eb6abf0eed37486f78a6bfee175c217b0 Mon Sep 17 00:00:00 2001 From: Timo K Date: Tue, 21 Apr 2026 16:10:45 +0200 Subject: [PATCH 05/10] update CI to ignore pnpmfile - This is save since we never run pnpmfiles in ci - We can still run it locally - It helps us detect if we accidently commit it anyways. --- .github/workflows/build-element-call.yaml | 3 ++- .github/workflows/lint.yaml | 3 ++- .github/workflows/test.yaml | 6 ++++-- .github/workflows/translations-download.yaml | 3 ++- 4 files changed, 10 insertions(+), 5 deletions(-) diff --git a/.github/workflows/build-element-call.yaml b/.github/workflows/build-element-call.yaml index 190cdfdb..f4071975 100644 --- a/.github/workflows/build-element-call.yaml +++ b/.github/workflows/build-element-call.yaml @@ -43,7 +43,8 @@ jobs: cache: "pnpm" node-version-file: ".node-version" - name: Install dependencies - run: "pnpm install --frozen-lockfile" + # ignore-pnpmfile should never be commited. Make CI crash if it happened (`pnpmfileChecksum` is present) + run: "pnpm install --frozen-lockfile --ignore-pnpmfile" - name: Build Element Call run: pnpm run build:"$PACKAGE":"$BUILD_MODE" env: diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml index 60b9095e..0638eca6 100644 --- a/.github/workflows/lint.yaml +++ b/.github/workflows/lint.yaml @@ -18,7 +18,8 @@ jobs: cache: "pnpm" node-version-file: ".node-version" - name: Install dependencies - run: "pnpm install --frozen-lockfile" + # ignore-pnpmfile should never be commited. Make CI crash if it happened (`pnpmfileChecksum` is present) + run: "pnpm install --frozen-lockfile --ignore-pnpmfile" - name: Prettier run: "pnpm run prettier:check" - name: i18n diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml index c436c5ee..d8af6f92 100644 --- a/.github/workflows/test.yaml +++ b/.github/workflows/test.yaml @@ -20,7 +20,8 @@ jobs: cache: "pnpm" node-version-file: ".node-version" - name: Install dependencies - run: "pnpm install --frozen-lockfile" + # ignore-pnpmfile should never be commited. Make CI crash if it happened (`pnpmfileChecksum` is present) + run: "pnpm install --frozen-lockfile --ignore-pnpmfile" - name: Vitest run: "pnpm run test:coverage" - name: Upload to codecov @@ -45,7 +46,8 @@ jobs: cache: "pnpm" node-version-file: ".node-version" - name: Install dependencies - run: pnpm install --frozen-lockfile + # ignore-pnpmfile should never be commited. Make CI crash if it happened (`pnpmfileChecksum` is present) + run: pnpm install --frozen-lockfile --ignore-pnpmfile - name: Install Playwright Browsers run: pnpm exec playwright install --with-deps - name: Run backend components diff --git a/.github/workflows/translations-download.yaml b/.github/workflows/translations-download.yaml index 6339e378..08260a5a 100644 --- a/.github/workflows/translations-download.yaml +++ b/.github/workflows/translations-download.yaml @@ -26,7 +26,8 @@ jobs: node-version-file: ".node-version" - name: Install Deps - run: "pnpm install --frozen-lockfile" + # ignore-pnpmfile should never be commited. Make CI crash if it happened (`pnpmfileChecksum` is present) + run: "pnpm install --frozen-lockfile --ignore-pnpmfile" - name: Prune i18n run: "rm -R locales" From 6ae88531ecec1ebc4259b38fda3e7a8817d8e723 Mon Sep 17 00:00:00 2001 From: Timo K Date: Tue, 21 Apr 2026 16:10:57 +0200 Subject: [PATCH 06/10] pnpm v10.33.0 + lock file --- package.json | 2 +- pnpm-lock.yaml | 37 +++++++++++++++++++++++++++++++++++++ 2 files changed, 38 insertions(+), 1 deletion(-) diff --git a/package.json b/package.json index da6b7a2d..87204c66 100644 --- a/package.json +++ b/package.json @@ -156,5 +156,5 @@ "esbuild": "^0.27.7" } }, - "packageManager": "pnpm@10.0.0" + "packageManager": "pnpm@10.33.0" } diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index c9d752ab..b342500d 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -1700,41 +1700,49 @@ packages: resolution: {integrity: sha512-heV2+jmXyYnUrpUXSPugqWDRpnsQcDm2AX4wzTuvgdlZfoNYO0O3W2AVpJYaDn9AG4JdM6Kxom8+foE7/BcSig==} cpu: [arm64] os: [linux] + libc: [glibc] '@oxc-resolver/binding-linux-arm64-musl@11.19.1': resolution: {integrity: sha512-jvo2Pjs1c9KPxMuMPIeQsgu0mOJF9rEb3y3TdpsrqwxRM+AN6/nDDwv45n5ZrUnQMsdBy5gIabioMKnQfWo9ew==} cpu: [arm64] os: [linux] + libc: [musl] '@oxc-resolver/binding-linux-ppc64-gnu@11.19.1': resolution: {integrity: sha512-vLmdNxWCdN7Uo5suays6A/+ywBby2PWBBPXctWPg5V0+eVuzsJxgAn6MMB4mPlshskYbppjpN2Zg83ArHze9gQ==} cpu: [ppc64] os: [linux] + libc: [glibc] '@oxc-resolver/binding-linux-riscv64-gnu@11.19.1': resolution: {integrity: sha512-/b+WgR+VTSBxzgOhDO7TlMXC1ufPIMR6Vj1zN+/x+MnyXGW7prTLzU9eW85Aj7Th7CCEG9ArCbTeqxCzFWdg2w==} cpu: [riscv64] os: [linux] + libc: [glibc] '@oxc-resolver/binding-linux-riscv64-musl@11.19.1': resolution: {integrity: sha512-YlRdeWb9j42p29ROh+h4eg/OQ3dTJlpHSa+84pUM9+p6i3djtPz1q55yLJhgW9XfDch7FN1pQ/Vd6YP+xfRIuw==} cpu: [riscv64] os: [linux] + libc: [musl] '@oxc-resolver/binding-linux-s390x-gnu@11.19.1': resolution: {integrity: sha512-EDpafVOQWF8/MJynsjOGFThcqhRHy417sRyLfQmeiamJ8qVhSKAn2Dn2VVKUGCjVB9C46VGjhNo7nOPUi1x6uA==} cpu: [s390x] os: [linux] + libc: [glibc] '@oxc-resolver/binding-linux-x64-gnu@11.19.1': resolution: {integrity: sha512-NxjZe+rqWhr+RT8/Ik+5ptA3oz7tUw361Wa5RWQXKnfqwSSHdHyrw6IdcTfYuml9dM856AlKWZIUXDmA9kkiBQ==} cpu: [x64] os: [linux] + libc: [glibc] '@oxc-resolver/binding-linux-x64-musl@11.19.1': resolution: {integrity: sha512-cM/hQwsO3ReJg5kR+SpI69DMfvNCp+A/eVR4b4YClE5bVZwz8rh2Nh05InhwI5HR/9cArbEkzMjcKgTHS6UaNw==} cpu: [x64] os: [linux] + libc: [musl] '@oxc-resolver/binding-openharmony-arm64@11.19.1': resolution: {integrity: sha512-QF080IowFB0+9Rh6RcD19bdgh49BpQHUW5TajG1qvWHvmrQznTZZjYlgE2ltLXyKY+qs4F/v5xuX1XS7Is+3qA==} @@ -1790,36 +1798,42 @@ packages: engines: {node: '>= 10.0.0'} cpu: [arm] os: [linux] + libc: [glibc] '@parcel/watcher-linux-arm-musl@2.5.6': resolution: {integrity: sha512-Ve3gUCG57nuUUSyjBq/MAM0CzArtuIOxsBdQ+ftz6ho8n7s1i9E1Nmk/xmP323r2YL0SONs1EuwqBp2u1k5fxg==} engines: {node: '>= 10.0.0'} cpu: [arm] os: [linux] + libc: [musl] '@parcel/watcher-linux-arm64-glibc@2.5.6': resolution: {integrity: sha512-f2g/DT3NhGPdBmMWYoxixqYr3v/UXcmLOYy16Bx0TM20Tchduwr4EaCbmxh1321TABqPGDpS8D/ggOTaljijOA==} engines: {node: '>= 10.0.0'} cpu: [arm64] os: [linux] + libc: [glibc] '@parcel/watcher-linux-arm64-musl@2.5.6': resolution: {integrity: sha512-qb6naMDGlbCwdhLj6hgoVKJl2odL34z2sqkC7Z6kzir8b5W65WYDpLB6R06KabvZdgoHI/zxke4b3zR0wAbDTA==} engines: {node: '>= 10.0.0'} cpu: [arm64] os: [linux] + libc: [musl] '@parcel/watcher-linux-x64-glibc@2.5.6': resolution: {integrity: sha512-kbT5wvNQlx7NaGjzPFu8nVIW1rWqV780O7ZtkjuWaPUgpv2NMFpjYERVi0UYj1msZNyCzGlaCWEtzc+exjMGbQ==} engines: {node: '>= 10.0.0'} cpu: [x64] os: [linux] + libc: [glibc] '@parcel/watcher-linux-x64-musl@2.5.6': resolution: {integrity: sha512-1JRFeC+h7RdXwldHzTsmdtYR/Ku8SylLgTU/reMuqdVD7CtLwf0VR1FqeprZ0eHQkO0vqsbvFLXUmYm/uNKJBg==} engines: {node: '>= 10.0.0'} cpu: [x64] os: [linux] + libc: [musl] '@parcel/watcher-win32-arm64@2.5.6': resolution: {integrity: sha512-3ukyebjc6eGlw9yRt678DxVF7rjXatWiHvTXqphZLvo7aC5NdEgFufVwjFfY51ijYEWpXbqF5jtrK275z52D4Q==} @@ -2327,36 +2341,42 @@ packages: engines: {node: ^20.19.0 || >=22.12.0} cpu: [arm64] os: [linux] + libc: [glibc] '@rolldown/binding-linux-arm64-musl@1.0.0-rc.15': resolution: {integrity: sha512-ZvRYMGrAklV9PEkgt4LQM6MjQX2P58HPAuecwYObY2DhS2t35R0I810bKi0wmaYORt6m/2Sm+Z+nFgb0WhXNcQ==} engines: {node: ^20.19.0 || >=22.12.0} cpu: [arm64] os: [linux] + libc: [musl] '@rolldown/binding-linux-ppc64-gnu@1.0.0-rc.15': resolution: {integrity: sha512-VDpgGBzgfg5hLg+uBpCLoFG5kVvEyafmfxGUV0UHLcL5irxAK7PKNeC2MwClgk6ZAiNhmo9FLhRYgvMmedLtnQ==} engines: {node: ^20.19.0 || >=22.12.0} cpu: [ppc64] os: [linux] + libc: [glibc] '@rolldown/binding-linux-s390x-gnu@1.0.0-rc.15': resolution: {integrity: sha512-y1uXY3qQWCzcPgRJATPSOUP4tCemh4uBdY7e3EZbVwCJTY3gLJWnQABgeUetvED+bt1FQ01OeZwvhLS2bpNrAQ==} engines: {node: ^20.19.0 || >=22.12.0} cpu: [s390x] os: [linux] + libc: [glibc] '@rolldown/binding-linux-x64-gnu@1.0.0-rc.15': resolution: {integrity: sha512-023bTPBod7J3Y/4fzAN6QtpkSABR0rigtrwaP+qSEabUh5zf6ELr9Nc7GujaROuPY3uwdSIXWrvhn1KxOvurWA==} engines: {node: ^20.19.0 || >=22.12.0} cpu: [x64] os: [linux] + libc: [glibc] '@rolldown/binding-linux-x64-musl@1.0.0-rc.15': resolution: {integrity: sha512-witB2O0/hU4CgfOOKUoeFgQ4GktPi1eEbAhaLAIpgD6+ZnhcPkUtPsoKKHRzmOoWPZue46IThdSgdo4XneOLYw==} engines: {node: ^20.19.0 || >=22.12.0} cpu: [x64] os: [linux] + libc: [musl] '@rolldown/binding-openharmony-arm64@1.0.0-rc.15': resolution: {integrity: sha512-UCL68NJ0Ud5zRipXZE9dF5PmirzJE4E4BCIOOssEnM7wLDsxjc6Qb0sGDxTNRTP53I6MZpygyCpY8Aa8sPfKPg==} @@ -2443,66 +2463,79 @@ packages: resolution: {integrity: sha512-L+34Qqil+v5uC0zEubW7uByo78WOCIrBvci69E7sFASRl0X7b/MB6Cqd1lky/CtcSVTydWa2WZwFuWexjS5o6g==} cpu: [arm] os: [linux] + libc: [glibc] '@rollup/rollup-linux-arm-musleabihf@4.60.1': resolution: {integrity: sha512-n83O8rt4v34hgFzlkb1ycniJh7IR5RCIqt6mz1VRJD6pmhRi0CXdmfnLu9dIUS6buzh60IvACM842Ffb3xd6Gg==} cpu: [arm] os: [linux] + libc: [musl] '@rollup/rollup-linux-arm64-gnu@4.60.1': resolution: {integrity: sha512-Nql7sTeAzhTAja3QXeAI48+/+GjBJ+QmAH13snn0AJSNL50JsDqotyudHyMbO2RbJkskbMbFJfIJKWA6R1LCJQ==} cpu: [arm64] os: [linux] + libc: [glibc] '@rollup/rollup-linux-arm64-musl@4.60.1': resolution: {integrity: sha512-+pUymDhd0ys9GcKZPPWlFiZ67sTWV5UU6zOJat02M1+PiuSGDziyRuI/pPue3hoUwm2uGfxdL+trT6Z9rxnlMA==} cpu: [arm64] os: [linux] + libc: [musl] '@rollup/rollup-linux-loong64-gnu@4.60.1': resolution: {integrity: sha512-VSvgvQeIcsEvY4bKDHEDWcpW4Yw7BtlKG1GUT4FzBUlEKQK0rWHYBqQt6Fm2taXS+1bXvJT6kICu5ZwqKCnvlQ==} cpu: [loong64] os: [linux] + libc: [glibc] '@rollup/rollup-linux-loong64-musl@4.60.1': resolution: {integrity: sha512-4LqhUomJqwe641gsPp6xLfhqWMbQV04KtPp7/dIp0nzPxAkNY1AbwL5W0MQpcalLYk07vaW9Kp1PBhdpZYYcEw==} cpu: [loong64] os: [linux] + libc: [musl] '@rollup/rollup-linux-ppc64-gnu@4.60.1': resolution: {integrity: sha512-tLQQ9aPvkBxOc/EUT6j3pyeMD6Hb8QF2BTBnCQWP/uu1lhc9AIrIjKnLYMEroIz/JvtGYgI9dF3AxHZNaEH0rw==} cpu: [ppc64] os: [linux] + libc: [glibc] '@rollup/rollup-linux-ppc64-musl@4.60.1': resolution: {integrity: sha512-RMxFhJwc9fSXP6PqmAz4cbv3kAyvD1etJFjTx4ONqFP9DkTkXsAMU4v3Vyc5BgzC+anz7nS/9tp4obsKfqkDHg==} cpu: [ppc64] os: [linux] + libc: [musl] '@rollup/rollup-linux-riscv64-gnu@4.60.1': resolution: {integrity: sha512-QKgFl+Yc1eEk6MmOBfRHYF6lTxiiiV3/z/BRrbSiW2I7AFTXoBFvdMEyglohPj//2mZS4hDOqeB0H1ACh3sBbg==} cpu: [riscv64] os: [linux] + libc: [glibc] '@rollup/rollup-linux-riscv64-musl@4.60.1': resolution: {integrity: sha512-RAjXjP/8c6ZtzatZcA1RaQr6O1TRhzC+adn8YZDnChliZHviqIjmvFwHcxi4JKPSDAt6Uhf/7vqcBzQJy0PDJg==} cpu: [riscv64] os: [linux] + libc: [musl] '@rollup/rollup-linux-s390x-gnu@4.60.1': resolution: {integrity: sha512-wcuocpaOlaL1COBYiA89O6yfjlp3RwKDeTIA0hM7OpmhR1Bjo9j31G1uQVpDlTvwxGn2nQs65fBFL5UFd76FcQ==} cpu: [s390x] os: [linux] + libc: [glibc] '@rollup/rollup-linux-x64-gnu@4.60.1': resolution: {integrity: sha512-77PpsFQUCOiZR9+LQEFg9GClyfkNXj1MP6wRnzYs0EeWbPcHs02AXu4xuUbM1zhwn3wqaizle3AEYg5aeoohhg==} cpu: [x64] os: [linux] + libc: [glibc] '@rollup/rollup-linux-x64-musl@4.60.1': resolution: {integrity: sha512-5cIATbk5vynAjqqmyBjlciMJl1+R/CwX9oLk/EyiFXDWd95KpHdrOJT//rnUl4cUcskrd0jCCw3wpZnhIHdD9w==} cpu: [x64] os: [linux] + libc: [musl] '@rollup/rollup-openbsd-x64@4.60.1': resolution: {integrity: sha512-cl0w09WsCi17mcmWqqglez9Gk8isgeWvoUZ3WiJFYSR3zjBQc2J5/ihSjpl+VLjPqjQ/1hJRcqBfLjssREQILw==} @@ -4857,24 +4890,28 @@ packages: engines: {node: '>= 12.0.0'} cpu: [arm64] os: [linux] + libc: [glibc] lightningcss-linux-arm64-musl@1.32.0: resolution: {integrity: sha512-UpQkoenr4UJEzgVIYpI80lDFvRmPVg6oqboNHfoH4CQIfNA+HOrZ7Mo7KZP02dC6LjghPQJeBsvXhJod/wnIBg==} engines: {node: '>= 12.0.0'} cpu: [arm64] os: [linux] + libc: [musl] lightningcss-linux-x64-gnu@1.32.0: resolution: {integrity: sha512-V7Qr52IhZmdKPVr+Vtw8o+WLsQJYCTd8loIfpDaMRWGUZfBOYEJeyJIkqGIDMZPwPx24pUMfwSxxI8phr/MbOA==} engines: {node: '>= 12.0.0'} cpu: [x64] os: [linux] + libc: [glibc] lightningcss-linux-x64-musl@1.32.0: resolution: {integrity: sha512-bYcLp+Vb0awsiXg/80uCRezCYHNg1/l3mt0gzHnWV9XP1W5sKa5/TCdGWaR/zBM2PeF/HbsQv/j2URNOiVuxWg==} engines: {node: '>= 12.0.0'} cpu: [x64] os: [linux] + libc: [musl] lightningcss-win32-arm64-msvc@1.32.0: resolution: {integrity: sha512-8SbC8BR40pS6baCM8sbtYDSwEVQd4JlFTOlaD3gWGHfThTcABnNDBda6eTZeqbofalIJhFx0qKzgHJmcPTnGdw==} From 92338a2e7cf02910c5d24cb77d99a04c8a2aa360 Mon Sep 17 00:00:00 2001 From: Timo K Date: Tue, 21 Apr 2026 16:12:14 +0200 Subject: [PATCH 07/10] review --- src/livekit/BlurBackgroundTransformer.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/livekit/BlurBackgroundTransformer.ts b/src/livekit/BlurBackgroundTransformer.ts index 7bec3cc4..f86120d3 100644 --- a/src/livekit/BlurBackgroundTransformer.ts +++ b/src/livekit/BlurBackgroundTransformer.ts @@ -29,7 +29,7 @@ interface WasmFileset { // MediaPipe and depend on node_modules having this specific structure. It's // easy to see this breaking if our dependencies changed and MediaPipe were // no longer hoisted, or if we switched to another dependency loader such as -// pnpm PnP. +// yarn PnP. // https://github.com/google-ai-edge/mediapipe/issues/5961 const wasmFileset: WasmFileset = { wasmLoaderPath: new URL( From d28cad3f12431111fa44e172cb6a35f6ac885278 Mon Sep 17 00:00:00 2001 From: Timo K Date: Tue, 21 Apr 2026 16:45:00 +0200 Subject: [PATCH 08/10] fix matrix-js-sdk branch reference --- pnpm-lock.yaml | 8 ++++---- pnpm-workspace.yaml | 3 +++ 2 files changed, 7 insertions(+), 4 deletions(-) create mode 100644 pnpm-workspace.yaml diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index b342500d..fa9ebebb 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -236,7 +236,7 @@ importers: version: 1.9.2 matrix-js-sdk: specifier: matrix-org/matrix-js-sdk#develop - version: https://codeload.github.com/matrix-org/matrix-js-sdk/tar.gz/d7d771fadb983bf40bed2c97aa31c398d8eec875 + version: https://codeload.github.com/matrix-org/matrix-js-sdk/tar.gz/4b33892d48017b3733a00a48cf5d30182be4a6fb matrix-widget-api: specifier: ^1.16.1 version: 1.17.0 @@ -5011,8 +5011,8 @@ packages: matrix-events-sdk@0.0.1: resolution: {integrity: sha512-1QEOsXO+bhyCroIe2/A5OwaxHvBm7EsSQ46DEDn8RBIfQwN5HWBpFvyWWR4QY0KHPPnnJdI99wgRiAl7Ad5qaA==} - matrix-js-sdk@https://codeload.github.com/matrix-org/matrix-js-sdk/tar.gz/d7d771fadb983bf40bed2c97aa31c398d8eec875: - resolution: {tarball: https://codeload.github.com/matrix-org/matrix-js-sdk/tar.gz/d7d771fadb983bf40bed2c97aa31c398d8eec875} + matrix-js-sdk@https://codeload.github.com/matrix-org/matrix-js-sdk/tar.gz/4b33892d48017b3733a00a48cf5d30182be4a6fb: + resolution: {tarball: https://codeload.github.com/matrix-org/matrix-js-sdk/tar.gz/4b33892d48017b3733a00a48cf5d30182be4a6fb} version: 41.3.0 engines: {node: '>=22.0.0'} @@ -11786,7 +11786,7 @@ snapshots: matrix-events-sdk@0.0.1: {} - matrix-js-sdk@https://codeload.github.com/matrix-org/matrix-js-sdk/tar.gz/d7d771fadb983bf40bed2c97aa31c398d8eec875: + matrix-js-sdk@https://codeload.github.com/matrix-org/matrix-js-sdk/tar.gz/4b33892d48017b3733a00a48cf5d30182be4a6fb: dependencies: '@babel/runtime': 7.29.2 '@matrix-org/matrix-sdk-crypto-wasm': 18.1.0 diff --git a/pnpm-workspace.yaml b/pnpm-workspace.yaml new file mode 100644 index 00000000..3fbe34a8 --- /dev/null +++ b/pnpm-workspace.yaml @@ -0,0 +1,3 @@ +# dependencies where we use branches and hashes in the package.json. But that also use a pre/post install script. +onlyBuiltDependencies: + - "matrix-js-sdk" From ecb2a6846f63e02da810b8af749bf40d2393ca81 Mon Sep 17 00:00:00 2001 From: Timo K Date: Tue, 21 Apr 2026 17:13:13 +0200 Subject: [PATCH 09/10] prettier --- docs/linking.md | 7 ++++++- docs/linking_concept_reasoning.md | 35 +++++++++++++++++-------------- 2 files changed, 25 insertions(+), 17 deletions(-) diff --git a/docs/linking.md b/docs/linking.md index b9c62edf..1016fffb 100644 --- a/docs/linking.md +++ b/docs/linking.md @@ -1,9 +1,13 @@ ## Quickstart guide + run + ```bash ./scripts/setup-linking.sh ``` + Read the script output: + ``` Setup complete. Update: .links.cjs to your liking @@ -14,7 +18,6 @@ Run: 'git config --local core.hooksPath ""' to allow committing with linking (no Run: 'rm links.cjs' & 'git config --local core.hooksPath ""' to fully revert what this script did ``` - # Developing with linked packages If you want to make changes to a package that Element Call depends on and see those changes applied in real time, you can create a link to a local copy of the package. `pnpm` has a command for this (`pnpm link`), but it's not recommended to use it as it ends up modifying package.json with details specific to your development environment. @@ -54,7 +57,9 @@ To activate the hooks configure git with (when using the setup script (`./script ```bash git config --local core.hooksPath .githooks ``` + This will add the hook path for this repository only to .gihooks. which is a tracked (by git) folder containing the pre-commit hook. ## Background + Information, why this approach is used can be found in the [linking concept reasoning](./linking_concept_reasoning.md) document. diff --git a/docs/linking_concept_reasoning.md b/docs/linking_concept_reasoning.md index 37221344..7c135a96 100644 --- a/docs/linking_concept_reasoning.md +++ b/docs/linking_concept_reasoning.md @@ -1,27 +1,30 @@ - ### Why do we not enable .pnpmfile.cjs by default + Background: The presence of the `.pnpmfile.cjs` adds a field to the `pnpm-lock.yaml` called: `pnpmfileChecksum`. This field is a checksum of the content of the `.pnpmfile.cjs` file. `pnpm install --frozen-lockfile` **fails** if there is a `.pnpmfile.cjs` but no `pnpmfileChecksum` or vice versa (or on mismatch). _TLDR: running with `--ignore-pnpmfile` will fail if `pnpmfileChecksum` is present._ #### `pnpmfileChecksum` + renovate bot + When the renovate bot creates a PR it runs `pnpm install --ignore-pnpmfile`. This means that the `pnpmfileChecksum` in the lockfile will be **empty**. This breaks builds that **don't** ignore the `.pnpmfile.cjs`-file. (CI that runs on the renovate PR) From here we have two possible paths: - - ignore `.pnpmfile.cjs` in all CI builds CI will also fail if we accidently add it locally. - - fixup the `pnpm-lock.yaml` in the renovate PR to contain the correct `pnpmfileChecksum`. - - Ignoring in all CI builds means that CI will always fail if we enable the linking system. - This is annoying but can be worked around with the git hook we provide that at least lets us know that we are - commiting with enabled linking. - Only if we remember setting it back/disbale linking (or let ourselves remember by the git hook) the CI will work. - #### Summary - - We will always run into conflicts with the `pnpmfileChecksum` because in renovate prs it will be empty (`--ignore-pnpmfile`) - - To keep it simple we set `--ignore-pnpmfile` in all of ours CI to see issues immediately. - - The only solution is to never have a `.pnpmfile.cjs` in the repository when pushing. - - This way there will never be a commit with `pnpmfileChecksum` in the lockfile. - - renovate (which uses `--ignore-pnpmfile` which we cannot disable) and other CI will work - - We are able to use the linking system locally if we `cp` this file from the scripts folder into `./` on demand. - - `pnpm links:on` and `pnpm links:off` + `./scripts/setup-linking.sh` will help us with this. +- ignore `.pnpmfile.cjs` in all CI builds CI will also fail if we accidently add it locally. +- fixup the `pnpm-lock.yaml` in the renovate PR to contain the correct `pnpmfileChecksum`. + +Ignoring in all CI builds means that CI will always fail if we enable the linking system. +This is annoying but can be worked around with the git hook we provide that at least lets us know that we are +commiting with enabled linking. +Only if we remember setting it back/disbale linking (or let ourselves remember by the git hook) the CI will work. + +#### Summary + +- We will always run into conflicts with the `pnpmfileChecksum` because in renovate prs it will be empty (`--ignore-pnpmfile`) +- To keep it simple we set `--ignore-pnpmfile` in all of ours CI to see issues immediately. +- The only solution is to never have a `.pnpmfile.cjs` in the repository when pushing. + - This way there will never be a commit with `pnpmfileChecksum` in the lockfile. + - renovate (which uses `--ignore-pnpmfile` which we cannot disable) and other CI will work +- We are able to use the linking system locally if we `cp` this file from the scripts folder into `./` on demand. +- `pnpm links:on` and `pnpm links:off` + `./scripts/setup-linking.sh` will help us with this. From bbb73b27cb834171ffcfadc92014843094f4f0f0 Mon Sep 17 00:00:00 2001 From: Timo K Date: Tue, 21 Apr 2026 17:20:58 +0200 Subject: [PATCH 10/10] fix knip --- knip.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/knip.ts b/knip.ts index aa6aee79..d7628941 100644 --- a/knip.ts +++ b/knip.ts @@ -18,6 +18,7 @@ export default { // https://docs.docker.com/compose/migrate/ "docker-compose", ], + ignoreFiles: ["scripts/.pnpmfile.cjs"], ignoreDependencies: [ // Used in CSS "normalize.css",