Fix company's website step is skipped #46940

bernhardoj · 2024-08-07T06:48:40Z

Details

The website step on bank account setup is skipped. This PR fix it.

Fixed Issues

$ #45283
PROPOSAL: #45283 (comment)

Tests

Same as QA Steps

Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

Go to workspace settings > Workflows
Click Connect bank account > Connect manually
Proceed to Step 4 - Enter Company's Tax ID page
Enter Tax ID > Next
Verify the website step is shown with the placeholder value (https://) is shown
Enter an invalid website
Go back
Press Next again
Verify the website step is shown

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 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.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(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.
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.mweb.mp4

iOS: Native

ios.mp4

iOS: mWeb Safari

ios.mweb.mp4

MacOS: Chrome / Safari

web.mp4

MacOS: Desktop

desktop.mp4

melvin-bot · 2024-08-07T06:48:44Z

Hey! I see that you made changes to our Form component. Make sure to update the docs in FORMS.md accordingly. Cheers!

melvin-bot · 2024-08-07T06:48:45Z

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

bernhardoj · 2024-08-07T07:02:33Z

src/components/Form/FormProvider.tsx

@@ -249,7 +253,7 @@ function FormProvider(
            } else if (inputProps.shouldUseDefaultValue && inputProps.defaultValue !== undefined && inputValues[inputID] === undefined) {
                // We force the form to set the input value from the defaultValue props if there is a saved valid value
                inputValues[inputID] = inputProps.defaultValue;
-            } else if (inputValues[inputID] === undefined) {


I just did some testing to see if this change affects other forms in the app and I found an issue in the money request merchant page.

e.mp4

From the video above, you can see that when I try to clear the merchant, the value always reverted back to the saved merchant, so, I believe we can't change this to check for an empty string.

I have reverted this change and instead reset the website to undefined instead of an empty string.

suneox · 2024-08-07T08:21:42Z

src/pages/ReimbursementAccount/utils/getInitialSubstepForBusinessInfo.ts

@@ -15,7 +16,7 @@ function getInitialSubstepForBusinessInfo(data: CompanyStepProps): number {
        return 1;
    }

-    if (data[businessInfoStepKeys.COMPANY_WEBSITE] === '') {
+    if (data[businessInfoStepKeys.COMPANY_WEBSITE] === '' || !ValidationUtils.isValidWebsite(data[businessInfoStepKeys.COMPANY_WEBSITE])) {


Suggested change

if (data[businessInfoStepKeys.COMPANY_WEBSITE] === '' || !ValidationUtils.isValidWebsite(data[businessInfoStepKeys.COMPANY_WEBSITE])) {

if (!ValidationUtils.isValidWebsite(data[businessInfoStepKeys.COMPANY_WEBSITE])) {

Function isValidWebsite also cover an empty string

Cool, updated!

suneox · 2024-08-07T08:24:20Z

src/pages/workspace/WorkspaceResetBankAccountModal.tsx

-            onConfirm={() => BankAccounts.resetFreePlanBankAccount(bankAccountID, session, achData?.policyID ?? '-1', user)}
+            onConfirm={() => BankAccounts.resetFreePlanBankAccount(bankAccountID, session, achData?.policyID ?? '-1')}


Could you please explain this change?

The user is used before for the default website.

App/src/libs/actions/ReimbursementAccount/resetFreePlanBankAccount.ts

Line 101 in 7b18ac5

[INPUT_IDS.BUSINESS_INFO_STEP.COMPANY_WEBSITE]: getDefaultCompanyWebsite(session, user),

suneox · 2024-08-07T18:52:15Z

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 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.
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-08-08.at.01.46.21.mp4

Android: mWeb Chrome

Screen.Recording.2024-08-08.at.01.48.02.mp4

iOS: Native

Screen.Recording.2024-08-08.at.01.45.43.mp4

iOS: mWeb Safari

Screen.Recording.2024-08-08.at.01.43.27.mp4

MacOS: Chrome / Safari

Screen.Recording.2024-08-08.at.01.40.29.mp4

MacOS: Desktop

Screen.Recording.2024-08-08.at.01.39.46.mp4

suneox · 2024-08-07T18:56:24Z

src/libs/actions/ReimbursementAccount/resetFreePlanBankAccount.ts

@@ -98,7 +97,7 @@ function resetFreePlanBankAccount(bankAccountID: number | undefined, session: On
                        [INPUT_IDS.BUSINESS_INFO_STEP.STATE]: '',
                        [INPUT_IDS.BUSINESS_INFO_STEP.ZIP_CODE]: '',
                        [INPUT_IDS.BUSINESS_INFO_STEP.COMPANY_PHONE]: '',
-                        [INPUT_IDS.BUSINESS_INFO_STEP.COMPANY_WEBSITE]: getDefaultCompanyWebsite(session, user),
+                        [INPUT_IDS.BUSINESS_INFO_STEP.COMPANY_WEBSITE]: undefined,


Suggested change

[INPUT_IDS.BUSINESS_INFO_STEP.COMPANY_WEBSITE]: undefined,

[INPUT_IDS.BUSINESS_INFO_STEP.COMPANY_WEBSITE]: '',

NAB: The defaultCompanyWebsite has changed from ?? to || so we can use empty string for that case

The value reset here is for the form draft, so it does have no effect on defaultCompanyWebsite. If we use an empty string, then the default value won't be applied.

App/src/components/Form/FormProvider.tsx

Lines 252 to 255 in 53eee53

} else if (inputValues[inputID] === undefined) {

// We want to initialize the input value if it's undefined

inputValues[inputID] = inputProps.defaultValue ?? getInitialValueByType(inputProps.valueType);

}

I updated the defaultCompanyWebsite from ?? to || because reimbursementAccount?.achData?.website is a string, so I think it's safer to use ||. Do you think we should just revert that?

@bernhardoj I got it, we can revert change the defaultCompanyWebsite from ?? to || and keep this change

NAB: Would null be better to remove the key from Onyx?

suneox

LGTM, with just a minor change request that’s not a blocker.

neil-marcellini

The code looks good and it looks like it tests well. Thanks.

neil-marcellini · 2024-08-08T23:13:22Z

src/libs/actions/ReimbursementAccount/resetFreePlanBankAccount.ts

@@ -98,7 +97,7 @@ function resetFreePlanBankAccount(bankAccountID: number | undefined, session: On
                        [INPUT_IDS.BUSINESS_INFO_STEP.STATE]: '',
                        [INPUT_IDS.BUSINESS_INFO_STEP.ZIP_CODE]: '',
                        [INPUT_IDS.BUSINESS_INFO_STEP.COMPANY_PHONE]: '',
-                        [INPUT_IDS.BUSINESS_INFO_STEP.COMPANY_WEBSITE]: getDefaultCompanyWebsite(session, user),
+                        [INPUT_IDS.BUSINESS_INFO_STEP.COMPANY_WEBSITE]: undefined,


NAB: Would null be better to remove the key from Onyx?

OSBotify · 2024-08-08T23:32:39Z

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

Beamanator · 2024-08-14T20:54:05Z

FYI I believe this was deployed to prod yesterday, from this checklist - #47219

fix website step is skipped

f525a3e

bernhardoj requested a review from a team as a code owner August 7, 2024 06:48

melvin-bot bot requested a review from suneox August 7, 2024 06:48

melvin-bot bot removed the request for review from a team August 7, 2024 06:48

bernhardoj added 2 commits August 7, 2024 15:01

only checks for undefined

9e530a0

reset website to undefined

297c05a

bernhardoj commented Aug 7, 2024

View reviewed changes

linter

0628d37

suneox reviewed Aug 7, 2024

View reviewed changes

remove unnecessary checks

60a5bdd

suneox reviewed Aug 7, 2024

View reviewed changes

suneox approved these changes Aug 7, 2024

View reviewed changes

melvin-bot bot requested a review from neil-marcellini August 7, 2024 19:01

bernhardoj added 2 commits August 8, 2024 23:37

Merge branch 'main' into fix/45283-company-step-is-skipped

bf68bbb

use ?? back

e4f0616

neil-marcellini approved these changes Aug 8, 2024

View reviewed changes

neil-marcellini merged commit 76ac5b5 into Expensify:main Aug 8, 2024
17 checks passed

github-actions bot mentioned this pull request Aug 12, 2024

Deploy Checklist: New Expensify 2024-08-12 #47219

Closed

90 tasks

NikkiWines mentioned this pull request Aug 12, 2024

[HOLD for payment 2024-08-20] Bank account - Unable to proceed after website step when website is auto populated #47227

Closed

6 tasks

bernhardoj mentioned this pull request Oct 8, 2024

[CP Staging] Fix company website field is blank on confirmation page if it is not modified #48731

Merged

50 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix company's website step is skipped #46940

Fix company's website step is skipped #46940

bernhardoj commented Aug 7, 2024

melvin-bot bot commented Aug 7, 2024

melvin-bot bot commented Aug 7, 2024

bernhardoj Aug 7, 2024

suneox Aug 7, 2024

bernhardoj Aug 7, 2024

suneox Aug 7, 2024

bernhardoj Aug 7, 2024

suneox commented Aug 7, 2024

suneox Aug 7, 2024

bernhardoj Aug 8, 2024

suneox Aug 8, 2024

bernhardoj Aug 8, 2024

neil-marcellini Aug 8, 2024

suneox left a comment

neil-marcellini left a comment

neil-marcellini Aug 8, 2024

OSBotify commented Aug 8, 2024

Beamanator commented Aug 14, 2024

	if (data[businessInfoStepKeys.COMPANY_WEBSITE] === '' \|\| !ValidationUtils.isValidWebsite(data[businessInfoStepKeys.COMPANY_WEBSITE])) {
	if (!ValidationUtils.isValidWebsite(data[businessInfoStepKeys.COMPANY_WEBSITE])) {

		onConfirm={() => BankAccounts.resetFreePlanBankAccount(bankAccountID, session, achData?.policyID ?? '-1', user)}
		onConfirm={() => BankAccounts.resetFreePlanBankAccount(bankAccountID, session, achData?.policyID ?? '-1')}

	[INPUT_IDS.BUSINESS_INFO_STEP.COMPANY_WEBSITE]: undefined,
	[INPUT_IDS.BUSINESS_INFO_STEP.COMPANY_WEBSITE]: '',

	} else if (inputValues[inputID] === undefined) {
	// We want to initialize the input value if it's undefined
	inputValues[inputID] = inputProps.defaultValue ?? getInitialValueByType(inputProps.valueType);
	}

Fix company's website step is skipped #46940

Fix company's website step is skipped #46940

Conversation

bernhardoj commented Aug 7, 2024

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Aug 7, 2024

melvin-bot bot commented Aug 7, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

suneox commented Aug 7, 2024

Reviewer Checklist

Screenshots/Videos

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

suneox left a comment

Choose a reason for hiding this comment

neil-marcellini left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

OSBotify commented Aug 8, 2024

Beamanator commented Aug 14, 2024