Skip to content

fix: cursor lag during typing on mWeb SignIn page#60941

Merged
Valforte merged 6 commits into
Expensify:mainfrom
Eskalifer1:fix-60401
Apr 29, 2025
Merged

fix: cursor lag during typing on mWeb SignIn page#60941
Valforte merged 6 commits into
Expensify:mainfrom
Eskalifer1:fix-60401

Conversation

@Eskalifer1
Copy link
Copy Markdown
Contributor

@Eskalifer1 Eskalifer1 commented Apr 26, 2025

Explanation of Change

Fixed Issues

$ #60401
PROPOSAL: #60401 (comment)

Tests

  1. Navigate to the sign in page
  2. In the "Phone or email" field type in a quick manner several characters, eg 14253648463, watch how the cursor moves
  3. Delete characters in a quick manner, tapping the "x" button, watch how the cursor moves
    (Same as in Issue)
    A few console errors related to canBeMissing are present, but they are irrelevant to this PR.
  • Verify that no errors appear in the JS console

Offline tests

  1. Navigate to the sign in page
  2. In the "Phone or email" field type in a quick manner several characters, eg 14253648463, watch how the cursor moves
  3. Delete characters in a quick manner, tapping the "x" button, watch how the cursor moves
    (Same as in Issue)

QA Steps

// TODO: These must be filled out, or the issue title must include "[No QA]."
Same as tests

  • 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 verified there are no new alerts related to the canBeMissing param for useOnyx
  • 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 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 used JaimeGPT to get English > Spanish translation. I then posted it 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 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 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.ts 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(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.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user 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.

Screenshots/Videos

Android: Native
android.mp4
Android: mWeb Chrome
android-web.mp4
iOS: Native
ios.mp4
iOS: mWeb Safari
ios-web.mp4
MacOS: Chrome / Safari
web.mp4
MacOS: Desktop
desktop.mp4

@Eskalifer1 Eskalifer1 requested a review from a team as a code owner April 26, 2025 10:37
@melvin-bot melvin-bot Bot requested review from hungvu193 and removed request for a team April 26, 2025 10:37
@melvin-bot
Copy link
Copy Markdown

melvin-bot Bot commented Apr 26, 2025

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

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 26, 2025

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

@Eskalifer1
Copy link
Copy Markdown
Contributor Author

I have read the CLA Document and I hereby sign the CLA

const [login, setLoginState] = useState(() => Str.removeSMSDomain(credentials?.login ?? ''));

const setLogin = useCallback((newLogin: string) => {
setLoginState(Str.removeSMSDomain(newLogin));
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we need to removeSMSDomain everytime we change the login. setLoginState(newLogin) is just enough.
Can you explain?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I agree with you, I just wasn't sure if it was needed in setLogin, so I added it just in case.

I will update the PR now

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool. Let's do it.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@hungvu193 I have a question, today before doing the PR I checked for eslint errors and there were none (I called it with the npm run lint-changed command). Now I call this command and I get 13 errors, even though they don't even refer to parts of my code, what could be the problem?

Do I need to fix them? Because I see that there are no new changes related to eslint or these pages on the main branch that would be related to this code

Знімок екрана 2025-04-26 о 20 21 54

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For example, an error is thrown on this line, although it is not related to my code and is identical to the code on the main branch

const [account] = useOnyx(ONYXKEYS.ACCOUNT);

I don't have access to Slack to ask (I sent the request about 3 weeks ago) :)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Eskalifer1 You still need to fix the lint, I know that wasn't related to your changes.

With Onyx linting, you can simply pass {canBeMissing: true}

//ie

const [network] = useOnyx(ONYXKEYS.NETWORK, {canBeMissing: true});

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, I'll try to do it now, it looks pretty strange, because this code hasn't been touched for a long time, and when I did the PR, these errors were not there)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah yeah. We have a new ESlint rule about onyx and import syntax but it will only check for changed files. Becasue the source code is huge, we can't refactor in one go, so checking lint for changed files will be better

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@hungvu193 Updated PR with eslint and your proposal changes. I apologize if something is wrong, this is my first PR, so I still don't know a lot)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No worries.

Comment thread src/pages/signin/SignInPage.tsx Outdated
Comment on lines +354 to +369
function SignInPageLoginWrapper(props: SignInPageProps, ref: ForwardedRef<SignInPageRef>) {
return (
<LoginProvider>
<SignInPageWithRef
ref={ref}
// eslint-disable-next-line react/jsx-props-no-spreading
{...props}
/>
</LoginProvider>
);
}

SignInPageLoginWrapper.displayName = 'SignInPage';

const SignInPageLoginWrapperWithRef = forwardRef(SignInPageLoginWrapper);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't need this one right? This isn't very clear to me because we already forwardRef above:

const SignInPageWithRef = forwardRef(SignInPage);

Then we did it again here:

const SignInPageLoginWrapperWithRef = forwardRef(SignInPageLoginWrapper);

How about removing this block of code and just wrapping LoginProider insideSignInPageThemeWrapper?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I mentioned this here: #60401 (comment)

As for me, the SignInPageThemeWrapper should be responsible only for the theme, as the name suggests, so I added a new Wrapper that is responsible for waking up the login. If you need, I can rework it, just let me know

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or we can just rename it to SignInPageWrapper, and then add the provider for Login

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see. Then I think just wrap it inside SignInPage then? Like you mentioned here:
#60401 (comment)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In my opinion, this will ruin the clean code a bit, because then the rendering of the component and its Wrapper will be mixed. But it's up to you to decide. It seems to me that the best option, if we are not satisfied with another separate wrapper (as I did in the PR), is to rename ThemeWrapper simply to Wrapper, then this new component will be responsible not only for the theme, but also for everything else. The final say is still yours :)

Copy link
Copy Markdown
Contributor

@hungvu193 hungvu193 Apr 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is to rename ThemeWrapper simply to Wrapper

I think this makes sense. Wdyt?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think so. I tried to separate the logic so as not to mix Providers that are responsible for different things with each other, but we can combine everything into one component if it is acceptable

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool. I think we only have Provider related to theme before, that's why we named it ThemeProvider, but now we have one more, so renaming it to wrapper will make it cleaner. Let's do it.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, I'll update the PR now

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@hungvu193 Updated PR

@hungvu193
Copy link
Copy Markdown
Contributor

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 that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
  • 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-04-26.at.23.12.13.mov
Android: mWeb Chrome
Screen.Recording.2025-04-26.at.23.13.37.mov
iOS: Native
Screen.Recording.2025-04-26.at.23.08.47.mov
iOS: mWeb Safari
Screen.Recording.2025-04-26.at.23.07.36.mov
MacOS: Chrome / Safari
Screen.Recording.2025-04-26.at.22.48.38.mov
MacOS: Desktop
Screen.Recording.2025-04-26.at.23.06.37.mov

Copy link
Copy Markdown
Contributor

@hungvu193 hungvu193 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@melvin-bot melvin-bot Bot requested a review from Valforte April 26, 2025 18:30
Valforte
Valforte previously approved these changes Apr 28, 2025
Copy link
Copy Markdown
Contributor

@Valforte Valforte left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGMT!

@Eskalifer1
Copy link
Copy Markdown
Contributor Author

Hi everyone, should i do something else now?

@hungvu193
Copy link
Copy Markdown
Contributor

All good here. In case there is regression you should fix it. As for now, you don't need to do anything

@Eskalifer1
Copy link
Copy Markdown
Contributor Author

Okay, thx

@Valforte
Copy link
Copy Markdown
Contributor

@Eskalifer1 can you merge main into your branch? That will fix the ESLint error

@github-actions
Copy link
Copy Markdown
Contributor

⚠️ This PR is possibly changing native code and/or updating libraries, it may cause problems with HybridApp. Please check if any patch updates are required in the HybridApp repo and run an AdHoc build to verify that HybridApp will not break. Ask Contributor Plus for help if you are not sure how to handle this. ⚠️

@hungvu193
Copy link
Copy Markdown
Contributor

@Eskalifer1 Looks like a bad merge 0c930ec

Can you check please?

@Eskalifer1
Copy link
Copy Markdown
Contributor Author

@Valforte Hi, I've merged main to the branch, as you said

@Eskalifer1
Copy link
Copy Markdown
Contributor Author

@hungvu193 Yes, I updated, for some reason it created this as a separate commit and not as a merge, but I've already fixed it

@dubielzyk-expensify
Copy link
Copy Markdown
Contributor

Does this need a design review?

@Valforte
Copy link
Copy Markdown
Contributor

@dubielzyk-expensify no, ill remove the tag

@Valforte Valforte removed the request for review from a team April 29, 2025 12:00
@hungvu193
Copy link
Copy Markdown
Contributor

We have some lintings 🤔 But I don't think it's related to this PR.

@Eskalifer1
Copy link
Copy Markdown
Contributor Author

We have some lintings 🤔 But I don't think it's related to this PR.

It looks like it, but these files with errors have nothing to do with the login page where the changes were made

@hungvu193
Copy link
Copy Markdown
Contributor

can you merge main again? @Eskalifer1

@Valforte
Copy link
Copy Markdown
Contributor

I checked and those are already fixed in main, so a merge is supposed to fix it

@Eskalifer1
Copy link
Copy Markdown
Contributor Author

@hungvu193 Updated PR

Copy link
Copy Markdown
Contributor

@Valforte Valforte left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@Valforte Valforte merged commit 93657d2 into Expensify:main Apr 29, 2025
16 checks passed
@OSBotify
Copy link
Copy Markdown
Contributor

✋ 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
Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/Valforte in version: 9.1.38-0 🚀

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

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 1, 2025

🚀 Deployed to production by https://github.com/thienlnam in version: 9.1.38-4 🚀

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants