Scroll highlight feature for workspace member page by shubham1206agra · Pull Request #38036 · Expensify/App

shubham1206agra · 2024-03-11T11:42:25Z

Details

Fixed Issues

$ #35717

Tests

Open Workspace where you want to add members.
Add new members using Invite Members flow.
Observe that it scrolls to the first new added member, and it highlights new members for some time.

Verify that no errors appear in the JS console

Offline tests

Same as Tests

QA Steps

Same as Tests

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2024-03-11.at.7.09.25.PM.mov

Android: mWeb Chrome

Screen.Recording.2024-03-11.at.6.44.06.PM.mov

iOS: Native

iOS: mWeb Safari

Screen.Recording.2024-03-11.at.6.27.11.PM.mov

Screen.Recording.2024-03-11.at.6.28.29.PM.mov

MacOS: Chrome / Safari

Screen.Recording.2024-03-11.at.6.12.58.PM.mov

MacOS: Desktop

Screen.Recording.2024-03-11.at.6.51.18.PM.mov

melvin-bot · 2024-03-11T11:42:30Z

@ishpaul777 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]

shubham1206agra · 2024-03-11T11:43:03Z

@ishpaul777 Scroll feature might misbehave as it is a known bug.

shubham1206agra · 2024-03-11T11:48:39Z

@mountiny I am currently using fixed timing approach instead of focus till interaction as it is very hard to implement due to multiple extra re-renders which I am unable to control.

shubham1206agra · 2024-03-11T12:27:09Z

src/pages/workspace/WorkspaceMembersPage.tsx

+            return;
+        }
+        const invitedEmails = Object.values(invitedEmailsToAccountIDsDraft).map(String);
+        selectionListRef.current?.scrollAndHighlightItem?.(invitedEmails, 1500);


We need to decide time here.

@Expensify/design How long should the highlight be there for?

Got it, so just to clarify, we are not doing the original idea where it stays highlighted until another action is taken? The highlight will always be ephemeral?

If that's the case I don't have strong feelings on an exact time... somewhere between 1.5-3 seconds seems fine to me?

Got it, so just to clarify, we are not doing the original idea where it stays highlighted until another action is taken? The highlight will always be ephemeral?

@shawnborton We are using a fixed time approach only right now.

Cool, no strong feelings in terms of time then - perhaps let's see some screen recordings of a few different options?

1500ms (current)

Screen.Recording.2024-03-11.at.8.35.00.PM.mov

That feels pretty good, but can we have the background color fade out instead of just change at the end?

would be a great improvement, @shubham1206agra ^

This will most probably be added later in a follow-up PR as discussed with @mountiny in Slack.

smallll nitpick: 1500 should have been in CONST file

mountiny · 2024-03-11T12:47:04Z

it is very hard to implement due to multiple extra re-renders which I am unable to control.

Could you define this problem a bit more specifically and bring it to slack, possible #newdot-performance and we could brainstorm with agency workers how to achieve this

mountiny

@ishpaul777 @shubham1206agra Given this is bigger change to the BaseSelectionList component, can you please add tests for other places where the SelectionList component is used? Also make sure Tab+Enter navigation is working as expected there etc.

Thanks

src/pages/workspace/WorkspaceMembersPage.tsx

mountiny · 2024-03-11T12:52:28Z

src/pages/workspace/WorkspaceInviteMessagePage.tsx

        Keyboard.dismiss();
        // Please see https://github.com/Expensify/App/blob/main/README.md#Security for more details
        Policy.addMembersToWorkspace(invitedEmailsToAccountIDsDraft ?? {}, welcomeNote ?? '', route.params.policyID);
-        Policy.setWorkspaceInviteMembersDraft(route.params.policyID, {});


Noted in the other file, why did this need to be moved

I think this is written in document. Its main purpose to get invite list when sending the invite request.

I think we still want to clear this list, no?

We clear it here #38036 (comment)

src/components/SelectionList/BaseSelectionList.tsx

shubham1206agra · 2024-03-11T12:56:34Z

I saw when I added new members, it re-renders with old members list, and then with new member list multiple times. And another problem I will highlight here, is that it might get laggy as I have to run highlight cleanup logic on every interaction which involves a Onyx cleanup logic, which might introduce performance issues.

ishpaul777 · 2024-03-11T14:06:55Z

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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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 the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- 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 grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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(theme.componentBG)
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
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 the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If the PR modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label so the design team can review the changes.
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

Android: Native

Screen.Recording.2024-03-11.at.11.43.33.PM.mov

Android: mWeb Chrome

Screen.Recording.2024-03-11.at.11.00.06.PM.mov

iOS: Native

Screen.Recording.2024-03-11.at.11.19.04.PM.mov

iOS: mWeb Safari

Screen.Recording.2024-03-11.at.10.40.51.PM.mov

MacOS: Chrome / Safari

Screen.Recording.2024-03-11.at.11.01.41.PM.mov

MacOS: Desktop

Screen.Recording.2024-03-11.at.11.23.29.PM-1.mov

mountiny · 2024-03-11T16:13:43Z

Cool ok, I think we can leave the fade for later and explore if the highlight approach is doable

ishpaul777 · 2024-03-11T17:13:43Z

src/components/SelectionList/BaseSelectionList.tsx

+    const scrollAndHighlightItem = useCallback(
+        (items: string[], timeout: number) => {
+            const newItemsToHighlight = new Set<string>();
+            items.forEach((item) => {
+                newItemsToHighlight.add(item);
+            });
+            const index = flattenedSections.allOptions.findIndex((option) => newItemsToHighlight.has(option.keyForList));
+            updateAndScrollToFocusedIndex(index);
+            setItemToHighlight(newItemsToHighlight);
+
+            if (itemFocusTimeoutRef.current) {
+                clearTimeout(itemFocusTimeoutRef.current);
+            }
+
+            itemFocusTimeoutRef.current = setTimeout(() => {
+                setFocusedIndex(-1);
+                setItemToHighlight(null);
+            }, timeout);
+        },
+        [flattenedSections.allOptions, updateAndScrollToFocusedIndex],
+    );


Scroll feature might misbehave as it is a known bug.

just for future note that scroll just end above the item in list

Screen.Recording.2024-03-11.at.10.40.51.PM.mov

Did this happen on mWeb only? Do we need to add an offset with the item height?

This happens on all platforms.

luacmartins · 2024-03-11T19:52:17Z

@shubham1206agra can you resolve conflicts please?

src/components/SelectionList/BaseSelectionList.tsx

luacmartins · 2024-03-11T23:52:30Z

src/components/SelectionList/BaseSelectionList.tsx

+    const scrollAndHighlightItem = useCallback(
+        (items: string[], timeout: number) => {
+            const newItemsToHighlight = new Set<string>();
+            items.forEach((item) => {
+                newItemsToHighlight.add(item);
+            });
+            const index = flattenedSections.allOptions.findIndex((option) => newItemsToHighlight.has(option.keyForList));
+            updateAndScrollToFocusedIndex(index);
+            setItemToHighlight(newItemsToHighlight);
+
+            if (itemFocusTimeoutRef.current) {
+                clearTimeout(itemFocusTimeoutRef.current);
+            }
+
+            itemFocusTimeoutRef.current = setTimeout(() => {
+                setFocusedIndex(-1);
+                setItemToHighlight(null);
+            }, timeout);
+        },
+        [flattenedSections.allOptions, updateAndScrollToFocusedIndex],
+    );


Did this happen on mWeb only? Do we need to add an offset with the item height?

luacmartins · 2024-03-11T23:54:11Z

src/pages/workspace/WorkspaceInviteMessagePage.tsx

        Keyboard.dismiss();
        // Please see https://github.com/Expensify/App/blob/main/README.md#Security for more details
        Policy.addMembersToWorkspace(invitedEmailsToAccountIDsDraft ?? {}, welcomeNote ?? '', route.params.policyID);
-        Policy.setWorkspaceInviteMembersDraft(route.params.policyID, {});


I think we still want to clear this list, no?

luacmartins · 2024-03-12T05:17:55Z

LGTM we can look at this issue in the follow up - #38036 (comment)

mountiny · 2024-03-12T22:33:49Z

Waiting for conflicts resolution

OSBotify · 2024-03-13T03:17:27Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

OSBotify · 2024-03-13T19:59:48Z

🚀 Deployed to staging by https://github.com/luacmartins in version: 1.4.52-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

OSBotify · 2024-03-15T10:16:09Z

🚀 Deployed to production by https://github.com/Beamanator in version: 1.4.52-6 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

Scroll highlight feature for workspace member page

6d0f165

shubham1206agra requested a review from a team as a code owner March 11, 2024 11:42

melvin-bot bot requested review from ishpaul777 and removed request for a team March 11, 2024 11:42

shubham1206agra commented Mar 11, 2024

View reviewed changes

Removed timeout on unmount

abf13f6

mountiny assigned shubham1206agra Mar 11, 2024

mountiny requested review from luacmartins and mountiny March 11, 2024 12:45

mountiny reviewed Mar 11, 2024

View reviewed changes

Added comments

1d8ff48

ishpaul777 reviewed Mar 11, 2024

View reviewed changes

ishpaul777 approved these changes Mar 11, 2024

View reviewed changes

melvin-bot bot requested a review from mountiny March 11, 2024 18:16

Merge branch 'main' into scroll-highlight

a165c49

luacmartins requested changes Mar 11, 2024

View reviewed changes

shubham1206agra and others added 2 commits March 12, 2024 07:03

Merge branch 'Expensify:main' into scroll-highlight

9c8b4cc

lint fix

4bee35b

luacmartins previously approved these changes Mar 12, 2024

View reviewed changes

Merge branch 'main' into scroll-highlight

f5bf3ce

shubham1206agra dismissed luacmartins’s stale review via f5bf3ce March 13, 2024 02:40

luacmartins approved these changes Mar 13, 2024

View reviewed changes

luacmartins merged commit 5ec1325 into Expensify:main Mar 13, 2024

github-actions bot mentioned this pull request Mar 13, 2024

Deploy Checklist: New Expensify 2024-03-13 #38257

Closed

74 tasks

melvin-bot bot mentioned this pull request Mar 15, 2024

[PAID] [$500] [Simplified Collect][Members] WorkspaceInvitePage: Redesign and scrolling to the first invited member #35717

Closed

mountiny mentioned this pull request Mar 15, 2024

[Awaiting Payment 30th April] [Wave Collect] [More Features] [$500] Feature enabled from more features are not highlighted when user taken back to the LHN #38372

Closed

6 tasks

allroundexperts mentioned this pull request Mar 18, 2024

feat: Add temporary focus to enabled option in workspace initial page #38546

Merged

50 tasks

shubham1206agra deleted the scroll-highlight branch February 3, 2025 17:47

Conversation

shubham1206agra commented Mar 11, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Mar 11, 2024

Uh oh!

shubham1206agra commented Mar 11, 2024

Uh oh!

shubham1206agra commented Mar 11, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mountiny commented Mar 11, 2024

Uh oh!

mountiny left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

shubham1206agra commented Mar 11, 2024

Uh oh!

ishpaul777 commented Mar 11, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

mountiny commented Mar 11, 2024

Uh oh!

ishpaul777 Mar 11, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

luacmartins commented Mar 11, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

luacmartins commented Mar 12, 2024

shubham1206agra commented Mar 11, 2024 •

edited

Loading

ishpaul777 commented Mar 11, 2024 •

edited

Loading

ishpaul777 Mar 11, 2024 •

edited

Loading