[NO QA] [TS migration] Migrate LinkPreviewer component to TypeScript #32822

SzymczakJ · 2023-12-11T15:54:08Z

Details

Migration of 'LinkPreviewer' to Typescript. This cannot be tested by QA because link preview permission is globally set to false. If you want to test it, set Permissions.canUseLinkPreview() to return True and send links in chat.

Fixed Issues

$ #31948
PROPOSAL: N/A

Tests

Verify that link previews function properly in chat(to allow showing LinkPreviews you have to edit Permissions file and set canUseLinkPreview to return true).
Test main flows of the app(sending messages, logging, requesting money)

Offline tests

N/A

QA Steps

N/A This issue cannot be currently tested without hacking the Permissions in app. At this moment link previews permission is set to false. I've set this to true in code and made sure the LinkPreview works as expected, but someone that cannot change the codebase won't be able to test this.

PR Author Checklist

Screenshots/Videos

Android: Native

android.mov

Android: mWeb Chrome

androidweb.mov

iOS: Native

ios.mov

iOS: mWeb Safari

iosweb.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

src/pages/home/report/LinkPreviewer.tsx

src/pages/home/report/LinkPreviewer.js

blazejkustra

LGTM!

kubabutkiewicz · 2023-12-14T13:34:22Z

src/pages/home/report/LinkPreviewer.tsx

+    const theme = useTheme();
+    const styles = useThemeStyles();
+    const StyleUtils = useStyleUtils();
+    const uniqueLinks = linkMetadata.filter((link, index, self) => self.findIndex((t) => t.url === link.url) === index);


minor but maybe you can change t variable name to something more meaningful?

kubabutkiewicz · 2023-12-14T13:36:06Z

@SzymczakJ please resolve conflicts and I think you should remove [No QA] prefix from PR title

melvin-bot · 2023-12-15T10:38:25Z

@shubham1206agra Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

shubham1206agra · 2023-12-17T12:53:24Z

src/pages/home/report/LinkPreviewer.tsx

+    const theme = useTheme();
+    const styles = useThemeStyles();
+    const StyleUtils = useStyleUtils();
+    const uniqueLinks = linkMetadata.filter((link, index) => linkMetadata.findIndex(({url}) => url === link.url) === index);


This is a slower implementation of uniqBy function.

Maybe use this

const uniqBy = (arr: any[], predicate: (item: any) => string) => { const cb = typeof predicate === 'function' ? predicate : (o) => o[predicate]; const result = []; const map = new Map(); arr.forEach((item) => { const key = (item === null || item === undefined) ? item : cb(item); if (!map.has(key)) { map.set(key, item); result.push(item); } }); return result; };

Indeed this is a better and faster implementation. But do we need something like this? linkMetadata is in 99.9% of times, a really small array(1 - 3 elements) and this optimization is not giving us that much(also _.uniqBy function is used only once in our codebase, so we won't be able to reuse it). That being said, can we keep the current implementation, as it seems to me that it's a little easier to understand?

I agree that most of the cases won't have problem with the current implementation. But lets keep the optimised implementation as current implementation may introduce extra latencies, which we don't want

changed filter to better implementation. How do you like it?

@shubham1206agra seems like you forgot to press approve 😅

Oh I just need to test this once. I will approve this today.

shubham1206agra · 2023-12-20T13:31:47Z

Can you merge main here?

SzymczakJ · 2023-12-20T13:51:48Z

@shubham1206agra merged main

shubham1206agra · 2023-12-20T14:14:43Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

Screen.Recording.2023-12-20.at.7.58.42.PM.mov

iOS: mWeb Safari

Screen.Recording.2023-12-20.at.7.38.53.PM.mov

MacOS: Chrome / Safari

Screen.Recording.2023-12-20.at.7.36.31.PM.mov

MacOS: Desktop

Screen.Recording.2023-12-20.at.7.50.06.PM.mov

melvin-bot · 2023-12-20T14:30:37Z

We did not find an internal engineer to review this PR, trying to assign a random engineer to #31948 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

shubham1206agra · 2023-12-20T14:33:22Z

@bondydaa Looks like this PR needs your approval

OSBotify · 2023-12-20T18:32:51Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

OSBotify · 2023-12-21T05:30:56Z

🚀 Deployed to staging by https://github.com/bondydaa in version: 1.4.15-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

OSBotify · 2023-12-22T05:19:39Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.4.15-5 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	failure ❌
🕸 web 🕸	success ✅

migrate LinkPreviewer to typescript

103821b

blazejkustra suggested changes Dec 11, 2023

View reviewed changes

src/pages/home/report/LinkPreviewer.tsx Outdated Show resolved Hide resolved

src/pages/home/report/LinkPreviewer.tsx Outdated Show resolved Hide resolved

src/pages/home/report/LinkPreviewer.js Show resolved Hide resolved

SzymczakJ added 3 commits December 13, 2023 10:15

fix PR comments

20463d1

Merge branch 'main' into @szymczak/31948

a94831b

fix typescript errors

5547279

blazejkustra approved these changes Dec 13, 2023

View reviewed changes

SzymczakJ changed the title ~~[TS migration, NO QA] Migrate LinkPreviewer component to TypeScript~~ [NO QA] [TS migration] Migrate LinkPreviewer component to TypeScript Dec 13, 2023

kubabutkiewicz reviewed Dec 14, 2023

View reviewed changes

SzymczakJ added 2 commits December 14, 2023 15:14

fix PR comments

ed74e29

Merge branch 'main' into @szymczak/31948

66393c5

kubabutkiewicz approved these changes Dec 14, 2023

View reviewed changes

SzymczakJ marked this pull request as ready for review December 15, 2023 10:38

SzymczakJ requested a review from a team as a code owner December 15, 2023 10:38

melvin-bot bot requested review from shubham1206agra and removed request for a team December 15, 2023 10:38

shubham1206agra reviewed Dec 17, 2023

View reviewed changes

SzymczakJ added 2 commits December 18, 2023 12:54

fix comments

23a9a01

fix naming

84a862b

SzymczakJ requested a review from shubham1206agra December 18, 2023 11:57

Merge branch 'main' into @szymczak/31948

28cd4fc

shubham1206agra approved these changes Dec 20, 2023

View reviewed changes

bondydaa approved these changes Dec 20, 2023

View reviewed changes

bondydaa merged commit e76c75d into Expensify:main Dec 20, 2023
16 checks passed

github-actions bot mentioned this pull request Dec 21, 2023

Deploy Checklist: New Expensify 2023-12-21 #33391

Closed

51 tasks

melvin-bot bot mentioned this pull request Dec 22, 2023

[HOLD for payment 2023-12-29] [TS migration] Migrate 'LinkPreviewer.js' component to TypeScript #31948

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[NO QA] [TS migration] Migrate LinkPreviewer component to TypeScript #32822

[NO QA] [TS migration] Migrate LinkPreviewer component to TypeScript #32822

SzymczakJ commented Dec 11, 2023 •

edited

Loading

blazejkustra left a comment

kubabutkiewicz Dec 14, 2023

kubabutkiewicz commented Dec 14, 2023

melvin-bot bot commented Dec 15, 2023

shubham1206agra Dec 17, 2023

SzymczakJ Dec 18, 2023

shubham1206agra Dec 18, 2023

SzymczakJ Dec 18, 2023

SzymczakJ Dec 20, 2023

shubham1206agra Dec 20, 2023

shubham1206agra commented Dec 20, 2023

SzymczakJ commented Dec 20, 2023

shubham1206agra commented Dec 20, 2023 •

edited

Loading

melvin-bot bot commented Dec 20, 2023

shubham1206agra commented Dec 20, 2023

OSBotify commented Dec 20, 2023

OSBotify commented Dec 21, 2023

OSBotify commented Dec 22, 2023

[NO QA] [TS migration] Migrate LinkPreviewer component to TypeScript #32822

[NO QA] [TS migration] Migrate LinkPreviewer component to TypeScript #32822

Conversation

SzymczakJ commented Dec 11, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

blazejkustra left a comment

Choose a reason for hiding this comment

kubabutkiewicz Dec 14, 2023

Choose a reason for hiding this comment

kubabutkiewicz commented Dec 14, 2023

melvin-bot bot commented Dec 15, 2023

shubham1206agra Dec 17, 2023

Choose a reason for hiding this comment

SzymczakJ Dec 18, 2023

Choose a reason for hiding this comment

shubham1206agra Dec 18, 2023

Choose a reason for hiding this comment

SzymczakJ Dec 18, 2023

Choose a reason for hiding this comment

SzymczakJ Dec 20, 2023

Choose a reason for hiding this comment

shubham1206agra Dec 20, 2023

Choose a reason for hiding this comment

shubham1206agra commented Dec 20, 2023

SzymczakJ commented Dec 20, 2023

shubham1206agra commented Dec 20, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

melvin-bot bot commented Dec 20, 2023

shubham1206agra commented Dec 20, 2023

OSBotify commented Dec 20, 2023

OSBotify commented Dec 21, 2023

OSBotify commented Dec 22, 2023

SzymczakJ commented Dec 11, 2023 •

edited

Loading

shubham1206agra commented Dec 20, 2023 •

edited

Loading