/*--------------------------------------------------------------------------------------------- * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. See License.txt in the project root for license information. *--------------------------------------------------------------------------------------------*/ import { homedir } from 'os'; import { constants, existsSync, statSync, unlinkSync, chmodSync, truncateSync, readFileSync } from 'fs'; import { spawn, ChildProcess, SpawnOptions } from 'child_process'; import { buildHelpMessage, buildVersionMessage, OPTIONS } from 'vs/platform/environment/node/argv'; import { NativeParsedArgs } from 'vs/platform/environment/common/argv'; import { parseCLIProcessArgv, addArg } from 'vs/platform/environment/node/argvHelper'; import { createWaitMarkerFile } from 'vs/platform/environment/node/wait'; import product from 'vs/platform/product/common/product'; import { isAbsolute, join } from 'vs/base/common/path'; import { whenDeleted, writeFileSync } from 'vs/base/node/pfs'; import { findFreePort, randomPort } from 'vs/base/node/ports'; import { isWindows, isLinux } from 'vs/base/common/platform'; import type { ProfilingSession, Target } from 'v8-inspect-profiler'; import { isString } from 'vs/base/common/types'; import { hasStdinWithoutTty, stdinDataListener, getStdinFilePath, readFromStdin } from 'vs/platform/environment/node/stdin'; function shouldSpawnCliProcess(argv: NativeParsedArgs): boolean { return !!argv['install-source'] || !!argv['list-extensions'] || !!argv['install-extension'] || !!argv['install-builtin-extension'] || !!argv['uninstall-extension'] || !!argv['locate-extension'] || !!argv['telemetry']; } interface IMainCli { main: (argv: NativeParsedArgs) => Promise; } export async function main(argv: string[]): Promise { let args: NativeParsedArgs; try { args = parseCLIProcessArgv(argv); } catch (err) { console.error(err.message); return; } // Help if (args.help) { const executable = `${product.applicationName}${isWindows ? '.exe' : ''}`; console.log(buildHelpMessage(product.nameLong, executable, product.version, OPTIONS)); } // Version Info else if (args.version) { console.log(buildVersionMessage(product.version, product.commit)); } // Extensions Management else if (shouldSpawnCliProcess(args)) { const cli = await new Promise((c, e) => require(['vs/code/node/cliProcessMain'], c, e)); await cli.main(args); return; } // Write File else if (args['file-write']) { const source = args._[0]; const target = args._[1]; // Validate if ( !source || !target || source === target || // make sure source and target are provided and are not the same !isAbsolute(source) || !isAbsolute(target) || // make sure both source and target are absolute paths !existsSync(source) || !statSync(source).isFile() || // make sure source exists as file !existsSync(target) || !statSync(target).isFile() // make sure target exists as file ) { throw new Error('Using --file-write with invalid arguments.'); } try { // Check for readonly status and chmod if so if we are told so let targetMode: number = 0; let restoreMode = false; if (!!args['file-chmod']) { targetMode = statSync(target).mode; if (!(targetMode & constants.S_IWUSR)) { chmodSync(target, targetMode | constants.S_IWUSR); restoreMode = true; } } // Write source to target const data = readFileSync(source); if (isWindows) { // On Windows we use a different strategy of saving the file // by first truncating the file and then writing with r+ mode. // This helps to save hidden files on Windows // (see https://github.com/microsoft/vscode/issues/931) and // prevent removing alternate data streams // (see https://github.com/microsoft/vscode/issues/6363) truncateSync(target, 0); writeFileSync(target, data, { flag: 'r+' }); } else { writeFileSync(target, data); } // Restore previous mode as needed if (restoreMode) { chmodSync(target, targetMode); } } catch (error) { error.message = `Error using --file-write: ${error.message}`; throw error; } } // Just Code else { const env: NodeJS.ProcessEnv = { ...process.env, 'VSCODE_CLI': '1', // this will signal Code that it was spawned from this module 'ELECTRON_NO_ATTACH_CONSOLE': '1' }; delete env['ELECTRON_RUN_AS_NODE']; const processCallbacks: ((child: ChildProcess) => Promise)[] = []; const verbose = args.verbose || args.status; if (verbose) { env['ELECTRON_ENABLE_LOGGING'] = '1'; processCallbacks.push(async child => { child.stdout!.on('data', (data: Buffer) => console.log(data.toString('utf8').trim())); child.stderr!.on('data', (data: Buffer) => console.log(data.toString('utf8').trim())); await new Promise(resolve => child.once('exit', () => resolve())); }); } const hasReadStdinArg = args._.some(a => a === '-'); if (hasReadStdinArg) { // remove the "-" argument when we read from stdin args._ = args._.filter(a => a !== '-'); argv = argv.filter(a => a !== '-'); } let stdinFilePath: string | undefined; if (hasStdinWithoutTty()) { // Read from stdin: we require a single "-" argument to be passed in order to start reading from // stdin. We do this because there is no reliable way to find out if data is piped to stdin. Just // checking for stdin being connected to a TTY is not enough (https://github.com/microsoft/vscode/issues/40351) if (hasReadStdinArg) { stdinFilePath = getStdinFilePath(); // returns a file path where stdin input is written into (write in progress). try { readFromStdin(stdinFilePath, !!verbose); // throws error if file can not be written // Make sure to open tmp file addArg(argv, stdinFilePath); // Enable --wait to get all data and ignore adding this to history addArg(argv, '--wait'); addArg(argv, '--skip-add-to-recently-opened'); args.wait = true; console.log(`Reading from stdin via: ${stdinFilePath}`); } catch (e) { console.log(`Failed to create file to read via stdin: ${e.toString()}`); stdinFilePath = undefined; } } else { // If the user pipes data via stdin but forgot to add the "-" argument, help by printing a message // if we detect that data flows into via stdin after a certain timeout. processCallbacks.push(_ => stdinDataListener(1000).then(dataReceived => { if (dataReceived) { if (isWindows) { console.log(`Run with '${product.applicationName} -' to read output from another program (e.g. 'echo Hello World | ${product.applicationName} -').`); } else { console.log(`Run with '${product.applicationName} -' to read from stdin (e.g. 'ps aux | grep code | ${product.applicationName} -').`); } } })); } } // If we are started with --wait create a random temporary file // and pass it over to the starting instance. We can use this file // to wait for it to be deleted to monitor that the edited file // is closed and then exit the waiting process. let waitMarkerFilePath: string | undefined; if (args.wait) { waitMarkerFilePath = createWaitMarkerFile(verbose); if (waitMarkerFilePath) { addArg(argv, '--waitMarkerFilePath', waitMarkerFilePath); } } // If we have been started with `--prof-startup` we need to find free ports to profile // the main process, the renderer, and the extension host. We also disable v8 cached data // to get better profile traces. Last, we listen on stdout for a signal that tells us to // stop profiling. if (args['prof-startup']) { const portMain = await findFreePort(randomPort(), 10, 3000); const portRenderer = await findFreePort(portMain + 1, 10, 3000); const portExthost = await findFreePort(portRenderer + 1, 10, 3000); // fail the operation when one of the ports couldn't be accquired. if (portMain * portRenderer * portExthost === 0) { throw new Error('Failed to find free ports for profiler. Make sure to shutdown all instances of the editor first.'); } const filenamePrefix = join(homedir(), 'prof-' + Math.random().toString(16).slice(-4)); addArg(argv, `--inspect-brk=${portMain}`); addArg(argv, `--remote-debugging-port=${portRenderer}`); addArg(argv, `--inspect-brk-extensions=${portExthost}`); addArg(argv, `--prof-startup-prefix`, filenamePrefix); addArg(argv, `--no-cached-data`); writeFileSync(filenamePrefix, argv.slice(-6).join('|')); processCallbacks.push(async _child => { class Profiler { static async start(name: string, filenamePrefix: string, opts: { port: number, tries?: number, target?: (targets: Target[]) => Target }) { const profiler = await import('v8-inspect-profiler'); let session: ProfilingSession; try { session = await profiler.startProfiling(opts); } catch (err) { console.error(`FAILED to start profiling for '${name}' on port '${opts.port}'`); } return { async stop() { if (!session) { return; } let suffix = ''; let profile = await session.stop(); if (!process.env['VSCODE_DEV']) { // when running from a not-development-build we remove // absolute filenames because we don't want to reveal anything // about users. We also append the `.txt` suffix to make it // easier to attach these files to GH issues profile = profiler.rewriteAbsolutePaths(profile, 'piiRemoved'); suffix = '.txt'; } await profiler.writeProfile(profile, `${filenamePrefix}.${name}.cpuprofile${suffix}`); } }; } } try { // load and start profiler const mainProfileRequest = Profiler.start('main', filenamePrefix, { port: portMain }); const extHostProfileRequest = Profiler.start('extHost', filenamePrefix, { port: portExthost, tries: 300 }); const rendererProfileRequest = Profiler.start('renderer', filenamePrefix, { port: portRenderer, tries: 200, target: function (targets) { return targets.filter(target => { if (!target.webSocketDebuggerUrl) { return false; } if (target.type === 'page') { return target.url.indexOf('workbench/workbench.html') > 0; } else { return true; } })[0]; } }); const main = await mainProfileRequest; const extHost = await extHostProfileRequest; const renderer = await rendererProfileRequest; // wait for the renderer to delete the // marker file await whenDeleted(filenamePrefix); // stop profiling await main.stop(); await renderer.stop(); await extHost.stop(); // re-create the marker file to signal that profiling is done writeFileSync(filenamePrefix, ''); } catch (e) { console.error('Failed to profile startup. Make sure to quit Code first.'); } }); } const jsFlags = args['js-flags']; if (isString(jsFlags)) { const match = /max_old_space_size=(\d+)/g.exec(jsFlags); if (match && !args['max-memory']) { addArg(argv, `--max-memory=${match[1]}`); } } const options: SpawnOptions = { detached: true, env }; if (!verbose) { options['stdio'] = 'ignore'; } if (isLinux) { addArg(argv, '--no-sandbox'); // Electron 6 introduces a chrome-sandbox that requires root to run. This can fail. Disable sandbox via --no-sandbox } const child = spawn(process.execPath, argv.slice(2), options); if (args.wait && waitMarkerFilePath) { return new Promise(resolve => { // Complete when process exits child.once('exit', () => resolve(undefined)); // Complete when wait marker file is deleted whenDeleted(waitMarkerFilePath!).then(resolve, resolve); }).then(() => { // Make sure to delete the tmp stdin file if we have any if (stdinFilePath) { unlinkSync(stdinFilePath); } }); } return Promise.all(processCallbacks.map(callback => callback(child))); } } function eventuallyExit(code: number): void { setTimeout(() => process.exit(code), 0); } main(process.argv) .then(() => eventuallyExit(0)) .then(null, err => { console.error(err.message || err.stack || err); eventuallyExit(1); });