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
|
// Copyright 2017 Yahoo Holdings. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.vespa.model.application.validation;
import com.fasterxml.jackson.core.JsonFactory;
import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.core.JsonToken;
import com.google.common.base.Joiner;
import com.yahoo.tensor.TensorType;
import java.io.IOException;
import java.io.Reader;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.function.Function;
import java.util.stream.Collectors;
/**
* ConstantTensorJsonValidator strictly validates a constant tensor in JSON format read from a Reader object
*
* @author Vegard Sjonfjell
*/
public class ConstantTensorJsonValidator {
private static final String FIELD_CELLS = "cells";
private static final String FIELD_ADDRESS = "address";
private static final String FIELD_VALUE = "value";
private static final JsonFactory jsonFactory = new JsonFactory();
private JsonParser parser;
private Map<String, TensorType.Dimension> tensorDimensions;
public void validate(String fileName, TensorType type, Reader tensorData) {
if (fileName.endsWith(".json")) {
validateTensor(type, tensorData);
}
else if (fileName.endsWith(".json.lz4")) {
// don't validate; the cost probably outweights the advantage
}
else {
throw new IllegalArgumentException("Ranking constant file names must end with either '.json' or '.json.lz4'");
}
}
private void validateTensor(TensorType type, Reader tensorData) {
wrapIOException(() -> {
this.parser = jsonFactory.createParser(tensorData);
this.tensorDimensions = type
.dimensions()
.stream()
.collect(Collectors.toMap(TensorType.Dimension::name, Function.identity()));
assertNextTokenIs(JsonToken.START_OBJECT);
assertNextTokenIs(JsonToken.FIELD_NAME);
assertFieldNameIs(FIELD_CELLS);
assertNextTokenIs(JsonToken.START_ARRAY);
while (parser.nextToken() != JsonToken.END_ARRAY) {
validateTensorCell();
}
assertNextTokenIs(JsonToken.END_OBJECT);
});
}
private void validateTensorCell() {
wrapIOException(() -> {
assertCurrentTokenIs(JsonToken.START_OBJECT);
List<String> fieldNameCandidates = new ArrayList<>(Arrays.asList(FIELD_ADDRESS, FIELD_VALUE));
for (int i = 0; i < 2; i++) {
assertNextTokenIs(JsonToken.FIELD_NAME);
String fieldName = parser.getCurrentName();
if (fieldNameCandidates.contains(fieldName)) {
fieldNameCandidates.remove(fieldName);
if (fieldName.equals(FIELD_ADDRESS)) {
validateTensorAddress();
} else if (fieldName.equals(FIELD_VALUE)) {
validateTensorValue();
}
} else {
throw new InvalidConstantTensor(parser, "Only \"address\" or \"value\" fields are permitted within a cell object");
}
}
assertNextTokenIs(JsonToken.END_OBJECT);
});
}
private void validateTensorAddress() throws IOException {
assertNextTokenIs(JsonToken.START_OBJECT);
Set<String> cellDimensions = new HashSet<>(tensorDimensions.keySet());
// Iterate within the address key, value pairs
while ((parser.nextToken() != JsonToken.END_OBJECT)) {
assertCurrentTokenIs(JsonToken.FIELD_NAME);
String dimensionName = parser.getCurrentName();
TensorType.Dimension dimension = tensorDimensions.get(dimensionName);
if (dimension == null) {
throw new InvalidConstantTensor(parser, String.format("Tensor dimension \"%s\" does not exist", parser.getCurrentName()));
}
if (!cellDimensions.contains(dimensionName)) {
throw new InvalidConstantTensor(parser, String.format("Duplicate tensor dimension \"%s\"", parser.getCurrentName()));
}
cellDimensions.remove(dimensionName);
validateTensorCoordinate(dimension);
}
if (!cellDimensions.isEmpty()) {
throw new InvalidConstantTensor(parser, String.format("Tensor address missing dimension(s): %s", Joiner.on(", ").join(cellDimensions)));
}
}
/*
* Tensor coordinates are always strings. Coordinates for a mapped dimension can be any string,
* but those for indexed dimensions needs to be able to be interpreted as integers, and,
* additionally, those for indexed bounded dimensions needs to fall within the dimension size.
*/
private void validateTensorCoordinate(TensorType.Dimension dimension) throws IOException {
JsonToken token = parser.nextToken();
if (token != JsonToken.VALUE_STRING) {
throw new InvalidConstantTensor(parser, String.format("Tensor coordinate is not a string (%s)", token.toString()));
}
if (dimension instanceof TensorType.IndexedBoundDimension) {
validateBoundedCoordinate((TensorType.IndexedBoundDimension) dimension);
} else if (dimension instanceof TensorType.IndexedUnboundDimension) {
validateUnboundedCoordinate(dimension);
}
}
private void validateBoundedCoordinate(TensorType.IndexedBoundDimension dimension) {
wrapIOException(() -> {
try {
int value = Integer.parseInt(parser.getValueAsString());
if (value >= dimension.size().get()) {
throw new InvalidConstantTensor(parser, String.format("Coordinate \"%s\" not within limits of bounded dimension %s", value, dimension.name()));
}
} catch (NumberFormatException e) {
throwCoordinateIsNotInteger(parser.getValueAsString(), dimension.name());
}
});
}
private void validateUnboundedCoordinate(TensorType.Dimension dimension) {
wrapIOException(() -> {
try {
Integer.parseInt(parser.getValueAsString());
} catch (NumberFormatException e) {
throwCoordinateIsNotInteger(parser.getValueAsString(), dimension.name());
}
});
}
private void throwCoordinateIsNotInteger(String value, String dimensionName) {
throw new InvalidConstantTensor(parser, String.format("Coordinate \"%s\" for dimension %s is not an integer", value, dimensionName));
}
private void validateTensorValue() throws IOException {
JsonToken token = parser.nextToken();
if (token != JsonToken.VALUE_NUMBER_FLOAT && token != JsonToken.VALUE_NUMBER_INT) {
throw new InvalidConstantTensor(parser, String.format("Tensor value is not a number (%s)", token.toString()));
}
}
private void assertCurrentTokenIs(JsonToken wantedToken) {
assertTokenIs(parser.getCurrentToken(), wantedToken);
}
private void assertNextTokenIs(JsonToken wantedToken) throws IOException {
assertTokenIs(parser.nextToken(), wantedToken);
}
private void assertTokenIs(JsonToken token, JsonToken wantedToken) {
if (token != wantedToken) {
throw new InvalidConstantTensor(parser, String.format("Expected JSON token %s, but got %s", wantedToken.toString(), token.toString()));
}
}
private void assertFieldNameIs(String wantedFieldName) throws IOException {
String actualFieldName = parser.getCurrentName();
if (!actualFieldName.equals(wantedFieldName)) {
throw new InvalidConstantTensor(parser, String.format("Expected field name \"%s\", got \"%s\"", wantedFieldName, actualFieldName));
}
}
static class InvalidConstantTensor extends RuntimeException {
InvalidConstantTensor(JsonParser parser, String message) {
super(message + " " + parser.getCurrentLocation().toString());
}
InvalidConstantTensor(JsonParser parser, Exception base) {
super("Failed to parse JSON stream " + parser.getCurrentLocation().toString(), base);
}
}
@FunctionalInterface
private interface SubroutineThrowingIOException {
void invoke() throws IOException;
}
private void wrapIOException(SubroutineThrowingIOException lambda) {
try {
lambda.invoke();
} catch (IOException e) {
throw new InvalidConstantTensor(parser, e);
}
}
}
|
