Fix the getPolicyName function for when the report or policies are not ready #48621

wildan-m · 2024-09-05T06:57:36Z

Details

Fix concierge chat header on initial login

Fixed Issues

$ #44480
PROPOSAL: #44480 (comment)

Tests

Go to App
Login with a new Gmail account
Complete the onboarding modal requests
Take a look at the Concierge chat header
There should be only Concierge label on Concierge chat header

Verify that no errors appear in the JS console

Offline tests

Should always online

QA Steps

Same as test

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

Kapture.2024-09-10.at.15.48.26.mp4

Android: mWeb Chrome

Kapture.2024-09-10.at.15.50.48.mp4

iOS: Native

Kapture.2024-09-10.at.15.45.49.mp4

iOS: mWeb Safari

Kapture.2024-09-10.at.15.49.24.mp4

MacOS: Chrome / Safari

Kapture.2024-09-10.at.15.42.18.mp4

MacOS: Desktop

Kapture.2024-09-10.at.15.56.43.mp4

melvin-bot · 2024-09-05T06:57:41Z

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

wildan-m · 2024-09-05T07:00:38Z

src/libs/ReportUtils.ts

-
-    if ((!allPolicies || Object.keys(allPolicies).length === 0) && !report?.policyName) {
+    
+    if (isEmptyObject(allPolicies) && !report?.policyName) {


@allgandalf upon further consideration, I believe the second check is unreachable. My suggestion would be to eliminate it. Your thoughts?

Yeah i too checked, it is unreachable , lets remove this

wildan-m · 2024-09-05T07:56:01Z

@allgandalf sorry, need to convert back to draft, I'll need to test more with jest

wildan-m · 2024-09-05T09:55:28Z

@allgandalf My main solution failed the tests due to the possibility of using getPolicyName without any policies, but my other solution (Alternative 3) passed all the tests.

Is it ok to move with my alternative 3 solution?

I haven't jest tested my alternative 1, but seems that will pass all the jest tests as well.

Failed tests

1. opens a chat and load newer messages

App/tests/ui/PaginationTest.tsx

Line 312 in 8a35256

it('opens a chat and load newer messages', async () => {

PolicyExpenseChat > Active > as member

App/tests/unit/ReportUtilsTest.ts

Line 208 in 8a35256

test('as member', () => {

PolicyExpenseChat > Active > as member

App/tests/unit/ReportUtilsTest.ts

Line 246 in 8a35256

test('as member', () => {

renders the policy deleted archive reason as the preview message of the chat

App/tests/unit/SidebarTest.ts

Line 93 in 8a35256

    
           it('renders the policy deleted archive reason as the preview message of the chat', () => {

shubham1206agra · 2024-09-07T15:57:48Z

src/libs/ReportUtils.ts

-    if ((!allPolicies || Object.keys(allPolicies).length === 0) && !report?.policyName) {
+    if (isEmptyObject(allPolicies) && !report?.policyName) {
        return unavailableTranslation;
    }


@wildan-m This whole expression is unreachable.

Yeah, I'm aware of that. This is my latest suggestion.

@allgandalf what is your opinion?

…x/44480-fix-undesired-unavailable-workspace

allgandalf · 2024-09-09T06:08:07Z

@allgandalf My main solution failed the tests due to the possibility of using getPolicyName without any policies, but my other solution (Alternative 3) passed all the tests.

Is it ok to move with my alternative 3 solution?

I haven't jest tested my alternative 1, but seems that will pass all the jest tests as well.

Failed tests

Yes please, lets get this over the line

wildan-m · 2024-09-09T06:24:34Z

@allgandalf The PR has been updated

allgandalf · 2024-09-10T08:27:33Z

@wildan-m can you update your videos with the latest solution please

…x/44480-fix-undesired-unavailable-workspace

wildan-m · 2024-09-10T08:58:48Z

@allgandalf sure, the videos has been updated

allgandalf · 2024-09-11T08:08: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 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-09-11.at.3.30.29.PM.mov

Android: mWeb Chrome

Screen.Recording.2024-09-11.at.3.29.09.PM.mov

iOS: Native

Screen.Recording.2024-09-11.at.3.33.04.PM.mov

iOS: mWeb Safari

Screen.Recording.2024-09-11.at.3.33.38.PM.mov

MacOS: Chrome / Safari

Screen.Recording.2024-09-11.at.3.28.17.PM.mov

MacOS: Desktop

Screen.Recording.2024-09-11.at.3.31.06.PM.mov

allgandalf

Tests well and LGTM

OSBotify · 2024-09-11T10:56:44Z

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

OSBotify · 2024-09-12T21:19:05Z

🚀 Deployed to production by https://github.com/luacmartins in version: 9.0.33-4 🚀

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

Fix getPolicyName when report / policies not ready

db25e26

wildan-m requested a review from a team as a code owner September 5, 2024 06:57

melvin-bot bot requested review from allgandalf and removed request for a team September 5, 2024 06:57

wildan-m mentioned this pull request Sep 5, 2024

[HOLD for payment 2024-09-17][$250] Web - Concierge - Concierge in unavailable workspace when create new account #44480

Closed

6 tasks

wildan-m commented Sep 5, 2024

View reviewed changes

wildan-m added 2 commits September 5, 2024 14:12

lint

3134d83

Add dummy reportID instead of empty

93dbf1a

wildan-m marked this pull request as draft September 5, 2024 07:55

Revert unnecessary changes

d0a5e8b

wildan-m marked this pull request as ready for review September 5, 2024 09:51

shubham1206agra reviewed Sep 7, 2024

View reviewed changes

Merge branch 'main' of https://github.com/wildan-m/App into wildan/fi…

73c2b03

…x/44480-fix-undesired-unavailable-workspace

Change solution that pass all test cases

d49601a

Merge branch 'main' of https://github.com/wildan-m/App into wildan/fi…

06ebc3c

…x/44480-fix-undesired-unavailable-workspace

allgandalf approved these changes Sep 11, 2024

View reviewed changes

melvin-bot bot requested a review from mjasikowski September 11, 2024 10:05

mjasikowski approved these changes Sep 11, 2024

View reviewed changes

mjasikowski merged commit e9642dc into Expensify:main Sep 11, 2024
17 checks passed

github-actions bot mentioned this pull request Sep 11, 2024

Deploy Checklist: New Expensify 2024-09-11 #49025

Closed

49 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix the getPolicyName function for when the report or policies are not ready #48621

Fix the getPolicyName function for when the report or policies are not ready #48621

wildan-m commented Sep 5, 2024 •

edited

Loading

melvin-bot bot commented Sep 5, 2024

wildan-m Sep 5, 2024

allgandalf Sep 9, 2024

wildan-m commented Sep 5, 2024

wildan-m commented Sep 5, 2024 •

edited

Loading

shubham1206agra Sep 7, 2024

wildan-m Sep 9, 2024

allgandalf commented Sep 9, 2024

wildan-m commented Sep 9, 2024

allgandalf commented Sep 10, 2024

wildan-m commented Sep 10, 2024

allgandalf commented Sep 11, 2024 •

edited

Loading

allgandalf left a comment

OSBotify commented Sep 11, 2024

OSBotify commented Sep 12, 2024


		if ((!allPolicies \|\| Object.keys(allPolicies).length === 0) && !report?.policyName) {

		if (isEmptyObject(allPolicies) && !report?.policyName) {

Fix the getPolicyName function for when the report or policies are not ready #48621

Fix the getPolicyName function for when the report or policies are not ready #48621

Conversation

wildan-m commented Sep 5, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Sep 5, 2024

wildan-m Sep 5, 2024

Choose a reason for hiding this comment

allgandalf Sep 9, 2024

Choose a reason for hiding this comment

wildan-m commented Sep 5, 2024

wildan-m commented Sep 5, 2024 • edited Loading

shubham1206agra Sep 7, 2024

Choose a reason for hiding this comment

wildan-m Sep 9, 2024

Choose a reason for hiding this comment

allgandalf commented Sep 9, 2024

wildan-m commented Sep 9, 2024

allgandalf commented Sep 10, 2024

wildan-m commented Sep 10, 2024

allgandalf commented Sep 11, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

allgandalf left a comment

Choose a reason for hiding this comment

OSBotify commented Sep 11, 2024

OSBotify commented Sep 12, 2024

wildan-m commented Sep 5, 2024 •

edited

Loading

wildan-m commented Sep 5, 2024 •

edited

Loading

allgandalf commented Sep 11, 2024 •

edited

Loading