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

[Report Creation UI] Create entrypoint for Report creation flow. #57847

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

Conversation

SzymczakJ
Copy link
Contributor

@SzymczakJ SzymczakJ commented Mar 5, 2025

Explanation of Change

Fixed Issues

$ #57651
$ #57653
PROPOSAL:

Tests

To test you need to have tableReportView beta enabled.

  1. (Prerequisite: account with no paid workspace with chat enabled) Open FAB and click on 'Create report', make sure it opens up a redirect to Old Dot modal.
  2. (Prerequisite: account with at least two paid workspaces with chat enabled) Open FAB and click on 'Create report'. Make sure it redirects to workspace selection screen.
  3. Make sure that after selecting a workspace we are redirected to SearchMoneyRequestReportPage(it's empty at the moment).
  4. Make sure that after clicking back button, user is redirected to whatever page he started Create report flow.
  5. (Prerequisite: account with only one workspace with chat enabled) Make sure that the workspace selection page is skipped and report is created and user is redirected to SearchMoneyRequestReportPage.

Offline tests

QA Steps

Same as tests.

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
android.mov
Android: mWeb Chrome
iOS: Native
ios.mov
iOS: mWeb Safari
mwebIos.mov
MacOS: Chrome / Safari
web.mov
MacOS: Desktop
web.mov

@mountiny mountiny self-requested a review March 5, 2025 22:30
@mountiny mountiny changed the title Create entrypoint for Report creation flow. [Report Creation UI] Create entrypoint for Report creation flow. Mar 5, 2025
@SzymczakJ SzymczakJ marked this pull request as ready for review March 7, 2025 11:20
@SzymczakJ SzymczakJ requested a review from a team as a code owner March 7, 2025 11:20
@melvin-bot melvin-bot bot requested review from DylanDylann and removed request for a team March 7, 2025 11:20
Copy link

melvin-bot bot commented Mar 7, 2025

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

@luacmartins luacmartins self-requested a review March 7, 2025 11:45
@luacmartins
Copy link
Contributor

@DylanDylann let's prioritize reviewing this PR when you're online since this is a critical one

@shawnborton
Copy link
Contributor

I think the RHP is temporary, right? Either way, we can probably kill the second "Create report" here since the RHP header says it clearly:
CleanShot 2025-03-07 at 14 21 44@2x

@DylanDylann
Copy link
Contributor

I will submit my review by end of day today. If any unexpected delays occur, I guarantee completion by Monday.

@SzymczakJ
Copy link
Contributor Author

SzymczakJ commented Mar 7, 2025

kill the second "Create report" here since the RHP header says it clearly

Sorry I just applied wrong translation path, when cleaning up the code, this will be "Choose a workspace for this report." as Tom suggested here https://swmansion.slack.com/archives/C08ERETRDBK/p1741008093144109?thread_ts=1740954704.217869&cid=C08ERETRDBK

@trjExpensify
Copy link
Contributor

@SzymczakJ in the video from the OP, does that account not have a default workspace selected?

optimisticDataValue.ownerAccountID = accountID;
}

const optimisticData: OnyxUpdate[] = [
Copy link
Contributor

Choose a reason for hiding this comment

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

there should be optimistic report preview too cc @trjExpensify

Copy link
Contributor Author

Choose a reason for hiding this comment

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

FYI I added optimistic report preview.

@DylanDylann
Copy link
Contributor

DylanDylann commented Mar 8, 2025

BUG: "owes $0.00" displays on the report header

Screenshot 2025-03-08 at 19 33 20


const {stateNum, statusNum} = getExpenseReportStateAndStatus(policy);

const optimisticDataValue: OptimisticNewReport = {
Copy link
Contributor

Choose a reason for hiding this comment

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

This action follows offline pattern B, so I think we need to add pending action to the optimistic report

API.write(
WRITE_COMMANDS.CREATE_APP_REPORT,
{reportName, type: CONST.REPORT.TYPE.EXPENSE, policyID, reportID: optimisticReportID, reportActionID},
{optimisticData, successData: [], failureData: []},
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 need to add an error on failure data to handle the failure case

Screenshot 2025-03-08 at 19 43 25

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I added pending action and failure data, but it's not used anywhere yet, so let's not focus on it so much. I'm planning to make it better in next issue: #57654, in which I'll use offline and failure data.

@shawnborton
Copy link
Contributor

Also to note, based on this screenshot here:
image

If a report is in the main content view, nothing in the LHN should be highlighted or given the "active" treatment.

@SzymczakJ
Copy link
Contributor Author

As for @trjExpensify comment(#57847 (comment)):

@SzymczakJ in the video from the OP, does that account not have a default workspace selected?

Yes, this account has a default workspace, should we add some kind default marker in this case? Why do you ask?

@SzymczakJ
Copy link
Contributor Author

As for @shawnborton comment(#57847 (comment)): I was planning to fix that in a next issue which is adding empty state to report view and merge this issue as fast as possible, since it's blocking our next tasks.
So can we address issues regarding Report view UI side in the issue that I linked?

@SzymczakJ SzymczakJ force-pushed the @szymczak/start-create-report-flow branch from 3b4b3d8 to f8e88f2 Compare March 10, 2025 11:44
@SzymczakJ
Copy link
Contributor Author

Fixed your comments @DylanDylann!

@trjExpensify
Copy link
Contributor

Yes, this account has a default workspace, should we add some kind default marker in this case? Why do you ask?

If the default workspace is a group workspace we should not show the selector. We just create the report on the default workspace. The only time we show the selector is in the edge case of:

  • User's default workspace is set to the personal workspace
  • User also has multiple group workspaces, so we can't "guess" which one to use.

@shawnborton
Copy link
Contributor

So can we address issues regarding Report view UI side in the issue that I linked?

I'm cool with that, as long as we have a plan to fix it :)

@SzymczakJ
Copy link
Contributor Author

Yes, this account has a default workspace, should we add some kind default marker in this case? Why do you ask?

If the default workspace is a group workspace we should not show the selector. We just create the report on the default workspace. The only time we show the selector is in the edge case of:

  • User's default workspace is set to the personal workspace
  • User also has multiple group workspaces, so we can't "guess" which one to use.

Alright, now I understand this 😄. Fixed the logic the way you wanted!

@mountiny
Copy link
Contributor

@DylanDylann Are you able to do another review?

Copy link
Contributor

@luacmartins luacmartins left a comment

Choose a reason for hiding this comment

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

Looking good. Left a few small comments

@@ -81,7 +81,7 @@ const ROUTES = {
SEARCH_MONEY_REQUEST_REPORT: {
route: 'search/report/:reportID',
getRoute: ({reportID, backTo}: {reportID: string; backTo?: string}) => {
const baseRoute = `search/view/${reportID}` as const;
const baseRoute = `search/report/${reportID}` as const;
Copy link
Contributor

Choose a reason for hiding this comment

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

We're changing this to /r to be consistent with other routes. Discussed in https://expensify.slack.com/archives/C07NMDKEFMH/p1741479977432699

Suggested change
const baseRoute = `search/report/${reportID}` as const;
const baseRoute = `search/r/${reportID}` as const;

return;
}

// If the users default workspace is personal and user has more than one group workspace which is paid and has chat enabled, we need to redirect them to workspace selection screen
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
// If the users default workspace is personal and user has more than one group workspace which is paid and has chat enabled, we need to redirect them to workspace selection screen
// If the user's default workspace is personal and the user has more than one group workspace which is paid and has chat enabled, we need to redirect them to the workspace selection screen

return;
}

// If the users default workspace is paid group workspace with chat enabled, we create a report with it by default
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
// If the users default workspace is paid group workspace with chat enabled, we create a report with it by default
// If the user's default workspace is a paid group workspace with chat enabled, we create a report with it by default


const optimisticData: OnyxUpdate[] = [
{
onyxMethod: Onyx.METHOD.SET,
Copy link
Contributor

Choose a reason for hiding this comment

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

Why are we using SET here and below?

const optimisticReportID = generateReportID();
const reportActionID = rand64();
// eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
const reportName = `${creatorPersonalDetails.firstName || 'User'}'s report`;
Copy link
Contributor

Choose a reason for hiding this comment

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

This should use the policy's default report name rule stored in policy.fieldList.text_title.defaultValue

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