Add more info in IGListAdapterUpdater willPerformBatchUpdates call

Summary: Provide additional context in willPerformBatchUpdates, which can be useful for debugging. Reviewed By: lorixx Differential Revision: D10436588 fbshipit-source-id: a59803affc24ca20f7726e36117df6126b984afb
GitHawkApp · Oct 21, 2018 · b200dda · b200dda
1 parent 13d22fb
commit b200dda
Show file tree

Hide file tree

Showing 4 changed files with 108 additions and 78 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,8 @@ The changelog for `IGListKit`. Also see the [releases](https://github.com/instag
 
 - All `IGListBindingSectionControllerSelectionDelegate` methods are now required. [Bofei Zhu] (https://github.com/zhubofei) [(#1186)](https://github.com/Instagram/IGListKit/pull/1186)
 
+- Renamed `[IGListAdapterUpdatingDelegate listAdapterUpdater:willPerformBatchUpdatesWithCollectionView:]` to `[IGListAdapterUpdatingDelegate listAdapterUpdater:willPerformBatchUpdatesWithCollectionView:fromObjects:toObjects:listIndexSetResult:]` to include more supporting info on updated objects. [Jeremy Cohen] (https://github.com/jeremycohen) (tbd)
+
 ### Enhancements
 
 - Added `IGListCollectionScrollingTraits` for exposing `UICollectionView` scrolling traits to section controllers via `IGListCollectionContext`. [Adam Stern](https://github.com/adamastern) (tbd)

diff --git a/Source/IGListAdapterUpdater.m b/Source/IGListAdapterUpdater.m
@@ -228,7 +228,11 @@ - (void)performBatchUpdatesWithCollectionViewBlock:(IGListCollectionViewBlock)co
         [collectionView layoutIfNeeded];
 
         @try {
-            [delegate listAdapterUpdater:self willPerformBatchUpdatesWithCollectionView:collectionView];
+            [delegate  listAdapterUpdater:self
+willPerformBatchUpdatesWithCollectionView:collectionView
+                              fromObjects:fromObjects
+                                toObjects:toObjects
+                       listIndexSetResult:result];
             if (result.changeCount > 100 && IGListExperimentEnabled(experiments, IGListExperimentReloadDataFallback)) {
                 reloadDataFallback();
             } else if (animated) {

diff --git a/Source/IGListAdapterUpdaterDelegate.h b/Source/IGListAdapterUpdaterDelegate.h
@@ -10,6 +10,9 @@
 #import <IGListKit/IGListBatchUpdateData.h>
 
 @class IGListAdapterUpdater;
+@class IGListBatchUpdates;
+@class IGListIndexSetResult;
+@protocol IGListDiffable;
 
 NS_ASSUME_NONNULL_BEGIN
 
@@ -24,8 +27,15 @@ NS_SWIFT_NAME(ListAdapterUpdaterDelegate)
 
  @param listAdapterUpdater The adapter updater owning the transition.
  @param collectionView The collection view that will perform the batch updates.
+ @param fromObjects The items transitioned from in the batch updates, if any.
+ @param toObjects The items transitioned to in the batch updates, if any.
+ @param listIndexSetResults The diffing result of indices to be inserted/removed/updated/moved/etc.
  */
-- (void)listAdapterUpdater:(IGListAdapterUpdater *)listAdapterUpdater willPerformBatchUpdatesWithCollectionView:(UICollectionView *)collectionView;
+- (void)               listAdapterUpdater:(IGListAdapterUpdater *)listAdapterUpdater
+willPerformBatchUpdatesWithCollectionView:(UICollectionView *)collectionView
+                              fromObjects:(nullable NSArray <id<IGListDiffable>> *)fromObjects
+                                toObjects:(nullable NSArray <id<IGListDiffable>> *)toObjects
+                       listIndexSetResult:(nullable IGListIndexSetResult *)listIndexSetResults;
 
 /**
  Notifies the delegate that the updater successfully finished `-[UICollectionView performBatchUpdates:completion:]`.