@tilewise/workbench-client 0.2.0 → 0.2.1

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## 0.2.1 · 2026-11-12 05:46 +04:00
+
+- feat(workbench-client): pull a branch forward from the switcher (84ca115)
+  - Add /__workbench/pull: git fetch, then fast-forward a branch to its branch on GitHub, never merging or rebasing
+  - Move the checked-out branch's files too, refused while anything is uncommitted, and install when the lockfile changed
+  - Move any other branch's ref alone, refused when another worktree has it checked out
+  - Refuse a branch with commits GitHub doesn't have, or with no branch there, saying why
+  - Share Checkout's install step in install.ts
+  - Show Pull beside History on each branch behind GitHub's, with the result or the reason in the switcher's footer
+  - Ask for a newer client when the dev server has no Pull
+
 ## 0.2.0 · 2026-11-10 17:08 +04:00
 
 - feat(workbench-client)!: serve the dev server over https by default, for Safari (4219956)

package/README.md

@@ -174,6 +174,14 @@ git-ignored `.builds/<sha>/`, and checks a branch out, refused while
 anything is uncommitted. Builds are served under `/__workbench/b/<sha>/`, so
 the app's router takes `basepath: import.meta.env.BASE_URL`.
 
+It also pulls a branch, fast-forward only (`/__workbench/pull`): `git fetch`,
+then the branch moves to its branch on GitHub, never merging or rebasing. The
+checked-out branch moves its files too, refused while anything is
+uncommitted, and installs at the repository's top when the lockfile changed,
+then restarts the dev server. Any other branch moves alone, refused when
+another worktree has it checked out. A branch with commits GitHub doesn't
+have, or with no branch there, is refused, with the reason.
+
 It also reads `workbench.json`, at the repository's top, where the
 repository declares its setup: the fake API comes from it (below), and
 `/__workbench/setup` hands the checkout's to the viewer, as `{ name, viewers }`

package/dist/vite/checkout.js

@@ -1,5 +1,5 @@
-import { spawn } from 'node:child_process';
 import { lockOf } from './builds.js';
+import { installIfChanged } from './install.js';
 /**
  * Checks a branch out, refused while anything is uncommitted. When the
  * lockfile changes, installs and restarts the dev server.
@@ -18,26 +18,6 @@ export async function checkout(git, root, branch, restart) {
     }
     const before = (await lockOf(root)).text;
     await git('switch', branch);
-    const after = await lockOf(root);
-    const installed = before !== after.text;
-    if (installed) {
-        await new Promise((resolve, reject) => {
-            const args = after.manager === 'pnpm' ? ['install'] : ['install', '--no-audit', '--no-fund'];
-            const child = spawn(after.manager, args, {
-                cwd: root,
-                shell: process.platform === 'win32',
-                stdio: 'inherit',
-            });
-            child.on('close', (code) => {
-                if (code === 0) {
-                    resolve();
-                }
-                else {
-                    reject(new Error(`${after.manager} install exited with ${code}`));
-                }
-            });
-        });
-        setTimeout(restart, 50);
-    }
+    const installed = await installIfChanged(root, before, restart);
     return { status: 200, body: { current: branch, installed } };
 }

package/dist/vite/install.d.ts

@@ -0,0 +1,5 @@
+/**
+ * After the checkout moved: when its lockfile is no longer `before`, installs
+ * with its package manager and restarts the dev server. Whether it installed.
+ */
+export declare function installIfChanged(root: string, before: string | null, restart: () => void): Promise<boolean>;

package/dist/vite/install.js

@@ -0,0 +1,30 @@
+import { spawn } from 'node:child_process';
+import { lockOf } from './builds.js';
+/**
+ * After the checkout moved: when its lockfile is no longer `before`, installs
+ * with its package manager and restarts the dev server. Whether it installed.
+ */
+export async function installIfChanged(root, before, restart) {
+    const after = await lockOf(root);
+    if (before === after.text) {
+        return false;
+    }
+    await new Promise((resolve, reject) => {
+        const args = after.manager === 'pnpm' ? ['install'] : ['install', '--no-audit', '--no-fund'];
+        const child = spawn(after.manager, args, {
+            cwd: root,
+            shell: process.platform === 'win32',
+            stdio: 'inherit',
+        });
+        child.on('close', (code) => {
+            if (code === 0) {
+                resolve();
+            }
+            else {
+                reject(new Error(`${after.manager} install exited with ${code}`));
+            }
+        });
+    });
+    setTimeout(restart, 50);
+    return true;
+}

package/dist/vite/pull.d.ts

@@ -0,0 +1,16 @@
+import { type Git } from './git.js';
+import { installIfChanged } from './install.js';
+interface Answer {
+    status: number;
+    body: Record<string, unknown>;
+}
+/**
+ * Brings a branch up to its branch on GitHub, fast-forward only: git fetch
+ * first, then the branch moves to what it fetched, never merging or
+ * rebasing. The checked-out branch moves its files too, refused while
+ * anything is uncommitted, and installs at `top` when the lockfile changed.
+ * Any other branch moves alone, its files untouched. A branch with commits
+ * GitHub doesn't have is refused, and so is one with no branch there.
+ */
+export declare function pull(git: Git, top: string, branch: string, restart: () => void, install?: typeof installIfChanged): Promise<Answer>;
+export {};

package/dist/vite/pull.js

@@ -0,0 +1,84 @@
+import { lockOf } from './builds.js';
+import { refExists } from './git.js';
+import { installIfChanged } from './install.js';
+const plural = (n, one) => `${n} ${one}${n === 1 ? '' : 's'}`;
+/**
+ * Brings a branch up to its branch on GitHub, fast-forward only: git fetch
+ * first, then the branch moves to what it fetched, never merging or
+ * rebasing. The checked-out branch moves its files too, refused while
+ * anything is uncommitted, and installs at `top` when the lockfile changed.
+ * Any other branch moves alone, its files untouched. A branch with commits
+ * GitHub doesn't have is refused, and so is one with no branch there.
+ */
+export async function pull(git, top, branch, restart, install = installIfChanged) {
+    const ref = `refs/heads/${branch}`;
+    if (!(await refExists(git, ref))) {
+        return { status: 404, body: { error: `No branch ${branch} on this computer` } };
+    }
+    const upstream = (await git('for-each-ref', '--format=%(upstream)', ref)).trim();
+    if (!upstream.startsWith('refs/remotes/origin/')) {
+        return {
+            status: 409,
+            body: { error: `${branch} has no branch on GitHub to pull from.`, reason: 'no-upstream' },
+        };
+    }
+    await git('fetch', '--prune', 'origin');
+    if (!(await refExists(git, upstream))) {
+        return {
+            status: 409,
+            body: { error: `${branch}’s branch on GitHub is gone.`, reason: 'no-upstream' },
+        };
+    }
+    const [from = '', to = ''] = (await git('rev-parse', ref, upstream)).trim().split(/\s+/);
+    const [ahead = 0, behind = 0] = (await git('rev-list', '--left-right', '--count', `${from}...${to}`))
+        .trim()
+        .split(/\s+/)
+        .map(Number);
+    if (!behind) {
+        return { status: 200, body: { branch, pulled: 0, installed: false } };
+    }
+    if (ahead) {
+        return {
+            status: 409,
+            body: {
+                error: `${branch} has ${plural(ahead, 'commit')} GitHub doesn’t, and GitHub ` +
+                    `${plural(behind, 'commit')} it doesn’t. Pull only moves a branch forward: ` +
+                    'merge or rebase it yourself.',
+                reason: 'diverged',
+                ahead,
+                behind,
+            },
+        };
+    }
+    const current = (await git('symbolic-ref', '--quiet', '--short', 'HEAD').catch(() => '')).trim();
+    if (current === branch) {
+        const changed = (await git('status', '--porcelain')).split('\n').filter(Boolean).length;
+        if (changed) {
+            return {
+                status: 409,
+                body: {
+                    error: `You have ${plural(changed, 'changed file')}. Commit or stash ${changed === 1 ? 'it' : 'them'} first.`,
+                    reason: 'changed',
+                    changed,
+                },
+            };
+        }
+        const before = (await lockOf(top)).text;
+        await git('merge', '--ff-only', '--quiet', to);
+        const installed = await install(top, before, restart);
+        return { status: 200, body: { branch, pulled: behind, installed } };
+    }
+    // Checked out in another worktree, it would move under that worktree's files.
+    const worktrees = (await git('worktree', 'list', '--porcelain')).split('\n');
+    if (worktrees.includes(`branch ${ref}`)) {
+        return {
+            status: 409,
+            body: {
+                error: `${branch} is checked out in another worktree. Pull it there.`,
+                reason: 'worktree',
+            },
+        };
+    }
+    await git('update-ref', '-m', 'pull: fast-forward', ref, to, from);
+    return { status: 200, body: { branch, pulled: behind, installed: false } };
+}

package/dist/vite/workbenchLocal.d.ts

@@ -2,7 +2,7 @@ import type { Plugin } from 'vite';
 /**
  * The local builds service, as a Vite plugin: with it, the app's dev server
  * also answers the deployed viewer. It lists this machine's branches and
- * commits, builds any commit, and checks a branch out.
+ * commits, builds any commit, checks a branch out, and pulls one.
  *
  *   GET  /__workbench/connect            { token, repo }: the token, for an allowed origin, which needs none
  *   GET  /__workbench/setup              the checkout's workbench.json: { name, viewers }; 404 none, 422 no setup
@@ -13,6 +13,7 @@ import type { Plugin } from 'vite';
  *   GET  /__workbench/b/<sha>/…          the build, for the viewer's frame
  *   POST /__workbench/checkout           { branch }: refused while anything is uncommitted
  *   POST /__workbench/fetch              git fetch, so push status is current
+ *   POST /__workbench/pull               { branch }: git fetch, then fast-forward it to GitHub's (pull.ts)
  *
  * `base` is the branch the others are compared with: the repository's
  * default branch unless set. Builds are served without the token, as a frame

package/dist/vite/workbenchLocal.js

@@ -9,6 +9,7 @@ import { environment } from './environment.js';
 import { sendResponse, toRequest } from './fetchBridge.js';
 import { defaultBranch, gitIn, repositoryOf } from './git.js';
 import { localhostCertificate, trustSteps } from './https.js';
+import { pull } from './pull.js';
 import { sendJson, serveBuild } from './serveBuild.js';
 import { readSetup, setupApi } from './setup.js';
 import { commits, versions } from './versions.js';
@@ -58,7 +59,7 @@ function open(url) {
 /**
  * The local builds service, as a Vite plugin: with it, the app's dev server
  * also answers the deployed viewer. It lists this machine's branches and
- * commits, builds any commit, and checks a branch out.
+ * commits, builds any commit, checks a branch out, and pulls one.
  *
  *   GET  /__workbench/connect            { token, repo }: the token, for an allowed origin, which needs none
  *   GET  /__workbench/setup              the checkout's workbench.json: { name, viewers }; 404 none, 422 no setup
@@ -69,6 +70,7 @@ function open(url) {
  *   GET  /__workbench/b/<sha>/…          the build, for the viewer's frame
  *   POST /__workbench/checkout           { branch }: refused while anything is uncommitted
  *   POST /__workbench/fetch              git fetch, so push status is current
+ *   POST /__workbench/pull               { branch }: git fetch, then fast-forward it to GitHub's (pull.ts)
  *
  * `base` is the branch the others are compared with: the repository's
  * default branch unless set. Builds are served without the token, as a frame
@@ -176,6 +178,15 @@ export function workbenchLocal(options = {}) {
             await git('fetch', '--prune', 'origin');
             return sendJson(response, 200, { ok: true });
         }
+        if (request.method === 'POST' && path === '/pull') {
+            const branch = (await bodyOf(request))?.branch;
+            if (typeof branch !== 'string' || !REF.test(branch)) {
+                return sendJson(response, 400, { error: 'Bad branch' });
+            }
+            const top = (await topOf()) ?? root;
+            const result = await pull(git, top, branch, () => void server?.restart());
+            return sendJson(response, result.status, result.body);
+        }
         return sendJson(response, 404, { error: 'Not found' });
     }
     /** A build's own fake API, asked at `rest`, the path under the build; false when it has none there. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tilewise/workbench-client",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Connects a React prototype to the workbench's viewer: its screens, its controls and the protocol between them.",
   "license": "MIT",
   "repository": {