Details

Description

Motivation

We are trying to implement message signing in the application layer for an internal project. The transport is over Thrift – the server side is using Java and the client side is using C++. We noticed that the message signing would fail because the client and server would serialize the same Thrift object in different ways.

Problem

The semantics of "optional" fields differ between thrift code generated for Java and CPP. In CPP, all optional fields are guarded by the isset helper struct. On Java, however, the generated code takes advantage of nullable types: for containers, structs, exceptions, enums, and, notably, strings, the generator elides explicit use of an "isset" bit vector and instead emits checks of the form "field null". This leads to varying behavior between the two languages: an optional string field with a default value will have isset[fieldid] false on C, but the equivalent test in Java will be true.

As a result, when the Java object is serialized, the value for 'bar' is included. But when the C++ object is serialized, the value for 'bar' is NOT included.

For a system like Thrift, I would eschew a few bytes saved over correctness and reliability. As a user of Thrift, I do expect that the wire data generated for identical Thrift objects will be identical, regardless of the language used.

Proposal

We already use a BitSet to track primitive types in Java. The compiler should extend the bit vector to also guard nullable types, to be consistent with C++. This is pretty easy and low impact – I'm happy to provide a patch.

Jake, considering that the current C++ <-> Java wire translation is inconsistent and likely to be inconsistent across other languages as well AND considering that this hasn't been a huge issue in the community so far, my sense is that most Thrift users just haven't run into this.

Given our limited resources, we are unable to provide patches for other client libraries. But I don't see why that should prevent this patch from going in – it passes all tests and doesn't break any existing clients and/or functionality.

Diwaker Gupta
added a comment - 13/Dec/11 00:02 Jake, considering that the current C++ <-> Java wire translation is inconsistent and likely to be inconsistent across other languages as well AND considering that this hasn't been a huge issue in the community so far, my sense is that most Thrift users just haven't run into this.
Given our limited resources, we are unable to provide patches for other client libraries. But I don't see why that should prevent this patch from going in – it passes all tests and doesn't break any existing clients and/or functionality.
What would it take to get this patch into the next release?

In CPP, all optional fields are guarded by the isset helper struct. On Java, however, the generated code takes advantage of nullable types: for containers, structs, exceptions, enums, and, notably, strings, the generator elides explicit use of an "isset" bit vector and instead emits checks of the form "field null". This leads to varying behavior between the two languages: an optional string field with a default value will have isset[fieldid] false on C, but the equivalent test in Java will be true.

Hudson
added a comment - 27/Jan/12 05:28 Integrated in Thrift #398 (See https://builds.apache.org/job/Thrift/398/ )
THRIFT-1394 :Treatment of optional fields is not consistent between C++ and Java
Client: cpp
Patch: Diwaker Gupta
In CPP, all optional fields are guarded by the isset helper struct. On Java, however, the generated code takes advantage of nullable types: for containers, structs, exceptions, enums, and, notably, strings, the generator elides explicit use of an "isset" bit vector and instead emits checks of the form "field null". This leads to varying behavior between the two languages: an optional string field with a default value will have isset [fieldid] false on C, but the equivalent test in Java will be true.
jfarrell : http://svn.apache.org/viewvc/?view=rev&rev=1236529
Files :
/thrift/trunk/compiler/cpp/src/generate/t_cpp_generator.cc
/thrift/trunk/lib/cpp/test/OptionalRequiredTest.cpp
/thrift/trunk/test/OptionalRequiredTest.thrift