Auto download wallet statement after finish genereating by bernhardoj · Pull Request #51626 · Expensify/App

bernhardoj · 2024-10-29T04:01:17Z

Details

Currently, user needs to press twice the download button to download a wallet statement. We want to auto-download it after finish generating.

Fixed Issues

$ #50828
PROPOSAL: #50828 (comment)

Tests

Same as QA Steps

Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

Open a wallet statement page
Press on the download button
Verify a loader is shown and the statement is downloaded afterward

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 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 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 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.

Screenshots/Videos

Android: Native

android.mp4

Android: mWeb Chrome

android.mweb.mp4

iOS: Native

ios.mp4

iOS: mWeb Safari

MacOS: Chrome / Safari

web.mp4

MacOS: Desktop

desktop.mp4

melvin-bot · 2024-10-29T04:01:22Z

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

bernhardoj · 2024-10-29T04:02:48Z

Looks like the download doesn't work in iOS mWeb (on main too).

ios.mweb.mp4

fedirjh · 2024-10-31T12:46: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 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

CleanShot.2024-10-31.at.12.44.12.mp4

Android: mWeb Chrome

CleanShot.2024-10-31.at.12.57.55.mp4

iOS: Native

CleanShot.2024-10-31.at.11.31.48.mp4

iOS: mWeb Safari

CleanShot.2024-10-31.at.11.51.48.mp4

MacOS: Chrome / Safari

CleanShot.2024-10-30.at.23.23.18.mp4

MacOS: Desktop

CleanShot.2024-10-30.at.23.30.08.mp4

fedirjh

Looks good to me.

cc @Expensify/design

dannymcclain · 2024-10-31T13:19:41Z

Looking good. Is there any way we can keep the spinner going until the download thing actually happens/pops up? This is definitely much better than it was, but it seems like there's a couple seconds after the spinner goes away and before the download thingy pops up that makes me think "Ok wait, did it do it or did it mess up?"

shawnborton · 2024-10-31T16:01:25Z

Yeah I think that's a fair point Danny.

dubielzyk-expensify · 2024-11-01T01:30:11Z

Agree with that. Would make it clearer

bernhardoj · 2024-11-01T03:29:06Z

Done. Please check!

web.mp4

shawnborton · 2024-11-01T07:26:57Z

I think that looks better - it does seem like the continuity of the loading circle breaks slightly (as if it resets quickly) but I think that's something we can probably not worry about.

dannymcclain · 2024-11-01T13:16:02Z

it does seem like the continuity of the loading circle breaks slightly (as if it resets quickly) but I think that's something we can probably not worry about.

Yeah this isn't super noticeable (I mean... You and me noticed it but 😅) and I think we can not worry about it.

It feels much better than before.

shawnborton · 2024-11-01T14:11:15Z

Agree! Lets Get This Merged.

fedirjh

it does seem like the continuity of the loading circle breaks slightly

@bernhardoj I think we can address that with the suggested changes.

fedirjh · 2024-11-01T16:16:06Z

        if (walletStatement?.[yearMonth]) {
+            setIsDownloading(true);


Suggested change

if (walletStatement?.[yearMonth]) {

setIsDownloading(true);

setIsDownloading(true);

if (walletStatement?.[yearMonth]) {

fedirjh · 2024-11-01T16:16:22Z

    const isWalletStatementGenerating = walletStatement?.isGenerating ?? false;
-
+    const prevIsWalletStatementGenerating = usePrevious(isWalletStatementGenerating);
+    const [isDownloading, setIsDownloading] = useState(false);


Suggested change

const [isDownloading, setIsDownloading] = useState(false);

const [isDownloading, setIsDownloading] = useState(isWalletStatementGenerating);

fedirjh · 2024-11-01T16:16:36Z

                title={Str.recapitalize(title)}
-                shouldShowDownloadButton={!isOffline || isWalletStatementGenerating}
+                shouldShowDownloadButton={!isOffline || isWalletStatementGenerating || isDownloading}
+                isDownloading={isWalletStatementGenerating || isDownloading}


Suggested change

isDownloading={isWalletStatementGenerating || isDownloading}

isDownloading={isDownloading}

bernhardoj · 2024-11-01T17:21:33Z

Done. Please check again.

fedirjh · 2024-11-01T17:28:10Z

+            } else {
+                setIsDownloading(false);
+            }


Why is this necessary?

Just in case the generate fails.

fedirjh

Looks good

CleanShot.2024-11-01.at.18.38.19.mp4

CleanShot.2024-11-01.at.18.45.09.mp4

OSBotify · 2024-11-01T18:52:13Z

✋ 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 · 2024-11-04T14:39:04Z

🚀 Deployed to staging by https://github.com/carlosmiceli in version: 9.0.57-0 🚀

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

mvtglobally · 2024-11-04T20:46:28Z

We are not able to see statements in Wallet. Is there a way to trigger it in QA or can you validate internally ?

bernhardoj · 2024-11-05T05:42:40Z

@mvtglobally sorry, I should've put it on the QA Steps, but you can try accessing the wallet statement page directly.
https://staging.new.expensify.com/statements/{yyyy}{mm}
https://staging.new.expensify.com/statements/202404

Julesssss · 2024-11-05T16:57:36Z

Hey @carlosmiceli @bernhardoj, I can't figure out how to access the statement page using the direct link. Please can you test and verify this on staging? When I use the links above I see this (below)

Regardless in the meantime I will skip this from the checklist because it is a hidden feature that shouldn't block deploy.

github-actions · 2024-11-06T00:02:37Z

🚀 Deployed to production by https://github.com/luacmartins in version: 9.0.57-10 🚀

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

bernhardoj · 2024-11-06T03:27:56Z

Yes, I see that too, but you can still download it. Here is the recording on staging.

web.mp4

Julesssss · 2024-11-06T08:58:11Z

Ah thanks. After realising this wasn't live for users I was less concerned and removed the blocker, but thanks for pointing this out 👍

bernhardoj added 3 commits October 29, 2024 11:48

remove growl

bb4eddf

show loading indicator while downloading

662fc4e

automatically download after finisinh generating

eca5672

bernhardoj requested a review from a team as a code owner October 29, 2024 04:01

melvin-bot Bot requested a review from fedirjh October 29, 2024 04:01

melvin-bot Bot removed the request for review from a team October 29, 2024 04:01

bernhardoj added 2 commits October 29, 2024 12:40

lint

e9c7c93

lint

90eeee1

fedirjh approved these changes Oct 31, 2024

View reviewed changes

melvin-bot Bot requested a review from carlosmiceli October 31, 2024 12:48

bernhardoj added 2 commits November 1, 2024 11:13

Merge branch 'main' into fix/50828-auto-download-wallet-statement

585f64c

show loading until the download is complete

362ae7d

fedirjh reviewed Nov 1, 2024

View reviewed changes

make the loading smoother

658d138

fedirjh reviewed Nov 1, 2024

View reviewed changes

fedirjh approved these changes Nov 1, 2024

View reviewed changes

carlosmiceli approved these changes Nov 1, 2024

View reviewed changes

carlosmiceli merged commit 648aee5 into Expensify:main Nov 1, 2024

github-actions Bot mentioned this pull request Nov 4, 2024

Deploy Checklist: New Expensify 2024-11-04 #51953

Closed

63 tasks

lanitochka17 mentioned this pull request Nov 5, 2024

[HOLD for payment 2024-12-03] [$250] Wallet - Statement is not downloaded #52046

Closed

8 tasks

melvin-bot Bot mentioned this pull request Nov 6, 2024

[HOLD for payment 2024-11-13] [$250] Wallet statement: Clicking on download button showing a snackbar style notification about generating PDF #50828

Closed

6 tasks

	const [isDownloading, setIsDownloading] = useState(false);
	const [isDownloading, setIsDownloading] = useState(isWalletStatementGenerating);

	isDownloading={isWalletStatementGenerating \|\| isDownloading}
	isDownloading={isDownloading}

Uh oh!

Conversation

bernhardoj commented Oct 29, 2024

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot Bot commented Oct 29, 2024

Uh oh!

bernhardoj commented Oct 29, 2024

Uh oh!

fedirjh commented Oct 31, 2024

Reviewer Checklist

Screenshots/Videos

Uh oh!

fedirjh left a comment

Choose a reason for hiding this comment

Uh oh!

dannymcclain commented Oct 31, 2024

Uh oh!

shawnborton commented Oct 31, 2024

Uh oh!

dubielzyk-expensify commented Nov 1, 2024

Uh oh!

bernhardoj commented Nov 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

shawnborton commented Nov 1, 2024

Uh oh!

dannymcclain commented Nov 1, 2024

Uh oh!

shawnborton commented Nov 1, 2024

Uh oh!

fedirjh left a comment

Choose a reason for hiding this comment

Uh oh!

fedirjh Nov 1, 2024

Choose a reason for hiding this comment

Uh oh!

fedirjh Nov 1, 2024

Choose a reason for hiding this comment

Uh oh!

fedirjh Nov 1, 2024

Choose a reason for hiding this comment

Uh oh!

bernhardoj commented Nov 1, 2024

Uh oh!

fedirjh Nov 1, 2024

Choose a reason for hiding this comment

Uh oh!

bernhardoj Nov 1, 2024

Choose a reason for hiding this comment

Uh oh!

fedirjh left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Nov 1, 2024

Uh oh!

github-actions Bot commented Nov 4, 2024

Uh oh!

mvtglobally commented Nov 4, 2024

Uh oh!

bernhardoj commented Nov 5, 2024

Uh oh!

Julesssss commented Nov 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Nov 6, 2024

Uh oh!

bernhardoj commented Nov 6, 2024

Uh oh!

Julesssss commented Nov 6, 2024

Uh oh!

Reviewers

Assignees

Labels

bernhardoj commented Nov 1, 2024 •

edited

Loading

Julesssss commented Nov 5, 2024 •

edited

Loading