Skip to content

(fix)ResourceGuesser: Fix <ResourceGuesser> ignores recordRepresentation prop #611

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

Merged
merged 3 commits into from
Mar 18, 2025
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
83 changes: 83 additions & 0 deletions src/core/ResourceGuesser.test.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,65 @@
import React from 'react';
import {
AdminContext,
useGetOne,
useGetRecordRepresentation,
} from 'react-admin';
import ReactTestRenderer from 'react-test-renderer/shallow';
import { Resource } from '@api-platform/api-doc-parser';
import { render, screen } from '@testing-library/react';
import '@testing-library/jest-dom';
import ResourceGuesser from './ResourceGuesser.js';
import SchemaAnalyzerContext from '../introspection/SchemaAnalyzerContext.js';
import schemaAnalyzer from '../hydra/schemaAnalyzer.js';
import type {
ApiPlatformAdminDataProvider,
ApiPlatformAdminRecord,
} from '../types.js';
import { API_FIELDS_DATA } from '../__fixtures__/parsedData.js';

const hydraSchemaAnalyzer = schemaAnalyzer();
const dataProvider: ApiPlatformAdminDataProvider = {
getList: () => Promise.resolve({ data: [], total: 0 }),
getMany: () => Promise.resolve({ data: [] }),
getManyReference: () => Promise.resolve({ data: [], total: 0 }),
update: <RecordType extends ApiPlatformAdminRecord>() =>
Promise.resolve({ data: { id: 'id' } } as { data: RecordType }),
updateMany: () => Promise.resolve({ data: [] }),
create: <RecordType extends ApiPlatformAdminRecord>() =>
Promise.resolve({ data: { id: 'id' } } as { data: RecordType }),
delete: <RecordType extends ApiPlatformAdminRecord>() =>
Promise.resolve({ data: { id: 'id' } } as { data: RecordType }),
deleteMany: () => Promise.resolve({ data: [] }),
getOne: () =>
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-ignore
Promise.resolve({
data: {
id: '/users/123',
fieldA: 'fieldA value',
fieldB: 'fieldB value',
deprecatedField: 'deprecatedField value',
title: 'Title',
body: 'Body',
},
}),
introspect: () =>
Promise.resolve({
data: {
entrypoint: 'entrypoint',
resources: [
new Resource('users', '/users', {
fields: API_FIELDS_DATA,
readableFields: API_FIELDS_DATA,
writableFields: API_FIELDS_DATA,
parameters: [],
}),
],
},
}),
subscribe: () => Promise.resolve({ data: null }),
unsubscribe: () => Promise.resolve({ data: null }),
};

describe('<ResourceGuesser />', () => {
const renderer = ReactTestRenderer.createRenderer();
Expand Down Expand Up @@ -60,4 +119,28 @@ describe('<ResourceGuesser />', () => {

expect(renderer.getRenderOutput()).toMatchSnapshot();
});

test('supports recordRepresentation', async () => {
const TestComponent = () => {
const { data: user } = useGetOne('users', { id: '/users/123' });
const getRecordRepresentation = useGetRecordRepresentation('users');
if (!user) {
return 'loading';
}
return getRecordRepresentation(user);
};
render(
<AdminContext dataProvider={dataProvider}>
<SchemaAnalyzerContext.Provider value={hydraSchemaAnalyzer}>
<ResourceGuesser
name="users"
list={<TestComponent />}
recordRepresentation="fieldA"
/>
</SchemaAnalyzerContext.Provider>
</AdminContext>,
);

await screen.findByText('fieldA value');
});
});
3 changes: 3 additions & 0 deletions src/core/ResourceGuesser.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ export const IntrospectedResourceGuesser = ({
name: resource,
icon: props.icon,
options: props.options,
recordRepresentation: props.recordRepresentation,
hasList,
hasEdit,
hasCreate,
Expand All @@ -69,6 +70,7 @@ export const IntrospectedResourceGuesser = ({
resource,
props.icon,
props.options,
props.recordRepresentation,
hasList,
hasEdit,
hasCreate,
Expand Down Expand Up @@ -104,6 +106,7 @@ ResourceGuesser.registerResource = (
name: props.name,
icon: props.icon,
options: props.options,
recordRepresentation: props.recordRepresentation,
hasList: true,
hasEdit: true,
hasCreate: true,
Expand Down
2 changes: 1 addition & 1 deletion src/stories/custom/AdvancedCustomization.stories.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@ export const AdvancedCustomization = () => (
show={BookShow}
edit={BookEdit}
create={BookCreate}
recordRepresentation="name"
recordRepresentation="title"
icon={AutoStoriesIcon}
/>
<ResourceGuesser
Expand Down