Skip to content

Fix onViewableItemsChanged not firing after StrictMode/Activity remount #58986

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pinpong wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix onViewableItemsChanged not firing after StrictMode/Activity remount #58986

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/virtualized-lists/Lists/ViewabilityHelper.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ class ViewabilityHelper {
*/
dispose() {
this._timers.forEach(clearTimeout);
this.resetViewableIndices();
}

/**
Expand Down
82 changes: 82 additions & 0 deletions packages/virtualized-lists/Lists/__tests__/ViewabilityHelper-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -767,6 +767,88 @@ describe('onUpdate', function () {
});
});

it('minimumViewTime reports items again after dispose', function () {
const helper = new ViewabilityHelper({
minimumViewTime: 350,
viewAreaCoveragePercentThreshold: 0,
});
rowFrames = {
a: {y: 0, height: 200},
b: {y: 200, height: 200},
};
data = [{key: 'a'}, {key: 'b'}];
const onViewableItemsChanged = jest.fn();
helper.onUpdate(
props,
0,
200,
// $FlowFixMe[incompatible-type] - Invalid `ListMetricsAggregator`.
{getCellMetrics},
createViewToken,
onViewableItemsChanged,
);
// Cancels the pending callback, e.g. when the list gets hidden.
helper.dispose();
jest.runAllTimers();
expect(onViewableItemsChanged).not.toBeCalled();

helper.onUpdate(
props,
0,
200,
// $FlowFixMe[incompatible-type] - Invalid `ListMetricsAggregator`.
{getCellMetrics},
createViewToken,
onViewableItemsChanged,
);
jest.runAllTimers();

expect(onViewableItemsChanged.mock.calls.length).toBe(1);
expect(onViewableItemsChanged.mock.calls[0][0]).toEqual({
changed: [{isViewable: true, key: 'a'}],
viewabilityConfig: {
minimumViewTime: 350,
viewAreaCoveragePercentThreshold: 0,
},
viewableItems: [{isViewable: true, key: 'a'}],
});
});

it('does not report already viewable items again after dispose', function () {
const helper = new ViewabilityHelper({
viewAreaCoveragePercentThreshold: 0,
});
rowFrames = {
a: {y: 0, height: 200},
b: {y: 200, height: 200},
};
data = [{key: 'a'}, {key: 'b'}];
const onViewableItemsChanged = jest.fn();
helper.onUpdate(
props,
0,
200,
// $FlowFixMe[incompatible-type] - Invalid `ListMetricsAggregator`.
{getCellMetrics},
createViewToken,
onViewableItemsChanged,
);
expect(onViewableItemsChanged.mock.calls.length).toBe(1);

helper.dispose();
helper.onUpdate(
props,
0,
200,
// $FlowFixMe[incompatible-type] - Invalid `ListMetricsAggregator`.
{getCellMetrics},
createViewToken,
onViewableItemsChanged,
);

expect(onViewableItemsChanged.mock.calls.length).toBe(1);
});

it('waitForInteraction blocks callback until interaction', function () {
const helper = new ViewabilityHelper({
waitForInteraction: true,
Expand Down
Loading