[rush-lib] Use pnpm-sync-lib logging APIs to customize the log message for pnpm-sync operations.

[g-chao]

Summary

pnpm-sync-lib now have a logMessage API which allow us to customize the log message printing behavior. Check here to see how it implemented.

So, on Rush side, we can use this API to preventing unexpected log message and customize the log message format.

Details

Generally, there will be four types of message coming from pnpm-sync-lib, there are 'info' | 'warning' | 'error' | 'verbose'.

1. Normally, we will only print out info message.
2. error and warning will be printed if there are errors or warnings.
3. The verbose will be printed out if we pass --debug or --vebose flag to the rush commands.

The pnpm-sync-lib also provides operation metadata in the API, so if don't want the message content from pnpm-sync-lib, we can utilize that metadata to fully customize the log message on the Rush side.

How it was tested

Manually tested on local.

Impacted documentation

N/A

[octogonz]

@g-chao I've proposed some upstream changes that should to go in first: tiktok/pnpm-sync#20

The formatting improvements in d490478 rely on that new API.

[octogonz]

@g-chao For some reason this doesn't get printed with rush rebuild --verbose. I didn't have time to investigate why.

[g-chao]

I checked a little bit, this seems a general bug. Basically, the --verbose is not take effect for rush rebuild command.

[octogonz]

It is because BaseInstallManager creates its own ConsoleTerminalProvider rather than reusing the existing one:

rushstack/libraries/rush-lib/src/logic/base/BaseInstallManager.ts

Lines 105 to 106 in e0de053

	this._terminalProvider = new ConsoleTerminalProvider();
	this._terminal = new Terminal(this._terminalProvider);

Seems this code was introduced in PR #3575 and was probably just an oversight.

@iclanton

[octogonz]

The top-level Rush terminal provider is created here:

rushstack/libraries/rush-lib/src/cli/RushCommandLineParser.ts

Lines 106 to 107 in e0de053

	this._terminalProvider = new ConsoleTerminalProvider();
	this._terminal = new Terminal(this._terminalProvider);

It sets verboseEnabled based on the --debug flag not the --verbose flag:

rushstack/libraries/rush-lib/src/cli/RushCommandLineParser.ts

Lines 190 to 193 in e0de053

	public async execute(args?: string[]): Promise<boolean> {
	// debugParameter will be correctly parsed during super.execute(), so manually parse here.
	this._terminalProvider.verboseEnabled = this._terminalProvider.debugEnabled =
	process.argv.indexOf('--debug') >= 0;

I wonder if this was a historical decision? Maybe because of this definition of --verbose?

  -v, --verbose         Display the logs during the build, rather than just
                        displaying the build status summary

Or maybe because not all commands have the --verbose flag?

I'll discuss it with some other maintainers today.

@dmichon-msft

[octogonz]

In afffe7c I have wired up the terminal so that pnpm-sync output is now printed with rush --debug. To unblock this PR, we'll address the problem where --verbose doesn't work in a followup PR.

Ian's feedback has been addressed