fix statement modal being broken on staging environment #52799

blimpich · 2024-11-19T23:41:06Z

Explanation of Change

Our statement modal works on prod but not on staging because the URL its using to query OldDot is not cognizant that it is on staging. Here we implement logic to make it query staging when on staging and production when on production.

Fixed Issues

$ #52046
PROPOSAL:

Tests

Can't be tested locally since the bug is specific to the staging environment.

Offline tests

QA Steps

Open a wallet statement page https://staging.new.expensify.com/statements/202406 where the last 6 digits in the url represent the year and month (yyyymm) of the statement you are trying to access. If you have a enabled wallet that would probably be better for QA-ing this, if you don't ping @blimpich to do the QA instead
Press on the download button
Verify statement is downloaded

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 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: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2024-11-20T00:34:01Z

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

blimpich · 2024-11-20T00:35:03Z

Requesting review from @thienlnam for Expensify engineer review since he has context on this

thienlnam · 2024-11-20T00:44:39Z

src/libs/Environment/Environment.ts

+/**
+ * Given the environment get the corresponding oldDot URL
+ */
+function getOldDotURLFromEnvironment(environment: Environment): string {
+    return OLDDOT_ENVIRONMENT_URLS[environment];
+}
+


We already have getOldDotEnvironmentURL so we don't need this right?

Yeah but getOldDotEnvironmentURL returns a Promise. We could make it work but I thought using this where we provide the environment variable lets us do it synchronously and prevents us from having to do an async call in the modal

bump @thienlnam

Sorry, forgot to get back to this - I guess that is true, it just feels odd having the same method twice and I imagine people might not know which one to use when they see this. But alternatively I guess you'd have to use a useEffect to get the baseURL so this is cleaner

thienlnam · 2024-11-21T20:29:38Z

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

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

OSBotify · 2024-11-21T20:43:02Z

✋ 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-22T20:32:09Z

🚀 Deployed to staging by https://github.com/thienlnam in version: 9.0.66-0 🚀

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

blimpich · 2024-11-25T18:46:57Z

Looks like this fixed the original problem of the statement not downloading but the statement UI is still broken. Looks like a CSP error. Looking into it here:https://expensify.slack.com/archives/C03TQ48KC/p1732560231315739?thread_ts=1732044492.040319&cid=C03TQ48KC

github-actions · 2024-11-26T16:13:34Z

🚀 Deployed to production by https://github.com/mountiny in version: 9.0.66-8 🚀

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

add new getOldDotURLFromEnvironment synchronous method

c111f2d

blimpich self-assigned this Nov 19, 2024

update WalletStatementPage to use new baseURL

38e5b08

blimpich force-pushed the blimpich-fixStatementsOnStagingUrl branch from 29ba3f2 to 38e5b08 Compare November 19, 2024 23:44

blimpich added the InternalQA This pull request required internal QA label Nov 19, 2024

get rid of unused import

7dbe07e

blimpich changed the title ~~add new getOldDotURLFromEnvironment synchronous method~~ fix statement modal being broken on staging environment Nov 19, 2024

blimpich marked this pull request as ready for review November 20, 2024 00:33

blimpich requested a review from a team as a code owner November 20, 2024 00:33

melvin-bot bot requested a review from alitoshmatov November 20, 2024 00:34

melvin-bot bot removed the request for review from a team November 20, 2024 00:34

blimpich requested a review from thienlnam November 20, 2024 00:34

thienlnam requested changes Nov 20, 2024

View reviewed changes

blimpich requested a review from thienlnam November 21, 2024 20:18

thienlnam approved these changes Nov 21, 2024

View reviewed changes

thienlnam merged commit 738111c into main Nov 21, 2024
19 of 23 checks passed

thienlnam deleted the blimpich-fixStatementsOnStagingUrl branch November 21, 2024 20:31

github-actions bot mentioned this pull request Nov 22, 2024

Deploy Checklist: New Expensify 2024-11-22 #52978

Closed

75 tasks

melvin-bot bot mentioned this pull request Nov 26, 2024

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

Closed

8 tasks

blimpich removed the request for review from alitoshmatov December 2, 2024 22:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix statement modal being broken on staging environment #52799

fix statement modal being broken on staging environment #52799

blimpich commented Nov 19, 2024 •

edited

Loading

melvin-bot bot commented Nov 20, 2024

blimpich commented Nov 20, 2024

thienlnam Nov 20, 2024

blimpich Nov 20, 2024 •

edited

Loading

blimpich Nov 21, 2024

thienlnam Nov 21, 2024

thienlnam commented Nov 21, 2024 •

edited

Loading

OSBotify commented Nov 21, 2024

github-actions bot commented Nov 22, 2024

blimpich commented Nov 25, 2024

github-actions bot commented Nov 26, 2024

fix statement modal being broken on staging environment #52799

fix statement modal being broken on staging environment #52799

Conversation

blimpich commented Nov 19, 2024 • edited Loading

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Nov 20, 2024

blimpich commented Nov 20, 2024

thienlnam Nov 20, 2024

Choose a reason for hiding this comment

blimpich Nov 20, 2024 • edited Loading

Choose a reason for hiding this comment

blimpich Nov 21, 2024

Choose a reason for hiding this comment

thienlnam Nov 21, 2024

Choose a reason for hiding this comment

thienlnam commented Nov 21, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

OSBotify commented Nov 21, 2024

github-actions bot commented Nov 22, 2024

blimpich commented Nov 25, 2024

github-actions bot commented Nov 26, 2024

blimpich commented Nov 19, 2024 •

edited

Loading

blimpich Nov 20, 2024 •

edited

Loading

thienlnam commented Nov 21, 2024 •

edited

Loading