Skip to content

E2E: improve CLI log format #7364

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
phyllis-sy-wu wants to merge 1 commit into
base: psyw-0420-E2E-utility-cleanup-all
Choose a base branch
from
+20 −5
Open

E2E: improve CLI log format #7364

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
25 changes: 20 additions & 5 deletions packages/e2e/setup/cli.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,18 @@ export const cliFixture = envFixture.extend<{cli: CLIProcess}>({
const spawnedProcesses: SpawnedProcess[] = []
const cliLog = createLogger('cli')

// When DEBUG=1, tee the subprocess streams to the parent so the CLI's
// info/success boxes and progress messages appear live, while still
// letting execa buffer and return the captured output.
const runExeca = (bin: string, args: string[], execaOpts: ExecaOptions) => {
const subprocess = execa('node', [bin, ...args], execaOpts)
if (process.env.DEBUG === '1') {
subprocess.stdout?.pipe(process.stdout, {end: false})
subprocess.stderr?.pipe(process.stderr, {end: false})
}
return subprocess
}

const cli: CLIProcess = {
async exec(args, opts = {}) {
const timeout = opts.timeout ?? CLI_TIMEOUT.medium
Expand All @@ -56,9 +68,10 @@ export const cliFixture = envFixture.extend<{cli: CLIProcess}>({
reject: false,
}

cliLog.log(env, `exec: node ${executables.cli} ${args.join(' ')}`)
cliLog.log(env, `exec: node ${executables.cli}`)
cliLog.log(env, args.join(' '))

const result = await execa('node', [executables.cli, ...args], execaOpts)
const result = await runExeca(executables.cli, args, execaOpts)

return {
stdout: result.stdout ?? '',
Expand All @@ -76,9 +89,10 @@ export const cliFixture = envFixture.extend<{cli: CLIProcess}>({
reject: false,
}

cliLog.log(env, `exec: node ${executables.createApp} ${args.join(' ')}`)
cliLog.log(env, `exec: node ${executables.createApp}`)
cliLog.log(env, `app init ${args.join(' ')}`)

const result = await execa('node', [executables.createApp, ...args], execaOpts)
const result = await runExeca(executables.createApp, args, execaOpts)

return {
stdout: result.stdout ?? '',
Expand All @@ -98,7 +112,8 @@ export const cliFixture = envFixture.extend<{cli: CLIProcess}>({
}
}

cliLog.log(env, `spawn: node ${executables.cli} ${args.join(' ')}`)
cliLog.log(env, `spawn: node ${executables.cli}`)
cliLog.log(env, args.join(' '))

const ptyProcess = nodePty.spawn('node', [executables.cli, ...args], {
name: 'xterm-color',
Expand Down
Loading