Add guards for types needed for prop types by mobile #44
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
streamer45
reviewed
Nov 8, 2024
| return false; | ||
| } | ||
|
|
||
| if (metadata.tr_id !== undefined && typeof metadata.tr_id !== 'string') { |
There was a problem hiding this comment.
Is the undefined check necessary?
There was a problem hiding this comment.
The reason to use undefined is because tr_id is optional. So what we are doing here is saying...
- Is there a value on
tr_id? (tr_id !== undefined) - If so, is the value a string? (
typeof tr_id === 'string')
If we don't check for undefined, we have the following things that may happen:
- Only check
typeof tr_id === 'string'- An object that doesn't have defined
tr_idwon't pass the check
- An object that doesn't have defined
tr_id && typeof tr_id === 'string'- An object that
tr_idis a 0, a null or any other falsy value would be considered valid. This probably have no implications, since you usually check whether it is defined by checking whether the value is truthy or falsy, but this direction is more correct.
- An object that
There was a problem hiding this comment.
Thanks. Could we add exceptions to make the linter happy?
| return false; | ||
| } | ||
|
|
||
| if (metadata.rec_id !== undefined && typeof metadata.rec_id !== 'string') { |
cpoile
previously approved these changes
Nov 8, 2024
| @@ -259,6 +259,28 @@ export type Caption = { | |||
| file_id: string; | |||
| }; | |||
|
|
|||
| export function isCaption(obj: unknown): obj is Caption { | |||
| if (typeof obj !== 'object' || obj === null) { | |||
Not AFAIK, but for what is worth, after doing a few for the webapp by hand, I discovered that our MM copilot does a great job with these 😅 |
|
@larkox May need to rebuild and push (hopefully it's enough). |
streamer45
previously approved these changes
Nov 12, 2024
larkox
added
the
3: Reviews Complete
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
For prop validation, we need guards for several types. This PR add those guards.
Ticket Link
NONE