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

23298 - Desktop - Unable to move click>dragging the header in desktop app #24098

Merged

Conversation

Skalakid
Copy link
Contributor

@Skalakid Skalakid commented Aug 3, 2023

Details

Fixed Issues

$ #23298
PROPOSAL: #23298 (comment)

Tests

  1. Open desktop app
  2. Log in
  3. Try to move the app window by dragging the frame at the top. Dragging when holding buttons shouldn't work, since it is blocked by Electron.
  • Verify that no errors appear in the JS console

Offline tests

Same as Tests

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

N/A

Mobile Web - Chrome

N/A

Mobile Web - Safari

N/A

Desktop
desktop.mov
iOS

N/A

Android

N/A

@Skalakid Skalakid requested a review from a team as a code owner August 3, 2023 09:54
@melvin-bot melvin-bot bot requested review from Santhosh-Sellavel and removed request for a team August 3, 2023 09:54
@melvin-bot
Copy link

melvin-bot bot commented Aug 3, 2023

@Santhosh-Sellavel 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]

Comment on lines 18 to 19
dataSet={{id: 'pressable'}}
className="ASDASD"
Copy link
Collaborator

Choose a reason for hiding this comment

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

Why do we need this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

oh my bad, I accidentally committed it

@Santhosh-Sellavel
Copy link
Collaborator

@Skalakid Did some testing, mostly works well.

But I noticed a weird issue clicking above the header area doesn't dismiss the RHN, post this change.

Screen.Recording.2023-08-04.at.12.12.35.AM.mov

@Skalakid
Copy link
Contributor Author

Skalakid commented Aug 4, 2023

@Santhosh-Sellavel I removed unnecessary code and fixed the bug you mentioned

@Santhosh-Sellavel
Copy link
Collaborator

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 / Chrome
    • iOS / native
    • iOS / 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(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 reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Desktop
Screen.Recording.2023-08-07.at.1.06.30.AM.mov
Web
Screen.Recording.2023-08-07.at.1.09.07.AM.mov

Copy link
Collaborator

@Santhosh-Sellavel Santhosh-Sellavel left a comment

Choose a reason for hiding this comment

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

LGTM tests well, thanks!

All yours @roryabraham

@melvin-bot melvin-bot bot requested a review from roryabraham August 6, 2023 19:43
@Santhosh-Sellavel
Copy link
Collaborator

bump @roryabraham!

Copy link
Contributor

@roryabraham roryabraham left a comment

Choose a reason for hiding this comment

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

This seems like it leverages an internal implementation detail of react-native-web and thus is going to be unstable / subject to change w/o warning.

Instead, can we:

  1. Use data attributes instead of ID for drag-area? Technically HTML documents aren't supposed to have multiple elements with the same ID, right?
  2. Add a custom data attribute in GenericPressable such that all Pressable components in our app are guaranteed to have that attribute unless we change/remove it, instead of leveraging the touchAction class that's currently added to pressables by react-native-web?

@Skalakid
Copy link
Contributor Author

Skalakid commented Aug 8, 2023

@roryabraham agreed! I've added the requested changes

roryabraham
roryabraham previously approved these changes Aug 8, 2023
@roryabraham
Copy link
Contributor

LGTM, @Santhosh-Sellavel can you re-review please since there have been significant changes?

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented Aug 8, 2023

Can not drag while RHN is open while dragging using a header area not part of RHN? It was working before this PR

Screen.Recording.2023-08-09.at.5.04.54.AM.mov

@@ -71,6 +71,7 @@ function ThreePaneView(props) {
onPress={() => props.navigation.goBack()}
accessibilityLabel={translate('common.close')}
accessibilityRole={CONST.ACCESSIBILITY_ROLE.BUTTON}
noDragArea
Copy link
Collaborator

Choose a reason for hiding this comment

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

This change causing this issue

@Skalakid
Copy link
Contributor Author

Skalakid commented Aug 9, 2023

Can not drag while RHN is open while dragging using a header area not part of RHN? It was working before this PR

@Santhosh-Sellavel @roryabraham This bug appears because, in the latest Electron version, Pressable components can't be both clickable and draggable. The dimmed dismiss modal area takes the whole space on the left and it is a Pressable. Before adding noDragArea the draggable areas were inherited from the components below, so you could only drag at the top where there wasn't any button (for example search button). Now with noDragArea on the dimmed area, we can click everywhere and dismiss the modal but we can't move the window.
If we want to enable users to drag the window at the top of dismiss modal area, we can do something like this:

           <View style={[styles.flex1, {paddingTop: 30}]}>
                <PressableWithoutFeedback
                    style={[styles.flex1]}
                    onPress={() => props.navigation.goBack()}
                    accessibilityLabel={translate('common.close')}
                    accessibilityRole={CONST.ACCESSIBILITY_ROLE.BUTTON}
                    noDragArea
                />
           </View>

By adding paddingTop there would be draggable area at the top and a clickable area below it. What do you think about it? Should we add it or leave it like it is?

@Santhosh-Sellavel
Copy link
Collaborator

@Skalakid Adding a paddingTop will it address both problems?
#24098 (comment)
#24098 (comment)

If so let's go with it if not we just have to pick one between the two

@Skalakid
Copy link
Contributor Author

Skalakid commented Aug 10, 2023

@Santhosh-Sellavel Unfortunately no, it will only improve #24098 (comment) since there you could drag on the same area that was under the dimmed area. With the paddingTop you will be able to drag only at the top of the window but everywhere else you will dismiss the modal. What do you think about it?

Example
desktop2.mov

@Skalakid
Copy link
Contributor Author

Skalakid commented Aug 16, 2023

@Santhosh-Sellavel @roryabraham The only problem with paddingTop solution is that we should add it only for desktop app since it can cause some problems in other large-screen devices like for example top part of the dimmed area won't be pressable on web

@Skalakid
Copy link
Contributor Author

I've added similar solution that works on all platforms

Comment on lines 69 to 86
<View style={[styles.flex1, styles.flexColumn]}>
{/* The PressableWithoutFeedback with 30px height was added to make whole dimmed area pressable
on all web devices, but aslo make the top of the desktop apps draggable.
Please remember that in latestest Electron update, buttons can't be both draggable and clickable */}
<PressableWithoutFeedback
style={[styles.w100, {height: 30}]}
onPress={() => props.navigation.goBack()}
accessibilityLabel={translate('common.close')}
accessibilityRole={CONST.ACCESSIBILITY_ROLE.BUTTON}
/>
<PressableWithoutFeedback
style={[styles.flex1]}
onPress={() => props.navigation.goBack()}
accessibilityLabel={translate('common.close')}
accessibilityRole={CONST.ACCESSIBILITY_ROLE.BUTTON}
noDragArea
/>
</View>
Copy link
Collaborator

Choose a reason for hiding this comment

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

@roryabraham are we good with this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

If not we can go with just removing noDragArea and have a draggable area like presented here

Copy link
Contributor

@roryabraham roryabraham left a comment

Choose a reason for hiding this comment

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

If I'm understanding this correctly, it seems fine to me.

Also this seems like such an annoying limitation that Electron imposed on us, idk why they did that...

{/* The PressableWithoutFeedback with 30px height was added to make whole dimmed area pressable
on all web devices, but aslo make the top of the desktop apps draggable.
Please remember that in latestest Electron update, buttons can't be both draggable and clickable */}
<PressableWithoutFeedback
Copy link
Contributor

Choose a reason for hiding this comment

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

So just to be clear, does this mean that this PressableWithoutFeedback w/ static 30px height is draggable but not clickable?

Copy link
Contributor

Choose a reason for hiding this comment

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

(btw if we go with this approach we need to move the style to be in styles.js instead of inline)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@roryabraham yes but only on the desktop app. I put two Pressables to make everything behave like it is one big Pressable (like before it was before) on other devices. But on the desktop app it will have 30px of draggable, not clickable bar at the top

Copy link
Collaborator

@Santhosh-Sellavel Santhosh-Sellavel left a comment

Choose a reason for hiding this comment

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

LGTM, all yours @roryabraham!

@Santhosh-Sellavel
Copy link
Collaborator

@roryabraham bump!

@Skalakid Skalakid force-pushed the 23298-unable-to-move-desktop-window branch from 1a1edea to 309828f Compare August 28, 2023 06:49
@Skalakid
Copy link
Contributor Author

@roryabraham bump

@roryabraham roryabraham merged commit 9b34d34 into Expensify:main Aug 28, 2023
13 checks passed
@OSBotify
Copy link
Contributor

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

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

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/roryabraham in version: 1.3.60-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/roryabraham in version: 1.3.60-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.59-5 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/luacmartins in version: 1.3.60-3 🚀

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