Cant use compsite keys for domain id when extending JpaRepository

[huhu72]

Describe the bug
For Spring Boot Tools extension V1.50.0 on vscode)
When creating a interface that extends JpaRepository, it will throw an error saying "Expected Domain ID type is 'java.lang.String'vscode-spring-boot(DOMAIN_ID_FOR_REPOSITORY)". When I switch back to v1.49.0 the error is no longer there.

To Reproduce

1. Create an entity with a composite key
2. Create a repository interface that extends JpaRepository<T,ID>

Sample

package sample.entities;

import java.io.Serializable;
import java.time.LocalDateTime;
import java.time.ZonedDateTime;
import javax.persistence.*;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Size;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.apache.commons.lang3.StringUtils;

@Data
@AllArgsConstructor
@NoArgsConstructor
@Entity(name = "customer_account_relationship")
@IdClass(CustomerAccountId.class)
public class CustomerAccountRel implements Serializable, ErrorLoggable {

  @Id
  @NotNull
  @Size(max = 20)
  @Column(name = "acct_nbr", length = 20)
  private String acct_nbr;

  @Id
  @Size(max = 50)
  @Column(name = "customer_id", length = 50)
  private String customerId;

  @NotNull
  @Size(max = 5)
  @Column(name = "relation_code", length = 5)
  private String relation_code;

  public void setAcct_nbr(String acct_nbr) {
    this.acct_nbr = StringUtils.truncate(acct_nbr, 20);
  }

  public void setCustomerId(String customerId) {
    this.customerId = StringUtils.truncate(customerId, 50);
  }

  public void setRelation_code(String relation_code) {
    this.relation_code = StringUtils.truncate(relation_code, 5);
  }

  @Override
  public String getId() {
    return customerId + " - " + acct_nbr;
  }

}

package sample.entities;

import java.io.Serializable;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@AllArgsConstructor
@NoArgsConstructor
public class CustomerAccountId implements Serializable {

  private String acct_nbr;
  private String customerId;
}

package sample.repositories;

import sample.entities.CustomerAccountId;
import sample.entities.CustomerAccountRel;
import java.util.List;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.stereotype.Repository;

@Repository
public interface CustomerAccountRelRepository
    extends JpaRepository<CustomerAccountRel, CustomerAccountId> {

  public List<CustomerAccountRel> findByCustomerId(String customerId);
}

[BoykoAlex]

@huhu72 thanks for reporting this. While we are fixing the issue the workaround would be turning this validation off in the preferences/settings.

[BoykoAlex]

Should be fixed with b1e1bf7

[chalikir]

latest version of Spring STS plugin for eclipse is still having this issue.

it gives error 'Expected Domain ID type is 'long''

[BoykoAlex]

Is the code snippet to reproduce the issue still the same? If not, do you mind pasting the java code snippets for which you still observe the issue?

[chalikir]

I had problem with this version . <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.7.18</version> </parent> I have to change it to fix it <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.7.8</version> </parent>

…

On Thu, Dec 14, 2023 at 1:56 PM Alex Boyko ***@***.***> wrote: Is the code snippet to reproduce the issue still the same? If not, do you mind pasting the java code snippets for which you still observe the issue? — Reply to this email directly, view it on GitHub <#1139 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AASKFRIAW55MBHID3YMEECTYJNDULAVCNFSM6AAAAAA64OFPLCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQNJWGQYTCOBQGM> . You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>

-- Raja Sekhar Chaliki

[BoykoAlex]

@chalikir hmm... i wouldn't think that changing boot version could help with reconciling. The reconciling in this case isn't based on a boot version on the classpath... It seems though as i made a mistake in the fix to this issue. Someone else complained about the same issue here #1159. I have pushed a fix and would be great if you could try the snapshot distro build or nightly update site (see https://cdn.spring.io/spring-tools/snapshot/STS4/nightly-distributions.html)

[chalikir]

Ok. Will di. Thanks for letting me know.

…

On Thu, Dec 14, 2023, 4:47 PM Alex Boyko ***@***.***> wrote: @chalikir <https://github.com/chalikir> hmm... i wouldn't think that changing boot version could help with reconciling. The reconciling in this case isn't based on a boot version on the classpath... It seems though as i made a mistake in the fix to this issue. Someone else complained about the same issue here #1159 <#1159>. I have pushed a fix and would be great if you could try the snapshot distro build or nightly update site (see https://cdn.spring.io/spring-tools/snapshot/STS4/nightly-distributions.html ) — Reply to this email directly, view it on GitHub <#1139 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AASKFRKE3KE3HG7RNWLDLT3YJNXXRAVCNFSM6AAAAAA64OFPLCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQNJWGY4TSMZYGI> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[SajidhKareem]

Is this issue fixed? Right now I'm having this issue in my version of STS. Would like to know if a newer version has arrived with a fix.

[BoykoAlex]

@SajidhKareem All fixes were put into STS 4.21.0 if this is the version you're using and still seeing issues then please raise a new issue for it.

As a workaround you can disable the validation for entity keys... it is somewhat experimental.
Go to Settings -> Spring -> Validation -> Boot 2.x Best Practices page. Find "Invalid Domain ID Type for Spring Data Repository" and switch it to "IGNORE" using the drop down.

[neo7BF]

I just downloaded sts but this problem continues to occur.

[BoykoAlex]

@neo7BF Can you paste your NotificatioEntity in here please? You can simply disable this validation in the preferences as a workaround (Spring -> Validations)

[neo7BF]

This is the entity:

@Entity
@Table(name = "notification")
@Data
public class NotificationEntity implements Serializable {

    @Id
    @NotNull
    @NotBlank
    @Size(max = 255)
    @Column(name = "notification_k", length = 255)
    private String key;

    @NotNull
    @Column(name = "sent_at")
    private OffsetDateTime sentAt;

    @Size(max = 255)
    @Column(name = "error_message", length = 255)
    private String errorMessage;

    public NotificationEntity() {
    }

    public NotificationEntity(@NotNull @NotBlank @Size(max = 255) String key) {
        this.key = key;
    }
}

[BoykoAlex]

If your id is String in the NotificationEntity then I'd expect NotificationRepository extends JPARepository<Notification, String> rather than JPARepository<Notification, Long> - i think Long is underlined as expected... Or am I missing something?

[neo7BF]

Yes correct. I was misled by the fact that I had downloaded sources
and I had worked on it in another editor and it didn't highlight it to me as a compilation error as happens in STS. Assuming that the source was correct because it compiled from there, I thought it was a problem with STS, but instead it was a lack of the other editor.
I am sorry !

[BoykoAlex]

@neo7BF no problem at all! This validation is very flaky unfortunately. Don't be shy to bring up any issues with this validation in the future even if they don't turn out to be issues.

[WeiMao33]

Sorry, I can't find the Boot 2.x Best Practices page. this is my screen shot.
ENV:
eclipse Version: 2023-12 (4.30.0)

[BoykoAlex]

If this validation gives you issues please paste your domain class and repository implementations with the short description of the issue.

[WeiMao33]

thanks @BoykoAlex
here are the codes.

Spring Tool Suite 4 
Version: 4.22.0.RELEASE
Build Id: 202403071427
Revision: 44291b464093d161f115d8e16059e5272ed3c81d

import jakarta.persistence.Column;
import jakarta.persistence.GeneratedValue;
import jakarta.persistence.GenerationType;
import jakarta.persistence.Id;
import jakarta.persistence.MappedSuperclass;
import lombok.AllArgsConstructor;
import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;
import lombok.experimental.SuperBuilder;

@Setter
@Getter
@EqualsAndHashCode
@MappedSuperclass
@NoArgsConstructor
@AllArgsConstructor
@SuperBuilder(toBuilder = true)
public abstract class BaseEntity {

  @Id
  @Column(name = "id")
  @GeneratedValue(strategy = GenerationType.IDENTITY)
  private Long id;
}

import org.springframework.data.jpa.repository.support.JpaEntityInformation;
import org.springframework.data.jpa.repository.support.SimpleJpaRepository;

import jakarta.persistence.EntityManager;

public abstract class RdsJpaRepository<T extends BaseEntity, ID>
    extends SimpleJpaRepository<T, ID> {

  public RdsJpaRepository(Class<T> domainClass, EntityManager em) {
    super(domainClass, em);
  }

  public RdsJpaRepository(
      JpaEntityInformation<T, ?> entityInformation, EntityManager entityManager) {
    super(entityInformation, entityManager);
  }
}

[BoykoAlex]

Last comment extracted in #1220