test(logger): migrate to vitest & custom matchers

[dreamorosi]

Summary

Changes

Please provide a summary of what's being changed

This PR migrates the unit tests for the Logger utility to use Vitest rather than Jest.

With this change, we can also finally start investing time/effort in custom matchers that can further reduce the boilerplate we write in our tests.

The first example of this are two new custom matchers introduced in this PR:

process.env.POWERTOOLS_DEV = 'true';
vi.spyOn(console, 'info').mockReturnValue();

// Matches any of the logs emitted
expect(console.info).toHaveLogged(
  expect.objectContaining({
    message: 'Hello, world!',
  })
);

// Matches the log emitted at the specified nth call
expect(console.info).toHaveLoggedNth(
  1,
  expect.objectContaining({
    message: 'Hello, world!',
  })
);

These two matchers will be available across all the test suites of our project and allow you to assert that a mocked console method has emitted a specific JSON-structured object.

Before this change, to use the matcher we had to directly drill down the mock calls and manually parse the object each time like this: expect(JSON.parse(logSpy.mock.calls[0][0])).toEqual(...).

These new matchers, in addition to providing a more ergonomic call signature, also provide better error messaging when tests fail. The new matchers leverage framework APIs and provide a more targeted diff between expected and received objects.

Besides the above, the tests are largely unchanged except for 2 new test cases being added due to the new coverage reporter (now using v8 instead of istanbul).

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

Issue number: closes #3130

---

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.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

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

See analysis details on SonarCloud