chore(custom-checks): add check to prevent circular imports #887
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
hathor
module 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 fromhathor
in the module-level of CLI entrypoints. For specific cases, a# no-custom-check
comment 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
hathor
module 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