Skip to content

fix: use execFile instead of exec for npm calls-W-23661850 #1532

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

Open
soridalac wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: use execFile instead of exec for npm calls-W-23661850 #1532

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
22 changes: 14 additions & 8 deletions src/hooks/diagnostics.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
* limitations under the License.
*/
import childProcess from 'node:child_process';
import { ExecOptions, PromiseWithChild } from 'node:child_process';
import { ExecFileOptions } from 'node:child_process';
import util from 'node:util';
import { join } from 'node:path';
import fs from 'node:fs';
Expand All @@ -24,7 +24,11 @@ import { asString, isString } from '@salesforce/ts-types';
import { parseJsonMap } from '@salesforce/kit';

type HookFunction = (options: { doctor: SfDoctor }) => Promise<[void]>;
type PromisifiedExec = (command: string, options?: ExecOptions) => PromiseWithChild<{ stdout: string; stderr: string }>;
type PromisifiedExecFile = (
command: string,
args: string[],
options?: ExecFileOptions
) => Promise<{ stdout: string; stderr: string }>;

let logger: Logger;
const getLogger = (): Logger => {
Expand All @@ -38,13 +42,15 @@ const pluginName = '@salesforce/plugin-auth';
Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
const messages = Messages.loadMessages(pluginName, 'diagnostics');

let exec: PromisifiedExec;
// Use execFile instead of exec to avoid shell interpretation.
// exec invokes cmd.exe on Windows, which resolves commands from CWD before PATH.
let execFile: PromisifiedExecFile;

export const hook: HookFunction = async (options) => {
getLogger().debug(`Running SfDoctor diagnostics for ${pluginName}`);
exec = util.promisify(childProcess.exec);
execFile = util.promisify(childProcess.execFile) as unknown as PromisifiedExecFile;
try {
await exec('npm -v');
await execFile('npm', ['-v']);
return await Promise.all([cryptoVersionTest(options.doctor)]);
} catch (e: unknown) {
const errMsg = e instanceof Error ? e.message : isString(e) ? e : 'unknown';
Expand Down Expand Up @@ -153,7 +159,7 @@ const supportsCliV2Crypto = async (doctor: SfDoctor): Promise<boolean> => {
// check core CLI
if (root?.length) {
try {
const { stdout } = await exec('npm explain @salesforce/core --json', { cwd: root });
const { stdout } = await execFile('npm', ['explain', '@salesforce/core', '--json'], { cwd: root });
const coreExplanation = JSON.parse(stdout) as NpmExplanation[];
coreSupportsV2 = coreExplanation.every((exp) => exp?.version > '6.6.0');
} catch (e: unknown) {
Expand All @@ -164,7 +170,7 @@ const supportsCliV2Crypto = async (doctor: SfDoctor): Promise<boolean> => {
// check installed plugins
if (dataDir?.length) {
try {
const { stdout } = await exec('npm explain @salesforce/core --json', { cwd: dataDir });
const { stdout } = await execFile('npm', ['explain', '@salesforce/core', '--json'], { cwd: dataDir });
const pluginsExplanation = JSON.parse(stdout) as NpmExplanation[];
pluginsSupportV2 = pluginsExplanation?.length ? pluginsExplanation.every((exp) => exp?.version > '6.6.0') : true;
} catch (e: unknown) {
Expand All @@ -186,7 +192,7 @@ const supportsCliV2Crypto = async (doctor: SfDoctor): Promise<boolean> => {
// last entry is the path. E.g., "auth 3.3.17 (link) /Users/me/dev/plugin-auth",
const pluginPath = pluginEntry.split(' ')?.pop();
if (pluginPath?.length) {
const { stdout } = await exec('npm explain @salesforce/core --json', { cwd: pluginPath });
const { stdout } = await execFile('npm', ['explain', '@salesforce/core', '--json'], { cwd: pluginPath });
const linksExplanation = JSON.parse(stdout) as NpmExplanation[];
return linksExplanation?.every((exp) => exp?.version > '6.6.0');
}
Expand Down
Loading