Skip to content

Migrate Forms into NewContactMethodPage #18223

Merged
cristipaval merged 23 commits into
Expensify:mainfrom
dhairyasenjaliya:newContactForm
May 12, 2023
Merged

Migrate Forms into NewContactMethodPage #18223
cristipaval merged 23 commits into
Expensify:mainfrom
dhairyasenjaliya:newContactForm

Conversation

@dhairyasenjaliya

@dhairyasenjaliya dhairyasenjaliya commented May 1, 2023

Copy link
Copy Markdown
Contributor

Details

  • We are adding validation to the new Contact page for checking if the user has inputted the contact method which is already an existing contact then we are displaying the error

Fixed Issues

$ #17997
PROPOSAL: #17997 (comment)

Tests

  1. Go to Settings > Profile > Contact Method
  2. Click on the New contact method button
  3. Enter your current email address in the email field
  4. Click on Add
  5. Verify that the error display The Entered Contact Method already exists.
  • Verify that no errors appear in the JS console

Offline tests

Same as above

QA Steps

  1. Go to Settings > Profile > Contact Method
  2. Click on the New contact method button
  3. Enter your current email address in the email field
  4. Click on Add
  5. Verify that the error display The Entered Contact Method already exists.
  • 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 / Chrome
    • iOS / native
    • iOS / 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 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(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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web web
Mobile Web - Chrome mobile_chrome
Mobile Web - Safari
Desktop Desktop
iOS
Android

@dhairyasenjaliya dhairyasenjaliya requested a review from a team as a code owner May 1, 2023 13:06
@melvin-bot melvin-bot Bot requested review from cristipaval and mollfpr and removed request for a team May 1, 2023 13:06
@MelvinBot

Copy link
Copy Markdown
Contributor

@cristipaval @mollfpr One of you needs to 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]

@dhairyasenjaliya

dhairyasenjaliya commented May 1, 2023

Copy link
Copy Markdown
Contributor Author

hey @mollfpr @cristipaval We are adding a few validation texts here do we need someone to translate for us should I ask in Slack?

en.js ->

Screenshot 2023-05-01 at 7 21 37 PM

es.js ->

Screenshot 2023-05-01 at 7 22 01 PM

@mollfpr mollfpr left a comment

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.

@dhairyasenjaliya Thanks for the quick PR!

A couple of request changes, and for the email/phone input, we should add shouldSaveDraft.

Saving draft values is highly desirable, and we should always try to save draft values. Additionally, we should clear draft data once the form is successfully submitted by calling Onyx.set(ONYXKEY.FORM_ID, null) in the onSubmit callback passed to Form.

For the copy, we can get it faster from the Slack channel.

Comment thread src/ONYXKEYS.js Outdated
Comment thread src/pages/settings/Profile/Contacts/NewContactMethodPage.js Outdated
Comment thread src/pages/settings/Profile/Contacts/NewContactMethodPage.js
inputID="phoneOrEmail"
autoCapitalize="none"
returnKeyType={Permissions.canUsePasswordlessLogins(props.betas) ? 'done' : 'next'}
autoFocus

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 think it's better to use the previous implementation to focus on the input with onTransitionEnd. With this I found it's a bit weird transition with iOS and on Android sometimes the keyboard is not open even the input is focused.

iOS

Simulator.Screen.Recording.-.iPhone.14.-.2023-05-02.at.18.14.28.mp4

Android

Screen.Recording.2023-05-02.at.18.15.45.mov

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.

alright let me quick check this one to use onEntryTransitionEnd

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.

@mollfpr not sure why but I'm not getting ref event on <TextInput>

@dhairyasenjaliya

Copy link
Copy Markdown
Contributor Author

@dhairyasenjaliya Thanks for the quick PR!

A couple of request changes, and for the email/phone input, we should add shouldSaveDraft.

Saving draft values is highly desirable, and we should always try to save draft values. Additionally, we should clear draft data once the form is successfully submitted by calling Onyx.set(ONYXKEY.FORM_ID, null) in the onSubmit callback passed to Form.

For the copy, we can get it faster from the Slack channel.

hm, do you suggest adding shouldSaveDraft to newContact form?

Comment thread src/pages/settings/Profile/Contacts/NewContactMethodPage.js Outdated
Comment thread src/pages/settings/Profile/Contacts/NewContactMethodPage.js
@mollfpr

mollfpr commented May 2, 2023

Copy link
Copy Markdown
Contributor

hm, do you suggest adding shouldSaveDraft to newContact form?

Yes!

@dhairyasenjaliya

Copy link
Copy Markdown
Contributor Author

@dhairyasenjaliya Thanks for the quick PR!
A couple of request changes, and for the email/phone input, we should add shouldSaveDraft.

Saving draft values is highly desirable, and we should always try to save draft values. Additionally, we should clear draft data once the form is successfully submitted by calling Onyx.set(ONYXKEY.FORM_ID, null) in the onSubmit callback passed to Form.

For the copy, we can get it faster from the Slack channel.

hm, do you suggest adding shouldSaveDraft to newContact form?

@mollfpr also where do we need to clear this shouldSaveDraft ?

@mollfpr

mollfpr commented May 2, 2023

Copy link
Copy Markdown
Contributor

@dhairyasenjaliya Could you check if the old input value is not cleared after the form submit success? Also, could you resolve that conflict? Thanks!

@dhairyasenjaliya

Copy link
Copy Markdown
Contributor Author

@mollfpr all query resolve let me know if any further improvement required :)

@mollfpr

mollfpr commented May 3, 2023

Copy link
Copy Markdown
Contributor

@dhairyasenjaliya Thanks!

Another conflict need to solved 😅

@dhairyasenjaliya

Copy link
Copy Markdown
Contributor Author

@mollfpr oop lots of things going on this page 😄 btw Im waiting for translation text do we tag someone ?

@mollfpr

mollfpr commented May 3, 2023

Copy link
Copy Markdown
Contributor

@dhairyasenjaliya I don't know too 😅 @cristipaval can add the label Waiting for Copy, and someone will be pulled to confirm the copy.

@dhairyasenjaliya

dhairyasenjaliya commented May 3, 2023

Copy link
Copy Markdown
Contributor Author

@mollfpr Yeah, we can do that also conflict is resolved & I think PR is ready for merge just waiting for the translation text

@cristipaval

Copy link
Copy Markdown
Contributor

@dhairyasenjaliya Could you please merge the latest main?

@dhairyasenjaliya

Copy link
Copy Markdown
Contributor Author

@cristipaval Sure btw we are just waiting for translation messages

@dhairyasenjaliya

Copy link
Copy Markdown
Contributor Author

@cristipaval conflict resolved do we bump anyone about translating messages? this is only left here

@dhairyasenjaliya

Copy link
Copy Markdown
Contributor Author

@mollfpr @cristipaval all translation messages updated as per suggestion and conflict resolved we should merge this

@cristipaval cristipaval requested a review from mollfpr May 11, 2023 09:54
@dhairyasenjaliya

Copy link
Copy Markdown
Contributor Author

Bump @mollfpr

@mollfpr

mollfpr commented May 11, 2023

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 tests pass on all platforms & I tested again on:
    • Android / native
    • Android / Chrome
    • iOS / native
    • iOS / 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 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 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(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 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

Web
18223.Web.mov
Mobile Web - Chrome
18223.mWeb.Chrome.mov
Mobile Web - Safari
18223.mWeb.Safari.mp4
Desktop
18223.Desktop.mov
iOS
18223.iOS.mp4
Android
Screen.Recording.2023-05-12.at.14.44.31.mov

@mollfpr

mollfpr commented May 11, 2023

Copy link
Copy Markdown
Contributor

I'm running out of time to record the test. I'll try to finish it in the morning.

@dhairyasenjaliya

Copy link
Copy Markdown
Contributor Author

@mollfpr When you get a chance let's complete this before fixing another conflict 😄

@mollfpr

mollfpr commented May 12, 2023

Copy link
Copy Markdown
Contributor

Sorry for the delay @dhairyasenjaliya! The code looks good to me, I just need a record for the Android.

Could you update the test to include the expected is? Like add one more point Verify that the error display The Entered Contact Method already exists.

@mollfpr mollfpr left a comment

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.

LGTM 🚀

@dhairyasenjaliya

Copy link
Copy Markdown
Contributor Author

@mollfpr added

@mollfpr

mollfpr commented May 12, 2023

Copy link
Copy Markdown
Contributor

Completed the checklist! All yours @cristipaval

@cristipaval cristipaval merged commit 2376b77 into Expensify:main May 12, 2023
@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.

@OSBotify

Copy link
Copy Markdown
Contributor

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

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

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.3.14-14 🚀

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


return (Permissions.canUsePasswordlessLogins(props.betas) || password) && (Str.isValidEmail(login) || parsePhoneNumber(phoneLogin).possible);
}, [login, password, props.betas]);
const validate = (values) => {

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.

Coming from #20610:
This was overlooked while doing form refactor.
validate is re-triggered when form is submitted and it caused a small regression: email already exist message appears for a second when go to previous screen.
More details about the root cause: #20610 (comment)

useCallback and original dependencies were added in https://github.com/Expensify/App/pull/17472/files#diff-fe6782071280d20a06400ddd9435c11ea1961b6d8601c9acdc1e42257ad52348R84 and we should have considered this while introducing form and removing useCallback.

const validateNumber = (values) => {
const parsedPhoneNumber = parsePhoneNumber(values);

if (parsedPhoneNumber.possible) {

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.

This line caused a regression in #22819, parsePhoneNumber will treat 1234567890@ as a valid phone number. more context #22819 (comment)

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.

7 participants