Chore: Future-proofed ConfigFileFormat
#4030
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
Adding new formats to `ConfigFileFormat` is now easier, since you now just have to add the enum value. Previously you had to change multiple lines in the code, which means if you forget one line you basically broke everything.
DiegoKrupitza
commented
Oct 12, 2021
apollo-core/src/main/java/com/ctrip/framework/apollo/core/enums/ConfigFileFormat.java
Show resolved
Hide resolved
Codecov Report
@@ Coverage Diff @@
## master #4030 +/- ##
============================================
+ Coverage 51.49% 51.62% +0.13%
- Complexity 2530 2542 +12
============================================
Files 484 484
Lines 14839 14839
Branches 1537 1536 -1
============================================
+ Hits 7641 7661 +20
+ Misses 6666 6645 -21
- Partials 532 533 +1
Continue to review full report at Codecov.
|
The javadoc now has a note that currently `ConfigFileFormat#Properties` is not compatible with itself.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Adding new formats to
ConfigFileFormatis now easier, since you nowjust have to add the enum value. Previously you had to change multiple
lines in the code, which means if you forget one line you basically
broke everything.
What's the purpose of this PR
So far the supported ConfigFileFormats are hardcoded in few places. The aim of this PR is to make
ConfigFileFormatfuture-proof by reducing the hardcoded values of it. This will make it easier in the future to support new formats such as TOML.Additionally I tested the enum since so far there were no tests. The functionality of
ConfigFileFormatis important in my opinion since it has the task of recognizing the correct format for further processing and should not stay untested.Which issue(s) this PR fixes:
NONE
Follow this checklist to help us incorporate your contribution quickly and easily:
mvn clean testto make sure this pull request doesn't break anything.CHANGESlog.