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.

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

Refactor the money request creation flow #28618

Merged
merged 282 commits into from
Dec 8, 2023

Conversation

tgolen
Copy link
Contributor

@tgolen tgolen commented Oct 2, 2023

Details

This is a large refactoring for the money request creation flow. It will be done in two phases in an attempt to reduce conflicts with existing components. This PR builds out all the new routes and components while trying to leave as much of the original flows untouched. In a second PR, I will come back and remove all the old components and ensure no changes were missed during development (see this GH for phase 2).

I tried to leave as much of the original functionality untouched, so also be aware that as you review this, it might look like I am writing new code, when in actuality, the code was just copied from the original component. Again, this phase 2 GH lists the old components and their counter parts if you really want to compare the differences.

The main things that changed in this PR are:

  1. All the navigation is done via explicit transactionID and reportID in the URL. This ensures that each component is connected to the correct data.
  2. The data is stored in a transaction in the normal transaction collection (keeping it consistent with the shape of other transactions)
  3. The pages are restructured to be nested inside a single page that renders all the steps (simplifies the route config and helps with verifying permissions and URL params)

Fixed Issues

$ #26538

Tests

  1. Create a new workspace (or ensure you have an existing one)
  2. Create all three types of money requests: manual, scan, distance (distance can only be done with the workspace)
  3. Create them from both the global + menu as well as the + button on the chat composer in an existing message
  4. Try creating splits as well
  5. Try editing all the fields on the confirmation page
  6. Verify that everything works as normal with no regressions
  • Verify that no errors appear in the JS console

Offline tests

Same as the above

QA Steps

Same as the above

  • 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 I struggled to create distance requests. It seems the map kept causing Chrome to crash in my Android emulator
    • 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
      • 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

Web

2023-10-12_14-00-24
2023-10-12_14-01-17

Mobile Web - Chrome

2023-10-12_15-43-25

I struggled to create distance requests. It seems the map kept causing Chrome to crash in my Android emulator.

Mobile Web - Safari

image

image

Desktop

2023-10-12_15-30-33
2023-10-12_15-31-15

iOS

2023-10-12_15-43-22
image

Android

2023-10-12_15-34-12
2023-10-12_15-39-00

@tgolen tgolen self-assigned this Oct 2, 2023
@parasharrajat
Copy link
Member

We missed to handle one case #32865

[reportID, transactionID],
);

const goToNextStep = useCallback(() => {
Copy link
Contributor

Choose a reason for hiding this comment

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

We missed that the participants needed to be reset here (as was done in MoneyRequestParticipantsPage previously), this caused #33067 where tags and categories were not resetting when switching workspace for a request. More details here.

Comment on lines +86 to +88
return isPolicyExpenseChat ? OptionsListUtils.getPolicyExpenseReportOption(participant) : OptionsListUtils.getParticipantsOption(participant, personalDetails);
})
.filter((participant) => !!participant.login || !!participant.text)
Copy link
Contributor

Choose a reason for hiding this comment

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

This reverted #32166 which caused #33151

lat: null,
lng: null,
address: waypointValue,
name: values.name,
Copy link
Contributor

Choose a reason for hiding this comment

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

Coming from #33505

We didn't provide a fallback value, as we did in the "old flow".

@@ -49,7 +49,7 @@ function EditRequestAmountPage({defaultAmount, defaultCurrency, onNavigateToCurr
>
<HeaderWithBackButton title={translate('iou.amount')} />
<MoneyRequestAmountForm
isEditing
Copy link
Contributor

Choose a reason for hiding this comment

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

This removal caused #33011

getRoute: (iouType: ValueOf<typeof CONST.IOU.TYPE>, transactionID: string, reportID: string) => `create/${iouType}/confirmation/${transactionID}/${reportID}/` as const,
},
MONEY_REQUEST_STEP_AMOUNT: {
route: 'create/:iouType/amount/:transactionID/:reportID/',
Copy link
Member

Choose a reason for hiding this comment

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

Coming from #33205 (comment)

The routes added here have a trailing /. It lead to inconsistenecy because our routes don't have trailing slashes.

There was also a bug that broke "go back" because our code didn't handle trailing slashes.

return ErrorUtils.getLatestErrorField(transaction, 'route');
}

if (_.size(validatedWaypoints) < 2) {
Copy link
Member

Choose a reason for hiding this comment

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

Coming from #29895 (comment).

We missed a case when consecutive duplicate waypoints are present for more than 2 waypoints.

Comment on lines +657 to +660
{shouldShowDate && (
<MenuItemWithTopDescription
shouldShowRightIcon={!isReadOnly}
title={iouCreated || format(new Date(), CONST.DATE.FNS_FORMAT_STRING)}
Copy link
Contributor

Choose a reason for hiding this comment

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

Coming from #33751 , this led to a regression where the order of menu items is incorrect. The correct order is :

  1. Distance
  2. Date


// If we have a receipt let's start the split bill by creating only the action, the transaction, and the group DM if needed
if (iouType === CONST.IOU.TYPE.SPLIT && receiptFile) {
const existingSplitChatReportID = CONST.REGEX.NUMBER.test(reportID) ? reportID : '';
Copy link
Collaborator

Choose a reason for hiding this comment

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

We are passing the randomly generated reportID as existingSplitChatReportID cause a regression more details here #34060 (comment)


const {unit, rate, currency} = mileageRate;
const distance = lodashGet(transaction, 'routes.route0.distance', 0);
const shouldCalculateDistanceAmount = isDistanceRequest && iouAmount === 0;
Copy link
Contributor

Choose a reason for hiding this comment

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

Coming from #34226, the amount remains unchanged when a user modifies the endpoint using the distance option on the confirmation page.shouldCalculateDistanceAmount prevents recalculation of the correct amount.

<StepScreenWrapper
headerTitle={policyTagListName}
onBackButtonPress={navigateBack}
shouldShowWrapper
Copy link
Contributor

Choose a reason for hiding this comment

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

This pages was not restricted, An employee can access in a paid IOU the tag selection menu via a URL request we should show a not found page for this case

Comment on lines +49 to +57
useEffect(() => {
if (!trackRef.current) {
return;
}

trackRef.current.applyConstraints({
advanced: [{torch: torchOn}],
});
}, [torchOn]);
Copy link
Contributor

Choose a reason for hiding this comment

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

On native the torch is enabled only while taking a photo. This code made mWeb turn the torch on indefinitely causing inconsistency.

return;
}

camera.current
Copy link
Contributor

Choose a reason for hiding this comment

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

Coming from this issue #36520, It's an edge case that we haven't covered yet. This is an async function, so we need to return it in order to work with useSingleExecution to avoid user tap multiple times

<View style={styles.flex1}>
<DraggableList
data={waypointsList}
keyExtractor={(item) => item}
Copy link
Contributor

Choose a reason for hiding this comment

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

This might have caused this #40105

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.