fix: Windows venv initialization issues

4pmtong · 4pmtong · commit ba73b6b9b6c8 · 2026-02-04T23:18:20.000+08:00
diff --git a/electron/main/utils/process.ts b/electron/main/utils/process.ts
@@ -163,15 +163,22 @@ function fixPyvenvCfgPlaceholder(pyvenvCfgPath: string): boolean {
     if (content.includes('{{PREBUILT_PYTHON_DIR}}')) {
       const prebuiltPythonDir = getPrebuiltPythonDir();
       if (!prebuiltPythonDir) {
-        log.warn('[VENV] Cannot fix pyvenv.cfg: prebuilt Python directory not found');
+        log.warn(
+          '[VENV] Cannot fix pyvenv.cfg: prebuilt Python directory not found'
+        );
         return false;
       }
 
       // Replace placeholder with actual path
       // On Windows, path.join returns paths with backslashes, which matches our placeholder format
-      content = content.replace(/\{\{PREBUILT_PYTHON_DIR\}\}/g, prebuiltPythonDir);
+      content = content.replace(
+        /\{\{PREBUILT_PYTHON_DIR\}\}/g,
+        prebuiltPythonDir
+      );
       fs.writeFileSync(pyvenvCfgPath, content);
-      log.info(`[VENV] Fixed pyvenv.cfg placeholder with: ${prebuiltPythonDir}`);
+      log.info(
+        `[VENV] Fixed pyvenv.cfg placeholder with: ${prebuiltPythonDir}`
+      );
       return true;
     }
 
@@ -195,20 +202,24 @@ function fixPyvenvCfgPlaceholder(pyvenvCfgPath: string): boolean {
 /**
  * Fix shebang lines in venv scripts by replacing placeholder with actual Python path
  * This ensures scripts can be executed directly (not just via `uv run`)
+ * Note: Windows doesn't use shebangs - it uses .exe wrappers instead
  */
 function fixVenvScriptShebangs(venvPath: string): boolean {
   const isWindows = process.platform === 'win32';
-  const binDir = isWindows
-    ? path.join(venvPath, 'Scripts')
-    : path.join(venvPath, 'bin');
+
+  // Windows doesn't use shebangs - skip this step
+  if (isWindows) {
+    log.info(`[VENV] Skipping shebang fixes on Windows (not needed)`);
+    return true;
+  }
+
+  const binDir = path.join(venvPath, 'bin');
 
   if (!fs.existsSync(binDir)) {
     return false;
   }
 
-  const pythonExe = isWindows
-    ? path.join(binDir, 'python.exe')
-    : path.join(binDir, 'python');
+  const pythonExe = path.join(binDir, 'python');
 
   if (!fs.existsSync(pythonExe)) {
     log.warn(`[VENV] Python executable not found: ${pythonExe}`);
@@ -373,7 +384,10 @@ export function getPrebuiltTerminalVenvPath(): string | null {
   );
   if (fs.existsSync(prebuiltTerminalVenvPath)) {
     const pyvenvCfgPath = path.join(prebuiltTerminalVenvPath, 'pyvenv.cfg');
-    const installedMarker = path.join(prebuiltTerminalVenvPath, '.packages_installed');
+    const installedMarker = path.join(
+      prebuiltTerminalVenvPath,
+      '.packages_installed'
+    );
     if (fs.existsSync(pyvenvCfgPath) && fs.existsSync(installedMarker)) {
       // Fix placeholder in pyvenv.cfg if needed
       fixPyvenvCfgPlaceholder(pyvenvCfgPath);
diff --git a/scripts/fix-symlinks.js b/scripts/fix-symlinks.js
@@ -1,4 +1,5 @@
 #!/usr/bin/env node
+/* global console */
 // ========= Copyright 2025-2026 @ Eigent.ai All Rights Reserved. =========
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -28,6 +29,7 @@
  * - Works on any machine after packaging
  */
 
+import { Buffer } from 'buffer';
 import fs from 'fs';
 import path from 'path';
 import { fileURLToPath } from 'url';
@@ -50,12 +52,22 @@ function findPythonExecutable(uvPythonDir) {
     // Find cpython directory
     for (const entry of entries) {
       if (entry.isDirectory() && entry.name.startsWith('cpython-')) {
-        // Try different possible paths
         const possiblePaths = [
+          // Unix paths
           path.join(uvPythonDir, entry.name, 'bin', 'python3.10'),
           path.join(uvPythonDir, entry.name, 'bin', 'python'),
           path.join(uvPythonDir, entry.name, 'install', 'bin', 'python3.10'),
           path.join(uvPythonDir, entry.name, 'install', 'bin', 'python'),
+          // Windows paths
+          path.join(uvPythonDir, entry.name, 'Scripts', 'python.exe'),
+          path.join(
+            uvPythonDir,
+            entry.name,
+            'install',
+            'Scripts',
+            'python.exe'
+          ),
+          path.join(uvPythonDir, entry.name, 'python.exe'),
         ];
 
         for (const pythonPath of possiblePaths) {
@@ -64,7 +76,7 @@ function findPythonExecutable(uvPythonDir) {
               absolutePath: pythonPath,
               cpythonDir: entry.name,
               // Extract relative path from uv_python
-              relativePath: path.relative(uvPythonDir, pythonPath)
+              relativePath: path.relative(uvPythonDir, pythonPath),
             };
           }
         }
@@ -82,14 +94,29 @@ function findPythonExecutable(uvPythonDir) {
  */
 function fixVenvSymlinks(venvPath, venvName) {
   const binDir = path.join(venvPath, 'bin');
+  const scriptsDir = path.join(venvPath, 'Scripts');
+
+  // Windows uses Scripts directory and doesn't need symlink fixes
+  if (fs.existsSync(scriptsDir) && !fs.existsSync(binDir)) {
+    console.log(`\n📝 Processing ${venvName}`);
+    console.log(
+      `   ℹ️  Windows venv detected - skipping symlink fixes (not needed)`
+    );
+    return true;
+  }
 
   if (!fs.existsSync(binDir)) {
     console.log(`⚠️  ${venvName} bin directory not found: ${binDir}`);
     return false;
   }
 
   // Find Python in uv_python
-  const uvPythonDir = path.join(projectRoot, 'resources', 'prebuilt', 'uv_python');
+  const uvPythonDir = path.join(
+    projectRoot,
+    'resources',
+    'prebuilt',
+    'uv_python'
+  );
   const pythonInfo = findPythonExecutable(uvPythonDir);
 
   if (!pythonInfo) {
@@ -112,22 +139,34 @@ function fixVenvSymlinks(venvPath, venvName) {
       let needsFix = false;
       let currentTarget = null;
 
-      if (fs.existsSync(symlinkPath) || fs.lstatSync(symlinkPath).isSymbolicLink()) {
+      if (
+        fs.existsSync(symlinkPath) ||
+        fs.lstatSync(symlinkPath).isSymbolicLink()
+      ) {
         try {
           currentTarget = fs.readlinkSync(symlinkPath);
 
           // Check if it's a broken symlink or points to wrong location
-          if (path.isAbsolute(currentTarget) || currentTarget.includes('cache')) {
+          if (
+            path.isAbsolute(currentTarget) ||
+            currentTarget.includes('cache')
+          ) {
             needsFix = true;
-            console.log(`   ❌ ${symlinkName}: broken symlink -> ${currentTarget}`);
+            console.log(
+              `   ❌ ${symlinkName}: broken symlink -> ${currentTarget}`
+            );
           } else {
-            console.log(`   ✓  ${symlinkName}: already fixed -> ${currentTarget}`);
+            console.log(
+              `   ✓  ${symlinkName}: already fixed -> ${currentTarget}`
+            );
             continue;
           }
         } catch (err) {
           // Broken symlink
           needsFix = true;
-          console.log(`   ❌ ${symlinkName}: broken symlink (target doesn't exist)`);
+          console.log(
+            `   ❌ ${symlinkName}: broken symlink (target doesn't exist), ${err.message}`
+          );
         }
       } else {
         needsFix = true;
@@ -137,10 +176,16 @@ function fixVenvSymlinks(venvPath, venvName) {
       if (needsFix) {
         // Remove existing symlink
         try {
-          if (fs.existsSync(symlinkPath) || fs.lstatSync(symlinkPath).isSymbolicLink()) {
+          if (
+            fs.existsSync(symlinkPath) ||
+            fs.lstatSync(symlinkPath).isSymbolicLink()
+          ) {
             fs.unlinkSync(symlinkPath);
           }
         } catch (err) {
+          console.error(
+            `   ❌ Failed to remove ${symlinkName}: ${err.message}`
+          );
           // Ignore
         }
 
@@ -171,9 +216,20 @@ function fixVenvSymlinks(venvPath, venvName) {
 
 /**
  * Fix shebang lines in all executable scripts in venv/bin directory
+ * Note: Windows doesn't use shebangs - it uses .exe wrappers instead
  */
 function fixScriptShebangs(venvPath, venvName) {
   const binDir = path.join(venvPath, 'bin');
+  const scriptsDir = path.join(venvPath, 'Scripts');
+
+  // Windows uses Scripts directory and doesn't need shebang fixes
+  if (fs.existsSync(scriptsDir) && !fs.existsSync(binDir)) {
+    console.log(`\n📝 Processing ${venvName}`);
+    console.log(
+      `   ℹ️  Windows venv detected - skipping shebang fixes (not needed)`
+    );
+    return { fixed: 0, skipped: 0 };
+  }
 
   if (!fs.existsSync(binDir)) {
     console.log(`⚠️  ${venvName} bin directory not found: ${binDir}`);
@@ -198,6 +254,7 @@ function fixScriptShebangs(venvPath, venvName) {
           continue;
         }
       } catch (err) {
+        console.error(`   ❌ Failed to check ${entry}: ${err.message}`);
         continue;
       }
 
@@ -222,7 +279,17 @@ function fixScriptShebangs(venvPath, venvName) {
         }
 
         // Check if it contains an absolute path to the venv
-        if (!path.isAbsolute(firstLine.substring(2).trim()) && !firstLine.includes('/resources/prebuilt/venv/')) {
+        // Support both Unix (/resources/prebuilt/venv/) and Windows (\resources\prebuilt\venv\ or \resources\prebuilt\Scripts\)
+        const shebangPath = firstLine.substring(2).trim();
+        const hasVenvPath =
+          firstLine.includes('/resources/prebuilt/venv/') ||
+          firstLine.includes('\\resources\\prebuilt\\venv\\') ||
+          firstLine.includes('/resources/prebuilt/terminal_venv/') ||
+          firstLine.includes('\\resources\\prebuilt\\terminal_venv\\') ||
+          firstLine.includes('/resources/prebuilt/Scripts/') ||
+          firstLine.includes('\\resources\\prebuilt\\Scripts\\');
+
+        if (!path.isAbsolute(shebangPath) && !hasVenvPath) {
           skippedCount++;
           continue;
         }
@@ -244,21 +311,24 @@ function fixScriptShebangs(venvPath, venvName) {
           fs.chmodSync(filePath, 0o755);
           fixedCount++;
 
-          if (fixedCount <= 5) { // Only show first 5 for brevity
+          if (fixedCount <= 5) {
+            // Only show first 5 for brevity
             console.log(`   ✅ Fixed: ${entry}`);
           }
         }
       } catch (err) {
         // Silently skip files that can't be processed
+        console.error(`   ❌ Failed to process ${entry}: ${err.message}`);
         continue;
       }
     }
 
     if (fixedCount > 5) {
       console.log(`   ✅ ... and ${fixedCount - 5} more files`);
     }
-    console.log(`   📊 Total: ${fixedCount} fixed, ${skippedCount} already correct`);
-
+    console.log(
+      `   📊 Total: ${fixedCount} fixed, ${skippedCount} already correct`
+    );
   } catch (error) {
     console.error(`❌ Error processing ${venvName}: ${error.message}`);
   }
@@ -276,12 +346,12 @@ function main() {
   const venvDirs = [
     {
       path: path.join(projectRoot, 'resources', 'prebuilt', 'venv'),
-      name: 'backend venv'
+      name: 'backend venv',
     },
     {
       path: path.join(projectRoot, 'resources', 'prebuilt', 'terminal_venv'),
-      name: 'terminal venv'
-    }
+      name: 'terminal venv',
+    },
   ];
 
   let symlinkSuccessCount = 0;
@@ -307,9 +377,13 @@ function main() {
 
   console.log('\n==========================================================');
   if (totalCount === 0) {
-    console.log('⚠️  No venv directories found - this is OK for development builds');
+    console.log(
+      '⚠️  No venv directories found - this is OK for development builds'
+    );
   } else {
-    console.log(`✅ Fixed symlinks in ${symlinkSuccessCount}/${totalCount} venv(s)`);
+    console.log(
+      `✅ Fixed symlinks in ${symlinkSuccessCount}/${totalCount} venv(s)`
+    );
     console.log(`✅ Fixed shebangs in ${totalShebangsFixed} script(s)`);
     console.log('✅ Venvs are now fully portable!');
   }
diff --git a/scripts/fix-venv-paths.js b/scripts/fix-venv-paths.js
@@ -64,8 +64,8 @@ function fixPyvenvCfg(venvPath, venvName) {
     console.log(`   Original home: ${originalHome}`);
 
     // Extract cpython directory name from the path
-    // Example: /path/to/cpython-3.10.19-macos-aarch64-none/bin -> cpython-3.10.19-macos-aarch64-none
-    const cpythonMatch = originalHome.match(/(cpython-[\w.-]+)/);
+    // Example: /path/to/cpython-3.10.19-macos-aarch64-none/bin -> cpython-3.10.19-macos-aarch64-none + /bin
+    const cpythonMatch = originalHome.match(/(cpython-[\w.-]+)(.*)/);
     if (!cpythonMatch) {
       console.log(
         `⚠️  Could not extract cpython directory from: ${originalHome}`
@@ -74,19 +74,19 @@ function fixPyvenvCfg(venvPath, venvName) {
     }
 
     const cpythonDir = cpythonMatch[1];
+    const pathAfterCpython = cpythonMatch[2];
 
     // Determine if this is Windows or Unix path
     const isWindowsPath =
       /^[A-Za-z]:\\/.test(originalHome) ||
       originalHome.startsWith('\\\\') ||
       originalHome.includes('\\');
-    const binDir = isWindowsPath ? 'Scripts' : 'bin';
 
     // Replace with placeholder that will be substituted at runtime
     // {{PREBUILT_PYTHON_DIR}} will be replaced with the actual path on user's machine
     // Use appropriate path separator for the platform
     const pathSep = isWindowsPath ? '\\' : '/';
-    const newHome = `{{PREBUILT_PYTHON_DIR}}${pathSep}${cpythonDir}${pathSep}${binDir}`;
+    const newHome = `{{PREBUILT_PYTHON_DIR}}${pathSep}${cpythonDir}${pathAfterCpython}`;
     content = content.replace(/^home\s*=\s*.+$/m, `home = ${newHome}`);
 
     // Only write if content changed
