-
Notifications
You must be signed in to change notification settings - Fork 39
/
validateDataContractFactory.js
337 lines (286 loc) · 11.8 KB
/
validateDataContractFactory.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
const JsonSchemaValidator = require('../../validation/JsonSchemaValidator');
const ValidationResult = require('../../validation/ValidationResult');
const DataContract = require('../DataContract');
const baseDocumentSchema = require('../../../schema/document/documentBase.json');
const DuplicateIndexError = require('../../errors/consensus/basic/dataContract/DuplicateIndexError');
const UndefinedIndexPropertyError = require('../../errors/consensus/basic/dataContract/UndefinedIndexPropertyError');
const InvalidIndexPropertyTypeError = require('../../errors/consensus/basic/dataContract/InvalidIndexPropertyTypeError');
const SystemPropertyIndexAlreadyPresentError = require('../../errors/consensus/basic/dataContract/SystemPropertyIndexAlreadyPresentError');
const UniqueIndicesLimitReachedError = require('../../errors/consensus/basic/dataContract/UniqueIndicesLimitReachedError');
const InvalidIndexedPropertyConstraintError = require('../../errors/consensus/basic/dataContract/InvalidIndexedPropertyConstraintError');
const InvalidCompoundIndexError = require('../../errors/consensus/basic/dataContract/InvalidCompoundIndexError');
const convertBuffersToArrays = require('../../util/convertBuffersToArrays');
const DuplicateIndexNameError = require('../../errors/consensus/basic/dataContract/DuplicateIndexNameError');
const allowedIndexSystemProperties = ['$ownerId', '$createdAt', '$updatedAt'];
const notAllowedIndexProperties = ['$id'];
const MAX_INDEXED_STRING_PROPERTY_LENGTH = 63;
const MAX_INDEXED_BYTE_ARRAY_PROPERTY_LENGTH = 255;
const MAX_INDEXED_ARRAY_ITEMS = 1024;
/**
* @param {JsonSchemaValidator} jsonSchemaValidator
* @param {validateDataContractMaxDepth} validateDataContractMaxDepth
* @param {enrichDataContractWithBaseSchema} enrichDataContractWithBaseSchema
* @param {validateDataContractPatterns} validateDataContractPatterns
* @param {validateProtocolVersion} validateProtocolVersion
* @param {getPropertyDefinitionByPath} getPropertyDefinitionByPath
* @return {validateDataContract}
*/
module.exports = function validateDataContractFactory(
jsonSchemaValidator,
validateDataContractMaxDepth,
enrichDataContractWithBaseSchema,
validateDataContractPatterns,
validateProtocolVersion,
getPropertyDefinitionByPath,
) {
/**
* @typedef validateDataContract
* @param {RawDataContract} rawDataContract
* @return {ValidationResult}
*/
async function validateDataContract(rawDataContract) {
const result = new ValidationResult();
// Validate Data Contract schema
result.merge(
jsonSchemaValidator.validate(
JsonSchemaValidator.SCHEMAS.META.DATA_CONTRACT,
convertBuffersToArrays(rawDataContract),
),
);
if (!result.isValid()) {
return result;
}
result.merge(
validateProtocolVersion(rawDataContract.protocolVersion),
);
if (!result.isValid()) {
return result;
}
result.merge(
await validateDataContractMaxDepth(rawDataContract),
);
// Validate regexp patterns are compatible with Re2
result.merge(
validateDataContractPatterns(rawDataContract),
);
if (!result.isValid()) {
return result;
}
// Validate Document JSON Schemas
const enrichedDataContract = enrichDataContractWithBaseSchema(
new DataContract(rawDataContract),
baseDocumentSchema,
enrichDataContractWithBaseSchema.PREFIX_BYTE_0,
);
Object.keys(enrichedDataContract.getDocuments()).forEach((documentType) => {
const documentSchemaRef = enrichedDataContract.getDocumentSchemaRef(
documentType,
);
const additionalSchemas = {
[enrichedDataContract.getJsonSchemaId()]: enrichedDataContract.toJSON(),
};
result.merge(
jsonSchemaValidator.validateSchema(
documentSchemaRef,
additionalSchemas,
),
);
});
if (!result.isValid()) {
return result;
}
// Validate indices
Object.entries(enrichedDataContract.documents).filter(([, documentSchema]) => (
Object.prototype.hasOwnProperty.call(documentSchema, 'indices')
))
.forEach(([documentType, documentSchema]) => {
const indicesFingerprints = [];
let uniqueIndexCount = 0;
let isUniqueIndexLimitReached = false;
// Ensure index names are unique
const indexNames = documentSchema.indices.map((indexDefinition) => indexDefinition.name);
const [nonUniqueIndexName] = indexNames.filter(
(indexName, i) => indexNames.indexOf(indexName) !== i,
);
if (nonUniqueIndexName !== undefined) {
result.addError(new DuplicateIndexNameError(
documentType,
nonUniqueIndexName,
));
}
documentSchema.indices.forEach((indexDefinition) => {
const indexPropertyNames = indexDefinition.properties
.map((property) => Object.keys(property)[0]);
// Ensure there are no more than 3 unique indices
if (!isUniqueIndexLimitReached && indexDefinition.unique) {
uniqueIndexCount++;
if (uniqueIndexCount > UniqueIndicesLimitReachedError.UNIQUE_INDEX_LIMIT) {
isUniqueIndexLimitReached = true;
result.addError(new UniqueIndicesLimitReachedError(
documentType,
));
}
}
// Ensure there are no duplicate system indices
notAllowedIndexProperties
.forEach((propertyName) => {
if (indexPropertyNames.includes(propertyName)) {
result.addError(new SystemPropertyIndexAlreadyPresentError(
documentType,
indexDefinition,
propertyName,
));
}
});
// Ensure index properties are defined in the document
const userDefinedProperties = indexPropertyNames
.filter((name) => !allowedIndexSystemProperties.includes(name));
const propertyDefinitionEntities = userDefinedProperties
.map((propertyName) => (
[
propertyName,
getPropertyDefinitionByPath(documentSchema, propertyName),
]
));
const undefinedProperties = propertyDefinitionEntities
.filter(([, propertyDefinition]) => !propertyDefinition)
.map(([propertyName]) => {
result.addError(
new UndefinedIndexPropertyError(
documentType,
indexDefinition,
propertyName,
),
);
return propertyName;
});
// Skip further validation if there are undefined properties
if (undefinedProperties.length > 0) {
return;
}
// Validate indexed property $defs
propertyDefinitionEntities.forEach(([propertyName, propertyDefinition]) => {
const {
type: propertyType,
byteArray: isByteArray,
} = propertyDefinition;
let invalidPropertyType;
if (propertyType === 'object') {
invalidPropertyType = 'object';
}
// const { items, prefixItems } = propertyDefinition;
// Validate arrays contain scalar values or have the same types
if (propertyType === 'array' && !isByteArray) {
invalidPropertyType = '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';
// }
}
if (invalidPropertyType) {
result.addError(new InvalidIndexPropertyTypeError(
documentType,
indexDefinition,
propertyName,
invalidPropertyType,
));
}
// Validate sting length inside arrays
// if (!invalidPropertyType && propertyType === 'array' && !isByteArray) {
// const isInvalidPrefixItems = prefixItems && prefixItems.some((prefixItem) => (
// prefixItem.type === 'string'
// && (
// !prefixItem.maxLength || prefixItem.maxLength > MAX_INDEXED_STRING_PROPERTY_LENGTH
// )
// ));
//
// const isInvalidItemTypes = items.type === 'string' && (
// !items.maxLength || items.maxLength > MAX_INDEXED_STRING_PROPERTY_LENGTH
// );
//
// if (isInvalidPrefixItems || isInvalidItemTypes) {
// result.addError(
// new InvalidIndexedPropertyConstraintError(
// documentType,
// indexDefinition,
// propertyName,
// 'maxLength',
// `should be less or equal ${MAX_INDEXED_STRING_PROPERTY_LENGTH}`,
// ),
// );
// }
// }
//
if (!invalidPropertyType && propertyType === 'array') {
const { maxItems } = propertyDefinition;
let maxLimit;
if (isByteArray) {
maxLimit = MAX_INDEXED_BYTE_ARRAY_PROPERTY_LENGTH;
} else {
maxLimit = MAX_INDEXED_ARRAY_ITEMS;
}
if ((maxItems === undefined || maxItems > maxLimit)) {
result.addError(
new InvalidIndexedPropertyConstraintError(
documentType,
indexDefinition,
propertyName,
'maxItems',
`should be less or equal ${maxLimit}`,
),
);
}
}
if (propertyType === 'string') {
const { maxLength } = propertyDefinition;
if (maxLength === undefined || maxLength > MAX_INDEXED_STRING_PROPERTY_LENGTH) {
result.addError(
new InvalidIndexedPropertyConstraintError(
documentType,
indexDefinition,
propertyName,
'maxLength',
`should be less or equal ${MAX_INDEXED_STRING_PROPERTY_LENGTH}`,
),
);
}
}
});
// Make sure that compound unique indices contain all fields
if (indexPropertyNames.length > 1) {
const requiredFields = documentSchema.required || [];
const allAreRequired = indexPropertyNames
.every((propertyName) => requiredFields.includes(propertyName));
const allAreNotRequired = indexPropertyNames
.every((propertyName) => !requiredFields.includes(propertyName));
if (!allAreRequired && !allAreNotRequired) {
result.addError(
new InvalidCompoundIndexError(documentType, indexDefinition),
);
}
}
// Ensure index definition uniqueness
const indicesFingerprint = JSON.stringify(indexDefinition.properties);
if (indicesFingerprints.includes(indicesFingerprint)) {
result.addError(
new DuplicateIndexError(
documentType,
indexDefinition,
),
);
}
indicesFingerprints.push(indicesFingerprint);
});
});
return result;
}
return validateDataContract;
};