Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Link Previews #17288

Merged
merged 27 commits into from
Jun 13, 2023
Merged

Link Previews #17288

merged 27 commits into from
Jun 13, 2023

Conversation

wojtus7
Copy link
Contributor

@wojtus7 wojtus7 commented Apr 11, 2023

Details

Added link preview in messages that contain links.
Up to three link previews are visible for single message but it can be changed using one variable.
If multiple the same links are provided only one preview will be displayed.

Fixed Issues

Part of #15001

Added based on:
https://docs.google.com/document/d/1317yQGmDgDnjwfoLybqNb5qVUU_jkhI2Bs3X9PQFcG4/edit#heading=h.fcvmbish8sz6

Tests

  1. Send a message containing a link or multiple links
  2. See if the preview will show on your device as well as on other devices
  • Verify that no errors appear in the JS console

Offline steps

If cached earlier downloaded previews will show as usual, if there is no cache nothing will download so nothing should show up if there is no network connection.

QA Steps

  1. Send a message containing a link or multiple links
  2. See if the preview will show on your device as well as on other devices
  • Verify that no errors appear in the JS console

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover 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 tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android / native
    • Android / Chrome
    • iOS / native
    • iOS / Safari
    • MacOS / Chrome / Safari
    • MacOS / Desktop
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (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 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
      • If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • 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 correct English and 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 followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • 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
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • 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(themeColors.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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web image
Mobile Web - Chrome

IMG_8084
IMG_8085

Mobile Web - Safari

IMG_8082
IMG_8083

Desktop image
iOS
Screen.Recording.2023-04-11.at.13.42.20.mov
Android

Screenshot 2023-04-12 at 01 48 19

@wojtus7 wojtus7 requested a review from a team as a code owner April 11, 2023 19:56
@github-actions
Copy link
Contributor

github-actions bot commented Apr 11, 2023

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

@melvin-bot melvin-bot bot requested review from AndrewGable and removed request for a team April 11, 2023 19:56
@MelvinBot
Copy link

@AndrewGable 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]

@AndrewGable
Copy link
Contributor

Wow this is awesome! 😍

@marcaaron marcaaron self-requested a review April 11, 2023 20:12
Copy link
Contributor

@marcaaron marcaaron left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks nice! Adding some more details about the next approach.

src/pages/home/report/ReportLinkPreview.js Outdated Show resolved Hide resolved
package.json Outdated Show resolved Hide resolved
src/pages/home/report/ReportActionItem.js Outdated Show resolved Hide resolved
@marcaaron
Copy link
Contributor

cc @thienlnam

@wojtus7 wojtus7 requested a review from marcaaron April 21, 2023 13:35
Copy link
Contributor

@marcaaron marcaaron left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great and thanks for the work on this! I had a few small style notes and a comment about the limiting of previews (not sure if we need to do it yet).

src/libs/actions/Report.js Outdated Show resolved Hide resolved
src/pages/home/report/LinkPreviewer.js Outdated Show resolved Hide resolved
src/pages/home/report/ReportActionItem.js Outdated Show resolved Hide resolved
src/pages/home/report/ReportActionItem.js Outdated Show resolved Hide resolved
src/pages/home/report/LinkPreviewer.js Outdated Show resolved Hide resolved
src/styles/styles.js Outdated Show resolved Hide resolved
@marcaaron
Copy link
Contributor

@wojtus7 Please let me know if I can explain anything else or help move things along 🙇

Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking good, I will ask for some C+ for testing but I have noticed we should multiple of the link previews which is not intended, is it?

I see your comment I misread that was for same links. Where do we add the limit for 3 link previews in the code?

src/libs/ReportActionsUtils.js Outdated Show resolved Hide resolved
src/libs/actions/Report.js Outdated Show resolved Hide resolved
}

Report.expandURLPreview(props.report.reportID, props.action.reportActionID);
}, [])
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Linter warning here

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see url expands only on component mount. Is it already planned to refresh preview on edit?

Screen.Recording.2023-05-25.at.3.31.31.PM.mov

@mountiny mountiny requested a review from 0xmiros May 25, 2023 09:59
@rushatgabhane
Copy link
Member

Do they also work when you insert a markdown link?

text

Copy link
Contributor

@0xmiros 0xmiros left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@wojtus7 author checklist is outdated. please pull from latest main.

Please check and fix this everywhere.

- [x] I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. `myBool && <MyComponent />`.

src/libs/ReportActionsUtils.js Outdated Show resolved Hide resolved
}

Report.expandURLPreview(props.report.reportID, props.action.reportActionID);
}, [])
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see url expands only on component mount. Is it already planned to refresh preview on edit?

Screen.Recording.2023-05-25.at.3.31.31.PM.mov

src/pages/home/report/ReportActionItem.js Outdated Show resolved Hide resolved
src/styles/styles.js Outdated Show resolved Hide resolved
src/pages/home/report/LinkPreviewer.js Show resolved Hide resolved
src/pages/home/report/LinkPreviewer.js Outdated Show resolved Hide resolved
@0xmiros
Copy link
Contributor

0xmiros commented May 25, 2023

Do they also work when you insert a markdown link?

@rushatgabhane yes works

Screen.Recording.2023-05-25.at.3.43.15.PM.mov

@rushatgabhane
Copy link
Member

really cool feature btw!

@mountiny
Copy link
Contributor

@wojtus7 have you posted the CLA comment?

@0xmiros
Copy link
Contributor

0xmiros commented May 25, 2023

@wojtus7 have you posted the CLA comment?

@wojtus7 I also noticed all commits are not signed.

@wojtus7
Copy link
Contributor Author

wojtus7 commented May 26, 2023

I have read the CLA Document and I hereby sign the CLA

@mountiny mountiny requested a review from 0xmiros June 12, 2023 12:33
Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

couple of NABs

@0xmiroslav can you please give this one another go, seems like we are close

src/libs/ReportActionsUtils.js Outdated Show resolved Hide resolved
src/libs/actions/Report.js Outdated Show resolved Hide resolved
src/pages/home/report/LinkPreviewer.js Outdated Show resolved Hide resolved
wojtus7 and others added 4 commits June 12, 2023 16:24
Co-authored-by: Vit Horacek <36083550+mountiny@users.noreply.github.com>
Co-authored-by: Vit Horacek <36083550+mountiny@users.noreply.github.com>
@0xmiros
Copy link
Contributor

0xmiros commented Jun 12, 2023

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 / Chrome
    • iOS / native
    • iOS / 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(themeColors.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 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

Web
web.mov
Mobile Web - Chrome
mchrome.mov
Mobile Web - Safari
msafari.mov
Desktop
desktop.mov
iOS
ios.mov
Android
android.mov

Copy link
Contributor

@marcaaron marcaaron left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@marcaaron marcaaron merged commit b2d9980 into Expensify:main Jun 13, 2023
@OSBotify
Copy link
Contributor

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

@youssef-lr
Copy link
Contributor

Possible regression, HTML URL is displayed in the LHN:

Screenshot 2023-06-14 at 13 20 33

@0xmiros
Copy link
Contributor

0xmiros commented Jun 14, 2023

Possible regression, HTML URL is displayed in the LHN:

Screenshot 2023-06-14 at 13 20 33

I don't think it's related to this PR. That was happening some days ago (before this PR merged) but now I am not able to reproduce.
@youssef-lr if you can reproduce constantly, can you please re-test after reverting this PR locally?

@mountiny
Copy link
Contributor

I am not sure the changes here dont really touch that. Might be still worth trying revert locally

@0xmiros
Copy link
Contributor

0xmiros commented Jun 14, 2023

bug.mov

On latest main, I noticed new link message is auto-flagged every time.
This didn't happen on this branch but after merging main.
@wojtus7 can you please check?

@youssef-lr
Copy link
Contributor

Sorry folks for the scare, looks like this was fixed in the backend and I had checked out a different branch before and completely forgot.

@0xmiros
Copy link
Contributor

0xmiros commented Jun 14, 2023

@wojtus7 nvm, please ignore #17288 (comment). We confirmed it's backend issue and already happens on production.

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/marcaaron in version: 1.3.28-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/AndrewGable in version: 1.3.28-5 🚀

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

const regex = /<a\s+(?:[^>]*?\s+)?href="([^"]*)"/gi;

if (!htmlContent) {
return;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

BTW this caused a bug which I fixed here https://github.com/Expensify/App/pull/21369/files

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for catching it 🙇

@@ -328,6 +340,11 @@ function ReportActionItem(props) {
return (
<>
{children}
{!_.isEmpty(props.action.linkMetadata) && (
<View style={props.draftMessage ? styles.chatItemReactionsDraftRight : {}}>
<LinkPreviewer linkMetadata={_.filter(props.action.linkMetadata, (item) => !_.isEmpty(item))} />
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👋 This has caused a regression in #21195
We shouldn't show link preview if message was flagged as inappropriate, this was resolved by hiding LinkPreview if isHidden=true

@eVoloshchak
Copy link
Contributor

👋 Coming from #22888,
Kind of an edge case, if you 'reply in thread' to a message with link preview and then delete that message, the link preview was still visible
This was resolved by clearing linkMetadata in optimisticReportActions when deleteReportComment is called

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.