making stf8 format support configurable for providing backward compatibility between different serializers versions

marenzo · marenzo · commit ca723f87ac66 · 2016-04-06T18:45:41.000+03:00
diff --git a/msgpack-core/src/main/java/org/msgpack/core/MessagePack.java b/msgpack-core/src/main/java/org/msgpack/core/MessagePack.java
@@ -248,6 +248,8 @@ public static class PackerConfig
 
         private int bufferSize = 8192;
 
+        private boolean str8FormatSupport = true;
+
         public PackerConfig()
         { }
 
@@ -366,6 +368,23 @@ public int getBufferSize()
         {
             return bufferSize;
         }
+
+        /**
+         * Disable str8 format when needed backward compatibility between
+         * different msgpack serializer versions.
+         * default true (str8 supported enabled)
+         */
+        public PackerConfig withStr8FormatSupport(boolean str8FormatSupport)
+        {
+            PackerConfig copy = clone();
+            copy.str8FormatSupport = str8FormatSupport;
+            return copy;
+        }
+
+        public boolean isStr8FormatSupport()
+        {
+            return str8FormatSupport;
+        }
     }
 
     /**
diff --git a/msgpack-core/src/main/java/org/msgpack/core/MessagePacker.java b/msgpack-core/src/main/java/org/msgpack/core/MessagePacker.java
@@ -88,6 +88,8 @@ public class MessagePacker
 
     private final int bufferFlushThreshold;
 
+    private final boolean str8FormatSupport;
+
     protected MessageBufferOutput out;
 
     private MessageBuffer buffer;
@@ -116,6 +118,7 @@ protected MessagePacker(MessageBufferOutput out, MessagePack.PackerConfig config
         this.out = checkNotNull(out, "MessageBufferOutput is null");
         this.smallStringOptimizationThreshold = config.getSmallStringOptimizationThreshold();
         this.bufferFlushThreshold = config.getBufferFlushThreshold();
+        this.str8FormatSupport = config.isStr8FormatSupport();
         this.position = 0;
         this.totalFlushBytes = 0;
     }
@@ -667,7 +670,7 @@ public MessagePacker packRawStringHeader(int len)
         if (len < (1 << 5)) {
             writeByte((byte) (FIXSTR_PREFIX | len));
         }
-        else if (len < (1 << 8)) {
+        else if (str8FormatSupport && len < (1 << 8)) {
             writeByteAndByte(STR8, (byte) len);
         }
         else if (len < (1 << 16)) {
diff --git a/msgpack-jackson/src/test/java/org/msgpack/jackson/dataformat/MessagePackGeneratorTest.java b/msgpack-jackson/src/test/java/org/msgpack/jackson/dataformat/MessagePackGeneratorTest.java
@@ -46,6 +46,7 @@
 import static org.junit.Assert.assertArrayEquals;
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertNotEquals;
 import static org.junit.Assert.assertTrue;
 
 public class MessagePackGeneratorTest
@@ -435,4 +436,22 @@ public Exception call()
             }
         }
     }
+
+    @Test
+    public void testDisableStr8Support()
+      throws Exception
+    {
+        String str8LengthString = new String(new char[32]).replace("\0", "a");
+
+        // Test that produced value having str8 format
+        ObjectMapper defaultMapper = new ObjectMapper(new MessagePackFactory());
+        byte[] resultWithStr8Format = defaultMapper.writeValueAsBytes(str8LengthString);
+        assertEquals(resultWithStr8Format[0], MessagePack.Code.STR8);
+
+        // Test that produced value does not having str8 format
+        MessagePack.PackerConfig config = new MessagePack.PackerConfig().withStr8FormatSupport(false);
+        ObjectMapper mapperWithConfig = new ObjectMapper(new MessagePackFactory(config));
+        byte[] resultWithoutStr8Format = mapperWithConfig.writeValueAsBytes(str8LengthString);
+        assertNotEquals(resultWithoutStr8Format[0], MessagePack.Code.STR8);
+    }
 }
