Add `allowsBackgroundReloading` Flag to ListAdapterUpdater to Give User Control of Behavior #375

Adlai-Holler · 2016-12-28T22:32:47Z

Such a powerful framework y'all have made! Game status: changed.

Changes in this pull request

Add a flag to ListAdapterUpdater to require it to perform diffing, even when collection view is not in a window.
- Ensures delegate can rely on diffing callbacks.
- Ensures layout can rely on prepareForCollectionViewUpdates:.
- Helps with support for AsyncDisplayKit that I'm working on 🙊

Pull request checklist

All tests pass. Demo project builds and runs.
I added tests, an experiment, or detailed why my change isn't tested.
I added an entry to the CHANGELOG.md for any breaking changes, enhancements, or bug fixes.
I have reviewed the contributing guide

…collection view is offscreen.

coveralls · 2016-12-28T22:49:03Z

Coverage increased (+0.0007%) to 97.979% when pulling 12c5587 on Adlai-Holler:always-be-diffing into 5cd771b on Instagram:master.

jessesquires · 2016-12-29T16:51:09Z

Thanks @Adlai-Holler ! 💯

Not 100% sure about this change. I'll defer to @rnystrom.

One thing to note though: we'll need the default value to be NO to preserve existing behavior. Otherwise, this is a breaking change for clients already using the library.

Adlai-Holler · 2016-12-29T18:15:46Z

@jessesquires The current behavior is to default to YES.

EDIT: Thanks for the review btw! Love your work!

jessesquires · 2016-12-29T18:16:42Z

@Adlai-Holler - ahh ok 👍

rnystrom

Really curious about the ASDK integration stuff! Sounds cool.

Just a few nits then we can go ahead and land this. We had batch updates in the background for a while and removed it simply to save main queue resources for things that might be updating off-screen. Should be a harmless option.

rnystrom · 2016-12-29T20:42:20Z

Source/IGListAdapterUpdater.h

+ @note This will result in better performance, but will not generate the same delegate
+ callbacks and your layout will not receive `prepareForCollectionViewUpdates:`.
+
+ @warning On iOS < 8.3, this behavior is unsupported and will always be treated as `NO`.


rnystrom · 2016-12-29T20:50:59Z

Source/IGListAdapterUpdater.m

@@ -155,7 +153,8 @@ - (void)performBatchUpdatesWithCollectionView:(UICollectionView *)collectionView

 // if the collection view isn't in a visible window, skip diffing and batch updating. execute all transition blocks,
 // reload data, execute completion blocks, and get outta here
- if (_canBackgroundReload && collectionView.window == nil) {
+ BOOL iOS83OrLater = (NSFoundationVersionNumber >= NSFoundationVersionNumber_iOS_8_3);


nit: Can keep this in here for now, but IMO better to keep PRs changing one thing at a time. Makes crawling history and blames a lot easier.

let's make this const BOOL too 😊

rnystrom · 2016-12-29T20:51:57Z

Source/IGListAdapterUpdater.m

@@ -155,7 +153,8 @@ - (void)performBatchUpdatesWithCollectionView:(UICollectionView *)collectionView

 // if the collection view isn't in a visible window, skip diffing and batch updating. execute all transition blocks,
 // reload data, execute completion blocks, and get outta here
- if (_canBackgroundReload && collectionView.window == nil) {
+ BOOL iOS83OrLater = (NSFoundationVersionNumber >= NSFoundationVersionNumber_iOS_8_3);
+ if (iOS83OrLater && _skipsDiffingWhenOffscreen && collectionView.window == nil) {


Let's use the getter self.skipsDiffingWhenOffscreen since we're using more than an ivar

rnystrom · 2016-12-29T20:52:05Z

Tests/IGListAdapterUpdaterTests.m

@@ -459,4 +459,52 @@ - (void)test_whenCallingReloadData_withUICollectionViewFlowLayout_withEstimatedS
 XCTAssertEqual([collectionView numberOfItemsInSection:1], 4);
 }

+- (void)test_whenCollectionViewNotInWindow_andDiffSkippingFlagSetNO_diffHappens
+{


nit: sameline the { for all tests

facebook-github-bot · 2016-12-29T21:31:07Z

@Adlai-Holler updated the pull request - view changes

Adlai-Holler · 2016-12-29T21:31:35Z

@rnystrom Thanks for the review!

coveralls · 2016-12-29T21:48:38Z

Coverage increased (+0.0007%) to 97.979% when pulling 2d60457 on Adlai-Holler:always-be-diffing into 5cd771b on Instagram:master.

jessesquires

Actually, can we simplify this?

How about naming: allowsBackgroundReloading ?

Cocoa usually follows an "affirmative" naming style, i.e. prefersStatusBarHidden, hidesBottomBarWhenPushed, etc.

We'll need to invert the logic too.

jessesquires · 2016-12-29T22:29:03Z

Marked this for 2.1.0 release.

facebook-github-bot · 2016-12-30T21:38:06Z

@Adlai-Holler updated the pull request - view changes

facebook-github-bot · 2016-12-30T21:38:49Z

@Adlai-Holler updated the pull request - view changes

coveralls · 2016-12-30T21:57:24Z

Coverage increased (+0.0007%) to 97.979% when pulling 4f588f4 on Adlai-Holler:always-be-diffing into 5cd771b on Instagram:master.

coveralls · 2016-12-30T22:08:42Z

Coverage increased (+0.0007%) to 97.979% when pulling 4f588f4 on Adlai-Holler:always-be-diffing into 5cd771b on Instagram:master.

jessesquires · 2017-01-01T19:19:06Z

Thanks @Adlai-Holler !

Can you check the box on the PR to "allow owners to edit" ? (something like that)

Adlai-Holler · 2017-01-01T23:24:11Z

@jessesquires Done and done.

facebook-github-bot · 2017-01-02T00:04:37Z

@Adlai-Holler updated the pull request - view changes

facebook-github-bot · 2017-01-02T00:05:00Z

@Adlai-Holler updated the pull request - view changes

facebook-github-bot · 2017-01-02T00:05:42Z

@Adlai-Holler updated the pull request - view changes

jessesquires

Looks awesome! 🌮 🎉

coveralls · 2017-01-02T00:18:36Z

Coverage increased (+0.0007%) to 97.979% when pulling 808788e on Adlai-Holler:always-be-diffing into 5cd771b on Instagram:master.

coveralls · 2017-01-02T00:28:56Z

Coverage increased (+0.0007%) to 97.979% when pulling 808788e on Adlai-Holler:always-be-diffing into 5cd771b on Instagram:master.

coveralls · 2017-01-02T00:39:09Z

Coverage increased (+0.0007%) to 97.979% when pulling 808788e on Adlai-Holler:always-be-diffing into 5cd771b on Instagram:master.

facebook-github-bot · 2017-01-03T17:59:12Z

@jessesquires has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator.

Adlai Holler added 4 commits December 28, 2016 13:45

Allow user to force ListAdapterUpdater to perform diffing, even when …

4b1f621

…collection view is offscreen.

Add a unit test

cee2625

Add another unit test

122cce4

Update the changelog

12c5587

Adlai-Holler changed the title ~~Allow user to force ListAdapterUpdater to perform diffing, even when …~~ Add skipsDiffingWhenOffscreen Flag to ListAdapterUpdater to Give User Control of Behavior Dec 28, 2016

facebook-github-bot added the CLA Signed label Dec 29, 2016

jessesquires requested a review from rnystrom December 29, 2016 16:51

rnystrom suggested changes Dec 29, 2016

View reviewed changes

Address PR review comments

2d60457

jessesquires added this to the 2.1.0 milestone Dec 29, 2016

jessesquires suggested changes Dec 29, 2016

View reviewed changes

Rename the new flag

6d22dd1

Adlai-Holler changed the title ~~Add skipsDiffingWhenOffscreen Flag to ListAdapterUpdater to Give User Control of Behavior~~ Add allowsBackgroundReloading Flag to ListAdapterUpdater to Give User Control of Behavior Dec 30, 2016

Rename harder

4f588f4

Adlai-Holler mentioned this pull request Dec 31, 2016

Add Support for IGListKit facebookarchive/AsyncDisplayKit#2848

Closed

Update IGListAdapterUpdater.h

29d939c

Update IGListAdapterUpdater.m

9a9204d

Update IGListAdapterUpdaterTests.m

808788e

jessesquires approved these changes Jan 2, 2017

View reviewed changes

rnystrom approved these changes Jan 3, 2017

View reviewed changes

facebook-github-bot closed this in 71ce990 Jan 3, 2017

Adlai-Holler deleted the always-be-diffing branch January 3, 2017 23:16

Sherlouk mentioned this pull request Jan 10, 2017

Add examples for ASDK, ComponentKit, etc. #94

Closed

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `allowsBackgroundReloading` Flag to ListAdapterUpdater to Give User Control of Behavior #375

Add `allowsBackgroundReloading` Flag to ListAdapterUpdater to Give User Control of Behavior #375

Adlai-Holler commented Dec 28, 2016

coveralls commented Dec 28, 2016 •

edited

Loading

jessesquires commented Dec 29, 2016

Adlai-Holler commented Dec 29, 2016 •

edited

Loading

jessesquires commented Dec 29, 2016

rnystrom left a comment

rnystrom Dec 29, 2016

rnystrom Dec 29, 2016

jessesquires Dec 29, 2016

rnystrom Dec 29, 2016

rnystrom Dec 29, 2016

facebook-github-bot commented Dec 29, 2016

Adlai-Holler commented Dec 29, 2016

coveralls commented Dec 29, 2016 •

edited

Loading

jessesquires left a comment

jessesquires commented Dec 29, 2016

facebook-github-bot commented Dec 30, 2016

facebook-github-bot commented Dec 30, 2016

coveralls commented Dec 30, 2016 •

edited

Loading

coveralls commented Dec 30, 2016 •

edited

Loading

jessesquires commented Jan 1, 2017

Adlai-Holler commented Jan 1, 2017

facebook-github-bot commented Jan 2, 2017

facebook-github-bot commented Jan 2, 2017

facebook-github-bot commented Jan 2, 2017

jessesquires left a comment

coveralls commented Jan 2, 2017 •

edited

Loading

coveralls commented Jan 2, 2017 •

edited

Loading

coveralls commented Jan 2, 2017 •

edited

Loading

facebook-github-bot commented Jan 3, 2017

Add allowsBackgroundReloading Flag to ListAdapterUpdater to Give User Control of Behavior #375

Add allowsBackgroundReloading Flag to ListAdapterUpdater to Give User Control of Behavior #375

Conversation

Adlai-Holler commented Dec 28, 2016

Changes in this pull request

Pull request checklist

coveralls commented Dec 28, 2016 • edited Loading

jessesquires commented Dec 29, 2016

Adlai-Holler commented Dec 29, 2016 • edited Loading

jessesquires commented Dec 29, 2016

rnystrom left a comment

Choose a reason for hiding this comment

rnystrom Dec 29, 2016

Choose a reason for hiding this comment

rnystrom Dec 29, 2016

Choose a reason for hiding this comment

jessesquires Dec 29, 2016

Choose a reason for hiding this comment

rnystrom Dec 29, 2016

Choose a reason for hiding this comment

rnystrom Dec 29, 2016

Choose a reason for hiding this comment

facebook-github-bot commented Dec 29, 2016

Adlai-Holler commented Dec 29, 2016

coveralls commented Dec 29, 2016 • edited Loading

jessesquires left a comment

Choose a reason for hiding this comment

jessesquires commented Dec 29, 2016

facebook-github-bot commented Dec 30, 2016

facebook-github-bot commented Dec 30, 2016

coveralls commented Dec 30, 2016 • edited Loading

coveralls commented Dec 30, 2016 • edited Loading

jessesquires commented Jan 1, 2017

Adlai-Holler commented Jan 1, 2017

facebook-github-bot commented Jan 2, 2017

facebook-github-bot commented Jan 2, 2017

facebook-github-bot commented Jan 2, 2017

jessesquires left a comment

Choose a reason for hiding this comment

coveralls commented Jan 2, 2017 • edited Loading

coveralls commented Jan 2, 2017 • edited Loading

coveralls commented Jan 2, 2017 • edited Loading

facebook-github-bot commented Jan 3, 2017

Add `allowsBackgroundReloading` Flag to ListAdapterUpdater to Give User Control of Behavior #375

Add `allowsBackgroundReloading` Flag to ListAdapterUpdater to Give User Control of Behavior #375

coveralls commented Dec 28, 2016 •

edited

Loading

Adlai-Holler commented Dec 29, 2016 •

edited

Loading

coveralls commented Dec 29, 2016 •

edited

Loading

coveralls commented Dec 30, 2016 •

edited

Loading

coveralls commented Dec 30, 2016 •

edited

Loading

coveralls commented Jan 2, 2017 •

edited

Loading

coveralls commented Jan 2, 2017 •

edited

Loading

coveralls commented Jan 2, 2017 •

edited

Loading