new-log-viewer: Formalize config parameters and add management utilities. #51
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
junhaoliao
reviewed
Aug 14, 2024
There was a problem hiding this comment.
@Henry8192 Please help addressing the posted comments. I feel some design details could have been more clear to us if we added the function demos / tests.
Comment on lines
208
to
213
| decoderOptions: { | ||
| // TODO: these shall come from config provider | ||
| formatString: "%d{yyyy-MM-dd HH:mm:ss.SSS} [%process.thread.name] %log.level" + | ||
| " %message%n", | ||
| logLevelKey: "log.level", | ||
| timestampKey: "@timestamp", | ||
| formatString: DECODER_OPTIONS_DEFAULT.formatString, | ||
| logLevelKey: DECODER_OPTIONS_DEFAULT.logLevelKey, | ||
| timestampKey: DECODER_OPTIONS_DEFAULT.timestampKey, | ||
| }, |
There was a problem hiding this comment.
This should now be getConfig(CONFIG_NAME.DECODER_OPTIONS), right?
new-log-viewer/src/utils/config.ts
Outdated
| case CONFIG_NAME.THEME: | ||
| return window.localStorage.getItem(LOCAL_STORAGE_KEY.THEME) as ConfigMap[T]; | ||
| case CONFIG_NAME.PAGE_SIZE: | ||
| return window.localStorage.getItem(LOCAL_STORAGE_KEY.PAGE_SIZE) as ConfigMap[T]; |
There was a problem hiding this comment.
To avoid returning value in undesired types, we previously discussed one possible solution to have TypeScript check the return types:
- We can create an object of type
Partial<>of ConfigMap. - Then in the switch-cases, into the object we can assign values on different keys
code. e.g.// TypeScript will show an error if we don't cast (parse) the localStorage value into a number result[CONFIG_NAME.PAGE_SIZE] = Number(window.localStorage.getItem(LOCAL_STORAGE_KEY.PAGE_SIZE)); return result[code] as ConfigMap[T];since TypeScript assumes the values can be undefined in thePartial<>type, although we should have assigned a value in the switch-cases.
I feel Step 1 & 3 may be optimized if we gain better knowledge of TypeScript. We can discuss more after you make the changes.
There was a problem hiding this comment.
Due to TypeScript's inability to validation the return type within the function body, the proposed approach is essentially a hack and a bit unclean. This is not implemented for now to avoid confusions.
junhaoliao
reviewed
Aug 14, 2024
…e size and default config values; improve validation and localStorage handling logic.
junhaoliao
changed the title
…ngs; update theme type in ConfigMap to THEME_NAME.
Co-authored-by: kirkrodrigues <2454684+kirkrodrigues@users.noreply.github.com>
…de review Co-authored-by: kirkrodrigues <2454684+kirkrodrigues@users.noreply.github.com>
kirkrodrigues
approved these changes
Aug 16, 2024
junhaoliao
changed the title
This was referenced Aug 28, 2024
This was referenced Sep 11, 2024
This was referenced Sep 26, 2024
This was referenced Sep 27, 2024
This was referenced Sep 30, 2024
This was referenced Oct 14, 2024
This was referenced Oct 22, 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.
References
This PR follows #48.
Description
The new
utils/config.tsprovides 3 functions:getConfig- takes in aCONFIG_NAME(defined intypings/config.ts) and returns the corresponding result defined inConfigMap. If the code is invalid, returnnull.testConfig- validate aConfigUpdateobject (essentially a {code, value} pair). It is provided to users to test their configs, and is also used bysetConfigto endorse inputs.setConfig- takes in aConfigUpdateobject, validate the input usingtestConfig, and store to localStorage.Validation performed