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

Scan - Failed to load PDF file uploaded in request money scan #30747

Merged
merged 5 commits into from
Nov 14, 2023

Conversation

pradeepmdk
Copy link
Contributor

@pradeepmdk pradeepmdk commented Nov 2, 2023

Details

Fixed Issues

$ #27680
PROPOSAL: #27680 (comment)

Tests

  1. Request money and open scan tab
  2. Upload a pdf
  3. Open scan report
  4. Click on pdf preview
  5. Verify it's loading the pdf
  • Verify that no errors appear in the JS console

Offline tests

Same as test

QA Steps

same as test

  • 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 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
    • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
    • 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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native
Screen.Recording.2023-11-02.at.11.20.12.AM.mov
output.mp4
Android: mWeb Chrome
Screen.Recording.2023-11-02.at.1.36.04.PM.mov
output.mp4
iOS: Native
Screen.Recording.2023-11-02.at.11.33.59.AM.mov
output.mp4
iOS: mWeb Safari
Screen.Recording.2023-11-02.at.9.36.48.AM.mov
output.mp4
MacOS: Chrome / Safari
Screen.Recording.2023-11-02.at.9.04.39.AM.mov
output.mp4
MacOS: Desktop
Screen.Recording.2023-11-02.at.11.30.28.AM.mov
output.mp4

@pradeepmdk pradeepmdk requested a review from a team as a code owner November 2, 2023 06:05
@melvin-bot melvin-bot bot requested review from sobitneupane and removed request for a team November 2, 2023 06:05
Copy link

melvin-bot bot commented Nov 2, 2023

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

@pradeepmdk
Copy link
Contributor Author

@sobitneupane Pr is ready for review

src/CONST.ts Outdated Show resolved Hide resolved
@trjExpensify
Copy link
Contributor

Looking at the video, why isn't their a preview of the PDF showing in the thumbnail?

image

@pradeepmdk
Copy link
Contributor Author

@trjExpensify Currently the expected result is showing the PDF on the preview modal. for here to show pdf preview may be different bug/future.

@trjExpensify
Copy link
Contributor

I'm not sure I'm following, do you mind rephrasing?

@pradeepmdk
Copy link
Contributor Author

Looking at the video, why isn't their a preview of the PDF showing in the thumbnail?

image

@trjExpensify actually you are asking to show the preview pdf view here right?

@trjExpensify
Copy link
Contributor

Yep, a PDF receipt should preview the same as an image receipt would.

@pradeepmdk
Copy link
Contributor Author

@trjExpensify but we are fixing a different issue here.. when we click the thumbnail it will open a modal for showing the pdf preview load to fail that things we are fixed here. i am not sure we need include this here or not

Yep, a PDF receipt should preview the same as an image receipt would.

Copy link
Contributor

@sobitneupane sobitneupane left a comment

Choose a reason for hiding this comment

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

@pradeepmdk thumbnail is missing when we try to upload pdf/doc as receipt.

Screen.Recording.2023-11-09.at.20.54.35.mov

Update: I am not sure what is the problem. But I cannot reproduce it any longer. Trying to reproduce it again.

@Gonals
Copy link
Contributor

Gonals commented Nov 9, 2023

Yep, a PDF receipt should preview the same as an image receipt would.

I think that would be a different issue to the one proposed in the original GH. The approved proposal is also only focused on the full preview, rather than the thumbnail. (We should fix that too, though)

Copy link
Contributor

@sobitneupane sobitneupane left a comment

Choose a reason for hiding this comment

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

Screenshots/Videos

Android: Native
Screen.Recording.2023-11-09.at.22.19.03.mov
Android: mWeb Chrome
iOS: Native
Screen.Recording.2023-11-09.at.22.37.52.mov
iOS: mWeb Safari
Screen.Recording.2023-11-09.at.21.54.54.mov
MacOS: Chrome / Safari
Online
Screen.Recording.2023-11-09.at.21.15.22.mov
Offline
Screen.Recording.2023-11-09.at.21.06.38.mov
MacOS: Desktop

@trjExpensify
Copy link
Contributor

I think that would be a different issue to the one proposed in the original GH. The approved proposal is also only focused on the full preview, rather than the thumbnail. (We should fix that too, though)

Hmm.. okay. That seems very strange to me. Why would we accept a partial proposal? Is the thumbnail being worked on already somewhere else or something? This feels and looks broken still really. With the empty state thumbnail, nobody would think to click it to see the PDF rendered.

@Gonals
Copy link
Contributor

Gonals commented Nov 9, 2023

I think that would be a different issue to the one proposed in the original GH. The approved proposal is also only focused on the full preview, rather than the thumbnail. (We should fix that too, though)

Hmm.. okay. That seems very strange to me. Why would we accept a partial proposal? Is the thumbnail being worked on already somewhere else or something? This feels and looks broken still really. With the empty state thumbnail, nobody would think to click it to see the PDF rendered.

I think that what happened is that the described issue in the GH did not cover the thumbnails (Expected result: The pdf loads. Actual result: It doesn't. No mention of the thumbnails).

Basically, the GH presented an issue and the proposed solution fixes that issue. I agree that it would have been better to fix everything together for the flow, but, in the end, they are different issues that require separate investigation

Copy link
Contributor

@sobitneupane sobitneupane left a comment

Choose a reason for hiding this comment

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

@pradeepmdk I am seeing issues while trying to request money with receipt in mWeb/Chrome. Can you please upload a video containing a full flow from adding receipt to displaying it for each platform.

Also, I can see quite a few console warnings related to thumbnail image in Android: Native and IOS: Native.

I was unable to access recently uploaded pdf in Android: Native. Eventually those request failed.
Screenshot 2023-11-09 at 22 26 20

I am suspicious that some of these issues might be caused by my simulator because issues are only reproduced in Android Simulator. It is working fine in IOS simulator.

@sobitneupane
Copy link
Contributor

@Gonals When a user uploads a DOC file, the backend (I assume) converts it to PDF and returns the converted file. Since we currently don't support previewing DOC files, the receipt won't be displayed until the PDF version is received from the backend.

Screenshot 2023-11-09 at 22 47 12

@pradeepmdk
Copy link
Contributor Author

@sobitneupane updated

Copy link
Contributor

@sobitneupane sobitneupane left a comment

Choose a reason for hiding this comment

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

@pradeepmdk Console Warnings are still present. Please do update thumbnail prop in following line to accept type number. There might be other places where the update is required.

Screenshot 2023-11-10 at 20 52 02

Copy link
Contributor

@sobitneupane sobitneupane left a comment

Choose a reason for hiding this comment

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

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(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 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
test_android.mov
Android: mWeb Chrome
iOS: Native
Screen.Recording.2023-11-14.at.14.11.42.mov
iOS: mWeb Safari
Screen.Recording.2023-11-14.at.14.09.06.mov
MacOS: Chrome / Safari
Screen.Recording.2023-11-14.at.14.15.31.mov
MacOS: Desktop
Screen.Recording.2023-11-14.at.14.19.12.mov

@melvin-bot melvin-bot bot requested a review from Gonals November 14, 2023 09:11
@Gonals Gonals merged commit 62e437b into Expensify:main Nov 14, 2023
15 checks passed
@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.

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/Gonals in version: 1.3.99-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.99-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/Gonals in version: 1.4.0-0 🚀

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

@trjExpensify
Copy link
Contributor

I created an issue for the thumbnails here.

@@ -65,7 +66,7 @@ function getThumbnailAndImageURIs(transaction: Transaction, receiptPath: string
image = ReceiptSVG;
}

return {thumbnail: null, image};
return {thumbnail: image, image: path, isLocalFile: true};
Copy link
Contributor

Choose a reason for hiding this comment

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

You forgot to cover the case of local files which caused a bug. More details here: #33474

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.

6 participants