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

Skip files if no rules are enabled #379

Merged
merged 1 commit into from
Aug 22, 2023

Conversation

datur
Copy link
Contributor

@datur datur commented Aug 15, 2023

Summary

I had suggested on issue #365 that it would be nice to automatically skip a file if no rules were enabled for a given file #365 (comment).

To avoid unnecessary processing of files if no rules are enabled for a given file the config is now checked before processing a file and if no rules are enabled the file is skipped.

Test Plan

Two smoke tests have been added to confirm files are skipped if no rules are enabled.

@facebook-github-bot
Copy link

Hi @datur!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at [email protected]. Thanks!

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Aug 15, 2023
Copy link
Member

@amyreese amyreese left a comment

Choose a reason for hiding this comment

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

There are two main issues with this approach:

  1. by skipping the call to fixit_bytes(), we are not generating a clean Result() object for the file, which will result in the CLI output under-counting the number of clean file results.

  2. this only catching cases where the file config has no enabled rules/modules, but doesn't prevent visiting files when the number of rules actually discovered at runtime is empty (eg, passing --tags to CLI or combination of enable/disable that results in no selected rules).

I think the better solution is to modify fixit_bytes() instead such that it generates a clean result and aborts early if the result of collect_rules(...) is empty.

To avoid unnecessary processing of files if no rules are enabled for a given path then a clean Result is yielded.
@datur datur force-pushed the skip-files-if-no-rules-enabled branch from c488588 to 2ac6cf3 Compare August 17, 2023 08:40
@datur
Copy link
Contributor Author

datur commented Aug 17, 2023

Thanks for the review @amyreese I believe I have addressed your change requests now! Let me know if you have any other feedback 😄

@datur datur requested a review from amyreese August 17, 2023 08:42
@amyreese amyreese merged commit 5fbcbdc into Instagram:main Aug 22, 2023
13 checks passed
@amyreese
Copy link
Member

Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants