-
Notifications
You must be signed in to change notification settings - Fork 16
/
ProtoCelValueConverter.java
320 lines (290 loc) · 13 KB
/
ProtoCelValueConverter.java
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
// Copyright 2023 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package dev.cel.common.values;
import static com.google.common.collect.ImmutableList.toImmutableList;
import static com.google.common.collect.ImmutableMap.toImmutableMap;
import static com.google.common.math.LongMath.checkedAdd;
import static com.google.common.math.LongMath.checkedSubtract;
import com.google.common.base.Preconditions;
import com.google.errorprone.annotations.Immutable;
import com.google.protobuf.Any;
import com.google.protobuf.BoolValue;
import com.google.protobuf.ByteString;
import com.google.protobuf.Descriptors.EnumValueDescriptor;
import com.google.protobuf.Descriptors.FieldDescriptor;
import com.google.protobuf.DoubleValue;
import com.google.protobuf.DynamicMessage;
import com.google.protobuf.FloatValue;
import com.google.protobuf.Int32Value;
import com.google.protobuf.Int64Value;
import com.google.protobuf.InvalidProtocolBufferException;
import com.google.protobuf.MapEntry;
import com.google.protobuf.Message;
import com.google.protobuf.MessageOrBuilder;
import com.google.protobuf.StringValue;
import com.google.protobuf.Struct;
import com.google.protobuf.Timestamp;
import com.google.protobuf.UInt32Value;
import com.google.protobuf.UInt64Value;
import com.google.protobuf.Value;
import com.google.protobuf.util.Durations;
import com.google.protobuf.util.Timestamps;
import dev.cel.common.CelOptions;
import dev.cel.common.annotations.Internal;
import dev.cel.common.internal.CelDescriptorPool;
import dev.cel.common.internal.DynamicProto;
import dev.cel.common.internal.WellKnownProto;
import dev.cel.common.types.CelTypes;
import java.time.Duration;
import java.time.Instant;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
* {@code CelValueConverter} handles bidirectional conversion between native Java and protobuf
* objects to {@link CelValue}.
*
* <p>Protobuf semantics take precedence for conversion. For example, CEL's TimestampValue will be
* converted into Protobuf's Timestamp instead of java.time.Instant.
*
* <p>CEL Library Internals. Do Not Use.
*/
@Immutable
@Internal
public final class ProtoCelValueConverter extends CelValueConverter {
private final CelDescriptorPool celDescriptorPool;
private final DynamicProto dynamicProto;
/** Constructs a new instance of ProtoCelValueConverter. */
public static ProtoCelValueConverter newInstance(
CelOptions celOptions, CelDescriptorPool celDescriptorPool, DynamicProto dynamicProto) {
return new ProtoCelValueConverter(celOptions, celDescriptorPool, dynamicProto);
}
/**
* Adapts a {@link CelValue} to a native Java object. The CelValue is adapted into protobuf object
* when an equivalent exists.
*/
@Override
public Object fromCelValueToJavaObject(CelValue celValue) {
Preconditions.checkNotNull(celValue);
if (celValue instanceof TimestampValue) {
return TimeUtils.toProtoTimestamp(((TimestampValue) celValue).value());
} else if (celValue instanceof DurationValue) {
return TimeUtils.toProtoDuration(((DurationValue) celValue).value());
} else if (celValue instanceof BytesValue) {
return ByteString.copyFrom(((BytesValue) celValue).value().toByteArray());
} else if (NullValue.NULL_VALUE.equals(celValue)) {
return com.google.protobuf.NullValue.NULL_VALUE;
}
return super.fromCelValueToJavaObject(celValue);
}
/** Adapts a Protobuf message into a {@link CelValue}. */
public CelValue fromProtoMessageToCelValue(MessageOrBuilder message) {
Preconditions.checkNotNull(message);
// Attempt to convert the proto from a dynamic message into a concrete message if possible.
if (message instanceof DynamicMessage) {
message = dynamicProto.maybeAdaptDynamicMessage((DynamicMessage) message);
}
WellKnownProto wellKnownProto =
WellKnownProto.getByDescriptorName(message.getDescriptorForType().getFullName());
if (wellKnownProto == null) {
return ProtoMessageValue.create((Message) message, celDescriptorPool, this);
}
switch (wellKnownProto) {
case ANY_VALUE:
Message unpackedMessage;
try {
unpackedMessage = dynamicProto.unpack((Any) message);
} catch (InvalidProtocolBufferException e) {
throw new IllegalStateException(
"Unpacking failed for message: " + message.getDescriptorForType().getFullName(), e);
}
return fromProtoMessageToCelValue(unpackedMessage);
case JSON_VALUE:
return adaptJsonValueToCelValue((Value) message);
case JSON_STRUCT_VALUE:
return adaptJsonStructToCelValue((Struct) message);
case JSON_LIST_VALUE:
return adaptJsonListToCelValue((com.google.protobuf.ListValue) message);
case DURATION_VALUE:
return DurationValue.create(
TimeUtils.toJavaDuration((com.google.protobuf.Duration) message));
case TIMESTAMP_VALUE:
return TimestampValue.create(TimeUtils.toJavaInstant((Timestamp) message));
case BOOL_VALUE:
return fromJavaPrimitiveToCelValue(((BoolValue) message).getValue());
case BYTES_VALUE:
return fromJavaPrimitiveToCelValue(
((com.google.protobuf.BytesValue) message).getValue().toByteArray());
case DOUBLE_VALUE:
return fromJavaPrimitiveToCelValue(((DoubleValue) message).getValue());
case FLOAT_VALUE:
return fromJavaPrimitiveToCelValue(((FloatValue) message).getValue());
case INT32_VALUE:
return fromJavaPrimitiveToCelValue(((Int32Value) message).getValue());
case INT64_VALUE:
return fromJavaPrimitiveToCelValue(((Int64Value) message).getValue());
case STRING_VALUE:
return fromJavaPrimitiveToCelValue(((StringValue) message).getValue());
case UINT32_VALUE:
return UintValue.create(
((UInt32Value) message).getValue(), celOptions.enableUnsignedLongs());
case UINT64_VALUE:
return UintValue.create(
((UInt64Value) message).getValue(), celOptions.enableUnsignedLongs());
}
throw new UnsupportedOperationException(
"Unsupported message to CelValue conversion - " + message);
}
/**
* Adapts a plain old Java Object to a {@link CelValue}. Protobuf semantics take precedence for
* conversion.
*/
@Override
public CelValue fromJavaObjectToCelValue(Object value) {
Preconditions.checkNotNull(value);
if (value instanceof Message) {
return fromProtoMessageToCelValue((Message) value);
} else if (value instanceof Message.Builder) {
Message.Builder msgBuilder = (Message.Builder) value;
return fromProtoMessageToCelValue(msgBuilder.build());
} else if (value instanceof ByteString) {
return BytesValue.create(CelByteString.of(((ByteString) value).toByteArray()));
} else if (value instanceof com.google.protobuf.NullValue) {
return NullValue.NULL_VALUE;
} else if (value instanceof EnumValueDescriptor) {
// (b/178627883) Strongly typed enum is not supported yet
return IntValue.create(((EnumValueDescriptor) value).getNumber());
}
return super.fromJavaObjectToCelValue(value);
}
/** Adapts the protobuf message field into {@link CelValue}. */
@SuppressWarnings("unchecked")
public CelValue fromProtoMessageFieldToCelValue(
Message message, FieldDescriptor fieldDescriptor) {
Preconditions.checkNotNull(message);
Preconditions.checkNotNull(fieldDescriptor);
Object result = message.getField(fieldDescriptor);
switch (fieldDescriptor.getType()) {
case MESSAGE:
if (CelTypes.isWrapperType(fieldDescriptor.getMessageType().getFullName())
&& !message.hasField(fieldDescriptor)) {
// Special semantics for wrapper types per CEL specification. These all convert into null
// instead of the default value.
return NullValue.NULL_VALUE;
} else if (fieldDescriptor.isMapField()) {
Map<Object, Object> map = new HashMap<>();
for (MapEntry<Object, Object> entry : ((List<MapEntry<Object, Object>>) result)) {
map.put(entry.getKey(), entry.getValue());
}
return fromJavaObjectToCelValue(map);
}
break;
case UINT32:
return UintValue.create((int) result, celOptions.enableUnsignedLongs());
case UINT64:
return UintValue.create((long) result, celOptions.enableUnsignedLongs());
default:
break;
}
return fromJavaObjectToCelValue(result);
}
private CelValue adaptJsonValueToCelValue(Value value) {
switch (value.getKindCase()) {
case BOOL_VALUE:
return fromJavaPrimitiveToCelValue(value.getBoolValue());
case NUMBER_VALUE:
return fromJavaPrimitiveToCelValue(value.getNumberValue());
case STRING_VALUE:
return fromJavaPrimitiveToCelValue(value.getStringValue());
case LIST_VALUE:
return adaptJsonListToCelValue(value.getListValue());
case STRUCT_VALUE:
return adaptJsonStructToCelValue(value.getStructValue());
case NULL_VALUE:
case KIND_NOT_SET: // Fall-through is intended
return NullValue.NULL_VALUE;
}
throw new UnsupportedOperationException(
"Unsupported Json to CelValue conversion: " + value.getKindCase());
}
private ListValue<CelValue> adaptJsonListToCelValue(com.google.protobuf.ListValue listValue) {
return ImmutableListValue.create(
listValue.getValuesList().stream()
.map(this::adaptJsonValueToCelValue)
.collect(toImmutableList()));
}
private MapValue<CelValue, CelValue> adaptJsonStructToCelValue(Struct struct) {
return ImmutableMapValue.create(
struct.getFieldsMap().entrySet().stream()
.collect(
toImmutableMap(
e -> fromJavaObjectToCelValue(e.getKey()),
e -> adaptJsonValueToCelValue(e.getValue()))));
}
/** Helper to convert between java.util.time and protobuf duration/timestamp. */
private static class TimeUtils {
private static final int NANOS_PER_SECOND = 1000000000;
private static Instant toJavaInstant(Timestamp timestamp) {
timestamp = normalizedTimestamp(timestamp.getSeconds(), timestamp.getNanos());
return Instant.ofEpochSecond(timestamp.getSeconds(), timestamp.getNanos());
}
private static Duration toJavaDuration(com.google.protobuf.Duration duration) {
duration = normalizedDuration(duration.getSeconds(), duration.getNanos());
return java.time.Duration.ofSeconds(duration.getSeconds(), duration.getNanos());
}
private static Timestamp toProtoTimestamp(Instant instant) {
return normalizedTimestamp(instant.getEpochSecond(), instant.getNano());
}
private static com.google.protobuf.Duration toProtoDuration(Duration duration) {
return normalizedDuration(duration.getSeconds(), duration.getNano());
}
private static Timestamp normalizedTimestamp(long seconds, int nanos) {
if (nanos <= -NANOS_PER_SECOND || nanos >= NANOS_PER_SECOND) {
seconds = checkedAdd(seconds, nanos / NANOS_PER_SECOND);
nanos = nanos % NANOS_PER_SECOND;
}
if (nanos < 0) {
nanos = nanos + NANOS_PER_SECOND; // no overflow since nanos is negative (and we're adding)
seconds = checkedSubtract(seconds, 1);
}
Timestamp timestamp = Timestamp.newBuilder().setSeconds(seconds).setNanos(nanos).build();
return Timestamps.checkValid(timestamp);
}
private static com.google.protobuf.Duration normalizedDuration(long seconds, int nanos) {
if (nanos <= -NANOS_PER_SECOND || nanos >= NANOS_PER_SECOND) {
seconds = checkedAdd(seconds, nanos / NANOS_PER_SECOND);
nanos %= NANOS_PER_SECOND;
}
if (seconds > 0 && nanos < 0) {
nanos += NANOS_PER_SECOND; // no overflow since nanos is negative (and we're adding)
seconds--; // no overflow since seconds is positive (and we're decrementing)
}
if (seconds < 0 && nanos > 0) {
nanos -= NANOS_PER_SECOND; // no overflow since nanos is positive (and we're subtracting)
seconds++; // no overflow since seconds is negative (and we're incrementing)
}
com.google.protobuf.Duration duration =
com.google.protobuf.Duration.newBuilder().setSeconds(seconds).setNanos(nanos).build();
return Durations.checkValid(duration);
}
}
private ProtoCelValueConverter(
CelOptions celOptions, CelDescriptorPool celDescriptorPool, DynamicProto dynamicProto) {
super(celOptions);
Preconditions.checkNotNull(celDescriptorPool);
Preconditions.checkNotNull(dynamicProto);
this.celDescriptorPool = celDescriptorPool;
this.dynamicProto = dynamicProto;
}
}