DATAREDIS-1106 - Remove expiration phantom key on delete via KeyValueAdapter.

Original pull request: spring-projects#521.

Author: christophstrobl

src/main/java/org/springframework/data/redis/core/RedisKeyValueAdapter.java

@@ -329,8 +329,14 @@ public <T> T delete(Object id, String keyspace, Class<T> type) {
 
 connection.del(keyToDelete);
 connection.sRem(binKeyspace, binId);
-
 new IndexWriter(connection, converter).removeKeyFromIndexes(asString(keyspace), binId);
+
+RedisPersistentEntity<?> persistentEntity = converter.getMappingContext().getPersistentEntity(type);
+if (persistentEntity != null && persistentEntity.isExpiring()) {
+
+byte[] phantomKey = ByteUtils.concat(keyToDelete, BinaryKeyspaceIdentifier.PHANTOM_SUFFIX);
+connection.del(phantomKey);
+}
 return null;
 });
 }

src/main/java/org/springframework/data/redis/core/TimeToLiveAccessor.java

@@ -31,4 +31,11 @@ public interface TimeToLiveAccessor {
  */
 @Nullable
 Long getTimeToLive(Object source);
+
+/**
+ * @param type must not be {@literal null}.
+ * @return return {@literal true} if the entity could potentially expire.
+ * @since ? (depends on backport)
+ */
+boolean isExpiringEntity(Class<?> type);
 }

src/main/java/org/springframework/data/redis/core/mapping/RedisMappingContext.java

@@ -206,10 +206,6 @@ static class ConfigAwareTimeToLiveAccessor implements TimeToLiveAccessor {
 this.mappingContext = mappingContext;
 }
 
-/*
- * (non-Javadoc)
- * @see org.springframework.data.redis.core.TimeToLiveResolver#resolveTimeToLive(java.lang.Object)
- */
 @Override
 @SuppressWarnings({ "rawtypes" })
 public Long getTimeToLive(final Object source) {
@@ -283,6 +279,24 @@ public Long getTimeToLive(final Object source) {
 return defaultTimeout;
 }
 
+/*
+ * (non-Javadoc)
+ * @see org.springframework.data.redis.core.TimeToLiveResolver#isExpiringEntity(java.lang.Class)
+ */
+@Override
+public boolean isExpiringEntity(Class<?> type) {
+
+Long defaultTimeOut = resolveDefaultTimeOut(type);
+
+if (defaultTimeOut != null && defaultTimeOut > 0) {
+return true;
+}
+if (resolveTtlProperty(type) != null) {
+return true;
+}
+return resolveTimeMethod(type) != null;
+}
+
 private Long resolveDefaultTimeOut(Class<?> type) {
 
 if (this.defaultTimeouts.containsKey(type)) {

src/main/java/org/springframework/data/redis/core/mapping/RedisPersistentEntity.java

@@ -52,4 +52,11 @@ public interface RedisPersistentEntity<T> extends KeyValuePersistentEntity<T, Re
 @Nullable
 RedisPersistentProperty getExplicitTimeToLiveProperty();
 
+/**
+ * @return {@literal true} if the entity could potentially expire.
+ * @since ? (depends on backport)
+ */
+default boolean isExpiring() {
+return getTimeToLiveAccessor().isExpiringEntity(getType());
+}
 }

src/test/java/org/springframework/data/redis/core/RedisKeyValueAdapterTests.java

@@ -297,6 +297,24 @@ public void deleteCleansIndexedDataCorrectly() {
 assertThat(template.opsForSet().members("persons:firstname:rand")).doesNotContain("1");
 }
 
+@Test // DATAREDIS-1106
+public void deleteRemovesExpireHelperStructures() {
+
+WithExpiration source = new WithExpiration();
+source.id = "1";
+source.value = "vale";
+
+adapter.put("1", source, "withexpiration");
+
+assertThat(template.hasKey("withexpiration:1")).isTrue();
+assertThat(template.hasKey("withexpiration:1:phantom")).isTrue();
+
+adapter.delete("1", "withexpiration", WithExpiration.class);
+
+assertThat(template.hasKey("withexpiration:1")).isFalse();
+assertThat(template.hasKey("withexpiration:1:phantom")).isFalse();
+}
+
 @Test // DATAREDIS-425
 public void keyExpiredEventShouldRemoveHelperStructures() throws Exception {
 
@@ -765,4 +783,12 @@ static class Location {
 String name;
 }
 
+@KeySpace("withexpiration")
+@RedisHash(timeToLive = 30)
+static class WithExpiration {
+
+@Id String id;
+String value;
+}
+
 }