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-8091: added selectData calculation for url/resource select components #5564

Merged
merged 2 commits into from
Apr 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
120 changes: 120 additions & 0 deletions src/WebformBuilder.unit.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import assert from 'power-assert';
import Harness from '../test/harness';
import WebformBuilder from './WebformBuilder';
import Builders from './builders';
import { Formio } from './Formio';
import { uniqueApiKeys, uniqueApiKeysLayout, uniqueApiKeysSameLevel, columnsForm, resourceKeyCamelCase } from '../test/formtest';
import sameApiKeysLayoutComps from '../test/forms/sameApiKeysLayoutComps';
import testApiKeysUniquifying from '../test/forms/testApiKeysUniquifying';
Expand Down Expand Up @@ -269,3 +270,122 @@ describe('WebformBuilder tests', function() {
}).catch(done);
});
});

describe('Select Component selectData property', () => {
const originalMakeRequest = Formio.makeRequest;

before((done) => {
Formio.makeRequest = () => {
return new Promise(resolve => {
const values = [{
label: 'Label 1',
value: 'value1',
}, {
label: 'Label 2',
value: 'value2',
}];

resolve(values);
});
};
Harness.builderBefore(done);
});
afterEach(() => Harness.getBuilder().setForm({ display: 'form', components: [] }));

it('Should calculate selectData property for url dataSource', (done) => {
const builder = Harness.getBuilder();
builder.setForm({}).then(() => {
Harness.buildComponent('select');

setTimeout(() => {
const dataSrc = builder.editForm.getComponent('dataSrc');
dataSrc.setValue('url');
const url = builder.editForm.getComponent(['data.url']);
const valueProperty = builder.editForm.getComponent('valueProperty');
url.setValue('htts//fakeurl.com');
valueProperty.setValue('value');

setTimeout(() => {
const defaultValue = builder.editForm.getComponent('defaultValue');
defaultValue.setValue('value1');
defaultValue.updateItems(null, true);

setTimeout(() => {
assert.deepEqual(builder.editForm.data.selectData, {
label: 'Label 1',
});
Harness.saveComponent();
setTimeout(() => {
done();
}, 150);
}, 250);
}, 250);
}, 150);
}).catch(done);
});

it('Should calculate selectData property for resource dataSource', (done) => {
const builder = Harness.getBuilder();
builder.setForm({}).then(() => {
Harness.buildComponent('select');

setTimeout(() => {
const dataSrc = builder.editForm.getComponent('dataSrc');
dataSrc.setValue('resource');
const resource = builder.editForm.getComponent(['data.resource']);
const valueProperty = builder.editForm.getComponent('valueProperty');
resource.setValue('12345678');
valueProperty.setValue('value');

setTimeout(() => {
const defaultValue = builder.editForm.getComponent('defaultValue');
defaultValue.setValue('value1');
defaultValue.updateItems(null, true);

setTimeout(() => {
assert.deepEqual(builder.editForm.data.selectData, {
label: 'Label 1',
});
Harness.saveComponent();
setTimeout(() => {
done();
}, 150);
}, 250);
}, 250);
}, 150);
}).catch(done);
});

it('Should not calculate selectData property without valueProperty', (done) => {
const builder = Harness.getBuilder();
builder.setForm({}).then(() => {
Harness.buildComponent('select');

setTimeout(() => {
const dataSrc = builder.editForm.getComponent('dataSrc');
dataSrc.setValue('url');
const url = builder.editForm.getComponent(['data.url']);
url.setValue('https://fakeurl.com');

setTimeout(() => {
const defaultValue = builder.editForm.getComponent('defaultValue');
defaultValue.setValue('value1');
defaultValue.updateItems(null, true);

setTimeout(() => {
assert.equal(builder.editForm.data.selectData, undefined);
Harness.saveComponent();
setTimeout(() => {
done();
}, 150);
}, 250);
}, 250);
}, 150);
}).catch(done);
});

after((done) => {
Formio.makeRequest = originalMakeRequest;
Harness.builderAfter(done);
});
});
4 changes: 4 additions & 0 deletions src/components/select/Select.js
Original file line number Diff line number Diff line change
Expand Up @@ -254,6 +254,10 @@ export default class SelectComponent extends ListComponent {
return super.shouldLoad;
}

get selectData() {
return this.component.selectData || super.selectData;
}

isEntireObjectDisplay() {
return this.component.dataSrc === 'resource' && this.valueProperty === 'data';
}
Expand Down
1 change: 1 addition & 0 deletions src/components/select/Select.unit.js
Original file line number Diff line number Diff line change
Expand Up @@ -1212,3 +1212,4 @@ describe('Select Component with Entire Object Value Property', () => {
});
});
});

62 changes: 61 additions & 1 deletion src/components/select/editForm/Select.edit.data.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,33 @@
import _ from 'lodash';
import { eachComponent } from '../../../utils/utils';

const calculateSelectData = (context) => {
const { instance, data } = context;
const rawDefaultValue = instance.downloadedResources.find(resource => _.get(resource, data.valueProperty) === instance.getValue());
const options = { data: {}, noeval: true };
instance.interpolate(data.template, {
item: rawDefaultValue,
}, options);
return options.data.item;
};

const setSelectData = (context) => {
// Wait before downloadedResources will be set
setTimeout(() => {
const { instance, data } = context;
const selectDataComponent = instance?.root.getComponent('selectData');
// nothing can set if don't have downloaded resources
if (!selectDataComponent || !instance.getValue() || !instance.downloadedResources?.length) {
return;
}
// if valueProperty is not provided, we have entire object
const shouldCalculateUrlData = data.dataSrc === 'url' && data.data.url && data.valueProperty;
const shouldCalculateResourceData = data.dataSrc === 'resource' && data.data.resource && data.valueProperty;
const newValue = shouldCalculateUrlData || shouldCalculateResourceData ? calculateSelectData(context) : undefined;
selectDataComponent.setValue(newValue);
}, 0);
};

export default [
{
key: 'dataSrc',
Expand Down Expand Up @@ -625,5 +653,37 @@ export default [
key: 'useExactSearch',
label: 'Use exact search',
tooltip: 'Disables search algorithm threshold.',
}
},
{
key: 'defaultValue',
onSetItems(component) {
setSelectData(component.evalContext());
},
onChange(context) {
if (context && context.flags && context.flags.modified) {
setSelectData(context);
}
},
},
{
key: 'selectData',
conditional: {
json: { 'and': [
{ '!==': [{ var: 'data.valueProperty' }, null] },
{ '!==': [{ var: 'data.valueProperty' }, ''] },
] },
},
},
{
key: 'template',
onChange(context) {
if (context && context.flags && context.flags.modified) {
const defaultValueComponent = context.instance.root.getComponent('defaultValue');
if (!defaultValueComponent) {
return;
}
setSelectData(defaultValueComponent.evalContext());
}
},
},
];
Loading