Skip to content

separate test and default data providers #10001

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
djhi merged 3 commits into from
Jul 19, 2024
Merged

separate test and default data providers #10001

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4f599ab
separate test and default data providers
Nilegfx Jul 13, 2024
62145d7
use as Dataprovider to workaround the type-check
Nilegfx Jul 15, 2024
284fd8a
fix types and remove typo
Nilegfx Jul 16, 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
38 changes: 10 additions & 28 deletions packages/ra-core/src/dataProvider/defaultDataProvider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,31 +2,13 @@ import { DataProvider } from '../types';

// avoids adding a context in tests
export const defaultDataProvider: DataProvider = {
create: async () => {
throw new Error('create is not implemented');
},
delete: async () => {
throw new Error('delete not implemented');
},
deleteMany: async () => {
throw new Error('deleteMany is not implemented');
},
getList: async () => {
throw new Error('getList is not implemented');
},
getMany: async () => {
throw new Error('getMany is not implemented');
},
getManyReference: async () => {
throw new Error('getManyReference is not implemented');
},
getOne: async () => {
throw new Error('getOne is not implemented');
},
update: async () => {
throw new Error('update not implemented');
},
updateMany: async () => {
throw new Error('updateMany not implemented');
},
};
create: () => Promise.resolve({ data: null }),
delete: () => Promise.resolve({ data: null }),
deleteMany: () => Promise.resolve({ data: [] }),
getList: () => Promise.resolve({ data: [], total: 0 }),
getMany: () => Promise.resolve({ data: [] }),
getManyReference: () => Promise.resolve({ data: [], total: 0 }),
getOne: () => Promise.resolve({ data: { id: 'o' } }),
Copy link
Contributor

@adguernier adguernier Jul 16, 2024

Choose a reason for hiding this comment

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

question: why { data: { id: 'o' } } instead of { data: null } like the others?

Copy link
Contributor Author

@Nilegfx Nilegfx Jul 16, 2024

Choose a reason for hiding this comment

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

oh, that was committed by mistake, I will remove it.

update: () => Promise.resolve({ data: null }),
updateMany: () => Promise.resolve({ data: [] }),
} as DataProvider;
33 changes: 31 additions & 2 deletions packages/ra-core/src/dataProvider/testDataProvider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import { DataProvider } from '../types';
import { defaultDataProvider } from './defaultDataProvider';

/**
* A dataProvider meant to be used in tests only. You can override any of its methods by passing a partial dataProvider.
Expand All @@ -9,9 +8,39 @@ import { defaultDataProvider } from './defaultDataProvider';
* getOne: async () => ({ data: { id: 123, title: 'foo' }})
* })
*/

const defaultTestDataProvider: DataProvider = {
create: async () => {
throw new Error('create is not implemented');
},
delete: async () => {
throw new Error('delete not implemented');
},
deleteMany: async () => {
throw new Error('deleteMany is not implemented');
},
getList: async () => {
throw new Error('getList is not implemented');
},
getMany: async () => {
throw new Error('getMany is not implemented');
},
getManyReference: async () => {
throw new Error('getManyReference is not implemented');
},
getOne: async () => {
throw new Error('getOne is not implemented');
},
update: async () => {
throw new Error('update not implemented');
},
updateMany: async () => {
throw new Error('updateMany not implemented');
},
};
export const testDataProvider = (
overrides?: Partial<DataProvider>
): DataProvider => ({
...defaultDataProvider,
...defaultTestDataProvider,
...overrides,
});