fix: windows and python compatibility (#786)

Author: vladfrangu

src/lib/exec.ts

@@ -2,6 +2,7 @@ import { type SpawnOptions, type SpawnOptionsWithoutStdio, spawn } from 'node:ch
 
 import { normalizeExecutablePath } from './hooks/runtimes/utils.js';
 import { run } from './outputs.js';
+import { cliDebugPrint } from './utils/cliDebugPrint.js';
 
 const windowsOptions: SpawnOptions = {
 	shell: true,
@@ -14,6 +15,8 @@ const windowsOptions: SpawnOptions = {
 const spawnPromised = async (cmd: string, args: string[], opts: SpawnOptionsWithoutStdio) => {
 	const escapedCommand = normalizeExecutablePath(cmd);
 
+	cliDebugPrint('SpawnPromised', { escapedCommand, args, opts });
+
 	// NOTE: Pipes stderr, stdout to main process
 	const childProcess = spawn(escapedCommand, args, {
 		...opts,

src/lib/hooks/runtimes/javascript.ts

@@ -6,6 +6,7 @@ import which from 'which';
 
 import type { Runtime } from '../useCwdProject.js';
 import { normalizeExecutablePath } from './utils.js';
+import { cliDebugPrint } from '../../utils/cliDebugPrint.js';
 
 const cwdCache = new Map<string, Option<Runtime>>();
 
@@ -51,6 +52,7 @@ export async function useJavaScriptRuntime(cwd = process.cwd()): Promise<Option<
 	const cached = cwdCache.get(cwd);
 
 	if (cached) {
+		cliDebugPrint('useJavaScriptRuntime', { cacheHit: true, cwd, runtime: cached.unwrapOr(null) });
 		return cached;
 	}
 
@@ -86,6 +88,8 @@ export async function useJavaScriptRuntime(cwd = process.cwd()): Promise<Option<
 
 				cwdCache.set(cwd, some(res));
 
+				cliDebugPrint('useJavaScriptRuntime', { cacheHit: false, cwd, runtime: cwdCache.get(cwd)?.unwrap() });
+
 				return some(res);
 			}
 		} catch {
@@ -95,5 +99,7 @@ export async function useJavaScriptRuntime(cwd = process.cwd()): Promise<Option<
 
 	cwdCache.set(cwd, none);
 
+	cliDebugPrint('useJavaScriptRuntime', { cacheHit: false, cwd, runtime: null });
+
 	return none;
 }

src/lib/hooks/runtimes/python.ts

@@ -1,4 +1,3 @@
-import { access } from 'node:fs/promises';
 import { platform } from 'node:os';
 import { join } from 'node:path';
 import process from 'node:process';
@@ -9,6 +8,7 @@ import which from 'which';
 
 import type { Runtime } from '../useCwdProject.js';
 import { normalizeExecutablePath } from './utils.js';
+import { cliDebugPrint } from '../../utils/cliDebugPrint.js';
 
 const cwdCache = new Map<string, Option<Runtime>>();
 
@@ -44,6 +44,7 @@ export async function usePythonRuntime({
 	const cached = cwdCache.get(cwd);
 
 	if (cached && !force) {
+		cliDebugPrint('usePythonRuntime', { cacheHit: true, cwd, runtime: cached.unwrapOr(null) });
 		return cached;
 	}
 
@@ -62,8 +63,6 @@ export async function usePythonRuntime({
 	fullPythonVenvPath = normalizeExecutablePath(fullPythonVenvPath);
 
 	try {
-		await access(fullPythonVenvPath);
-
 		const version = await getPythonVersion(fullPythonVenvPath);
 
 		if (version) {
@@ -75,10 +74,9 @@ export async function usePythonRuntime({
 				}),
 			);
 
-			return some({
-				executablePath: fullPythonVenvPath,
-				version,
-			});
+			cliDebugPrint('usePythonRuntime', { cacheHit: false, cwd, runtime: cwdCache.get(cwd)?.unwrap() });
+
+			return cwdCache.get(cwd)!;
 		}
 	} catch {
 		// Ignore errors
@@ -101,10 +99,9 @@ export async function usePythonRuntime({
 					}),
 				);
 
-				return some({
-					executablePath: fullPath,
-					version,
-				});
+				cliDebugPrint('usePythonRuntime', { cacheHit: false, cwd, runtime: cwdCache.get(cwd)?.unwrap() });
+
+				return cwdCache.get(cwd)!;
 			}
 		} catch {
 			// Continue
@@ -113,5 +110,7 @@ export async function usePythonRuntime({
 
 	cwdCache.set(cwd, none);
 
+	cliDebugPrint('usePythonRuntime', { cacheHit: false, cwd, runtime: null });
+
 	return none;
 }

src/lib/hooks/useActorConfig.ts

@@ -7,6 +7,7 @@ import { err, ok, type Result } from '@sapphire/result';
 
 import { ACTOR_SPECIFICATION_VERSION, DEPRECATED_LOCAL_CONFIG_NAME } from '../consts.js';
 import { error, info, warning } from '../outputs.js';
+import { cliDebugPrint } from '../utils/cliDebugPrint.js';
 import { confirmAction } from '../utils/confirm.js';
 import { getJsonFileContent, getLocalConfigPath } from '../utils.js';
 
@@ -43,6 +44,7 @@ export async function useActorConfig(
 	const cached = cwdCache.get(cwd);
 
 	if (cached) {
+		cliDebugPrint('useActorConfig', { cacheHit: true, config: cached });
 		return ok(cached);
 	}
 
@@ -100,6 +102,8 @@ export async function useActorConfig(
 
 	cwdCache.set(cwd, { exists: true, migrated, config: config || deprecatedConfig || {} });
 
+	cliDebugPrint('useActorConfig', { cacheHit: false, config: cwdCache.get(cwd) });
+
 	return ok({ exists: true, migrated, config: config || deprecatedConfig || {} });
 }
 

src/lib/hooks/useCwdProject.ts

@@ -7,6 +7,7 @@ import { ok, type Result } from '@sapphire/result';
 import { useJavaScriptRuntime } from './runtimes/javascript.js';
 import { usePythonRuntime } from './runtimes/python.js';
 import { ScrapyProjectAnalyzer } from '../projects/scrapy/ScrapyProjectAnalyzer.js';
+import { cliDebugPrint } from '../utils/cliDebugPrint.js';
 
 export enum ProjectLanguage {
 	JavaScript = 0,
@@ -51,6 +52,7 @@ export async function useCwdProject({
 	const cached = cwdCache.get(cwd);
 
 	if (cached) {
+		cliDebugPrint('useCwdProject', { cacheHit: true, project: cached });
 		return ok(cached);
 	}
 
@@ -124,9 +126,11 @@ export async function useCwdProject({
 	const maybeErr = await check();
 
 	if (maybeErr?.isErr()) {
+		cliDebugPrint('useCwdProject', { cacheHit: false, error: maybeErr });
 		return maybeErr;
 	}
 
+	cliDebugPrint('useCwdProject', { cacheHit: false, project });
 	cwdCache.set(cwd, project);
 
 	return ok(project);

src/lib/hooks/useModuleVersion.ts

@@ -2,6 +2,7 @@ import { none, some, type Option } from '@sapphire/result';
 import { execa } from 'execa';
 
 import { ProjectLanguage, type CwdProject } from './useCwdProject.js';
+import { cliDebugPrint } from '../utils/cliDebugPrint.js';
 
 export interface UseModuleVersionInput {
 	moduleName: string;
@@ -77,6 +78,7 @@ const moduleVersionScripts: Record<string, (mod: string) => string[]> = {
 
 export async function useModuleVersion({ moduleName, project }: UseModuleVersionInput): Promise<Option<string>> {
 	if (!project.runtime) {
+		cliDebugPrint('useModuleVersion', { status: 'no_runtime_found', project, moduleName });
 		return none;
 	}
 
@@ -87,12 +89,14 @@ export async function useModuleVersion({ moduleName, project }: UseModuleVersion
 	} else if (project.type === ProjectLanguage.Python || project.type === ProjectLanguage.Scrapy) {
 		moduleVersionScriptKey = 'python';
 	} else {
+		cliDebugPrint('useModuleVersion', { status: 'unsupported_project_type', project, moduleName });
 		return none;
 	}
 
 	const args = moduleVersionScripts[moduleVersionScriptKey]?.(moduleName);
 
 	if (!args) {
+		cliDebugPrint('useModuleVersion', { status: 'no_version_script_found', project, moduleName });
 		return none;
 	}
 
@@ -103,11 +107,15 @@ export async function useModuleVersion({ moduleName, project }: UseModuleVersion
 		});
 
 		if (result.stdout.trim() === 'n/a') {
+			cliDebugPrint('useModuleVersion', { status: 'no_version_found', project, moduleName });
 			return none;
 		}
 
+		cliDebugPrint('useModuleVersion', { status: 'success', project, moduleName, version: result.stdout.trim() });
+
 		return some(result.stdout.trim());
-	} catch {
+	} catch (ex) {
+		cliDebugPrint('useModuleVersion', { status: 'failed_to_run_version_script', project, moduleName, error: ex });
 		return none;
 	}
 }

src/lib/utils/cliDebugPrint.ts

@@ -0,0 +1,7 @@
+import chalk from 'chalk';
+
+export function cliDebugPrint(tag: string, ...args: unknown[]) {
+	if (process.env.APIFY_CLI_DEBUG) {
+		console.error(chalk.gray(`[${tag}]`), ...args);
+	}
+}