API-543 Add bigint serializer (#975)

hazelcast · Aug 4, 2021 · 2828350 · 2828350
1 parent 0f5e5d5
commit 2828350
Show file tree

Hide file tree

Showing 9 changed files with 84 additions and 17 deletions.
diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md
@@ -575,6 +575,7 @@ Hazelcast serializes all your objects before sending them to the server. Certain
 |-----------------|---------------------------------------|
 | boolean         | Boolean                               |
 | number          | Byte, Short, Integer, Float, Double   |
+| BigInt          | BigInteger                            |
 | string          | String                                |
 | Long            | Long                                  |
 | Buffer          | byte[]                                |
@@ -584,7 +585,7 @@ Hazelcast serializes all your objects before sending them to the server. Certain
 
 > **NOTE: A `number` is serialized as `Double` by default. You can configure this behavior using the `defaultNumberType` serialization config option. See [API Documentation](http://hazelcast.github.io/hazelcast-nodejs-client/api/current/docs/) for more information.**
 
-Arrays of the `boolean`, `number`, `string`, and `Long` types can be serialized as `boolean[]`, `byte[]`, `short[]`, `int[]`, `float[]`, `double[]`, `string[]`, and `long[]` for the Java server side, respectively.
+Arrays of the `boolean`, `number`, `BigInt`, `string`, and `Long` types can be serialized as `boolean[]`, `BigInteger[]', `byte[]`, `short[]`, `int[]`, `float[]`, `double[]`, `string[]`, and `long[]` for the Java server side, respectively.
 
 **Serialization Priority**
 

diff --git a/src/serialization/DefaultSerializers.ts b/src/serialization/DefaultSerializers.ts
@@ -559,3 +559,19 @@ export class BigDecimalSerializer implements Serializer<BigDecimal> {
         output.writeInt(bigDecimal.scale);
     }
 }
+
+/** @internal */
+export class BigIntSerializer implements Serializer<BigInt> {
+
+    id = -26;
+
+    read(input: DataInput): BigInt {
+        const body = input.readByteArray();
+        return BigDecimalUtil.bufferToBigInt(body);
+    }
+
+    write(output: DataOutput, bigint: BigInt): void {
+        output.writeByteArray(BigDecimalUtil.bigIntToBuffer(bigint));
+    }
+}
+
diff --git a/src/serialization/SerializationService.ts b/src/serialization/SerializationService.ts
@@ -28,6 +28,7 @@ import {Serializer, IdentifiedDataSerializableFactory} from './Serializable';
 import {
     ArrayListSerializer,
     BigDecimalSerializer,
+    BigIntSerializer,
     BooleanArraySerializer,
     BooleanSerializer,
     ByteArraySerializer,
@@ -291,6 +292,7 @@ export class SerializationServiceV1 implements SerializationService {
         this.registerSerializer('linkedList', new LinkedListSerializer());
         this.registerSerializer('uuid', new UuidSerializer());
         this.registerSerializer('bigDecimal', new BigDecimalSerializer());
+        this.registerSerializer('bigint', new BigIntSerializer());
         this.registerIdentifiedFactories();
         this.registerSerializer('!portable', new PortableSerializer(this.serializationConfig));
         if (this.serializationConfig.jsonStringDeserializationPolicy === JsonStringDeserializationPolicy.EAGER) {

diff --git a/test/integration/backward_compatible/serialization/DefaultSerializersLiveTest.js b/test/integration/backward_compatible/serialization/DefaultSerializersLiveTest.js
@@ -62,13 +62,13 @@ describe('DefaultSerializersLiveTest', function () {
 
     it('string', async function () {
         await map.put('testStringKey', 'testStringValue');
-        const response = await RC.executeOnController(cluster.id, generateGet('testStringKey'), 1);
+        const response = await RC.executeOnController(cluster.id, generateGet('testStringKey'), Lang.JAVASCRIPT);
         expect(response.result.toString()).to.equal('testStringValue');
     });
 
     it('utf8 sample string test', async function () {
         await map.put('key', 'Iñtërnâtiônàlizætiøn');
-        const response = await RC.executeOnController(cluster.id, generateGet('key'), 1);
+        const response = await RC.executeOnController(cluster.id, generateGet('key'), Lang.JAVASCRIPT);
         expect(response.result.toString()).to.equal('Iñtërnâtiônàlizætiøn');
     });
 
@@ -80,7 +80,7 @@ describe('DefaultSerializersLiveTest', function () {
 
     it('array', async function () {
         await map.put('a', ['a', 'v', 'vg']);
-        const response = await RC.executeOnController(cluster.id, generateGet('a'), 1);
+        const response = await RC.executeOnController(cluster.id, generateGet('a'), Lang.JAVASCRIPT);
         expect(response.result.toString()).to.equal(['a', 'v', 'vg'].toString());
     });
 
@@ -111,19 +111,19 @@ describe('DefaultSerializersLiveTest', function () {
 
     it('emoji string test on RC', async function () {
         await map.put('key', '1⚐中💦2😭‍🙆😔5');
-        const response = await RC.executeOnController(cluster.id, generateGet('key'), 1);
+        const response = await RC.executeOnController(cluster.id, generateGet('key'), Lang.JAVASCRIPT);
         expect(response.result.toString()).to.equal('1⚐中💦2😭‍🙆😔5');
     });
 
     it('utf8 characters test on RC', async function () {
         await map.put('key', '\u0040\u0041\u01DF\u06A0\u12E0\u{1D306}');
-        const response = await RC.executeOnController(cluster.id, generateGet('key'), 1);
+        const response = await RC.executeOnController(cluster.id, generateGet('key'), Lang.JAVASCRIPT);
         expect(response.result.toString()).to.equal('\u0040\u0041\u01DF\u06A0\u12E0\u{1D306}');
     });
 
     it('utf8 characters test on RC with surrogates', async function () {
         await map.put('key', '\u0040\u0041\u01DF\u06A0\u12E0\uD834\uDF06');
-        const response = await RC.executeOnController(cluster.id, generateGet('key'), 1);
+        const response = await RC.executeOnController(cluster.id, generateGet('key'), Lang.JAVASCRIPT);
         expect(response.result.toString()).to.equal('\u0040\u0041\u01DF\u06A0\u12E0\u{1D306}');
     });
 
@@ -142,7 +142,7 @@ describe('DefaultSerializersLiveTest', function () {
             '\\"value\\": \\"" +  new String(value) + "\\"}"\n';
 
         await map.put('key', restValue);
-        const response = await RC.executeOnController(cluster.id, script, 1);
+        const response = await RC.executeOnController(cluster.id, script, Lang.JAVASCRIPT);
         const result = JSON.parse(response.result.toString());
         expect(result.contentType).to.equal(restValue.contentType);
         expect(result.value).to.equal(restValue.value);
@@ -157,7 +157,7 @@ describe('DefaultSerializersLiveTest', function () {
             'result = "\\"" + uuid.toString() + "\\"";\n';
 
         await map.put('key', uuid);
-        const response = await RC.executeOnController(cluster.id, script, 1);
+        const response = await RC.executeOnController(cluster.id, script, Lang.JAVASCRIPT);
         const result = JSON.parse(response.result);
         expect(result).to.equal(uuid.toString());
     });
@@ -171,7 +171,7 @@ describe('DefaultSerializersLiveTest', function () {
             'list.add(3);\n' +
             'map.set("key", list);\n';
 
-        await RC.executeOnController(cluster.id, script, 1);
+        await RC.executeOnController(cluster.id, script, Lang.JAVASCRIPT);
 
         const actualValue = await map.get('key');
         expect(actualValue).to.deep.equal([1, 2, 3]);
@@ -186,7 +186,7 @@ describe('DefaultSerializersLiveTest', function () {
             'list.add(3);\n' +
             'map.set("key", list);\n';
 
-        await RC.executeOnController(cluster.id, script, 1);
+        await RC.executeOnController(cluster.id, script, Lang.JAVASCRIPT);
 
         const actualValue = await map.get('key');
         expect(actualValue).to.deep.equal([1, 2, 3]);
@@ -545,4 +545,47 @@ describe('DefaultSerializersLiveTest', function () {
             }
         }
     });
+
+    const bigIntParams = [
+        ['1111', 1111n],
+        ['-1111', -1111n],
+        ['9999999999999999999999999', 9999999999999999999999999n],
+        ['-9999999999999999999999999', -9999999999999999999999999n],
+        ['0', 0n],
+        ['1', 1n],
+        ['-7', -7n],
+    ];
+
+    it('should deserialize BigInt', async function () {
+        TestUtil.markClientVersionAtLeast(this, '5.0');
+
+        let script = 'var map = instance_0.getMap("' + map.getName() + '");\n';
+
+        bigIntParams.forEach((values, index) => {
+            const bigIntString = values[0];
+            script += `map.set("${index}", new java.math.BigInteger("${bigIntString}"));\n`;
+        });
+
+        await RC.executeOnController(cluster.id, script, Lang.JAVASCRIPT);
+
+        for (let i = 0; i < bigIntParams.length; i++) {
+            const actualValue = await map.get(i.toString());
+            const expectedBigIntValue = bigIntParams[i][1];
+
+            expect(actualValue).to.be.equal(expectedBigIntValue);
+        }
+    });
+
+    it('should serialize BigInt correctly', async function () {
+        TestUtil.markClientVersionAtLeast(this, '5.0');
+        for (let i = 0; i < bigIntParams.length; i++) {
+            const bigintValue = bigIntParams[i][1];
+            await map.put(i.toString(), bigintValue);
+        }
+
+        for (let i = 0; i < bigIntParams.length; i++) {
+            const responseString = await getMapValueAsString(i);
+            expect(responseString).to.be.equal(bigIntParams[i][0]);
+        }
+    });
 });
diff --git a/test/unit/serialization/1.serialization.compatibility.binary b/test/unit/serialization/1.serialization.compatibility.binary
diff --git a/test/unit/serialization/DefaultSerializersTest.js b/test/unit/serialization/DefaultSerializersTest.js
@@ -83,12 +83,14 @@ describe('DefaultSerializersTest', function () {
         new LocalTime(11, 22, 41, 123456789),
         new LocalDateTime(new LocalDate(2022, 7, 29), new LocalTime(12, 23, 42, 123456789)),
         new OffsetDateTime(new LocalDateTime(new LocalDate(2022, 7, 29), new LocalTime(12, 23, 42, 123456789)), -64800),
-        BigDecimal.fromString('1.11111111111111111111111111')
+        BigDecimal.fromString('1.11111111111111111111111111'),
+        BigInt('111111111111111111111111111'),
     ];
 
     parameters.forEach((obj) => {
         it('type: ' + typeof obj + ', isArray: ' + Array.isArray(obj) + ', value: '
-            + (obj instanceof BigDecimal ? `BigDecimal ${obj.toString()}` : JSON.stringify(obj)), function () {
+            + (obj instanceof BigDecimal ? `BigDecimal ${obj.toString()}` :
+                (typeof obj === 'bigint' ? `BigInt ${obj}` : JSON.stringify(obj))), function () {
                 const config = new SerializationConfigImpl();
                 const serializationService = new SerializationServiceV1(config);
                 const serialized = serializationService.toData(obj);

diff --git a/test/unit/serialization/ReferenceObjects.java b/test/unit/serialization/ReferenceObjects.java
@@ -30,6 +30,7 @@
 import com.hazelcast.internal.serialization.Data;
 import com.hazelcast.nio.serialization.Portable;
 import java.math.BigDecimal;
+import java.math.BigInteger;
 import java.nio.CharBuffer;
 import java.time.LocalTime;
 import java.time.LocalDate;
@@ -141,6 +142,7 @@ class ReferenceObjects {
         aOffsetDateTime = OffsetDateTime.of(aLocalDateTime, ZoneOffset.ofHours(18));
     }
 
+    static BigInteger aBigInteger = new BigInteger("1314432323232411");
     static BigDecimal aBigDecimal = new BigDecimal(31231);
     static Class aClass = BigDecimal.class;
 
@@ -150,6 +152,6 @@ class ReferenceObjects {
             booleans, bytes, chars, doubles, shorts, floats, ints, longs, strings,
             aCustomStreamSerializable, aCustomByteArraySerializable,
             anIdentifiedDataSerializable, aPortable,
-            aDate, aLocalDate, aLocalTime, aLocalDateTime, aOffsetDateTime, aBigDecimal, aClass
+            aDate, aLocalDate, aLocalTime, aLocalDateTime, aOffsetDateTime, aBigInteger, aBigDecimal, aClass
     };
 }
diff --git a/test/unit/serialization/ReferenceObjects.js b/test/unit/serialization/ReferenceObjects.js
@@ -79,6 +79,7 @@ to.APortable = new APortable(
     to.aCustomByteArraySerializable, exports.aData
 );
 to.aDate = new Date(Date.UTC(1990, 2, 1, 0, 0, 0, 0));
+to.aBigInteger = BigInt('1314432323232411');
 to.aBigDecimal = BigDecimal.fromString('31231');
 to.aClass = 'java.math.BigDecimal';
 

diff --git a/tsconfig.json b/tsconfig.json
@@ -8,12 +8,12 @@
         "strictBindCallApply": true,
         "strictFunctionTypes": true,
         "noImplicitThis": true,
-        "target": "es2016",
+        "target": "es2018",
         "outDir": "lib",
         "preserveConstEnums": true,
         "lib": [
-            "es2016",
-            "es2017.string"
+            "es2018",
+            "es2020.bigint"
         ],
         "removeComments": false,
         "sourceMap": true,