Scroll To Last Index After Layout Change Of List #15662

Litande · 2023-03-04T16:45:02Z

Details

Added layoutChange function that will scroll to last index and fix position in case the original scroll happened before layout changed.

Fixed Issues

$ 15303
PROPOSAL: 15303(COMMENT)

Tests

Note: this behavior is only related to IOS and impacts native behavior.

Go to any chat
Write a few messages at least enough to have scroll
Write a multi line messages make it even five six rows
Scroll in such a way up so you will see only half of the message near the button.
Make sure on simulator keyboard is enabled
Long press the long message and select edit
Verify the edit view and actions are visible and not covered by keyboard

Verify that no errors appear in the JS console

Offline tests

QA Steps

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

New.Expensify.-.8.March.2023.mp4

Mobile Web - Chrome

Android.Studio.-.Emulator.-.8.March.2023.mp4

Mobile Web - Safari

Simulator.-.iPhone.14.Pro.-.8.March.2023.mp4

Desktop

Electron.-.New.Expensify.-.8.March.2023.mp4

iOS

Simulator.-.iPhone.14.Pro.-.6.March.2023.mp4

Android

qemu-system-aarch64.-.Android.Emulator.-.Pixel_6_API_32_5554.-.6.March.2023.mp4

…t change from report actions list to handle index scroll adjustment after layout is changed

github-actions · 2023-03-04T16:45:19Z

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

MelvinBot · 2023-03-06T07:24:30Z

@danieldoglas Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

danieldoglas · 2023-03-06T10:43:21Z

Assigning @puneetlath and @eVoloshchak since this is their issue. not sure why Melving added me.

src/libs/ReportScrollManager/index.native.js

Litande · 2023-03-06T18:25:03Z

@puneetlath not sure why @eVoloshchak was remnoved from reviewers

Lint Updates

Litande · 2023-03-07T14:09:01Z

@puneetlath @eVoloshchak i have fixed lint issues

puneetlath · 2023-03-07T16:01:38Z

@eVoloshchak can you take the first pass?

eVoloshchak · 2023-03-07T16:17:22Z

@eVoloshchak can you take the first pass?

Sure, reviewing in a couple of hours

eVoloshchak · 2023-03-07T16:52:26Z

@Litande, please include videos for all the platforms. They aren't affected, but this is a good way to double-check that

src/libs/ReportScrollManager/index.native.js

src/pages/home/report/ReportActionsList.js

src/libs/ReportScrollManager/index.native.js

Litande · 2023-03-07T18:31:33Z

@eVoloshchak updated the videos on all platforms, should i request review again? it seems to remove users when i do it.

Thanks.

eVoloshchak · 2023-03-07T21:26:32Z

should i request review again? it seems to remove users when i do it.

No, it remains visible in Review requests, so you don't have to request a review each time
UPD: you can just drag and drop videos into github, so they can be displayed in the built-in player

eVoloshchak · 2023-03-07T21:27:09Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is correct English and approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Screen.Recording.2023-03-08.at.12.49.35.mov

Mobile Web - Chrome

video_2023-03-08_12-56-11.mp4

Mobile Web - Safari

IMG_0006.MP4

Desktop

Screen.Recording.2023-03-08.at.12.53.55.mov

iOS

IMG_0007.MP4

Android

video_2023-03-08_12-56-07.mp4

src/libs/ReportScrollManager/index.native.js

eVoloshchak · 2023-03-07T21:37:46Z

src/libs/ReportScrollManager/index.native.js

+    }
+
+    flatListRef.current.scrollToIndex(lastIndex);
+    lastIndex = undefined;


Do we need to do this? I might be wrong, but I think we don't need to set lastIndex to undefined and don't need the if (lastIndex === undefined) check. Could you verify that, please?

The uncontrolled behavior requires this because the events aren't chained and can happen asynchronously the check validates and clearance of this value validates the action won't happen again if not actually needed

src/libs/ReportScrollManager/index.js

src/libs/ReportScrollManager/index.native.js

Co-authored-by: Eugene Voloshchak <copyreading@gmail.com>

Litande · 2023-03-08T06:42:15Z

@eVoloshchak updated everything and left comments

eVoloshchak · 2023-03-08T11:05:05Z

@Litande, some of the links in your Screenshots/Videos are broken, there are no videos.
You don't need to use a separate video hosting, you can just drag a file directly into GitHub comment

Screen.Recording.2023-03-08.at.12.55.35.mov

eVoloshchak

Code looks good to me, tests well on iOS too.
There is the same behavior on Mobile Safari, Web and Desktop (you can see it in videos here), but it was present before this PR (and it changes index.ios file only). We probably need to tackle it as a separate issue.
cc: @puneetlath

Litande · 2023-03-08T11:06:50Z

@eVoloshchak will update the videos in a hour like this

Litande · 2023-03-08T13:38:11Z

@eVoloshchak updated the videos.

puneetlath · 2023-03-08T14:50:55Z

There is the same behavior on Mobile Safari, Web and Desktop (you can see it in videos #15662 (comment)), but it was present before this PR (and it changes index.ios file only). We probably need to tackle it as a separate issue.

Hm, interesting. Will the solution for tackling it on those platforms be different?

eVoloshchak · 2023-03-08T14:56:36Z

Hm, interesting. Will the solution for tackling it on those platforms be different?

Yes. I've tried to apply the fix to all platforms, but the behavior is still the same

puneetlath · 2023-03-08T15:18:10Z

Ok, that's interesting. Is there a more holistic solution that we could do that would fix the issue on iOS and other platforms? Or do we need to take a platform-specific approach?

Don't worry @Litande, we'll pay you out for this no matter what direction we choose to go. I just want to make sure that this is indeed the best approach.

Litande · 2023-03-08T15:22:07Z

I can try to check other platforms the question is what the expected behavior if on switch to edit to execute the scroll because in most of them it don't scroll at all as it seems

eVoloshchak · 2023-03-08T15:28:21Z

@puneetlath, it turns out we explicitly disable the scroll if editing on web and desktop

App/src/libs/ReportScrollManager/index.js

Line 15 in f4ffc7c

if (isEditing) {

function scrollToIndex(index, isEditing) {
    if (isEditing) {
        return;
    }

    flatListRef.current.scrollToIndex(index);
}

I deleted this line and everything seems to work fine, but this logic was added for some reason.
It was added in #2320. I can't access the issue linked in that PR, all I found is this comment

Scroll to the provided index. On non-native implementations we do not want to scroll when we are scrolling because we are editing a comment.

Litande · 2023-03-08T15:46:12Z

@puneetlath @eVoloshchak it seems to me on web and desktop the assumption is that if an item is fully in view there is no need to scroll it, but it seems not to handle the edge cases (in case the item pressed is partially covered from top or bottom) also in general the "mobile - web" doesn't have a lot of space and those the same issue may happen much more frequently.

puneetlath · 2023-03-08T19:01:36Z

Looks like you added that two years ago @yuwenmemon. Do you remember why that was?

yuwenmemon · 2023-03-08T20:29:46Z

Do you remember why that was?

Yeah, we didn't want the scroll to move if you were editing. We just wanted you to be able to "edit in place" effectively. Small UX choice not sure if we're married to it anymore.

puneetlath · 2023-03-09T18:30:46Z

Ah that makes sense. So like if new messages come in while you're editing, we don't want the comment you're editing to move.

puneetlath · 2023-03-09T18:32:05Z

I'm still thinking, however, that we should try to solve this in a cross-platform way, rather than just doing it for iOS. What do you think @Litande and @eVoloshchak?

eVoloshchak · 2023-03-13T21:14:43Z

I'm still thinking, however, that we should try to solve this in a cross-platform way, rather than just doing it for iOS. What do you think @Litande and @eVoloshchak?

The only thing we can do is remove

    if (isEditing) {
        return;
    }

It works ok for me, haven't found any issues.
We can implement it here or raise a discussion in slack, since this is caused by a different reason than our issue

eVoloshchak · 2023-03-20T14:40:11Z

@puneetlath, bump on the above

Litande · 2023-03-20T14:44:02Z

@eVoloshchak @puneetlath i am ok with this, but not sure if the desition is correct from behavior point of view.

eVoloshchak · 2023-03-22T18:37:14Z

@puneetlath, should we proceed with the current bevavior (scroll is disabled while editing on web/desktop) or enable it?

puneetlath · 2023-03-23T14:40:20Z

My apologies for the delay! Not sure how this slipped through the cracks for me for so long. I think what we want ideally on all platforms:

When you edit a comment, scroll if needed so that the full input field and save/cancel buttons are visible
While editing, don't allow the chat to scroll if new messages come in

I think we should approach that in a cross-platofrm way. So I think we should go ahead and pay out @Litande and @eVoloshchak for this, since the work that was initially agreed upon was done. But let's close the PR and open a new issue to handle this in a more cross-platform way.

Thoughts on that approach @eVoloshchak?

eVoloshchak · 2023-03-23T15:14:11Z

When you edit a comment, scroll if needed so that the full input field and save/cancel buttons are visible

While editing, don't allow the chat to scroll if new messages come in

Yeah, I argee that should be the correct behavior
That means this issue might appear on web (on safari mobile) and we'll need to use this fix for all the platforms, going to check this

puneetlath · 2023-03-28T01:52:00Z

Ok opened new issue here: #16601

added layoutChange on report scroll manager and calling it from layou…

722d2e8

…t change from report actions list to handle index scroll adjustment after layout is changed

This comment was marked as off-topic.

Sign in to view

Litande marked this pull request as ready for review March 6, 2023 07:23

Litande requested a review from a team as a code owner March 6, 2023 07:23

melvin-bot bot requested review from danieldoglas and removed request for a team March 6, 2023 07:24

Litande mentioned this pull request Mar 6, 2023

[$1000] iPhone - Save changes and cancel button is hidden behind keyboard when Editing a quote message #15303

Closed

1 task

danieldoglas requested review from puneetlath and eVoloshchak March 6, 2023 10:42

danieldoglas removed their request for review March 6, 2023 10:43

puneetlath reviewed Mar 6, 2023

View reviewed changes

src/libs/ReportScrollManager/index.native.js Outdated Show resolved Hide resolved

Updated comment on lastIndex reference

7715aba

Litande requested review from puneetlath and removed request for eVoloshchak March 6, 2023 18:24

puneetlath requested a review from eVoloshchak March 6, 2023 18:29

Litande added 2 commits March 7, 2023 13:41

Update index.native.js

ec95e93

Lint Updates

Update ReportActionsList.js

ffebdb0

Lint Updates

eVoloshchak suggested changes Mar 7, 2023

View reviewed changes

review updates

1bf4564

missing export

20687e5

eVoloshchak suggested changes Mar 7, 2023

View reviewed changes

Litande and others added 4 commits March 8, 2023 07:12

Update src/libs/ReportScrollManager/index.native.js

1f309ff

Co-authored-by: Eugene Voloshchak <copyreading@gmail.com>

Update src/libs/ReportScrollManager/index.js

b1ce92c

Co-authored-by: Eugene Voloshchak <copyreading@gmail.com>

Update src/libs/ReportScrollManager/index.js

0778282

Co-authored-by: Eugene Voloshchak <copyreading@gmail.com>

split native-ios

c278d6e

eVoloshchak approved these changes Mar 8, 2023

View reviewed changes

puneetlath closed this Mar 28, 2023

Scroll To Last Index After Layout Change Of List #15662

Scroll To Last Index After Layout Change Of List #15662

Conversation

Litande commented Mar 4, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

github-actions bot commented Mar 4, 2023 • edited Loading

This comment was marked as off-topic.

MelvinBot commented Mar 6, 2023

danieldoglas commented Mar 6, 2023

Litande commented Mar 6, 2023

Litande commented Mar 7, 2023

puneetlath commented Mar 7, 2023

eVoloshchak commented Mar 7, 2023

eVoloshchak commented Mar 7, 2023

Litande commented Mar 7, 2023

eVoloshchak commented Mar 7, 2023 • edited Loading

eVoloshchak commented Mar 7, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

eVoloshchak Mar 7, 2023

Choose a reason for hiding this comment

Litande Mar 8, 2023

Choose a reason for hiding this comment

Litande commented Mar 8, 2023

eVoloshchak commented Mar 8, 2023

eVoloshchak left a comment

Choose a reason for hiding this comment

Litande commented Mar 8, 2023

Litande commented Mar 8, 2023

puneetlath commented Mar 8, 2023

eVoloshchak commented Mar 8, 2023

puneetlath commented Mar 8, 2023

Litande commented Mar 8, 2023

eVoloshchak commented Mar 8, 2023 • edited Loading

Litande commented Mar 8, 2023

puneetlath commented Mar 8, 2023

yuwenmemon commented Mar 8, 2023

puneetlath commented Mar 9, 2023

puneetlath commented Mar 9, 2023

eVoloshchak commented Mar 13, 2023

eVoloshchak commented Mar 20, 2023

Litande commented Mar 20, 2023

eVoloshchak commented Mar 22, 2023

puneetlath commented Mar 23, 2023

eVoloshchak commented Mar 23, 2023

puneetlath commented Mar 28, 2023

Litande commented Mar 4, 2023 •

edited

Loading

github-actions bot commented Mar 4, 2023 •

edited

Loading

eVoloshchak commented Mar 7, 2023 •

edited

Loading

eVoloshchak commented Mar 7, 2023 •

edited

Loading

eVoloshchak commented Mar 8, 2023 •

edited

Loading