Use VS Code's LogOutputChannel for logging

[EhabY]

closes #257

In this PR I create a LogOutputChannel instead of the old OutputChannel. By default, appendLine uses the info logging level so I used info to log most messages, except errors where the error level was used.

I think all of the info can be downgraded into debug level actually, and the errors could be downgraded into warn since they are handled or thrown right away. What do you think?

[code-asher]

I had no idea this existed! Awesome.

[code-asher]

Ah and I mentioned info already but to this point:

the errors could be downgraded into warn since they are handled or thrown right away. What do you think?

I think you are right, looking at the error calls, warn feels appropriate to me for these

[aslilac]

Suggested change

	`Got invalid or missing content length: ${rawContentLength}`,
	"Got invalid or missing content length",
	rawContentLength,

The methods on LogOutputChannel all take ...args: any[], so we can take advantage of that instead of continuing to use string interpolation

[EhabY]

Should I replace all messages that have a dynamic value at the end and remove the trailing : from the message?

The only issue here is that we cannot guarantee that VS Code is going to log those in the same way in future versions. Is it simply a message + args.join(" ")?

[EhabY]

It seems this is how VS Code formats the args, primitives are kept as is, objects are stringified and errors made into human readable errors:

function format(args: any, verbose: boolean = false): string {
	let result = '';

	for (let i = 0; i < args.length; i++) {
		let a = args[i];

		if (a instanceof Error) {
			a = toErrorMessage(a, verbose);
		}

		if (typeof a === 'object') {
			try {
				a = JSON.stringify(a);
			} catch (e) { }
		}

		result += (i > 0 ? ' ' : '') + a;
	}

	return result;
}

[aslilac]

that's really seems like the "right" way to do it, I'm pretty convinced they won't change it majorly

[EhabY]

Probably requires another review now that I replaced all the calls of storage.writeToCoderOutputChannel

[code-asher]

🎉

[matifali]

HI @EhabY. Thanks for your contribution. Could you also add the change to https://github.com/coder/vscode-coder/blob/main/CHANGELOG.md
I am ssuming that the usuall way to do it @code-asher

[EhabY]

Added the change to the changlog

[code-asher]

Ah right yeah, adding a line to the changelog in the PR is the best way yeah.

[code-asher]

I would word it to be more user-centric, like how does this affect the user and what can/should they do about it?

Something like this maybe:

Respect log levels.  In the Coder output panel, you can now select the log level to filter messages.