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

Show join button in the chat header #33791

Merged
merged 5 commits into from
Jan 3, 2024

Conversation

bernhardoj
Copy link
Contributor

Details

We want to show a join button in the chat header.

Fixed Issues

$ #33577
PROPOSAL: #33577 (comment)

Tests

Same as QA Steps

  • Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

  1. Open a policy room chat
  2. Send any message
  3. In the message context menu, press "Unsubscribe from the thread" (you are automatically subscribed to your own message)
  4. In the message context menu, press "Reply in thread"
  5. In the thread chat header, verify there is a "Join" button (on web/desktop, the button is to the left of 3-dot, on mobile devices, the button is below the header title and avatar)
  6. Press the "Join" button and verify it disappears
  7. Press the 3-dot button and choose "Leave". You will be redirected to the concierge chat (I expect it to return to parent chat, maybe this is a bug)
  8. Go back to the room chat and repeat steps 4-5

(NOTE: if you press back from the concierge chat, you will see the thread chat again and if you try to press Join, it will fail. The BE response said it's because the report doesn't exist anymore, as shown on the iOS recording below, so make sure to reopen the thread chat from the room chat by following step 8)

  • 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.2023-12-30.at.12.23.40.mov
Android: mWeb Chrome
Screen.Recording.2023-12-30.at.12.19.13.mov
iOS: Native
Screen.Recording.2023-12-30.at.12.24.44.mov
iOS: mWeb Safari
Screen.Recording.2023-12-30.at.12.20.26.mov
MacOS: Chrome / Safari
Screen.Recording.2023-12-30.at.12.16.44.mov
MacOS: Desktop
Screen.Recording.2023-12-30.at.12.17.16.mov

@bernhardoj bernhardoj requested a review from a team as a code owner December 30, 2023 04:40
@melvin-bot melvin-bot bot requested review from abdulrahuman5196 and removed request for a team December 30, 2023 04:40
Copy link

melvin-bot bot commented Dec 30, 2023

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

</View>
{canJoin && isSmallScreenWidth && <View style={[styles.ph5, styles.pb2]}>{joinButton}</View>}
</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.

This looks like so many changes, but it just changing

from

<View style={[styles.appContentHeader, shouldShowBorderBottom && styles.borderBottom]}
            dataSet={{dragArea: true}}>
     ... (unchanged)
</View>

to

<View style={[shouldShowBorderBottom && styles.borderBottom]}  dataSet={{dragArea: true}}>
    <View style={[styles.appContentHeader]}>
        ... (unchanged)
    </View>
    {join button for small screen)
</View>

Copy link
Contributor

@abdulrahuman5196 abdulrahuman5196 Jan 2, 2024

Choose a reason for hiding this comment

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

Thank you for the reference. This seems to better approach than task button which is existing now, since for small screen we render the task button from ReportScreen and non-small screen we render the task button from HeaderView.
I think in future we should have standard component to render these kind of buttons and their logic.

icon: Expensicons.ChatBubbles,
text: translate('common.leave'),
onSelected: Session.checkIfActionIsAllowed(() => Report.leaveRoom(props.report.reportID, isWorkspaceMemberLeavingWorkspaceRoom)),
});
}
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Because we need the canJoin condition to show the Join button, I guess it's better to create canLeave too to store the leave visibility condition.

Report.updateNotificationPreference(props.report.reportID, props.report.notificationPreference, CONST.REPORT.NOTIFICATION_PREFERENCE.ALWAYS, false),
)}
/>
);
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 don't think it's worth to create a separate component for join button (like task button), so I just put it here.

@bernhardoj
Copy link
Contributor Author

A question:

Because now we put a Join button on the header, do we still need the Join menu item on 3-dot?
image

@abdulrahuman5196 @srikarparsi

@srikarparsi
Copy link
Contributor

Yes, we should take it out of the 3-dot menu

@bernhardoj
Copy link
Contributor Author

Thanks, updated
image

@quinthar
Copy link
Contributor

Because now we put a Join button on the header, do we still need the Join menu item on 3-dot?
I think we should leave it in the overflow menu; a little redundant, but that's where we're putting "leave", so it will be good to mirror it.

@bernhardoj bernhardoj force-pushed the fix/33577-show-join-button branch from aa2c196 to e76361b Compare December 31, 2023 06:42
@bernhardoj
Copy link
Contributor Author

but that's where we're putting "leave", so it will be good to mirror it.

I think so too, added it back.

@abdulrahuman5196
Copy link
Contributor

Reviewing now

@abdulrahuman5196
Copy link
Contributor

@bernhardoj Typescript checks are failing

@bernhardoj
Copy link
Contributor Author

Unit test fails on main

@abdulrahuman5196
Copy link
Contributor

Reviewing now

@abdulrahuman5196
Copy link
Contributor

@bernhardoj I see an issue where the join button is flickering when we leave.

Screen.Recording.2024-01-02.at.2.12.58.PM.mov

@bernhardoj
Copy link
Contributor Author

@abdulrahuman5196 the join button shows because you leave the room.

@abdulrahuman5196
Copy link
Contributor

@abdulrahuman5196 the join button shows because you leave the room.

Got it. It visually seems flickering, but it's actually switching chat which has the join button to chat without join button.

@abdulrahuman5196
Copy link
Contributor

abdulrahuman5196 commented Jan 2, 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 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
Screen.Recording.2024-01-02.at.6.52.33.PM.mp4
Android: mWeb Chrome
Screen.Recording.2024-01-02.at.6.54.50.PM.mp4
iOS: Native
Screen.Recording.2024-01-02.at.6.44.29.PM.mp4
iOS: mWeb Safari
Screen.Recording.2024-01-02.at.6.49.48.PM.mp4
MacOS: Chrome / Safari
Screen.Recording.2024-01-02.at.6.10.22.PM.mp4
MacOS: Desktop
Screen.Recording.2024-01-02.at.6.11.22.PM.mp4

@abdulrahuman5196
Copy link
Contributor

@bernhardoj Unit test failure has been fixed in main. Could you kindly do a merge from main, so that all tests pass?

@bernhardoj
Copy link
Contributor Author

@abdulrahuman5196 done 👍

@abdulrahuman5196
Copy link
Contributor

And a note on QA tests, for me Join or Leave only appears if the thread has a child message. Same in staging as well.

Copy link
Contributor

@abdulrahuman5196 abdulrahuman5196 left a comment

Choose a reason for hiding this comment

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

Changes looks good and works well. Reviewers checklist is also complete.

All yours. @srikarparsi

🎀 👀 🎀
C+ Reviewed

@melvin-bot melvin-bot bot requested a review from srikarparsi January 2, 2024 13:45
icon: Expensicons.ChatBubbles,
text: translate('common.join'),
onSelected: Session.checkIfActionIsAllowed(() =>
Report.updateNotificationPreference(props.report.reportID, props.report.notificationPreference, CONST.REPORT.NOTIFICATION_PREFERENCE.ALWAYS, false),
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we add , props.report.parentReportID, props.report.parentReportActionID) as the fifth and sixth parameters of updateNotificationPreference so that the bell icon updates optimistically?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

@bernhardoj
Copy link
Contributor Author

@srikarparsi Hmm, the reassure pass when I ran it locally. Can you help re-run the CI job for reassure, please?

@srikarparsi
Copy link
Contributor

Changes look good, thank you, re-running tests

Copy link
Contributor

@srikarparsi srikarparsi left a comment

Choose a reason for hiding this comment

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

lgtm!

@srikarparsi srikarparsi merged commit 5462451 into Expensify:main Jan 3, 2024
14 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Jan 3, 2024

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

@situchan situchan mentioned this pull request Jan 4, 2024
58 tasks
@OSBotify
Copy link
Contributor

OSBotify commented Jan 4, 2024

🚀 Deployed to staging by https://github.com/srikarparsi in version: 1.4.22-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Jan 4, 2024

🚀 Deployed to staging by https://github.com/srikarparsi in version: 1.4.22-0 🚀

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

@cristipaval
Copy link
Contributor

I might be wrong, but it seems that since this was deployed to staging, there are some use cases when the App sends 0 as the value for reportID param to the command UpdateReportNotificationPreference. Sample of logs here and here

@bernhardoj
Copy link
Contributor Author

Hmm, the code for joining the thread stays the same, that is by sending the current report reportID. If the reportID is 0, the header won't show, so I think there is no way of joining a thread with a reportID of 0 in a normal way.

@OSBotify
Copy link
Contributor

OSBotify commented Jan 9, 2024

🚀 Deployed to production by https://github.com/thienlnam in version: 1.4.22-6 🚀

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

</View>
{canJoin && isSmallScreenWidth && <View style={[styles.ph5, styles.pb2]}>{joinButton}</View>}
Copy link
Contributor

@s77rt s77rt Feb 2, 2024

Choose a reason for hiding this comment

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

The join button should be displayed only if isLoading if false (Coming from #34820)

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