Migrate DragNDrop

[roryabraham]

Details

Migrating DragNDrop to a functional component. The existing configuration of DragAndDrop we had was pretty circuitous and also didn't really follow normal React patterns. Before, it was implemented something like this:

• In ReportScreen, we pass an ID to a view. That's the view we're listening for drag events
• Also in ReportScreen, we set up a PortalHost which will be used to later display the UI that appears when you do drag a file over
• Then in ReportActionCompose, we set up the listeners for drag events on that view in the ReportScreen, and save the drag state to ReportActionCompose state
• Then in ReportActionCompose, if the parent view is dragged over, we render a UI into the PortalHost we set up in the ReportScreen
• There was also some confusing stuff with three different props to identify a "drop zone":
  • dropZoneID
  • activeDropZoneID
  • dropZoneHostName
• In order to use it, you had to set up:
  • parent view w/ nativeID
  • PortalHost
  • DragAndDrop – use callbacks and manage state manually
  • DropZone (i.e: the Portal "client")

A simplified version of how it was used before looks something like this:

• in the parent:

  <View nativeID={dropZoneID}>
      ...
      ...
      <PortalHost hostName={dropZoneHostName} />
  </View>

• In the child:

  const [isDraggingOver, setIsDraggingOver] = useState(false);
  
  ...
  
  /* Note: technically there's no point in putting children inside this component... */
  <DragAndDrop
      dropZoneID={dropZoneID}
      onDragEnter={() => setIsDraggingOver(true)}
      onDragLeave={() => setIsDraggingOver(false)}
      onDrop={() => { /* do callback */ }}
  />
  
  ...
  
  isDraggingOver && {
      <Portal hostName={dropZoneHostName}>
          {/* There were some helper components, but essentially here is where we render what appears when the parent view w/ dropZoneID is hovered over */}
      </Portal>
  }

This PR makes it a bit simpler to use. Now it looks something like this:

• in the parent:

  <DragAndDropProvider dropZoneID={dropZoneID}>
      {/* Render children normally here, developer doesn't have to create a Portal */}
  </DragAndDropProvider>

• in the child:

  <DragAndDropConsumer dropZoneID={dropZoneID}>
      {
      /*
        * Here is where you render what appears when the parent view w/ dropZoneID is hovered over.
        * It will automatically only render when the dropZoneID is dragged over
        * It will be absolute-positioned w/ the same dimensions and position in window as the parent `dropZoneID`. You can style the content relative to that.
        */
      }
  </DragAndDropConsumer>

Fixed Issues

$ #16142

Tests (web/desktop only)

0. If you are using an Expensify dev DM, vssh into the VM, navigate to Web-PDFs/var/pdfs.expensify.com and run composer install
1. Open a report and verify that you can send a message as normal, hover over items, and click on the + button in the composer.
2. Drag a file over the composer.
3. Verify that you can drag and drop a file to add it as an attachment.
4. Drag a file in and out of the report view, verify that the "drag hover state" toggles off and on correctly.
5. Open the settings page. Try to drag-and-drop a file, verify that dropping the file does nothing and does not open up the image in a new browser tab.
6. Close and reopen the settings page, then repeat the previous step and make sure the behavior hasn't changed.
7. Now open another report, and verify that you can drag-and-drop to upload an image.
8. Run storybook, make sure that the stories for DragAndDrop are still working.

• Verify that no errors appear in the JS console

Offline tests

Verify that you can drag and drop a file to add it as an attachment.

QA Steps (web/desktop only)

1. Verify that you can drag and drop a file over the composer to add it as an attachment.
2. Go to https://staging.new.expensify.com/docs/index.html and look at the story for DragAndDrop. Make sure it looks and functions as expected by dragging a file over it.

• 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

web.mov

storybook.mov

Mobile Web - Chrome

Mobile Web - Safari

Desktop

desktop.mov

iOS

Android

[melvin-bot]

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

[roryabraham]

@fedirjh I'm assigning this to @allroundexperts for review since I came from #23252

[OSBotify]

🧪🧪 Use the links below to test this build in android and iOS. Happy testing! 🧪🧪

android 🤖	iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/23589/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/23589/index.html
desktop 💻	web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/23589/NewExpensify.dmg	https://23589.pr-testing.expensify.com

[allroundexperts]

@roryabraham I'm getting the following console error. Can you please confirm / fix?

Screen.Recording.2023-07-28.at.9.40.22.PM.mov

[roryabraham]

@allroundexperts I'm not seeing the same:

web.mov

Tried with a PDF as well, didn't see the error. Also verified that the global create popover is correctly closed when you drag over:

web.mov

[roryabraham]

Not in-scope for this PR but this code should really listen for dragenter instead of dragover since dragover is a continuous event that gets fired many times per second

[allroundexperts]

Gotcha. Testing again!

[allroundexperts]

Tests well @roryabraham. I wasn't able to find any other thing. That being said, given the size of this PR, I think it will be beneficial if we can get another pair of eyes on this (If this is not super urgent).

[melvin-bot]

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

[roryabraham]

Going to merge this because it's blocking another pretty urgent PR

[OSBotify]

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

[luacmartins]

@roryabraham I see this on the latest iOS/android main. Possibly related to this PR or am I doing something wrong?

[allroundexperts]

I just built the app on native and saw that it loaded fine. Should have tested composer as well. Anyways, I think this is the culprit. We need to return null as far as I can see.

@roryabraham I can raise a quick fix PR for this if you're busy.

[AndrewGable]

PR: #23829

[OSBotify]

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

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

[OSBotify]

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.48-5 🚀

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

[OSBotify]

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

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

[OSBotify]

🚀 Deployed to production by https://github.com/Beamanator in version: 1.3.49-3 🚀

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

[allroundexperts]

The wrapping View caused this. When creating a new workspace in ThreePaneView component, props.state.routes still contains NAVIGATORS.RIGHT_MODAL_NAVIGATOR route. This causes the App to be wrapped in NoDropZone even after RHN is closed.
Mentioning it here so that it remains documented.

[s77rt]

If we drag on an element the counter will increase. If that element is removed from dom, the counter will not decrease (stale date). This caused #33820