feat(logger): disable logs while testing with jest --silent in dev env

[shdq]

Description of your changes

It conditionally initializes console property as an instance of the internal version of Console() class (PR #748) or as the global node console if the `POWERTOOLS_DEV' env variable is set and has a truthy value.

How to verify this change

Related issues, RFCs

Issue number:
#1030

PR status

Is this ready for review?: YES
Is it a breaking change?: NO

Checklist

• My changes meet the tenets criteria
• I have performed a self-review of my own code
• I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
• I have made corresponding changes to the documentation
• I have made corresponding changes to the examples
• My changes generate no new warnings
• The code coverage hasn't decreased
• I have added tests that prove my change is effective and works
• New and existing unit tests pass locally and in Github Actions
• Any dependent changes have been merged and published in downstream module
• The PR title follows the conventional commit semantics

Breaking change checklist

• I have documented the migration process
• I have added, implemented necessary warnings (if it can live side by side)

---

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

[dreamorosi]

Also I think it could be interesting to surface this new behavior in the docs, specifically in this section.

We could add a new sub section under Testing your code

[shdq]

What about testing? Is there a way to unit test this "silent" behavior? I only came up with the idea to somehow check what type of console object we use with POWERTOOL_DEV on and off.

[dreamorosi]

What about testing? Is there a way to unit test this "silent" behavior? I only came up with the idea to somehow check what type of console object we use with POWERTOOL_DEV on and off.

I don't think we should test Jest's behavior. From my point of view we just need to test that when POWERTOOL_DEV is enabled or disabled the value of Logger.console is a new Console object or the global one.

[shdq]

From my point of view we just need to test that when POWERTOOL_DEV is enabled or disabled the value of Logger.console is a new Console object or the global one.

This is what I meant actually.

I tested the global node object when POWERTOOLS_DEV is set. But for the other option, since instances of a class are not the same I presumed the opposite:

expect(logger).not.toEqual({
  ...logger,
  console: console,
});

@dreamorosi what do you think?

[dreamorosi]

I think that's acceptable, maybe just leave a comment right above the assertion for future reference to explain the assertion.

[dreamorosi]

Sorry, I wasn't 100% clear with my previous comment.

In the changes related to the docs, could we please add a code snippet that shows how to call jest with the flag & with the environment variable, similar to what done here?

i.e.

export POWERTOOLS_DEV=true && npx jest --silent

[shdq]

Sorry, I wasn't 100% clear with my previous comment.

I missed the comment it happens in remote communication. I'm pleased to finish the job appropriately. Let me know if some other changes are needed.

[dreamorosi]

Thank you @shdq!

Tomorrow morning I will test the code locally (same process as the one in the issue) & see how it renders in the documentation - then if it's all good I'll approve & we can merge :)

[dreamorosi]

Hi @shdq, I have reviewed the code and it looks good. I also have tested this version in a separate codebase & verified that the `--silent- flag is indeed respected.

I'm going to run the integration tests on this branch now.

In the meanwhile I have left a comment/question about one of the sections of your changes.

[dreamorosi]

Integration tests are passing: https://github.com/awslabs/aws-lambda-powertools-typescript/actions/runs/3469565442

@shdq thank you so much for all the hard work here!