-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
core.ts
350 lines (315 loc) · 9.45 KB
/
core.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
// Copyright 2021 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
import { ChalkInstance } from 'chalk'
import {
ChildProcessByStdio,
SpawnOptionsWithStdioTuple,
StdioPipe,
} from 'child_process'
import { Readable, Writable } from 'node:stream'
import { inspect, promisify } from 'node:util'
import { spawn } from 'node:child_process'
import { chalk, which } from './goods.js'
import { runInCtx, getCtx, root, Context, Options } from './context.js'
import { printCmd, log } from './print.js'
import { quote, substitute } from './guards.js'
import psTreeModule from 'ps-tree'
import { DeepProxy } from '@qiwi/deep-proxy'
const psTree = promisify(psTreeModule)
interface Zx extends Options {
(pieces: TemplateStringsArray, ...args: any[]): ProcessPromise
}
export const $: Zx = new DeepProxy<Zx>(root as Zx, ({trapName, DEFAULT, args: _args}) => {
if (trapName === 'apply') {
const [,, [pieces, ...args]] = _args
let resolve, reject
let promise = new ProcessPromise((...args) => ([resolve, reject] = args))
let cmd = pieces[0],
i = 0
let quote = getCtx().quote
while (i < args.length) {
let s
if (Array.isArray(args[i])) {
s = args[i].map((x: any) => quote(substitute(x))).join(' ')
} else {
s = quote(substitute(args[i]))
}
cmd += s + pieces[++i]
}
promise.ctx = {
...getCtx(),
cmd,
__from: new Error().stack!.split(/^\s*at\s/m)[2].trim(),
resolve,
reject,
}
setImmediate(() => promise._run()) // Make sure all subprocesses are started, if not explicitly by await or then().
return promise
}
return DEFAULT
})
$.cwd = process.cwd()
$.env = process.env
$.quote = quote
$.spawn = spawn
$.verbose = 2
$.maxBuffer = 200 * 1024 * 1024 /* 200 MiB*/
$.prefix = '' // Bash not found, no prefix.
$.shell = true
try {
$.shell = which.sync('bash')
$.prefix = 'set -euo pipefail;'
} catch (e) {}
export class ProcessPromise extends Promise<ProcessOutput> {
child?: ChildProcessByStdio<Writable, Readable, Readable>
_resolved = false
_inheritStdin = true
_piped = false
_prerun: any = undefined
_postrun: any = undefined
ctx?: Context
get stdin() {
this._inheritStdin = false
this._run()
if (!this.child)
throw new Error('Access to stdin without creation a subprocess.')
return this.child.stdin
}
get stdout() {
this._inheritStdin = false
this._run()
if (!this.child)
throw new Error('Access to stdout without creation a subprocess.')
return this.child.stdout
}
get stderr() {
this._inheritStdin = false
this._run()
if (!this.child)
throw new Error('Access to stderr without creation a subprocess.')
return this.child.stderr
}
get exitCode() {
return this.then(
(p) => p.exitCode,
(p) => p.exitCode
)
}
pipe(dest: Writable | ProcessPromise | string) {
if (typeof dest === 'string') {
throw new Error('The pipe() method does not take strings. Forgot $?')
}
if (this._resolved) {
throw new Error(
"The pipe() method shouldn't be called after promise is already resolved!"
)
}
this._piped = true
if (dest instanceof ProcessPromise) {
dest._inheritStdin = false
dest._prerun = this._run.bind(this)
dest._postrun = () => {
if (!dest.child)
throw new Error(
'Access to stdin of pipe destination without creation a subprocess.'
)
this.stdout.pipe(dest.child.stdin)
}
return dest
} else {
this._postrun = () => this.stdout.pipe(dest)
return this
}
}
async kill(signal = 'SIGTERM') {
this.catch((_) => _)
if (!this.child)
throw new Error('Trying to kill child process without creating one.')
if (!this.child.pid) throw new Error('Child process pid is undefined.')
let children = await psTree(this.child.pid)
for (const p of children) {
try {
process.kill(+p.PID, signal)
} catch (e) {}
}
try {
process.kill(this.child.pid, signal)
} catch (e) {}
}
_run() {
if (this.child) return // The _run() called from two places: then() and setTimeout().
if (this._prerun) this._prerun() // In case $1.pipe($2), the $2 returned, and on $2._run() invoke $1._run().
runInCtx(this.ctx!, () => {
const {
nothrow,
cmd,
cwd,
env,
prefix,
shell,
maxBuffer,
__from,
resolve,
reject,
} = this.ctx!
printCmd(cmd)
let options: SpawnOptionsWithStdioTuple<any, StdioPipe, StdioPipe> = {
cwd,
shell,
stdio: [this._inheritStdin ? 'inherit' : 'pipe', 'pipe', 'pipe'],
windowsHide: true,
// TODO: Surprise: maxBuffer have no effect for spawn.
// maxBuffer,
env,
}
let child: ChildProcessByStdio<Writable, Readable, Readable> = spawn(
prefix + cmd,
options
)
child.on('close', (code, signal) => {
let message = `exit code: ${code}`
if (code != 0 || signal != null) {
message = `${stderr || '\n'} at ${__from}`
message += `\n exit code: ${code}${
exitCodeInfo(code) ? ' (' + exitCodeInfo(code) + ')' : ''
}`
if (signal != null) {
message += `\n signal: ${signal}`
}
}
let output = new ProcessOutput({
code,
signal,
stdout,
stderr,
combined,
message,
})
;(code === 0 || nothrow ? resolve : reject)(output)
this._resolved = true
})
let stdout = '',
stderr = '',
combined = ''
let onStdout = (data: any) => {
log({ scope: 'cmd', output: 'stdout', raw: true, verbose: 2 }, data)
stdout += data
combined += data
}
let onStderr = (data: any) => {
log({ scope: 'cmd', output: 'stderr', raw: true, verbose: 2 }, data)
stderr += data
combined += data
}
if (!this._piped) child.stdout.on('data', onStdout) // If process is piped, don't collect or print output.
child.stderr.on('data', onStderr) // Stderr should be printed regardless of piping.
this.child = child
if (this._postrun) this._postrun() // In case $1.pipe($2), after both subprocesses are running, we can pipe $1.stdout to $2.stdin.
})
}
}
export class ProcessOutput extends Error {
#code: number | null = null
#signal: NodeJS.Signals | null = null
#stdout = ''
#stderr = ''
#combined = ''
constructor({
code,
signal,
stdout,
stderr,
combined,
message,
}: {
code: number | null
signal: NodeJS.Signals | null
stdout: string
stderr: string
combined: string
message: string
}) {
super(message)
this.#code = code
this.#signal = signal
this.#stdout = stdout
this.#stderr = stderr
this.#combined = combined
}
toString() {
return this.#combined
}
get stdout() {
return this.#stdout
}
get stderr() {
return this.#stderr
}
get exitCode() {
return this.#code
}
get signal() {
return this.#signal
}
[inspect.custom]() {
let stringify = (s: string, c: ChalkInstance) =>
s.length === 0 ? "''" : c(inspect(s))
return `ProcessOutput {
stdout: ${stringify(this.stdout, chalk.green)},
stderr: ${stringify(this.stderr, chalk.red)},
signal: ${inspect(this.signal)},
exitCode: ${(this.exitCode === 0 ? chalk.green : chalk.red)(this.exitCode)}${
exitCodeInfo(this.exitCode)
? chalk.grey(' (' + exitCodeInfo(this.exitCode) + ')')
: ''
}
}`
}
}
function exitCodeInfo(exitCode: number | null): string | undefined {
return {
2: 'Misuse of shell builtins',
126: 'Invoked command cannot execute',
127: 'Command not found',
128: 'Invalid exit argument',
129: 'Hangup',
130: 'Interrupt',
131: 'Quit and dump core',
132: 'Illegal instruction',
133: 'Trace/breakpoint trap',
134: 'Process aborted',
135: 'Bus error: "access to undefined portion of memory object"',
136: 'Floating point exception: "erroneous arithmetic operation"',
137: 'Kill (terminate immediately)',
138: 'User-defined 1',
139: 'Segmentation violation',
140: 'User-defined 2',
141: 'Write to pipe with no one reading',
142: 'Signal raised by alarm',
143: 'Termination (request to terminate)',
145: 'Child process terminated, stopped (or continued*)',
146: 'Continue if stopped',
147: 'Stop executing temporarily',
148: 'Terminal stop signal',
149: 'Background process attempting to read from tty ("in")',
150: 'Background process attempting to write to tty ("out")',
151: 'Urgent data available on socket',
152: 'CPU time limit exceeded',
153: 'File size limit exceeded',
154: 'Signal raised by timer counting virtual time: "virtual timer expired"',
155: 'Profiling timer expired',
157: 'Pollable event',
159: 'Bad syscall',
}[exitCode || -1]
}