Add a new optional AbortController parameter to defer

[brophdawg11]

POC for #10786 which would let users provide an AbortController to defer

// Current
function loader({ request }) {
  // request.signal is only aborted on a navigation interruption.  Once 
  // our loaders resolve, the navigation is complete, but we can still 
  // interrupt the pending deferreds by clicking another link on the 
  // destination page.  So there's no way to know that the request 
  // succeeded but promise got cancelled (or at least we stopped 
  // waiting for it to settle)
  let promise = fetchData();
  return defer({ data: promise }); 
}

// New
function loader({ request }) {
  // Now, users can create their own controller and hand it to defer(), 
  // and we'll abort that if we end up cancelling the deferreds.  Either 
  // via a navigation interruption or a post-navigation pending-UI 
  // cancellation
  let controller = new AbortController();
  let promise = fetchData(controller.signal);  
  return defer({ data: promise }, null, controller);
}

Note, the second parameter to defer is a ResponseInit (just like json), so I made this a standalone 3rd param to be explicit/simple/clear. We could override the second param and also allow defer({ data: promise }, controller) if we wanted though.

[changeset-bot]

🦋 Changeset detected

Latest commit: 94973bb

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 5 packages

Name	Type
@remix-run/router	Minor
react-router	Patch
react-router-dom	Patch
react-router-dom-v5-compat	Patch
react-router-native	Patch

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

[brophdawg11]

Use user controller if provided

[brophdawg11]

Cancel defer() instances created after the request has already been aborted

[brophdawg11]

Cancel defer() instanced created before the request is aborted

[changeset-bot]

🦋 Changeset detected

Latest commit: 2d7450b

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 5 packages

Name	Type
@remix-run/router	Minor
react-router	Patch
react-router-dom	Patch
react-router-dom-v5-compat	Patch
react-router-native	Patch

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

[brophdawg11]

Talked to @jacob-ebey and we think we may want to align React Router with the Remix behavior here. In Remix because it's using an actual HTTP streaming request, the request is still active until all pending deferreds settle. This is not the case in React Router since it's not actually streaming so the request is "done" - but we should treat it as if it was and consider the promises part of the request lifetime.

This should just require attaching the navigation AbortController to DeferredData instead of creating one internally (or accepting one from the user).