Skip to content

Beautiful, AI-native markdown IDE and LLM wiki

fix(ok): keep dev desktop builds off the installed app's profile (#5336)

tim-inkeep3ce4d7876180
diff --git a/packages/desktop/src/main/auto-instance.test.ts b/packages/desktop/src/main/auto-instance.test.ts
index f5cb07920..19c4cbb4c 100644
--- a/packages/desktop/src/main/auto-instance.test.ts
+++ b/packages/desktop/src/main/auto-instance.test.ts
@@ -4,6 +4,7 @@ import {
type GitInstanceContext,
resolveEffectiveInstanceName,
} from './auto-instance.ts';
+import { sanitizeInstanceName } from './instance-isolation.ts';
describe('deriveAutoInstanceName', () => {
test('uses the branch name for a normal feature branch', () => {
@@ -16,9 +17,27 @@ describe('deriveAutoInstanceName', () => {
expect(deriveAutoInstanceName({ branch: 'feat/foo', worktreeDir: '/repo' })).toBe('feat/foo');
});
- test('skips the repo default branch so plain dev on main is unchanged', () => {
- expect(deriveAutoInstanceName({ branch: 'main', worktreeDir: '/repo' })).toBeNull();
- expect(deriveAutoInstanceName({ branch: 'master', worktreeDir: '/repo' })).toBeNull();
+ test("the repo default branch gets its own dev instance instead of Stable's userData", () => {
+ expect(deriveAutoInstanceName({ branch: 'main', worktreeDir: '/repo' })).toBe('dev');
+ expect(deriveAutoInstanceName({ branch: 'master', worktreeDir: '/repo' })).toBe('dev');
+ });
+
+ test('a branch or worktree named dev never lands on the default-branch dev instance', () => {
+ const fromMain = deriveAutoInstanceName({ branch: 'main', worktreeDir: '/repo' });
+ for (const ctx of [
+ { branch: 'dev', worktreeDir: '/repo' },
+ { branch: 'dev-', worktreeDir: '/repo' },
+ { branch: 'Dev', worktreeDir: '/repo' },
+ { branch: 'DEV', worktreeDir: '/repo' },
+ { branch: 'HEAD', worktreeDir: '/Users/me/wt/dev' },
+ { branch: 'HEAD', worktreeDir: '/Users/me/wt/Dev' },
+ ]) {
+ const derived = deriveAutoInstanceName(ctx);
+ expect(derived).toBe('dev..branch');
+ expect(sanitizeInstanceName(derived ?? '').toLowerCase()).not.toBe(
+ sanitizeInstanceName(fromMain ?? '').toLowerCase(),
+ );
+ }
});
test('falls back to the worktree dir basename on detached HEAD', () => {
@@ -91,10 +110,10 @@ describe('resolveEffectiveInstanceName', () => {
}
});
- test('returns null on the default branch with no explicit override', () => {
+ test('derives the dev instance on the default branch with no explicit override', () => {
expect(
resolveEffectiveInstanceName({}, '/repo', gitOn({ branch: 'main', worktreeDir: '/repo' })),
- ).toBeNull();
+ ).toEqual({ name: 'dev', source: 'git' });
});
test('autoDeriveEnabled: false disables git derivation (E2E smoke) but explicit still wins', () => {
diff --git a/packages/desktop/src/main/auto-instance.ts b/packages/desktop/src/main/auto-instance.ts
index accedc66b..eadd69d3b 100644
--- a/packages/desktop/src/main/auto-instance.ts
+++ b/packages/desktop/src/main/auto-instance.ts
@@ -1,7 +1,10 @@
import { execFileSync } from 'node:child_process';
import { basename } from 'node:path';
+import { sanitizeInstanceName } from './instance-isolation.ts';
const DEFAULT_BRANCH_NAMES = new Set(['main', 'master']);
+const DEFAULT_BRANCH_INSTANCE = 'dev';
+const NON_DEFAULT_DEV_INSTANCE = 'dev..branch';
export interface GitInstanceContext {
readonly branch: string | null;
@@ -29,15 +32,21 @@ function readGitInstanceContext(dir: string): GitInstanceContext {
};
}
+function avoidDefaultBranchInstance(name: string): string {
+ return sanitizeInstanceName(name).toLowerCase() === DEFAULT_BRANCH_INSTANCE
+ ? NON_DEFAULT_DEV_INSTANCE
+ : name;
+}
+
export function deriveAutoInstanceName(ctx: GitInstanceContext): string | null {
const branch = ctx.branch;
if (branch && branch !== 'HEAD') {
- if (DEFAULT_BRANCH_NAMES.has(branch)) return null;
- return branch;
+ if (DEFAULT_BRANCH_NAMES.has(branch)) return DEFAULT_BRANCH_INSTANCE;
+ return avoidDefaultBranchInstance(branch);
}
if (ctx.worktreeDir) {
const base = basename(ctx.worktreeDir);
- return base.length > 0 ? base : null;
+ return base.length > 0 ? avoidDefaultBranchInstance(base) : null;
}
return null;
}
diff --git a/packages/desktop/src/main/index.ts b/packages/desktop/src/main/index.ts
index e2e2a7c22..d3d7ea907 100644
--- a/packages/desktop/src/main/index.ts
+++ b/packages/desktop/src/main/index.ts
@@ -6230,6 +6230,7 @@ function bootPrimaryInstance(): void {
setAsDefaultProtocolClient: (scheme) => app.setAsDefaultProtocolClient(scheme),
removeAsDefaultProtocolClient: (scheme) => app.removeAsDefaultProtocolClient(scheme),
},
+ registerDevProtocol: process.env.OK_DEV_PROTOCOL === '1',
focusWindowForProject: (projectPath) => {
if (!wm) return null;
yieldRestoreToDeepLink();
diff --git a/packages/desktop/src/main/url-scheme.ts b/packages/desktop/src/main/url-scheme.ts
index 8ad3f8105..464230816 100644
--- a/packages/desktop/src/main/url-scheme.ts
+++ b/packages/desktop/src/main/url-scheme.ts
@@ -381,6 +381,7 @@ interface ProtocolHandlerDeps {
setAsDefaultProtocolClient(scheme: string): boolean;
removeAsDefaultProtocolClient(scheme: string): boolean;
};
+ registerDevProtocol?: boolean;
focusWindowForProject(projectPath: string): BrowserWindowHandle | null;
openProject(
projectPath: string,
@@ -474,7 +475,24 @@ export function registerProtocolHandler(deps: ProtocolHandlerDeps): ProtocolHand
settleResolve = null;
};
- if (!deps.app.isPackaged) {
+ if (deps.app.isPackaged) {
+ try {
+ const ok = deps.app.setAsDefaultProtocolClient(protocolScheme);
+ if (!ok) {
+ deps.log?.error(
+ {},
+ '[url-scheme] packaged setAsDefaultProtocolClient returned false — openknowledge:// links may not reach this install',
+ );
+ }
+ } catch (err) {
+ deps.log?.error({ err }, '[url-scheme] packaged setAsDefaultProtocolClient failed');
+ }
+ } else if (deps.registerDevProtocol !== true) {
+ deps.log?.info?.(
+ { protocolScheme },
+ '[url-scheme] this dev build is not registered for the protocol, so its links go to whichever app owns the scheme, or nowhere; set OK_DEV_PROTOCOL=1 to claim it',
+ );
+ } else {
try {
const ok = deps.app.setAsDefaultProtocolClient(protocolScheme);
if (!ok) {
@@ -497,18 +515,6 @@ export function registerProtocolHandler(deps: ProtocolHandlerDeps): ProtocolHand
} catch (err) {
deps.log?.warn({ err }, '[url-scheme] setAsDefaultProtocolClient failed');
}
- } else {
- try {
- const ok = deps.app.setAsDefaultProtocolClient(protocolScheme);
- if (!ok) {
- deps.log?.error(
- {},
- '[url-scheme] packaged setAsDefaultProtocolClient returned false — openknowledge:// links may not reach this install',
- );
- }
- } catch (err) {
- deps.log?.error({ err }, '[url-scheme] packaged setAsDefaultProtocolClient failed');
- }
}
const broadcastShareToast = (
diff --git a/packages/desktop/tests/main/url-scheme-handler.test.ts b/packages/desktop/tests/main/url-scheme-handler.test.ts
index 95f7bdbf8..2f5692909 100644
--- a/packages/desktop/tests/main/url-scheme-handler.test.ts
+++ b/packages/desktop/tests/main/url-scheme-handler.test.ts
@@ -180,9 +180,29 @@ function tickTimer(env: TestEnv): void {
}
describe('registerProtocolHandler — setAsDefaultProtocolClient', () => {
- test('calls setAsDefaultProtocolClient in dev mode (!isPackaged)', () => {
+ test('a dev build leaves the scheme unclaimed unless OK_DEV_PROTOCOL opts in', () => {
const env = makeEnv({ isPackaged: false });
registerProtocolHandler({
+ log: env.log,
+ app: env.app,
+ focusWindowForProject: env.focusWindowForProject,
+ openProject: env.openProject,
+ sendDeepLink: env.sendDeepLink,
+ getAnyReadyWindow: env.getAnyReadyWindow,
+ setTimeout: (cb, ms) => env.timers.push({ cb, ms }),
+ });
+ expect(env.app.setAsDefaultProtocolClient).not.toHaveBeenCalled();
+ expect(env.app.on).not.toHaveBeenCalledWith('before-quit', expect.anything());
+ const skip = env.infoLog.find((e) => e.msg.includes('OK_DEV_PROTOCOL=1'))?.msg ?? '';
+ expect(skip).toContain('not registered');
+ expect(skip).toContain('or nowhere');
+ expect(skip).not.toContain('installed app');
+ });
+
+ test('calls setAsDefaultProtocolClient in dev mode when OK_DEV_PROTOCOL opts in', () => {
+ const env = makeEnv({ isPackaged: false });
+ registerProtocolHandler({
+ registerDevProtocol: true,
app: env.app,
focusWindowForProject: env.focusWindowForProject,
openProject: env.openProject,
@@ -236,6 +256,7 @@ describe('registerProtocolHandler — setAsDefaultProtocolClient', () => {
const env = makeEnv({ isPackaged: false });
env.app.setAsDefaultProtocolClient = vi.fn(() => false);
registerProtocolHandler({
+ registerDevProtocol: true,
app: env.app,
focusWindowForProject: env.focusWindowForProject,
openProject: env.openProject,
@@ -291,6 +312,7 @@ describe('registerProtocolHandler — before-quit Launch Services cleanup', () =
test('registers before-quit handler that calls removeAsDefaultProtocolClient in dev mode', () => {
const env = makeEnv({ isPackaged: false });
registerProtocolHandler({
+ registerDevProtocol: true,
app: env.app,
focusWindowForProject: env.focusWindowForProject,
openProject: env.openProject,
@@ -320,6 +342,7 @@ describe('registerProtocolHandler — before-quit Launch Services cleanup', () =
const env = makeEnv({ isPackaged: false });
env.app.setAsDefaultProtocolClient = vi.fn(() => false);
registerProtocolHandler({
+ registerDevProtocol: true,
app: env.app,
focusWindowForProject: env.focusWindowForProject,
openProject: env.openProject,
@@ -337,6 +360,7 @@ describe('registerProtocolHandler — before-quit Launch Services cleanup', () =
throw new Error('launch services refused');
});
registerProtocolHandler({
+ registerDevProtocol: true,
app: env.app,
focusWindowForProject: env.focusWindowForProject,
openProject: env.openProject,
diff --git a/packages/desktop/tests/smoke/_helpers/launch-desktop.test.ts b/packages/desktop/tests/smoke/_helpers/launch-desktop.test.ts
index c2536a7d6..b41b510bd 100644
--- a/packages/desktop/tests/smoke/_helpers/launch-desktop.test.ts
+++ b/packages/desktop/tests/smoke/_helpers/launch-desktop.test.ts
@@ -131,6 +131,10 @@ describe('desktopLaunchOptions', () => {
);
});
+ it('opts the unpackaged build into claiming the URL scheme so open -g deep links reach it', () => {
+ expect(desktopLaunchOptions({ target: unpackaged }).env?.OK_DEV_PROTOCOL).toBe('1');
+ });
+
it('passes a supplied env through, over the inherited copy', () => {
const env = { HOME: '/tmp/home', OK_DESKTOP_E2E_SMOKE: '1' };
const opts = desktopLaunchOptions({ target: unpackaged, env });
diff --git a/packages/desktop/tests/smoke/_helpers/launch-desktop.ts b/packages/desktop/tests/smoke/_helpers/launch-desktop.ts
index 09e74a379..f0d946eb0 100644
--- a/packages/desktop/tests/smoke/_helpers/launch-desktop.ts
+++ b/packages/desktop/tests/smoke/_helpers/launch-desktop.ts
@@ -120,6 +120,7 @@ export function desktopLaunchOptions(input: DesktopLaunchOptionsInput = {}): Des
...input.env,
OK_LANG: 'en',
OK_LOG_LEVEL: 'info',
+ OK_DEV_PROTOCOL: '1',
...(target.mode === 'packaged'
? { OK_IDLE_SHUTDOWN: `${PACKAGED_SMOKE_SERVER_IDLE_SHUTDOWN_MS / 1000}s` }
: {}),
diff --git a/turbo.json b/turbo.json
index e45485fc2..09e48e825 100644
--- a/turbo.json
+++ b/turbo.json
@@ -30,6 +30,7 @@
"passThroughEnv": [
"OK_INSTANCE",
"OK_AUTO_INSTANCE",
+ "OK_DEV_PROTOCOL",
"OK_M6B_FORCE",
"OK_RECLAIM_DISABLE",
"OK_UNINSTALL_UI_PREVIEW",