fix: cache extra attributes for video markdown conversion #42463

dominictb · 2024-05-22T09:44:50Z

Details

New expensify-common version -> Support video tag conversion
Support cache the extra attributes from video so the user cannot edit it.

Fixed Issues

$ #41952
PROPOSAL: #41952 (comment)

Tests

To test, please use this branch of expensify-common: Expensify/expensify-common#703

Start editing any comment with video
Edit the markdown in the composer (try not to edit the markdown section containing video data)
Verify that the video still shows normally after editing

Offline tests

QA Steps

Start editing any comment with video
Edit the markdown in the composer (try not to edit the markdown section containing video data)
Verify that the video still shows normally after editing

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

android1.mp4

Android: mWeb Chrome

android.mp4

iOS: Native

Uploading ios8.mp4…

iOS: mWeb Safari

iosweb.mp4

MacOS: Chrome / Safari

web8.mp4

MacOS: Desktop

Screen.Recording.2024-06-12.at.00.07.27.mov

dominictb · 2024-06-06T10:41:37Z

Note: This PR will needed to be reviewed and merged first: Expensify/expensify-common#703

melvin-bot · 2024-06-06T10:41:46Z

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

deetergp · 2024-06-06T21:11:17Z

I left a comment on Expensify/expensify-common#703 that @DylanDylann should review that one too since it's tightly coupled with this one. Please let me know if that isn't possible or is unreasonable. Thanks!

DylanDylann · 2024-06-11T09:14:03Z

@dominictb Please fill out the desktop video and resolve conflict + typescript error. Thanks

dominictb · 2024-06-11T11:04:27Z

@DylanDylann typescript issue is due to the expensify-common package not updated. Please review the PR on expensify-common first.

dominictb · 2024-06-11T17:10:34Z

@DylanDylann all good now (Desktop video added). You have to test along side with expensify-common change. The TS error will be automatically fixed once the lib PR is merged.

dominictb · 2024-06-13T01:23:22Z

@DylanDylann can you start reviewing? Thanks!

DylanDylann · 2024-06-13T02:51:54Z

Whoops, I am reviewing. It could take me a couple of days to review this PR

DylanDylann · 2024-06-13T10:53:37Z

src/pages/home/report/ReportActionItemMessageEdit.tsx

+        const videoAttributesCache: Record<string, string> = {};
+        const originalMessage = parser.htmlToMarkdown(action.message?.[0]?.html ?? '', {
+            cacheVideoAttributes: (videoSource, attrs) => {
+                videoAttributesCache[videoSource] = attrs;


@dominictb Hi, Why don't we directly set attrs to draftMessageVideoAttributeCache? With this, we can move the clear function to above

DylanDylann

Thanks for your quick update. Everything else looks good. Testing now

src/libs/actions/Report.ts

DylanDylann · 2024-06-13T12:01:45Z

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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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 the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
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

Screen.Recording.2024-06-19.at.12.01.33.mov

Android: mWeb Chrome

Screen.Recording.2024-06-19.at.11.47.55.mov

iOS: Native

Screen.Recording.2024-06-19.at.11.55.29.mov

iOS: mWeb Safari

Screen.Recording.2024-06-19.at.11.47.11.mov

MacOS: Chrome / Safari

Screen.Recording.2024-06-19.at.11.36.26.mov

MacOS: Desktop

Screen.Recording.2024-06-19.at.11.42.21.mov

DylanDylann · 2024-06-13T12:03:10Z

@dominictb whoops, we have a minor lint error. Let's address it, too

DylanDylann · 2024-06-13T12:14:54Z

@tgolen @dominictb I wonder if the user tries to edit the video source. What should happen? Currently, if users try to edit the video source, the App displays the infinity load, they still can download this video but can't open

Screen.Recording.2024-06-13.at.19.13.55.mov

tgolen · 2024-06-13T13:17:53Z

I think we should just do whatever GitHub does (which I assume is just allowing people to break it).

DylanDylann · 2024-06-14T07:37:57Z

I think we should just do whatever GitHub does (which I assume is just allowing people to break it).

I see that GH only converts to video tag if the source is valid. If users try to break the source by editing it, GH will not convert the markdown to video tag.

It maybe require support from BE to validate the video source. @dominictb Do you have any suggestions for this?

dominictb · 2024-06-14T08:44:15Z

I see that GH only converts to
It maybe require support from BE to validate the video source

I would suggest @tgolen to bring this to the internal team for issue triage.

tgolen · 2024-06-14T16:09:09Z

OK, I can bring this up internally to get some thoughts on it, but let's not let that hold up this PR. I think we can handle what to do about broken video links in a separate issue.

tgolen · 2024-06-14T16:16:31Z

I brought this up in Slack (but it's an internal channel, so you won't have access). I'm just keeping a paper-trail going.

dominictb · 2024-06-18T01:30:37Z

@DylanDylann @tgolen this is ready for review!

tgolen

Following up from the previous discussion about what to do if users break the URLs, we've agreed internally to ignore that edge case for now and if a user breaks a URL, it's on them.

DylanDylann

LGTM 🚀

OSBotify · 2024-06-19T13:53:17Z

✋ 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 · 2024-06-19T21:52:04Z

🚀 Deployed to staging by https://github.com/tgolen in version: 1.4.86-0 🚀

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

OSBotify · 2024-06-19T22:16:46Z

🚀 Deployed to staging by https://github.com/tgolen in version: 1.4.86-0 🚀

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

OSBotify · 2024-06-19T22:50:45Z

🚀 Deployed to staging by https://github.com/tgolen in version: 1.4.86-0 🚀

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

OSBotify · 2024-06-21T21:21:23Z

🚀 Deployed to production by https://github.com/AndrewGable in version: 9.0.0-9 🚀

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

dominictb added 2 commits May 22, 2024 16:40

fix: cache extra attributes for video markdown conversion

8a27923

Merge remote-tracking branch 'origin/main' into fix/41952

c7083fd

dominictb marked this pull request as ready for review June 6, 2024 10:41

dominictb requested a review from a team as a code owner June 6, 2024 10:41

melvin-bot bot removed the request for review from a team June 6, 2024 10:41

melvin-bot bot requested a review from DylanDylann June 6, 2024 10:41

deetergp mentioned this pull request Jun 6, 2024

fix: add rules for video conversion Expensify/expensify-common#703

Merged

Merge remote-tracking branch 'origin/main' into fix/41952

49933f2

DylanDylann reviewed Jun 13, 2024

View reviewed changes

fix: set the cache directly

5153b95

dominictb requested a review from DylanDylann June 13, 2024 11:20

DylanDylann reviewed Jun 13, 2024

View reviewed changes

src/libs/actions/Report.ts Show resolved Hide resolved

Merge remote-tracking branch 'origin/main' into fix/41952

e355bcc

Merge remote-tracking branch 'origin/main' into fix/41952

d1fc0b3

chore: update expensify-common 2.0.17

a2cfd54

dominictb requested a review from DylanDylann June 18, 2024 01:29

tgolen approved these changes Jun 18, 2024

View reviewed changes

DylanDylann approved these changes Jun 19, 2024

View reviewed changes

melvin-bot bot requested a review from tgolen June 19, 2024 05:08

tgolen merged commit 768da63 into Expensify:main Jun 19, 2024
17 of 18 checks passed

github-actions bot mentioned this pull request Jun 19, 2024

Deploy Checklist: New Expensify 2024-06-19 #44047

Closed

59 tasks

lanitochka17 mentioned this pull request Jun 20, 2024

[$250] Chat - No "Edit" option on comment with video attachment #44098

Closed

6 tasks

ishpaul777 mentioned this pull request Jun 20, 2024

Revert "fix: cache extra attributes for video markdown conversion" #44101

Closed

dominictb mentioned this pull request Jun 21, 2024

[HOLD for payment 2024-06-28] [$500] HIGH: [Polish] Editing a comment with a video removes the video #41952

Closed

dominictb deleted the fix/41952 branch July 18, 2024 02:48

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: cache extra attributes for video markdown conversion #42463

fix: cache extra attributes for video markdown conversion #42463

dominictb commented May 22, 2024 •

edited

Loading

dominictb commented Jun 6, 2024

melvin-bot bot commented Jun 6, 2024

deetergp commented Jun 6, 2024

DylanDylann commented Jun 11, 2024

dominictb commented Jun 11, 2024

dominictb commented Jun 11, 2024

dominictb commented Jun 13, 2024

DylanDylann commented Jun 13, 2024

DylanDylann Jun 13, 2024

DylanDylann left a comment

DylanDylann commented Jun 13, 2024 •

edited

Loading

DylanDylann commented Jun 13, 2024

DylanDylann commented Jun 13, 2024

tgolen commented Jun 13, 2024

DylanDylann commented Jun 14, 2024 •

edited

Loading

dominictb commented Jun 14, 2024

tgolen commented Jun 14, 2024

tgolen commented Jun 14, 2024

dominictb commented Jun 18, 2024

tgolen left a comment

DylanDylann left a comment

OSBotify commented Jun 19, 2024

OSBotify commented Jun 19, 2024

OSBotify commented Jun 19, 2024

OSBotify commented Jun 19, 2024

OSBotify commented Jun 21, 2024

fix: cache extra attributes for video markdown conversion #42463

fix: cache extra attributes for video markdown conversion #42463

Conversation

dominictb commented May 22, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

dominictb commented Jun 6, 2024

melvin-bot bot commented Jun 6, 2024

deetergp commented Jun 6, 2024

DylanDylann commented Jun 11, 2024

dominictb commented Jun 11, 2024

dominictb commented Jun 11, 2024

dominictb commented Jun 13, 2024

DylanDylann commented Jun 13, 2024

DylanDylann Jun 13, 2024

Choose a reason for hiding this comment

DylanDylann left a comment

Choose a reason for hiding this comment

DylanDylann commented Jun 13, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

DylanDylann commented Jun 13, 2024

DylanDylann commented Jun 13, 2024

tgolen commented Jun 13, 2024

DylanDylann commented Jun 14, 2024 • edited Loading

dominictb commented Jun 14, 2024

tgolen commented Jun 14, 2024

tgolen commented Jun 14, 2024

dominictb commented Jun 18, 2024

tgolen left a comment

Choose a reason for hiding this comment

DylanDylann left a comment

Choose a reason for hiding this comment

OSBotify commented Jun 19, 2024

OSBotify commented Jun 19, 2024

OSBotify commented Jun 19, 2024

OSBotify commented Jun 19, 2024

OSBotify commented Jun 21, 2024

dominictb commented May 22, 2024 •

edited

Loading

DylanDylann commented Jun 13, 2024 •

edited

Loading

DylanDylann commented Jun 14, 2024 •

edited

Loading