Skip to content

Refactor(ui): Remove deprecated history typing from withRouteProps #3452

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.

Sign up for GitHub

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

Closed
aryanG9403 wants to merge 8 commits into from
Closed

Refactor(ui): Remove deprecated history typing from withRouteProps #3452

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
f03a6da
refactor: remove History from withRouteProps typing
aryanG9403 Jan 19, 2026
167d3e4
refactor: rely on react-router hooks in withRouteProps
aryanG9403 Jan 19, 2026
75efb1a
Merge branch 'main' into improve-withrouteprops-typing
aryanG9403 Jan 19, 2026
7c498a3
Merge branch 'main' into improve-withrouteprops-typing
aryanG9403 Jan 20, 2026
3c5ad25
Merge branch 'main' into improve-withrouteprops-typing
yurishkuro Jan 29, 2026
21f3ea2
Test(ui):update withRouteProps expectations
aryanG9403 Jan 29, 2026
79ff9ee
Merge branch 'main' into improve-withrouteprops-typing
aryanG9403 Mar 8, 2026
799ebd5
Merge branch 'main' into improve-withrouteprops-typing
aryanG9403 Mar 21, 2026
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
19 changes: 0 additions & 19 deletions packages/jaeger-ui/src/utils/withRouteProps.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,26 +6,8 @@ import { render } from '@testing-library/react';
import { MemoryRouter, Route, Routes } from 'react-router-dom-v5-compat';
import withRouteProps from './withRouteProps';

jest.mock('./configure-store', () => ({
history: {
push: jest.fn(),
replace: jest.fn(),
go: jest.fn(),
goBack: jest.fn(),
goForward: jest.fn(),
block: jest.fn(),
listen: jest.fn(),
createHref: jest.fn(),
action: 'POP',
length: 1,
location: { pathname: '/test', search: '?param=value' },
},
store: {},
}));

describe('withRouteProps', () => {
test('passes route props to WrappedComponent', () => {
const { history: mockHistory } = require('./configure-store');
const WrappedComponent = jest.fn(() => null);
const ComponentWithRouteProps = withRouteProps(WrappedComponent);
render(
Expand All @@ -46,7 +28,6 @@ describe('withRouteProps', () => {
pathname: '/test',
search: '?param=value',
params: {},
history: mockHistory,
})
);
});
Expand Down
21 changes: 5 additions & 16 deletions packages/jaeger-ui/src/utils/withRouteProps.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,21 @@
// SPDX-License-Identifier: Apache-2.0

import React from 'react';
import { useLocation, useParams } from 'react-router-dom-v5-compat';
import { History, Location } from 'history';
import { history } from './configure-store';
import { useLocation, useParams } from 'react-router-dom';

/**
* Interface representing route-related props passed to the enhanced component.
* @interface
* @property {Location} location - The current location object containing information about the URL.
* @property {ReturnType<typeof useLocation>} location - The current location object
* @property {string} pathname - The current URL pathname.
* @property {string} search - The current URL search string.
* @property {object} params - The URL parameters.
* @property {History} history - The history object for navigation.
*/
export type IWithRouteProps = {
location: Location;
location: ReturnType<typeof useLocation>;
pathname: string;
search: string;
params: object;
history: History;
};

/**
Expand All @@ -38,7 +34,7 @@ export default function withRouteProps(WrappedComponent: React.ElementType) {
return function WithRouteProps(props: IWithRouteProps | object) {
/**
* The current location object containing information about the URL.
* @type {Location}
* @type {ReturnType<typeof useLocation>}
*/
const location = useLocation();

Expand All @@ -65,14 +61,7 @@ export default function withRouteProps(WrappedComponent: React.ElementType) {
* @returns {React.Component} The enhanced component with additional route-related props.
*/
return (
<WrappedComponent
{...props}
location={location}
pathname={pathname}
search={search}
params={params}
history={history}
Copy link
Copy Markdown
Member

@yurishkuro yurishkuro Jan 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So we're no longer passing history, how is it not a breaking change? THIS file may not need history but we have no idea if the WrappedComponent needs it.

Copy link
Copy Markdown
Author

@aryanG9403 aryanG9403 Jan 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The test update was meant to reflect the current behavior of withRouteProps, which no longer injects history now that routing is handled via hooks.That said, I agree this HOC could still be used by components that expect history, so removing it may be a breaking change depending on usage.
I’m happy to update this in either direction:

  1. keep passing history for backward compatibility, or
  2. clarify and/or deprecate the behavior explicitly if that’s the intended direction.

Let me know what you’d prefer and I’ll adjust accordingly.

Copy link
Copy Markdown
Member

@yurishkuro yurishkuro Jan 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Parship12

/>
<WrappedComponent {...props} location={location} pathname={pathname} search={search} params={params} />
);
};
}
Loading