Fix - Web - Blue selection border on plan option after a refresh #54682

FitseTLT · 2024-12-31T14:28:32Z

Details

Fixed Issues

$ #54502
PROPOSAL: #54502 (comment)

Tests

Create a workspace
Navigate to Workspace Settings > Profile > Plan
Refresh the page
Verify that there is no border around a plan

Verify that no errors appear in the JS console

Offline tests

Same as above

QA Steps

Same as above

Verify that no errors appear in the JS console

PR Author Checklist

I linked the correct issue in the ### Fixed Issues section above
I wrote clear testing steps that cover the changes made in this PR
- I added steps for local testing in the Tests section
- I added steps for the expected offline behavior in the Offline steps section
- I added steps for Staging and/or Production testing in the QA steps section
- I added steps to cover 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 tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
I included screenshots or videos for tests on all platforms
I ran the tests on all platforms & verified they passed on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
I followed proper code patterns (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
  - If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
- 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 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 followed the guidelines as stated in the Review Guidelines
I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
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
I verified that if a function's arguments changed that all usages have also been updated correctly
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 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.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

aw.mp4

iOS: Native

ios.mp4

iOS: mWeb Safari

iw.mp4

MacOS: Chrome / Safari

w.mp4

MacOS: Desktop

d.mp4

melvin-bot · 2024-12-31T14:28:37Z

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

FitseTLT · 2024-12-31T14:29:05Z

I am having trouble building for android native.

hoangzinh · 2025-01-02T11:17:45Z

@FitseTLT there is a failed unit tests in your new tests

FitseTLT · 2025-01-02T14:54:58Z

@FitseTLT there is a failed unit tests in your new tests

@hoangzinh the problem was caused by the unit test importing always the native code; I proved that b/c the test passes if I delete the native file. So I fixed it by separating the implementation in a different file and importing it 👍 U can proceed.

hoangzinh · 2025-01-03T09:57:11Z

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 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.ts 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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design 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.
For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
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.2025-01-31.at.21.28.29.android.mov

Android: mWeb Chrome

Screen.Recording.2025-01-31.at.21.29.37.android.chrome.mov

iOS: Native

Screen.Recording.2025-01-31.at.21.41.24.mov

iOS: mWeb Safari

Screen.Recording.2025-01-31.at.21.30.51.ios.safari.mov

MacOS: Chrome / Safari

Screen.Recording.2025-01-31.at.21.23.57.web.mov

MacOS: Desktop

Screen.Recording.2025-01-31.at.21.27.07.desktop.mov

hoangzinh · 2025-01-03T10:16:32Z

@FitseTLT it seems we haven't fixed this issue completely, when reload the page the blue selection border does not show but when I start to select options, it shows again

Screen.Recording.2025-01-03.at.17.14.23.mov

FitseTLT · 2025-01-20T13:48:09Z

@hoangzinh Fixed U can proceed

hoangzinh · 2025-01-22T15:08:59Z

Bug 2: It doesn't sync focus in the first key down press. It only works from 2nd time

Screen.Recording.2025-01-22.at.22.07.36.mov

FitseTLT · 2025-01-23T14:00:30Z

@hoangzinh Fixed

hoangzinh · 2025-01-24T06:50:37Z

@FitseTLT could you quickly share why we have to move keydown event into useArrowKeyFocusManager and SelectList 32a2550?

FitseTLT · 2025-01-24T12:45:03Z

@FitseTLT could you quickly share why we have to move keydown event into useArrowKeyFocusManager and SelectList 32a2550?

The problem where the syncing didn't work on the first key press was caused because the key down event listener in useSyncFocus was called after the focus on the item was changed so syncing wasn't happening as the hasKeyBeenPressed ref will be false by the time the effect runs. So, now we activate the sycing immediately on focus change via arrow (useArrowKeyFocusManager) and also when other key presses happen (SelectionList).

hoangzinh

Sorry for late review. It works for me. Just a few feedbacks

src/hooks/useSyncFocus/useSyncFocusImplementation.ts

src/components/SelectionList/BaseSelectionList.tsx

src/hooks/useSyncFocus/useSyncFocusImplementation.ts

tests/unit/useSyncFocusTest.ts

hoangzinh

LGTM

src/components/SelectionList/BaseSelectionList.tsx

cristipaval · 2025-02-04T19:17:24Z

src/components/SelectionList/BaseSelectionList.tsx

+
+        return () => removeKeyDownPressListener(setHasKeyBeenPressed);
+    }, [setHasKeyBeenPressed]);
+


Same, some comments might help for whoever comes here in the future.

@cristipaval I added a comment here

App/src/components/SelectionList/BaseSelectionList.tsx

Lines 328 to 330 in 1c9c6a7

// We need to track whether a key has been pressed to enable focus syncing only if a key has been pressed.

// This is to avoid the default behavior of web showing blue border on click of items after a page refresh.

hasKeyBeenPressed.current = true;

Isn't that enough? Because here the name of the ref already gives a hint why it is being set on key down event. WDYT

yes, I think that should be enough to know the reason for this code. Thanks

OSBotify · 2025-02-04T22:21:38Z

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

github-actions · 2025-02-06T22:00:43Z

🚀 Deployed to staging by https://github.com/cristipaval in version: 9.0.95-0 🚀

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

github-actions · 2025-02-11T02:12:02Z

🚀 Deployed to production by https://github.com/Julesssss in version: 9.0.95-6 🚀

platform	result
🤖 android 🤖	true ❌
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	failure ❌
🍎🔄 iOS HybridApp 🍎🔄	failure ❌

FitseTLT added 2 commits December 31, 2024 15:35

update useSyncFocus to operate only on isFocused change

920fd89

added test

80a568c

FitseTLT requested a review from a team as a code owner December 31, 2024 14:28

melvin-bot bot requested review from hoangzinh and removed request for a team December 31, 2024 14:28

fix test

5002fc2

FitseTLT added 3 commits January 20, 2025 15:08

Merge branch 'main' into fix-blue-selection-on-page-refresh

d138c13

allow focus sync only after key press

f8a0691

fix test

c78599c

FitseTLT added 3 commits January 22, 2025 18:31

Merge branch 'main' into fix-blue-selection-on-page-refresh

2bfaa1e

Merge branch 'main' into fix-blue-selection-on-page-refresh

4c13d8b

fix sync focus not working on first key press

32a2550

hoangzinh reviewed Jan 29, 2025

View reviewed changes

src/hooks/useSyncFocus/useSyncFocusImplementation.ts Outdated Show resolved Hide resolved

src/components/SelectionList/BaseSelectionList.tsx Outdated Show resolved Hide resolved

remove previous focus condition

6cc1de7

FitseTLT requested a review from hoangzinh January 30, 2025 12:31

FitseTLT added 3 commits January 30, 2025 15:34

rename the ref

090183c

Merge branch 'main' into fix-blue-selection-on-page-refresh

0ad24b4

resolved conflict

64dc0d0

hoangzinh reviewed Jan 30, 2025

View reviewed changes

src/hooks/useSyncFocus/useSyncFocusImplementation.ts Show resolved Hide resolved

hoangzinh reviewed Jan 30, 2025

View reviewed changes

tests/unit/useSyncFocusTest.ts Show resolved Hide resolved

FitseTLT added 2 commits January 30, 2025 18:31

Merge branch 'main' into fix-blue-selection-on-page-refresh

5374ae9

Added another check

189cfb7

hoangzinh approved these changes Jan 31, 2025

View reviewed changes

melvin-bot bot requested a review from cristipaval January 31, 2025 14:42

cristipaval reviewed Feb 4, 2025

View reviewed changes

src/components/SelectionList/BaseSelectionList.tsx Show resolved Hide resolved

cristipaval reviewed Feb 4, 2025

View reviewed changes

added comment

1c9c6a7

cristipaval approved these changes Feb 4, 2025

View reviewed changes

cristipaval merged commit e159fc3 into Expensify:main Feb 4, 2025
18 checks passed

github-actions bot mentioned this pull request Feb 6, 2025

Deploy Checklist: New Expensify 2025-02-06 #56482

Closed

melvin-bot bot mentioned this pull request Feb 11, 2025

[Due for payment 2025-02-18] [$250] Web - Blue selection border on plan option after a refresh #54502

Closed

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix - Web - Blue selection border on plan option after a refresh #54682

Fix - Web - Blue selection border on plan option after a refresh #54682

FitseTLT commented Dec 31, 2024

melvin-bot bot commented Dec 31, 2024

FitseTLT commented Dec 31, 2024

hoangzinh commented Jan 2, 2025

FitseTLT commented Jan 2, 2025

hoangzinh commented Jan 3, 2025 •

edited

Loading

hoangzinh commented Jan 3, 2025 •

edited

Loading

FitseTLT commented Jan 20, 2025

hoangzinh commented Jan 22, 2025

FitseTLT commented Jan 23, 2025

hoangzinh commented Jan 24, 2025

FitseTLT commented Jan 24, 2025

hoangzinh left a comment

hoangzinh left a comment

cristipaval Feb 4, 2025

FitseTLT Feb 4, 2025

cristipaval Feb 4, 2025

OSBotify commented Feb 4, 2025

github-actions bot commented Feb 6, 2025

github-actions bot commented Feb 11, 2025


		return () => removeKeyDownPressListener(setHasKeyBeenPressed);
		}, [setHasKeyBeenPressed]);

	// We need to track whether a key has been pressed to enable focus syncing only if a key has been pressed.
	// This is to avoid the default behavior of web showing blue border on click of items after a page refresh.
	hasKeyBeenPressed.current = true;

Fix - Web - Blue selection border on plan option after a refresh #54682

Fix - Web - Blue selection border on plan option after a refresh #54682

Conversation

FitseTLT commented Dec 31, 2024

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Dec 31, 2024

FitseTLT commented Dec 31, 2024

hoangzinh commented Jan 2, 2025

FitseTLT commented Jan 2, 2025

hoangzinh commented Jan 3, 2025 • edited Loading

Reviewer Checklist

Screenshots/Videos

hoangzinh commented Jan 3, 2025 • edited Loading

FitseTLT commented Jan 20, 2025

hoangzinh commented Jan 22, 2025

FitseTLT commented Jan 23, 2025

hoangzinh commented Jan 24, 2025

FitseTLT commented Jan 24, 2025

hoangzinh left a comment

Choose a reason for hiding this comment

hoangzinh left a comment

Choose a reason for hiding this comment

cristipaval Feb 4, 2025

Choose a reason for hiding this comment

FitseTLT Feb 4, 2025

Choose a reason for hiding this comment

cristipaval Feb 4, 2025

Choose a reason for hiding this comment

OSBotify commented Feb 4, 2025

github-actions bot commented Feb 6, 2025

github-actions bot commented Feb 11, 2025

hoangzinh commented Jan 3, 2025 •

edited

Loading

hoangzinh commented Jan 3, 2025 •

edited

Loading