fix(ci): make runtime path tests cross-platform

Author: ZengLiangYi

server/src/runtime/paths.test.ts

@@ -1,56 +1,85 @@
 import assert from 'node:assert/strict';
+import { posix, win32 } from 'node:path';
 import test from 'node:test';
 import { resolveDataDirForTest } from './paths.js';
 
-test('resolveDataDirForTest uses absolute DATA_DIR verbatim', () => {
-  const dataDir = resolveDataDirForTest({
-    envDataDir: 'C:/data/chatcrystal',
-    packageRoot: 'C:/pkg/server',
-    workspaceRoot: 'C:/pkg',
-    homeDir: 'C:/Users/Rayner',
-  });
-
-  assert.equal(dataDir, 'C:/data/chatcrystal');
-});
-
-test('resolveDataDirForTest resolves relative DATA_DIR against workspace root', () => {
-  const dataDir = resolveDataDirForTest({
-    envDataDir: './data',
+const pathCases = [
+  {
+    name: 'Windows',
+    pathResolver: win32,
+    absoluteDataDir: 'C:/data/chatcrystal',
     packageRoot: 'C:/repo/server',
     workspaceRoot: 'C:/repo',
+    globalPackageRoot: 'C:/global/node_modules/chatcrystal',
     homeDir: 'C:/Users/Rayner',
+  },
+  {
+    name: 'POSIX',
+    pathResolver: posix,
+    absoluteDataDir: '/data/chatcrystal',
+    packageRoot: '/repo/server',
+    workspaceRoot: '/repo',
+    globalPackageRoot: '/global/node_modules/chatcrystal',
+    homeDir: '/home/rayner',
+  },
+];
+
+for (const pathCase of pathCases) {
+  test(`resolveDataDirForTest uses absolute DATA_DIR verbatim on ${pathCase.name}`, () => {
+    const dataDir = resolveDataDirForTest({
+      envDataDir: pathCase.absoluteDataDir,
+      packageRoot: pathCase.packageRoot,
+      workspaceRoot: pathCase.workspaceRoot,
+      homeDir: pathCase.homeDir,
+      pathResolver: pathCase.pathResolver,
+    });
+
+    assert.equal(dataDir, pathCase.absoluteDataDir);
   });
 
-  assert.equal(dataDir, 'C:\\repo\\data');
-});
+  test(`resolveDataDirForTest resolves relative DATA_DIR against workspace root on ${pathCase.name}`, () => {
+    const dataDir = resolveDataDirForTest({
+      envDataDir: './data',
+      packageRoot: pathCase.packageRoot,
+      workspaceRoot: pathCase.workspaceRoot,
+      homeDir: pathCase.homeDir,
+      pathResolver: pathCase.pathResolver,
+    });
 
-test('resolveDataDirForTest falls back to package root when no workspace root exists', () => {
-  const dataDir = resolveDataDirForTest({
-    envDataDir: './data',
-    packageRoot: 'C:/global/node_modules/chatcrystal',
-    workspaceRoot: null,
-    homeDir: 'C:/Users/Rayner',
+    assert.equal(dataDir, pathCase.pathResolver.resolve(pathCase.workspaceRoot, 'data'));
   });
 
-  assert.equal(dataDir, 'C:\\global\\node_modules\\chatcrystal\\data');
-});
+  test(`resolveDataDirForTest falls back to package root when no workspace root exists on ${pathCase.name}`, () => {
+    const dataDir = resolveDataDirForTest({
+      envDataDir: './data',
+      packageRoot: pathCase.globalPackageRoot,
+      workspaceRoot: null,
+      homeDir: pathCase.homeDir,
+      pathResolver: pathCase.pathResolver,
+    });
 
-test('resolveDataDirForTest defaults to ~/.chatcrystal/data when DATA_DIR is unset in a repo checkout', () => {
-  const dataDir = resolveDataDirForTest({
-    packageRoot: 'C:/repo/server',
-    workspaceRoot: 'C:/repo',
-    homeDir: 'C:/Users/Rayner',
+    assert.equal(dataDir, pathCase.pathResolver.resolve(pathCase.globalPackageRoot, 'data'));
   });
 
-  assert.equal(dataDir, 'C:\\Users\\Rayner\\.chatcrystal\\data');
-});
+  test(`resolveDataDirForTest defaults to ~/.chatcrystal/data when DATA_DIR is unset in a repo checkout on ${pathCase.name}`, () => {
+    const dataDir = resolveDataDirForTest({
+      packageRoot: pathCase.packageRoot,
+      workspaceRoot: pathCase.workspaceRoot,
+      homeDir: pathCase.homeDir,
+      pathResolver: pathCase.pathResolver,
+    });
 
-test('resolveDataDirForTest defaults to ~/.chatcrystal/data when installed outside a workspace', () => {
-  const dataDir = resolveDataDirForTest({
-    packageRoot: 'C:/Users/Rayner/AppData/Roaming/npm/node_modules/chatcrystal',
-    workspaceRoot: null,
-    homeDir: 'C:/Users/Rayner',
+    assert.equal(dataDir, pathCase.pathResolver.resolve(pathCase.homeDir, '.chatcrystal', 'data'));
   });
 
-  assert.equal(dataDir, 'C:\\Users\\Rayner\\.chatcrystal\\data');
-});
+  test(`resolveDataDirForTest defaults to ~/.chatcrystal/data when installed outside a workspace on ${pathCase.name}`, () => {
+    const dataDir = resolveDataDirForTest({
+      packageRoot: pathCase.globalPackageRoot,
+      workspaceRoot: null,
+      homeDir: pathCase.homeDir,
+      pathResolver: pathCase.pathResolver,
+    });
+
+    assert.equal(dataDir, pathCase.pathResolver.resolve(pathCase.homeDir, '.chatcrystal', 'data'));
+  });
+}

server/src/runtime/paths.ts

@@ -1,21 +1,24 @@
 import { existsSync, readFileSync } from 'node:fs';
 import { homedir } from 'node:os';
-import { dirname, isAbsolute, resolve } from 'node:path';
+import path from 'node:path';
 import { config } from 'dotenv';
 
 type PackageJson = {
   workspaces?: unknown;
 };
 
+type PathResolver = Pick<typeof path, 'isAbsolute' | 'resolve'>;
+
 type RuntimePathOptions = {
   envDataDir?: string;
   packageRoot: string;
   workspaceRoot?: string | null;
   homeDir?: string;
+  pathResolver?: PathResolver;
 };
 
 function readPackageJson(dir: string): PackageJson | null {
-  const manifestPath = resolve(dir, 'package.json');
+  const manifestPath = path.resolve(dir, 'package.json');
   if (!existsSync(manifestPath)) {
     return null;
   }
@@ -28,31 +31,31 @@ function readPackageJson(dir: string): PackageJson | null {
 }
 
 function findNearestPackageRoot(startDir: string): string {
-  let current = resolve(startDir);
+  let current = path.resolve(startDir);
 
   while (true) {
     if (readPackageJson(current)) {
       return current;
     }
 
-    const parent = dirname(current);
+    const parent = path.dirname(current);
     if (parent === current) {
-      return resolve(startDir, '../../..');
+      return path.resolve(startDir, '../../..');
     }
     current = parent;
   }
 }
 
 function findWorkspaceRoot(packageRoot: string): string | null {
-  let current = dirname(packageRoot);
+  let current = path.dirname(packageRoot);
 
   while (true) {
     const manifest = readPackageJson(current);
     if (manifest?.workspaces) {
       return current;
     }
 
-    const parent = dirname(current);
+    const parent = path.dirname(current);
     if (parent === current) {
       return null;
     }
@@ -67,23 +70,24 @@ function unique<T>(items: T[]): T[] {
 export function resolveDataDirForTest(options: RuntimePathOptions): string {
   const appRoot = options.workspaceRoot ?? options.packageRoot;
   const homeDir = options.homeDir ?? homedir();
+  const pathResolver = options.pathResolver ?? path;
 
-  if (options.envDataDir && isAbsolute(options.envDataDir)) {
+  if (options.envDataDir && pathResolver.isAbsolute(options.envDataDir)) {
     return options.envDataDir;
   }
 
   if (options.envDataDir) {
-    return resolve(appRoot, options.envDataDir);
+    return pathResolver.resolve(appRoot, options.envDataDir);
   }
 
-  return resolve(homeDir, '.chatcrystal', 'data');
+  return pathResolver.resolve(homeDir, '.chatcrystal', 'data');
 }
 
 const packageRoot = findNearestPackageRoot(import.meta.dirname);
 const workspaceRoot = findWorkspaceRoot(packageRoot);
 const appRoot = workspaceRoot ?? packageRoot;
 
-for (const envPath of unique([resolve(appRoot, '.env'), resolve(packageRoot, '.env')])) {
+for (const envPath of unique([path.resolve(appRoot, '.env'), path.resolve(packageRoot, '.env')])) {
   if (existsSync(envPath)) {
     config({ path: envPath });
     break;
@@ -101,8 +105,8 @@ export const runtimePaths = {
   packageRoot,
   workspaceRoot,
   dataDir,
-  dbPath: resolve(dataDir, 'chatcrystal.db'),
-  configPath: resolve(dataDir, 'config.json'),
-  pidPath: resolve(dataDir, 'crystal.pid'),
-  logPath: resolve(dataDir, 'crystal-server.log'),
+  dbPath: path.resolve(dataDir, 'chatcrystal.db'),
+  configPath: path.resolve(dataDir, 'config.json'),
+  pidPath: path.resolve(dataDir, 'crystal.pid'),
+  logPath: path.resolve(dataDir, 'crystal-server.log'),
 };