Method parameters validation fails for @Converted collections used as scalars [DATAJPA-1682]

ahaczewski opened DATAJPA-1682 and commented

One of the uses of Spring Data JPA in my company is to store plain Protocol Buffers messages and in @Entity we have a field of type ByteString, which is Iterable, we also have a custom @Converter created for it, which converts ByteString to Base-64 string.

Here is ByteString declaration (from ByteString JavaDoc):

public abstract class ByteString
extends Object
implements Iterable<Byte>, Serializable

Here is a custom converter that we use:

@Converter
public class ByteStringConverter implements AttributeConverter<ByteString, String> {

  @Override
  public String convertToDatabaseColumn(ByteString attribute) {
    return BaseEncoding.base64().encode(attribute.toByteArray());
  }

  @Override
  public ByteString convertToEntityAttribute(String dbData) {
    byte[] decodedBytes = BaseEncoding.base64().decode(dbData);
    return ByteString.copyFrom(decodedBytes);
  }
}

Here is our field declaration in the entity:

@Column(updatable = false, unique = true)
@Convert(converter = ByteStringConverter.class)
private ByteString signature;

Here is our repository method:

Optional<SignatureEntity> findBySignature(ByteString featuresSignature);

This setup worked perfectly fine in Spring Data JPA 2.1, but now fails with the following exception:

Caused by: java.lang.IllegalStateException: Operator SIMPLE_PROPERTY on signature requires a scalar argument, found class com.google.protobuf.ByteString in method public abstract java.util.Optional com.company.project.SignatureEntityRepository.findBySignature(com.google.protobuf.ByteString).
	at org.springframework.data.jpa.repository.query.PartTreeJpaQuery.throwExceptionOnArgumentMismatch(PartTreeJpaQuery.java:171)
	at org.springframework.data.jpa.repository.query.PartTreeJpaQuery.validate(PartTreeJpaQuery.java:147)
	at org.springframework.data.jpa.repository.query.PartTreeJpaQuery.<init>(PartTreeJpaQuery.java:90)
	... 119 common frames omitted

Affects: 2.2.4 (Moore SR4)

Reference URL: https://github.com/spring-projects/spring-data-jpa/pull/228#issuecomment-585244338

3 votes, 4 watchers