test: add test where form is descendant of element with stop propagation on click

[penspinner]

Bug

Added a failing test where clicking a submit button as a descendant of an element that stops propagation on click does not send the clicked submit button's name and value properties to the action request payload.

I think this bug was introduced from #1781 (released in v1.2.0) because this used to work until I updated dependencies at some point.

---

How I encountered this

I encountered this bug through my own app. I had a modal with a form in it, and it suddenly stopped sending { _action: add_note } to my action's request payload. My code looks something like this:

import { Dialog } from '@headlessui/react'
import { Form } from 'remix'

const Page = () => {
  return (
    <Dialog>
      <Form method="post">
        <button name="_action" value="add_note">
          Add note
        </button
      </Form
    </Dialog>
  )
}

export default Page

And I noticed Headless UI's Dialog has an event.stopPropagation() on the div's onClick: https://github.com/tailwindlabs/headlessui/blob/c4e35f38794b89ec9692e8bb7027447503623604/packages/%40headlessui-react/src/components/dialog/dialog.tsx#L318

[penspinner]

Related Discord thread with @ryanflorence: https://discord.com/channels/770287896669978684/950943922966900756.

[remix-cla-bot]

Thank you for signing the Contributor License Agreement. Let's get this merged! 🥳

[penspinner]

@mcansh Thanks! Another duplicated PR for this bug: #2034.