Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix:blank page appears in validate code form page #55588

Open
wants to merge 21 commits into
base: main
Choose a base branch
from
Open

fix:blank page appears in validate code form page #55588

wants to merge 21 commits into from
+121 −19

Conversation

jacobkim9881
Copy link
Contributor

@jacobkim9881 jacobkim9881 commented Jan 22, 2025 •
edited
Loading

Explanation of Change

This PR replaces <ValidateCodeActionModal> with <ValidateCodeActionWithoutModal> in ContactMethodDetailsPage as it creates <ValidateCodeActionWithoutModal> component. This component doesn't have HeaderWithBackButton or Modal so it can be used in any page that needs validate code form but it can uses props for <ValidateCodeActionModal>.

Fixed Issues

$ #53884
PROPOSAL:$ #53884 (comment)

Tests

  • Verify that no errors appear in the JS console

Preparation

  1. Go to "Settings" bottom tab -> Profile -> ContactMethod.
  2. Click "New contact method" at bottom in RHP.
  3. Put Email address and click "Add".
  4. Put numbers to validate the email.

Test

  1. Click one of contact methods from Preparation 4.
  2. Check there is blank modal briefly.

Test2

  1. Click default contact methods.
  2. Check there is blank modal briefly.

Test3

  1. Click validated contact methods.
  2. Check there is blank modal briefly.

Offline tests

Preparation

  1. Go to "Settings" bottom tab -> Profile -> ContactMethod.
  2. Click "New contact method" at bottom in RHP.
  3. Put Email address and click "Add".
  4. Put numbers to validate the email.

Test

  1. Click one of contact methods from Preparation 4.
  2. Check there is blank modal briefly.

Test2

  1. Click default contact methods.
  2. Check there is blank modal briefly.

Test3

  1. Click validated contact methods.
  2. Check there is blank modal briefly.

QA Steps

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

  • Verify that no errors appear in the JS console

Preparation

  1. Go to "Settings" bottom tab -> Profile -> ContactMethod.
  2. Click "New contact method" at bottom in RHP.
  3. Put Email address and click "Add".
  4. Put numbers to validate the email.

Test

  1. Click one of contact methods from Preparation 4.
  2. Check there is blank modal briefly.

Test2

  1. Click default contact methods.
  2. Check there is blank modal briefly.

Test3

  1. Click validated contact methods.
  2. Check there is blank modal briefly.

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 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
expensify-test15-2025-01-29_05.23.39.mp4
Android: mWeb Chrome
expensify-test16-2025-01-29_05.28.07.mp4
iOS: Native
2025-01-29.5.18.03.mov
iOS: mWeb Safari
2025-01-29.5.19.48.mov
MacOS: Chrome / Safari
expensify-test14-2025-01-29_05.12.06.mp4
MacOS: Desktop
2025-01-29.5.30.16.mov

@jacobkim9881
Copy link
Contributor Author

@hoangzinh Another issue from other branch bother testing. Should we handle this bug too?(If we don't then we can't test on iOS)

2025-01-28.3.18.24.mov

Process:

  1. Click default contact method or validated one.
  2. Navigate back and click the one again.
  3. Can not enter contact method.

@jacobkim9881
Copy link
Contributor Author

jacobkim9881 commented Jan 28, 2025 •
edited
Loading

App/src/pages/settings/Profile/Contacts/ContactMethodDetailsPage.tsx

Lines 171 to 173 in 433778f

useEffect(() => {
resetContactMethodValidateCodeSentState(contactMethod);
}, [contactMethod]);

This line makes this issue

cc: @nkdengineer

@jacobkim9881 jacobkim9881 marked this pull request as ready for review January 28, 2025 20:36
@jacobkim9881 jacobkim9881 requested a review from a team as a code owner January 28, 2025 20:36
@melvin-bot melvin-bot bot requested review from hoangzinh and removed request for a team January 28, 2025 20:36
@melvin-bot Melvin Bot
Copy link

melvin-bot bot commented Jan 28, 2025

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

@hoangzinh
Copy link
Contributor

@jacobkim9881 is it reproducible if we click on "unverified" contact method in the 1st step?

@jacobkim9881
Copy link
Contributor Author

jacobkim9881 commented Jan 29, 2025 •
edited
Loading

@hoangzinh It isn't reproducible if clicking 1st time so it isn't unrelated with the PR. Thanks for clarifying!

hoangzinh
hoangzinh reviewed Jan 30, 2025
View reviewed changes
src/components/ValidateCodeActionWithoutModal.tsx

type ValidateCodeActionProps = ValidateCodeActionModalProps & ValidateCodeActionWithoutModalProps;

function ValidateCodeActionWithoutModal({
Copy link
Contributor

Choose a reason for hiding this comment

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

Do you have any other names for this component? It seems is not a good name.

src/pages/settings/Profile/Contacts/ContactMethodDetailsPage.tsx
<ScrollView keyboardShouldPersistTaps="handled">
<ScrollView
keyboardShouldPersistTaps="handled"
contentContainerStyle={themeStyles.flex1}
Copy link
Contributor

Choose a reason for hiding this comment

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

can you elaborate why do we need this style?

src/pages/settings/Profile/Contacts/ContactMethodDetailsPage.tsx Outdated
{!loginData?.validatedDate && (
<ValidateCodeActionWithoutModal
hasMagicCodeBeenSent={hasMagicCodeBeenSent}
isVisible={isValidateCodeActionModalVisible && !loginData.validatedDate && !!loginData}
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we should control the visibility of this component in line 323 instead of a prop. What do you think?

src/pages/settings/Profile/Contacts/ContactMethodDetailsPage.tsx Outdated

{!isValidateCodeActionModalVisible && getMenuItems()}
{!isValidateCodeActionModalVisible && !!loginData?.validatedDate && getMenuItems()}
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you elaborate why do we need add an extra condition here?

src/components/ValidateCodeActionWithoutModal.tsx
Comment on lines +37 to +52
useEffect(
() => () => {
firstRenderRef.current = true;
},
[],
);

useEffect(() => {
if (!firstRenderRef.current || !isVisible || hasMagicCodeBeenSent) {
return () => {
clearError();
};
}
firstRenderRef.current = false;
sendValidateCode();
}, [isVisible, sendValidateCode, hasMagicCodeBeenSent, clearError]);
Copy link
Contributor

Choose a reason for hiding this comment

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

If it's not a modal. Do we need firstRenderRef or isVisible anymore?

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

@hoangzinh hoangzinh hoangzinh left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@jacobkim9881 @hoangzinh