fix(common): correct order for logger error parameters

[ChrisiPK]

The error() function of a logger has two optional parameters: the trace and the context. The logger now no longer passes the global context as the first optional parameter when there are is no value supplied for the trace parameter. Instead, the trace parameter is passed as undefined and the context is passed as the second optional parameter.

This fixes a bug where the trace is overwritten by the context when passed to custom loggers. Fixes gremo/nest-winston#473

PR Checklist

Please check if your PR fulfills the following requirements:

• The commit message follows our guidelines: https://github.com/nestjs/nest/blob/master/CONTRIBUTING.md
• Tests for the changes have been added (for bug fixes / features)
• Docs have been added / updated (for bug fixes / features) Couldn't find any reference to this behavior in the docs.

PR Type

What kind of change does this PR introduce?

• Bugfix
• Feature
• Code style update (formatting, local variables)
• Refactoring (no functional changes, no api changes)
• Build related changes
• CI related changes
• Other... Please describe:

What is the current behavior?

When implementing a custom logger, instantiating the Nest Logger with a context and then calling logger.error(message), the Nest logger will call the underlying logger's function with customLogger.error(message, context).

However, the interface for the error message is defined as follows: error(message: any, stack?: string, context?: string): void; This clearly shows that the first parameter after the message is the stack and the second parameter is the context. Consequently, Nest passing the context as the second parameter (i.e. first optional parameter) is incorrect.

An example of this behavior causing problems for custom logger implementations can be found in gremo/nest-winston#473

Issue Number: N/A

What is the new behavior?

In the case mentioned above with a custom logger and a Nest logger with a global context, calling logger.error(message) in the code will now make Nest correctly call the underlying logger with customLogger.error(message, undefined, context). Note how the first optional parameter (the trace) is now passed as undefined and the second optional parameter contains the context.

Does this PR introduce a breaking change?

• Yes
• No

If users correctly used the error() function of the Logger, i.e. they used the first optional parameter for the trace and the second optional parameter for the context, there is no need to change anything.
If users copied the behavior of Nest of setting the context to the first optional parameter of the error() function (e.g. calling logger.error(message, context)), then the code needs to be changed to correctly pass the context as the second optional parameter: logger.error(message, undefined, context)

Other information

[coveralls]

Pull Request Test Coverage Report for Build b3bcc5d3-3522-4c1d-abfb-ace9db0256e5

• 0 of 0 changed or added relevant lines in 0 files are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage remained the same at 93.776%

---

Totals
Change from base Build db07b797-b226-4c6c-9b82-22af4fb43cb5:	0.0%
Covered Lines:	6147
Relevant Lines:	6555

---

💛 - Coveralls

[kamilmysliwiec]

LGTM