fix: review

Author: veeso

.github/workflows/ci.yaml

@@ -1,4 +1,4 @@
-name: 'checks'
+name: "checks"
 on:
   pull_request:
   push:
@@ -18,15 +18,15 @@ jobs:
     permissions:
       contents: read
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v7
         with:
           persist-credentials: false
 
       - name: setup node
         uses: actions/setup-node@v6
         with:
           node-version: 24
-          cache: 'yarn'
+          cache: "yarn"
 
       - name: Install dependencies
         run: yarn install --frozen-lockfile
@@ -41,34 +41,3 @@ jobs:
         env:
           GH_TOKEN: ${{ github.token }}
         run: yarn check:config
-
-  binaries:
-    name: binaries
-    strategy:
-      fail-fast: false
-      matrix:
-        platform:
-          - windows-2022
-          - macos-15-intel
-          - macos-latest
-          - ubuntu-22.04
-          - ubuntu-24.04-arm
-    runs-on: ${{ matrix.platform }}
-    permissions:
-      contents: read
-    steps:
-      - uses: actions/checkout@v6
-        with:
-          persist-credentials: false
-
-      - name: setup node
-        uses: actions/setup-node@v6
-        with:
-          node-version: 24
-          cache: 'yarn'
-
-      - name: Install dependencies
-        run: yarn install --frozen-lockfile
-
-      - name: Download binaries and verify checksums
-        run: yarn fetch:binaries

README.md

@@ -17,6 +17,20 @@ Depending on which Holochain minor version you want to use you should use the co
 - Holochain 0.4.x: [main-0.4](https://github.com/holochain/kangaroo-electron/tree/main-0.4)
 - Holochain 0.3.x: [main-0.3](https://github.com/holochain/kangaroo-electron/tree/main-0.3)
 
+If you change the `holochainVersion` field in `kangaroo.config.ts`, the npm dependencies that talk to the conductor (`@holochain/client` and `@holochain/hc-spin-rust-utils`) need to move to a matching version series as well. The `bins.compatibleDeps` field in `kangaroo.config.ts` records which npm dependency series goes with which Holochain series, and `yarn check:config` verifies that `package.json` agrees with it:
+
+```ts
+compatibleDeps: {
+  '0.7': {
+    '@holochain/client': '0.21',
+    '@holochain/hc-spin-rust-utils': '0.700',
+  },
+},
+```
+
+> [!NOTE]
+> Add an entry whenever you move to a new Holochain series. If there is no entry for the series you configured, `yarn check:config` prints a warning and skips the dependency verification instead of failing.
+
 # Instructions
 
 ## Setup and Testing Locally

kangaroo.config.ts

@@ -14,6 +14,12 @@ export default defineConfig({
   relayUrl: 'https://dev-test-bootstrap2.holochain.org/',
   bins: {
     holochainVersion: '0.7.0',
+    compatibleDeps: {
+      '0.7': {
+        '@holochain/client': '0.21',
+        '@holochain/hc-spin-rust-utils': '0.700',
+      },
+    },
     holochain: {
       sha256: {
         'x86_64-unknown-linux-gnu':

scripts/lib/test-server.js

@@ -5,11 +5,14 @@ import path from 'node:path';
 
 const require = createRequire(import.meta.url);
 require('tsx/cjs');
-const { isTestServerUrl } = require('./lib/test-server.js');
 
 const OWNER = 'holochain';
 const REPO = 'holochain';
 
+// URL of the testing bootstrap/relay server this repository ships with.
+// Compared as an exact URL, matching the check in scripts/write-configs.js.
+const TEST_SERVER_URL = 'https://dev-test-bootstrap2-iroh.holochain.org/';
+
 const CHECK_MODE = process.argv.includes('--check');
 
 // The platform targets kangaroo builds for. Both sha256 maps in
@@ -22,16 +25,6 @@ const EXPECTED_TARGETS = [
   'aarch64-apple-darwin',
 ];
 
-// Known-compatible npm dependency series (major.minor) per Holochain
-// series. Extend this map when adopting a new Holochain series; the check
-// fails loudly when the configured Holochain version is not listed here.
-const DEP_COMPAT = {
-  '0.7': {
-    '@holochain/client': '0.21',
-    '@holochain/hc-spin-rust-utils': '0.700',
-  },
-};
-
 const configPath = path.join(process.cwd(), 'kangaroo.config.ts');
 const kangarooConfig = require(configPath).default;
 
@@ -143,18 +136,19 @@ function checkDependencyVersions(problems) {
     return;
   }
   const series = `${parsed.major}.${parsed.minor}`;
-  const compat = DEP_COMPAT[series];
+  const compat = kangarooConfig.bins.compatibleDeps?.[series];
   if (!compat) {
-    problems.push(
-      `no known compatible dependency versions for Holochain ${series}.x - extend DEP_COMPAT in scripts/update-binary-hashes.mjs`
+    console.warn(
+      `⚠️  kangaroo.config.ts has no 'bins.compatibleDeps' entry for Holochain ${series}.x - skipping the npm dependency check. Add one to have this check verify that your npm dependencies match your Holochain version.`
     );
     return;
   }
   const packageJson = JSON.parse(
     fs.readFileSync(path.join(process.cwd(), 'package.json'), 'utf-8')
   );
+  const dependencies = packageJson.dependencies ?? {};
   for (const [depName, expectedSeries] of Object.entries(compat)) {
-    const range = packageJson.dependencies[depName];
+    const range = dependencies[depName];
     if (!range) {
       problems.push(`package.json has no dependency '${depName}'`);
       continue;
@@ -167,7 +161,7 @@ function checkDependencyVersions(problems) {
     const depSeries = `${minVersion.major}.${minVersion.minor}`;
     if (depSeries !== expectedSeries) {
       problems.push(
-        `dependency '${depName}' is '${range}' (series ${depSeries}) but Holochain ${holochainVersion} needs series ${expectedSeries}`
+        `dependency '${depName}' is '${range}' (series ${depSeries}) but 'bins.compatibleDeps' in kangaroo.config.ts declares series ${expectedSeries} for Holochain ${holochainVersion}`
       );
     }
   }
@@ -179,7 +173,7 @@ function warnAboutTestServers() {
     ['relayUrl', kangarooConfig.relayUrl],
   ];
   for (const [field, url] of servers) {
-    if (isTestServerUrl(url)) {
+    if (url === TEST_SERVER_URL) {
       console.warn(
         `⚠️  ${field} ('${url}') points at a test server. Test servers have no availability guarantees - do not ship a production release with this setting.`
       );

scripts/update-binary-hashes.mjs

@@ -2,7 +2,6 @@ const jsYaml = require('js-yaml');
 const fs = require('fs');
 const path = require('path');
 require('tsx/cjs');
-const { isTestServerUrl } = require('./lib/test-server');
 
 const PLACEHOLDER_APP_ID = 'org.holochain.kangaroo-electron';
 const PLACEHOLDER_PRODUCT_NAME = 'Holochain Kangaroo Electron';
@@ -15,15 +14,15 @@ if (!process.env.KANGAROO_DEV) {
   // of their own chosen appId/productName
   if (kangarooConfig.appId === PLACEHOLDER_APP_ID)
     throw new Error(
-      "The appId field in 'kangaroo.config.ts' is still using the placeholder value. Change it to the appId of your app."
+      "The appId field in 'kangaroo.config.ts' is still using the placeholder value. Change it to the appId of your app.",
     );
   if (kangarooConfig.productName === PLACEHOLDER_PRODUCT_NAME)
     throw new Error(
-      "The productName field in 'kangaroo.config.ts' is still using the placeholder value. Change it to the productName of your app."
+      "The productName field in 'kangaroo.config.ts' is still using the placeholder value. Change it to the productName of your app.",
     );
 }
 
-if (isTestServerUrl(kangarooConfig.bootstrapUrl)) {
+if (kangarooConfig.bootstrapUrl === 'https://dev-test-bootstrap2-iroh.holochain.org/') {
   console.log(`
 
          ⚠️   WARNING  ⚠️
@@ -41,7 +40,7 @@ among users of your app.
   `);
 }
 
-if (isTestServerUrl(kangarooConfig.relayUrl)) {
+if (kangarooConfig.relayUrl === 'https://dev-test-bootstrap2-iroh.holochain.org/') {
   console.log(`
 
          ⚠️   WARNING  ⚠️
@@ -65,13 +64,13 @@ fs.mkdirSync('resources', { recursive: true });
 fs.writeFileSync(
   path.join('resources', 'kangaroo.config.json'),
   JSON.stringify(kangarooConfig, undefined, 2),
-  'utf-8'
+  'utf-8',
 );
 
 // Copy conductor config template to resources folder
 fs.copyFileSync(
   path.join(process.cwd(), 'templates', 'conductor-config.yaml'),
-  path.join('resources', 'conductor-config.yaml')
+  path.join('resources', 'conductor-config.yaml'),
 );
 
 // Overwrite package.json values
@@ -83,7 +82,7 @@ packageJSON.version = kangarooConfig.version;
 fs.writeFileSync('package.json', JSON.stringify(packageJSON, undefined, 2), 'utf-8');
 
 const eletronBuilderYml = jsYaml.load(
-  fs.readFileSync(path.join(process.cwd(), 'templates', 'electron-builder-template.yml'))
+  fs.readFileSync(path.join(process.cwd(), 'templates', 'electron-builder-template.yml')),
 );
 
 eletronBuilderYml.appId = kangarooConfig.appId;

scripts/write-configs.js

@@ -116,6 +116,31 @@ export type KangarooConfig = {
   bins: {
     holochainVersion: string;
     holochainFeature?: "unstable";
+    /**
+     * npm dependency versions that are known to work with a given Holochain
+     * series, used by `yarn check:config` to catch a `holochainVersion` bump
+     * that forgot to bump the corresponding npm dependencies.
+     *
+     * The outer key is a Holochain series in `major.minor` notation, the inner
+     * keys are npm package names and the inner values the `major.minor` series
+     * of that package which is compatible with that Holochain series.
+     *
+     * Whenever you move to a new Holochain series, add an entry for it. If
+     * there is no entry for the series of `holochainVersion`, the check is
+     * skipped with a warning.
+     *
+     * Example:
+     *
+     * ```ts
+     * compatibleDeps: {
+     *   '0.7': {
+     *     '@holochain/client': '0.21',
+     *     '@holochain/hc-spin-rust-utils': '0.700',
+     *   },
+     * }
+     * ```
+     */
+    compatibleDeps?: Record<string, Record<string, string>>;
     holochain: Sha256Hashes;
     lair: Sha256Hashes;
   };