From 3e5ab63a783602791eea539b3465504d23d8cbc4 Mon Sep 17 00:00:00 2001 From: Jens Schauder Date: Wed, 26 Jun 2024 11:58:56 +0200 Subject: [PATCH] Fix Auditing for embedded fields. The reason for auditing to not work on embedded fields is that EmbeddedRelationalPersistentProperty and BasicRelationalPersisntentProperty were not considered equal even when they represent the same field. Note: the fix is somewhat hackish since it breaks the equals contract for EmbeddedRelationalPersistentProperty. Closes #1694 See https://github.com/spring-projects/spring-data-mongodb/commit/1545e184ef581d39fc538f582bae93fedde2aadf --- ...nableJdbcAuditingHsqlIntegrationTests.java | 241 +++++++++++++----- .../EmbeddedRelationalPersistentProperty.java | 10 +- ...RelationalPersistentPropertyUnitTests.java | 44 ++++ 3 files changed, 223 insertions(+), 72 deletions(-) create mode 100644 spring-data-relational/src/test/java/org/springframework/data/relational/core/mapping/EmbeddedRelationalPersistentPropertyUnitTests.java diff --git a/spring-data-jdbc/src/test/java/org/springframework/data/jdbc/repository/config/EnableJdbcAuditingHsqlIntegrationTests.java b/spring-data-jdbc/src/test/java/org/springframework/data/jdbc/repository/config/EnableJdbcAuditingHsqlIntegrationTests.java index fab3203a0..3f60cfa70 100644 --- a/spring-data-jdbc/src/test/java/org/springframework/data/jdbc/repository/config/EnableJdbcAuditingHsqlIntegrationTests.java +++ b/spring-data-jdbc/src/test/java/org/springframework/data/jdbc/repository/config/EnableJdbcAuditingHsqlIntegrationTests.java @@ -44,6 +44,7 @@ import org.springframework.data.jdbc.testing.EnabledOnDatabase; import org.springframework.data.jdbc.testing.IntegrationTest; import org.springframework.data.jdbc.testing.TestClass; import org.springframework.data.jdbc.testing.TestConfiguration; +import org.springframework.data.relational.core.mapping.Embedded; import org.springframework.data.relational.core.mapping.NamingStrategy; import org.springframework.data.relational.core.mapping.event.BeforeConvertCallback; import org.springframework.data.relational.core.mapping.event.BeforeSaveEvent; @@ -68,50 +69,50 @@ public class EnableJdbcAuditingHsqlIntegrationTests { AuditingAnnotatedDummyEntityRepository.class, // Config.class, // AuditingConfiguration.class) // - .accept(repository -> { + .accept(repository -> { - AuditingConfiguration.currentAuditor = "user01"; - LocalDateTime now = LocalDateTime.now(); + AuditingConfiguration.currentAuditor = "user01"; + LocalDateTime now = LocalDateTime.now(); - AuditingAnnotatedDummyEntity entity = repository.save(new AuditingAnnotatedDummyEntity()); + AuditingAnnotatedDummyEntity entity = repository.save(new AuditingAnnotatedDummyEntity()); - assertThat(entity.id).as("id not null").isNotNull(); - assertThat(entity.getCreatedBy()).as("created by set").isEqualTo("user01"); - assertThat(entity.getCreatedDate()).as("created date set").isAfter(now); - assertThat(entity.getLastModifiedBy()).as("modified by set").isEqualTo("user01"); - assertThat(entity.getLastModifiedDate()).as("modified date set") - .isAfterOrEqualTo(entity.getCreatedDate()); - assertThat(entity.getLastModifiedDate()).as("modified date after instance creation").isAfter(now); + assertThat(entity.id).as("id not null").isNotNull(); + assertThat(entity.getCreatedBy()).as("created by set").isEqualTo("user01"); + assertThat(entity.getCreatedDate()).as("created date set").isAfter(now); + assertThat(entity.getLastModifiedBy()).as("modified by set").isEqualTo("user01"); + assertThat(entity.getLastModifiedDate()).as("modified date set") + .isAfterOrEqualTo(entity.getCreatedDate()); + assertThat(entity.getLastModifiedDate()).as("modified date after instance creation").isAfter(now); - AuditingAnnotatedDummyEntity reloaded = repository.findById(entity.id).get(); + AuditingAnnotatedDummyEntity reloaded = repository.findById(entity.id).get(); - assertThat(reloaded.getCreatedBy()).as("reload created by").isNotNull(); - assertThat(reloaded.getCreatedDate()).as("reload created date").isNotNull(); - assertThat(reloaded.getLastModifiedBy()).as("reload modified by").isNotNull(); - assertThat(reloaded.getLastModifiedDate()).as("reload modified date").isNotNull(); + assertThat(reloaded.getCreatedBy()).as("reload created by").isNotNull(); + assertThat(reloaded.getCreatedDate()).as("reload created date").isNotNull(); + assertThat(reloaded.getLastModifiedBy()).as("reload modified by").isNotNull(); + assertThat(reloaded.getLastModifiedDate()).as("reload modified date").isNotNull(); - LocalDateTime beforeCreatedDate = entity.getCreatedDate(); - LocalDateTime beforeLastModifiedDate = entity.getLastModifiedDate(); + LocalDateTime beforeCreatedDate = entity.getCreatedDate(); + LocalDateTime beforeLastModifiedDate = entity.getLastModifiedDate(); - sleepMillis(10); + sleepMillis(10); - AuditingConfiguration.currentAuditor = "user02"; + AuditingConfiguration.currentAuditor = "user02"; - entity = repository.save(entity); + entity = repository.save(entity); - assertThat(entity.getCreatedBy()).as("created by unchanged").isEqualTo("user01"); - assertThat(entity.getCreatedDate()).as("created date unchanged").isEqualTo(beforeCreatedDate); - assertThat(entity.getLastModifiedBy()).as("modified by updated").isEqualTo("user02"); - assertThat(entity.getLastModifiedDate()).as("modified date updated") - .isAfter(beforeLastModifiedDate); + assertThat(entity.getCreatedBy()).as("created by unchanged").isEqualTo("user01"); + assertThat(entity.getCreatedDate()).as("created date unchanged").isEqualTo(beforeCreatedDate); + assertThat(entity.getLastModifiedBy()).as("modified by updated").isEqualTo("user02"); + assertThat(entity.getLastModifiedDate()).as("modified date updated") + .isAfter(beforeLastModifiedDate); - reloaded = repository.findById(entity.id).get(); + reloaded = repository.findById(entity.id).get(); - assertThat(reloaded.getCreatedBy()).as("2. reload created by").isNotNull(); - assertThat(reloaded.getCreatedDate()).as("2. reload created date").isNotNull(); - assertThat(reloaded.getLastModifiedBy()).as("2. reload modified by").isNotNull(); - assertThat(reloaded.getLastModifiedDate()).as("2. reload modified date").isNotNull(); - }); + assertThat(reloaded.getCreatedBy()).as("2. reload created by").isNotNull(); + assertThat(reloaded.getCreatedDate()).as("2. reload created date").isNotNull(); + assertThat(reloaded.getLastModifiedBy()).as("2. reload modified by").isNotNull(); + assertThat(reloaded.getLastModifiedDate()).as("2. reload modified date").isNotNull(); + }); } @Test // DATAJDBC-204 @@ -121,17 +122,17 @@ public class EnableJdbcAuditingHsqlIntegrationTests { DummyEntityRepository.class, // Config.class, // AuditingConfiguration.class) // - .accept(repository -> { + .accept(repository -> { - DummyEntity entity = repository.save(new DummyEntity()); + DummyEntity entity = repository.save(new DummyEntity()); - assertThat(entity.id).isNotNull(); - assertThat(repository.findById(entity.id).get()).isEqualTo(entity); + assertThat(entity.id).isNotNull(); + assertThat(repository.findById(entity.id).get()).isEqualTo(entity); - entity = repository.save(entity); + entity = repository.save(entity); - assertThat(repository.findById(entity.id)).contains(entity); - }); + assertThat(repository.findById(entity.id)).contains(entity); + }); } @Test // DATAJDBC-204 @@ -141,19 +142,19 @@ public class EnableJdbcAuditingHsqlIntegrationTests { AuditingAnnotatedDummyEntityRepository.class, // Config.class, // CustomizeAuditorAwareAndDateTimeProvider.class) // - .accept(repository -> { + .accept(repository -> { - LocalDateTime currentDateTime = LocalDate.of(2018, 4, 14).atStartOfDay(); - CustomizeAuditorAwareAndDateTimeProvider.currentDateTime = currentDateTime; + LocalDateTime currentDateTime = LocalDate.of(2018, 4, 14).atStartOfDay(); + CustomizeAuditorAwareAndDateTimeProvider.currentDateTime = currentDateTime; - AuditingAnnotatedDummyEntity entity = repository.save(new AuditingAnnotatedDummyEntity()); + AuditingAnnotatedDummyEntity entity = repository.save(new AuditingAnnotatedDummyEntity()); - assertThat(entity.id).isNotNull(); - assertThat(entity.getCreatedBy()).isEqualTo("custom user"); - assertThat(entity.getCreatedDate()).isEqualTo(currentDateTime); - assertThat(entity.getLastModifiedBy()).isNull(); - assertThat(entity.getLastModifiedDate()).isNull(); - }); + assertThat(entity.id).isNotNull(); + assertThat(entity.getCreatedBy()).isEqualTo("custom user"); + assertThat(entity.getCreatedDate()).isEqualTo(currentDateTime); + assertThat(entity.getLastModifiedBy()).isNull(); + assertThat(entity.getLastModifiedDate()).isNull(); + }); } @Test // DATAJDBC-204 @@ -163,16 +164,16 @@ public class EnableJdbcAuditingHsqlIntegrationTests { AuditingAnnotatedDummyEntityRepository.class, // Config.class, // CustomizeAuditorAware.class) // - .accept(repository -> { + .accept(repository -> { - AuditingAnnotatedDummyEntity entity = repository.save(new AuditingAnnotatedDummyEntity()); + AuditingAnnotatedDummyEntity entity = repository.save(new AuditingAnnotatedDummyEntity()); - assertThat(entity.id).isNotNull(); - assertThat(entity.getCreatedBy()).isEqualTo("user"); - assertThat(entity.getCreatedDate()).isNull(); - assertThat(entity.getLastModifiedBy()).isEqualTo("user"); - assertThat(entity.getLastModifiedDate()).isNull(); - }); + assertThat(entity.id).isNotNull(); + assertThat(entity.getCreatedBy()).isEqualTo("user"); + assertThat(entity.getCreatedDate()).isNull(); + assertThat(entity.getLastModifiedBy()).isEqualTo("user"); + assertThat(entity.getLastModifiedDate()).isNull(); + }); } @Test // DATAJDBC-390 @@ -193,21 +194,97 @@ public class EnableJdbcAuditingHsqlIntegrationTests { }); } + + @Test // DATAJDBC-1694 + public void auditEmbeddedRecord() { + + configureRepositoryWith( // + DummyEntityWithEmbeddedRecordRepository.class, // + Config.class, // + AuditingConfiguration.class) // + .accept(repository -> { + + AuditingConfiguration.currentAuditor = "user01"; + LocalDateTime now = LocalDateTime.now(); + + DummyEntityWithEmbeddedRecord entity = repository.save(new DummyEntityWithEmbeddedRecord(null, new EmbeddedAuditing(null, null, null, null))); + + assertThat(entity.id).as("id not null").isNotNull(); + assertThat(entity.auditing.createdBy).as("created by set").isEqualTo("user01"); + assertThat(entity.auditing.createdDate()).as("created date set").isAfter(now); + assertThat(entity.auditing.lastModifiedBy()).as("modified by set").isEqualTo("user01"); + assertThat(entity.auditing.lastModifiedDate()).as("modified date set") + .isAfterOrEqualTo(entity.auditing.createdDate()); + assertThat(entity.auditing.lastModifiedDate()).as("modified date after instance creation").isAfter(now); + + DummyEntityWithEmbeddedRecord reloaded = repository.findById(entity.id).get(); + + assertThat(reloaded.auditing.createdBy()).as("reload created by").isNotNull(); + assertThat(reloaded.auditing.createdDate()).as("reload created date").isNotNull(); + assertThat(reloaded.auditing.lastModifiedBy()).as("reload modified by").isNotNull(); + assertThat(reloaded.auditing.lastModifiedDate()).as("reload modified date").isNotNull(); + + LocalDateTime beforeCreatedDate = entity.auditing().createdDate; + LocalDateTime beforeLastModifiedDate = entity.auditing().lastModifiedDate; + + sleepMillis(10); + + AuditingConfiguration.currentAuditor = "user02"; + + entity = repository.save(entity); + + assertThat(entity.auditing.createdBy()).as("created by unchanged").isEqualTo("user01"); + assertThat(entity.auditing.createdDate()).as("created date unchanged").isEqualTo(beforeCreatedDate); + assertThat(entity.auditing.lastModifiedBy()).as("modified by updated").isEqualTo("user02"); + assertThat(entity.auditing.lastModifiedDate()).as("modified date updated") + .isAfter(beforeLastModifiedDate); + + reloaded = repository.findById(entity.id).get(); + + assertThat(reloaded.auditing.createdBy()).as("2. reload created by").isNotNull(); + assertThat(reloaded.auditing.createdDate()).as("2. reload created date").isNotNull(); + assertThat(reloaded.auditing.lastModifiedBy()).as("2. reload modified by").isNotNull(); + assertThat(reloaded.auditing.lastModifiedDate()).as("2. reload modified date").isNotNull(); + }); + } + @Test // DATAJDBC-1694 + public void auditEmbeddedNullRecordStaysNull() { + + configureRepositoryWith( // + DummyEntityWithEmbeddedRecordRepository.class, // + Config.class, // + AuditingConfiguration.class) // + .accept(repository -> { + + AuditingConfiguration.currentAuditor = "user01"; + + DummyEntityWithEmbeddedRecord entity = repository.save(new DummyEntityWithEmbeddedRecord(null, null)); + + assertThat(entity.id).as("id not null").isNotNull(); + assertThat(entity.auditing).isNull(); + + DummyEntityWithEmbeddedRecord reloaded = repository.findById(entity.id).get(); + + assertThat(reloaded.auditing).isNull(); + }); + } + + /** * Usage looks like this: *

* {@code configure(MyRepository.class, MyConfiguration) .accept(repository -> { // perform tests on repository here * }); } * - * @param repositoryType the type of repository you want to perform tests on. + * @param repositoryType the type of repository you want to perform tests on. * @param configurationClasses the classes containing the configuration for the - * {@link org.springframework.context.ApplicationContext}. - * @param type of the entity managed by the repository. - * @param type of the repository. + * {@link org.springframework.context.ApplicationContext}. + * @param type of the entity managed by the repository. + * @param type of the repository. * @return a Consumer for repositories of type {@code R}. */ private > Consumer> configureRepositoryWith(Class repositoryType, - Class... configurationClasses) { + Class... configurationClasses) { return (Consumer test) -> { @@ -228,15 +305,21 @@ public class EnableJdbcAuditingHsqlIntegrationTests { } } - interface AuditingAnnotatedDummyEntityRepository extends CrudRepository {} + interface AuditingAnnotatedDummyEntityRepository extends CrudRepository { + } static class AuditingAnnotatedDummyEntity { - @Id long id; - @CreatedBy String createdBy; - @CreatedDate LocalDateTime createdDate; - @LastModifiedBy String lastModifiedBy; - @LastModifiedDate LocalDateTime lastModifiedDate; + @Id + long id; + @CreatedBy + String createdBy; + @CreatedDate + LocalDateTime createdDate; + @LastModifiedBy + String lastModifiedBy; + @LastModifiedDate + LocalDateTime lastModifiedDate; public long getId() { return this.id; @@ -279,11 +362,13 @@ public class EnableJdbcAuditingHsqlIntegrationTests { } } - interface DummyEntityRepository extends CrudRepository {} + interface DummyEntityRepository extends CrudRepository { + } static class DummyEntity { - @Id private Long id; + @Id + private Long id; // not actually used, exists just to avoid empty value list during insert. String name; @@ -319,6 +404,22 @@ public class EnableJdbcAuditingHsqlIntegrationTests { } } + record DummyEntityWithEmbeddedRecord( + @Id Long id, + @Embedded.Nullable EmbeddedAuditing auditing + ) { + } + + record EmbeddedAuditing( + @CreatedBy String createdBy, + @CreatedDate LocalDateTime createdDate, + @LastModifiedBy String lastModifiedBy, + @LastModifiedDate LocalDateTime lastModifiedDate + ) { + } + interface DummyEntityWithEmbeddedRecordRepository extends CrudRepository { + } + @Configuration @EnableJdbcRepositories(considerNestedRepositories = true) @Import(TestConfiguration.class) diff --git a/spring-data-relational/src/main/java/org/springframework/data/relational/core/mapping/EmbeddedRelationalPersistentProperty.java b/spring-data-relational/src/main/java/org/springframework/data/relational/core/mapping/EmbeddedRelationalPersistentProperty.java index 2bff29fec..99019b341 100644 --- a/spring-data-relational/src/main/java/org/springframework/data/relational/core/mapping/EmbeddedRelationalPersistentProperty.java +++ b/spring-data-relational/src/main/java/org/springframework/data/relational/core/mapping/EmbeddedRelationalPersistentProperty.java @@ -290,10 +290,16 @@ class EmbeddedRelationalPersistentProperty implements RelationalPersistentProper @Override public boolean equals(Object o) { - if (this == o) + + if (this == o) { + return true; + } + if (delegate == o) { return true; - if (o == null || getClass() != o.getClass()) + } + if (o == null || getClass() != o.getClass()) { return false; + } EmbeddedRelationalPersistentProperty that = (EmbeddedRelationalPersistentProperty) o; diff --git a/spring-data-relational/src/test/java/org/springframework/data/relational/core/mapping/EmbeddedRelationalPersistentPropertyUnitTests.java b/spring-data-relational/src/test/java/org/springframework/data/relational/core/mapping/EmbeddedRelationalPersistentPropertyUnitTests.java new file mode 100644 index 000000000..a948cac57 --- /dev/null +++ b/spring-data-relational/src/test/java/org/springframework/data/relational/core/mapping/EmbeddedRelationalPersistentPropertyUnitTests.java @@ -0,0 +1,44 @@ +/* + * Copyright 2024 the original author or authors. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.springframework.data.relational.core.mapping; + +import static org.mockito.Mockito.*; + +import org.assertj.core.api.SoftAssertions; +import org.junit.jupiter.api.Test; + +class EmbeddedRelationalPersistentPropertyUnitTests { + + @Test // GH-1694 + void testEquals() { + + RelationalPersistentProperty delegate = mock(RelationalPersistentProperty.class); + EmbeddedRelationalPersistentProperty embeddedProperty = new EmbeddedRelationalPersistentProperty(delegate, mock(EmbeddedContext.class)); + + RelationalPersistentProperty otherDelegate = mock(RelationalPersistentProperty.class); + EmbeddedRelationalPersistentProperty otherEmbeddedProperty = new EmbeddedRelationalPersistentProperty(otherDelegate, mock(EmbeddedContext.class)); + + SoftAssertions.assertSoftly(softly -> { + softly.assertThat(embeddedProperty).isEqualTo(embeddedProperty); + softly.assertThat(embeddedProperty).isEqualTo(delegate); + + softly.assertThat(embeddedProperty).isNotEqualTo(otherEmbeddedProperty); + softly.assertThat(embeddedProperty).isNotEqualTo(otherDelegate); + }); + } + +} \ No newline at end of file