forked from microsoft/vscode-go
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
third_party/tree-kill: vendor and fix the pgrep issue
Invoke the default pgrep (/usr/bin/pgrep) and prevent a buggy pgrep from getting in the way. Fixes golang/vscode-go#90 Change-Id: Iea9944fa8688af7781a8665279ec3ac925b0e770
- Loading branch information
Showing
11 changed files
with
369 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,6 @@ | ||
src/**/* | ||
test/ | ||
third_party/ | ||
typings/**/* | ||
.vscode/**/* | ||
tsconfig.json | ||
|
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
# Vendored dependencies | ||
|
||
third_party directory contains code from the third party including | ||
vendored modules that need local modifications (e.g. bug fixes or | ||
necessary enhancement before they are incorporated and released | ||
in the upstream). Every directory must contain LICENSE files. | ||
|
||
The vendored node modules still need to be specified in the dependencies. | ||
For example, after copying the `tree-kill` module to this directory | ||
and applying necessary local modification, run from the root of this | ||
project directory: | ||
|
||
``` | ||
$ npm install --save ./third_party/tree-kill | ||
``` | ||
|
||
This will update `package.json` and `package-lock.json` to point to | ||
the local dependency. | ||
|
||
Note: We didn't test vendoring platform-dependent modules yet. | ||
|
||
|
||
## List of local modification | ||
|
||
`tree-kill`: vendored 1.2.2 with a fix for https://github.com/golang/vscode-go/issues/90 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2018 Peter Krumins | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,89 @@ | ||
Tree Kill | ||
========= | ||
|
||
Kill all processes in the process tree, including the root process. | ||
|
||
Examples | ||
======= | ||
|
||
Kill all the descendent processes of the process with pid `1`, including the process with pid `1` itself: | ||
```js | ||
var kill = require('tree-kill'); | ||
kill(1); | ||
``` | ||
|
||
Send a signal other than SIGTERM.: | ||
```js | ||
var kill = require('tree-kill'); | ||
kill(1, 'SIGKILL'); | ||
``` | ||
|
||
Run a callback when done killing the processes. Passes an error argument if there was an error. | ||
```js | ||
var kill = require('tree-kill'); | ||
kill(1, 'SIGKILL', function(err) { | ||
// Do things | ||
}); | ||
``` | ||
|
||
You can also install tree-kill globally and use it as a command: | ||
```sh | ||
tree-kill 1 # sends SIGTERM to process 1 and its descendents | ||
tree-kill 1 SIGTERM # same | ||
tree-kill 1 SIGKILL # sends KILL instead of TERMINATE | ||
``` | ||
|
||
Methods | ||
======= | ||
|
||
## require('tree-kill')(pid, [signal], [callback]); | ||
|
||
Sends signal `signal` to all children processes of the process with pid `pid`, including `pid`. Signal defaults to `SIGTERM`. | ||
|
||
For Linux, this uses `ps -o pid --no-headers --ppid PID` to find the parent pids of `PID`. | ||
|
||
For Darwin/OSX, this uses `pgrep -P PID` to find the parent pids of `PID`. | ||
|
||
For Windows, this uses `'taskkill /pid PID /T /F'` to kill the process tree. Note that on Windows, sending the different kinds of POSIX signals is not possible. | ||
|
||
Install | ||
======= | ||
|
||
With [npm](https://npmjs.org) do: | ||
|
||
``` | ||
npm install tree-kill | ||
``` | ||
|
||
License | ||
======= | ||
|
||
MIT | ||
|
||
Changelog | ||
========= | ||
|
||
|
||
## [1.2.2] - 2019-12-11 | ||
### Changed | ||
- security fix: sanitize `pid` parameter to fix arbitrary code execution vulnerability | ||
|
||
## [1.2.1] - 2018-11-05 | ||
### Changed | ||
- added missing LICENSE file | ||
- updated TypeScript definitions | ||
|
||
## [1.2.0] - 2017-09-19 | ||
### Added | ||
- TypeScript definitions | ||
### Changed | ||
- `kill(pid, callback)` works. Before you had to use `kill(pid, signal, callback)` | ||
|
||
## [1.1.0] - 2016-05-13 | ||
### Added | ||
- A `tree-kill` CLI | ||
|
||
## [1.0.0] - 2015-09-17 | ||
### Added | ||
- optional callback | ||
- Darwin support |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
#!/usr/bin/env node | ||
kill = require('.') | ||
try { | ||
kill(process.argv[2], process.argv[3], function(err){ | ||
if (err) { | ||
console.log(err.message) | ||
process.exit(1) | ||
} | ||
}) | ||
} | ||
catch (err) { | ||
console.log(err.message) | ||
process.exit(1) | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
/** | ||
* Kills process identified by `pid` and all its children | ||
* | ||
* @param pid | ||
* @param signal 'SIGTERM' by default | ||
* @param callback | ||
*/ | ||
declare function treeKill(pid: number, callback?: (error?: Error) => void): void; | ||
declare function treeKill(pid: number, signal?: string | number, callback?: (error?: Error) => void): void; | ||
|
||
declare namespace treeKill {} | ||
|
||
export = treeKill; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,119 @@ | ||
'use strict'; | ||
|
||
var childProcess = require('child_process'); | ||
var spawn = childProcess.spawn; | ||
var exec = childProcess.exec; | ||
|
||
module.exports = function (pid, signal, callback) { | ||
if (typeof signal === 'function' && callback === undefined) { | ||
callback = signal; | ||
signal = undefined; | ||
} | ||
|
||
pid = parseInt(pid); | ||
if (Number.isNaN(pid)) { | ||
if (callback) { | ||
return callback(new Error("pid must be a number")); | ||
} else { | ||
throw new Error("pid must be a number"); | ||
} | ||
} | ||
|
||
var tree = {}; | ||
var pidsToProcess = {}; | ||
tree[pid] = []; | ||
pidsToProcess[pid] = 1; | ||
|
||
switch (process.platform) { | ||
case 'win32': | ||
exec('taskkill /pid ' + pid + ' /T /F', callback); | ||
break; | ||
case 'darwin': | ||
buildProcessTree(pid, tree, pidsToProcess, function (parentPid) { | ||
// make sure to use the default pgrep (/usr/bin/pgrep) | ||
return spawn('/usr/bin/pgrep', ['-P', parentPid]); | ||
}, function () { | ||
killAll(tree, signal, callback); | ||
}); | ||
break; | ||
// case 'sunos': | ||
// buildProcessTreeSunOS(pid, tree, pidsToProcess, function () { | ||
// killAll(tree, signal, callback); | ||
// }); | ||
// break; | ||
default: // Linux | ||
buildProcessTree(pid, tree, pidsToProcess, function (parentPid) { | ||
return spawn('ps', ['-o', 'pid', '--no-headers', '--ppid', parentPid]); | ||
}, function () { | ||
killAll(tree, signal, callback); | ||
}); | ||
break; | ||
} | ||
}; | ||
|
||
function killAll (tree, signal, callback) { | ||
var killed = {}; | ||
try { | ||
Object.keys(tree).forEach(function (pid) { | ||
tree[pid].forEach(function (pidpid) { | ||
if (!killed[pidpid]) { | ||
killPid(pidpid, signal); | ||
killed[pidpid] = 1; | ||
} | ||
}); | ||
if (!killed[pid]) { | ||
killPid(pid, signal); | ||
killed[pid] = 1; | ||
} | ||
}); | ||
} catch (err) { | ||
if (callback) { | ||
return callback(err); | ||
} else { | ||
throw err; | ||
} | ||
} | ||
if (callback) { | ||
return callback(); | ||
} | ||
} | ||
|
||
function killPid(pid, signal) { | ||
try { | ||
process.kill(parseInt(pid, 10), signal); | ||
} | ||
catch (err) { | ||
if (err.code !== 'ESRCH') throw err; | ||
} | ||
} | ||
|
||
function buildProcessTree (parentPid, tree, pidsToProcess, spawnChildProcessesList, cb) { | ||
var ps = spawnChildProcessesList(parentPid); | ||
var allData = ''; | ||
ps.stdout.on('data', function (data) { | ||
var data = data.toString('ascii'); | ||
allData += data; | ||
}); | ||
|
||
var onClose = function (code) { | ||
delete pidsToProcess[parentPid]; | ||
|
||
if (code != 0) { | ||
// no more parent processes | ||
if (Object.keys(pidsToProcess).length == 0) { | ||
cb(); | ||
} | ||
return; | ||
} | ||
|
||
allData.match(/\d+/g).forEach(function (pid) { | ||
pid = parseInt(pid, 10); | ||
tree[parentPid].push(pid); | ||
tree[pid] = []; | ||
pidsToProcess[pid] = 1; | ||
buildProcessTree(pid, tree, pidsToProcess, spawnChildProcessesList, cb); | ||
}); | ||
}; | ||
|
||
ps.on('close', onClose); | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,82 @@ | ||
{ | ||
"_args": [ | ||
[ | ||
"[email protected]", | ||
"/Users/hakim/projects/google/vscode-go" | ||
] | ||
], | ||
"_from": "[email protected]", | ||
"_id": "[email protected]", | ||
"_inBundle": false, | ||
"_integrity": "sha512-L0Orpi8qGpRG//Nd+H90vFB+3iHnue1zSSGmNOOCh1GLJ7rUKVwV2HvijphGQS2UmhUZewS9VgvxYIdgr+fG1A==", | ||
"_location": "/tree-kill", | ||
"_phantomChildren": {}, | ||
"_requested": { | ||
"type": "version", | ||
"registry": true, | ||
"raw": "[email protected]", | ||
"name": "tree-kill", | ||
"escapedName": "tree-kill", | ||
"rawSpec": "1.2.2", | ||
"saveSpec": null, | ||
"fetchSpec": "1.2.2" | ||
}, | ||
"_requiredBy": [ | ||
"/" | ||
], | ||
"_resolved": "https://registry.npmjs.org/tree-kill/-/tree-kill-1.2.2.tgz", | ||
"_spec": "1.2.2", | ||
"_where": "/Users/hakim/projects/google/vscode-go", | ||
"author": { | ||
"name": "Peteris Krumins", | ||
"email": "[email protected]", | ||
"url": "http://www.catonmat.net" | ||
}, | ||
"bin": { | ||
"tree-kill": "cli.js" | ||
}, | ||
"bugs": { | ||
"url": "https://github.com/pkrumins/node-tree-kill/issues" | ||
}, | ||
"contributors": [ | ||
{ | ||
"name": "Todd Wolfson", | ||
"email": "[email protected]", | ||
"url": "http://twolfson.com/" | ||
}, | ||
{ | ||
"name": "William Hilton", | ||
"email": "[email protected]", | ||
"url": "http://wmhilton.com/" | ||
}, | ||
{ | ||
"name": "Fabrício Matté", | ||
"url": "http://ultcombo.js.org/" | ||
} | ||
], | ||
"description": "kill trees of processes", | ||
"devDependencies": { | ||
"mocha": "^2.2.5" | ||
}, | ||
"homepage": "https://github.com/pkrumins/node-tree-kill", | ||
"keywords": [ | ||
"tree", | ||
"trees", | ||
"process", | ||
"processes", | ||
"kill", | ||
"signal" | ||
], | ||
"license": "MIT", | ||
"main": "index.js", | ||
"name": "tree-kill", | ||
"repository": { | ||
"type": "git", | ||
"url": "git://github.com/pkrumins/node-tree-kill.git" | ||
}, | ||
"scripts": { | ||
"test": "mocha" | ||
}, | ||
"types": "index.d.ts", | ||
"version": "1.2.2" | ||
} |
Oops, something went wrong.