Skip to content

Conversation

@Properko
Copy link
Contributor

@Properko Properko commented Feb 14, 2025

Description

Intended to close #160 to avoid log pollution in downstream apps.
Only imported the already existing logger and replaced all console.log with logger.info (in the lib directory).

Fixes #160

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • I have signed the Adobe Open Source CLA.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@ManasMaji
Copy link
Member

Hi @tmathern , @mfrisbey : Can you please review the PR? Providing consumers the option to regulate the logging as per their requirement would be really helpful.

Copy link
Contributor

@mfrisbey mfrisbey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you! I agree with the change. Would you please update the README with instructions on how to re-enabled the log messages? Looking at the debug module, it seems like it has to do with setting the DEBUG environment variable. But I'd appreciate if you would test re-enabling them and adding the documentation.

Would you also please be sure that you've signed the Adobe CLA? The PR is failing with this message:

No signed agreements were found. Please [sign the Adobe CLA](http://opensource.adobe.com/cla.html)! Once signed, close and re-open your pull request to run the check again.

If you have any questions, contact Adobe's Open Source Office by mentioning them on the pull request with @adobe/open-source-office or via email [grp-opensourceoffice@adobe.com](mailto:grp-opensourceoffice@adobe.com).

If you believe this was a mistake, please report an issue at [adobe/cla-bot](https://github.com/adobe/cla-bot/issues).

@Properko
Copy link
Contributor Author

Properko commented Mar 1, 2025

Works as expected. Added debugging note to docs.

There's a gotcha in this repo with the debug module, where it's hardcoded to be enabled in a few test files - so for test runs, regardless of what the env says, debug output will be enabled. Since those are not imported in downstream libs, it doesn't matter though.

@mfrisbey mfrisbey requested a review from pheenomenon March 3, 2025 15:45
@mfrisbey
Copy link
Contributor

mfrisbey commented Mar 3, 2025

I'm looping in @pheenomenon to give final approval, since neither Tania or myself are actively involved in the maintenance of this library anymore.

@pheenomenon wanted to make you aware of this work so that you can provide your input.

Copy link
Member

@bobvanmanen bobvanmanen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@bhellema
Copy link

bhellema commented Mar 6, 2025

@mfrisbey can you take another look and see if things are up to snuff.

Copy link
Contributor

@mfrisbey mfrisbey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@mfrisbey mfrisbey merged commit a1317e9 into adobe:master Mar 6, 2025
4 of 9 checks passed
@adobe-bot
Copy link

🎉 This PR is included in version 4.0.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add option to suppress logs

6 participants