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

Update Export Pages for Company Cards to include amendments #40902

Merged
merged 12 commits into from
Apr 25, 2024

Conversation

narefyev91
Copy link
Contributor

@narefyev91 narefyev91 commented Apr 24, 2024

Details

Update Export Pages for Company Cards to include amendments

Fixed Issues

$ #40792
PROPOSAL:

Tests

  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  • Verify that no errors appear in the JS console

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: mWeb Chrome
android-web.mov
iOS: Native
ios.mov
iOS: mWeb Safari
ios-web.mov
MacOS: Chrome / Safari
Screen.Recording.2024-04-24.at.14.12.01.mov
MacOS: Desktop
deskotop.mov

@narefyev91
Copy link
Contributor Author

@hayata-suenaga @s77rt @trjExpensify - first pass!

@narefyev91 narefyev91 requested a review from a team as a code owner April 24, 2024 14:42
@melvin-bot melvin-bot bot requested review from dukenv0307 and removed request for a team April 24, 2024 14:42
Copy link

melvin-bot bot commented Apr 24, 2024

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

@s77rt
Copy link
Contributor

s77rt commented Apr 24, 2024

@dukenv0307 I will review this one as it's part of QBO

@hayata-suenaga
Copy link
Contributor

hayata-suenaga commented Apr 24, 2024

ad hoc build brewing -> https://github.com/Expensify/App/actions/runs/8818710475

the mockups are in this GH issue

src/languages/en.ts Outdated Show resolved Hide resolved
src/languages/en.ts Outdated Show resolved Hide resolved
src/languages/en.ts Outdated Show resolved Hide resolved
src/languages/en.ts Outdated Show resolved Hide resolved
src/languages/en.ts Outdated Show resolved Hide resolved
src/languages/en.ts Outdated Show resolved Hide resolved
Copy link
Contributor

Comment on lines +70 to +71
Connections.updatePolicyConnectionConfig(policyID, CONST.POLICY.CONNECTIONS.NAME.QBO, CONST.QUICK_BOOKS_CONFIG.EXPORT_COMPANY_CARD, row.value);
Connections.updatePolicyConnectionConfig(policyID, CONST.POLICY.CONNECTIONS.NAME.QBO, CONST.QUICK_BOOKS_CONFIG.EXPORT_COMPANY_CARD_ACCOUNT);
Copy link
Contributor

Choose a reason for hiding this comment

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

Each user action should generate at most 1 API call

https://github.com/Expensify/App/blob/main/contributingGuides/API.md

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah - but here we need to set one value - and clean up already existed one from other field @s77rt do we have some examples?

Copy link
Contributor Author

@narefyev91 narefyev91 Apr 24, 2024

Choose a reason for hiding this comment

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

I saw something like this one:
Screenshot 2024-04-24 at 19 21 16
When Onyx is reseting.. but not sure if that works
Also i can move this logic to useEffect, based on prev stored card item and new one, but probably it looks like overkill. Maybe it can be done on BE side @hayata-suenaga - if user change company card - BE automatically clean up selected Account/Vendor. Will it be possible?

Copy link
Contributor

Choose a reason for hiding this comment

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

@aldo-expensify, if we're to follow the 1:1:1 pattern, I think we can create a new Web-E command. What do you think?

Copy link
Contributor

@aldo-expensify aldo-expensify Apr 24, 2024

Choose a reason for hiding this comment

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

So when you set CONST.QUICK_BOOKS_CONFIG.EXPORT_COMPANY_CARD, we have to always clear CONST.QUICK_BOOKS_CONFIG.EXPORT_COMPANY_CARD_ACCOUNT, is that what is happening?

Copy link
Contributor

@aldo-expensify aldo-expensify Apr 24, 2024

Choose a reason for hiding this comment

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

Yes, we have to follow 1:1:1, and I don't think we should go around with a useEffect. I see two options:

Option 1: We keep using UpdatePolicyConnectionConfig and we change the backend to clear CONST.QUICK_BOOKS_CONFIG.EXPORT_COMPANY_CARD_ACCOUNT if CONST.QUICK_BOOKS_CONFIG.EXPORT_COMPANY_CARD is being set. That would mean that we also have to add this exception in Connections.updatePolicyConnectionConfig to create the optimistic data correctly

Option 2: Add a new command

Maybe Option 2 is cleaner to avoid ending up with a bunch of exceptions in UpdatePolicyConnectionConfig

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@aldo-expensify agree with Option 2 - just having one additional command probably will be better solution

Copy link
Contributor

Choose a reason for hiding this comment

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

@hayata-suenaga
Copy link
Contributor

hayata-suenaga commented Apr 24, 2024

@Expensify/design, while we're doing the code review, can you check the design review using the ad hoc build here?

We want to check if the design matches the mockups here

@shawnborton
Copy link
Contributor

Looking at the screenshots... for this one:
CleanShot 2024-04-24 at 13 30 21@2x

If we have a RBR, wouldn't there be an error message below the row too?

Also, the RBR dot feels a bit far away from the right arrow? Is that how the standard component is styled, or something we introduced here?

@dannymcclain
Copy link
Contributor

🙈 @shawnborton @dubielzyk-expensify shouldn't all those hint texts be styled like this?

image

Instead of being totally separated from the push input and in text color?

@shawnborton
Copy link
Contributor

@dannymcclain I totally agree with you - I think the issue we run into is that we don't have this push row component in a good place where the hint text is considered part of the hoverable area. @narefyev91 does that sound right?

Otherwise I totally agree, I would love to make them look like your mocks above!

@trjExpensify
Copy link
Contributor

@dannymcclain I totally agree with you - I think the issue we run into is that we don't have this push row component in a good place where the hint text is considered part of the hoverable area. @narefyev91 does that sound right?

Otherwise I totally agree, I would love to make them look like your mocks above!

If that's the case, should this kind of improvement come separately for all places we have push row+hint text in the app? A little bit mindful of adding a refactor to this PR.

@trjExpensify
Copy link
Contributor

Asked for confirmation on Spanish translations from @Gonals & @pecanoro here.

They might suggest updates in the PR directly.

@narefyev91
Copy link
Contributor Author

Looking at the screenshots... for this one: CleanShot 2024-04-24 at 13 30 21@2x

If we have a RBR, wouldn't there be an error message below the row too?

Also, the RBR dot feels a bit far away from the right arrow? Is that how the standard component is styled, or something we introduced here?

Yeah - the error message should come from API side - and right now it's not in sync for that field - it will be message 100%
Regarding dot - it's our standard component - and nothing was introduced in this PR. I think i will take a look on this during follow up for error message styling @shawnborton

@narefyev91
Copy link
Contributor Author

@dannymcclain I totally agree with you - I think the issue we run into is that we don't have this push row component in a good place where the hint text is considered part of the hoverable area. @narefyev91 does that sound right?

Otherwise I totally agree, I would love to make them look like your mocks above!

Yeah! that's right - hint text is not a part of the hoverable area. We do not have insider MenuItem standard component

@trjExpensify
Copy link
Contributor

Looking at the screenshots... for this one: CleanShot 2024-04-24 at 13 30 21@2x
If we have a RBR, wouldn't there be an error message below the row too?
Also, the RBR dot feels a bit far away from the right arrow? Is that how the standard component is styled, or something we introduced here?

Yeah - the error message should come from API side - and right now it's not in sync for that field - it will be message 100% Regarding dot - it's our standard component - and nothing was introduced in this PR. I think i will take a look on this during follow up for error message styling @shawnborton

Can someone fill me in on what would cause RBR/an error on that field to choose an export method for company card spend? 🤔

src/languages/es.ts Outdated Show resolved Hide resolved
src/languages/es.ts Outdated Show resolved Hide resolved
src/languages/es.ts Outdated Show resolved Hide resolved
src/languages/es.ts Outdated Show resolved Hide resolved
src/languages/es.ts Outdated Show resolved Hide resolved
@narefyev91
Copy link
Contributor Author

Looking at the screenshots... for this one: CleanShot 2024-04-24 at 13 30 21@2x
If we have a RBR, wouldn't there be an error message below the row too?
Also, the RBR dot feels a bit far away from the right arrow? Is that how the standard component is styled, or something we introduced here?

Yeah - the error message should come from API side - and right now it's not in sync for that field - it will be message 100% Regarding dot - it's our standard component - and nothing was introduced in this PR. I think i will take a look on this during follow up for error message styling @shawnborton

Can someone fill me in on what would cause RBR/an error on that field to choose an export method for company card spend? 🤔

Probably if API failed? 500 or something else

narefyev91 and others added 9 commits April 25, 2024 13:55
Co-authored-by: Tom Rhys Jones <[email protected]>
Co-authored-by: Tom Rhys Jones <[email protected]>
Co-authored-by: Tom Rhys Jones <[email protected]>
Co-authored-by: Tom Rhys Jones <[email protected]>
Co-authored-by: Rocio Perez-Cano <[email protected]>
Co-authored-by: Rocio Perez-Cano <[email protected]>
Co-authored-by: Rocio Perez-Cano <[email protected]>
Co-authored-by: Rocio Perez-Cano <[email protected]>
Co-authored-by: Rocio Perez-Cano <[email protected]>
@shawnborton
Copy link
Contributor

Cool, I agree we can look at the hint text improvements as a follow up. Ideally they are part of the hoverable area and sit closer to the push row above them.

@narefyev91 narefyev91 requested review from s77rt and pecanoro April 25, 2024 12:22
Copy link
Contributor

@hayata-suenaga hayata-suenaga left a comment

Choose a reason for hiding this comment

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

deploy will happen soon and this is behind beta
people wants to test before weekend so let's merge

@hayata-suenaga
Copy link
Contributor

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 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(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 form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label 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

@hayata-suenaga hayata-suenaga merged commit 748cc74 into Expensify:main Apr 25, 2024
18 of 19 checks passed
@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/hayata-suenaga in version: 1.4.66-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/hayata-suenaga in version: 1.4.66-0 🚀

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

@OSBotify
Copy link
Contributor

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

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

shouldShowRightIcon
/>
</OfflineWithFeedback>
<ToggleSettingOptionRow
Copy link
Contributor

Choose a reason for hiding this comment

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

The addition of this toggle turned out to have a small UI difference from what design was expecting, leading the following issue:

basically missing shouldPlaceSubtitleBelowSwitch (true) which was rendering the toggle in the center of both title and subtitle container, instead of rendering the subtitle underneath the [title - toggle] container.

Copy link
Contributor

Choose a reason for hiding this comment

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

thank you for fixing it!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

10 participants