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.

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

FIO-4871: Fixed calculated value for data grid component #5448

Merged
merged 1 commit into from
Jan 16, 2024
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
4 changes: 2 additions & 2 deletions src/components/_classes/component/Component.js
Original file line number Diff line number Diff line change
Expand Up @@ -2923,7 +2923,7 @@ export default class Component extends Element {

if (fromSubmission) {
// If we set value from submission and it differs from calculated one, set the calculated value to prevent overriding dataValue in the next pass
this.calculatedValue = calculatedValue;
this.calculatedValue = fastCloneDeep(calculatedValue);
return false;
}

Expand All @@ -2934,7 +2934,7 @@ export default class Component extends Element {
}
}

this.calculatedValue = calculatedValue;
this.calculatedValue = fastCloneDeep(calculatedValue);

if (changed) {
if (!flags.noPristineChangeOnModified) {
Expand Down
12 changes: 12 additions & 0 deletions src/components/datagrid/DataGrid.js
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,18 @@ export default class DataGridComponent extends NestedArrayComponent {
}));
}

isEmpty(value = this.dataValue) {
const isEmpty = super.isEmpty(value);

if (this.components.length) {
return this.components.reduce((isEmpty, component) => {
return isEmpty && component.isEmpty();
}, true);
}

return isEmpty;
}

/**
* Split rows into chunks.
* @param {Number[]} groups - array of numbers where each item is size of group
Expand Down
66 changes: 65 additions & 1 deletion src/components/datagrid/DataGrid.unit.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ import {
modalWithRequiredFields,
withConditionalFieldsAndValidations,
withLogic,
withCollapsibleRowGroups
withCollapsibleRowGroups,
withAllowCalculateOverride
} from './fixtures';

describe('DataGrid Component', () => {
Expand Down Expand Up @@ -501,3 +502,66 @@ describe('DataGrid modal', () => {
.catch(done);
});
});

describe('DataGrid calculated values', () => {
it('Should allow override calculated value', (done) => {
Formio.createForm(document.createElement('div'), withAllowCalculateOverride)
.then((form) => {
const select = form.getComponent('select');
const dataGrid = form.getComponent('dataGrid');

assert.deepEqual(dataGrid.getValue(),
[{
firstName: 'initial 1',
lastName: 'initial 2'
},
{
firstName: 'initial 1b',
lastName: 'initial 2b'
}]
);

select.setValue('a', { modified: true });
setTimeout(() => {
assert.deepEqual(dataGrid.getValue(),
[{
firstName: 'A f 1',
lastName: 'A l 1'
}]
);

select.setValue('b', { modified: true });
setTimeout(() => {
assert.deepEqual(dataGrid.getValue(),
[{
firstName: 'B f 1',
lastName: 'B l 1'
},
{
firstName: 'B f 2',
lastName: 'B l 2'
}]
);

const firstName = form.getComponent(['dataGrid', 0, 'firstName']);
firstName.setValue('first name', { modified: true });
select.setValue('c', { modified: true });
setTimeout(() => {
assert.deepEqual(dataGrid.getValue(),
[{
firstName: 'first name',
lastName: 'B l 1'
},
{
firstName: 'B f 2',
lastName: 'B l 2'
}]
);
done();
}, 300);
}, 300);
}, 300);
})
.catch(done);
});
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
export default {
type: 'form',
display: 'form',
components: [
{
label: 'Select',
widget: 'choicesjs',
tableView: true,
data: {
values: [
{
label: 'a',
value: 'a'
},
{
label: 'b',
value: 'b'
},
{
label: 'c',
value: 'c'
}
]
},
key: 'select',
type: 'select',
input: true
},
{
label: 'Data Grid',
reorder: false,
addAnotherPosition: 'bottom',
layoutFixed: false,
enableRowGroups: false,
initEmpty: false,
tableView: false,
defaultValue: [
{
firstName: '',
lastName: ''
}
],
calculateValue: "var temp = [\n {'firstName': 'initial 1','lastName': 'initial 2'},\n {'firstName': 'initial 1b','lastName': 'initial 2b'},\n ];\n if(data.select === 'a')\n {\n temp = [{'firstName': 'A f 1','lastName': 'A l 1'}];\n } else if(data.select === 'b') { \n temp = [{'firstName': 'B f 1','lastName': 'B l 1'} \n ,{'firstName': 'B f 2','lastName': 'B l 2'}];\n } else if(data.select === 'c') { \n temp = [{'firstName': 'C f 1','lastName': 'C l 1'}];\n }\n value = temp;",
allowCalculateOverride: true,
key: 'dataGrid',
type: 'datagrid',
input: true,
components: [
{
label: 'First Name',
tableView: true,
key: 'firstName',
type: 'textfield',
input: true
},
{
label: 'Last Name',
tableView: true,
key: 'lastName',
type: 'textfield',
input: true
}
]
}
]
};
3 changes: 2 additions & 1 deletion src/components/datagrid/fixtures/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,5 @@ import modalWithRequiredFields from './comp-modal-with-required-fields';
import withConditionalFieldsAndValidations from './comp-with-conditional-components-and-validations';
import withLogic from './comp-with-logic';
import withCollapsibleRowGroups from './comp-with-collapsible-groups';
export { comp1, comp2, comp3, comp4, comp5, comp6, comp7, comp8, withCollapsibleRowGroups, withConditionalFieldsAndValidations, withDefValue, withLogic, withRowGroupsAndDefValue, modalWithRequiredFields };
import withAllowCalculateOverride from './comp-with-allow-calculate-override';
export { comp1, comp2, comp3, comp4, comp5, comp6, comp7, comp8, withCollapsibleRowGroups, withConditionalFieldsAndValidations, withDefValue, withLogic, withRowGroupsAndDefValue, modalWithRequiredFields, withAllowCalculateOverride };
5 changes: 5 additions & 0 deletions src/components/editgrid/EditGrid.js
Original file line number Diff line number Diff line change
Expand Up @@ -673,6 +673,11 @@ export default class EditGridComponent extends NestedArrayComponent {
: this.editRows.reduce((result, row) => result.concat(row.components || []), []);
}

destroy(all = false) {
this.calculatedValue = undefined;
super.destroy(all);
}

destroyComponents(all = false, rowIndex = 0) {
if (this.builderMode) {
return super.destroyComponents(all);
Expand Down
9 changes: 7 additions & 2 deletions test/forms/helpers/testBasicComponentSettings/tests.js
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,7 @@ export default {
done();
},
},

redrawOn: {
'Should redraw on checkbox value change'(form, done) {
const checkboxValue = form.data.checkbox;
Expand Down Expand Up @@ -492,7 +492,12 @@ export default {
assert.deepEqual(!!confirmationDialogAfter, false, `${compKey} (component ${compType}): should close confirmation dialog`);

if (!componentsWithBug.includes(compType)) {
assert.deepEqual(comp.getValue(), initialValue, `${compKey} (component ${compType}): should clear value in modalEdit mode`);
if (compType === 'form') {
assert.deepEqual(comp.getValue().data, initialValue.data, `${compKey} (component ${compType}): should clear value in modalEdit mode`);
}
else {
assert.deepEqual(comp.getValue(), initialValue, `${compKey} (component ${compType}): should clear value in modalEdit mode`);
}
}

assert.deepEqual(isModalWindowOpened(), false, `${compKey} (component ${compType}): should close modal window`);
Expand Down
Loading