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

chore(deps): update dependency react-router-dom to v6.24.1 #921

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Dec 13, 2023

Mend Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
react-router-dom (source) 6.20.1 -> 6.24.1 age adoption passing confidence

Release Notes

remix-run/react-router (react-router-dom)

v6.24.1

Compare Source

Patch Changes

v6.24.0

Compare Source

Minor Changes
Patch Changes
  • Fix fetcher.submit types - remove incorrect navigate/fetcherKey/unstable_viewTransition options because they are only relevant for useSubmit (#​11631)
  • Allow falsy location.state values passed to <StaticRouter> (#​11495)
  • Updated dependencies:
    • react-router@6.24.0
    • @remix-run/router@1.17.0

v6.23.1

Compare Source

Patch Changes
  • Check for document existence when checking startViewTransition (#​11544)
  • Change the react-router-dom/server import back to react-router-dom instead of index.ts (#​11514)
  • Updated dependencies:
    • @remix-run/router@1.16.1
    • react-router@6.23.1

v6.23.0

Compare Source

Minor Changes
  • Add a new unstable_dataStrategy configuration option (#​11098)
    • This option allows Data Router applications to take control over the approach for executing route loaders and actions
    • The default implementation is today's behavior, to fetch all loaders in parallel, but this option allows users to implement more advanced data flows including Remix single-fetch, middleware/context APIs, automatic loader caching, and more
Patch Changes
  • Updated dependencies:
    • @remix-run/router@1.16.0
    • react-router@6.23.0

v6.22.3

Compare Source

Patch Changes
  • Updated dependencies:
    • @remix-run/router@1.15.3
    • react-router@6.22.3

v6.22.2

Compare Source

Patch Changes
  • Updated dependencies:
    • @remix-run/router@1.15.2
    • react-router@6.22.2

v6.22.1

Compare Source

v6.22.0

Compare Source

Minor Changes
  • Include a window__reactRouterVersion tag for CWV Report detection (#​11222)
Patch Changes
  • Updated dependencies:
    • @remix-run/router@1.15.0
    • react-router@6.22.0

v6.21.3

Compare Source

Patch Changes
  • Fix NavLink isPending when a basename is used (#​11195)
  • Remove leftover unstable_ prefix from Blocker/BlockerFunction types (#​11187)
  • Updated dependencies:
    • react-router@6.21.3

v6.21.2

Compare Source

v6.21.1

Compare Source

Patch Changes
  • Updated dependencies:
    • react-router@6.21.1
    • @remix-run/router@1.14.1

v6.21.0

Compare Source

Minor Changes
  • Add a new future.v7_relativeSplatPath flag to implement a breaking bug fix to relative routing when inside a splat route. (#​11087)

    This fix was originally added in #​10983 and was later reverted in #​11078 because it was determined that a large number of existing applications were relying on the buggy behavior (see #​11052)

    The Bug
    The buggy behavior is that without this flag, the default behavior when resolving relative paths is to ignore any splat (*) portion of the current route path.

    The Background
    This decision was originally made thinking that it would make the concept of nested different sections of your apps in <Routes> easier if relative routing would replace the current splat:

    <BrowserRouter>
      <Routes>
        <Route path="/" element={<Home />} />
        <Route path="dashboard/*" element={<Dashboard />} />
      </Routes>
    </BrowserRouter>

    Any paths like /dashboard, /dashboard/team, /dashboard/projects will match the Dashboard route. The dashboard component itself can then render nested <Routes>:

    function Dashboard() {
      return (
        <div>
          <h2>Dashboard</h2>
          <nav>
            <Link to="/">Dashboard Home</Link>
            <Link to="team">Team</Link>
            <Link to="projects">Projects</Link>
          </nav>
    
          <Routes>
            <Route path="/" element={<DashboardHome />} />
            <Route path="team" element={<DashboardTeam />} />
            <Route path="projects" element={<DashboardProjects />} />
          </Routes>
        </div>
      );
    }

    Now, all links and route paths are relative to the router above them. This makes code splitting and compartmentalizing your app really easy. You could render the Dashboard as its own independent app, or embed it into your large app without making any changes to it.

    The Problem

    The problem is that this concept of ignoring part of a path breaks a lot of other assumptions in React Router - namely that "." always means the current location pathname for that route. When we ignore the splat portion, we start getting invalid paths when using ".":

    // If we are on URL /dashboard/team, and we want to link to /dashboard/team:
    function DashboardTeam() {
      // ❌ This is broken and results in <a href="/dashboard">
      return <Link to=".">A broken link to the Current URL</Link>;
    
      // ✅ This is fixed but super unintuitive since we're already at /dashboard/team!
      return <Link to="./team">A broken link to the Current URL</Link>;
    }

    We've also introduced an issue that we can no longer move our DashboardTeam component around our route hierarchy easily - since it behaves differently if we're underneath a non-splat route, such as /dashboard/:widget. Now, our "." links will, properly point to ourself inclusive of the dynamic param value so behavior will break from it's corresponding usage in a /dashboard/* route.

    Even worse, consider a nested splat route configuration:

    <BrowserRouter>
      <Routes>
        <Route path="dashboard">
          <Route path="*" element={<Dashboard />} />
        </Route>
      </Routes>
    </BrowserRouter>

    Now, a <Link to="."> and a <Link to=".."> inside the Dashboard component go to the same place! That is definitely not correct!

    Another common issue arose in Data Routers (and Remix) where any <Form> should post to it's own route action if you the user doesn't specify a form action:

    let router = createBrowserRouter({
      path: "/dashboard",
      children: [
        {
          path: "*",
          action: dashboardAction,
          Component() {
            // ❌ This form is broken!  It throws a 405 error when it submits because
            // it tries to submit to /dashboard (without the splat value) and the parent
            // `/dashboard` route doesn't have an action
            return <Form method="post">...</Form>;
          },
        },
      ],
    });

    This is just a compounded issue from the above because the default location for a Form to submit to is itself (".") - and if we ignore the splat portion, that now resolves to the parent route.

    The Solution
    If you are leveraging this behavior, it's recommended to enable the future flag, move your splat to it's own route, and leverage ../ for any links to "sibling" pages:

    <BrowserRouter>
      <Routes>
        <Route path="dashboard">
          <Route index path="*" element={<Dashboard />} />
        </Route>
      </Routes>
    </BrowserRouter>
    
    function Dashboard() {
      return (
        <div>
          <h2>Dashboard</h2>
          <nav>
            <Link to="..">Dashboard Home</Link>
            <Link to="../team">Team</Link>
            <Link to="../projects">Projects</Link>
          </nav>
    
          <Routes>
            <Route path="/" element={<DashboardHome />} />
            <Route path="team" element={<DashboardTeam />} />
            <Route path="projects" element={<DashboardProjects />} />
          </Router>
        </div>
      );
    }

    This way, . means "the full current pathname for my route" in all cases (including static, dynamic, and splat routes) and .. always means "my parents pathname".

Patch Changes
  • Updated dependencies:
    • @remix-run/router@1.14.0
    • react-router@6.21.0

Configuration

📅 Schedule: Branch creation - "before 1am on monday and wednesday" in timezone Europe/Paris, Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR has been generated by Mend Renovate. View repository job log here.

Copy link

codecov bot commented Dec 13, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 57.89%. Comparing base (1e3dd18) to head (e416555).

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #921   +/-   ##
=======================================
  Coverage   57.89%   57.89%           
=======================================
  Files           4        4           
  Lines          38       38           
  Branches        8        8           
=======================================
  Hits           22       22           
  Misses         13       13           
  Partials        3        3           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@renovate renovate bot changed the title chore(deps): update dependency react-router-dom to v6.21.0 chore(deps): update dependency react-router-dom to v6.21.1 Dec 21, 2023
@renovate renovate bot force-pushed the renovate/react-router-monorepo branch from 351a2d6 to 3db97aa Compare December 21, 2023 19:05
@renovate renovate bot force-pushed the renovate/react-router-monorepo branch from 3db97aa to 90d4c0a Compare January 11, 2024 17:44
@renovate renovate bot changed the title chore(deps): update dependency react-router-dom to v6.21.1 chore(deps): update dependency react-router-dom to v6.21.2 Jan 11, 2024
@renovate renovate bot changed the title chore(deps): update dependency react-router-dom to v6.21.2 chore(deps): update dependency react-router-dom to v6.21.3 Jan 18, 2024
@renovate renovate bot force-pushed the renovate/react-router-monorepo branch from 90d4c0a to d1b05e4 Compare January 18, 2024 20:01
@renovate renovate bot changed the title chore(deps): update dependency react-router-dom to v6.21.3 chore(deps): update dependency react-router-dom to v6.22.0 Feb 2, 2024
@renovate renovate bot force-pushed the renovate/react-router-monorepo branch from d1b05e4 to b84c4d5 Compare February 2, 2024 14:40
@renovate renovate bot force-pushed the renovate/react-router-monorepo branch from b84c4d5 to 5fd4eaa Compare February 16, 2024 22:48
@renovate renovate bot changed the title chore(deps): update dependency react-router-dom to v6.22.0 chore(deps): update dependency react-router-dom to v6.22.1 Feb 16, 2024
@renovate renovate bot changed the title chore(deps): update dependency react-router-dom to v6.22.1 chore(deps): update dependency react-router-dom to v6.22.2 Feb 28, 2024
@renovate renovate bot force-pushed the renovate/react-router-monorepo branch from 5fd4eaa to 557c498 Compare February 28, 2024 20:30
@renovate renovate bot changed the title chore(deps): update dependency react-router-dom to v6.22.2 chore(deps): update dependency react-router-dom to v6.22.3 Mar 7, 2024
@renovate renovate bot force-pushed the renovate/react-router-monorepo branch from 557c498 to 619b365 Compare March 7, 2024 15:47
@renovate renovate bot force-pushed the renovate/react-router-monorepo branch 4 times, most recently from 9237ca1 to 8df69b7 Compare April 16, 2024 07:24
@renovate renovate bot changed the title chore(deps): update dependency react-router-dom to v6.22.3 chore(deps): update dependency react-router-dom to v6.23.0 Apr 23, 2024
@renovate renovate bot force-pushed the renovate/react-router-monorepo branch from 8df69b7 to a4dfd8a Compare April 23, 2024 15:40
@renovate renovate bot force-pushed the renovate/react-router-monorepo branch from a4dfd8a to 570ebef Compare May 10, 2024 18:07
@renovate renovate bot changed the title chore(deps): update dependency react-router-dom to v6.23.0 chore(deps): update dependency react-router-dom to v6.23.1 May 10, 2024
@renovate renovate bot force-pushed the renovate/react-router-monorepo branch 3 times, most recently from 7348eb3 to 1de7676 Compare June 12, 2024 10:56
@renovate renovate bot force-pushed the renovate/react-router-monorepo branch from 1de7676 to e416555 Compare June 24, 2024 19:30
@renovate renovate bot changed the title chore(deps): update dependency react-router-dom to v6.23.1 chore(deps): update dependency react-router-dom to v6.24.0 Jun 24, 2024
@renovate renovate bot changed the title chore(deps): update dependency react-router-dom to v6.24.0 chore(deps): update dependency react-router-dom to v6.24.1 Jul 3, 2024
@renovate renovate bot force-pushed the renovate/react-router-monorepo branch from e416555 to 8fdf60c Compare July 3, 2024 14:21
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.

None yet

0 participants