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 ^6.21.1 - autoclosed #45

Closed
wants to merge 1 commit into from

Conversation

renovate[bot]
Copy link

@renovate renovate bot commented Oct 1, 2023

Mend Renovate

This PR contains the following updates:

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

Release Notes

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

v6.21.1

Compare Source

Patch Changes

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

Configuration

📅 Schedule: Branch creation - "before 4am on the first day of the month" (UTC), Automerge - At any time (no schedule defined).

🚦 Automerge: Enabled.

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.

@changeset-bot
Copy link

changeset-bot bot commented Oct 1, 2023

⚠️ No Changeset found

Latest commit: 3a58fb8

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@codesandbox-ci
Copy link

codesandbox-ci bot commented Oct 1, 2023

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

@codecov
Copy link

codecov bot commented Oct 1, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (211ae8c) 100.00% compared to head (3a58fb8) 100.00%.

Additional details and impacted files
@@            Coverage Diff            @@
##              main       #45   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            1         1           
  Lines            1         1           
=========================================
  Hits             1         1           

☔ 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 ^6.16.0 chore(deps): update dependency react-router-dom to ^6.17.0 Oct 16, 2023
@renovate renovate bot force-pushed the renovate/react-router-monorepo branch from 30a4520 to 2e6f5b0 Compare October 16, 2023 17:25
@renovate renovate bot changed the title chore(deps): update dependency react-router-dom to ^6.17.0 chore(deps): update dependency react-router-dom to ^6.18.0 Oct 31, 2023
@renovate renovate bot force-pushed the renovate/react-router-monorepo branch from 2e6f5b0 to 8b2233a Compare October 31, 2023 17:22
@renovate renovate bot changed the title chore(deps): update dependency react-router-dom to ^6.18.0 chore(deps): update dependency react-router-dom to ^6.19.0 Nov 16, 2023
@renovate renovate bot force-pushed the renovate/react-router-monorepo branch from 8b2233a to 9aa4d16 Compare November 16, 2023 15:37
@renovate renovate bot changed the title chore(deps): update dependency react-router-dom to ^6.19.0 chore(deps): update dependency react-router-dom to ^6.20.0 Nov 22, 2023
@renovate renovate bot force-pushed the renovate/react-router-monorepo branch from 9aa4d16 to 16dfdd0 Compare November 22, 2023 18:10
@renovate renovate bot changed the title chore(deps): update dependency react-router-dom to ^6.20.0 chore(deps): update dependency react-router-dom to ^6.20.1 Dec 1, 2023
@renovate renovate bot force-pushed the renovate/react-router-monorepo branch from 16dfdd0 to 14d8e9a Compare December 1, 2023 23:21
@renovate renovate bot changed the title chore(deps): update dependency react-router-dom to ^6.20.1 chore(deps): update dependency react-router-dom to ^6.20.1 - autoclosed Dec 7, 2023
@renovate renovate bot closed this Dec 7, 2023
@renovate renovate bot deleted the renovate/react-router-monorepo branch December 7, 2023 13:16
@renovate renovate bot changed the title chore(deps): update dependency react-router-dom to ^6.20.1 - autoclosed chore(deps): update dependency react-router-dom to ^6.20.1 Dec 13, 2023
@renovate renovate bot restored the renovate/react-router-monorepo branch December 13, 2023 22:23
@renovate renovate bot reopened this Dec 13, 2023
Copy link

github-actions bot commented Dec 13, 2023

📊 Package size report   No changes

File Before After
Total (Includes all files) 62.8 kB 62.8 kB
Tarball size 22.4 kB 22.4 kB
Unchanged files
File Size
.changeset/config.json 323 B
.changeset/README.md 510 B
.codesandbox/ci.json 38 B
.gitattributes 40 B
.github/FUNDING.yml 197 B
.github/workflows/ci.yml 1.2 kB
.github/workflows/codeql.yml 848 B
.github/workflows/pkg-size.yml 539 B
.github/workflows/release.yml 1.0 kB
.github/workflows/vercel.yml 813 B
.lintstagedrc.cjs 50 B
.nvmrc 3 B
.prettierignore 78 B
.simple-git-hooks.cjs 51 B
.stylelintignore 84 B
.yarn/patches/vite-npm-5.0.7-583fea8b6f.patch 511 B
.yarn/plugins/plugin-prepare-lifecycle.cjs 202 B
.yarnrc.yml 357 B
auto-imports.d.ts 814 B
CHANGELOG.md 204 B
docs/App.tsx 1.9 kB
docs/global.scss 156 B
docs/index.tsx 208 B
docs/tsconfig.json 85 B
index.html 404 B
LICENSE 1.1 kB
package.json 3.3 kB
packages/pkg/CHANGELOG.md 13 B
packages/pkg/package.json 830 B
packages/pkg/README.md 3.1 kB
packages/pkg/src/index.ts 36 B
packages/pkg/test/basic.spec.ts 101 B
packages/pkg/tsconfig.json 153 B
packages/pkg/tsconfig.tsbuildinfo 37.4 kB
README.md 5.1 kB
tsconfig.json 209 B
vercel.json 231 B
vite.config.ts 310 B
vitest.config.ts 341 B

🤖 This report was automatically generated by pkg-size-action

@renovate renovate bot changed the title chore(deps): update dependency react-router-dom to ^6.20.1 chore(deps): update dependency react-router-dom to ^6.21.0 Dec 14, 2023
@renovate renovate bot force-pushed the renovate/react-router-monorepo branch from 14d8e9a to b0e2be2 Compare December 14, 2023 00:35
@renovate renovate bot changed the title chore(deps): update dependency react-router-dom to ^6.21.0 chore(deps): update dependency react-router-dom to ^6.21.1 Dec 21, 2023
@renovate renovate bot force-pushed the renovate/react-router-monorepo branch from b0e2be2 to 3a58fb8 Compare December 21, 2023 18:58
@renovate renovate bot changed the title chore(deps): update dependency react-router-dom to ^6.21.1 chore(deps): update dependency react-router-dom to ^6.21.1 - autoclosed Dec 29, 2023
@renovate renovate bot closed this Dec 29, 2023
@renovate renovate bot deleted the renovate/react-router-monorepo branch December 29, 2023 14:28
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.

0 participants