Replace hardcoded config fallback version with dynamic constant #381
Conversation
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
Previously, when loading the config file, the fallback version `”0.3.0"` was hardcoded to handle unversioned configs from earlier releases. This commit replaces the hardcoded value with the centralized `version` constant, ensuring consistency across the codebase and reducing the risk of version mismatches in the future.
belkhadir
requested review from
shahmishal,
cmcgee1024,
justice-adams-apple and
etcwilde
as code owners
|
Thank you for this contribution. The code is working as designed at the time, which is that the version would have to be "0.3.0" (or earlier) if there's no version field in the config.json. This sets the version so that it can be compared further down the line for any migrations of the swiftly installation. Since swiftly does not support upgrading from "0.3.0" and earlier the change here might be to make the version field mandatory, and remove this set if it's not set code. |
This commit aligns with the decision to drop support for configurations without a version field (pre-0.3.0). The `version` property in `Config` is now non-optional and must be explicitly set at creation. - Removed the fallback assignment to "0.3.0" - Updated all code to require and use non-optional `version` - Adjusted the config initializer to take `version` as a parameter - Simplified conditional checks and eliminated `.version?` This ensures that swiftly no longer silently accepts or upgrades legacy configurations without an explicit version.
|
Thanks for the clarification; that makes perfect sense. I've updated the code to make the |
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.
Previously, when loading the config file, the fallback version
"0.3.0"was hardcoded to handle unversioned configs from earlier releases.This MR replaces the hardcoded value with the centralized
SwiftlyCore.versionconstant, ensuring consistency across the codebase and reducing the risk of version mismatches in the future.