fix: resolve symlinks in project directory paths (#1316)

* fix: resolve symlinks in project directory paths OpenCode stores sessions using the canonical (realpath) directory, but OpenChamber passed the unresolved symlink path in several places. The string-match directory filter would fail when a project was accessed via a symlink, making sessions invisible. Changes: - Add safeRealpathSync to settings normalization — project paths and lastDirectory are canonicalized at persistence time - Add Express middleware before the API proxy to resolve symlinks in ?directory= query params on in-flight requests - Resolve symlinks in /api/fs/list so the directory browser returns canonical paths, allowing the "already added" check to work correctly - Reconcile the in-memory projects store when the server responds with normalized paths, preventing temporary duplicates Fixes #1315 * fix: avoid sync realpath in opencode proxy --------- Co-authored-by: Bohdan Triapitsyn <artmore@protonmail.com>
2026-05-24 15:46:11 +03:00
parent 90b3d4760e
commit c5862cc6ee
12 changed files with 695 additions and 12 deletions
@@ -0,0 +1,226 @@
+import { describe, expect, it } from 'vitest';
+
+import { createProjectDirectoryRuntime } from './project-directory-runtime.js';
+
+const createTestRuntime = (overrides = {}) => {
+  const defaults = {
+    fsPromises: {
+      stat: async () => ({ isDirectory: () => true }),
+      realpath: async (p) => p,
+    },
+    path: {
+      resolve: (p) => p,
+    },
+    normalizeDirectoryPath: (value) => value,
+    readSettingsFromDiskMigrated: async () => ({}),
+    getReadSettingsFromDiskMigrated: () => async () => ({}),
+    sanitizeProjects: (input) => input,
+  };
+
+  return createProjectDirectoryRuntime({ ...defaults, ...overrides });
+};
+
+describe('project directory runtime', () => {
+  describe('validateDirectoryPath', () => {
+    it('returns resolved real path for a valid directory', async () => {
+      const runtime = createTestRuntime();
+      const result = await runtime.validateDirectoryPath('/home/user/project');
+
+      expect(result).toEqual({ ok: true, directory: '/home/user/project' });
+    });
+
+    it('resolves symlinks via fsPromises.realpath', async () => {
+      const runtime = createTestRuntime({
+        fsPromises: {
+          stat: async () => ({ isDirectory: () => true }),
+          realpath: async () => '/real/path/to/project',
+        },
+      });
+
+      const result = await runtime.validateDirectoryPath('/symlink/path/to/project');
+
+      expect(result).toEqual({ ok: true, directory: '/real/path/to/project' });
+    });
+
+    it('returns error when candidate is empty', async () => {
+      const runtime = createTestRuntime();
+      const result = await runtime.validateDirectoryPath('');
+
+      expect(result).toEqual({ ok: false, error: 'Directory parameter is required' });
+    });
+
+    it('returns error when candidate is not a string', async () => {
+      const runtime = createTestRuntime();
+      const result = await runtime.validateDirectoryPath(null);
+
+      expect(result).toEqual({ ok: false, error: 'Directory parameter is required' });
+    });
+
+    it('returns error when path is not a directory', async () => {
+      const runtime = createTestRuntime({
+        fsPromises: {
+          stat: async () => ({ isDirectory: () => false }),
+          realpath: async (p) => p,
+        },
+      });
+
+      const result = await runtime.validateDirectoryPath('/some/file.txt');
+
+      expect(result).toEqual({ ok: false, error: 'Specified path is not a directory' });
+    });
+
+    it('returns error when path does not exist', async () => {
+      const runtime = createTestRuntime({
+        fsPromises: {
+          stat: async () => { throw { code: 'ENOENT' }; },
+          realpath: async (p) => p,
+        },
+      });
+
+      const result = await runtime.validateDirectoryPath('/nonexistent');
+
+      expect(result).toEqual({ ok: false, error: 'Directory not found' });
+    });
+
+    it('returns error when access is denied', async () => {
+      const runtime = createTestRuntime({
+        fsPromises: {
+          stat: async () => { throw { code: 'EACCES' }; },
+          realpath: async (p) => p,
+        },
+      });
+
+      const result = await runtime.validateDirectoryPath('/restricted');
+
+      expect(result).toEqual({ ok: false, error: 'Access to directory denied' });
+    });
+
+    it('returns error when realpath fails after stat succeeds', async () => {
+      const runtime = createTestRuntime({
+        fsPromises: {
+          stat: async () => ({ isDirectory: () => true }),
+          realpath: async () => { throw { code: 'ENOENT' }; },
+        },
+      });
+
+      const result = await runtime.validateDirectoryPath('/deleted-after-stat');
+
+      expect(result).toEqual({ ok: false, error: 'Directory not found' });
+    });
+  });
+
+  describe('resolveProjectDirectory', () => {
+    it('resolves symlinks in x-opencode-directory header', async () => {
+      const runtime = createTestRuntime({
+        fsPromises: {
+          stat: async () => ({ isDirectory: () => true }),
+          realpath: async () => '/real/workspace/project',
+        },
+      });
+
+      const req = {
+        get: (header) => header === 'x-opencode-directory' ? '/home/user/workspace/project' : null,
+        query: {},
+      };
+
+      const result = await runtime.resolveProjectDirectory(req);
+
+      expect(result).toEqual({ directory: '/real/workspace/project', error: null });
+    });
+
+    it('resolves symlinks in query directory parameter', async () => {
+      const runtime = createTestRuntime({
+        fsPromises: {
+          stat: async () => ({ isDirectory: () => true }),
+          realpath: async () => '/real/workspace/project',
+        },
+      });
+
+      const req = {
+        get: () => null,
+        query: { directory: '/home/user/workspace/project' },
+      };
+
+      const result = await runtime.resolveProjectDirectory(req);
+
+      expect(result).toEqual({ directory: '/real/workspace/project', error: null });
+    });
+
+    it('resolves symlinks in lastDirectory from settings', async () => {
+      const runtime = createTestRuntime({
+        fsPromises: {
+          stat: async () => ({ isDirectory: () => true }),
+          realpath: async () => '/real/workspace/project',
+        },
+        getReadSettingsFromDiskMigrated: () => async () => ({
+          lastDirectory: '/home/user/workspace/project',
+        }),
+      });
+
+      const req = {
+        get: () => null,
+        query: {},
+      };
+
+      const result = await runtime.resolveProjectDirectory(req);
+
+      expect(result).toEqual({ directory: '/real/workspace/project', error: null });
+    });
+
+    it('resolves symlinks in active project path from settings', async () => {
+      const runtime = createTestRuntime({
+        fsPromises: {
+          stat: async () => ({ isDirectory: () => true }),
+          realpath: async () => '/real/workspace/project',
+        },
+        getReadSettingsFromDiskMigrated: () => async () => ({
+          projects: [{ id: 'proj-1', path: '/home/user/workspace/project' }],
+          activeProjectId: 'proj-1',
+        }),
+        sanitizeProjects: (input) => input,
+      });
+
+      const req = {
+        get: () => null,
+        query: {},
+      };
+
+      const result = await runtime.resolveProjectDirectory(req);
+
+      expect(result).toEqual({ directory: '/real/workspace/project', error: null });
+    });
+  });
+
+  describe('resolveOptionalProjectDirectory', () => {
+    it('returns null directory when no directory is requested', async () => {
+      const runtime = createTestRuntime();
+
+      const req = {
+        get: () => null,
+        query: {},
+      };
+
+      const result = await runtime.resolveOptionalProjectDirectory(req);
+
+      expect(result).toEqual({ directory: null, error: null });
+    });
+
+    it('resolves symlinks when directory is provided', async () => {
+      const runtime = createTestRuntime({
+        fsPromises: {
+          stat: async () => ({ isDirectory: () => true }),
+          realpath: async () => '/real/workspace/project',
+        },
+      });
+
+      const req = {
+        get: (header) => header === 'x-opencode-directory' ? '/symlink/workspace/project' : null,
+        query: {},
+      };
+
+      const result = await runtime.resolveOptionalProjectDirectory(req);
+
+      expect(result).toEqual({ directory: '/real/workspace/project', error: null });
+    });
+  });
+});