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

Display status emojis in the LHN (including the user's own status) #24414

Merged

Conversation

perunt
Copy link
Contributor

@perunt perunt commented Aug 11, 2023

Details

This is the first part of a series of PRs to implement the UI for the new custom status feature.
It implements the Status option in the profile settings, and the screen to set a status.
As this feature is incomplete yet and build in iterations it will be hidden behind the customStatus beta.

Fixed Issues

$ #23132
PROPOSAL:

Tests

  • Verify that no errors appear in the JS console

Offline tests

QA Steps

Add the customStatus beta to your account or simply let this function return true

Test Steps for Account A:

  1. Log in using Account A.
  2. Navigate to Settings.
  3. Select the Status item.
  4. Choose the desired emoji and accompanying text.
  5. Press Save.
  • Note: By default, the status is set to expire 'by the end of the day,' which means it remains valid until tomorrow.
  1. Return to the main dashboard.
  2. Verify that the chosen emoji now appears next to your avatar.

Test Steps for Account B:

  1. Log in using Account B.
  2. View the chat list on the left panel.
  3. Locate the chat associated with Account A.
  4. Confirm that you can see Account A's status emoji next to their name.
  5. (For Web Only) Hover over the status emoji.
  • Verify that a tooltip appears.
  • Confirm that the text within the tooltip matches what was set by Account A.

Additional Notes:

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 / Chrome
    • iOS / native
    • iOS / 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 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
    • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
    • 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(themeColors.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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web
Untitled.2.mov
Mobile Web - Chrome

photo_2023-08-15 12 43 54

Mobile Web - Safari

Simulator Screen Shot - SE 16 2 - 2023-08-15 at 12 42 05

Desktop

Screenshot 2023-08-15 at 12 45 49

iOS

Simulator Screen Shot - iPhone 14 Pro - 2023-08-15 at 12 59 58

Android

photo_2023-08-15 13 32 30

@perunt perunt marked this pull request as ready for review August 15, 2023 18:10
@perunt perunt requested a review from a team as a code owner August 15, 2023 18:10
@melvin-bot melvin-bot bot requested review from burczu and removed request for a team August 15, 2023 18:54
@melvin-bot
Copy link

melvin-bot bot commented Aug 15, 2023

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

@burczu
Copy link
Contributor

burczu commented Aug 17, 2023

@perunt Please update Tests chapter in your Author Checklist - especially how to set this status to be able to test clicking on it to show the Status Page...

Edit: I've found how to do it here: #23267 but it still needs to be updated here

src/components/LHNOptionsList/OptionRowLHN.js Outdated Show resolved Hide resolved
src/components/LHNOptionsList/OptionRowLHN.js Outdated Show resolved Hide resolved
src/pages/home/sidebar/SidebarLinks.js Outdated Show resolved Hide resolved
src/pages/home/sidebar/SidebarLinks.js Outdated Show resolved Hide resolved
@perunt
Copy link
Contributor Author

perunt commented Aug 17, 2023

@burczu I updated the description and also added the link to the method of how you can change the date manually
you can pass it using this formatting moment(...).format('YYYY-MM-DD HH:mm:ss')

Edit: found an issue with rerendering, will fix it asap

Copy link
Contributor

@burczu burczu left a comment

Choose a reason for hiding this comment

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

Reviewed and tested - I think we are good to go!

@melvin-bot melvin-bot bot requested a review from stitesExpensify August 22, 2023 08:37
@stitesExpensify
Copy link
Contributor

Looking great so far! 2 things that I noticed:

  1. The user's status is not being shown in the LHN:
2023-08-22_15-58-48 2. In @burczu testing videos, the status is showing up on the `#admins` channel which shouldn't happen. The status should only ever show up on DMs. I was not able to repro this so maybe it isn't happening anymore? But something i wanted to call out in case you have an idea how that could happen @perunt
24414-web.mp4

@perunt
Copy link
Contributor Author

perunt commented Aug 23, 2023

I added a check for that second issue. As for the first one, it's unrelated to focus mode like I thought. I can't get it to happen on my end. Would you mind sharing the test account details or that JSON report?

@stitesExpensify
Copy link
Contributor

Hmm there is nothing special about the accounts i'm using. @burczu are you able to see the emojis in 1 from my post above?

@burczu
Copy link
Contributor

burczu commented Aug 24, 2023

@stitesExpensify @perunt Regarding first issue - I think it works correctly: the status icon shows up in LHN only next to items where the current user, that has this status set, is presented:

Screenshot 2023-08-24 at 09 37 39

Screenshot 2023-08-24 at 09 37 59

!isTaskReport(report) && //
isDM(report) &&
!isIOUReport(report) &&
report.participantsList.length === 1
Copy link
Contributor

@burczu burczu Aug 24, 2023

Choose a reason for hiding this comment

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

I don't think this correctly fixes the issue with showing up status icon next to channels like #admins - in my case there is only one admin, and the icons keeps showing up

Copy link
Contributor

Choose a reason for hiding this comment

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

I'm also a bit confused how #admins is passing the other checks here. It should be isDM or !isChatRoom

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I found the issue. The function isChatRoom() doesn't seem to return true even when the report has the field isChatRoom: true 😕

@stitesExpensify
Copy link
Contributor

I think it works correctly: the status icon shows up in LHN only next to items where the current user, that has this status set, is presented:

Hmm something must just be weird on my end then.

Copy link
Contributor

@stitesExpensify stitesExpensify left a comment

Choose a reason for hiding this comment

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

LGTM!

@stitesExpensify stitesExpensify merged commit e7931d2 into Expensify:main Aug 24, 2023
@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.

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/stitesExpensify in version: 1.3.58-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/luacmartins in version: 1.3.58-5 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/stitesExpensify in version: 1.3.59-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/luacmartins in version: 1.3.59-5 🚀

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

</OfflineWithFeedback>
)}
</PressableWithoutFeedback>
<SignInOrAvatarWithOptionalStatus isCreateMenuOpen={this.props.isCreateMenuOpen} />
Copy link
Contributor

@WoLewicki WoLewicki Sep 12, 2023

Choose a reason for hiding this comment

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

@perunt could you elaborate where does this.props.isCreateMenuOpen come from? Or is it always undefined?

Copy link
Contributor Author

@perunt perunt Sep 12, 2023

Choose a reason for hiding this comment

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

Hmm, tbh I didn't dig where it comes from but now I can see that it was undefined
I see that it was removed (isCreateMenuOpen) without cleaning it inside the component
image

Copy link
Contributor

Choose a reason for hiding this comment

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

Ok thanks for the input.

@stitesExpensify
Copy link
Contributor

I think that something broke here. I'm no longer seeing the status in LHN at all @perunt

@perunt
Copy link
Contributor Author

perunt commented Sep 26, 2023

I saw recently the Moment was replaced, it could break it. Let me check
UPD: I've tried, and it works for me. Is it still broken for you?

@stitesExpensify
Copy link
Contributor

2023-09-27_13-47-23

User.clearDraftCustomStatus();
};

const navigateBackToSettingsPage = useCallback(() => Navigation.goBack(ROUTES.SETTINGS_PROFILE, false, true), []);
Copy link
Contributor

Choose a reason for hiding this comment

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

This change created this issue #30509.

<PressableWithoutFeedback
accessibilityLabel={translate('sidebarScreen.buttonMySettings')}
accessibilityRole={CONST.ACCESSIBILITY_ROLE.BUTTON}
onPress={Session.signOutAndRedirectToSignIn}
Copy link
Contributor

Choose a reason for hiding this comment

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

This caused #34764 since signOutAndRedirectToSignIn got the first param as true always. It should have been false instead.

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.

7 participants