Skip to content
This repository has been archived by the owner on Jan 4, 2022. It is now read-only.

fix: building indices on arrays using prefixItems #343

Merged
merged 4 commits into from
Aug 31, 2021
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
10 changes: 9 additions & 1 deletion lib/dataContract/validation/validateDataContractFactory.js
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,15 @@ module.exports = function validateDataContractFactory(
if (propertyType === 'array' && !isByteArray) {
const { items, prefixItems } = propertyDefinition;

if (prefixItems || items.type === 'object' || items.type === 'array') {
const isInvalidPrefixItems = prefixItems
&& (
prefixItems.some((prefixItem) => prefixItem.type === 'object' || prefixItem.type === 'array')
|| !prefixItems.every((prefixItem) => prefixItem.type === prefixItems[0].type)
);

const isInvalidItemTypes = items.type === 'object' || items.type === 'array';

if (isInvalidPrefixItems || isInvalidItemTypes) {
invalidPropertyType = 'array';
}
}
Expand Down
24 changes: 24 additions & 0 deletions lib/test/fixtures/getDataContractFixture.js
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,30 @@ module.exports = function getDataContractFixture(ownerId = randomOwnerId) {
required: ['firstName', '$createdAt', '$updatedAt', 'lastName'],
additionalProperties: false,
},
indexedArray: {
type: 'object',
indices: [
{
properties: [
{ mentions: 'asc' },
],
},
],
properties: {
mentions: {
type: 'array',
prefixItems: [
{
type: 'string',
},
],
minItems: 1,
maxItems: 5,
items: false,
},
},
additionalProperties: false,
},
noTimeDocument: {
type: 'object',
properties: {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ describe('validateDataContractFactory', function main() {
it('should be present', async () => {
rawDataContract = {
documents: {
zalupa: {
someDocument: {
type: 'object',
},
},
Expand Down Expand Up @@ -1555,6 +1555,86 @@ describe('validateDataContractFactory', function main() {
expect(error.getIndexDefinition()).to.deep.equal(indexDefinition);
});

it('should return invalid result if index property is an array of different types', async () => {
const indexedDocumentDefinition = rawDataContract.documents.indexedArray;

const indexDefinition = indexedDocumentDefinition.indices[0];

rawDataContract.documents.indexedArray.properties.mentions.prefixItems = [
{
type: 'string',
},
{
type: 'number',
},
];

rawDataContract.documents.indexedArray.properties.mentions.minItems = 2;

const result = await validateDataContract(rawDataContract);
expectValidationError(result, InvalidIndexPropertyTypeError);

const [error] = result.getErrors();
expect(error.getPropertyName()).to.equal('mentions');
expect(error.getPropertyType()).to.equal('array');
expect(error.getRawDataContract()).to.deep.equal(rawDataContract);
expect(error.getDocumentType()).to.deep.equal('indexedArray');
expect(error.getIndexDefinition()).to.deep.equal(indexDefinition);
});

it('should return invalid result if index property contained prefixItems array of arrays', async () => {
const indexedDocumentDefinition = rawDataContract.documents.indexedArray;

const indexDefinition = indexedDocumentDefinition.indices[0];

rawDataContract.documents.indexedArray.properties.mentions.prefixItems = [
{
type: 'array',
items: {
type: 'string',
},
},
];

const result = await validateDataContract(rawDataContract);
expectValidationError(result, InvalidIndexPropertyTypeError);

const [error] = result.getErrors();
expect(error.getPropertyName()).to.equal('mentions');
expect(error.getPropertyType()).to.equal('array');
expect(error.getRawDataContract()).to.deep.equal(rawDataContract);
expect(error.getDocumentType()).to.deep.equal('indexedArray');
expect(error.getIndexDefinition()).to.deep.equal(indexDefinition);
});

it('should return invalid result if index property contained prefixItems array of objects', async () => {
const indexedDocumentDefinition = rawDataContract.documents.indexedArray;

const indexDefinition = indexedDocumentDefinition.indices[0];

rawDataContract.documents.indexedArray.properties.mentions.prefixItems = [
{
type: 'object',
properties: {
something: {
type: 'string',
},
},
additionalProperties: false,
},
];

const result = await validateDataContract(rawDataContract);
expectValidationError(result, InvalidIndexPropertyTypeError);

const [error] = result.getErrors();
expect(error.getPropertyName()).to.equal('mentions');
expect(error.getPropertyType()).to.equal('array');
expect(error.getRawDataContract()).to.deep.equal(rawDataContract);
expect(error.getDocumentType()).to.deep.equal('indexedArray');
expect(error.getIndexDefinition()).to.deep.equal(indexDefinition);
});

it('should return invalid result if index property is array of arrays', async () => {
const indexedDocumentDefinition = rawDataContract.documents.indexedDocument;

Expand Down