Merge pull request #2213 from ebean-orm/feature/transparentPersistence

Initial experimental support for autoPersistUpdates / "transparent persistence"

ebean-core/src/main/java/io/ebeaninternal/api/SpiTransaction.java

@@ -147,6 +147,11 @@ public interface SpiTransaction extends Transaction {
    */
   int depth();
 
+  /**
+   * Return true if dirty beans are automatically persisted.
+   */
+  boolean isAutoPersistUpdates();
+
   /**
    * Return true if this transaction was created explicitly via
    * <code>Ebean.beginTransaction()</code>.

ebean-core/src/main/java/io/ebeaninternal/api/SpiTransactionProxy.java

@@ -43,6 +43,16 @@ public abstract class SpiTransactionProxy implements SpiTransaction {
     return transaction.getLabel();
   }
 
+  @Override
+  public void setAutoPersistUpdates(boolean autoPersistUpdates) {
+    transaction.setAutoPersistUpdates(autoPersistUpdates);
+  }
+
+  @Override
+  public boolean isAutoPersistUpdates() {
+    return transaction.isAutoPersistUpdates();
+  }
+
   @Override
   public void commitAndContinue() {
     transaction.commitAndContinue();

ebean-core/src/main/java/io/ebeaninternal/server/core/DefaultServer.java

@@ -236,7 +236,7 @@ public final class DefaultServer implements SpiServer, SpiEbeanServer {
     this.clockService = config.getClockService();
 
     DocStoreIntegration docStoreComponents = config.createDocStoreIntegration(this);
-    this.transactionManager = config.createTransactionManager(docStoreComponents.updateProcessor());
+    this.transactionManager = config.createTransactionManager(this, docStoreComponents.updateProcessor());
     this.documentStore = docStoreComponents.documentStore();
     this.queryPlanManager = config.initQueryPlanManager(transactionManager);
     this.metaInfoManager = new DefaultMetaInfoManager(this);

ebean-core/src/main/java/io/ebeaninternal/server/core/InternalConfiguration.java

@@ -423,13 +423,13 @@ public class InternalConfiguration {
   /**
    * Create the TransactionManager taking into account autoCommit mode.
    */
-  TransactionManager createTransactionManager(DocStoreUpdateProcessor indexUpdateProcessor) {
+  TransactionManager createTransactionManager(SpiServer server, DocStoreUpdateProcessor indexUpdateProcessor) {
 
     TransactionScopeManager scopeManager = createTransactionScopeManager();
     boolean notifyL2CacheInForeground = cacheManager.isLocalL2Caching() || config.isNotifyL2CacheInForeground();
 
     TransactionManagerOptions options =
-      new TransactionManagerOptions(notifyL2CacheInForeground, config, scopeManager, clusterManager, backgroundExecutor,
+      new TransactionManagerOptions(server, notifyL2CacheInForeground, config, scopeManager, clusterManager, backgroundExecutor,
         indexUpdateProcessor, beanDescriptorManager, dataSource(), profileHandler(), logManager,
         tableModState, cacheNotify, clockService);
 

ebean-core/src/main/java/io/ebeaninternal/server/core/PersistRequestBean.java

@@ -887,6 +887,14 @@ public final class PersistRequestBean<T> extends PersistRequest implements BeanP
     }
   }
 
+  /**
+   * Remove deleted beans from the persistence context early.
+   */
+  public void removeFromPersistenceContext() {
+    idValue = beanDescriptor.getId(entityBean);
+    beanDescriptor.contextDeleted(transaction.getPersistenceContext(), idValue);
+  }
+
   /**
    * Aggressive L1 and L2 cache cleanup for deletes.
    */
@@ -1030,6 +1038,10 @@ public final class PersistRequestBean<T> extends PersistRequest implements BeanP
     if (!publish) {
       beanDescriptor.setDraft(entityBean);
     }
+    if (transaction.isAutoPersistUpdates() && idValue != null) {
+      // with getGeneratedKeys off we will not have a idValue
+      beanDescriptor.contextPut(transaction.getPersistenceContext(), idValue, entityBean);
+    }
   }
 
   /**

ebean-core/src/main/java/io/ebeaninternal/server/persist/DefaultPersister.java

@@ -881,6 +881,7 @@ public final class DefaultPersister implements Persister {
     }
 
     int count = request.executeOrQueue();
+    request.removeFromPersistenceContext();
 
     if (request.isPersistCascade()) {
       deleteAssocOne(request);

ebean-core/src/main/java/io/ebeaninternal/server/transaction/DefaultPersistenceContext.java

@@ -1,11 +1,9 @@
 package io.ebeaninternal.server.transaction;
 
+import io.ebean.bean.EntityBean;
 import io.ebean.bean.PersistenceContext;
 
-import java.util.HashMap;
-import java.util.HashSet;
-import java.util.Map;
-import java.util.Set;
+import java.util.*;
 import java.util.concurrent.locks.ReentrantLock;
 
 /**
@@ -200,6 +198,20 @@ public final class DefaultPersistenceContext implements PersistenceContext {
     }
   }
 
+  @Override
+  public List<Object> dirtyBeans() {
+    lock.lock();
+    try {
+      List<Object> list = new ArrayList<>();
+      for (ClassContext classContext : typeCache.values()) {
+        classContext.dirtyBeans(list);
+      }
+      return list;
+    } finally {
+      lock.unlock();
+    }
+  }
+
   @Override
   public String toString() {
     lock.lock();
@@ -318,6 +330,17 @@ public final class DefaultPersistenceContext implements PersistenceContext {
       deleteSet.add(id);
       map.remove(id);
     }
+
+    /**
+     * Add the dirty beans to the list.
+     */
+    void dirtyBeans(List<Object> list) {
+      for (Object value : map.values()) {
+        if (((EntityBean) value)._ebean_getIntercept().isDirty()) {
+          list.add(value);
+        }
+      }
+    }
   }
 
 }

ebean-core/src/main/java/io/ebeaninternal/server/transaction/ImplicitReadOnlyTransaction.java

@@ -95,6 +95,16 @@ class ImplicitReadOnlyTransaction implements SpiTransaction, TxnProfileEventCode
     return startNanos;
   }
 
+  @Override
+  public void setAutoPersistUpdates(boolean autoPersistUpdates) {
+    // do nothing
+  }
+
+  @Override
+  public boolean isAutoPersistUpdates() {
+    return false;
+  }
+
   @Override
   public void setLabel(String label) {
     // do nothing

ebean-core/src/main/java/io/ebeaninternal/server/transaction/JdbcTransaction.java

@@ -187,6 +187,8 @@ class JdbcTransaction implements SpiTransaction, TxnProfileEventCodes {
 
   private final long startNanos;
 
+  private boolean autoPersistUpdates;
+
   /**
    * Create a new JdbcTransaction.
    */
@@ -209,11 +211,12 @@ class JdbcTransaction implements SpiTransaction, TxnProfileEventCodes {
         this.batchOnCascadeMode = false;
         this.onQueryOnly = OnQueryOnly.ROLLBACK;
       } else {
+        this.autoPersistUpdates = explicit && manager.isAutoPersistUpdates();
         this.logSql = manager.isLogSql();
         this.logSummary = manager.isLogSummary();
         this.skipCacheAfterWrite = manager.isSkipCacheAfterWrite();
-        this.batchMode = manager.getPersistBatch();
-        this.batchOnCascadeMode = manager.getPersistBatchOnCascade();
+        this.batchMode = manager.isPersistBatch();
+        this.batchOnCascadeMode = manager.isPersistBatchOnCascade();
         this.onQueryOnly = manager.getOnQueryOnly();
       }
 
@@ -294,6 +297,17 @@ class JdbcTransaction implements SpiTransaction, TxnProfileEventCodes {
     return sb.toString();
   }
 
+  @Override
+  public void setAutoPersistUpdates(boolean autoPersistUpdates) {
+    this.autoPersistUpdates = autoPersistUpdates;
+    this.batchMode = true;
+  }
+
+  @Override
+  public boolean isAutoPersistUpdates() {
+    return autoPersistUpdates;
+  }
+
   @Override
   public boolean isSkipCacheExplicit() {
     return (skipCache != null && !skipCache);
@@ -774,6 +788,10 @@ class JdbcTransaction implements SpiTransaction, TxnProfileEventCodes {
    * Flush the JDBC batch and execute derived relationship statements if necessary.
    */
   private void internalBatchFlush() {
+    if (autoPersistUpdates) {
+      // Experimental - flush dirty beans held by the persistence context
+      manager.flushTransparent(persistenceContext, this);
+    }
     batchFlush();
     if (deferredList != null) {
       for (PersistDeferredRelationship deferred : deferredList) {
@@ -1042,7 +1060,7 @@ class JdbcTransaction implements SpiTransaction, TxnProfileEventCodes {
       throw new IllegalStateException(illegalStateMessage);
     }
     try {
-      if (queryOnly) {
+      if (queryOnly && !autoPersistUpdates) {
         connectionEndForQueryOnly();
       } else {
         flushCommitAndNotify();

ebean-core/src/main/java/io/ebeaninternal/server/transaction/NoTransaction.java

@@ -25,6 +25,16 @@ class NoTransaction implements SpiTransaction {
 
   static final NoTransaction INSTANCE = new NoTransaction();
 
+  @Override
+  public void setAutoPersistUpdates(boolean autoPersistUpdates) {
+    // do nothing
+  }
+
+  @Override
+  public boolean isAutoPersistUpdates() {
+    return false;
+  }
+
   @Override
   public void setLabel(String label) {
     // do nothing

ebean-core/src/main/java/io/ebeaninternal/server/transaction/TransactionManager.java

@@ -5,6 +5,7 @@ import io.ebean.ProfileLocation;
 import io.ebean.TxScope;
 import io.ebean.annotation.PersistBatch;
 import io.ebean.annotation.TxType;
+import io.ebean.bean.PersistenceContext;
 import io.ebean.cache.ServerCacheNotification;
 import io.ebean.cache.ServerCacheNotify;
 import io.ebean.config.CurrentTenantProvider;
@@ -17,6 +18,7 @@ import io.ebean.meta.MetricVisitor;
 import io.ebean.metric.MetricFactory;
 import io.ebean.metric.TimedMetric;
 import io.ebean.metric.TimedMetricMap;
+import io.ebean.plugin.SpiServer;
 import io.ebeaninternal.api.ScopeTrans;
 import io.ebeaninternal.api.ScopedTransaction;
 import io.ebeaninternal.api.SpiLogManager;
@@ -59,6 +61,8 @@ public class TransactionManager implements SpiTransactionManager {
 
   private static final Logger clusterLogger = LoggerFactory.getLogger("io.ebean.Cluster");
 
+  private final SpiServer server;
+
   private final BeanDescriptorManager beanDescriptorManager;
 
   /**
@@ -100,6 +104,8 @@ public class TransactionManager implements SpiTransactionManager {
    */
   final DocStoreUpdateProcessor docStoreUpdateProcessor;
 
+  private final boolean autoPersistUpdates;
+
   private final boolean persistBatch;
 
   private final boolean persistBatchOnCascade;
@@ -153,7 +159,7 @@ public class TransactionManager implements SpiTransactionManager {
    * Create the TransactionManager
    */
   public TransactionManager(TransactionManagerOptions options) {
-
+    this.server = options.server;
     this.logManager = options.logManager;
     this.txnLogger = logManager.txn();
     this.txnDebug = txnLogger.isDebug();
@@ -161,6 +167,7 @@ public class TransactionManager implements SpiTransactionManager {
     this.supportsSavepointId = databasePlatform.isSupportsSavepointId();
     this.skipCacheAfterWrite = options.config.isSkipCacheAfterWrite();
     this.notifyL2CacheInForeground = options.notifyL2CacheInForeground;
+    this.autoPersistUpdates = options.config.isAutoPersistUpdates();
     this.persistBatch = PersistBatch.ALL == options.config.getPersistBatch();
     this.persistBatchOnCascade = PersistBatch.ALL == options.config.appliedPersistBatchOnCascade();
     this.rollbackOnChecked = options.config.isTransactionRollbackOnChecked();
@@ -279,11 +286,15 @@ public class TransactionManager implements SpiTransactionManager {
     return bulkEventListenerMap;
   }
 
-  boolean getPersistBatch() {
+  boolean isAutoPersistUpdates() {
+    return autoPersistUpdates;
+  }
+
+  boolean isPersistBatch() {
     return persistBatch;
   }
 
-  public boolean getPersistBatchOnCascade() {
+  boolean isPersistBatchOnCascade() {
     return persistBatchOnCascade;
   }
 
@@ -786,4 +797,14 @@ public class TransactionManager implements SpiTransactionManager {
   public boolean isLogSummary() {
     return logManager.sum().isDebug();
   }
+
+  /**
+   * Experimental - find dirty beans in the persistence context and persist them.
+   */
+  public void flushTransparent(PersistenceContext persistenceContext, SpiTransaction transaction) {
+    List<Object> dirtyBeans = persistenceContext.dirtyBeans();
+    if (!dirtyBeans.isEmpty()) {
+      server.updateAll(dirtyBeans, transaction);
+    }
+  }
 }

ebean-core/src/main/java/io/ebeaninternal/server/transaction/TransactionManagerOptions.java

@@ -3,6 +3,7 @@ package io.ebeaninternal.server.transaction;
 import io.ebean.BackgroundExecutor;
 import io.ebean.cache.ServerCacheNotify;
 import io.ebean.config.DatabaseConfig;
+import io.ebean.plugin.SpiServer;
 import io.ebeaninternal.api.SpiLogManager;
 import io.ebeaninternal.api.SpiProfileHandler;
 import io.ebeaninternal.server.cluster.ClusterManager;
@@ -15,6 +16,7 @@ import io.ebeanservice.docstore.api.DocStoreUpdateProcessor;
  */
 public class TransactionManagerOptions {
 
+  final SpiServer server;
   final boolean notifyL2CacheInForeground;
   final DatabaseConfig config;
   final ClusterManager clusterManager;
@@ -31,11 +33,11 @@ public class TransactionManagerOptions {
   final ClockService clockService;
 
 
-  public TransactionManagerOptions(boolean notifyL2CacheInForeground, DatabaseConfig config, TransactionScopeManager scopeManager, ClusterManager clusterManager,
+  public TransactionManagerOptions(SpiServer server, boolean notifyL2CacheInForeground, DatabaseConfig config, TransactionScopeManager scopeManager, ClusterManager clusterManager,
                                    BackgroundExecutor backgroundExecutor, DocStoreUpdateProcessor docStoreUpdateProcessor,
                                    BeanDescriptorManager descMgr, DataSourceSupplier dataSourceSupplier, SpiProfileHandler profileHandler,
                                    SpiLogManager logManager, TableModState tableModState, ServerCacheNotify cacheNotify, ClockService clockService) {
-
+    this.server = server;
     this.notifyL2CacheInForeground = notifyL2CacheInForeground;
     this.config = config;
     this.scopeManager = scopeManager;