[Wave collect] [Xero] Block Xero screens if Xero is not connected. #42619

mananjadhav · 2024-05-26T17:54:38Z

Provide access to Xero related screens only if the integration connected is Xero.

Details

Fixed Issues

$ #41726
PROPOSAL:

Tests

Pre-requisite:

Workspace with accounting enabled but not connected to Xero.

Test Steps

Open the NewDot.
Go to Settings -> Workspaces.
Choose your workspace that has accounting enabled but not connected to Xero.
For each of the URLs listed in the Xero URLs, replace {policyID} with your workspace's policyID and try to access the page.
Ensure that it shows Not found page.

Xero URLs

Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Same as Test Steps all the links are for staging.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

android-xero-pages.mov

Android: mWeb Chrome

mweb-chrome-xero-pages.mov

iOS: Native

ios-xero-pages.mov

iOS: mWeb Safari

mweb-safari-xero-pages.mov

MacOS: Chrome / Safari

web-xero-pages-access.mp4

MacOS: Desktop

desktop-xero-pages.mov

melvin-bot · 2024-05-26T18:27:04Z

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

mananjadhav · 2024-05-26T18:27:47Z

@ishpaul777 You can ignore this PR.

@rushatgabhane @hungvu193 @lakchote This is ready for review.

hungvu193 · 2024-05-27T02:13:41Z

I'm thinking about the way we handle it in our ConnectionLayout, ie we have a props called connection, base on connection we will have shouldBeBlocked condition. So we don't need to update it in every screen we used ConnectionLayout, how do you think? @mananjadhav

hungvu193

Here's my idea. Let's me know what you think

hungvu193 · 2024-05-27T02:25:36Z

src/components/ConnectionLayout.tsx

+    shouldBeBlocked?: boolean;
 };


Suggested change

shouldBeBlocked?: boolean;

};

shouldBeBlocked?: boolean;

/** Name of the current connection **/

connectionName: 'xero' | 'quickbooksOnline';

};

hungvu193 · 2024-05-27T02:26:06Z

src/components/ConnectionLayout.tsx

@@ -77,6 +80,7 @@ function ConnectionLayout({
    titleStyle,
    shouldIncludeSafeAreaPaddingBottom,
    shouldUseScrollView = true,
+    shouldBeBlocked = false,
 }: ConnectionLayoutProps) {
    const {translate} = useLocalize();



Suggested change

const policy = PolicyUtils.getPolicy(policyID ?? '');

const isConnectionEmpty = isEmpty(policy.connections?.[connectionName]);

hungvu193 · 2024-05-27T02:26:19Z

src/components/ConnectionLayout.tsx

@@ -97,6 +101,7 @@ function ConnectionLayout({
            policyID={policyID}
            accessVariants={accessVariants}
            featureName={featureName}
+            shouldBeBlocked={shouldBeBlocked}


Suggested change

shouldBeBlocked={shouldBeBlocked}

shouldBeBlocked={shouldBeBlocked || isConnectionEmpty}

lakchote · 2024-05-27T03:26:31Z

I'm thinking about the way we handle it in our ConnectionLayout, ie we have a props called connection, base on connection we will have shouldBeBlocked condition. So we don't need to update it in every screen we used ConnectionLayout, how do you think? @mananjadhav

I like that idea, to prevent repeating code and adhere to the DRY principle.

mananjadhav · 2024-05-27T07:29:06Z

I think the amount of changes in the files is still the same. But I have updated the code anyway. I've also refactored the XeroImportPage to use ConnectionLayout.

@hungvu193 @lakchote All yours.

hungvu193 · 2024-05-27T08:02:48Z

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

issue with current Android studio.

Android: mWeb Chrome

Uploading mAndroid.mov…

iOS: Native

iOS.mov

iOS: mWeb Safari

mSafari.mov

MacOS: Chrome / Safari

chrome.mov

MacOS: Desktop

desktop.mov

hungvu193

LGTM 🚀

OSBotify · 2024-05-30T21:55:53Z

🚀 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 · 2024-05-30T22:32:23Z

🚀 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 · 2024-06-04T13:58:25Z

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

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

mananjadhav added 4 commits May 25, 2024 23:01

feat: added shouldBeBlocked to ConnectionLayout

26680ab

fix: added checks for connection import pages

1782985

fix: added block check for xero pages

cd23f1c

style: lint fixes

bfcba51

mananjadhav marked this pull request as ready for review May 26, 2024 18:27

mananjadhav requested a review from a team as a code owner May 26, 2024 18:27

melvin-bot bot removed the request for review from a team May 26, 2024 18:27

melvin-bot bot requested a review from ishpaul777 May 26, 2024 18:27

hungvu193 reviewed May 27, 2024

View reviewed changes

mananjadhav added 6 commits May 27, 2024 12:30

refactor: added connection name

bc3c185

refactor: use connection name

a786d30

refactor: use connection name

c77d660

refactor: use connection layout for import page

3430cea

style: lint fixes

11923a4

fix: added connection name to pending pages

7ba4125

hungvu193 approved these changes May 27, 2024

View reviewed changes

melvin-bot bot requested a review from lakchote May 27, 2024 08:03

lakchote approved these changes May 27, 2024

View reviewed changes

lakchote merged commit 063d8d1 into Expensify:xero-merge-freeze May 27, 2024
16 checks passed

github-actions bot mentioned this pull request May 30, 2024

Deploy Checklist: New Expensify 2024-05-30 #42872

Closed

95 tasks

melvin-bot bot mentioned this pull request Jun 4, 2024

[HOLD for payment 2024-06-11] [Xero] Provide access to Xero related screens only if the integration connected is Xero #41726

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Wave collect] [Xero] Block Xero screens if Xero is not connected. #42619

[Wave collect] [Xero] Block Xero screens if Xero is not connected. #42619

mananjadhav commented May 26, 2024 •

edited

Loading

melvin-bot bot commented May 26, 2024

mananjadhav commented May 26, 2024

hungvu193 commented May 27, 2024

hungvu193 left a comment

hungvu193 May 27, 2024

hungvu193 May 27, 2024

hungvu193 May 27, 2024

lakchote commented May 27, 2024

mananjadhav commented May 27, 2024 •

edited

Loading

hungvu193 commented May 27, 2024

hungvu193 left a comment

OSBotify commented May 30, 2024

OSBotify commented May 30, 2024

OSBotify commented Jun 4, 2024


	const policy = PolicyUtils.getPolicy(policyID ?? '');
	const isConnectionEmpty = isEmpty(policy.connections?.[connectionName]);

	shouldBeBlocked={shouldBeBlocked}
	shouldBeBlocked={shouldBeBlocked \|\| isConnectionEmpty}

[Wave collect] [Xero] Block Xero screens if Xero is not connected. #42619

[Wave collect] [Xero] Block Xero screens if Xero is not connected. #42619

Conversation

mananjadhav commented May 26, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented May 26, 2024

mananjadhav commented May 26, 2024

hungvu193 commented May 27, 2024

hungvu193 left a comment

Choose a reason for hiding this comment

hungvu193 May 27, 2024

Choose a reason for hiding this comment

hungvu193 May 27, 2024

Choose a reason for hiding this comment

hungvu193 May 27, 2024

Choose a reason for hiding this comment

lakchote commented May 27, 2024

mananjadhav commented May 27, 2024 • edited Loading

hungvu193 commented May 27, 2024

Reviewer Checklist

Screenshots/Videos

hungvu193 left a comment

Choose a reason for hiding this comment

OSBotify commented May 30, 2024

OSBotify commented May 30, 2024

OSBotify commented Jun 4, 2024

mananjadhav commented May 26, 2024 •

edited

Loading

mananjadhav commented May 27, 2024 •

edited

Loading