Validate props in retrospective post (aider assisted) #1973
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
larkox
reviewed
Dec 18, 2024
Comment on lines
36
to
37
| const metricsConfigs: Array<Metric> = props.post.props?.metricsConfigs ? JSON.parse(props.post.props.metricsConfigs) : []; | ||
| const metricsData: Array<RunMetricData> = props.post.props?.metricsData ? JSON.parse(props.post.props.metricsData) : []; |
There was a problem hiding this comment.
This validation is probably not enough. The following inputs should break this:
- A non JSON parseable string value like
"{" - A non string value like
{} - A non list JSON string like =
"{}"
If we want to be 100% safe, we would need to add some try catch (or create a "safeJSONParse" function that does the try catch for us), and some type guard.
const parsedMetricsConfig = safeJSONParse(props.post.props?.metricsConfigs);
const parsedMetricsData = safeJSONParse(props.post.props?.metricsData);
const metricsConfigs = isArrayOf(parsedMetricsConfig, isMetric) ? parsedMetricsConfig : [];
const metricsData = isArrayOf(parsedMetricsData, isMetricsData) ? parsedMetricsData : [];
larkox
approved these changes
Dec 19, 2024
| @@ -132,3 +132,40 @@ export function runCallsSlashCommand(command: string, channelId: string, teamId: | |||
| }, | |||
| }, window.origin); | |||
| } | |||
|
|
|||
| export function safeJSONParse<T>(value: unknown): T | null { | |||
There was a problem hiding this comment.
Nitpick: I like the semantics of undefined better than null, but it is just about taste.
| @@ -132,3 +132,40 @@ export function runCallsSlashCommand(command: string, channelId: string, teamId: | |||
| }, | |||
| }, window.origin); | |||
| } | |||
|
|
|||
| export function safeJSONParse<T>(value: unknown): T | null { | |||
| if (!value || typeof value !== 'string') { | |||
There was a problem hiding this comment.
I think this would be enough:
Suggested change
| if (!value || typeof value !== 'string') { | |
| if (typeof value !== 'string') { |
We can let the case of empty string being handled by JSON.parse.
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.
Summary
Validate props in the retrospective post
Ticket Link
https://mattermost.atlassian.net/browse/MM-61164
Checklist
[ ] Telemetry updated[ ] Gated by experimental feature flag[ ] Unit tests updated