Allow users to export report as PDF by Gonals · Pull Request #57323 · Expensify/App

Gonals · 2025-02-24T14:23:18Z

HELD https://github.com/Expensify/Web-Expensify/pull/45644

Explanation of Change

Fixed Issues

$ #55810
PROPOSAL:

Tests

Log into NewDot and create some expenses in a workspace
Open the expense report and click on the header. The right hand summary should open, and the "Download as PDF" Option should be there:

Click it. A modal should show up:

After a bit, it should error (because we are in Dev and PDFs aren't generated there):

Repeat the steps 1-3 using staging as the backend (no NGROK).
After a bit, the "Download" button should show. Click it. The file should download

Verify that no errors appear in the JS console

Offline tests

Offline, clicking the "Download as PDF" button should show a modal blocking the flow.

QA Steps

Log into NewDot and create some expenses in a workspace
Open the expense report and click on the header. The right hand summary should open, and the "Download as PDF" Option should be there:

Click it. A modal should show up:

After a bit, the "Download" button should show. Click it. The file should download

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2025-02-24T14:23:24Z

@dubielzyk-expensify @ishpaul777 One of you needs to 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]

Mobile-Expensify

ishpaul777 · 2025-02-25T19:28:51Z

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 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.ts 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.
For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
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

Screen.Recording.2025-03-04.at.2.49.39.AM.mov

iOS: Native

Screen.Recording.2025-03-02.at.10.58.53.PM.mov

Screen.Recording.2025-03-04.at.2.30.48.AM.mov

iOS: mWeb Safari

Screen.Recording.2025-03-02.at.10.58.31.PM.mov

Screen.Recording.2025-03-02.at.10.43.16.PM.mov

Screen.Recording.2025-03-04.at.2.24.08.AM.mov

MacOS: Chrome / Safari

Screen.Recording.2025-03-02.at.11.01.30.PM.mov

MacOS: Desktop

ishpaul777 · 2025-02-25T19:29:25Z

oh i thought this is still WIP because it shows gray on K2, that's why left partial review, I am on it today!

src/pages/ReportDetailsPage.tsx

ishpaul777 · 2025-02-25T20:58:38Z

Bug: offline modal only visible when the generating PDF modal is dismissed

Screen.Recording.2025-02-26.at.2.21.03.AM.mov

ishpaul777 · 2025-02-25T21:00:51Z

Some small comments, Overall looks great! also we have some lint checks failing @Gonals

Gonals · 2025-02-26T11:55:58Z

oh i thought this is still WIP because it shows gray on K2, that's why left partial review, I am on it today!

It is still on WIP! 😆

ishpaul777 · 2025-03-07T16:34:14Z

@Gonals I was thinking if it would be possible to redirect user to browser with expensify.com/fileaLinkurl only on Android native as workaround until we figure out the problem at root? Is that viable idea

Gonals · 2025-03-10T10:44:45Z

@Gonals I was thinking if it would be possible to redirect user to browser with expensify.com/fileaLinkurl only on Android native as workaround until we figure out the problem at root? Is that viable idea

Potentially, but I'm going to try one more thing. I still have half a feeling this is all because we are in dev. I have put everything behind a beta, so we could deploy with Android as-is (because it should work, as we do the exact same thing in another place) nd see what happens in staging. If it doesn't work there, then we figure out what's up and fix it.

github-actions · 2025-03-10T12:54:16Z

🚧 @Gonals has triggered a test app build. You can view the workflow run here.

github-actions · 2025-03-10T13:25:45Z

🧪🧪 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/57323/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/57323/index.html

Android Hybrid 🤖🔄	iOS Hybrid 🍎🔄
N/A	N/A
N/A	N/A
Desktop 💻	Web 🕸️
N/A	N/A
N/A	N/A

👀 View the workflow run that generated this build 👀

Gonals · 2025-03-10T13:57:30Z

@Gonals I was thinking if it would be possible to redirect user to browser with expensify.com/fileaLinkurl only on Android native as workaround until we figure out the problem at root? Is that viable idea

Potentially, but I'm going to try one more thing. I still have half a feeling this is all because we are in dev. I have put everything behind a beta, so we could deploy with Android as-is (because it should work, as we do the exact same thing in another place) nd see what happens in staging. If it doesn't work there, then we figure out what's up and fix it.

Let's make sure everything else works as expected and give that a shot, then

ishpaul777 · 2025-03-10T22:25:06Z

Everything else looks good, works well 🚀

Gonals · 2025-03-11T12:14:42Z

Everything else looks good, works well 🚀

Neat, then can you approve? 😁

melvin-bot · 2025-03-11T12:24:41Z

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

grgia

LGTM

OSBotify · 2025-03-11T14:52:19Z

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

github-actions · 2025-03-12T14:07:21Z

🚀 Deployed to staging by https://github.com/grgia in version: 9.1.12-0 🚀

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

lanitochka17 · 2025-03-12T16:00:49Z

@Gonals Hello
The option Download as PDF is not available for Gmail accounts. Is it expected?

dangrous · 2025-03-12T17:08:47Z

Already got linked but looks like this isn't quite working right - #58302 - seems like maybe we need to handle this with a shortLivedAuthToken or something on the Old Dot side?

Let me know if this is a blocker or we can move forward

izarutskaya · 2025-03-13T07:07:34Z

@dangrous @Gonals PR is failing with issues #58302, #58285

Gonals · 2025-03-13T11:33:58Z

@Gonals Hello The option Download as PDF is not available for Gmail accounts. Is it expected?

Yes, it is behind a beta

Gonals · 2025-03-13T14:32:00Z

@dangrous @Gonals PR is failing with issues #58302, #58285

Yes. I'm on it. We don't need to block deploy, though, as this is behind a beta

github-actions · 2025-03-14T01:06:23Z

🚀 Deployed to production by https://github.com/mountiny in version: 9.1.12-7 🚀

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

hoangzinh · 2025-06-02T11:04:50Z

src/libs/actions/Report.ts

+    const baseURL = addTrailingForwardSlash(getOldDotURLFromEnvironment(environment));
+    const downloadFileName = `${reportName}.pdf`;
+    const pdfURL = `${baseURL}secure?secureType=pdfreport&filename=${fileName}&downloadName=${downloadFileName}`;
+    fileDownload(pdfURL, downloadFileName, '', Browser.isMobileSafari());


We can explicitly pass true to the 3rd argument when calling this function to treat App downloads as an external link to avoid the CORS issue. More details here #61937 (comment)

Gonals added 13 commits February 20, 2025 14:55

labels

c1774d1

Add new params

1cafa55

new types and whatnot

9b5cd8c

Add button

c3cce3b

typing changes

04807e6

Add generating modal

2be5e3e

correctly display modal

2ba5438

Handle all three cases

aa05e50

call export command

5ceccea

create download file

8b0fda7

Handle downloads

feafad9

onyxdata added

73c1aa6

Correctly show popup

850cd1b

Gonals self-assigned this Feb 24, 2025

Gonals requested a review from a team as a code owner February 24, 2025 14:23

melvin-bot bot requested review from dubielzyk-expensify and ishpaul777 February 24, 2025 14:23

melvin-bot bot removed the request for review from a team February 24, 2025 14:23

strings

ac82821

ishpaul777 reviewed Feb 24, 2025

View reviewed changes

Mobile-Expensify Show resolved Hide resolved

ishpaul777 reviewed Feb 25, 2025

View reviewed changes

src/pages/ReportDetailsPage.tsx Outdated Show resolved Hide resolved

ishpaul777 reviewed Feb 25, 2025

View reviewed changes

src/pages/ReportDetailsPage.tsx Outdated Show resolved Hide resolved

Gonals force-pushed the alberto-pdfExport branch 2 times, most recently from 5f7b338 to a334576 Compare February 26, 2025 14:08

test link

3365a19

Gonals added 2 commits March 10, 2025 14:39

undo last change

d73748f

Merge branch 'main' into alberto-pdfExport

5fe3192

ishpaul777 approved these changes Mar 11, 2025

View reviewed changes

melvin-bot bot requested a review from grgia March 11, 2025 12:24

grgia approved these changes Mar 11, 2025

View reviewed changes

grgia merged commit 5413130 into main Mar 11, 2025
16 of 17 checks passed

grgia deleted the alberto-pdfExport branch March 11, 2025 14:44

github-actions bot mentioned this pull request Mar 12, 2025

Deploy Checklist: New Expensify 2025-03-12 #58283

Closed

71 tasks

mitarachim mentioned this pull request Mar 12, 2025

[BZ Checklist][$250] Android - Expense - Unable to download expense report as PDF #58285

Closed

8 tasks

lanitochka17 mentioned this pull request Mar 12, 2025

[Due for payment 2025-04-07] Web/mWeb - Clicking on download button in generating PDF redirects to OD site #58302

Closed

8 tasks

arosiclair mentioned this pull request Mar 12, 2025

[Due for payment 2025-04-07] Desktop - Expense - Expense PDF file downloaded from desktop app is broken #58319

Closed

8 tasks

melvin-bot bot mentioned this pull request Mar 14, 2025

[Due for payment 2025-03-21] Add the front-end UX for exporting reports to PDF but use the existing back-end PDF generation functionality from Classic #55810

Closed

hoangzinh reviewed Jun 2, 2025

View reviewed changes

Conversation

Gonals commented Feb 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Feb 24, 2025

Uh oh!

Uh oh!

ishpaul777 commented Feb 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

ishpaul777 commented Feb 25, 2025

Uh oh!

Uh oh!

Uh oh!

ishpaul777 commented Feb 25, 2025

Uh oh!

ishpaul777 commented Feb 25, 2025

Uh oh!

Gonals commented Feb 26, 2025

Uh oh!

ishpaul777 commented Mar 7, 2025

Uh oh!

Gonals commented Mar 10, 2025

Uh oh!

github-actions bot commented Mar 10, 2025

Uh oh!

github-actions bot commented Mar 10, 2025

Uh oh!

Gonals commented Mar 10, 2025

Uh oh!

ishpaul777 commented Mar 10, 2025

Uh oh!

Gonals commented Mar 11, 2025

Uh oh!

melvin-bot bot commented Mar 11, 2025

Uh oh!

grgia left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

OSBotify commented Mar 11, 2025

Uh oh!

github-actions bot commented Mar 12, 2025

Uh oh!

lanitochka17 commented Mar 12, 2025

Uh oh!

dangrous commented Mar 12, 2025

Uh oh!

izarutskaya commented Mar 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Gonals commented Mar 13, 2025

Uh oh!

Gonals commented Mar 13, 2025

Uh oh!

github-actions bot commented Mar 14, 2025

Uh oh!

hoangzinh Jun 2, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

Gonals commented Feb 24, 2025 •

edited

Loading

ishpaul777 commented Feb 25, 2025 •

edited

Loading

izarutskaya commented Mar 13, 2025 •

edited

Loading