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

[DataGrid] getValueError in valueGetter if incorrect field is supplied #755

Merged
merged 3 commits into from
Dec 21, 2020
Merged

[DataGrid] getValueError in valueGetter if incorrect field is supplied #755

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
9d3aa8e
fix: getValueError in valueGetter if incorrect field is supplied
ZeeshanTamboli Dec 18, 2020
8f3bbeb
polish test case
oliviertassinari Dec 18, 2020
877c5cd
Review from Damien
oliviertassinari Dec 21, 2020
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
18 changes: 17 additions & 1 deletion packages/grid/_modules_/grid/utils/paramsUtils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ import { GridApi } from '../models/api/gridApi';
import { CellParams } from '../models/params/cellParams';
import { RowParams } from '../models/params/rowParams';

let warnedOnce = false;

export function buildCellParams({
element,
value,
Expand All @@ -27,9 +29,23 @@ export function buildCellParams({
getValue: (field: string) => {
// We are getting the value of another column here, field
const col = api.getColumnFromField(field);
if (!col.valueGetter) {

if (process.env.NODE_ENV !== 'production') {
if (!col && !warnedOnce) {
console.warn(
[
`Material-UI: You are calling getValue('${field}') but the column \`${field}\` is not defined.`,
`Instead, you can access the data from \`params.row.${field}\`.`,
].join('\n'),
);
warnedOnce = true;
}
}

if (!col || !col.valueGetter) {
return rowModel[field];
}

return col.valueGetter(
buildCellParams({
value: rowModel[field],
Expand Down
25 changes: 24 additions & 1 deletion packages/grid/data-grid/src/tests/layout.DataGrid.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import {
} from 'test/utils';
import { useFakeTimers } from 'sinon';
import { expect } from 'chai';
import { DataGrid } from '@material-ui/data-grid';
import { DataGrid, ValueGetterParams } from '@material-ui/data-grid';
import { getColumnValues, raf } from 'test/utils/helperFn';

describe('<DataGrid /> - Layout & Warnings', () => {
Expand Down Expand Up @@ -160,6 +160,29 @@ describe('<DataGrid /> - Layout & Warnings', () => {
'Material-UI: useResizeContainer - The parent of the grid has an empty width.',
);
});

it('should warn when CellParams.valueGetter is called with a missing column', () => {
const rows = [
{ id: 1, age: 1 },
{ id: 2, age: 2 },
];
const columns = [
{ field: 'id', hide: true },
{
field: 'fullName',
valueGetter: (params: ValueGetterParams) => params.getValue('age'),
},
];
expect(() => {
render(
<div style={{ width: 300, height: 300 }}>
<DataGrid rows={rows} columns={columns} />
</div>,
);
// @ts-expect-error need to migrate helpers to TypeScript
}).toWarnDev(["You are calling getValue('age') but the column `age` is not defined"]);
expect(getColumnValues()).to.deep.equal(['1', '2']);
});
});

describe('column width', () => {
Expand Down