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

Tweaks to the expense flow #53760

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

Conversation

JKobrynski
Copy link
Contributor

@JKobrynski JKobrynski commented Dec 9, 2024

Explanation of Change

Implement the requirements specified in this comment

FYI

Screen title changes that were specified in the above comment were already implemented thus they are not included in this PR.

Fixed Issues

$ #52981
PROPOSAL: N/A

Tests

  1. Log into the app
  2. Click on the + button
  3. Select the Create expense option
  4. Choose the Manual expense
  5. Provide an expense value
  6. Navigate to the next step
  7. Make sure the Just track it (don't submit it) option row is not visible
  8. Verify if there is a Workspace and Personal section
  9. Test if you can submit an expenses to workspaces, recents, contacts and to yourself
  10. Verify the button on the Confirm details screen says "Create amount expense"
  • Verify that no errors appear in the JS console

Offline tests

Same as Tests section above

QA Steps

Same as Tests section 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: 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
    • 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
android-compressed.webm
Android: mWeb Chrome
chrome-compressed.webm
iOS: Native
ios-compressed.mp4
iOS: mWeb Safari
safari-compressed.mp4
MacOS: Chrome / Safari
MacOS: Desktop

@JKobrynski JKobrynski marked this pull request as ready for review December 10, 2024 16:12
@JKobrynski JKobrynski requested a review from a team as a code owner December 10, 2024 16:12
@melvin-bot melvin-bot bot requested review from suneox and removed request for a team December 10, 2024 16:12
Copy link

melvin-bot bot commented Dec 10, 2024

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

src/languages/es.ts Outdated Show resolved Hide resolved
Copy link
Contributor

🚧 @trjExpensify has triggered a test build. You can view the workflow run here.

Copy link
Contributor

@shawnborton
Copy link
Contributor

@trjExpensify is there a separate PR that just gets rid of the Track & Submit options and replaces it with the Create flow? Wasn't sure if we were doing that here or elsewhere. cc @anmurali for thoughts too

@shawnborton
Copy link
Contributor

Idea for the future: whenever we have the "Default" badge for the default workspace in the Workspaces list from Settings, we should consider adding it here too on the right side of the workspace row?
CleanShot 2024-12-11 at 14 05 22@2x

@trjExpensify
Copy link
Contributor

That's a neat idea!

@trjExpensify
Copy link
Contributor

@trjExpensify is there a separate PR that just gets rid of the Track & Submit options and replaces it with the Create flow? Wasn't sure if we were doing that here or elsewhere. cc @anmurali for thoughts too

Separate PR & issue here: #53952

@trjExpensify
Copy link
Contributor

@JKobrynski is this ready for a re-review?

@JKobrynski
Copy link
Contributor Author

@trjExpensify not yet! Should be ready tomorrow

@JKobrynski
Copy link
Contributor Author

@trjExpensify I created a orderWorkspaceOptions method that puts the default workspace on top of the list and added it to orderOptions, it should be fine now.

@JKobrynski JKobrynski requested a review from mountiny December 20, 2024 09:30
@trjExpensify
Copy link
Contributor

@suneox can you re-review today please? Thanks!

@suneox
Copy link
Contributor

suneox commented Dec 20, 2024

@suneox can you re-review today please? Thanks!

Yes, I'll continue the checklist within a few hours

@trjExpensify
Copy link
Contributor

Great stuff, thanks! @JKobrynski looks like TypeScript Checks are failing?

@JKobrynski JKobrynski force-pushed the JKobrynski/feat/tweaks-to-create-expense-flow branch from 289a95c to d56d865 Compare December 20, 2024 12:53
let workspaceChats: ReportUtils.OptionData[] = [];

if (shouldSeparateWorkspaceChat) {
workspaceChats = allReportOptions.filter((option) => option.isOwnPolicyExpenseChat);
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
workspaceChats = allReportOptions.filter((option) => option.isOwnPolicyExpenseChat);
workspaceChats = allReportOptions.filter((option) => option.isOwnPolicyExpenseChat && !option.private_isArchived);

We need to filter out archived workspaces.

Screenshot 2024-12-20 at 19 57 11

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated, thanks!

@suneox
Copy link
Contributor

suneox commented Dec 20, 2024

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 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.ts 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.
  • For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this 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.
  • 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-12-20.at.21.29.51.mp4
Android: mWeb Chrome
Screen.Recording.2024-12-20.at.21.17.15.mp4
iOS: Native
Screen.Recording.2024-12-20.at.21.10.17.mp4
iOS: mWeb Safari
Screen.Recording.2024-12-20.at.20.30.24.mp4
MacOS: Chrome / Safari
Screen.Recording.2024-12-20.at.20.26.40.mp4
MacOS: Desktop
Screen.Recording.2024-12-20.at.21.02.42.mp4

Comment on lines 1977 to 1979
if (typeof config?.maxRecentReportsToShow === 'number' && filteredWorkspaceChats && filteredWorkspaceChats?.length > config.maxRecentReportsToShow) {
filteredWorkspaceChats = filteredWorkspaceChats.slice(0, config.maxRecentReportsToShow);
}
Copy link
Contributor

Choose a reason for hiding this comment

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

@trjExpensify Should we set a limitation to show for the workspace list similar to recent reports, or show all available workspace options like in this demo?

Screen.Recording.2024-12-20.at.21.14.58.mp4

Copy link
Contributor

Choose a reason for hiding this comment

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

I would think we'd always show all workspaces there... for most people it would be uncommon to have a ton of workspaces like you are showing above.

Copy link
Contributor

Choose a reason for hiding this comment

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

Same, agreed!

Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks for the confirmation. @JKobrynski we can remove this condition.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done!

Copy link
Contributor

@suneox suneox left a comment

Choose a reason for hiding this comment

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

The changes LGTM. Just only need confirmation on the configuration for the number of workspace options to display.

@melvin-bot melvin-bot bot requested a review from grgia December 20, 2024 14:46
grgia
grgia previously approved these changes Dec 20, 2024
Copy link
Contributor

@grgia grgia left a comment

Choose a reason for hiding this comment

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

This is testing well, nice work!

@grgia
Copy link
Contributor

grgia commented Dec 20, 2024

@JKobrynski could you fix conflicts 🙏

@JKobrynski
Copy link
Contributor Author

Conflicts resolved!

Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

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

I would like to double check the correct default values based on the new guidelines. I am not sure if this is correct cc @suneox

@@ -492,7 +496,7 @@ function getIOUReportIDOfLastAction(report: OnyxEntry<Report>): string | undefin
* Get the last message text from the report directly or from other sources for special cases.
*/
function getLastMessageTextForReport(report: OnyxEntry<Report>, lastActorDetails: Partial<PersonalDetails> | null, policy?: OnyxEntry<Policy>): string {
const reportID = report?.reportID ?? '-1';
const reportID = report?.reportID ?? String(CONST.DEFAULT_NUMBER_ID);
Copy link
Contributor

Choose a reason for hiding this comment

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

Looking at this we should never default to string value cc @VickyStash

Suggested change
const reportID = report?.reportID ?? String(CONST.DEFAULT_NUMBER_ID);
const reportID = report?.reportID;

Copy link
Contributor

@VickyStash VickyStash Dec 23, 2024

Choose a reason for hiding this comment

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

@mountiny Correct!
Also, this file is in the list of ignored files as it can be tricky to update it directly, so you should be able to skip id updates here and the lint will pass on its own.

Copy link
Contributor

Choose a reason for hiding this comment

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

@JKobrynski would you be able to update this please?

@@ -548,9 +552,16 @@ function getLastMessageTextForReport(report: OnyxEntry<Report>, lastActorDetails
lastMessageTextFromReport = ReportUtils.getReimbursementDeQueuedActionMessage(lastReportAction, report, true);
} else if (ReportActionUtils.isDeletedParentAction(lastReportAction) && ReportUtils.isChatReport(report)) {
lastMessageTextFromReport = ReportUtils.getDeletedParentActionMessageForChatReport(lastReportAction);
} else if (ReportActionUtils.isPendingRemove(lastReportAction) && ReportActionUtils.isThreadParentMessage(lastReportAction, report?.reportID ?? '-1')) {
} else if (ReportActionUtils.isPendingRemove(lastReportAction) && ReportActionUtils.isThreadParentMessage(lastReportAction, report?.reportID ?? String(CONST.DEFAULT_NUMBER_ID))) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Same as above https://github.com/Expensify/App/blob/main/contributingGuides/STYLE.md#default-value-for-inexistent-ids

Suggested change
} else if (ReportActionUtils.isPendingRemove(lastReportAction) && ReportActionUtils.isThreadParentMessage(lastReportAction, report?.reportID ?? String(CONST.DEFAULT_NUMBER_ID))) {
} else if (ReportActionUtils.isPendingRemove(lastReportAction) && ReportActionUtils.isThreadParentMessage(lastReportAction, report?.reportID)) {

} else if (ReportUtils.isReportMessageAttachment({text: report?.lastMessageText ?? '-1', html: report?.lastMessageHtml, translationKey: report?.lastMessageTranslationKey, type: ''})) {
} else if (
ReportUtils.isReportMessageAttachment({
text: report?.lastMessageText ?? String(CONST.DEFAULT_NUMBER_ID),
Copy link
Contributor

Choose a reason for hiding this comment

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

Same as above, I am not sure if I am misunderstanding the guidelines. It just feels like the empty string might be better here

Suggested change
text: report?.lastMessageText ?? String(CONST.DEFAULT_NUMBER_ID),
text: report?.lastMessageText ?? '',

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 eslint check even shouldn't complain on this place, as it's not ID.
@JKobrynski Correct me if I'm wrong.

}: GetOptionsConfig = {},
): Options {
const topmostReportId = Navigation.getTopmostReportId() ?? '-1';
const topmostReportId = Navigation.getTopmostReportId() ?? String(CONST.DEFAULT_NUMBER_ID);
Copy link
Contributor

Choose a reason for hiding this comment

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

Here the same

Suggested change
const topmostReportId = Navigation.getTopmostReportId() ?? String(CONST.DEFAULT_NUMBER_ID);
const topmostReportId = Navigation.getTopmostReportId();

@@ -1234,7 +1278,7 @@ function getValidOptions(
const shouldShowInvoiceRoom =
includeInvoiceRooms &&
ReportUtils.isInvoiceRoom(reportOption.item) &&
ReportUtils.isPolicyAdmin(reportOption.policyID ?? '', policies) &&
ReportUtils.isPolicyAdmin(reportOption.policyID ?? String(CONST.DEFAULT_NUMBER_ID), policies) &&
Copy link
Contributor

Choose a reason for hiding this comment

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

We should return early in the method if the value is undefined

Suggested change
ReportUtils.isPolicyAdmin(reportOption.policyID ?? String(CONST.DEFAULT_NUMBER_ID), policies) &&
ReportUtils.isPolicyAdmin(reportOption.policyID), policies) &&

isSelected: member.isSelected ?? false,
isDisabled: member.isDisabled ?? false,
accountID,
login: member.login ?? '',
icons: member.icons,
pendingAction: member.pendingAction,
reportID: member.reportID ?? '-1',
reportID: member.reportID ?? String(CONST.DEFAULT_NUMBER_ID),
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
reportID: member.reportID ?? String(CONST.DEFAULT_NUMBER_ID),
reportID: member.reportID,

@@ -168,7 +158,7 @@ function MoneyRequestParticipantsSelector({

const formatResults = OptionsListUtils.formatSectionsFromSearchTerm(
debouncedSearchTerm,
participants.map((participant) => ({...participant, reportID: participant.reportID ?? '-1'})),
participants.map((participant) => ({...participant, reportID: participant.reportID ?? String(CONST.DEFAULT_NUMBER_ID)})),
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
participants.map((participant) => ({...participant, reportID: participant.reportID ?? String(CONST.DEFAULT_NUMBER_ID)})),
participants.map((participant) => ({...participant, reportID: participant.reportID})),

@VickyStash
Copy link
Contributor

@JKobrynski is OOO till Dec 27th 🎄

@JKobrynski
Copy link
Contributor Author

@mountiny I removed these string id fallbacks according to your comments, feel free to give it another look!

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.

8 participants