[HOLD for payment 2024-11-07] [$250] Exit survey response auto-validates without any user action.

[m-natarajan]

If you haven’t already, check out our contributing guidelines for onboarding and email contributors@expensify.com to request to join our Slack channel!

---

Version Number: 9.0.49-0
Reproducible in staging?: yes
Reproducible in production?: yes
If this was caught on HybridApp, is this reproducible on New Expensify Standalone?:
If this was caught during regression testing, add the test name, ID and link from TestRail:
Email or phone of affected tester (no customers):
Logs: https://stackoverflow.com/c/expensify/questions/4856
Expensify/Expensify Issue URL:
Issue reported by: @suneox
Slack conversation: https://expensify.slack.com/archives/C049HHMV9SM/p1729102027380939

Action Performed:

1. Go to settings.
2. Switch to Expensify Classic.
3. Select a reason and click Next.

Expected Result:

On the survey response page, errors should not be shown until the user clicks “Next” or focuses out of the survey response input.

Actual Result:

Upon navigating to the survey response page, the form validates automatically without any user action.

Workaround:

unknown

Platforms:

Which of our officially supported platforms is this issue occurring on?

• Android: Standalone
• Android: HybridApp
• Android: mWeb Chrome
• iOS: Standalone
• iOS: HybridApp
• iOS: mWeb Safari
• MacOS: Chrome / Safari
• MacOS: Desktop

Screenshots/Videos

https://github.com/user-attachments/assets/106a82ee-3f8e-4ab9-9de5-0f64ead0e383

Screen.Recording.2024-10-17.at.00.53.18.mp4

Add any screenshot/video evidence

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~021846936289595366564
• Upwork Job ID: 1846936289595366564
• Last Price Increase: 2024-10-17
• Automatic offers:
• suneox | Reviewer | 104592534

Issue Owner

Current Issue Owner: @

Issue Owner

Current Issue Owner: @bfitzexpensify

[melvin-bot]

Triggered auto assignment to @bfitzexpensify (Bug), see https://stackoverflow.com/c/expensify/questions/14418 for more details. Please add this bug to a GH project, as outlined in the SO.

[abzokhattab]

Edited by proposal-police: This proposal was edited at 2024-10-16 21:57:00 UTC.

Proposal

Please re-state the problem that we are trying to solve in this issue.

Exit survey response auto-validates on blur even though the input is empty

What is the root cause of that problem?

the form auto validates because of the shouldValidateOnBlur here

App/src/pages/settings/ExitSurvey/ExitSurveyResponsePage.tsx

Line 107 in c3c7c7a

shouldValidateOnBlur

What changes do you think we should make in order to solve the problem?

we should disable it shouldValidateOnBlur={false} as we are doing with other similar forms (ex)

optionally we can remove the shouldValidateOnChange since the default value is already true

What alternative solutions did you explore? (Optional)

[suneox]

@bfitzexpensify I’ve reported this issue and have more context on it, so I can assist with reviewing the proposal as a C+.

[truph01]

@suneox Can you reproduce the issue in MacOS: Chrome / Safari?

[suneox]

Can you reproduce the issue in MacOS: Chrome / Safari?

This issue can only be reproduced on MacOS/Safari, iOS/Safari and does not occur on MacOS/Chrome, Android/Chrome

Screen.Recording.2024-10-17.at.01.01.50.mp4

[bernhardoj]

Proposal

Please re-state the problem that we are trying to solve in this issue.

The exit survey input field shows validation error when open the page.

What is the root cause of that problem?

On the page, we have a text input and a ref which calls updateMultilineInputRange.

App/src/pages/settings/ExitSurvey/ExitSurveyResponsePage.tsx

Lines 123 to 131 in 780e09e

	ref={(el: AnimatedTextInputRef) => {
	if (!el) {
	return;
	}
	if (!inputRef.current) {
	updateMultilineInputRange(el);
	}
	inputCallbackRef(el);
	}}

In updateMultilineInputRange, we do 2 things, setting the selection to the last character and scroll the input to the last line.

App/src/libs/updateMultilineInputRange/index.ts

Lines 17 to 24 in 780e09e

	if ('value' in input && typeof input.value === 'string' && input.setSelectionRange) {
	const length = input.value.length;
	if (shouldAutoFocus) {
	(input as HTMLInputElement).setSelectionRange(length, length);
	}
	// eslint-disable-next-line no-param-reassign
	input.scrollTop = input.scrollHeight;
	}

On safari, setting the selection will focus on the input. There is a comment about that but was removed here.

Because we focus the input too early, the input gets blurred which I think is already a known issue which is why we delay an input focus. This is similar to iOS. updateMultilineInputRange has a file for iOS only which immediately focus on the input.

App/src/libs/updateMultilineInputRange/index.ios.ts

Lines 22 to 24 in 780e09e

	if (shouldAutoFocus) {
	input.focus();
	}

So, this issue happens on iOS native too.

Note that the updateMultilineInputRange index.ts file checks for setSelectionRange and value which only exists on web, so basically updateMultilineInputRange is only made for web.

App/src/libs/updateMultilineInputRange/index.ts

Line 17 in 780e09e

if ('value' in input && typeof input.value === 'string' && input.setSelectionRange) {

What changes do you think we should make in order to solve the problem?

As mentioned before, updateMultilineInputRange does 2 things, setting the selection to the last character and scroll the input to the last line. We need to scroll the input to the last line immediately when mounted, but we need to delay setting the selection. The delay is happening inside useAutoFocusInput, so the solution is to duplicate the updateMultilineInputRange logic to useAutoFocusInput.

1. Accept a new param called shouldUpdateMultilineInputRange for useAutoFocusInput.
2. When the input callback ref is called, scroll the textinput
   

   App/src/hooks/useAutoFocusInput.ts

   Lines 52 to 58 in 780e09e

   	const inputCallbackRef = (ref: TextInput | null) => {
   	inputRef.current = ref;
   	if (isInputInitialized) {
   	return;
   	}
   	setIsInputInitialized(true);
   	};

if (shouldUpdateMultilineInputRange && ref && 'scrollTop' in ref) {
    ref.scrollTop = ref.scrollHeight;
}

3. When it's time to focus, set the selection
   

   App/src/hooks/useAutoFocusInput.ts

   Lines 27 to 30 in 780e09e

   	const focusTaskHandle = InteractionManager.runAfterInteractions(() => {
   	inputRef.current?.focus();
   	setIsScreenTransitionEnded(false);
   	});

if (shouldUpdateMultilineInputRange && inputRef.current && 'setSelectionRange' in inputRef.current) {
    const length = inputRef.current.value.length;
    (inputRef.current as HTMLInputElement).setSelectionRange(length, length);
}

4. Change all the ref type to AnimatedTextInputRef to fix the typing.
5. Pass true to useAutoFocusInput.
   

   App/src/pages/settings/ExitSurvey/ExitSurveyResponsePage.tsx

   Line 43 in 780e09e

   const {inputCallbackRef, inputRef} = useAutoFocusInput();

6. Remove updateMultilineInputRange here
   

   App/src/pages/settings/ExitSurvey/ExitSurveyResponsePage.tsx

   Lines 123 to 131 in 780e09e

   	ref={(el: AnimatedTextInputRef) => {
   	if (!el) {
   	return;
   	}
   	if (!inputRef.current) {
   	updateMultilineInputRange(el);
   	}
   	inputCallbackRef(el);
   	}}

For step 2 & 3, we can optionally create a platform-specific file for that to make it cleaner.

[truph01]

Proposal

Please re-state the problem that we are trying to solve in this issue.

Upon navigating to the survey response page, the form validates automatically without any user action.

What is the root cause of that problem?

• In Safari, calling the setSelectionRange function:
  

  App/src/pages/settings/ExitSurvey/ExitSurveyResponsePage.tsx

  Line 128 in 780e09e

  updateMultilineInputRange(el);

  
  always causes the input to focus. This is standard behavior in Safari. If we attempt to set focus earlier, the input blurs, triggering validation logic tied to the onBlur event.

What changes do you think we should make in order to solve the problem?

• We need to make sure, we only call the updateMultilineInputRange if the input is focused.

• So we can remove:

App/src/pages/settings/ExitSurvey/ExitSurveyResponsePage.tsx

Lines 127 to 129 in 780e09e

	if (!inputRef.current) {
	updateMultilineInputRange(el);
	}

then add:

                            onFocus={(el) => {
                                if (hasSetRangeRef.current) {
                                    return;
                                }
                                hasSetRangeRef.current = true;
                                updateMultilineInputRange(inputRef.current);
                            }}

to this. hasSetRangeRef is a ref flag to make sure we only call the set selection range one time.

What alternative solutions did you explore? (Optional)

[melvin-bot]

Job added to Upwork: https://www.upwork.com/jobs/~021846936289595366564

[melvin-bot]

Current assignee @suneox is eligible for the External assigner, not assigning anyone new.

[bfitzexpensify]

Cool, assigned you @suneox

[fasileds]

The error seems to come from how the form validation is configured. Instead of running the validation when the screen opens, we should trigger it only when the "Next" button is clicked. One way to fix this is by using a form validation library like Zod or Yup, and tying the validation logic to the button's onPress event. This way, the validation will only run when the user interacts with the form.

Another option is to manage the error state manually, where we keep error messages in the component’s state and trigger validation only on button click. We could also consider moving all the error handling logic into a separate file to keep the code cleaner and more manageable.

[melvin-bot]

📣 @fasileds! 📣
Hey, it seems we don’t have your contributor details yet! You'll only have to do this once, and this is how we'll hire you on Upwork.
Please follow these steps:

1. Make sure you've read and understood the contributing guidelines.
2. Get the email address used to login to your Expensify account. If you don't already have an Expensify account, create one here. If you have multiple accounts (e.g. one for testing), please use your main account email.
3. Get the link to your Upwork profile. It's necessary because we only pay via Upwork. You can access it by logging in, and then clicking on your name. It'll look like this. If you don't already have an account, sign up for one here.
4. Copy the format below and paste it in a comment on this issue. Replace the placeholder text with your actual details.
   
   Format:

Contributor details
Your Expensify account email: <REPLACE EMAIL HERE>
Upwork Profile Link: <REPLACE LINK HERE>

[fasileds]

https://www.upwork.com/freelancers/~01f528c40dce80e597
fasiledesshmels09@gmail.com

[fasileds]

and if it is only for specific device tell me the device names and i will shear you my thoughts 10Q

[suneox]

@fasileds Welcome to Expensify! First, please take some time to read through the guidelines on how to contribute to this project. This will help you understand the process and expectations for contributing effectively.

[suneox]

@truph01 proposal LGTM it’s a simple solution to handle this issue.

@bernhardoj proposal to separate the logic for setting the selection range and setting the scroll to the bottom immediately, while keeping the current implementation LGTM.

🎀 👀 🎀 C+ reviewed

[melvin-bot]

Triggered auto assignment to @neil-marcellini, see https://stackoverflow.com/c/expensify/questions/7972 for more details.

[bernhardoj]

If we apply the selected solution, the text input scroll to bottom will only happen on focus.

after.mp4

This is how it behaves currently.

curr.mp4

I mentioned this in my proposal too

We need to scroll the input to the last line immediately when mounted, but we need to delay setting the selection.

[suneox]

If we apply the selected solution, the text input scroll to bottom will only happen on focus.

I don’t think it’s a big issue since this behavior currently happens in other areas as well, like in the task description.

ScreenRecording_10-19-2024.01-18-06_1_2.mp4

[bernhardoj]

It happens in task description because it uses a markdown text input, which doesn't have setSelectionRange.

App/src/libs/updateMultilineInputRange/index.ts

Lines 17 to 24 in 66cf824

	if ('value' in input && typeof input.value === 'string' && input.setSelectionRange) {
	const length = input.value.length;
	if (shouldAutoFocus) {
	(input as HTMLInputElement).setSelectionRange(length, length);
	}
	// eslint-disable-next-line no-param-reassign
	input.scrollTop = input.scrollHeight;
	}

We scroll immediately to the bottom to solve this issue. If we are fine to change it back, then I think we can just remove updateMultilineInputRange.

Or we can just take input.scrollTop = input.scrollHeight; and not the setSelectionRange because looks like all platforms by default set the selection to the end already.

[suneox]

We scroll immediately to the bottom to solve this #21654.

@bernhardoj Thanks for pointing out the implementation history. Since we already have issue coverage for the case of setting scrollTop immediately so we can proceed with your solution.

[suneox]

I have updated the selected proposal

cc: @neil-marcellini

[neil-marcellini]

Ok, I'm good with @bernhardoj's proposal too

[melvin-bot]

📣 @suneox 🎉 An offer has been automatically sent to your Upwork account for the Reviewer role 🎉 Thanks for contributing to the Expensify app!

Offer link
Upwork job

[bernhardoj]

PR is ready

cc: @suneox

[mvtglobally]

Issue not reproducible during KI retests. (First week)

[melvin-bot]

Reviewing label has been removed, please complete the "BugZero Checklist".

[melvin-bot]

The solution for this issue has been 🚀 deployed to production 🚀 in version 9.0.55-10 and is now subject to a 7-day regression period 📆. Here is the list of pull requests that resolve this issue:

• Fix exit survey response page validation runs when open #51516

If no regressions arise, payment will be issued on 2024-11-07. 🎊

For reference, here are some details about the assignees on this issue:

• @suneox requires payment automatic offer (Reviewer)
• @bernhardoj requires payment through NewDot Manual Requests
• @suneox requires payment automatic offer (Reviewer)

[melvin-bot]

@suneox @bfitzexpensify The PR fixing this issue has been merged! The following checklist (instructions) will need to be completed before the issue can be closed. Please copy/paste the BugZero Checklist from here into a new comment on this GH and complete it. If you have the K2 extension, you can simply click: [this button]

[suneox]

BugZero Checklist:

• [Contributor] Classify the bug:

Bug classification

Source of bug:

• 1a. Result of the original design (eg. a case wasn't considered)
• 1b. Mistake during implementation
• 1c. Backend bug
• 1z. Other: Missing test

Where bug was reported:

• 2a. Reported on production
• 2b. Reported on staging (deploy blocker)
• 2c. Reported on a PR
• 2z. Other: This issue happen on both staging & production

Who reported the bug:

• 3a. Expensify user
• 3b. Expensify employee
• 3c. Contributor
• 3d. QA
• 3z. Other:

• [Contributor] The offending PR has been commented on, pointing out the bug it caused and why, so the author and reviewers can learn from the mistake.

  Link to comment: https://github.com/Expensify/App/pull/46172/files#r1831458784

• [Contributor] If the regression was CRITICAL (e.g. interrupts a core flow) A discussion in #expensify-open-source has been started about whether any other steps should be taken (e.g. updating the PR review checklist) in order to catch this type of bug sooner.

  Link to discussion: *N/A

• [Contributor] If it was decided to create a regression test for the bug, please propose the regression test steps using the template below to ensure the same bug will not reach production again. I think we don’t need to create a regression test for this bug since it’s not impactful and doesn’t break the user flow.

[bfitzexpensify]

Payment summary:

@suneox to be paid $250 for C+ work - paid via Upwork ✅
@bernhardoj to be paid $250 via NewDot Manual Requests for contributor work

[bernhardoj]

Requested in ND.

[JmillsExpensify]

$250 approved for @bernhardoj