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.

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

Fix double decoding of ids in URLs #10293

Merged
merged 2 commits into from
Oct 24, 2024
Merged

Fix double decoding of ids in URLs #10293

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
00a8f6b
Fix double decoding of ids in URLs
Oct 22, 2024
7117be5
Fix storybook
Oct 22, 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
58 changes: 24 additions & 34 deletions packages/ra-core/src/controller/edit/useEditController.spec.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ import {
CanAccess,
DisableAuthentication,
} from './useEditController.security.stories';
import { EncodedId } from './useEditController.stories';

describe('useEditController', () => {
const defaultProps = {
Expand Down Expand Up @@ -55,42 +56,31 @@ describe('useEditController', () => {
});
});

it('should decode the id from the route params', async () => {
const getOne = jest
.fn()
.mockImplementationOnce(() =>
Promise.resolve({ data: { id: 'test?', title: 'hello' } })
);
const dataProvider = { getOne } as unknown as DataProvider;
it.each([
{ id: 'test?', url: '/posts/test%3F' },
{ id: 'test%', url: '/posts/test%25' },
])(
'should decode the id $id from the route params',
async ({ id, url }) => {
const getOne = jest
.fn()
.mockImplementationOnce(() =>
Promise.resolve({ data: { id, title: 'hello' } })
);
const dataProvider = { getOne } as unknown as DataProvider;

render(
<TestMemoryRouter initialEntries={['/posts/test%3F']}>
<CoreAdminContext dataProvider={dataProvider}>
<Routes>
<Route
path="/posts/:id"
element={
<EditController resource="posts">
{({ record }) => (
<div>{record && record.title}</div>
)}
</EditController>
}
/>
</Routes>
</CoreAdminContext>
</TestMemoryRouter>
);
await waitFor(() => {
expect(getOne).toHaveBeenCalledWith('posts', {
id: 'test?',
signal: undefined,
render(<EncodedId id={id} url={url} dataProvider={dataProvider} />);
await waitFor(() => {
expect(getOne).toHaveBeenCalledWith('posts', {
id,
signal: undefined,
});
});
});
await waitFor(() => {
expect(screen.queryAllByText('hello')).toHaveLength(1);
});
});
await waitFor(() => {
expect(screen.queryAllByText('Title: hello')).toHaveLength(1);
});
}
);

it('should use the id provided through props if any', async () => {
const getOne = jest
Expand Down
85 changes: 85 additions & 0 deletions packages/ra-core/src/controller/edit/useEditController.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
import * as React from 'react';
import { Route, Routes, useLocation } from 'react-router';
import {
CoreAdminContext,
EditController,
testDataProvider,
TestMemoryRouter,
} from '../..';

export default {
title: 'ra-core/controller/useEditController',
};

export const EncodedId = ({
id = 'test?',
url = '/posts/test%3F',
dataProvider = testDataProvider({
// @ts-expect-error
getOne: () => Promise.resolve({ data: { id, title: 'hello' } }),
}),
}) => {
return (
<TestMemoryRouter initialEntries={[url]}>
<CoreAdminContext dataProvider={dataProvider}>
<Routes>
<Route
path="/posts/:id"
element={
<EditController resource="posts">
{({ record }) => (
<>
<LocationInspector />
<p>Id: {record && record.id}</p>
<p>Title: {record && record.title}</p>
</>
)}
</EditController>
}
/>
</Routes>
</CoreAdminContext>
</TestMemoryRouter>
);
};

export const EncodedIdWithPercentage = ({
id = 'test%',
url = '/posts/test%25',
dataProvider = testDataProvider({
// @ts-expect-error
getOne: () => Promise.resolve({ data: { id, title: 'hello' } }),
}),
}) => {
return (
<TestMemoryRouter initialEntries={[url]}>
<CoreAdminContext dataProvider={dataProvider}>
<Routes>
<Route
path="/posts/:id"
element={
<EditController resource="posts">
{({ record }) => (
<>
<LocationInspector />
<p>Id: {record && record.id}</p>
<p>Title: {record && record.title}</p>
</>
)}
</EditController>
}
/>
</Routes>
</CoreAdminContext>
</TestMemoryRouter>
);
};
slax57 marked this conversation as resolved.
Show resolved Hide resolved

const LocationInspector = () => {
const location = useLocation();
return (
<p>
Location: <code>{location.pathname}</code>
</p>
);
};
2 changes: 1 addition & 1 deletion packages/ra-core/src/controller/edit/useEditController.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ export const useEditController = <
'useEditController requires an id prop or a route with an /:id? parameter.'
);
}
const id = propsId ?? decodeURIComponent(routeId!);
const id = propsId ?? routeId;
const { meta: queryMeta, ...otherQueryOptions } = queryOptions;
const {
meta: mutationMeta,
Expand Down
58 changes: 24 additions & 34 deletions packages/ra-core/src/controller/show/useShowController.spec.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import {
CanAccess,
DisableAuthentication,
} from './useShowController.security.stories';
import { EncodedId } from './useShowController.stories';

describe('useShowController', () => {
const defaultProps = {
Expand Down Expand Up @@ -41,41 +42,30 @@ describe('useShowController', () => {
});
});

it('should decode the id from the route params', async () => {
const getOne = jest
.fn()
.mockImplementationOnce(() =>
Promise.resolve({ data: { id: 'test?', title: 'hello' } })
);
const dataProvider = { getOne } as unknown as DataProvider;
render(
<TestMemoryRouter initialEntries={['/posts/test%3F']}>
<CoreAdminContext dataProvider={dataProvider}>
<Routes>
<Route
path="posts/:id"
element={
<ShowController resource="posts">
{({ record }) => (
<div>{record && record.title}</div>
)}
</ShowController>
}
/>
</Routes>
</CoreAdminContext>
</TestMemoryRouter>
);
await waitFor(() => {
expect(getOne).toHaveBeenCalledWith('posts', {
id: 'test?',
signal: undefined,
it.each([
{ id: 'test?', url: '/posts/test%3F' },
{ id: 'test%', url: '/posts/test%25' },
])(
'should decode the id $id from the route params',
async ({ id, url }) => {
const getOne = jest
.fn()
.mockImplementationOnce(() =>
Promise.resolve({ data: { id, title: 'hello' } })
);
const dataProvider = { getOne } as unknown as DataProvider;
render(<EncodedId id={id} url={url} dataProvider={dataProvider} />);
await waitFor(() => {
expect(getOne).toHaveBeenCalledWith('posts', {
id,
signal: undefined,
});
});
});
await waitFor(() => {
expect(screen.queryAllByText('hello')).toHaveLength(1);
});
});
await waitFor(() => {
expect(screen.queryAllByText('Title: hello')).toHaveLength(1);
});
}
);

it('should use the id provided through props if any', async () => {
const getOne = jest
Expand Down
85 changes: 85 additions & 0 deletions packages/ra-core/src/controller/show/useShowController.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
import * as React from 'react';
import { Route, Routes, useLocation } from 'react-router';
import {
CoreAdminContext,
ShowController,
testDataProvider,
TestMemoryRouter,
} from '../..';

export default {
title: 'ra-core/controller/useShowController',
};

export const EncodedId = ({
id = 'test?',
url = '/posts/test%3F',
dataProvider = testDataProvider({
// @ts-expect-error
getOne: () => Promise.resolve({ data: { id, title: 'hello' } }),
}),
}) => {
return (
<TestMemoryRouter initialEntries={[url]}>
<CoreAdminContext dataProvider={dataProvider}>
<Routes>
<Route
path="/posts/:id"
element={
<ShowController resource="posts">
{({ record }) => (
<>
<LocationInspector />
<p>Id: {record && record.id}</p>
<p>Title: {record && record.title}</p>
</>
)}
</ShowController>
}
/>
</Routes>
</CoreAdminContext>
</TestMemoryRouter>
);
};

export const EncodedIdWithPercentage = ({
slax57 marked this conversation as resolved.
Show resolved Hide resolved
id = 'test%',
url = '/posts/test%25',
dataProvider = testDataProvider({
// @ts-expect-error
getOne: () => Promise.resolve({ data: { id, title: 'hello' } }),
}),
}) => {
return (
<TestMemoryRouter initialEntries={[url]}>
<CoreAdminContext dataProvider={dataProvider}>
<Routes>
<Route
path="/posts/:id"
element={
<ShowController resource="posts">
{({ record }) => (
<>
<LocationInspector />
<p>Id: {record && record.id}</p>
<p>Title: {record && record.title}</p>
</>
)}
</ShowController>
}
/>
</Routes>
</CoreAdminContext>
</TestMemoryRouter>
);
};

const LocationInspector = () => {
const location = useLocation();
return (
<p>
Location: <code>{location.pathname}</code>
</p>
);
};
2 changes: 1 addition & 1 deletion packages/ra-core/src/controller/show/useShowController.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ export const useShowController = <RecordType extends RaRecord = any>(
'useShowController requires an id prop or a route with an /:id? parameter.'
);
}
const id = propsId != null ? propsId : decodeURIComponent(routeId!);
const id = propsId != null ? propsId : routeId;
const { meta, ...otherQueryOptions } = queryOptions;

const {
Expand Down
Loading