hypersistence-utils: Unexpected dirty checking behavior on collections of POJOs mapped with JsonBinaryType
Description
When reading entities with collections of POJOs such as TestEntity (see Example 1), updates are performed on the database without the objects being changed.
Example 1
@TypeDefs({
@TypeDef(name = "jsonb", typeClass = JsonBinaryType.class)
})
@Entity
public class TestEntity {
@GeneratedValue(strategy = GenerationType.IDENTITY)
@Id
public int id;
@Type(type = "jsonb")
public Collection<TestElement> testElements;
public static class TestElement implements Serializable {
static final long serialVersionUID = -8485895696327472738L;
public String testProperty;
}
}
Analysis
It appears as if the dirty check on JsonBinaryType properties for collections of POJOs does no longer work as expected. The problem occurs since [commit-1]. This commit introduces a new dirty checking behavior for JsonBinaryType, when used with collections:
public boolean areEqual(Object one, Object another) {
// ...
if (one instanceof Collection && another instanceof Collection) {
return Objects.equals(one, another);
}
I would not expect the usage of java.lang.Object#equals at this point. In my understanding it creates an inconsistency compared to the dirty checking behavior used for non-collection types. The recursive field by field comparison before [commit-1] is appropriate in my opinion.
Workaround
Downgrade to the version before [commit-1]: version 2.4.2.
Links
About this issue
- Original URL
- State: closed
- Created 7 years ago
- Reactions: 2
- Comments: 18 (12 by maintainers)
Commits related to this issue
- Unexpected dirty checking behavior on collections of POJOs mapped with JsonBinaryType #138 — committed to vladmihalcea/hypersistence-utils by vladmihalcea 7 years ago
- Issue #138: Added documentation for JsonBinaryType dirty checking behavior — committed to cosminseceleanu/hibernate-types by cosminseceleanu 6 years ago
- Issue #138: Added documentation for JsonBinaryType dirty checking behavior — committed to vladmihalcea/hypersistence-utils by cosminseceleanu 6 years ago
@zxmarcos All JPA attributes should be
Serializable. The specification requires that, as indicated by the Hibernate documentation.to clarify - by “entity” we mean JPA Entity, by POJO - the type, that is persisted as JSON column, right ?
So, in this case:
DocumentOutboxRecordwould be an “entity” andDocumentPayloadV10- a POJO?and by “implementing equals/hashCode for POJO attributes” we mean that all custom (non-JDK) types, used inside the POJO type, and their attributes in turn, all should have
equals/hashCodeimplemented (i.e. not inherited fromObject) ?well, if that is correct, then “POJO” and the only custom type used in the POJO definition, they both have
equalsandhashCodeimplementations, generated with Lombok.And by the way, I have narrowed down the problem starting point: it was in 2.9.3 version of “hibernate-types-52” artifact. So, with 2.9.0/2.9.1/2.9.2 all is fine (just as with 2.5.2, for example), and with 2.9.3. and all subsequent versions - all goes bust… Version number being the only difference
Thanks. I’ll review it when I have some time. It would be great if there were a Contribution Guide too. You can supply one if you like.