Uploaded image for project: 'Apache Avro'
  1. Apache Avro
  2. AVRO-1743

BlockingBinaryEncoder should override writeFixed(ByteBuffer bytes)

    XMLWordPrintableJSON

Details

    • Bug
    • Status: Resolved
    • Major
    • Resolution: Fixed
    • 1.7.6, 1.7.7
    • 1.9.0
    • java
    • All environments

    Description

      BlockingBinaryEncoder which extends BufferedBinaryEncoder should override "public void writeFixed(ByteBuffer bytes) throws IOException" method.
      Now if we use BlockingBinaryEncoder - all writeFixed(ByteBuffer bytes) are addressed by BufferedBinaryEncoder. As a result, if "!bytes.hasArray() && bytes.remaining() > bulkLimit", then in flushBuffer() we flush empty buffer from BufferedBinaryEncoder and don't flush actual buffer from BlockingBinaryEncoder.

      I prepared localized unit tests to replicate bugs here: https://github.com/Spikhalskiy/avro-blockingbinaryencoder-error

      Bug could appears in silently incorrect serialization (We will read another object) or in deserialization errors. Both replicated in provided tests.

      Looks like BlockingBinaryEncoder which extends BufferedBinaryEncoder is error-prone approach and mistake in class hierarchy. We mostly override everything from BufferedBinaryEncoder, creating unused buffers and fields (like double pos, buf, etc), and it's already not first bug relating to "somebody forget to override method in BlockingBinaryEncoder from BufferedBinaryEncoder" (ex. https://issues.apache.org/jira/browse/AVRO-88). So, this classes should be separated at all or have common interface, or at least work with same buffer and pos instances. But BlockingBinaryEncoder shouldn't inherit method implementations, which work with another buffer object.

      Attachments

        Issue Links

          Activity

            People

              dkulp Daniel Kulp
              spikhalskiy Dmitry Spikhalskiy
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: