Rewrite WalletStatementModal to functional component #26064

MaciejSWM · 2023-08-28T09:22:15Z

Details

Fixed Issues

Tests

Go to http://localhost:8082/statements/202308
Verify that there is only one error in the console in local environment:

Refused to frame 'https://www.expensify.com/' because an ancestor violates the following Content Security Policy directive: "frame-ancestors https://we.are.expensify.com www.expensify.com chrome-extension://oiicpdkmeclmgmlmbajefnkalcfageek chrome-extension://eeibfofdhodcjojmbookcpigoaeilkek https://new.expensify.com".

Due to CSP policy, your browser will block you from seeing www.expensify.com iframe, as localhost is not whitelisted in the CSP headers coming from www.expensify.com. I disabled CSP protection in my chrome by downloading https://chrome.google.com/webstore/detail/always-disable-content-se/ffelghdomoehpceihalcnbmnodohkibj/related but still, even though the iframe is now loading, it's loading https://www.expensify.com/statement.php?period=202201&authToken=<HIDDEN> that loads no content at all (empty and ) - this might be because I am navigating to this URL by directly going to /statements/202308 but I have no card added to my wallet? I have no card added since I don't know how to do it/getting errors when adding a test mastercard card.

This is the header I'm getting from www.expensify.com that sets the allowed ancestors for iframe:

Content-Security-Policy:
frame-ancestors https://we.are.expensify.com www.expensify.com chrome-extension://oiicpdkmeclmgmlmbajefnkalcfageek chrome-extension://eeibfofdhodcjojmbookcpigoaeilkek https://new.expensify.com

Offline tests

You should see You appear to be offline.This feature requires an active internet connection to be used. instead of the iframe when you are offline.

QA Steps

In Staging, the iframe should load without any problems.

PR Author Checklist

Screenshots/Videos

Web

Screen.Recording.2023-08-30.at.17.45.59.mov

Mobile Web - Chrome

Screen.Recording.2023-08-30.at.17.38.53.mov

Mobile Web - Safari

Screen.Recording.2023-08-30.at.17.37.11.mov

Desktop

Screen.Recording.2023-08-30.at.17.35.13.mov

iOS

Screen.Recording.2023-08-30.at.17.30.51.mov

Android

Screen.Recording.2023-08-30.at.17.51.23.mov

melvin-bot · 2023-08-28T11:27:10Z

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

burczu

Added two minor comments, well done otherwise

burczu · 2023-08-29T06:50:19Z

src/components/WalletStatementModal/index.js


    /**
     * Handles in-app navigation for iframe links
     *
     * @param {MessageEvent} e
     */
-    navigate(e) {
+    const navigate = (e) => {


I know it was e before, but I would recommend to use more meaningful names for variables/parameters, so here something like event will be better. WDYT?

I'm also a fan of more meaningful variable names so I'll change it, thanks

burczu · 2023-08-29T06:50:45Z

src/components/WalletStatementModal/index.js

-    }
+                        // We listen to a message sent from the iframe to the parent component when a link is clicked.
+                        // This lets us handle navigation in the app, outside of the iframe.
+                        window.onmessage = (e) => navigate(e);


burczu · 2023-08-29T10:12:00Z

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 / Chrome
- iOS / native
- iOS / 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

Web

26064-web.mp4

Mobile Web - Chrome

26064-web-mobile-chrome.mp4

Mobile Web - Safari

26064-web-mobile-safari.mp4

Desktop

26064-desktop.mp4

iOS

26064-ios.mp4

Android

26064-android.mp4

burczu · 2023-08-30T08:31:07Z

@MaciejSWM Isn't it possible to test it on other platforms? You have only added screenshot for web.

MaciejSWM · 2023-08-30T15:53:34Z

@burczu I uploaded all the videos. Most of them either show a blank screen, or throw the CSP security error (the browser based ones). I have no idea how to make it show anything than a blank screen. Also, it seems like this component is not used anywhere so I had to invoke that route from the FAB menu.

burczu

Reviewed and tested - I think we are ok to go!

melvin-bot · 2023-08-31T11:23:45Z

We did not find an internal engineer to review this PR, trying to assign a random engineer to #16216 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

srikarparsi

lgtm as well!

OSBotify · 2023-09-01T04:40:23Z

✋ 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 · 2023-09-01T23:37:59Z

🚀 Deployed to staging by https://github.com/srikarparsi in version: 1.3.62-0 🚀

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

mvtglobally · 2023-09-02T01:53:14Z

@MaciejSWM @burczu @srikarparsi
Can you pls help us and clarify QA steps a bit more. How do we get to the iframe?

mountiny · 2023-09-03T18:57:16Z

I will check this off as its low priority, but @srikarparsi can you make sure this gets QAed and post here for posteriority that we did not break it. Thanks!

OSBotify · 2023-09-04T16:22:41Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.62-4 🚀

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

MaciejSWM · 2023-09-06T13:30:23Z

@mvtglobally this is how you can invoke it:

In FloatingActionButtonAndPopover.js

onSelected: () => interceptAnonymousUser(() => Navigation.navigate(ROUTES.getWalletStatementWithDateRoute('202306'))),

MaciejSWM added 2 commits August 28, 2023 10:59

Rewrite to functional component

822f431

Semicolon

24d09d2

MaciejSWM marked this pull request as ready for review August 28, 2023 11:27

MaciejSWM requested a review from a team as a code owner August 28, 2023 11:27

melvin-bot bot requested review from burczu and removed request for a team August 28, 2023 11:27

burczu reviewed Aug 29, 2023

View reviewed changes

MaciejSWM added 2 commits August 29, 2023 11:44

Rename e to event

c99b94e

Use more implicit function execution syntax

3a76d56

MaciejSWM requested a review from burczu August 29, 2023 09:54

burczu approved these changes Aug 31, 2023

View reviewed changes

melvin-bot bot requested a review from srikarparsi August 31, 2023 11:23

srikarparsi changed the title ~~Rewrite to functional component~~ Rewrite WalletStatementModal to functional component Sep 1, 2023

srikarparsi approved these changes Sep 1, 2023

View reviewed changes

srikarparsi merged commit 9b48540 into Expensify:main Sep 1, 2023
14 checks passed

OSBotify mentioned this pull request Sep 1, 2023

Deploy Checklist: New Expensify 2023-09-01 #26539

Closed

40 tasks

melvin-bot bot mentioned this pull request Sep 4, 2023

[HOLD for payment 2023-09-11] [HOLD][$250] Migrate index.js to function component #16216

Closed

1 task

situchan mentioned this pull request Sep 25, 2023

refactor: migrated WalletStatementModal to function component #27934

Merged

59 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rewrite WalletStatementModal to functional component #26064

Rewrite WalletStatementModal to functional component #26064

MaciejSWM commented Aug 28, 2023 •

edited

Loading

melvin-bot bot commented Aug 28, 2023

burczu left a comment

burczu Aug 29, 2023

MaciejSWM Aug 29, 2023

burczu Aug 29, 2023

burczu commented Aug 29, 2023 •

edited

Loading

burczu commented Aug 30, 2023

MaciejSWM commented Aug 30, 2023

burczu left a comment

melvin-bot bot commented Aug 31, 2023

srikarparsi left a comment

OSBotify commented Sep 1, 2023

OSBotify commented Sep 1, 2023

mvtglobally commented Sep 2, 2023

mountiny commented Sep 3, 2023 •

edited

Loading

OSBotify commented Sep 4, 2023

MaciejSWM commented Sep 6, 2023

Rewrite WalletStatementModal to functional component #26064

Rewrite WalletStatementModal to functional component #26064

Conversation

MaciejSWM commented Aug 28, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Aug 28, 2023

burczu left a comment

Choose a reason for hiding this comment

burczu Aug 29, 2023

Choose a reason for hiding this comment

MaciejSWM Aug 29, 2023

Choose a reason for hiding this comment

burczu Aug 29, 2023

Choose a reason for hiding this comment

burczu commented Aug 29, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

burczu commented Aug 30, 2023

MaciejSWM commented Aug 30, 2023

burczu left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Aug 31, 2023

srikarparsi left a comment

Choose a reason for hiding this comment

OSBotify commented Sep 1, 2023

OSBotify commented Sep 1, 2023

mvtglobally commented Sep 2, 2023

mountiny commented Sep 3, 2023 • edited Loading

OSBotify commented Sep 4, 2023

MaciejSWM commented Sep 6, 2023

MaciejSWM commented Aug 28, 2023 •

edited

Loading

burczu commented Aug 29, 2023 •

edited

Loading

mountiny commented Sep 3, 2023 •

edited

Loading