Skip to content

fix(replay): Fixes type error if same param is in url #68851

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

Merged
merged 3 commits into from
Apr 15, 2024
Merged

fix(replay): Fixes type error if same param is in url #68851

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
37175a8
fix type error
c298lee Apr 13, 2024
cd72f86
better fix
c298lee Apr 13, 2024
8a6b121
PR comments
c298lee Apr 15, 2024
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
6 changes: 5 additions & 1 deletion static/app/utils/useUrlParams.spec.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,15 @@ import useUrlParams from './useUrlParams';
jest.mock('react-router');
jest.mock('sentry/utils/useLocation');

type Query = {limit: string; page: string};
type Query = {array: string[]; limit: string; page: string};

describe('useUrlParams', () => {
beforeEach(() => {
jest.mocked(browserHistory.getCurrentLocation).mockReturnValue({
query: {
page: '3',
limit: '50',
array: ['first', 'second'],
},
} as Location<Query>);
});
Expand All @@ -25,6 +26,7 @@ describe('useUrlParams', () => {

expect(result.current.getParamValue('page')).toBe('3');
expect(result.current.getParamValue('limit')).toBe('50');
expect(result.current.getParamValue('array')).toBe('first');
expect(result.current.getParamValue('foo')).toBeUndefined();
});

Expand Down Expand Up @@ -54,6 +56,7 @@ describe('useUrlParams', () => {

expect(browserHistory.push).toHaveBeenCalledWith({
query: {
array: ['first', 'second'],
page: '4',
limit: '50',
},
Expand All @@ -69,6 +72,7 @@ describe('useUrlParams', () => {

expect(browserHistory.push).toHaveBeenCalledWith({
query: {
array: ['first', 'second'],
page: '4',
limit: '50',
},
Expand Down
5 changes: 4 additions & 1 deletion static/app/utils/useUrlParams.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,10 @@ function useUrlParams(defaultKey?: string, defaultValue?: string) {
const getParamValue = useCallback(
(key: string) => {
const location = browserHistory.getCurrentLocation();
return location.query[key] ?? defaultValue;
// location.query.key can return string[] but we expect a singular value from this function, so we return the first string (this is picked arbitrarily) if it's string[]
return Array.isArray(location.query[key])
? location.query[key]?.at(0) ?? defaultValue
: location.query[key] ?? defaultValue;
Comment on lines +24 to +26
Copy link
Member

@billyvg billyvg Apr 15, 2024

Choose a reason for hiding this comment

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

idk what's easier to read

      return (
        Array.isArray(location.query[key])
          ? location.query[key]?.at(0)
          : location.query[key]
        ) ?? defaultValue;

},
[defaultValue]
);
Expand Down