GitNexus/gitnexus/test/unit/lbug-native-safe-path.test.ts

/**
 * Unit Tests: toNativeSafePath
 *
 * Verifies the Windows non-ASCII path workaround that converts paths to
 * 8.3 short-name form before passing them to KuzuDB's native layer.
 */
import { describe, it, expect } from 'vitest';
import path from 'path';
import {
  toNativeSafePath,
  cleanupNativePathJunctions,
  resolveNativeSafeStorageDir,
} from '../../src/core/lbug/lbug-config.js';

describe('toNativeSafePath', () => {
  it('returns ASCII paths unchanged on any platform', () => {
    const p = 'C:\\Users\\test\\project\\.gitnexus\\lbug';
    expect(toNativeSafePath(p)).toBe(p);
  });

  it('returns forward-slash ASCII paths unchanged', () => {
    const p = '/home/user/project/.gitnexus/lbug';
    expect(toNativeSafePath(p)).toBe(p);
  });

  it('returns empty string unchanged', () => {
    expect(toNativeSafePath('')).toBe('');
  });

  if (process.platform !== 'win32') {
    it('returns non-ASCII paths unchanged on non-Windows', () => {
      const p = '/home/用户/project/.gitnexus/lbug';
      expect(toNativeSafePath(p)).toBe(p);
    });
  }

  if (process.platform === 'win32') {
    it('converts a path with non-ASCII parent directory to an ASCII-safe form', () => {
      // Real-world scenario: repo at C:\Project\中文\code, leaf is ASCII (.gitnexus/lbug).
      // Create a CJK parent dir with an ASCII leaf to match.
      const os = require('os');
      const fs = require('fs');
      const path = require('path');
      const cjkParent = path.join(os.tmpdir(), `gn-safepath-测试-${Date.now()}`);
      const asciiLeaf = path.join(cjkParent, 'lbug');
      fs.mkdirSync(cjkParent, { recursive: true });
      try {
        const result = toNativeSafePath(asciiLeaf);
        expect(typeof result).toBe('string');
        expect(result.length).toBeGreaterThan(0);
        // Either 8.3 short path or junction — both produce an all-ASCII result
        // since the leaf ('lbug') is ASCII and the parent is resolved
        if (result !== asciiLeaf) {
          expect(/^[\x00-\x7F]+$/.test(result)).toBe(true);
        }
      } finally {
        cleanupNativePathJunctions();
        fs.rmSync(cjkParent, { recursive: true, force: true });
      }
    });

    it('returns the original path when the target does not exist', () => {
      const nonexistent = 'C:\\不存在的路径\\test';
      const result = toNativeSafePath(nonexistent);
      expect(result).toBe(nonexistent);
    });
  }
});

describe('resolveNativeSafeStorageDir (#2202)', () => {
  it('returns <storage>/<subdir> for an ASCII storage path on any platform', () => {
    const storage = path.join('repo', '.gitnexus');
    expect(resolveNativeSafeStorageDir(storage, 'csv')).toBe(path.join(storage, 'csv'));
    expect(resolveNativeSafeStorageDir(storage, 'pdg-csv')).toBe(path.join(storage, 'pdg-csv'));
  });

  it('keeps csv and pdg-csv distinct (no collision between structural and streamed dirs)', () => {
    const storage = path.join('repo', '.gitnexus');
    expect(resolveNativeSafeStorageDir(storage, 'csv')).not.toBe(
      resolveNativeSafeStorageDir(storage, 'pdg-csv'),
    );
  });

  if (process.platform !== 'win32') {
    it('does NOT relocate a non-ASCII storage path off Windows (platform gate)', () => {
      const storage = path.join('repo', '用户', '.gitnexus');
      // Non-win32: the relocation never fires regardless of non-ASCII chars.
      expect(resolveNativeSafeStorageDir(storage, 'pdg-csv')).toBe(path.join(storage, 'pdg-csv'));
    });
  }

  if (process.platform === 'win32') {
    it('relocates a non-ASCII storage path to a unique mkdtemp os.tmpdir() dir per subdir', () => {
      const fs = require('fs');
      const storage = 'C:\\Project\\中文\\.gitnexus';
      // mkdtemp creates the dirs — track + clean them up.
      const csv = resolveNativeSafeStorageDir(storage, 'csv');
      const pdg = resolveNativeSafeStorageDir(storage, 'pdg-csv');
      try {
        // Both relocated under os.tmpdir(), ASCII-prefixed, and distinct (each
        // mkdtemp call returns a fresh random suffix — never a predictable name).
        expect(pdg.includes('gitnexus-pdg-csv-')).toBe(true);
        expect(csv.includes('gitnexus-csv-')).toBe(true);
        expect(csv).not.toBe(pdg);
        // Two calls for the same (storage, subdir) yield DIFFERENT dirs (random).
        const csv2 = resolveNativeSafeStorageDir(storage, 'csv');
        expect(csv2).not.toBe(csv);
        // The relocated paths are not under the original non-ASCII storage path.
        expect(pdg.includes('中文')).toBe(false);
        fs.rmSync(csv2, { recursive: true, force: true });
      } finally {
        fs.rmSync(csv, { recursive: true, force: true });
        fs.rmSync(pdg, { recursive: true, force: true });
      }
    });
  }
});