openchamber/packages/web/server/lib/opencode/project-directory-runtime.test.js

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', requestedDirectory: '/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', requestedDirectory: '/symlink/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',
        requestedDirectory: '/home/user/workspace/project',
        error: null,
      });
    });

    it('decodes marked x-opencode-directory header values', async () => {
      const pathWithUnicode = '/home/user/测试项目';
      let validatedPath = null;
      const runtime = createTestRuntime({
        fsPromises: {
          stat: async (p) => {
            validatedPath = p;
            return { isDirectory: () => true };
          },
          realpath: async (p) => p,
        },
      });

      const req = {
        get: (header) => {
          if (header === 'x-opencode-directory') return encodeURIComponent(pathWithUnicode);
          if (header === 'x-opencode-directory-encoding') return 'uri';
          return null;
        },
        query: {},
      };

      const result = await runtime.resolveProjectDirectory(req);

      expect(validatedPath).toBe(pathWithUnicode);
      expect(result).toEqual({ directory: pathWithUnicode, requestedDirectory: pathWithUnicode, error: null });
    });

    it('preserves raw percent sequences without directory encoding marker', async () => {
      const rawPath = '/home/user/foo%20bar';
      let validatedPath = null;
      const runtime = createTestRuntime({
        fsPromises: {
          stat: async (p) => {
            validatedPath = p;
            return { isDirectory: () => true };
          },
          realpath: async (p) => p,
        },
      });

      const req = {
        get: (header) => header === 'x-opencode-directory' ? rawPath : null,
        query: {},
      };

      const result = await runtime.resolveProjectDirectory(req);

      expect(validatedPath).toBe(rawPath);
      expect(result).toEqual({ directory: rawPath, requestedDirectory: rawPath, error: null });
    });

    it('falls back to query directory when an unmarked encoded header is invalid', async () => {
      const validPath = '/home/user/workspace/project';
      const runtime = createTestRuntime({
        fsPromises: {
          stat: async (p) => {
            if (p === validPath) return { isDirectory: () => true };
            throw { code: 'ENOENT' };
          },
          realpath: async (p) => p,
        },
      });

      const req = {
        get: (header) => header === 'x-opencode-directory' ? encodeURIComponent(validPath) : null,
        query: { directory: validPath },
      };

      const result = await runtime.resolveProjectDirectory(req);

      expect(result).toEqual({ directory: validPath, requestedDirectory: validPath, 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',
        requestedDirectory: '/home/user/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',
        requestedDirectory: '/home/user/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',
        requestedDirectory: '/home/user/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, requestedDirectory: 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',
        requestedDirectory: '/symlink/workspace/project',
        error: null,
      });
    });

    it('preserves raw percent sequences without directory encoding marker', async () => {
      const rawPath = '/optional/foo%25bar';
      let validatedPath = null;
      const runtime = createTestRuntime({
        fsPromises: {
          stat: async (p) => {
            validatedPath = p;
            return { isDirectory: () => true };
          },
          realpath: async (p) => p,
        },
      });

      const req = {
        get: (header) => header === 'x-opencode-directory' ? rawPath : null,
        query: {},
      };

      const result = await runtime.resolveOptionalProjectDirectory(req);

      expect(validatedPath).toBe(rawPath);
      expect(result).toEqual({ directory: rawPath, requestedDirectory: rawPath, error: null });
    });
  });
});