Skip to content

Use spawn rather than exec to support paths with spaces #539

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
charliermarsh merged 1 commit into from
Jul 18, 2024
Merged

Use spawn rather than exec to support paths with spaces #539

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 24 additions & 9 deletions src/common/server.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ import {
import { updateServerKind, updateStatus } from "./status";
import { getProjectRoot } from "./utilities";
import { isVirtualWorkspace } from "./vscodeapi";
import { exec } from "child_process";
import { spawn } from "child_process";
import which = require("which");

export type IInitializationOptions = {
Expand All @@ -49,23 +49,40 @@ export type IInitializationOptions = {
/**
* Function to execute a command and return the stdout.
*/
function executeCommand(command: string): Promise<string> {
function executeCommand(cmd: string, args: string[] = []): Promise<string> {
return new Promise((resolve, reject) => {
exec(command, (error, stdout, _) => {
if (error) {
reject(error);
const child = spawn(cmd, args);

@MichaReiser MichaReiser Jul 19, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think execFile is what we want here https://nodejs.org/api/child_process.html

@charliermarsh charliermarsh Jul 19, 2024

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh yeah, that looks better.

@charliermarsh charliermarsh Jul 19, 2024

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can change.


let stdout = "";
let stderr = "";

child.stdout.on("data", (data) => {
stdout += data.toString();
});

child.stderr.on("data", (data) => {
stderr += data.toString();
});

child.on("close", (code) => {
if (code !== 0) {
reject(new Error(stderr));
} else {
resolve(stdout);
}
});

child.on("error", (error) => {
reject(error);
});
});
}

/**
* Get the version of the Ruff executable at the given path.
*/
async function getRuffVersion(executable: string): Promise<VersionInfo> {
const stdout = await executeCommand(`${executable} --version`);
const stdout = await executeCommand(executable, ["--version"]);
const version = stdout.trim().split(" ")[1];
const [major, minor, patch] = version.split(".").map((x) => parseInt(x, 10));
return { major, minor, patch };
Expand Down Expand Up @@ -114,9 +131,7 @@ async function findRuffBinaryPath(
// Otherwise, we'll call a Python script that tries to locate a binary.
let ruffBinaryPath: string | undefined;
try {
const stdout = await executeCommand(
`${settings.interpreter[0]} ${FIND_RUFF_BINARY_SCRIPT_PATH}`,
);
const stdout = await executeCommand(settings.interpreter[0], [FIND_RUFF_BINARY_SCRIPT_PATH]);
ruffBinaryPath = stdout.trim();
} catch (err) {
await vscode.window
Expand Down