Browse Source
Closes #225 - reduces startup time & package size
Replaces spawn-rx with homegrown (stolen) implementation Removes telemetry for now (until I get an azure account again) Removes unused lodash modules Removes unused testing dependenciesmain
Eric Amodio
7 years ago
11 changed files with 358 additions and 297 deletions
Unified View
Diff Options
-
+45 -104package-lock.json
-
+1 -7package.json
-
+3 -3src/commands/common.ts
-
+7 -9src/extension.ts
-
+33 -44src/git/git.ts
-
+6 -5src/git/gitLocator.ts
-
+148 -0src/git/shell.ts
-
+2 -2src/logger.ts
-
+0 -5src/system/object.ts
-
+0 -5src/system/string.ts
-
+113 -113src/telemetry.ts
+ 45
- 104
package-lock.json
View File
+ 1
- 7
package.json
View File
+ 3
- 3
src/commands/common.ts
View File
+ 7
- 9
src/extension.ts
View File
+ 33
- 44
src/git/git.ts
View File
+ 6
- 5
src/git/gitLocator.ts
View File
+ 148
- 0
src/git/shell.ts
View File
| @ -0,0 +1,148 @@ | |||||
| 'use strict'; | |||||
| import { execFile } from 'child_process'; | |||||
| import { Logger } from '../logger'; | |||||
| import * as fs from 'fs'; | |||||
| import * as path from 'path'; | |||||
| const isWindows = process.platform === 'win32'; | |||||
| /** | |||||
| * Search PATH to see if a file exists in any of the path folders. | |||||
| * | |||||
| * @param {string} exe The file to search for | |||||
| * @return {string} A fully qualified path, or the original path if nothing | |||||
| * is found | |||||
| * | |||||
| * @private | |||||
| */ | |||||
| function runDownPath(exe: string): string { | |||||
| // NB: Windows won't search PATH looking for executables in spawn like | |||||
| // Posix does | |||||
| // Files with any directory path don't get this applied | |||||
| if (exe.match(/[\\\/]/)) return exe; | |||||
| const target = path.join('.', exe); | |||||
| try { | |||||
| if (fs.statSync(target) ) return target; | |||||
| } | |||||
| catch { } | |||||
| const haystack = process.env.PATH!.split(isWindows ? ';' : ':'); | |||||
| for (const p of haystack) { | |||||
| const needle = path.join(p, exe); | |||||
| try { | |||||
| if (fs.statSync(needle)) return needle; | |||||
| } | |||||
| catch { } | |||||
| } | |||||
| return exe; | |||||
| } | |||||
| /** | |||||
| * Finds the executable and parameters to run on Windows. This method | |||||
| * mimics the POSIX behavior of being able to run scripts as executables by | |||||
| * replacing the passed-in executable with the script runner, for PowerShell, | |||||
| * CMD, and node scripts. | |||||
| * | |||||
| * This method also does the work of running down PATH, which spawn on Windows | |||||
| * also doesn't do, unlike on POSIX. | |||||
| */ | |||||
| export function findExecutable(exe: string, args: string[]): { cmd: string; args: string[] } { | |||||
| // POSIX can just execute scripts directly, no need for silly goosery | |||||
| if (!isWindows) return { cmd: runDownPath(exe), args: args }; | |||||
| if (!fs.existsSync(exe)) { | |||||
| // NB: When you write something like `surf-client ... -- surf-build` on Windows, | |||||
| // a shell would normally convert that to surf-build.cmd, but since it's passed | |||||
| // in as an argument, it doesn't happen | |||||
| const possibleExts = ['.exe', '.bat', '.cmd', '.ps1']; | |||||
| for (const ext of possibleExts) { | |||||
| const possibleFullPath = runDownPath(`${exe}${ext}`); | |||||
| if (fs.existsSync(possibleFullPath)) return findExecutable(possibleFullPath, args); | |||||
| } | |||||
| } | |||||
| if (exe.match(/\.ps1$/i)) { | |||||
| const cmd = path.join(process.env.SYSTEMROOT!, 'System32', 'WindowsPowerShell', 'v1.0', 'PowerShell.exe'); | |||||
| const psargs = ['-ExecutionPolicy', 'Unrestricted', '-NoLogo', '-NonInteractive', '-File', exe]; | |||||
| return { cmd: cmd, args: psargs.concat(args) }; | |||||
| } | |||||
| if (exe.match(/\.(bat|cmd)$/i)) { | |||||
| const cmd = path.join(process.env.SYSTEMROOT!, 'System32', 'cmd.exe'); | |||||
| const cmdArgs = ['/C', exe, ...args]; | |||||
| return { cmd: cmd, args: cmdArgs }; | |||||
| } | |||||
| if (exe.match(/\.(js)$/i)) { | |||||
| const cmd = process.execPath; | |||||
| const nodeArgs = [exe]; | |||||
| return { cmd: cmd, args: nodeArgs.concat(args) }; | |||||
| } | |||||
| return { cmd: exe, args: args }; | |||||
| } | |||||
| export interface CommandOptions { | |||||
| readonly cwd?: string; | |||||
| readonly env?: Object; | |||||
| readonly encoding?: BufferEncoding; | |||||
| /** | |||||
| * The size the output buffer to allocate to the spawned process. Set this | |||||
| * if you are anticipating a large amount of output. | |||||
| * | |||||
| * If not specified, this will be 10MB (10485760 bytes) which should be | |||||
| * enough for most Git operations. | |||||
| */ | |||||
| readonly maxBuffer?: number; | |||||
| /** | |||||
| * An optional string or buffer which will be written to | |||||
| * the child process stdin stream immediately immediately | |||||
| * after spawning the process. | |||||
| */ | |||||
| readonly stdin?: string | Buffer; | |||||
| /** | |||||
| * The encoding to use when writing to stdin, if the stdin | |||||
| * parameter is a string. | |||||
| */ | |||||
| readonly stdinEncoding?: string; | |||||
| } | |||||
| export function runCommand(command: string, args: any[], options: CommandOptions = {}) { | |||||
| const { stdin, stdinEncoding, ...opts } = { maxBuffer: 10 * 1024 * 1024, ...options } as CommandOptions; | |||||
| return new Promise<string>((resolve, reject) => { | |||||
| const proc = execFile( | |||||
| command, | |||||
| args, | |||||
| opts, | |||||
| (err: Error & { code?: string | number } | null, stdout, stderr) => { | |||||
| if (!err) { | |||||
| if (stderr) { | |||||
| Logger.warn(`Warning(${command} ${args.join(' ')}): ${stderr}`); | |||||
| } | |||||
| resolve(stdout); | |||||
| return; | |||||
| } | |||||
| if (err.message === 'stdout maxBuffer exceeded') { | |||||
| reject(new Error(`Command output exceeded the allocated stdout buffer. Set 'options.maxBuffer' to a larger value than ${opts.maxBuffer} bytes`)); | |||||
| } | |||||
| Logger.warn(`Error(${command} ${args.join(' ')}): (${err.code}) ${stderr}`); | |||||
| reject(err); | |||||
| } | |||||
| ); | |||||
| if (stdin) { | |||||
| proc.stdin.end(stdin, stdinEncoding || 'utf8'); | |||||
| } | |||||
| }); | |||||
| } | |||||
+ 2
- 2
src/logger.ts
View File
+ 0
- 5
src/system/object.ts
View File
+ 0
- 5
src/system/string.ts
View File
+ 113
- 113
src/telemetry.ts
View File
| @ -1,113 +1,113 @@ | |||||
| 'use strict'; | |||||
| import { Disposable, env, version, workspace } from 'vscode'; | |||||
| import { configuration } from './configuration'; | |||||
| import { Logger } from './logger'; | |||||
| import * as os from 'os'; | |||||
| let _reporter: TelemetryReporter; | |||||
| export class Telemetry extends Disposable { | |||||
| static configure(key: string) { | |||||
| if (!configuration.get<boolean>(configuration.name('advanced')('telemetry')('enabled').value) || | |||||
| !workspace.getConfiguration('telemetry').get<boolean>('enableTelemetry', true)) { | |||||
| return; | |||||
| } | |||||
| const start = process.hrtime(); | |||||
| _reporter = new TelemetryReporter(key); | |||||
| const duration = process.hrtime(start); | |||||
| Logger.log(`Telemetry.configure took ${(duration[0] * 1000) + Math.floor(duration[1] / 1000000)} ms`); | |||||
| } | |||||
| static setContext(context?: { [key: string]: string }) { | |||||
| if (_reporter === undefined) return; | |||||
| _reporter.setContext(context); | |||||
| } | |||||
| static trackEvent(name: string, properties?: { [key: string]: string }, measurements?: { [key: string]: number; }) { | |||||
| if (_reporter === undefined) return; | |||||
| _reporter.trackEvent(name, properties, measurements); | |||||
| } | |||||
| static trackException(ex: Error) { | |||||
| if (_reporter === undefined) return; | |||||
| _reporter.trackException(ex); | |||||
| } | |||||
| } | |||||
| export class TelemetryReporter { | |||||
| private appInsights: ApplicationInsights; | |||||
| private _client: Client; | |||||
| private _context: { [key: string]: string }; | |||||
| constructor(key: string) { | |||||
| const diagChannelState = process.env['APPLICATION_INSIGHTS_NO_DIAGNOSTIC_CHANNEL']; | |||||
| (process.env['APPLICATION_INSIGHTS_NO_DIAGNOSTIC_CHANNEL'] ass="kr">as any) ="o">= true; | |||||
| this.appInsights = require('applicationinsights') as ApplicationInsights; | |||||
| process.env['APPLICATION_INSIGHTS_NO_DIAGNOSTIC_CHANNEL'] |
|||||
| if (this.appInsights.client) { | |||||
| this._client = this.appInsights.getClient(key); | |||||
| // no other way to enable offline mode | |||||
| this._client.channel.setOfflineMode(true); | |||||
| } | |||||
| else { | |||||
| this._client = this.appInsights.setup(key) | |||||
| .setAutoCollectRequests(false) | |||||
| .setAutoCollectPerformance(false) | |||||
| .setAutoCollectExceptions(false) | |||||
| .setAutoCollectDependencies(false) | |||||
| .setAutoCollectConsole(false) | |||||
| .setAutoDependencyCorrelation(false) | |||||
| .setOfflineMode(true) | |||||
| .start() | |||||
| .client; | |||||
| } | |||||
| this.setContext(); | |||||
| this.stripPII(this._client); | |||||
| } | |||||
| setContext(context?: { [key: string]: string }) { | |||||
| if (!this._context) { | |||||
| this._context = Object.create(null); | |||||
| // Add vscode properties | |||||
| this._context['code.language'] = env.language; | |||||
| this._context['code.version'] = version; | |||||
| this._context[this._client.context.keys.sessionId] = env.sessionId; | |||||
| // Add os properties | |||||
| this._context['os.platform'] = os.platform(); | |||||
| this._context['os.version'] = os.release(); | |||||
| } | |||||
| if (context) { | |||||
| Object.assign(this._context, context); | |||||
| } | |||||
| Object.assign(this._client.commonProperties, this._context); | |||||
| } | |||||
| trackEvent(name: string, properties?: { [key: string]: string }, measurements?: { [key: string]: number; }) { | |||||
| this._client.trackEvent(name, properties, measurements); | |||||
| } | |||||
| trackException(ex: Error) { | |||||
| this._client.trackException(ex); | |||||
| } | |||||
| private stripPII(client: Client) { | |||||
| if (client && client.context && client.context.keys && client.context.tags) { | |||||
| const machineNameKey = client.context.keys.deviceMachineName; | |||||
| client.context.tags[machineNameKey] = ''; | |||||
| } | |||||
| } | |||||
| } | |||||
| // 'use strict'; | |||||
| // import { env, version, workspace } from 'vscode'; | |||||
| // import { configuration } from './configuration'; | |||||
| // import { Logger } from './logger'; | |||||
| // import * as os from 'os'; | |||||
| // let _reporter: TelemetryReporter | undefined; | |||||
| // export class Telemetry { | |||||
| // static configure(key: string) { | |||||
| // if (!configuration.get<boolean>(configuration.name('advanced')('telemetry')('enabled').value) || | |||||
| // !workspace.getConfiguration('telemetry').get<boolean>('enableTelemetry', true)) { | |||||
| // return; | |||||
| // } | |||||
| // const start = process.hrtime(); | |||||
| // _reporter = new TelemetryReporter(key); | |||||
| // const duration = process.hrtime(start); | |||||
| // Logger.log(`Telemetry.configure took ${(duration[0] * 1000) + Math.floor(duration[1] / 1000000)} ms`); | |||||
| // } | |||||
| // static setContext(context?: { [key: string]: string }) { | |||||
| // if (_reporter === undefined) return; | |||||
| // _reporter.setContext(context); | |||||
| // } | |||||
| // static trackEvent(name: string, properties?: { [key: string]: string }, measurements?: { [key: string]: number; }) { | |||||
| // if (_reporter === undefined) return; | |||||
| // _reporter.trackEvent(name, properties, measurements); | |||||
| // } | |||||
| // static trackException(ex: Error) { | |||||
| // if (_reporter === undefined) return; | |||||
| // _reporter.trackException(ex); | |||||
| // } | |||||
| // } | |||||
| // export class TelemetryReporter { | |||||
| // private appInsights: ApplicationInsights; | |||||
| // private _client: Client; | |||||
| // private _context: { [key: string]: string }; | |||||
| // constructor(key: string) { | |||||
| // const diagChannelState = process.env['APPLICATION_INSIGHTS_NO_DIAGNOSTIC_CHANNEL']; | |||||
| // (process.env['APPLICATION_INSIGHTS_NO_DIAGNOSTIC_CHANNEL'] as any) = true; | |||||
| // this.appInsights = require('applicationinsights') as ApplicationInsights; | |||||
| // process.env['APPLICATION_INSIGHTS_NO_DIAGNOSTIC_CHANNEL'] = diagChannelState; | |||||
| // if (this.appInsights.client) { | |||||
| // this._client = this.appInsights.getClient(key); | |||||
| // // no other way to enable offline mode | |||||
| // this._client.channel.setOfflineMode(true); | |||||
| // } | |||||
| // else { | |||||
| // this._client = this.appInsights.setup(key) | |||||
| // .setAutoCollectRequests(false) | |||||
| // .setAutoCollectPerformance(false) | |||||
| // .setAutoCollectExceptions(false) | |||||
| // .setAutoCollectDependencies(false) | |||||
| // .setAutoCollectConsole(false) | |||||
| // .setAutoDependencyCorrelation(false) | |||||
| // .setOfflineMode(true) | |||||
| // .start() | |||||
| // .client; | |||||
| // } | |||||
| // this.setContext(); | |||||
| // this.stripPII(this._client); | |||||
| // } | |||||
| // setContext(context?: { [key: string]: string }) { | |||||
| // if (!this._context) { | |||||
| // this._context = Object.create(null); | |||||
| // // Add vscode properties | |||||
| // this._context['code.language'] = env.language; | |||||
| // this._context['code.version'] = version; | |||||
| // this._context[this._client.context.keys.sessionId] = env.sessionId; | |||||
| // // Add os properties | |||||
| // this._context['os.platform'] = os.platform(); | |||||
| // this._context['os.version'] = os.release(); | |||||
| // } | |||||
| // if (context) { | |||||
| // Object.assign(this._context, context); | |||||
| // } | |||||
| // Object.assign(this._client.commonProperties, this._context); | |||||
| // } | |||||
| // trackEvent(name: string, properties?: { [key: string]: string }, measurements?: { [key: string]: number; }) { | |||||
| // this._client.trackEvent(name, properties, measurements); | |||||
| // } | |||||
| // trackException(ex: Error) { | |||||
| // this._client.trackException(ex); | |||||
| // } | |||||
| // private stripPII(client: Client) { | |||||
| // if (client && client.context && client.context.keys && client.context.tags) { | |||||
| // const machineNameKey = client.context.keys.deviceMachineName; | |||||
| // client.context.tags[machineNameKey] = ''; | |||||
| // } | |||||
| // } | |||||
| // } | |||||