Make improve of caching for hierarchical data optional (#11501)

Make improve of caching for hierarchical data optional

Fixes #11477

1 files changed, 63 insertions, 24 deletions

diff --git a/client/src/main/java/com/vaadin/client/data/AbstractRemoteDataSource.java b/client/src/main/java/com/vaadin/client/data/AbstractRemoteDataSource.java
index 7a52b0ef95..2992d39d1f 100644
--- a/client/src/main/java/com/vaadin/client/data/AbstractRemoteDataSource.java
+++ b/client/src/main/java/com/vaadin/client/data/AbstractRemoteDataSource.java
@@ -202,6 +202,21 @@ public abstract class AbstractRemoteDataSource<T> implements DataSource<T> {
      */
     private Map<Integer, T> invalidatedRows;
 
+    /**
+     * Tracking the invalidated rows inside {{@link #insertRowData(int, int)}}
+     * and then filling cache from those invalidated rows is a feature
+     * introduced to improve caching in hierarchical data in V8, but as this
+     * interface is also shared with V7 compatibility package, this change
+     * causes this issue: issue https://github.com/vaadin/framework/issues/11477
+     *
+     * By having {#AbstractRemoteDataSource} define whether or not to track and
+     * then fill cache with the invalidated rows, allows different
+     * implementation of {#AbstractRemoteDataSource} to enable/disable this
+     * feature, as a consequence it is possible for V7 compatibility-package of
+     * this class to disabled it and fix the above issue.
+     */
+    private boolean trackInvalidatedRows = true;
+
     private Set<DataChangeHandler> dataChangeHandlers = new LinkedHashSet<>();
 
     private CacheStrategy cacheStrategy = new CacheStrategy.DefaultCacheStrategy();
@@ -526,7 +541,10 @@ public abstract class AbstractRemoteDataSource<T> implements DataSource<T> {
                 if (!cached.isEmpty()) {
                     cached = cached.combineWith(newUsefulData);
                     // Attempt to restore invalidated items
-                    fillCacheFromInvalidatedRows(maxCacheRange);
+                    if (trackInvalidatedRows) {
+                        fillCacheFromInvalidatedRows(maxCacheRange);
+                    }
+
                 } else {
                     cached = newUsefulData;
                 }
@@ -721,31 +739,21 @@ public abstract class AbstractRemoteDataSource<T> implements DataSource<T> {
             }
         } else if (cached.contains(firstRowIndex)) {
             int oldCacheEnd = cached.getEnd();
-            /*
-             * We need to invalidate the cache from the inserted row onwards,
-             * since the cache wants to be a contiguous range. It doesn't
-             * support holes.
-             *
-             * If holes were supported, we could shift the higher part of
-             * "cached" and leave a hole the size of "count" in the middle.
-             */
-            Range[] splitAt = cached.splitAt(firstRowIndex);
-            cached = splitAt[0];
-            Range invalid = splitAt[1];
 
-            /*
-             * If we already have a map in invalidatedRows, we're in a state
-             * where multiple row manipulations without data received have
-             * happened and the cache restoration is prevented completely.
-             */
+            Range[] splitOldCache = cached.splitAt(firstRowIndex);
+            cached = splitOldCache[0];
+            Range invalidated = splitOldCache[1];
 
-            if (!invalid.isEmpty() && invalidatedRows == null) {
-                invalidatedRows = new HashMap<>();
-                // Store all invalidated items to a map. Indices are updated to
-                // match what they should be after the insertion.
-                for (int i = invalid.getStart(); i < invalid.getEnd(); ++i) {
-                    invalidatedRows.put(i + count, indexToRowMap.get(i));
-                }
+            if (trackInvalidatedRows) {
+                /*
+                 * We need to invalidate the cache from the inserted row onwards,
+                 * since the cache wants to be a contiguous range. It doesn't
+                 * support holes.
+                 *
+                 * If holes were supported, we could shift the higher part of
+                 * "cached" and leave a hole the size of "count" in the middle.
+                 */
+                trackInvalidatedRowsFromCache(invalidated, count);
             }
 
             for (int i = firstRowIndex; i < oldCacheEnd; i++) {
@@ -761,6 +769,24 @@ public abstract class AbstractRemoteDataSource<T> implements DataSource<T> {
         Profiler.leave("AbstractRemoteDataSource.insertRowData");
     }
 
+    private void trackInvalidatedRowsFromCache(Range invalidated, int insertedRowCount){
+        /*
+         * If we already have a map in invalidatedRows, we're in a state
+         * where multiple row manipulations without data received have
+         * happened and the cache restoration is prevented completely.
+         */
+
+        if (!invalidated.isEmpty() && invalidatedRows == null) {
+            invalidatedRows = new HashMap<>();
+            // Store all invalidated items to a map. Indices are updated
+            // to match what they should be after the insertion.
+            for (int i = invalidated.getStart(); i < invalidated
+                    .getEnd(); ++i) {
+                invalidatedRows.put(i + insertedRowCount, indexToRowMap.get(i));
+            }
+        }
+    }
+
     @SuppressWarnings("boxing")
     private void moveRowFromIndexToIndex(int oldIndex, int newIndex) {
         T row = indexToRowMap.remove(oldIndex);
@@ -934,4 +960,17 @@ public abstract class AbstractRemoteDataSource<T> implements DataSource<T> {
     protected boolean canFetchData() {
         return true;
     }
+
+    /**
+     * Sets whether or not to track invalidated rows inside
+     * {@link #insertRowData(int, int)} and use them to fill cache when
+     * {{@link #setRowData(int, List)}} is called.
+     *
+     * @param trackInvalidatedRows
+     *            a boolean value specifying if to track invalidated rows or
+     *            not, default value <code>true</code>
+     */
+    public void setTrackInvalidatedRows(boolean trackInvalidatedRows) {
+        this.trackInvalidatedRows = trackInvalidatedRows;
+    }
 }