Refactor the contract analyzer #239
Open
Conversation
This file contains 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
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #239 +/- ##
==========================================
- Coverage 87.50% 87.50% -0.01%
==========================================
Files 61 61
Lines 7798 7795 -3
==========================================
- Hits 6824 6821 -3
Misses 796 796
Partials 178 178 ☔ View full report in Codecov by Sentry. |
yuxincs
force-pushed
the
yuxincs/refactor-function-contract-analyzer
branch
from
ebec5a0
to
045d6f0
Compare
yuxincs
force-pushed
the
yuxincs/refactor-function-contract-analyzer
branch
from
045d6f0
to
4c694b0
Compare
sonalmahajan15
approved these changes
May 23, 2024
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.
This PR simply refactors the contract analyzer to prepare for further updates. Specifically, it
(1) Defines a separate type for
[]Contractsuch that it can be made to be exported (i.e., satisfies theanalysis.Factinterface) in the future.(2) Replaces a few places where we were returning initialized empty slices with simple
nil. In principle we should not distinguish nil slice vs empty nonnil slice.(3) Shortens a few variable names to help improve readability without introducing ambiguity (since the variables are all under the
functioncontractspackage already).(4) Moved test cases from
src/go.uber.org/functioncontracts/xxxtosrc/go.uber.org/xxxinsidefunctioncontractspackage. Those tests are only meant to be used forfunctioncontractspackage, such that an extra folder only increases nesting but does not help test organization.Note that this PR does not bring any functionality changes.