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

[Debug Mode] Show reason for RBR/GBR on LHN tabs #49962

Conversation

pac-guerreiro
Copy link
Contributor

@pac-guerreiro pac-guerreiro commented Sep 30, 2024

Details

Fixed Issues

$#49600
PROPOSAL: N/A

Tests

To trigger a GBR in Inbox

Make sure there are no reports with RBR

  1. Open any report from Inbox page
  2. Click on the + on the chat editor and select Assign Task
  3. Fill all the necessary data and assign the task to your self
  4. The inbox should now show a green indicator and a message saying 'There's a report awaiting action' above the bottom bar
  5. Open another report, then click on View button after the message
  6. You should be redirected to the report where you assigned the task to yourself
To trigger a RBR in Inbox
  1. Create a new expense
  2. Remove a required property from expense (e.g. Category)
  3. The inbox indicator should be red
  4. A message saying 'There's a report with errors' should be shown above the bottom bar
  5. If you click on View, you should be redirected to the expense report
To trigger a GBR in Settings
  1. Go to Profile, then open Contact method
  2. Add new contact method
  3. The new contact method should show a GBR indicator, so as settings avatar in the bottom bar
  4. A message saying 'A contact method requires verification' should be displayed above the bottom bar
  5. If you click on View, you should be redirected to the contact method page
To trigger a RBR in Settings
  1. Go to Profile, then open Contact method
  2. Add new contact method
  3. During verification phase enter any code, then continue
  4. The new contact method should show a RBR indicator, so as settings avatar in the bottom bar
  5. A message saying 'There's a problem with a contact method' should be displayed above the bottom bar
  6. If you click on View, you should be redirected to the contact method page

Offline tests

Same as 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.-.Native.mp4
Android: mWeb Chrome
Android.-.Chrome.mp4
iOS: Native
iOS.-.Native.mp4
iOS: mWeb Safari
iOS.-.Safari.mp4
MacOS: Chrome / Safari
MacOS.-.Chrome.mp4
MacOS: Desktop
MacOS.-.Native.mp4

@pac-guerreiro
Copy link
Contributor Author

I need to add unit tests for the new hook that I created - useSettingsStatus - to make sure that it's working property since I extracted it's logic from Indicator.tsx, so it could be reused in debug mode.

Besides this, I also have to:

  • Finish english translations
  • Translate english to spanish
  • Make useSettingsStatus return and optional policyID which is necessary to redirect user's to the policy pages that contain errors or require attention
  • Test if the translations fit in the UI
  • Take screenshots and add them to the PR
  • Add testing steps to the PR

@pac-guerreiro
Copy link
Contributor Author

pac-guerreiro commented Oct 1, 2024

Today's update:

  • Finish english translations
  • Make useSettingsStatus return and optional policyID which is necessary to redirect user's to the policy pages that contain errors or require attention
  • STARTED Add unit tests for useSettingStatus hook

To continue tomorrow:

  • Add unit tests for useSettingStatus hook
  • Translate english to spanish
  • Test if the translations fit in the UI
  • Take screenshots and add them to the PR
  • Add testing steps to the PR

Copy link
Contributor

@fabioh8010 fabioh8010 left a comment

Choose a reason for hiding this comment

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

Partial review

src/libs/WorkspacesSettingsUtils.ts Outdated Show resolved Hide resolved
src/CONST.ts Outdated Show resolved Hide resolved
src/hooks/useSettingsStatus.ts Outdated Show resolved Hide resolved
src/languages/en.ts Outdated Show resolved Hide resolved
…rbr-gbr-on-lhn-tabs

# Conflicts:
#	src/CONST.ts
#	src/languages/en.ts
#	src/libs/Navigation/AppNavigator/createCustomBottomTabNavigator/BottomTabBar.tsx
@pac-guerreiro
Copy link
Contributor Author

Today's update:

  • Add unit tests for useSettingStatus hook
  • Addressed @fabioh8010's feedback

To continue tomorrow:

  • Translate english to spanish
  • Test if the translations fit in the UI
  • Take screenshots and add them to the PR
  • Add testing steps to the PR

@pac-guerreiro
Copy link
Contributor Author

Today's update:

  • Improved english translations
  • Fixed wrong routes being used for contact method error or info
  • Fixed GBR/RBR message not fitting in the UI

Todo:

  • Test subscription GBR/RBR, reimbursement account RBR, workspace employee list RBR and workspace custom unit RBR
  • Translate english to spanish
  • Take screenshots and add them to the PR
  • Add testing steps to the PR

src/hooks/useIndicatorStatus.ts Outdated Show resolved Hide resolved
src/hooks/useIndicatorStatus.ts Outdated Show resolved Hide resolved
src/hooks/useIndicatorStatus.ts Outdated Show resolved Hide resolved
src/hooks/useIndicatorStatus.ts Outdated Show resolved Hide resolved
src/libs/WorkspacesSettingsUtils.ts Outdated Show resolved Hide resolved
src/libs/WorkspacesSettingsUtils.ts Outdated Show resolved Hide resolved
tests/unit/useIndicatorStatusTest.tsx Outdated Show resolved Hide resolved
@pac-guerreiro
Copy link
Contributor Author

I forgot to leave my update yesterday, here it is:

  • Test subscription GBR/RBR, reimbursement account RBR, workspace employee list RBR and workspace custom unit RBR
  • Improve english translations
  • Translate english to spanish
  • Apply @fabioh8010's feedback

Todo:

  • Take screenshots and add them to the PR
  • Add testing steps to the PR

@pac-guerreiro pac-guerreiro changed the title [WIP] [Debug Mode] Show reason for RBR/GBR on LHN tabs [Debug Mode] Show reason for RBR/GBR on LHN tabs Oct 14, 2024
@pac-guerreiro
Copy link
Contributor Author

All tasks done. This PR is now ready for review!

@pac-guerreiro
Copy link
Contributor Author

@fabioh8010

Thanks for the feedback!

@DylanDylann

Waiting for your review when you're available 😄

@pac-guerreiro
Copy link
Contributor Author

Still waiting on final review from @DylanDylann

1 similar comment
@pac-guerreiro
Copy link
Contributor Author

Still waiting on final review from @DylanDylann

@DylanDylann
Copy link
Contributor

Screen.Recording.2024-10-17.at.09.41.43.mov

Let's use text color to be suitable with the background color

const transactionViolations = useOnyx(ONYXKEYS.COLLECTION.TRANSACTION_VIOLATIONS);
const [chatTabBrickRoad, setChatTabBrickRoad] = useState<BrickRoad>(getChatTabBrickRoad(activeWorkspaceID));

useEffect(() => {
setChatTabBrickRoad(getChatTabBrickRoad(activeWorkspaceID));
}, [activeWorkspaceID, transactionViolations]);
}, [activeWorkspaceID, transactionViolations, reports, reportActions]);
Copy link
Contributor

Choose a reason for hiding this comment

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

Nice change 🥇

@@ -5573,6 +5572,22 @@ const translations = {
hasChildReportAwaitingAction: 'Informe secundario pendiente de acción',
hasMissingInvoiceBankAccount: 'Falta la cuenta bancaria de la factura',
},
indicatorStatus: {
Copy link
Contributor

Choose a reason for hiding this comment

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

@pac-guerreiro NAB: Did you confirm these translations?

Copy link
Contributor Author

@pac-guerreiro pac-guerreiro Oct 17, 2024

Choose a reason for hiding this comment

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

@DylanDylann thanks for the reminder! I just requested confirmation on expensify-open-source 😄

- Fix text color in debug tab view when using light theme
- Update route for custom units error
@pac-guerreiro
Copy link
Contributor Author

@DylanDylann all feedback addressed!

I'll let you know when someone confirms the spanish translations 😄

@DylanDylann
Copy link
Contributor

@pac-guerreiro We have conflicts, please help to resolve it

@DylanDylann
Copy link
Contributor

DylanDylann commented Oct 18, 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
Screen.Recording.2024-10-18.at.10.50.23.mov
Android: mWeb Chrome
Screen.Recording.2024-10-18.at.10.46.20.mov
iOS: Native
Screen.Recording.2024-10-18.at.10.50.08.mov
iOS: mWeb Safari
Screen.Recording.2024-10-18.at.10.47.40.mov
MacOS: Chrome / Safari
Screen.Recording.2024-10-18.at.10.44.13.mov
MacOS: Desktop
Screen.Recording.2024-10-18.at.10.44.43.mov

…rbr-gbr-on-lhn-tabs

# Conflicts:
#	src/libs/Navigation/AppNavigator/createCustomBottomTabNavigator/BottomTabBar.tsx
@pac-guerreiro
Copy link
Contributor Author

@DylanDylann I just resolved the conflict and applied a fix for the problem you encountered 😄

@melvin-bot melvin-bot bot requested a review from puneetlath October 18, 2024 11:15
@pac-guerreiro
Copy link
Contributor Author

pac-guerreiro commented Oct 19, 2024

Thank you @DylanDylann for the review! 😄 The spanish translations were confirmed by @Gonals 🙌

The PR is ready to be merged!

Copy link
Contributor

@puneetlath puneetlath left a comment

Choose a reason for hiding this comment

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

This looks great and very thorough. Thank you!

@puneetlath puneetlath merged commit 9147240 into Expensify:main Oct 21, 2024
17 checks passed
@melvin-bot melvin-bot bot added the Emergency label Oct 21, 2024
Copy link

melvin-bot bot commented Oct 21, 2024

@puneetlath looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

@puneetlath
Copy link
Contributor

Hmm, all the tests are passing.

@OSBotify
Copy link
Contributor

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

Copy link
Contributor

🚀 Deployed to staging by https://github.com/puneetlath in version: 9.0.52-0 🚀

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

Copy link
Contributor

🚀 Deployed to production by https://github.com/yuwenmemon in version: 9.0.52-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.

5 participants