[AMQ-8417] ActiveMQBytesMessage - unable to read content after property is set

• Type: Bug
• Status: Reopened
• Priority: Critical
• Resolution: Unresolved
• Affects Version/s: 5.16.3
• Component/s: JMS client
• Assignee: Unassigned
• Reporter: R@DU
• Created: 26/Nov/21 10:48
• Updated: 24/Nov/22 14:20

Description

This issue was discovered, when using spring boot 2.5.7 and spring cloud 2020.0.4 (brave 5.13.2, and ActiveMQ Client 5.16.3)!
When sleuth is enabled, brave instrumentation jms edits the jms message, by removing properties related to sleuth, then jms message is consumed further (i.e. content is read).
The issue is when jms message is of type ActiveMQBytesMessage.
Having a closer look at how ActiveMQBytesMessage was implemented, I came to the conclusion that there is something wrong. However I do not know exactly if this is true, that's why I opened a bug for brave instrumentation jms as well. Please check for more details here: https://github.com/openzipkin/brave/issues/1310 ;

—

Steps:

1. jms message, of type ActiveMQBytesMessage is received;
2. set a property on that message - use ActiveMQBytesMessage#setObjectProperty method;
3. try to read the content - use ActiveMQBytesMessage#read* method.
4. analyze the result...

Expected:
The content is read...

Actual:
no content is read... 

For more details check: https://github.com/openzipkin/brave/issues/1310

Things to consider

When ActiveMQBytesMessage#setObjectProperty method is called

the `initializeWritingNoCheck()` method moves the `content` to `dataOut`/`bytesOut`.
As a result, `content` will be `null` and `dataOut`/`bytesOut` will contain the bytes moved from `content`. Note `dataIn` remains `null`.

Note the comment done above `this.content = null;`!

When `ActiveMQBytesMessage#read*` method is called, for example readByte()

the `initializeReading()` will try to prepare the `dataIn` for reading, based on the `content`... but the `content` is `null` (here is the problem actually)

as a result, the `dataIn` is initialized with an empty sequence of bytes (i.e. empty input stream).
As a result, calling dataIn.read* method (in our example it will be dataIn.readByte()) will end in unexpected result (EOF or -1)...

Solution (in my opinion)
Fix should be done in org.apache.activemq.command.ActiveMQBytesMessage#initializeReading() method.
When `content` is null, then org.apache.activemq.command.ActiveMQBytesMessage#storeContent() method should be called.
Here is the code snippet:

ByteSequence data = getContent();
if (data == null) {
    storeContent();
    data = getContent(); // storeContent() will set the content... only if dataOut != null;
    if (data == null) {
        data = new ByteSequence(new byte[] {}, 0, 0); // don't understand why we should silently fallback to an empty byte sequence... I would opt for an exception
    }
} 

This is just my opinion ^.

 

Note: I do not know who should do the fix, that's why I have created this bug, and additionally I have created a bug on the ActiveMQ client-side, in the hope to obtain a resolution ASAP... check https://github.com/openzipkin/brave/issues/1310