chore(custom-checks): add check to prevent circular imports#887
Merged
chore(custom-checks): add check to prevent circular imports#887
Conversation
9bb764e to
9c984aa
Compare
1 task
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #887 +/- ##
==========================================
+ Coverage 85.33% 85.37% +0.04%
==========================================
Files 282 282
Lines 22280 22280
Branches 3366 3366
==========================================
+ Hits 19012 19021 +9
+ Misses 2596 2588 -8
+ Partials 672 671 -1 ☔ View full report in Codecov by Sentry. |
msbrogli
requested changes
Dec 7, 2023
msbrogli
approved these changes
Dec 15, 2023
jansegre
approved these changes
Dec 18, 2023
1ac0f09 to
03d6758
Compare
03d6758 to
de67a6b
Compare
This was referenced Dec 20, 2023
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
Sometimes, when something is imported from the
hathormodule in an entrypoint file (from CLI commands), a circular import could happen, causing the full node node startup to fail. This has happened a couple times in the past (example).This problem would not be caught by our linters and neither tests, so it would only appear after the merge to
master, when the docker image is generated. This PR aims to prevent this by adding a custom lint check that prohibits importing fromhathorin the module-level of CLI entrypoints. For specific cases, a# no-custom-checkcomment can be added to opt-out of this check. Here's an example of a failing output.This will also be useful in #889, as it prevents indirect calls that could automatically install the default Twisted Reactor before our code had a chance to customize it.
Acceptance Criteria
hathormodule in the module-level of CLI related files.Checklist
master, confirm this code is production-ready and can be included in future releases as soon as it gets merged