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

Add Context menu with Pin option to LHN #16079

Merged
merged 42 commits into from
Jun 1, 2023
Merged

Add Context menu with Pin option to LHN #16079

merged 42 commits into from
Jun 1, 2023

Conversation

Gonals
Copy link
Contributor

@Gonals Gonals commented Mar 17, 2023

Details

Surrounding the existing TouchableOpacity with a PressableWithSecondaryInteraction component did not work on mobile, as the triggered touch event was the TouchableOpacity one, so I replaced the TouchableOpacity with the PressableWithSecondaryInteraction and gave it opacity capabilities. All working nice now!

Fixed Issues

$ #15960

Tests

  1. Log into NewDot
  2. On the LHN, right click/long press on top of an unpinned chat.
  3. A menu with the pin option should show up. Press it
  4. Confirm it gets pinned
  5. Do the same for a pinned chat and confirm you can unpin it
  6. Open newdot in a different devide and log into the same account.
  7. On Devide 1 right click/long press on top of a chat to display the menu. Leave it open
  8. On Devide 2, pin/unpin the chat for which you open the menu on Device 1.
  9. When the pin status update id Device 1, confirm the menu is automatically closed.
  10. Open a chat and right click/long press one of the messages. Confirm the usual menu shows up as usual and it doesn't have the pin/unpin option.
  11. On that menu, select the "Delete" option and confirm the message is correctly deleted
  12. (On Web/Desktop only) Go to Settings > About > App Download links and right click on one of the links. A menu should show up with just the option to copy the link.
  • Verify that no errors appear in the JS console

Offline tests

Not relevant

QA Steps

Same as tests

  • 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 / 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 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 correct English and 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
    • 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 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 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 Screenshot 2023-03-17 at 4 01 30 PM
Mobile Web - Chrome Screenshot 2023-03-22 at 4 39 00 PM
Mobile Web - Safari Screenshot 2023-03-22 at 4 34 09 PM
Desktop Screenshot 2023-03-17 at 4 02 43 PM
iOS Screenshot 2023-03-22 at 4 33 46 PM
Android Screenshot 2023-03-22 at 4 38 10 PM

@Gonals Gonals requested a review from a team as a code owner March 17, 2023 19:32
@melvin-bot melvin-bot bot requested review from cead22 and removed request for a team March 17, 2023 19:32
@MelvinBot
Copy link

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

@Gonals Gonals changed the title [WIP] Add Context menu with Pin option to LHN Add Context menu with Pin option to LHN Mar 22, 2023
@Gonals
Copy link
Contributor Author

Gonals commented Mar 22, 2023

OFF WIP! All yours @cead22

@cead22
Copy link
Contributor

cead22 commented Mar 23, 2023

I revived this slack discussion because I'm not convinced this is a good change

Copy link
Contributor

@cead22 cead22 left a comment

Choose a reason for hiding this comment

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

I think we this PR should have the following tests, but I'm curious for your thoughts

  • All uses of showContextMenu
  • All uses of PressableWithSecondaryInteraction
  • Deleting a report and make sure nothing breaks since hideDeleteModal changed

src/components/LHNOptionsList/OptionRowLHN.js Outdated Show resolved Hide resolved
@0xmiros
Copy link
Contributor

0xmiros commented Apr 3, 2023

reviewing now

@Gonals
Copy link
Contributor Author

Gonals commented Apr 4, 2023

I think we this PR should have the following tests, but I'm curious for your thoughts

  • All uses of showContextMenu

These changes shouldn't have affected other menus, right? We can add a test to just make sure the new "Pin/Unpin" doesn't show for other menus, but I think it'd be enough to change in any other use of the menu, instead of all of them

  • All uses of PressableWithSecondaryInteraction

Yep. This was a bigger one. Adding tests.

  • Deleting a report and make sure nothing breaks since hideDeleteModal changed

Where did it change? 😕

@Gonals
Copy link
Contributor Author

Gonals commented Jun 1, 2023

Conflicts solved AGAIN!

Copy link
Contributor

@0xmiros 0xmiros left a comment

Choose a reason for hiding this comment

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

👍

@cead22 cead22 merged commit bcf92bb into main Jun 1, 2023
@cead22 cead22 deleted the alberto-pin branch June 1, 2023 16:02
@OSBotify
Copy link
Contributor

OSBotify commented Jun 1, 2023

✋ 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

OSBotify commented Jun 2, 2023

🚀 Deployed to staging by https://github.com/cead22 in version: 1.3.23-0 🚀

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

1 similar comment
@OSBotify
Copy link
Contributor

OSBotify commented Jun 2, 2023

🚀 Deployed to staging by https://github.com/cead22 in version: 1.3.23-0 🚀

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


React.useEffect(() => {
ReportActionContextMenu.hideContextMenu(false);
}, [optionItem.isPinned]);
Copy link
Contributor

Choose a reason for hiding this comment

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

@Gonals we should add null safety check on this line. Sometimes app crashes when logout because optionItem is undefined returning here:

// When a user signs out, Onyx is cleared. Due to the lazy rendering with a virtual list, it's possible for
// this method to be called after the Onyx data has been cleared out. In that case, it's fine to do
// a null check here and return early.
if (!report || !personalDetails) {
return;
}

Copy link
Contributor

Choose a reason for hiding this comment

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

I faced this today

Screenshot 2023-06-05 at 7 53 31 AM

@OSBotify
Copy link
Contributor

OSBotify commented Jun 5, 2023

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.23-7 🚀

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

1 similar comment
@OSBotify
Copy link
Contributor

OSBotify commented Jun 5, 2023

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.23-7 🚀

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

@@ -52,11 +55,16 @@ const defaultProps = {

const OptionRowLHN = (props) => {
const optionItem = SidebarUtils.getOptionData(props.reportID);

React.useEffect(() => {
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 actually not seeing why this is necessary. I removed this and everything seems to work fine.

Copy link
Contributor

Choose a reason for hiding this comment

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

That discussion started from here.
Finally landed on #16079 (comment)

@roryabraham
Copy link
Contributor

I think that using PopoverMenu may have been a more appropriate component than ReportActionContextMenu, which is specifically for ... report actions and their context menus.

{
textTranslateKey: 'common.unPin',
icon: Expensicons.Pin,
shouldShow: (type, reportAction, isArchivedRoom, betas, anchor, isChronosReport, reportID, isPinnedChat) => type === CONTEXT_MENU_TYPES.REPORT && isPinnedChat,
Copy link
Member

Choose a reason for hiding this comment

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

Pin/UnPin options should not be visible on MoneyRequest chats as they are not pinnable. #20255

@abdulrahuman5196
Copy link
Contributor

Minor miss in implementation - Pin/Unpin should have made the composer in focus - #21861

@parasharrajat
Copy link
Member

parasharrajat commented Jul 22, 2023

@abdulrahuman5196 how will this work on Mobile devices. So I don't agree that these unpin/pin should focus on the composer even on web.

@sobitneupane
Copy link
Contributor

This case was not considered while implementing the context menu in Sidebar.

Issue: Context menu from LHN is visible even if report page is opened on resize

Steps to reproduce:

  1. Right click an option in LHN.
  2. Resize the window to small while the popover is still open.

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.