feat(logger): include enumerable properties in formatted errors

[dreamorosi]

Summary

Changes

Please provide a summary of what's being changed

This PR improves the logic used to format errors for Logger to start including all enumerable properties of the error including both own and inherited.

This change was done in response to customer demand and considering it's additive, we don't consider it as a breaking change.

Consider the following error:

const customSymbol = Symbol('customSymbol');
class CustomError extends Error {
  public otherProperty: string;

  public constructor(
    message: string,
    public readonly code: number
  ) {
    super(message);
    this.name = 'CustomError';
    this.otherProperty = 'otherProperty';
  }

  public [customSymbol] = (): void => {
    // do nothing
  };
}

class SuperCustomError extends CustomError {
  public extraProperty: string;
  public constructor(message: string, code: number) {
    super(message, code);
    this.name = 'SuperCustomError';
    this.extraProperty = 'extraProperty';
  }
}

Before this change, calling logger.error('An error occurred', new SuperCustomError('foo', 303)); generated this log:

{
  "message": "foo",
  "location": "/path/to/my/source-code/my-service/handler.ts:18",
  "name": "SuperCustomError",
  "stack": "Error: Unexpected error #1    at lambdaHandler (/path/to/my/source-code/my-service/handler.ts:18:11) ..." 
}

This missed properties that customers might have wanted to see, making the troubleshooting harder than needed.

After the change, the log will instead look like this:

{
  "message": "foo",
  "location": "/path/to/my/source-code/my-service/handler.ts:18",
  "name": "SuperCustomError",
  "stack": "Error: Unexpected error #1    at lambdaHandler (/path/to/my/source-code/my-service/handler.ts:18:11) ...",
  "code": 303,
  "otherProperty": "otherProperty",
  "extraProperty": "extraProperty"
}

Please add the issue number below, if no issue is present the PR might get blocked and not be reviewed

Issue number: closes #2170

---

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

[am29d]

Looks good, only a small nitpick to reduce repetitive statements

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud