From cca1f7a8cfda8dc3827dc16981a444f00de5dfe1 Mon Sep 17 00:00:00 2001
From: Christoph Strobl <cstrobl@pivotal.io>
Date: Mon, 6 Apr 2020 12:57:02 +0200
Subject: [PATCH] DATAREDIS-1106 - Remove expiration phantom key on delete via
 KeyValueAdapter.

Original pull request: #521.
---
 .../data/redis/core/RedisKeyValueAdapter.java |  8 +++++-
 .../data/redis/core/TimeToLiveAccessor.java   |  7 +++++
 .../core/mapping/RedisMappingContext.java     | 22 +++++++++++++---
 .../core/mapping/RedisPersistentEntity.java   |  7 +++++
 .../redis/core/RedisKeyValueAdapterTests.java | 26 +++++++++++++++++++
 5 files changed, 65 insertions(+), 5 deletions(-)

diff --git a/src/main/java/org/springframework/data/redis/core/RedisKeyValueAdapter.java b/src/main/java/org/springframework/data/redis/core/RedisKeyValueAdapter.java
index 35478fc1a..a6b084b5f 100644
--- a/src/main/java/org/springframework/data/redis/core/RedisKeyValueAdapter.java
+++ b/src/main/java/org/springframework/data/redis/core/RedisKeyValueAdapter.java
@@ -329,8 +329,14 @@ public class RedisKeyValueAdapter extends AbstractKeyValueAdapter
 
 				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;
 			});
 		}
diff --git a/src/main/java/org/springframework/data/redis/core/TimeToLiveAccessor.java b/src/main/java/org/springframework/data/redis/core/TimeToLiveAccessor.java
index 3bf240428..0241aa74a 100644
--- a/src/main/java/org/springframework/data/redis/core/TimeToLiveAccessor.java
+++ b/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);
 }
diff --git a/src/main/java/org/springframework/data/redis/core/mapping/RedisMappingContext.java b/src/main/java/org/springframework/data/redis/core/mapping/RedisMappingContext.java
index 52c5c4f01..df34db1f1 100644
--- a/src/main/java/org/springframework/data/redis/core/mapping/RedisMappingContext.java
+++ b/src/main/java/org/springframework/data/redis/core/mapping/RedisMappingContext.java
@@ -206,10 +206,6 @@ public class RedisMappingContext extends KeyValueMappingContext<RedisPersistentE
 			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 class RedisMappingContext extends KeyValueMappingContext<RedisPersistentE
 			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)) {
diff --git a/src/main/java/org/springframework/data/redis/core/mapping/RedisPersistentEntity.java b/src/main/java/org/springframework/data/redis/core/mapping/RedisPersistentEntity.java
index 01063f6d3..eb43f2655 100644
--- a/src/main/java/org/springframework/data/redis/core/mapping/RedisPersistentEntity.java
+++ b/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());
+	}
 }
diff --git a/src/test/java/org/springframework/data/redis/core/RedisKeyValueAdapterTests.java b/src/test/java/org/springframework/data/redis/core/RedisKeyValueAdapterTests.java
index 1eadde479..f140fd35c 100644
--- a/src/test/java/org/springframework/data/redis/core/RedisKeyValueAdapterTests.java
+++ b/src/test/java/org/springframework/data/redis/core/RedisKeyValueAdapterTests.java
@@ -297,6 +297,24 @@ public class RedisKeyValueAdapterTests {
 		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 @@ public class RedisKeyValueAdapterTests {
 		String name;
 	}
 
+	@KeySpace("withexpiration")
+	@RedisHash(timeToLive = 30)
+	static class WithExpiration {
+
+		@Id String id;
+		String value;
+	}
+
 }