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

Add proper offline state handling for XeroOrganizationConfigurationPage #41983

Conversation

SzymczakJ
Copy link
Contributor

@SzymczakJ SzymczakJ commented May 10, 2024

Details

This is PR adds offline state handling for XeroOrganizationConfigurationPage.

Fixed Issues

$ #41841
PROPOSAL: N/A

Tests

  1. With a Workspace with a Xero connection
  • Create workspace
  • Modify Permissions.ts so that canUseXeroIntegration and canUseAccountingIntegrations return true
  • On workspace page go to the "More features" and enable "Accounting"
  • On Accounting page set up Xero connection(you will have to create Xero account etc.)
  1. Turn on offline mode on troubleshoot page
  2. Go to Workspace Accounting page and then to Xero Organization Configuration Page
  3. Change organisation and verify that Organization page and Workspace Accounting page look like this
Screenshot 2024-05-13 at 18 22 04 Screenshot 2024-05-13 at 18 24 11
  1. Turn on simulate failing network requests on troubleshoot page
  2. Go to Workspace Accounting page and then to Xero Organization Configuration Page
  3. Change organisation and verify that Organization page and Workspace Accounting page look like this
Screenshot 2024-05-13 at 18 44 27 Screenshot 2024-05-13 at 18 44 34

Offline tests

QA Steps

Same as tests

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.mov
Android: mWeb Chrome
androidweb.mov
iOS: Native
ios.mov
iOS: mWeb Safari
iosweb.mov
MacOS: Chrome / Safari
web.mov
MacOS: Desktop
desktop.mov

@SzymczakJ
Copy link
Contributor Author

SzymczakJ commented May 13, 2024

@Expensify/design could you please review this? 🙏 cc @shawnborton

@shawnborton
Copy link
Contributor

I don't think Offline mode should make the list options here look faded:
CleanShot 2024-05-13 at 08 11 45@2x

cc @trjExpensify @Expensify/design - is that your understanding as well? Basically you can still interact with these, so no need to fade them out. We would only use the 50% opacity for the pending creation state of the previous screen's push row.

@shawnborton
Copy link
Contributor

For this error here:
CleanShot 2024-05-13 at 08 12 33@2x

I would think there should be a small dismiss "x" over on the right? And can we add perhaps 4px-8px of margin above the error so it's not quite touching the row above?

@trjExpensify
Copy link
Contributor

cc @trjExpensify @Expensify/design - is that your understanding as well? Basically you can still interact with these, so no need to fade them out. We would only use the 50% opacity for the pending creation state of the previous screen's push row.

Correct! 👍

@SzymczakJ
Copy link
Contributor Author

SzymczakJ commented May 13, 2024

So to make sure I understand
Offline state shouldn't be indicated on this page(so nothing should be faded out):
Screenshot 2024-05-10 at 11 15 50
Indicating offline state on this page is corrct and we should blank out this "Xero organization" button:
Screenshot 2024-05-10 at 16 28 24

cc @shawnborton @trjExpensify

@shawnborton
Copy link
Contributor

That sounds correct to me. I can't see your whole screenshot, but I think there would also be an offline indicator at the bottom of your second screenshot.

Can you also pull main when you get a chance? There's been some updated styles merged that aren't reflected in your screenshots either. Thanks!

Copy link
Contributor

@filip-solecki filip-solecki left a comment

Choose a reason for hiding this comment

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

LGTM

@SzymczakJ SzymczakJ marked this pull request as ready for review May 14, 2024 09:34
@SzymczakJ SzymczakJ requested a review from a team as a code owner May 14, 2024 09:34
@melvin-bot melvin-bot bot requested review from abdulrahuman5196 and removed request for a team May 14, 2024 09:34
Copy link

melvin-bot bot commented May 14, 2024

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

@shawnborton
Copy link
Contributor

@lakchote the "Other integrations" shouldn't be bold here:
CleanShot 2024-05-14 at 11 42 05@2x

But I know we talked about this somewhere else. Do we just need to merge main/a feature branch, or maybe something got messed up here?

@abdulrahuman5196
Copy link
Contributor

@SzymczakJ / @filip-solecki How do I enable this With a Workspace with a Xero connection ?

@SzymczakJ
Copy link
Contributor Author

@abdulrahuman5196 I've updated tests steps 😄

@SzymczakJ
Copy link
Contributor Author

@shawnborton I merged main and it got fixed!

Screenshot 2024-05-15 at 11 15 06

@shawnborton
Copy link
Contributor

Lovely, that looks better!

@SzymczakJ
Copy link
Contributor Author

@abdulrahuman5196 bump 🙏

@trjExpensify
Copy link
Contributor

@rushatgabhane is taking the review of this one as it's for the Xero project.

@trjExpensify trjExpensify requested review from rushatgabhane and removed request for abdulrahuman5196 May 16, 2024 11:11
@rushatgabhane
Copy link
Member

rushatgabhane commented May 16, 2024

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 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 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 image
Android: mWeb Chrome image
iOS: Native image image image
iOS: mWeb Safari image
MacOS: Chrome / Safari
Screen.Recording.2024-05-16.at.18.11.38.mov
MacOS: Desktop

Copy link
Member

@rushatgabhane rushatgabhane left a comment

Choose a reason for hiding this comment

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

LGTM

@melvin-bot melvin-bot bot requested a review from lakchote May 17, 2024 06:26
@lakchote lakchote changed the base branch from main to xero-merge-freeze May 17, 2024 09:57
@lakchote lakchote merged commit 55b0597 into Expensify:xero-merge-freeze May 17, 2024
17 checks passed
@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/lakchote in version: 1.4.77-11 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/lakchote in version: 1.4.77-11 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Jun 4, 2024

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.78-5 🚀

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.

8 participants