[TS migration] Migrate 'ReportActionItemImage' component to TypeScript #34605
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
blazejkustra
suggested changes
Jan 17, 2024
| @@ -19,6 +19,7 @@ const ORIGIN_PATTERN = new RegExp(`^(${ORIGINS_TO_REPLACE.join('|')})`); | |||
| */ | |||
| function tryResolveUrlFromApiRoot(url: string): string; | |||
| function tryResolveUrlFromApiRoot(url: number): number; | |||
| function tryResolveUrlFromApiRoot(url: string | number): string | number; | |||
There was a problem hiding this comment.
This shouldn't be necessary 🤔 This is already defined under:
function tryResolveUrlFromApiRoot(url: string | number): string | number {There was a problem hiding this comment.
Do you have a better solution to
The call would have succeeded against this implementation, but implementation signatures of overloads are not externally visible.
remove it and you will see it in ReportActionItemImage.tsx looks like implementation signatures are not visible externally
There was a problem hiding this comment.
I think this is our best bet:
/**
* When possible this function resolve URLs relative to API ROOT
* - Absolute URLs like `/{path}`, become: `https://{API_ROOT}/{path}`
* - Similarly for prod or staging URLs we replace the `https://www.expensify`
* or `https://staging.expensify` part, with `https://{API_ROOT}`
* - Unmatched URLs (non expensify) are returned with no modifications
*/
function tryResolveUrlFromApiRoot(url: string | number): string | number {
// in native, when we import an image asset, it will have a number representation which can be used in `source` of Image
// in this case we can skip the url resolving
if (typeof url === 'number') {
return url;
}
const apiRoot = ApiUtils.getApiRoot({shouldUseSecure: false} as Request);
return url.replace(ORIGIN_PATTERN, apiRoot);
}There was a problem hiding this comment.
You suggesting removing the overload signatures?? I mean there is an advantage to the overloads as it will enforce number return when the argument type is number and same for string too
There was a problem hiding this comment.
What is the point of overloading if you need to add this? 😅
function tryResolveUrlFromApiRoot(url: string | number): string | number;There was a problem hiding this comment.
When the parameter is number we will know that the return will be number (same for string) but when it is string | number we will have string | number return type that's the point! 👍
There was a problem hiding this comment.
Thank you for explanation, I thought it worked a bit differently 👍
Reviewer Checklist
Screenshots/VideosAndroid: NativereportActionImageAndroidNative.movAndroid: mWeb ChromereportActionImageAndroidChrome-compressed.mp4iOS: NativereportActionImageiOSNative.mp4iOS: mWeb SafarireportActionImageiOSSafari.mp4MacOS: Chrome / SafarireportActionImageChrome.mp4MacOS: DesktopreportActionImageDesktop.mp4 |
cristipaval
approved these changes
Jan 19, 2024
|
✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release. |
17 tasks
|
🚀 Deployed to staging by https://github.com/cristipaval in version: 1.4.29-0 🚀
|
|
🚀 Deployed to staging by https://github.com/cristipaval in version: 1.4.29-0 🚀
|
|
🚀 Deployed to production by https://github.com/thienlnam in version: 1.4.29-1 🚀
|
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.
Details
once #25130 is merged we should remove the typescript suppress comment
Fixed Issues
$ #31969
PROPOSAL:
Tests
Offline tests
same
QA Steps
same
PR Author Checklist
### Fixed Issuessection aboveTestssectionOffline stepssectionQA stepssectiontoggleReportand notonIconClick)myBool && <MyComponent />.src/languages/*files and using the translation methodWaiting for Copylabel for a copy review on the original GH to get the correct copy.STYLE.md) were followedAvatar, I verified the components usingAvatarare working as expected)StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG))Avataris modified, I verified thatAvataris working as expected in all cases)Designlabel so the design team can review the changes.ScrollViewcomponent to make it scrollable when more elements are added to the page.mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps.Screenshots/Videos
Android: Native
Android: mWeb Chrome
andr.web.mp4
iOS: Native
ios.native.mp4
iOS: mWeb Safari
ios.web.mp4
MacOS: Chrome / Safari
web.mp4
MacOS: Desktop
des.mp4