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

fix: Video - Invalid file is downloaded when downloading video. #37163

Merged
merged 7 commits into from
Feb 26, 2024

Conversation

Krishna2323
Copy link
Contributor

@Krishna2323 Krishna2323 commented Feb 23, 2024

Details

Fixed Issues

$ #37092
PROPOSAL: #37092 (comment)

Tests

  1. Go to any chat
  2. Send a video
  3. Right click on the video > Download & verify video is downloaded
  4. Click on the expand button in the video preview and click download icon in the attachment model , verify video is downloaded
  5. Click the three dots in the video controller and select download, verify video is downloaded
  • Verify that no errors appear in the JS console

Offline tests

  1. Go to any chat
  2. Send a video
  3. Right click on the video > Download & verify video is downloaded
  4. Click on the expand button in the video preview and click download icon in the attachment model , verify video is downloaded
  5. Click the three dots in the video controller and select download, verify video is downloaded

QA Steps

  1. Go to any chat
  2. Send a video
  3. Right click on the video > Download & verify video is downloaded
  4. Click on the expand button in the video preview and click download icon in the attachment model , verify video is downloaded
  5. Click the three dots in the video controller and select download, verify video is downloaded
  • 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: mWeb Chrome
    • iOS: Native
    • iOS: mWeb 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 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
      • 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 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 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 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 form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label 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.

Screenshots/Videos

Android: Native
android_native_1.mp4
Android: mWeb Chrome
android_chrome.mp4
iOS: Native
ios_native.mp4
iOS: mWeb Safari
ios_safari.mp4
MacOS: Chrome / Safari
web_chrome.mp4
MacOS: Desktop
desktop_app_2.mp4

Signed-off-by: Krishna Gupta <belivethatkg@gmail.com>
@Krishna2323 Krishna2323 requested a review from a team as a code owner February 23, 2024 22:52
@melvin-bot melvin-bot bot requested review from s77rt and removed request for a team February 23, 2024 22:52
Copy link

melvin-bot bot commented Feb 23, 2024

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

Copy link
Contributor

@s77rt s77rt left a comment

Choose a reason for hiding this comment

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

Apply suggestion and revert the rest

src/libs/fileDownload/FileUtils.ts Outdated Show resolved Hide resolved
Signed-off-by: Krishna Gupta <belivethatkg@gmail.com>
@s77rt
Copy link
Contributor

s77rt commented Feb 23, 2024

Please revert the other changes

Signed-off-by: Krishna Gupta <belivethatkg@gmail.com>
@Krishna2323
Copy link
Contributor Author

@s77rt, do you have any clue about this error? Why does it happen when downloading from popover menu? When we download from message context menu the request is sent to https://www.expensify.com, but when downloading from video popover menu it sends request to https://dev.new.expensify.com:8082. It only happens on desktop app.

bug_url.mp4

@s77rt
Copy link
Contributor

s77rt commented Feb 24, 2024

I'm not sure I can reproduce that bug. Can you please look into the native bug as well? On native it seems that status.url is different than that of web and this makes getPathFromURL crashes

const sourceURI = `/${Url.getPathFromURL(status.uri)}`;

Copy link
Contributor

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖 iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/37163/index.html ❌ FAILED ❌
Android The QR code can't be generated, because the iOS build failed
Desktop 💻 Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/37163/NewExpensify.dmg https://37163.pr-testing.expensify.com
Desktop Web

👀 View the workflow run that generated this build 👀

@Krishna2323
Copy link
Contributor Author

Krishna2323 commented Feb 24, 2024

@s77rt, yes, the bug also exists on native devices as well as the desktop app. After some digging, I found that in the code below, we don't use tryResolveUrlFromApiRoot before passing the url to fileDownload. Passing the URL after using tryResolveUrlFromApiRoot solves the issue on all platforms.

const downloadAttachment = useCallback(() => {
currentVideoPlayerRef.current.getStatusAsync().then((status) => {
const sourceURI = `/${Url.getPathFromURL(status.uri)}`;
fileDownload(sourceURI);
});
}, [currentVideoPlayerRef]);

@s77rt
Copy link
Contributor

s77rt commented Feb 24, 2024

@Krishna2323 On web the download should start on the same tab, using tryResolveUrlFromApiRoot may break that

@Krishna2323
Copy link
Contributor Author

Krishna2323 commented Feb 24, 2024

@s77rt no it won't, we use tryResolveUrlFromApiRoot for all other file urls also. In the code below we use tryResolveUrlFromApiRoot which is used in download option in the comment context menu. I tested on web.

const sourceURL = tryResolveUrlFromApiRoot(html.match(SOURCE_REGEX)?.[1] ?? '');
const imageURL = IS_IMAGE_TAG ? tryResolveUrlFromApiRoot(html.match(PREVIEW_SOURCE_REGEX)?.[1] ?? '') : null;
const previewSourceURL = IS_IMAGE_TAG ? imageURL : sourceURL;
const originalFileName = html.match(ORIGINAL_FILENAME_REGEX)?.[1] ?? null;
// Update the image URL so the images can be accessed depending on the config environment
return {
previewSourceURL,
sourceURL,

Same for video/image attachment modal download option:

if (name === 'video') {
const splittedUrl = attribs[CONST.ATTACHMENT_SOURCE_ATTRIBUTE].split('/');
attachments.unshift({
reportActionID: null,
source: tryResolveUrlFromApiRoot(attribs[CONST.ATTACHMENT_SOURCE_ATTRIBUTE]),

@s77rt
Copy link
Contributor

s77rt commented Feb 24, 2024

@Krishna2323 Please test on all platforms, if it works push the changes

Signed-off-by: Krishna Gupta <belivethatkg@gmail.com>
@Krishna2323
Copy link
Contributor Author

@s77rt, you were right it opens a new tab in web, first when I tried passing /${Url.getPathFromURL(status.uri)} to tryResolveUrlFromApiRoot, it worked for all platforms except android and now when I pass status.uri to tryResolveUrlFromApiRoot it opens new tab on web.

@s77rt
Copy link
Contributor

s77rt commented Feb 24, 2024

The source should be kept relative then. Can you check why status.uri is different on web and native? On native it's already relative and extracting a path from a relative url does not work

@Krishna2323
Copy link
Contributor Author

@s77rt, the source we pass to Video component seems to be consistent everywhere, it seems that getStatusAsync returns relative path in native. WDYT we should do here? should be use a state for the url?

@Krishna2323
Copy link
Contributor Author

I tested using the source directly (setting state in VideoPopoverMenuContextProvider) and it works fine on all platforms.

@s77rt
Copy link
Contributor

s77rt commented Feb 25, 2024

Can you try tryResolveUrlFromApiRoot followed by getPathFromURL. That why we always pass a valid a url.

@Krishna2323
Copy link
Contributor Author

@s77rt, that won't work on native devices because in native devices we need full path instead of just the path.

@s77rt
Copy link
Contributor

s77rt commented Feb 25, 2024

I tested using the source directly (setting state in VideoPopoverMenuContextProvider) and it works fine on all platforms.

Why would that make a difference? On web we still need to use the path only

@Krishna2323
Copy link
Contributor Author

@s77rt, because we already use tryResolveUrlFromApiRoot for sources.

From here we get for attachment download button and we also pass it to video player context menu:

source: tryResolveUrlFromApiRoot(attribs[CONST.ATTACHMENT_SOURCE_ATTRIBUTE]),

And from VideoRenderer (Preview) also:

const sourceURL = tryResolveUrlFromApiRoot(attrHref);

@s77rt
Copy link
Contributor

s77rt commented Feb 25, 2024

I think we can use currentlyPlayingURL from usePlaybackContext hook. On native it have the correct url, on web it's null due to another bug. Let's fix that bug and use that value

Edit: No bug here.

Comment on lines 28 to 33
const downloadAttachment = useCallback(() => {
currentVideoPlayerRef.current.getStatusAsync().then((status) => {
const sourceURI = `/${Url.getPathFromURL(status.uri)}`;
const sourceURI = tryResolveUrlFromApiRoot(status.uri);
fileDownload(sourceURI);
});
}, [currentVideoPlayerRef]);
Copy link
Contributor

Choose a reason for hiding this comment

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

const downloadAttachment = useCallback(() => fileDownload(addEncryptedAuthTokenToURL(currentlyPlayingURL)), [currentlyPlayingURL]);

This should do it. Please test on all platforms

Copy link
Contributor

Choose a reason for hiding this comment

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

Add the auth token only if the url does not start with blob: or file:

Copy link
Contributor

Choose a reason for hiding this comment

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

    const downloadAttachment = useCallback(() => {
        const sourceURI = currentlyPlayingURL.startsWith('blob:') || currentlyPlayingURL.startsWith('file:') ? currentlyPlayingURL : addEncryptedAuthTokenToURL(currentlyPlayingURL);
        fileDownload(sourceURI);
    }, [currentlyPlayingURL]);

@s77rt
Copy link
Contributor

s77rt commented Feb 26, 2024

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 the PR modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label 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
android.mov
Android: mWeb Chrome
mweb-chrome.mov
iOS: Native

I can't download videos on iOS but I think it's related to my simulator or settings as I can't download photos either

iOS: mWeb Safari
mweb-safari.mov
MacOS: Chrome / Safari
web.mov
MacOS: Desktop
desktop.mov

@s77rt
Copy link
Contributor

s77rt commented Feb 26, 2024

@Krishna2323 Once you complete the tests and adding the screenshots / videos, please tag me

Signed-off-by: Krishna Gupta <belivethatkg@gmail.com>
@Krishna2323
Copy link
Contributor Author

@s77rt, I tested on all platforms, works well. Screenshots are also added.

@s77rt
Copy link
Contributor

s77rt commented Feb 26, 2024

@Krishna2323 Please remove step 1 and step 5 from the testing steps, and change step 7 to:

  • Click the three dots in the video controller and select download, verify video is downloaded

@Krishna2323
Copy link
Contributor Author

Done.

@s77rt
Copy link
Contributor

s77rt commented Feb 26, 2024

@Krishna2323 You removed the wrong step, please double check

@s77rt
Copy link
Contributor

s77rt commented Feb 26, 2024

Also please make the requested change on the last step

@Krishna2323
Copy link
Contributor Author

Sorry for that, I updated wrong step, Updated.

@s77rt
Copy link
Contributor

s77rt commented Feb 26, 2024

Thank you!

@melvin-bot melvin-bot bot requested a review from deetergp February 26, 2024 05:18
@shahinyan11 shahinyan11 mentioned this pull request Feb 26, 2024
50 tasks
@deetergp deetergp merged commit 2509631 into Expensify:main Feb 26, 2024
18 of 19 checks passed
OSBotify pushed a commit that referenced this pull request Feb 26, 2024
fix: Video - Invalid file is downloaded when downloading video.
(cherry picked from commit 2509631)
deetergp added a commit that referenced this pull request Feb 26, 2024
…ng-37163-1

🍒 Cherry pick PR #37163 to staging 🍒
@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/deetergp in version: 1.4.43-19 🚀

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

@deetergp
Copy link
Contributor

This is been CPed to staging and works 👍

Screen.Recording.2024-02-26.at.11.03.38.AM.mov

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/puneetlath in version: 1.4.43-20 🚀

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

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

Successfully merging this pull request may close these issues.

5 participants