remove unsafe early exit on performDataSourceChange

Summary: By making `-performUpdate` completely synchronous sometimes, it unearthed a bug with the early exit where multiple updates can happen at once. Specifically, the shortcut doesn't block updates from being started within `-didUpdateToObject`. Lets test removing it, since it's happening in a pretty sensitive part of updates. Differential Revision: D60773894 fbshipit-source-id: 721dffcb6d5353d12693fa873eb0f502bcdf4c02
Instagram · Aug 6, 2024 · 5a93080 · 5a93080
1 parent 420fa27
commit 5a93080
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 8 deletions.
diff --git a/Source/IGListDiffKit/IGListExperiments.h b/Source/IGListDiffKit/IGListExperiments.h
@@ -20,6 +20,8 @@ typedef NS_OPTIONS (NSInteger, IGListExperiment) {
     IGListExperimentInvalidateLayoutForUpdates = 1 << 2,
     /// Throw NSInternalInconsistencyException during an update
     IGListExperimentThrowOnInconsistencyException = 1 << 3,
+    /// Remove the early exit so multiple updates can't happen at once
+    IGListExperimentRemoveDataSourceChangeEarlyExit = 1 << 4,
 };
 
 /**

diff --git a/Source/IGListKit/IGListAdapterUpdater.m b/Source/IGListKit/IGListAdapterUpdater.m
@@ -208,7 +208,9 @@ - (void)performDataSourceChange:(IGListDataSourceChangeBlock)block {
     // Which means we need to cancel the current transaction, flatten the changes from
     // both the current transtion and builder, and execute that new transaction.
 
-    if (!self.transaction && ![self.transactionBuilder hasChanges]) {
+    if (!self.transaction 
+        && ![self.transactionBuilder hasChanges]
+        && !IGListExperimentEnabled(self.experiments, IGListExperimentRemoveDataSourceChangeEarlyExit)) {
         // If nothing is going on, lets take a shortcut.
         block();
         return;

diff --git a/Source/IGListKit/Internal/IGListUpdateTransactionBuilder.m b/Source/IGListKit/Internal/IGListUpdateTransactionBuilder.m
@@ -141,13 +141,12 @@ - (void)addChangesFromBuilder:(IGListUpdateTransactionBuilder *)builder {
 - (nullable id<IGListUpdateTransactable>)buildWithConfig:(IGListUpdateTransactationConfig)config
                                                 delegate:(nullable id<IGListAdapterUpdaterDelegate>)delegate
                                                  updater:(IGListAdapterUpdater *)updater {
-    IGListCollectionViewBlock collectionViewBlock = self.collectionViewBlock;
-    if (!collectionViewBlock) {
-        return nil;
-    }
-
     switch (self.mode) {
-        case IGListUpdateTransactionBuilderModeBatchUpdate:
+        case IGListUpdateTransactionBuilderModeBatchUpdate: {
+            IGListCollectionViewBlock collectionViewBlock = self.collectionViewBlock;
+            if (!collectionViewBlock) {
+                return nil;
+            }
             return [[IGListBatchUpdateTransaction alloc] initWithCollectionViewBlock:collectionViewBlock
                                                                              updater:updater
                                                                             delegate:delegate
@@ -157,9 +156,11 @@ - (void)addChangesFromBuilder:(IGListUpdateTransactionBuilder *)builder {
                                                                applySectionDataBlock:self.applySectionDataBlock
                                                                     itemUpdateBlocks:self.itemUpdateBlocks
                                                                     completionBlocks:self.completionBlocks];
+        }
         case IGListUpdateTransactionBuilderModeReload: {
             IGListReloadUpdateBlock reloadBlock = self.reloadBlock;
-            if (!reloadBlock) {
+            IGListCollectionViewBlock collectionViewBlock = self.collectionViewBlock;
+            if (!reloadBlock || !collectionViewBlock) {
                 return nil;
             }
             return [[IGListReloadTransaction alloc] initWithCollectionViewBlock:collectionViewBlock