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

Ishpaul777/rhn no dropzone #23528

Merged
merged 13 commits into from
Jul 27, 2023
Merged

Conversation

ishpaul777
Copy link
Contributor

@ishpaul777 ishpaul777 commented Jul 25, 2023

Details

Fixed Issues

$ #22305
PROPOSAL: #22305 (comment)

Tests

  • Verify that no errors appear in the JS console
  • Verify user can drop a file on a chat report.
  • Verfify user can't drop file on LHN.
  • Navigate to RHN, Verify user can't drop a file when RHN is open,( if file is dropped no new tab opens)
  • Close RHN, Verify we can drop file on Chat report.

Offline tests

  • Go Offline.
  • Verify user can drop a file on a chat report.
  • Verfify user can't drop file on LHN.
  • Navigate to RHN, Verify user can't drop a file when RHN is open,( if file is dropped no new tab opens)
  • Close RHN, Verify we can drop file on Chat report.

QA Steps

  • Verify that no errors appear in the JS console
  • Verify user can drop a file on a chat report.
  • Verfify user can't drop file on LHN.
  • Navigate to RHN, Verify user can't drop a file when RHN is open,( if file is dropped no new tab opens)
  • Close RHN, Verify we can drop file on Chat report.

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 Mac (chrome)-
mac-chrome.mp4

Mac (safari)-

safari.mp4

Windows (chrome) -

win-chrome.mp4
Mobile Web - Chrome
mobile-web.mp4
Mobile Web - Safari
safari-ios.mp4
Desktop

(Same as before changes)

mac-desktop.mp4
iOS
ios-app.mp4
Android
android.mp4

@ishpaul777 ishpaul777 requested a review from a team as a code owner July 25, 2023 07:32
@melvin-bot melvin-bot bot removed the request for review from a team July 25, 2023 07:32
@melvin-bot
Copy link

melvin-bot bot commented Jul 25, 2023

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

@melvin-bot melvin-bot bot requested a review from robertKozik July 25, 2023 07:32
@robertKozik
Copy link
Contributor

@ishpaul777, ping me when you have completed the checklist and the PR will be ready for review.

@ishpaul777
Copy link
Contributor Author

@robertKozik done! PR is ready.

@ishpaul777
Copy link
Contributor Author

@robertKozik any updates?

@robertKozik
Copy link
Contributor

Sorry, I was focused on other issues. I'll address it tomorrow.

@robertKozik
Copy link
Contributor

BUG: when overing over RHN options with attachments, options are being highlighted (not reproducible on main)

VIDEO:

bug-rhn-highlightling.mov

CC. @ishpaul777

@ishpaul777
Copy link
Contributor Author

ishpaul777 commented Jul 26, 2023

@robertKozik Are you sure this is not reproducable on the main. I can repro on production.

bug.on.prod.mp4

tried a few things to fix it, but couldn't find a satisfactory solution.

@robertKozik
Copy link
Contributor

I see, I'll check it once again, It can by my fault.

But still, I think this PR can try address issue. Can't we disable any pointer interactions on drag?

@ishpaul777
Copy link
Contributor Author

ishpaul777 commented Jul 26, 2023

@robertKozik
I couldn't get to a satisfactory solution for this bug. Love to get your thoughts. Here are potential solutions explored:

  1. used a state to capture whether user is dragging over and when isDraggingOver applied pointerEvents='none' to View.
 <NoDropZone
   key={route.key}
   setIsDraggingOver={setIsDraggingOver}
   isDraggingOver={isDraggingOver}
>
   <View
       pointerEvents={isDraggingOver ? 'none' : 'auto'}
       style={[
           styles.flexRow,
           styles.pAbsolute,
           styles.w100,
           styles.h100,
           StyleUtils.getBackgroundColorWithOpacityStyle(themeColors.shadow, CONST.RIGHT_MODAL_BACKGROUND_OVERLAY_OPACITY),
           StyleUtils.displayIfTrue(props.state.index === i),
       ]}
   >
       <PressableWithoutFeedback
           style={[styles.flex1]}
           onPress={() => props.navigation.goBack()}
           accessibilityLabel={translate('common.close')}
           accessibilityRole={CONST.ACCESSIBILITY_ROLE.BUTTON}
       />
       <View style={styles.rightPanelContainer}>{props.descriptors[route.key].render()}</View>
   </View>
</NoDropZone>
  1. having a transparent overlay while dragging over on full screen.
<NoDropZone
  key={route.key}
  setIsDraggingOver={setIsDraggingOver}
  isDraggingOver={isDraggingOver}
>
  <View        
  style={[
          styles.flexRow,
          styles.pAbsolute,
          styles.w100,
          styles.h100,
          StyleUtils.getBackgroundColorWithOpacityStyle(themeColors.shadow, CONST.RIGHT_MODAL_BACKGROUND_OVERLAY_OPACITY),
          StyleUtils.displayIfTrue(props.state.index === i),
      ]}
  >
      {{isDraggingOver && (<View style={styles.dropZoneTopInvisibleOverlay} />)}}
      <PressableWithoutFeedback
          style={[styles.flex1]}
          onPress={() => props.navigation.goBack()}
          accessibilityLabel={translate('common.close')}
          accessibilityRole={CONST.ACCESSIBILITY_ROLE.BUTTON}
      />
      <View style={styles.rightPanelContainer}>{props.descriptors[route.key].render()}</View>
  </View>
</NoDropZone>

Problem applying them:

We set the isdraggingOver event like below, here when we dragover the child elments (say the RHN), unwanted dragleave event fires set isDraggingover state back to false, and then again dragover event kicks in set the isdraggingover to true, this results in continuous state changing while dragover, to tackle the same situation here we applied another transparent overlay, which here is not possible because it blocks the user interaction completly.

function NoDropZone(props) {
   const {setIsDraggingOver, isDraggingOver} = props;

   function handleDragEnter(event) {
       event.preventDefault();
       // eslint-disable-next-line no-param-reassign
       event.dataTransfer.dropEffect = 'none';
       if (isDraggingOver) {
           return;
       }
       setIsDraggingOver(true);
   }

   function handleDragOver(event) {
       event.preventDefault();
       // eslint-disable-next-line no-param-reassign
       event.dataTransfer.dropEffect = 'none';
   }


   function handleDragLeave(event) {
       event.preventDefault();
       setIsDraggingOver(false);
   }

   useEffect(() => {
       document.addEventListener('dragenter', handleDragEnter);
       document.addEventListener('dragover', handleDragOver);
       document.addEventListener('dragleave', handleDragLeave);

       return () => {
           document.removeEventListener('dragenter', handleDragEnter);
           document.removeEventListener('dragover', handleDragOver);
           document.removeEventListener('dragleave', handleDragLeave);
       };
   }, []);

// rest of code

@ishpaul777
Copy link
Contributor Author

Bump @robertKozik, can you please update me. thanks!

@robertKozik
Copy link
Contributor

Thank you for your insights on this. I thought It would be more simple to solve. This said I think we can proceed with this PR without fixing it, as it can be also reproduced on main. I'll post a bug report afterwards about it

@robertKozik
Copy link
Contributor

@ishpaul777 Could you clean up your code from the noDropZoneTopInvisibleOverlay tryouts? I'll proceed with the reviewer checklist then

@ishpaul777
Copy link
Contributor Author

@robertKozik thanks for pointing this out, I commited unnecessary changes by mistake, did the clean up

@ishpaul777
Copy link
Contributor Author

Bump @robertKozik for final review! thanks

@robertKozik
Copy link
Contributor

robertKozik commented Jul 27, 2023

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

Web
web.mov
Mobile Web - Chrome
android.-.web.mov
Mobile Web - Safari
iOS.-.web.mov
Desktop
Desktop.mov
iOS
IOS.-.native.mov
Android
Screen.Recording.2023-07-27.at.15.13.32.mov

Copy link
Contributor

@robertKozik robertKozik left a comment

Choose a reason for hiding this comment

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

One minor change: unnesessary comment and we will be ready to go.

Also if you would be able to fill remaining videos/screenshots. I know they are unrelated to drop zone behaviour, just show that RHN is render correctly and there is nothing wrong with it after your changes

src/components/DragAndDrop/NoDropZone/index.native.js Outdated Show resolved Hide resolved
@ishpaul777
Copy link
Contributor Author

ishpaul777 commented Jul 27, 2023

@robertKozik how can i build the app for mobile chrome. Can you please guide me?

@ishpaul777
Copy link
Contributor Author

@robertKozik done! update the videos

Copy link
Contributor

@robertKozik robertKozik left a comment

Choose a reason for hiding this comment

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

Great, thanks for your cooperation @ishpaul777

@melvin-bot melvin-bot bot requested a review from dangrous July 27, 2023 14:30
Copy link
Contributor

@dangrous dangrous left a comment

Choose a reason for hiding this comment

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

Looks good, though we should definitely file a new bug report for that existing bug, can you handle that in Slack if you haven't already? Thanks!

@dangrous dangrous merged commit 98ec467 into Expensify:main Jul 27, 2023
14 checks passed
@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.

@robertKozik
Copy link
Contributor

@dangrous Posted already, here is a link

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/dangrous in version: 1.3.47-0 🚀

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

@dangrous
Copy link
Contributor

Lovely thank you!

@Beamanator
Copy link
Contributor

Possible regression: #23881

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/Beamanator in version: 1.3.47-6 🚀

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.

5 participants