test

Signed-off-by: LiangliangSui <[email protected]>

.github/workflows/ci.yml

@@ -21,6 +21,7 @@ on:
   push:
     branches:
       - main
+      - go_magic_number
       - 'releases/**'
       - 'deploy/**'
       - 'test*'

go/fury/fury.go

@@ -90,6 +90,8 @@ const (
 	isOutOfBandFlag
 )
 
+const MAGIC_NUMBER int16 = 0x62D4
+
 type Fury struct {
 	typeResolver      *typeResolver
 	refResolver       *RefResolver
@@ -121,6 +123,11 @@ func (f *Fury) Serialize(buf *ByteBuffer, v interface{}, callback BufferCallback
 		buffer = f.buffer
 		buffer.writerIndex = 0
 	}
+	if f.language == XLANG {
+		buffer.WriteInt16(MAGIC_NUMBER)
+	} else {
+		return fmt.Errorf("%d language is not supported", f.language)
+	}
 	var bitmap byte = 0
 	if isNil(reflect.ValueOf(v)) {
 		bitmap |= isNilFlag
@@ -310,6 +317,15 @@ func (f *Fury) Unmarshal(data []byte, v interface{}) error {
 
 func (f *Fury) Deserialize(buf *ByteBuffer, v interface{}, buffers []*ByteBuffer) error {
 	defer f.resetRead()
+	if f.language == XLANG {
+		magicNumber := buf.ReadInt16()
+		if magicNumber != MAGIC_NUMBER {
+			return fmt.Errorf("the XLANG cross-language protocol is not currently used. For details," +
+				"see https://github.com/apache/incubator-fury/blob/main/docs/specification/xlang_serialization_spec.md")
+		}
+	} else {
+		return fmt.Errorf("%d language is not supported", f.language)
+	}
 	var bitmap = buf.ReadByte_()
 	if bitmap&isNilFlag == isNilFlag {
 		return nil

go/fury/fury_test.go

@@ -243,6 +243,18 @@ func TestSerializeStructSimple(t *testing.T) {
 	}
 }
 
+func TestSerializeBeginWithMagicNumber(t *testing.T) {
+	strSlice := []string{"str1", "str1", "", "", "str2"}
+	fury := NewFury(true)
+	bytes, err := fury.Marshal(strSlice)
+	require.Nil(t, err, fmt.Sprintf("serialize value %s with type %s failed: %s",
+		reflect.ValueOf(strSlice), reflect.TypeOf(strSlice), err))
+	// Contains at least two bytes.
+	require.True(t, len(bytes) > 2)
+	magicNumber := int16(bytes[0]) | (int16(bytes[1]) << 8)
+	require.Equal(t, magicNumber, MAGIC_NUMBER)
+}
+
 type Foo struct {
 	F1 int32
 	F2 string

java/fury-core/src/main/java/org/apache/fury/Fury.java

@@ -96,6 +96,7 @@ public final class Fury implements BaseFury {
   private static final boolean isLittleEndian = ByteOrder.nativeOrder() == ByteOrder.LITTLE_ENDIAN;
   private static final byte BITMAP = isLittleEndian ? isLittleEndianFlag : 0;
   private static final int BUFFER_SIZE_LIMIT = 128 * 1024;
+  private static final short MAGIC_NUMBER = 0x62D4;
 
   private final Config config;
   private final boolean refTracking;
@@ -221,6 +222,9 @@ public MemoryBuffer serialize(MemoryBuffer buffer, Object obj) {
 
   @Override
   public MemoryBuffer serialize(MemoryBuffer buffer, Object obj, BufferCallback callback) {
+    if (language == Language.XLANG) {
+      buffer.writeInt16(MAGIC_NUMBER);
+    }
     byte bitmap = BITMAP;
     if (language != Language.JAVA) {
       bitmap |= isCrossLanguageFlag;
@@ -711,6 +715,12 @@ public Object deserialize(MemoryBuffer buffer, Iterable<MemoryBuffer> outOfBandB
       if (depth != 0) {
         throwDepthDeserializationException();
       }
+      if (language == Language.XLANG) {
+        short magicNumber = buffer.readInt16();
+        assert magicNumber == MAGIC_NUMBER
+            : "The XLANG cross-language protocol is not currently used. For details, "
+                + "see https://github.com/apache/incubator-fury/blob/main/docs/specification/xlang_serialization_spec.md.";
+      }
       byte bitmap = buffer.readByte();
       if ((bitmap & isNilFlag) == isNilFlag) {
         return null;

python/pyfury/_fury.py

@@ -89,6 +89,9 @@
 DEFAULT_DYNAMIC_WRITE_STRING_ID = -1
 
 
+MAGIC_NUMBER = 0x62D4
+
+
 class MetaStringBytes:
     __slots__ = (
         "data",
@@ -697,6 +700,8 @@ def _serialize(
         else:
             self.buffer.writer_index = 0
             buffer = self.buffer
+        if self.language == Language.XLANG:
+            buffer.write_int16(MAGIC_NUMBER)
         mask_index = buffer.writer_index
         # 1byte used for bit mask
         buffer.grow(1)
@@ -843,6 +848,12 @@ def _deserialize(
             self.unpickler = Unpickler(buffer)
         if unsupported_objects is not None:
             self._unsupported_objects = iter(unsupported_objects)
+        if self.language == Language.XLANG:
+            magic_numer = buffer.read_int16()
+            assert magic_numer == MAGIC_NUMBER, (
+                "The XLANG cross-language protocol is not currently used. For details,"
+                "see https://github.com/apache/incubator-fury/blob/main/docs/specification/xlang_serialization_spec.md"
+            )
         reader_index = buffer.reader_index
         buffer.reader_index = reader_index + 1
         if get_bit(buffer, reader_index, 0):

python/pyfury/_serialization.pyx

@@ -223,6 +223,7 @@ cdef int8_t STRING_CLASS_ID = 4
 cdef int8_t PICKLE_CLASS_ID = 5
 cdef int8_t PICKLE_STRONG_CACHE_CLASS_ID = 6
 cdef int8_t PICKLE_CACHE_CLASS_ID = 7
+cdef int16_t MAGIC_NUMBER = 0x62D4
 # `NOT_NULL_VALUE_FLAG` + `CLASS_ID<<1` in little-endian order
 cdef int32_t NOT_NULL_PYINT_FLAG = NOT_NULL_VALUE_FLAG & 0b11111111 | \
                                    (PYINT_CLASS_ID << 9)
@@ -899,6 +900,8 @@ cdef class Fury:
         else:
             self.buffer.writer_index = 0
             buffer = self.buffer
+        if self.language == Language.XLANG:
+            buffer.write_int16(MAGIC_NUMBER)
         cdef int32_t mask_index = buffer.writer_index
         # 1byte used for bit mask
         buffer.grow(1)
@@ -1058,6 +1061,11 @@ cdef class Fury:
             self.unpickler = Unpickler(buffer)
         if unsupported_objects is not None:
             self._unsupported_objects = iter(unsupported_objects)
+        if self.language == Language.XLANG:
+            magic_numer = buffer.read_int16()
+            assert magic_numer == MAGIC_NUMBER, (
+                "The XLANG cross-language protocol is not currently used. For details, see "
+                "https://github.com/apache/incubator-fury/blob/main/docs/specification/xlang_serialization_spec.md.")
         cdef int32_t reader_index = buffer.reader_index
         buffer.reader_index = reader_index + 1
         if get_bit(buffer, reader_index, 0):