Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add adhoc debug logger package #1669

Merged
merged 24 commits into from
Dec 19, 2024
Merged

Conversation

feywind
Copy link
Contributor

@feywind feywind commented Oct 21, 2024

This adds a new pseudo-mono-repo package for adhoc debug logging. It's meant to be pulled in across any library and/or GAPIC to provide the ability to do the equivalent of "printf debugging", but with filtering and a disable flag.

Working group spec doc available upon request :)

@product-auto-label product-auto-label bot added the size: xl Pull request size is extra large. label Oct 21, 2024
@feywind feywind marked this pull request as ready for review December 10, 2024 20:23
@feywind feywind requested review from a team as code owners December 10, 2024 20:23
@feywind feywind added the owlbot:run Add this label to trigger the Owlbot post processor. label Dec 10, 2024
@gcf-owl-bot gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Dec 10, 2024
Copy link

snippet-bot bot commented Dec 10, 2024

No region tags are edited in this PR.

This comment is generated by snippet-bot.
If you find problems with this result, please file an issue at:
https://github.com/googleapis/repo-automation-bots/issues.
To update this comment, add snippet-bot:force-run label or use the checkbox below:

  • Refresh this comment

Copy link
Contributor

@leahecole leahecole left a comment

Choose a reason for hiding this comment

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

I took a quick look and only had really teeny nits about package name agreement

.release-please-manifest.json Show resolved Hide resolved
"fix": "gts fix",
"prepare": "npm run compile",
"precompile": "gts clean",
"samples-test": "echo no samples 🙀",
Copy link
Contributor

Choose a reason for hiding this comment

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

There is a sample, should there either be a test or should this actually say no samples tests?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@sofisl wanted to add a system test of some kind, so maybe a sample test would be the best place.

I don't have an official sample tag, and I don't know if we even want one, so I made one up as a placeholder. Any thoughts on that?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

For now I'm just "commenting out" the snippet tags. We'll need to revisit that and/or update the typeless bot later to make automatic JS sample updates possible.

logging-utils/samples/package.json Outdated Show resolved Hide resolved
Copy link
Contributor

@sofisl sofisl left a comment

Choose a reason for hiding this comment

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

Generally, LGTM. However, it would be cool to see it in action in a system test, something like gax's showcase-client. But since we haven't added code into our generated libraries I could see this being more of a to-do.

logging-utils/samples/package.json Outdated Show resolved Hide resolved
logging-utils/src/logging-utils.ts Outdated Show resolved Hide resolved
logging-utils/test/logging-utils.ts Outdated Show resolved Hide resolved
@sofisl
Copy link
Contributor

sofisl commented Dec 11, 2024

Browser tests are failing because I moved them to Node 18. You can wait for this PR to be merged first, or just copy over the .kokoro/**/*browser.cfg/setup/run files from that PR. Or I could admin merge it, since it really doesn't change anything in gax - depends on the speed with which you need it!

@feywind
Copy link
Contributor Author

feywind commented Dec 17, 2024

Browser tests are failing because I moved them to Node 18. You can wait for this PR to be merged first, or just copy over the .kokoro/**/*browser.cfg/setup/run files from that PR. Or I could admin merge it, since it really doesn't change anything in gax - depends on the speed with which you need it!

Soon... I can copy over the browser test config, because this will end up being used in some things that want browser support.

@feywind feywind added the owlbot:run Add this label to trigger the Owlbot post processor. label Dec 18, 2024
@gcf-owl-bot gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Dec 18, 2024
@feywind feywind added the owlbot:run Add this label to trigger the Owlbot post processor. label Dec 19, 2024
@gcf-owl-bot gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Dec 19, 2024
@feywind feywind added the snippet-bot:force-run Force snippet-bot runs its logic label Dec 19, 2024
@snippet-bot snippet-bot bot removed the snippet-bot:force-run Force snippet-bot runs its logic label Dec 19, 2024
@feywind feywind added the owlbot:run Add this label to trigger the Owlbot post processor. label Dec 19, 2024
@gcf-owl-bot gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Dec 19, 2024
@feywind feywind added owlbot:ignore instruct owl-bot to ignore a PR and removed owlbot:ignore instruct owl-bot to ignore a PR labels Dec 19, 2024
@feywind feywind merged commit 8a5cb86 into googleapis:main Dec 19, 2024
30 checks passed
@release-please release-please bot mentioned this pull request Dec 19, 2024
@feywind feywind added the release-please:force-run To run release-please label Dec 19, 2024
@release-please release-please bot removed the release-please:force-run To run release-please label Dec 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size: xl Pull request size is extra large.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants