useSubStep hook #30426

Swor71 · 2023-10-26T11:26:35Z

Details

Added useSubStep hook to manage navigation between sub steps

Fixed Issues

$ #30239
PROPOSAL:

Tests

Verify that no errors appear in the JS console

Offline tests

QA Steps

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
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
- 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 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 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

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

src/hooks/useSubStep.js

melvin-bot · 2023-10-27T09:04:01Z

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

src/hooks/useSubStep.js

…dded tests

Swor71 · 2023-10-27T13:03:39Z

@shubham1206agra please be aware that I've just pushed a change that introduces a function to go back to previous screen and screenIndex as these are required by the navigation flow.

shubham1206agra · 2023-10-28T09:21:44Z

I have one question here about the moveTo function.
When you use the moveTo function in between the process and then press next. Where should the screen go?
To the last step or the step where we previously were.

Swor71 · 2023-10-30T10:00:46Z

I have one question here about the moveTo function. When you use the moveTo function in between the process and then press next. Where should the screen go? To the last step or the step where we previously were.

@shubham1206agra
moveTo will be used from the confirmation page in order to edit a specific sub step, it will then take the user back to the confirmation page (last step)

shubham1206agra · 2023-10-30T11:46:48Z

@Swor71 Do we need to put any check for this in moveTo function?
If not, I will approve the PR

Swor71 · 2023-10-30T12:22:03Z

@Swor71 Do we need to put any check for this in moveTo function? If not, I will approve the PR

@shubham1206agra
the check for that is in the nextScreen function based on isEditing boolean so I think we should be good as is

…-hook

shubham1206agra · 2023-10-31T05:08:12Z

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

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

shubham1206agra · 2023-10-31T05:11:20Z

Since the error is unrelated, I am going to approve this request.
@mountiny Can you check the updated function and update the same in the docs, please?

mountiny

Thanks! just come comments for styles but please address that in another PR for the project, its minor

mountiny · 2023-10-31T16:06:05Z

src/hooks/useSubStep.js

+import PropTypes from 'prop-types';
+
+const propTypes = {
+    /** an array of substep components */


Could you fix this in next PR but the prop comments usually are capitalized

mountiny · 2023-10-31T16:10:39Z

src/hooks/useSubStep.js

+    /** an array of substep components */
+    bodyContent: PropTypes.arrayOf(PropTypes.element).isRequired,
+
+    /** an index of the component from bodyContent array to start from */


Same as above

mountiny · 2023-10-31T16:10:46Z

src/hooks/useSubStep.js

+    /** an index of the component from bodyContent array to start from */
+    onFinished: PropTypes.func.isRequired,
+
+    /** a callback to be fired when pressing Confirm on the last substep screen */


Same as above

add: useSubStep hook and some basic tests

79e9a6c

Swor71 changed the title ~~add: useSubStep hook and some basic tests~~ useSubStep hook and some basic tests Oct 26, 2023

Swor71 changed the title ~~useSubStep hook and some basic tests~~ useSubStep hook Oct 26, 2023

fabioh8010 reviewed Oct 26, 2023

View reviewed changes

src/hooks/useSubStep.js Outdated Show resolved Hide resolved

src/hooks/useSubStep.js Outdated Show resolved Hide resolved

src/hooks/useSubStep.js Outdated Show resolved Hide resolved

add: descriptions for jsdoc properties

f4ddc30

Swor71 marked this pull request as ready for review October 27, 2023 09:03

Swor71 requested a review from a team as a code owner October 27, 2023 09:03

melvin-bot bot requested review from shubham1206agra and removed request for a team October 27, 2023 09:03

shubham1206agra reviewed Oct 27, 2023

View reviewed changes

src/hooks/useSubStep.js Outdated Show resolved Hide resolved

shubham1206agra reviewed Oct 27, 2023

View reviewed changes

src/hooks/useSubStep.js Outdated Show resolved Hide resolved

shubham1206agra reviewed Oct 27, 2023

View reviewed changes

src/hooks/useSubStep.js Outdated Show resolved Hide resolved

Swor71 added 2 commits October 27, 2023 13:12

change: jsdoc comments

3b2c54e

add: prevScreen method and screenIndex to the return from the hook, a…

f76e933

…dded tests

fix: jsdoc on screenIndex

bd3f397

Merge branch 'vit-tieredBankAccountFlow' into marcin/30239-useSubStep…

92dbaea

…-hook

shubham1206agra approved these changes Oct 31, 2023

View reviewed changes

melvin-bot bot requested a review from mountiny October 31, 2023 05:10

MrMuzyk mentioned this pull request Oct 31, 2023

feat: PersonalInfo Step #30576

Merged

59 tasks

mountiny assigned Swor71 Oct 31, 2023

mountiny approved these changes Oct 31, 2023

View reviewed changes

mountiny merged commit 5046ed2 into Expensify:vit-tieredBankAccountFlow Oct 31, 2023
16 checks passed

shubham1206agra mentioned this pull request Feb 26, 2024

[HOLD for payment 2024-03-08] Implement Tiered Business Bank Account flow #22901

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

useSubStep hook #30426

useSubStep hook #30426

Swor71 commented Oct 26, 2023

melvin-bot bot commented Oct 27, 2023

Swor71 commented Oct 27, 2023

shubham1206agra commented Oct 28, 2023

Swor71 commented Oct 30, 2023

shubham1206agra commented Oct 30, 2023

Swor71 commented Oct 30, 2023 •

edited

Loading

shubham1206agra commented Oct 31, 2023 •

edited

Loading

shubham1206agra commented Oct 31, 2023

mountiny left a comment

mountiny Oct 31, 2023

mountiny Oct 31, 2023

mountiny Oct 31, 2023

useSubStep hook #30426

useSubStep hook #30426

Conversation

Swor71 commented Oct 26, 2023

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Oct 27, 2023

Swor71 commented Oct 27, 2023

shubham1206agra commented Oct 28, 2023

Swor71 commented Oct 30, 2023

shubham1206agra commented Oct 30, 2023

Swor71 commented Oct 30, 2023 • edited Loading

shubham1206agra commented Oct 31, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

shubham1206agra commented Oct 31, 2023

mountiny left a comment

Choose a reason for hiding this comment

mountiny Oct 31, 2023

Choose a reason for hiding this comment

mountiny Oct 31, 2023

Choose a reason for hiding this comment

mountiny Oct 31, 2023

Choose a reason for hiding this comment

Swor71 commented Oct 30, 2023 •

edited

Loading

shubham1206agra commented Oct 31, 2023 •

edited

Loading