Skip to content

fix(customizer): validate fields on user facing collection interface #731

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
Thenkei merged 2 commits into from
Jun 19, 2023
Merged

fix(customizer): validate fields on user facing collection interface #731

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
33ddf57
fix: validate fields on user facing collections relaxed collection)
Thenkei Jun 15, 2023
17c1fce
test: add unit tests
Thenkei Jun 15, 2023
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
3 changes: 3 additions & 0 deletions packages/datasource-customizer/src/context/relaxed-wrappers/collection.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import {
PaginatedFilter,
Projection,
RecordData,
RecordValidator,
Sort,
} from '@forestadmin/datasource-toolkit';

Expand Down Expand Up @@ -132,6 +133,8 @@ export default class RelaxedCollection<
update(filter: TFilter<S, N>, patch: TPartialSimpleRow<S, N>): Promise<void> {
const filterInstance = this.buildFilter(filter);

RecordValidator.validate(this.collection, patch);

return this.collection.update(this.caller, filterInstance, patch);
}

Expand Down
16 changes: 15 additions & 1 deletion packages/datasource-customizer/test/context/wrapper.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,13 @@ describe('RelaxedWrappers', () => {

beforeEach(() => {
caller = factories.caller.build();
collection = factories.collection.build();
collection = factories.collection.build({
schema: {
fields: {
name: factories.columnSchema.build({ columnType: 'String' }),
},
},
});
relaxed = new RelatedCollection(collection, caller);
});

Expand Down Expand Up @@ -154,6 +160,14 @@ describe('RelaxedWrappers', () => {
);
});

test('should validate patch operation before forwarding update', async () => {
await expect(() =>
relaxed.update({ segment: 'some_segment' }, { nonexistingField: 'newValue' }),
).toThrow('Unknown field "nonexistingField"');

expect(collection.update).not.toHaveBeenCalled();
});

test('should forward delete and transform filter', async () => {
await relaxed.delete({ segment: 'some_segment' });

Expand Down