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

Introduce a verbose flag for debug output #260

Merged
merged 1 commit into from
Jan 10, 2023

Conversation

0xricksanchez
Copy link
Contributor

This allows easier debugging of, e.g., custom bug detectors/hooks and can serve as an entry point for future debug features we do not want to have enabled by default.

@0xricksanchez 0xricksanchez marked this pull request as draft January 6, 2023 08:30
Copy link
Contributor

@oetr oetr left a comment

Choose a reason for hiding this comment

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

Thanks for the PR! I have some minor comments!

packages/hooking/hook.ts Outdated Show resolved Hide resolved
packages/hooking/hook.ts Show resolved Hide resolved
packages/instrumentor/plugins/functionHooks.test.ts Outdated Show resolved Hide resolved
@0xricksanchez
Copy link
Contributor Author

I intentionally left it as a draft for now as I still wasn’t quite content with the current implementation. I wanted to address this in another refactoring and by adding more tests asap. Thanks for the comments I’ll incorporate the feedback 👍

@0xricksanchez 0xricksanchez marked this pull request as ready for review January 9, 2023 12:17
@0xricksanchez 0xricksanchez requested review from oetr and a team January 9, 2023 12:51
Copy link
Contributor

@oetr oetr left a comment

Choose a reason for hiding this comment

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

With this PR the users can easily check if their custom hooks are applied or not. Thanks for this great contribution!

packages/hooking/hook.ts Outdated Show resolved Hide resolved
packages/instrumentor/plugins/functionHooks.test.ts Outdated Show resolved Hide resolved
packages/instrumentor/plugins/functionHooks.test.ts Outdated Show resolved Hide resolved
Copy link
Contributor

@oetr oetr left a comment

Choose a reason for hiding this comment

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

The last bit that's missing is documentation!

@0xricksanchez
Copy link
Contributor Author

Added a short section to the docs for both the verbose logging option and the debug-ability of custom hooks.

Copy link
Contributor

@oetr oetr 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!

@0xricksanchez 0xricksanchez enabled auto-merge (squash) January 10, 2023 18:11
@0xricksanchez 0xricksanchez merged commit e57e514 into main Jan 10, 2023
@0xricksanchez 0xricksanchez deleted the FUZZ-425_debug_bug_detectors branch January 10, 2023 19:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants