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

Replace state on repeated Link navigations #7864

Merged
merged 4 commits into from
Aug 27, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion packages/react-router-dom/modules/Link.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import React from "react";
import { __RouterContext as RouterContext } from "react-router";
import { createPath } from 'history';
import PropTypes from "prop-types";
import invariant from "tiny-invariant";
import {
Expand Down Expand Up @@ -100,7 +101,8 @@ const Link = forwardRef(
href,
navigate() {
const location = resolveToLocation(to, context.location);
const method = replace ? history.replace : history.push;
const isDuplicateNavigation = createPath(context.location) === createPath(normalizeToLocation(location));
const method = (replace || isDuplicateNavigation) ? history.replace : history.push;

method(location);
}
Expand Down
74 changes: 53 additions & 21 deletions packages/react-router-dom/modules/__tests__/Link-click-test.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,19 @@ import renderStrict from "./utils/renderStrict.js";
describe("<Link> click events", () => {
const node = document.createElement("div");

afterEach(() => {
ReactDOM.unmountComponentAtNode(node);
let memoryHistory, pushSpy, replaceSpy;

beforeEach(() => {
memoryHistory = createMemoryHistory();
pushSpy = jest.spyOn(memoryHistory, "push");
replaceSpy = jest.spyOn(memoryHistory, "push");
});

const memoryHistory = createMemoryHistory();
memoryHistory.push = jest.fn();
afterEach(() => {
ReactDOM.unmountComponentAtNode(node);

beforeEach(() => {
memoryHistory.push.mockReset();
pushSpy.mockRestore();
replaceSpy.mockRestore();
});

it("calls onClick eventhandler and history.push", () => {
Expand All @@ -40,15 +44,45 @@ describe("<Link> click events", () => {
});

expect(clickHandler).toBeCalledTimes(1);
expect(memoryHistory.push).toBeCalledTimes(1);
expect(memoryHistory.push).toBeCalledWith(to);
expect(pushSpy).toBeCalledTimes(1);
expect(pushSpy).toBeCalledWith(to);
});

it("calls onClick eventhandler and history.push with function `to` prop", () => {
const memoryHistoryFoo = createMemoryHistory({
initialEntries: ["/foo"]
it("calls history.replace on duplicate navigation", () => {
const clickHandler = jest.fn();
const to = "/duplicate/path?the=query#the-hash";

renderStrict(
<Router history={memoryHistory}>
<Link to={to} onClick={clickHandler}>
link
</Link>
</Router>,
node
);

const a = node.querySelector("a");
TestUtils.Simulate.click(a, {
defaultPrevented: false,
button: 0
});
memoryHistoryFoo.push = jest.fn();

TestUtils.Simulate.click(a, {
defaultPrevented: false,
button: 0
});

expect(clickHandler).toBeCalledTimes(2);
expect(pushSpy).toBeCalledTimes(1);
expect(pushSpy).toBeCalledWith(to);
expect(replaceSpy).toBeCalledTimes(1);
expect(replaceSpy).toBeCalledWith(to);
});

it("calls onClick eventhandler and history.push with function `to` prop", () => {
// Make push a no-op so key IDs do not change
pushSpy.mockImplementation();

const clickHandler = jest.fn();
let to = null;
const toFn = location => {
Expand All @@ -61,7 +95,7 @@ describe("<Link> click events", () => {
};

renderStrict(
<Router history={memoryHistoryFoo}>
<Router history={memoryHistory}>
<Link to={toFn} onClick={clickHandler}>
link
</Link>
Expand All @@ -76,8 +110,8 @@ describe("<Link> click events", () => {
});

expect(clickHandler).toBeCalledTimes(1);
expect(memoryHistoryFoo.push).toBeCalledTimes(1);
expect(memoryHistoryFoo.push).toBeCalledWith(to);
expect(pushSpy).toBeCalledTimes(1);
expect(pushSpy).toBeCalledWith(to);
});

it("does not call history.push on right click", () => {
Expand All @@ -96,7 +130,7 @@ describe("<Link> click events", () => {
button: 1
});

expect(memoryHistory.push).toBeCalledTimes(0);
expect(pushSpy).toBeCalledTimes(0);
});

it("does not call history.push on prevented event.", () => {
Expand All @@ -115,7 +149,7 @@ describe("<Link> click events", () => {
button: 0
});

expect(memoryHistory.push).toBeCalledTimes(0);
expect(pushSpy).toBeCalledTimes(0);
});

it("does not call history.push target not specifying 'self'", () => {
Expand All @@ -136,12 +170,10 @@ describe("<Link> click events", () => {
button: 0
});

expect(memoryHistory.push).toBeCalledTimes(0);
expect(pushSpy).toBeCalledTimes(0);
});

it("prevents the default event handler if an error occurs", () => {
const memoryHistory = createMemoryHistory();
memoryHistory.push = jest.fn();
const error = new Error();
const clickHandler = () => {
throw error;
Expand Down Expand Up @@ -173,6 +205,6 @@ describe("<Link> click events", () => {
console.error.mockRestore();
expect(clickHandler).toThrow(error);
expect(mockPreventDefault).toHaveBeenCalled();
expect(memoryHistory.push).toBeCalledTimes(0);
expect(pushSpy).toBeCalledTimes(0);
});
});