test(react-router-dom): streamline jsdom submitter bug workaround #9824
Conversation
🦋 Changeset detectedLatest commit: 168e557 The changes in this PR will be included in the next version bump. This PR includes changesets to release 4 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
Hi @jenseng, Welcome, and thank you for contributing to React Router! Before we consider your pull request, we ask that you sign our Contributor License Agreement (CLA). We require this only once. You may review the CLA and sign it by adding your name to contributors.yml. Once the CLA is signed, the If you have already signed the CLA and received this response in error, or if you have any questions, please contact us at hello@remix.run. Thanks! - The Remix team |
jenseng
force-pushed
the
jsdom-bug-workaround
branch
from
346a760
to
7d11113
Compare
|
Thank you for signing the Contributor License Agreement. Let's get this merged! 🥳 |
|
cc @brophdawg11 |
| @@ -37,6 +37,9 @@ import { | |||
| useLocation, | |||
| createRoutesFromElements, | |||
| } from "react-router-dom"; | |||
| import { isSubmitterElement } from "../dom"; | |||
|
|
|||
| fixSubmitEventSubmitter(window); | |||
There was a problem hiding this comment.
If we were to put this in another file, would we dup the listeners on window? Wondering if it should either return an unlisten and be called in a beforeEach/afterEach setup? Or - could this just move to setup.ts and be applied globally for all react-router-dom tests?
There was a problem hiding this comment.
From what I can tell of how jsdom/rtl are wired up, it looks like we just need to do it once per test suite/file, rather than per test. And since jest runs each test file in an isolated worker, I don't believe any cleanup should be needed. I like the setup.ts idea, I'll move it there 👍
| if (maybeSubmitter?.form === event.target) | ||
| event.submitter = maybeSubmitter; |
There was a problem hiding this comment.
Is it worth making this polyfill-esque so it becomes a no-op once this is fixed upstream?
if (maybeSubmitter?.form === event.target && !event.hasOwnProperty('submitter'))
event.submitter = maybeSubmitter;Or maybe a more lax version that would still overwrite undefined/null values:
if (maybeSubmitter?.form === event.target)
event.submitter = event.submitter || maybeSubmitter;There was a problem hiding this comment.
👍 I like the polyfill idea, I'll tweak this a bit
jenseng
force-pushed
the
jsdom-bug-workaround
branch
from
7d11113
to
e6bd456
Compare
Work around the submitter bug in just one place, and link to my jsdom PR which will fix it, so that the workaround can be removed sooner rather than later 🤞 This workaround refactor also establishes a pattern for other jsdom bug polyfills which will be landing in forthcoming RR PRs (the bugs aren't relevant in the current test suite, but will be in the PRs 😅)
jenseng
force-pushed
the
jsdom-bug-workaround
branch
from
e6bd456
to
168e557
Compare
|
Thanks! |
Work around the submitter bug in just one place, and link to my jsdom PR which will fix it, so that the workaround can be removed sooner rather than later 🤞
This workaround refactor also establishes a pattern for other jsdom bug polyfills which will be landing in forthcoming RR PRs (the bugs aren't relevant in the current test suite, but will be in the PRs 😅)