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

[Prod QA] Update Statement PDF #8270

Merged
merged 11 commits into from
Mar 30, 2022
Merged

[Prod QA] Update Statement PDF #8270

merged 11 commits into from
Mar 30, 2022

Conversation

thienlnam
Copy link
Contributor

@thienlnam thienlnam commented Mar 23, 2022

Details

Separates the download handling from the fetching of the statement. Prevents multiple download clicks. Automatically generate statement on component load so it's ready when the user wishes to download the statement

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/192002

Tests

  1. Follow the steps in this PR [P2P Statements] Add Wallet Statements Page + Modal #7663 to hook up a button to link to the statement page (On native devices, clicking on the link will just redirect to a web page)
  2. Click on the Download button
  3. Ensure you are able to download the PDF statement
  • Verify that no errors appear in the JS console

PR Review Checklist

Contributor (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 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 included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • iOS / native
    • Android / native
    • iOS / Safari
    • Android / Chrome
    • MacOS / Chrome
    • 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 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 was added in all src/languages/* files
    • I verified any copy / text that was added to the app is correct English and approved by marketing by tagging the marketing team 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
  • 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 */
    • Any functional components have the displayName property
    • 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
  • 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 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.

PR Reviewer Checklist

  • 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 verified tests pass on all platforms & I tested again on:
    • iOS / native
    • Android / native
    • iOS / Safari
    • Android / Chrome
    • MacOS / Chrome
    • 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 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 was added in all src/languages/* files
    • I verified any copy / text that was added to the app is correct English and approved by marketing by tagging the marketing team 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 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 */
    • Any functional components have the displayName property
    • 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 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 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.

QA Steps

Production QA

  • Navigate to new.expensify.com/statements/202112/

  • Click on the download button and verify it downloads the PDF

  • Verify that no errors appear in the JS console

Screenshots

Web

Screen Shot 2022-03-23 at 4 19 39 PM
Screen Shot 2022-03-23 at 4 19 46 PM

Mobile Web

Screen Shot 2022-03-23 at 4 20 44 PM
Screen Shot 2022-03-23 at 4 20 56 PM

Desktop

Screen Shot 2022-03-23 at 4 22 35 PM
Screen Shot 2022-03-23 at 4 22 49 PM

iOS

Android

Screen Shot 2022-03-23 at 4 28 28 PM

@thienlnam thienlnam self-assigned this Mar 23, 2022
@thienlnam thienlnam marked this pull request as ready for review March 23, 2022 23:30
@thienlnam thienlnam requested a review from a team as a code owner March 23, 2022 23:30
@melvin-bot melvin-bot bot requested review from sketchydroide and removed request for a team March 23, 2022 23:30
@thienlnam
Copy link
Contributor Author

Will be production QA, unable to test on simulators but made sure there were no console errors on those devices

@thienlnam thienlnam requested a review from nickmurray47 March 23, 2022 23:31
Copy link
Contributor

@nickmurray47 nickmurray47 left a comment

Choose a reason for hiding this comment

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

Looks pretty solid! Had one larger suggestion to implement

src/pages/wallet/WalletStatementPage.js Outdated Show resolved Hide resolved
src/libs/actions/User.js Show resolved Hide resolved
src/pages/wallet/WalletStatementPage.js Outdated Show resolved Hide resolved
@thienlnam thienlnam requested a review from nickmurray47 March 24, 2022 20:47
nickmurray47
nickmurray47 previously approved these changes Mar 24, 2022
Copy link
Contributor

@nickmurray47 nickmurray47 left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@sketchydroide sketchydroide left a comment

Choose a reason for hiding this comment

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

just a small question

@thienlnam
Copy link
Contributor Author

Added a log line!

@sketchydroide
Copy link
Contributor

not sure if @nickmurray47 is still going to be doing a review
I'm going to remove him

@sketchydroide
Copy link
Contributor

seems like I can't remove him.
I've approved the PR, I can't test it at the moment, as I'm not able to run the app ATM
Feel free to merge it @thienlnam

@thienlnam thienlnam merged commit fb5177e into main Mar 30, 2022
@thienlnam thienlnam deleted the jack-updatePDFHandling branch March 30, 2022 17:17
@thienlnam thienlnam added the InternalQA This pull request required internal QA label Mar 30, 2022
@melvin-bot
Copy link

melvin-bot bot commented Mar 30, 2022

Triggered auto assignment to @flodnv (InternalQA), see https://stackoverflow.com/c/expensify/questions/5042 for more details.

@thienlnam thienlnam removed the InternalQA This pull request required internal QA label Mar 30, 2022
@thienlnam
Copy link
Contributor Author

Sorry Flo, this actually isn't internal QA and can be tested with applause

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

@mvtglobally
Copy link

@thienlnam, this PR has to be deployed to PROD for us to QA, right?

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by @thienlnam in version: 1.1.47-0 🚀

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

@thienlnam
Copy link
Contributor Author

Ah yes sorry, this needs to be production QA @mvtglobally

@thienlnam thienlnam changed the title Update Statement PDF [Prod QA] Update Statement PDF Apr 4, 2022
@OSBotify
Copy link
Contributor

OSBotify commented Apr 5, 2022

🚀 Deployed to production by @roryabraham in version: 1.1.49-1 🚀

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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants