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

#37605 Do not show "member not found" when loading member list #37731

Merged

Conversation

burczu
Copy link
Contributor

@burczu burczu commented Mar 5, 2024

Details

This PR fixes the issue with showing the header message of the Selection List before the list is loaded.

Fixed Issues

$ #37605
PROPOSAL: n/a

Tests

  1. Log in to the app
  2. Open any workspace
  3. Open members list
  4. Observe that the "Member not found" message doesn't shows up while the list shows the loader
  • Verify that no errors appear in the JS console

Offline tests

Same as above.

QA Steps

Same as above.

  • 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 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 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 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.

Screenshots/Videos

Android: Native
Screen.Recording.2024-03-05.at.12.16.37.mov
Android: mWeb Chrome
Screen.Recording.2024-03-05.at.12.17.23.mov
iOS: Native
Screen.Recording.2024-03-05.at.12.04.38.mov
iOS: mWeb Safari
Screen.Recording.2024-03-05.at.12.06.06.mov
MacOS: Chrome / Safari
Screen.Recording.2024-03-05.at.11.54.35.mov
MacOS: Desktop
Screen.Recording.2024-03-05.at.11.56.19.mov

@burczu burczu requested a review from a team as a code owner March 5, 2024 11:17
@melvin-bot melvin-bot bot requested review from aimane-chnaif and removed request for a team March 5, 2024 11:17
Copy link

melvin-bot bot commented Mar 5, 2024

@aimane-chnaif 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]

luacmartins
luacmartins previously approved these changes Mar 5, 2024
Copy link
Contributor

@luacmartins luacmartins left a comment

Choose a reason for hiding this comment

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

LGTM and tests well

@luacmartins
Copy link
Contributor

@aimane-chnaif all yours

@@ -422,7 +422,7 @@ function BaseSelectionList<TItem extends ListItem>(
/>
</View>
)}
{!!headerMessage && (
{!!headerMessage && !showLoadingPlaceholder && (
Copy link
Contributor

Choose a reason for hiding this comment

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

This changes affects all pages where SelectionList is used. This is not safe change.
I suggest to hide header message only when loading skeleton shows.

Suggested change
{!!headerMessage && !showLoadingPlaceholder && (
{!!headerMessage && !(flattenedSections.allOptions.length === 0 && showLoadingPlaceholder) && (

Or define shouldShowSkeletonView variable and update to !!headerMessage && !shouldShowSkeletonView

Copy link
Contributor

Choose a reason for hiding this comment

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

@burczu bump on the comment above

Copy link
Contributor Author

@burczu burczu Mar 8, 2024

Choose a reason for hiding this comment

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

@aimane-chnaif You may be right this is not the place for this change but your proposed change does not fix the root issue we want to address with this PR - the message is visible while loading members for some short period. I think I need to find completely different approach to fix this - I'll try to fix it today then.

Copy link
Contributor Author

@burczu burczu Mar 8, 2024

Choose a reason for hiding this comment

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

@aimane-chnaif I've changed the approach by introducing new prop in the BaseSelectionList component called notFoundMessage - this way we can threat this special message separately and show it only after loading process is finished (if there is no items loaded). Other messages could show up even while loading, as it was before.

What do you think?

Copy link
Contributor

Choose a reason for hiding this comment

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

How about fixing this in WorkspaceMembersPage only, instead of introducing new prop in this base component?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@aimane-chnaif I've tried and the message is shown for some milliseconds no matter what condition I use - I think because the beginning state of the list is loading, only fixing it in this component fixes the issue...

</View>
)}
{!!headerMessage && renderTopMessage(headerMessage)}
{!!notFoundMessage && !showLoadingPlaceholder && !sections.some((item) => item.data.length > 0) && renderTopMessage(notFoundMessage)}
Copy link
Contributor

Choose a reason for hiding this comment

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

!sections.some((item) => item.data.length > 0) - is this condition different from flattenedSections.allOptions.length === 0 which was used to show skeleton view?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@aimane-chnaif no difference from what I see - I can use it instead if you like

Copy link
Contributor Author

Choose a reason for hiding this comment

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

changed

Comment on lines 432 to 433
{!!headerMessage && renderTopMessage(headerMessage)}
{!!notFoundMessage && !showLoadingPlaceholder && flattenedSections.allOptions.length === 0 && renderTopMessage(notFoundMessage)}
Copy link
Contributor

Choose a reason for hiding this comment

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

I am not sure about the case when 2 messages show at the same time.
But swap these rows so not found message should be above header message.

Or hide header message when not found message shows.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

swapped

@aimane-chnaif
Copy link
Contributor

Sorry for back and forth but I personally like what I suggested before - #37731 (comment)

Please check this:

main:
Screenshot 2024-03-08 at 11 23 22 AM

this branch:
Screenshot 2024-03-08 at 11 22 45 AM

@aimane-chnaif
Copy link
Contributor

We should not show not found message when we don't know yet how many members

@burczu
Copy link
Contributor Author

burczu commented Mar 8, 2024

@aimane-chnaif no worries - this issue is kind of tricky... I've checked what you proposed in this comment in a first place and the Not found message was glitching while the loader was visible, so this is not our solution...

@aimane-chnaif
Copy link
Contributor

@aimane-chnaif no worries - this issue is kind of tricky... I've checked what you proposed in this comment in a first place and the Not found message was glitching while the loader was visible, so this is not our solution...

ok

@burczu
Copy link
Contributor Author

burczu commented Mar 8, 2024

@aimane-chnaif I think the best would be to just introduce some isLoading variable inside the policyMembers ONYX key, that would be set to true at the beginning and set to false once loading the data is finished and rely on this value in WorkspaceMemberPage - simple Old School way of doing this ;)

@aimane-chnaif
Copy link
Contributor

aimane-chnaif commented Mar 8, 2024

@aimane-chnaif I think the best would be to just introduce some isLoading variable inside the policyMembers ONYX key, that would be set to true at the beginning and set to false once loading the data is finished and rely on this value in WorkspaceMemberPage - simple Old School way of doing this ;)

When policyMembers is empty, it means members are not fetched yet.
As myself (admin) is always in members list, there's no case of empty members list after fetched.

So !isOffline && isEmptyObject(policyMembers) is equivalent to isLoading what you suggested.

@aimane-chnaif
Copy link
Contributor

Actually, I found interesting thing.
When should we show Member not found message on this page?
I don't find any case as myself is always a member of workspace.
It makes sense to show this message when there are no other members except me, but this is not current logic.
cc: @luacmartins

@aimane-chnaif
Copy link
Contributor

Yeah, the owner can't be also removed, as I understand. Are you saying we should never show this message here?

yes unless we wanna update logic to

It makes sense to show this message when there are no other members except me

@burczu
Copy link
Contributor Author

burczu commented Mar 8, 2024

@aimane-chnaif I think I've fixed it - you are right with this condition but I've used it incorrectly (silly mistake). The condition is an equivalent of isLoading as you've said, but I had to check for !isLoading && isEmptyObject(policyMembers)... Please re-test. Thanks

@burczu burczu requested a review from aimane-chnaif March 8, 2024 11:24
@aimane-chnaif
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
mchrome.mov
iOS: Native
ios.mov
iOS: mWeb Safari
msafari.mov
MacOS: Chrome / Safari
web.mov
MacOS: Desktop
desktop.mov

@melvin-bot melvin-bot bot requested a review from luacmartins March 8, 2024 11:58
@luacmartins luacmartins merged commit c387241 into Expensify:main Mar 8, 2024
16 checks passed
@OSBotify
Copy link
Contributor

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

4 participants