Refactor the soft delete design

CHANGES.md

@@ -45,6 +45,6 @@ Apollo 2.0.0
 * [optimize import/export config](https://github.com/apolloconfig/apollo/pull/4231)
 * [Configure publish and rollback modal boxes to add scrollbars](https://github.com/apolloconfig/apollo/pull/4251)
 * [fix import config bug](https://github.com/apolloconfig/apollo/pull/4262)
-
+* [Refactor the soft delete design](https://github.com/apolloconfig/apollo/pull/3866)
 ------------------
 All issues and pull requests are [here](https://github.com/ctripcorp/apollo/milestone/8?closed=1)

apollo-adminservice/src/main/resources/application.yml

@@ -23,6 +23,10 @@ spring:
       enabled: false
     zookeeper:
       enabled: false
+  jpa:
+    properties:
+      hibernate:
+        metadata_builder_contributor: com.ctrip.framework.apollo.common.jpa.SqlFunctionsMetadataBuilderContributor
 
 ctrip:
   appid: 100003172

apollo-adminservice/src/test/resources/application.properties

@@ -16,6 +16,7 @@
 spring.datasource.url = jdbc:h2:mem:~/apolloconfigdb;mode=mysql;DB_CLOSE_ON_EXIT=FALSE;DB_CLOSE_DELAY=-1
 spring.jpa.hibernate.naming.physical-strategy=org.hibernate.boot.model.naming.PhysicalNamingStrategyStandardImpl
 spring.jpa.properties.hibernate.show_sql=false
+spring.jpa.properties.hibernate.metadata_builder_contributor=com.ctrip.framework.apollo.common.jpa.SqlFunctionsMetadataBuilderContributor
 spring.h2.console.enabled = true
 spring.h2.console.settings.web-allow-others=true
 spring.main.allow-bean-definition-overriding=true

apollo-adminservice/src/test/resources/import.sql

@@ -0,0 +1,16 @@
+--
+-- Copyright 2021 Apollo 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
+--
+-- http://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.
+--
+CREATE ALIAS IF NOT EXISTS UNIX_TIMESTAMP FOR "com.ctrip.framework.apollo.common.jpa.H2Function.unixTimestamp";

apollo-assembly/src/main/resources/application.yml

@@ -23,6 +23,10 @@ spring:
       enabled: false
   session:
     store-type: none
+  jpa:
+    properties:
+      hibernate:
+        metadata_builder_contributor: com.ctrip.framework.apollo.common.jpa.SqlFunctionsMetadataBuilderContributor
 
 logging:
   file:

apollo-assembly/src/test/resources/application.properties

@@ -16,6 +16,7 @@
 spring.datasource.url = jdbc:h2:mem:~/apolloconfigdb;mode=mysql;DB_CLOSE_ON_EXIT=FALSE
 spring.jpa.hibernate.naming.physical-strategy=org.hibernate.boot.model.naming.PhysicalNamingStrategyStandardImpl
 spring.jpa.properties.hibernate.show_sql=false
+spring.jpa.properties.hibernate.metadata_builder_contributor=com.ctrip.framework.apollo.common.jpa.SqlFunctionsMetadataBuilderContributor
 spring.h2.console.enabled = true
 spring.h2.console.settings.web-allow-others=true
 apollo.portal.env= local

apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/entity/AccessKey.java

@@ -26,7 +26,7 @@
 
 @Entity
 @Table(name = "AccessKey")
-@SQLDelete(sql = "Update AccessKey set isDeleted = 1 where id = ?")
+@SQLDelete(sql = "Update AccessKey set IsDeleted = 1, DeletedAt = ROUND(UNIX_TIMESTAMP(NOW(4))*1000) where Id = ?")
 @Where(clause = "isDeleted = 0")
 public class AccessKey extends BaseEntity {
 

apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/entity/Audit.java

@@ -27,7 +27,7 @@
 
 @Entity
 @Table(name = "Audit")
-@SQLDelete(sql = "Update Audit set isDeleted = 1 where id = ?")
+@SQLDelete(sql = "Update Audit set IsDeleted = 1, DeletedAt = ROUND(UNIX_TIMESTAMP(NOW(4))*1000) where Id = ?")
 @Where(clause = "isDeleted = 0")
 public class Audit extends BaseEntity {
 

apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/entity/Cluster.java

@@ -30,7 +30,7 @@
  */
 @Entity
 @Table(name = "Cluster")
-@SQLDelete(sql = "Update Cluster set isDeleted = 1 where id = ?")
+@SQLDelete(sql = "Update Cluster set IsDeleted = 1, DeletedAt = ROUND(UNIX_TIMESTAMP(NOW(4))*1000) where Id = ?")
 @Where(clause = "isDeleted = 0")
 public class Cluster extends BaseEntity implements Comparable<Cluster> {
 

apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/entity/Commit.java

@@ -28,7 +28,7 @@
 
 @Entity
 @Table(name = "Commit")
-@SQLDelete(sql = "Update Commit set isDeleted = 1 where id = ?")
+@SQLDelete(sql = "Update Commit set IsDeleted = 1, DeletedAt = ROUND(UNIX_TIMESTAMP(NOW(4))*1000) where Id = ?")
 @Where(clause = "isDeleted = 0")
 public class Commit extends BaseEntity {
 

apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/entity/GrayReleaseRule.java

@@ -27,7 +27,7 @@
 
 @Entity
 @Table(name = "GrayReleaseRule")
-@SQLDelete(sql = "Update GrayReleaseRule set isDeleted = 1 where id = ?")
+@SQLDelete(sql = "Update GrayReleaseRule set IsDeleted = 1, DeletedAt = ROUND(UNIX_TIMESTAMP(NOW(4))*1000) where Id = ?")
 @Where(clause = "isDeleted = 0")
 public class GrayReleaseRule extends BaseEntity{
 

apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/entity/Item.java

@@ -28,7 +28,7 @@
 
 @Entity
 @Table(name = "Item")
-@SQLDelete(sql = "Update Item set isDeleted = 1 where id = ?")
+@SQLDelete(sql = "Update Item set IsDeleted = 1, DeletedAt = ROUND(UNIX_TIMESTAMP(NOW(4))*1000) where Id = ?")
 @Where(clause = "isDeleted = 0")
 public class Item extends BaseEntity {
 

apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/entity/Namespace.java

@@ -27,7 +27,7 @@
 
 @Entity
 @Table(name = "Namespace")
-@SQLDelete(sql = "Update Namespace set isDeleted = 1 where id = ?")
+@SQLDelete(sql = "Update Namespace set IsDeleted = 1, DeletedAt = ROUND(UNIX_TIMESTAMP(NOW(4))*1000) where Id = ?")
 @Where(clause = "isDeleted = 0")
 public class Namespace extends BaseEntity {
 

apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/entity/Privilege.java

@@ -27,7 +27,7 @@
 
 @Entity
 @Table(name = "Privilege")
-@SQLDelete(sql = "Update Privilege set isDeleted = 1 where id = ?")
+@SQLDelete(sql = "Update Privilege set IsDeleted = 1, DeletedAt = ROUND(UNIX_TIMESTAMP(NOW(4))*1000) where Id = ?")
 @Where(clause = "isDeleted = 0")
 public class Privilege extends BaseEntity {
 

apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/entity/Release.java

@@ -31,7 +31,7 @@
  */
 @Entity
 @Table(name = "Release")
-@SQLDelete(sql = "Update Release set isDeleted = 1 where id = ?")
+@SQLDelete(sql = "Update Release set IsDeleted = 1, DeletedAt = ROUND(UNIX_TIMESTAMP(NOW(4))*1000) where Id = ?")
 @Where(clause = "isDeleted = 0")
 public class Release extends BaseEntity {
   @Column(name = "ReleaseKey", nullable = false)

apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/entity/ReleaseHistory.java

@@ -30,7 +30,7 @@
  */
 @Entity
 @Table(name = "ReleaseHistory")
-@SQLDelete(sql = "Update ReleaseHistory set isDeleted = 1 where id = ?")
+@SQLDelete(sql = "Update ReleaseHistory set IsDeleted = 1, DeletedAt = ROUND(UNIX_TIMESTAMP(NOW(4))*1000) where Id = ?")
 @Where(clause = "isDeleted = 0")
 public class ReleaseHistory extends BaseEntity {
   @Column(name = "AppId", nullable = false)

apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/entity/ServerConfig.java

@@ -30,7 +30,7 @@
  */
 @Entity
 @Table(name = "ServerConfig")
-@SQLDelete(sql = "Update ServerConfig set isDeleted = 1 where id = ?")
+@SQLDelete(sql = "Update ServerConfig set IsDeleted = 1, DeletedAt = ROUND(UNIX_TIMESTAMP(NOW(4))*1000) where Id = ?")
 @Where(clause = "isDeleted = 0")
 public class ServerConfig extends BaseEntity {
   @Column(name = "Key", nullable = false)

apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/repository/AppNamespaceRepository.java

@@ -43,10 +43,10 @@ public interface AppNamespaceRepository extends PagingAndSortingRepository<AppNa
   List<AppNamespace> findFirst500ByIdGreaterThanOrderByIdAsc(long id);
 
   @Modifying
-  @Query("UPDATE AppNamespace SET IsDeleted=1,DataChange_LastModifiedBy = ?2 WHERE AppId=?1")
+  @Query("UPDATE AppNamespace SET IsDeleted = 1, DeletedAt = ROUND(UNIX_TIMESTAMP(NOW(4))*1000), DataChange_LastModifiedBy = ?2 WHERE AppId=?1")
   int batchDeleteByAppId(String appId, String operator);
 
   @Modifying
-  @Query("UPDATE AppNamespace SET IsDeleted=1,DataChange_LastModifiedBy = ?3 WHERE AppId=?1 and Name = ?2")
+  @Query("UPDATE AppNamespace SET IsDeleted = 1, DeletedAt = ROUND(UNIX_TIMESTAMP(NOW(4))*1000), DataChange_LastModifiedBy = ?3 WHERE AppId=?1 and Name = ?2")
   int delete(String appId, String namespaceName, String operator);
 }

apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/repository/CommitRepository.java

@@ -35,7 +35,7 @@ List<Commit> findByAppIdAndClusterNameAndNamespaceNameAndDataChangeLastModifiedT
       String appId, String clusterName, String namespaceName, Date dataChangeLastModifiedTime, Pageable pageable);
 
   @Modifying
-  @Query("update Commit set isdeleted=1,DataChange_LastModifiedBy = ?4 where appId=?1 and clusterName=?2 and namespaceName = ?3")
+  @Query("update Commit set IsDeleted = 1, DeletedAt = ROUND(UNIX_TIMESTAMP(NOW(4))*1000), DataChange_LastModifiedBy = ?4 where appId=?1 and clusterName=?2 and namespaceName = ?3")
   int batchDelete(String appId, String clusterName, String namespaceName, String operator);
 
   List<Commit> findByAppIdAndClusterNameAndNamespaceNameAndChangeSetsLikeOrderByIdDesc(String appId, String clusterName, String namespaceName,String changeSets, Pageable page);

apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/repository/ItemRepository.java

@@ -42,7 +42,7 @@ public interface ItemRepository extends PagingAndSortingRepository<Item, Long> {
   Item findFirst1ByNamespaceIdOrderByLineNumDesc(Long namespaceId);
 
   @Modifying
-  @Query("update Item set isdeleted=1,DataChange_LastModifiedBy = ?2 where namespaceId = ?1")
+  @Query("update Item set IsDeleted = 1, DeletedAt = ROUND(UNIX_TIMESTAMP(NOW(4))*1000), DataChange_LastModifiedBy = ?2 where namespaceId = ?1")
   int deleteByNamespaceId(long namespaceId, String operator);
 
 }

apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/repository/NamespaceRepository.java

@@ -33,7 +33,7 @@ public interface NamespaceRepository extends PagingAndSortingRepository<Namespac
   Namespace findByAppIdAndClusterNameAndNamespaceName(String appId, String clusterName, String namespaceName);
 
   @Modifying
-  @Query("update Namespace set isdeleted=1,DataChange_LastModifiedBy = ?3 where appId=?1 and clusterName=?2")
+  @Query("update Namespace set IsDeleted = 1, DeletedAt = ROUND(UNIX_TIMESTAMP(NOW(4))*1000), DataChange_LastModifiedBy = ?3 where appId=?1 and clusterName=?2")
   int batchDelete(String appId, String clusterName, String operator);
 
   List<Namespace> findByAppIdAndNamespaceNameOrderByIdAsc(String appId, String namespaceName);

apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/repository/ReleaseHistoryRepository.java

@@ -39,7 +39,7 @@ Page<ReleaseHistory> findByAppIdAndClusterNameAndNamespaceNameOrderByIdDesc(Stri
   Page<ReleaseHistory> findByReleaseIdAndOperationInOrderByIdDesc(long releaseId, Set<Integer> operations, Pageable pageable);
 
   @Modifying
-  @Query("update ReleaseHistory set isdeleted=1,DataChange_LastModifiedBy = ?4 where appId=?1 and clusterName=?2 and namespaceName = ?3")
+  @Query("update ReleaseHistory set IsDeleted = 1, DeletedAt = ROUND(UNIX_TIMESTAMP(NOW(4))*1000), DataChange_LastModifiedBy = ?4 where appId=?1 and clusterName=?2 and namespaceName = ?3")
   int batchDelete(String appId, String clusterName, String namespaceName, String operator);
 
 }

apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/repository/ReleaseRepository.java

@@ -48,7 +48,7 @@ Release findFirstByAppIdAndClusterNameAndNamespaceNameAndIsAbandonedFalseOrderBy
   List<Release> findByIdIn(Set<Long> releaseIds);
 
   @Modifying
-  @Query("update Release set isdeleted=1,DataChange_LastModifiedBy = ?4 where appId=?1 and clusterName=?2 and namespaceName = ?3")
+  @Query("update Release set IsDeleted = 1, DeletedAt = ROUND(UNIX_TIMESTAMP(NOW(4))*1000), DataChange_LastModifiedBy = ?4 where appId=?1 and clusterName=?2 and namespaceName = ?3")
   int batchDelete(String appId, String clusterName, String namespaceName, String operator);
 
   // For release history conversion program, need to delete after conversion it done

apollo-biz/src/test/resources/application.properties

@@ -16,6 +16,7 @@
 spring.datasource.url = jdbc:h2:mem:~/apolloconfigdb;mode=mysql;DB_CLOSE_ON_EXIT=FALSE
 spring.jpa.hibernate.naming.physical-strategy=org.hibernate.boot.model.naming.PhysicalNamingStrategyStandardImpl
 spring.jpa.properties.hibernate.show_sql=false
+spring.jpa.properties.hibernate.metadata_builder_contributor=com.ctrip.framework.apollo.common.jpa.SqlFunctionsMetadataBuilderContributor
 spring.h2.console.enabled = true
 spring.h2.console.settings.web-allow-others=true
 spring.cloud.consul.enabled=false

apollo-biz/src/test/resources/import.sql

@@ -0,0 +1,16 @@
+--
+-- Copyright 2021 Apollo 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
+--
+-- http://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.
+--
+CREATE ALIAS IF NOT EXISTS UNIX_TIMESTAMP FOR "com.ctrip.framework.apollo.common.jpa.H2Function.unixTimestamp";

apollo-common/src/main/java/com/ctrip/framework/apollo/common/entity/App.java

@@ -28,7 +28,7 @@
 
 @Entity
 @Table(name = "App")
-@SQLDelete(sql = "Update App set isDeleted = 1 where id = ?")
+@SQLDelete(sql = "Update App set IsDeleted = 1, DeletedAt = ROUND(UNIX_TIMESTAMP(NOW(4))*1000) where Id = ?")
 @Where(clause = "isDeleted = 0")
 public class App extends BaseEntity {
 

apollo-common/src/main/java/com/ctrip/framework/apollo/common/entity/AppNamespace.java

@@ -31,7 +31,7 @@
 
 @Entity
 @Table(name = "AppNamespace")
-@SQLDelete(sql = "Update AppNamespace set isDeleted = 1 where id = ?")
+@SQLDelete(sql = "Update AppNamespace set IsDeleted = 1, DeletedAt = ROUND(UNIX_TIMESTAMP(NOW(4))*1000) where Id = ?")
 @Where(clause = "isDeleted = 0")
 public class AppNamespace extends BaseEntity {
 

apollo-common/src/main/java/com/ctrip/framework/apollo/common/entity/BaseEntity.java

@@ -19,6 +19,7 @@
 import com.google.common.base.MoreObjects;
 import com.google.common.base.MoreObjects.ToStringHelper;
 
+import java.time.Instant;
 import java.util.Date;
 
 import javax.persistence.Column;
@@ -44,6 +45,9 @@ public abstract class BaseEntity {
   @Column(name = "IsDeleted", columnDefinition = "Bit default '0'")
   protected boolean isDeleted = false;
 
+  @Column(name = "DeletedAt", columnDefinition = "Bigint default '0'")
+  protected long deletedAt;
+
   @Column(name = "DataChange_CreatedBy", nullable = false)
   private String dataChangeCreatedBy;
 
@@ -56,52 +60,62 @@ public abstract class BaseEntity {
   @Column(name = "DataChange_LastTime")
   private Date dataChangeLastModifiedTime;
 
-  public String getDataChangeCreatedBy() {
-    return dataChangeCreatedBy;
+  public long getId() {
+    return id;
   }
 
-  public Date getDataChangeCreatedTime() {
-    return dataChangeCreatedTime;
+  public void setId(long id) {
+    this.id = id;
   }
 
-  public String getDataChangeLastModifiedBy() {
-    return dataChangeLastModifiedBy;
+  public boolean isDeleted() {
+    return isDeleted;
   }
 
-  public Date getDataChangeLastModifiedTime() {
-    return dataChangeLastModifiedTime;
+  public void setDeleted(boolean deleted) {
+    isDeleted = deleted;
+    // also set deletedAt value as epoch millisecond
+    this.deletedAt = System.currentTimeMillis();
   }
 
-  public long getId() {
-    return id;
+  public long getDeletedAt() {
+    return deletedAt;
   }
 
-  public boolean isDeleted() {
-    return isDeleted;
+  public void setDeletedAt(long deletedAt) {
+    this.deletedAt = deletedAt;
+  }
+
+  public String getDataChangeCreatedBy() {
+    return dataChangeCreatedBy;
   }
 
   public void setDataChangeCreatedBy(String dataChangeCreatedBy) {
     this.dataChangeCreatedBy = dataChangeCreatedBy;
   }
 
+  public Date getDataChangeCreatedTime() {
+    return dataChangeCreatedTime;
+  }
+
   public void setDataChangeCreatedTime(Date dataChangeCreatedTime) {
     this.dataChangeCreatedTime = dataChangeCreatedTime;
   }
 
-  public void setDataChangeLastModifiedBy(String dataChangeLastModifiedBy) {
-    this.dataChangeLastModifiedBy = dataChangeLastModifiedBy;
+  public String getDataChangeLastModifiedBy() {
+    return dataChangeLastModifiedBy;
   }
 
-  public void setDataChangeLastModifiedTime(Date dataChangeLastModifiedTime) {
-    this.dataChangeLastModifiedTime = dataChangeLastModifiedTime;
+  public void setDataChangeLastModifiedBy(String dataChangeLastModifiedBy) {
+    this.dataChangeLastModifiedBy = dataChangeLastModifiedBy;
   }
 
-  public void setDeleted(boolean deleted) {
-    isDeleted = deleted;
+  public Date getDataChangeLastModifiedTime() {
+    return dataChangeLastModifiedTime;
   }
 
-  public void setId(long id) {
-    this.id = id;
+  public void setDataChangeLastModifiedTime(Date dataChangeLastModifiedTime) {
+    this.dataChangeLastModifiedTime = dataChangeLastModifiedTime;
   }
 
   @PrePersist

apollo-common/src/main/java/com/ctrip/framework/apollo/common/jpa/H2Function.java

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2021 Apollo 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
+ *
+ * http://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 com.ctrip.framework.apollo.common.jpa;
+
+/**
+ * @author nisiyong
+ */
+public class H2Function {
+
+  public static long unixTimestamp(java.sql.Timestamp timestamp) {
+    return timestamp.getTime() / 1000L;
+  }
+}