chore(server): better typing for system config key #8580
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
Deploying immich with
|
| Latest commit: |
3597791
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://75a959bf.immich.pages.dev |
| Branch Preview URL: | https://chore-server-config-key-type.immich.pages.dev |
jrasm91
approved these changes
Apr 7, 2024
mertalev
force-pushed
the
chore/server-config-key-type
branch
from
e07d62b
to
031c569
Compare
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.
Description
The
SystemConfigKeyenum is a frequent source of bugs when changes are made to the config. One reason for this is because its values can be any string and don't necessarily need to be valid paths to the config object.This PR tightens the typing for this enum such that any path not in
SystemConfigis an error. To be able to do this, I changed it from an explicit enum to a constant object.This PR includes the fix in #8579.
How Has This Been Tested?
Tested that the server starts up, that admin settings are changed successfully, and of course that invalid paths are caught by TypeScript.