Skip to content

Commit 5eebdfb

Browse files
rbygraverbygrave
committed
Add failOnNullPrimitives option, default to allowing NULL
- Default to allowing NULL for primitives like Jackson - Add failOnNullPrimitives=true configuration option
1 parent 10cb93a commit 5eebdfb

File tree

12 files changed

+277
-7
lines changed

12 files changed

+277
-7
lines changed

‎blackbox-test/src/main/java/org/example/other/MyPrimitives.java

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
package org.example.other;
2+
3+
import io.avaje.jsonb.Json;
4+
5+
@Json
6+
public record MyPrimitives(boolean a, int b, long c, double d) {};

‎blackbox-test/src/test/java/org/example/FailOnNullPrimitivesTest.java

+57
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
package org.example;
2+
3+
import io.avaje.json.JsonDataException;
4+
import io.avaje.jsonb.JsonType;
5+
import io.avaje.jsonb.Jsonb;
6+
import org.example.other.MyPrimitives;
7+
import org.junit.jupiter.api.Test;
8+
9+
import static org.assertj.core.api.Assertions.assertThat;
10+
import static org.assertj.core.api.Assertions.assertThatThrownBy;
11+
12+
class FailOnNullPrimitivesTest {
13+
14+
@Test
15+
void default_allowsNulls_expect_defaultValues() {
16+
String jsonContent = "{\"a\":null,\"b\":null,\"c\":null,\"d\":null}";
17+
18+
// default skips unknown
19+
Jsonb jsonb = Jsonb.builder().build();
20+
JsonType<MyPrimitives> jsonType = jsonb.type(MyPrimitives.class);
21+
22+
MyPrimitives bean = jsonType.fromJson(jsonContent);
23+
assertThat(bean.a()).isEqualTo(false);
24+
assertThat(bean.b()).isEqualTo(0);
25+
assertThat(bean.c()).isEqualTo(0);
26+
assertThat(bean.d()).isEqualTo(0);
27+
}
28+
29+
@Test
30+
void failOnNullPrimitives() {
31+
Jsonb jsonb = Jsonb.builder().failOnNullPrimitives(true).build();
32+
JsonType<MyPrimitives> jsonType = jsonb.type(MyPrimitives.class);
33+
34+
assertThatThrownBy(() ->jsonType.fromJson("{\"a\":null,\"b\":null,\"c\":null,\"d\":null}"))
35+
.isInstanceOf(JsonDataException.class)
36+
.hasMessageContaining("Read NULL value for boolean");
37+
38+
assertThatThrownBy(() ->jsonType.fromJson("{\"a\":false,\"b\":null,\"c\":null,\"d\":null}"))
39+
.isInstanceOf(JsonDataException.class)
40+
.hasMessageContaining("Read NULL value for int");
41+
42+
assertThatThrownBy(() ->jsonType.fromJson("{\"a\":false,\"b\":7,\"c\":null,\"d\":null}"))
43+
.isInstanceOf(JsonDataException.class)
44+
.hasMessageContaining("Read NULL value for long");
45+
46+
assertThatThrownBy(() ->jsonType.fromJson("{\"a\":false,\"b\":7,\"c\":7,\"d\":null}"))
47+
.isInstanceOf(JsonDataException.class)
48+
.hasMessageContaining("Read NULL value for double");
49+
50+
MyPrimitives result = jsonType.fromJson("{\"a\":true,\"b\":3,\"c\":5,\"d\":7}");
51+
assertThat(result.a()).isTrue();
52+
assertThat(result.b()).isEqualTo(3);
53+
assertThat(result.c()).isEqualTo(5);
54+
assertThat(result.d()).isEqualTo(7);
55+
}
56+
57+
}

‎json-core/src/main/java/io/avaje/json/stream/JsonStream.java

+3
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,9 @@ interface Builder {
8888
/** Set to true to fail on unknown properties. Defaults to false. */
8989
Builder failOnUnknown(boolean failOnUnknown);
9090

91+
/** Set to true to fail on NULL for primitive types. Defaults to false. */
92+
Builder failOnNullPrimitives(boolean failOnNullPrimitives);
93+
9194
/** Determines how byte buffers are recycled */
9295
Builder bufferRecycling(BufferRecycleStrategy strategy);
9396

‎json-core/src/main/java/io/avaje/json/stream/core/CoreJsonStream.java

+5-2
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,20 @@ final class CoreJsonStream implements JsonStream {
1414
private final boolean serializeNulls;
1515
private final boolean serializeEmpty;
1616
private final boolean failOnUnknown;
17+
private final boolean failOnNullPrimitives;
1718
private final BufferRecycler recycle;
1819

1920
/** Create additionally providing the jsonFactory. */
2021
CoreJsonStream(
2122
boolean serializeNulls,
2223
boolean serializeEmpty,
2324
boolean failOnUnknown,
25+
boolean failOnNullPrimitives,
2426
BufferRecycleStrategy recycle) {
2527
this.serializeNulls = serializeNulls;
2628
this.serializeEmpty = serializeEmpty;
2729
this.failOnUnknown = failOnUnknown;
30+
this.failOnNullPrimitives = failOnNullPrimitives;
2831
this.recycle = init2Recycler(recycle);
2932
}
3033

@@ -66,7 +69,7 @@ public JsonReader reader(String json) {
6669
@Override
6770
public JsonReader reader(byte[] json) {
6871
JsonParser parser = recycle.parser(json);
69-
return new JsonReadAdapter(parser, recycle, failOnUnknown);
72+
return new JsonReadAdapter(parser, recycle, failOnUnknown, failOnNullPrimitives);
7073
}
7174

7275
@Override
@@ -77,7 +80,7 @@ public JsonReader reader(Reader reader) {
7780
@Override
7881
public JsonReader reader(InputStream inputStream) {
7982
JsonParser parser = recycle.parser(inputStream);
80-
return new JsonReadAdapter(parser, recycle, failOnUnknown);
83+
return new JsonReadAdapter(parser, recycle, failOnUnknown, failOnNullPrimitives);
8184
}
8285

8386
@Override

‎json-core/src/main/java/io/avaje/json/stream/core/JParser.java

+4-1
Original file line numberDiff line numberDiff line change
@@ -372,11 +372,13 @@ char[] readSimpleQuote() {
372372

373373
@Override
374374
public int readInt() {
375+
if (isNullValue()) return 0;
375376
return NumberParser.deserializeInt(this);
376377
}
377378

378379
@Override
379380
public long readLong() {
381+
if (isNullValue()) return 0L;
380382
return NumberParser.deserializeLong(this);
381383
}
382384

@@ -387,6 +389,7 @@ public short readShort() {
387389

388390
@Override
389391
public double readDouble() {
392+
if (isNullValue()) return 0D;
390393
return NumberParser.deserializeDouble(this);
391394
}
392395

@@ -404,7 +407,7 @@ public BigInteger readBigInteger() {
404407
public boolean readBoolean() {
405408
if (wasTrue()) {
406409
return true;
407-
} else if (wasFalse()) {
410+
} else if (wasFalse() || isNullValue()) {
408411
return false;
409412
}
410413
throw newParseErrorAt("Found invalid boolean value", 0);

‎json-core/src/main/java/io/avaje/json/stream/core/JsonReadAdapter.java

+8-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
package io.avaje.json.stream.core;
22

3+
import io.avaje.json.JsonDataException;
34
import io.avaje.json.JsonReader;
45
import io.avaje.json.PropertyNames;
56

@@ -10,11 +11,13 @@ final class JsonReadAdapter implements JsonReader {
1011

1112
private final JsonParser reader;
1213
private final boolean failOnUnknown;
14+
private final boolean failOnNullPrimitives;
1315
private final BufferRecycler recycler;
1416

15-
JsonReadAdapter(JsonParser reader, BufferRecycler recycler, boolean failOnUnknown) {
17+
JsonReadAdapter(JsonParser reader, BufferRecycler recycler, boolean failOnUnknown, boolean failOnNullPrimitives) {
1618
this.reader = reader;
1719
this.failOnUnknown = failOnUnknown;
20+
this.failOnNullPrimitives = failOnNullPrimitives;
1821
this.recycler = recycler;
1922
}
2023

@@ -88,21 +91,25 @@ public String nextField() {
8891

8992
@Override
9093
public boolean readBoolean() {
94+
if (failOnNullPrimitives && reader.isNullValue()) throw new JsonDataException("Read NULL value for boolean");
9195
return reader.readBoolean();
9296
}
9397

9498
@Override
9599
public int readInt() {
100+
if (failOnNullPrimitives && reader.isNullValue()) throw new JsonDataException("Read NULL value for int");
96101
return reader.readInt();
97102
}
98103

99104
@Override
100105
public long readLong() {
106+
if (failOnNullPrimitives && reader.isNullValue()) throw new JsonDataException("Read NULL value for long");
101107
return reader.readLong();
102108
}
103109

104110
@Override
105111
public double readDouble() {
112+
if (failOnNullPrimitives && reader.isNullValue()) throw new JsonDataException("Read NULL value for double");
106113
return reader.readDouble();
107114
}
108115

‎json-core/src/main/java/io/avaje/json/stream/core/JsonStreamBuilder.java

+8-1
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ public final class JsonStreamBuilder implements JsonStream.Builder {
1212
private boolean serializeNulls;
1313
private boolean serializeEmpty;
1414
private boolean failOnUnknown;
15+
private boolean failOnNullPrimitives;
1516

1617
/**
1718
* Set to true to serialize nulls. Defaults to false.
@@ -40,6 +41,12 @@ public JsonStreamBuilder failOnUnknown(boolean failOnUnknown) {
4041
return this;
4142
}
4243

44+
@Override
45+
public JsonStreamBuilder failOnNullPrimitives(boolean failOnNullPrimitives) {
46+
this.failOnNullPrimitives = failOnNullPrimitives;
47+
return this;
48+
}
49+
4350
/**
4451
* Determines how byte buffers are recycled
4552
*/
@@ -54,6 +61,6 @@ public JsonStreamBuilder bufferRecycling(BufferRecycleStrategy strategy) {
5461
*/
5562
@Override
5663
public JsonStream build() {
57-
return new CoreJsonStream(serializeNulls, serializeEmpty, failOnUnknown, strategy);
64+
return new CoreJsonStream(serializeNulls, serializeEmpty, failOnUnknown, failOnNullPrimitives, strategy);
5865
}
5966
}

‎json-core/src/test/java/io/avaje/json/mapper/PrimitivesTest.java

+167
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,167 @@
1+
package io.avaje.json.mapper;
2+
3+
import io.avaje.json.JsonDataException;
4+
import io.avaje.json.JsonReader;
5+
import io.avaje.json.stream.JsonStream;
6+
import org.junit.jupiter.api.Test;
7+
8+
import static org.junit.jupiter.api.Assertions.*;
9+
import static org.junit.jupiter.api.Assertions.assertEquals;
10+
11+
class PrimitivesTest {
12+
13+
static final JsonStream defaultJsonStream = JsonStream.builder().build();
14+
static final JsonStream strictJsonStream = JsonStream.builder().failOnNullPrimitives(true).build();
15+
16+
@Test
17+
void booleanTest() {
18+
String input = "{\"a\":true, \"b\": false}";
19+
20+
try (JsonReader reader = defaultJsonStream.reader(input)) {
21+
reader.beginObject();
22+
assertTrue(reader.hasNextField());
23+
assertEquals("a", reader.nextField());
24+
assertTrue(reader.readBoolean());
25+
assertTrue(reader.hasNextField());
26+
assertEquals("b", reader.nextField());
27+
assertFalse(reader.readBoolean());
28+
reader.endObject();
29+
}
30+
}
31+
32+
@Test
33+
void booleanNullTest() {
34+
String input = "{\"a\":true, \"b\": null, \"c\": 7}";
35+
36+
try (JsonReader reader = defaultJsonStream.reader(input)) {
37+
reader.beginObject();
38+
assertTrue(reader.hasNextField());
39+
assertEquals("a", reader.nextField());
40+
assertTrue(reader.readBoolean());
41+
assertTrue(reader.hasNextField());
42+
assertEquals("b", reader.nextField());
43+
assertFalse(reader.readBoolean());
44+
assertTrue(reader.hasNextField());
45+
assertEquals("c", reader.nextField());
46+
assertEquals(7, reader.readInt());
47+
reader.endObject();
48+
}
49+
}
50+
51+
@Test
52+
void intNullTest() {
53+
String input = "{\"a\":3, \"b\": null, \"c\": 7}";
54+
55+
try (JsonReader reader = defaultJsonStream.reader(input)) {
56+
reader.beginObject();
57+
assertTrue(reader.hasNextField());
58+
assertEquals("a", reader.nextField());
59+
assertEquals(3, reader.readInt());
60+
assertTrue(reader.hasNextField());
61+
assertEquals("b", reader.nextField());
62+
assertEquals(0, reader.readInt());
63+
assertTrue(reader.hasNextField());
64+
assertEquals("c", reader.nextField());
65+
assertEquals(7, reader.readInt());
66+
reader.endObject();
67+
}
68+
}
69+
70+
@Test
71+
void longNullTest() {
72+
String input = "{\"a\":3, \"b\": null, \"c\": 7}";
73+
74+
try (JsonReader reader = defaultJsonStream.reader(input)) {
75+
reader.beginObject();
76+
assertTrue(reader.hasNextField());
77+
assertEquals("a", reader.nextField());
78+
assertEquals(3, reader.readLong());
79+
assertTrue(reader.hasNextField());
80+
assertEquals("b", reader.nextField());
81+
assertEquals(0, reader.readLong());
82+
assertTrue(reader.hasNextField());
83+
assertEquals("c", reader.nextField());
84+
assertEquals(7, reader.readLong());
85+
reader.endObject();
86+
}
87+
}
88+
89+
@Test
90+
void doubleNullTest() {
91+
String input = "{\"a\":3, \"b\": null, \"c\": 7}";
92+
93+
try (JsonReader reader = defaultJsonStream.reader(input)) {
94+
reader.beginObject();
95+
assertTrue(reader.hasNextField());
96+
assertEquals("a", reader.nextField());
97+
assertEquals(3, reader.readLong());
98+
assertTrue(reader.hasNextField());
99+
assertEquals("b", reader.nextField());
100+
assertEquals(0, reader.readDouble());
101+
assertTrue(reader.hasNextField());
102+
assertEquals("c", reader.nextField());
103+
assertEquals(7, reader.readLong());
104+
reader.endObject();
105+
}
106+
}
107+
108+
@Test
109+
void readBoolean_strictMode_failOnNull() {
110+
String input = "{\"a\":true, \"b\": null, \"c\": 7}";
111+
112+
try (JsonReader reader = strictJsonStream.reader(input)) {
113+
reader.beginObject();
114+
assertTrue(reader.hasNextField());
115+
assertEquals("a", reader.nextField());
116+
assertTrue(reader.readBoolean());
117+
assertTrue(reader.hasNextField());
118+
assertEquals("b", reader.nextField());
119+
assertThrows(JsonDataException.class, reader::readBoolean);
120+
}
121+
}
122+
123+
@Test
124+
void readInt_strictMode_failOnNull() {
125+
String input = "{\"a\":3, \"b\": null, \"c\": 7}";
126+
127+
try (JsonReader reader = strictJsonStream.reader(input)) {
128+
reader.beginObject();
129+
assertTrue(reader.hasNextField());
130+
assertEquals("a", reader.nextField());
131+
assertEquals(3, reader.readInt());
132+
assertTrue(reader.hasNextField());
133+
assertEquals("b", reader.nextField());
134+
assertThrows(JsonDataException.class, reader::readInt);
135+
}
136+
}
137+
138+
@Test
139+
void readLong_strictMode_failOnNull() {
140+
String input = "{\"a\":3, \"b\": null, \"c\": 7}";
141+
142+
try (JsonReader reader = strictJsonStream.reader(input)) {
143+
reader.beginObject();
144+
assertTrue(reader.hasNextField());
145+
assertEquals("a", reader.nextField());
146+
assertEquals(3, reader.readLong());
147+
assertTrue(reader.hasNextField());
148+
assertEquals("b", reader.nextField());
149+
assertThrows(JsonDataException.class, reader::readLong);
150+
}
151+
}
152+
153+
@Test
154+
void readDouble_strictMode_failOnNull() {
155+
String input = "{\"a\":3, \"b\": null, \"c\": 7}";
156+
157+
try (JsonReader reader = strictJsonStream.reader(input)) {
158+
reader.beginObject();
159+
assertTrue(reader.hasNextField());
160+
assertEquals("a", reader.nextField());
161+
assertEquals(3, reader.readLong());
162+
assertTrue(reader.hasNextField());
163+
assertEquals("b", reader.nextField());
164+
assertThrows(JsonDataException.class, reader::readDouble);
165+
}
166+
}
167+
}

‎json-core/src/test/java/io/avaje/json/stream/core/JsonReadAdapterTest.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ void via_jreader() {
2626
jr.process(bytes, bytes.length);
2727

2828
JsonReadAdapter reader =
29-
new JsonReadAdapter(jr, ThreadLocalPool.shared(), true);
29+
new JsonReadAdapter(jr, ThreadLocalPool.shared(), true, true);
3030
readExampleWithAsserts(reader);
3131
reader.close();
3232
}

0 commit comments

Comments
 (0)