Make #khepri_machine{} private
#252
Merged
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
[Why] With the upcoming need to add a field to implement command deduplication, we will have two versions of the record for the machine state. If we expose the definition, it will be more complicate to track which one we are using. [How] The record definition is moved to `src/khepri_machine.erl` and made an opaque type. The module exports functions to access the fields of the record without ever exposing the record itself. Most of these functions were already exported if `TEST` was defined at compile-time. This is no longer needed.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #252 +/- ##
==========================================
+ Coverage 89.14% 89.18% +0.04%
==========================================
Files 20 20
Lines 2920 2932 +12
==========================================
+ Hits 2603 2615 +12
Misses 317 317
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
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.
Why
With the upcoming need to add a field to implement command deduplication, we will have two versions of the record for the machine state.
If we expose the definition, it will be more complicate to track which one we are using.
How
The record definition is moved to
src/khepri_machine.erland made an opaque type.The module exports functions to access the fields of the record without ever exposing the record itself. Most of these functions were already exported if
TESTwas defined at compile-time. This is no longer needed.