Add QAB for Create report flow #59167

SzymczakJ · 2025-03-26T15:27:49Z

Explanation of Change

Fixed Issues

$ #57657
PROPOSAL:

Tests

To test you need to have tableReportView beta enabled and a paid workspace with chat enabled.

Create report with "Create Report" FAB menu.
Make sure that after that a Quick action appears in FAB and it's Create Report action with the name of workspace in subtitle.

3. Make sure that clicking on quick action is creating another report just like Create Report FAB button was doing. Prerequisite: have multiple paid workspaces with chat enabled and the default workspace is not a paid workspace with chat enabled(so that you are redirected to workspace selection) 4. Create report with a chosen workspace. 5. Use Quick action and make sure the report is created with the workspace you selected in the previous step. Prerequisite: have a default workspace that has a is past payment period and you cannot request money with it. 6. Create report with "Create Report" FAB menu.(this is not yet restricted since it's behind BETA, we will restrict it later) 7. Make sure that the create report action is restricted. 8. Test all other quick actions to make sure nothing got broken.

Offline tests

QA Steps

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

Same as tests

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2025-03-27.at.15.43.28.mov

Android: mWeb Chrome

iOS: Native

Screen.Recording.2025-03-27.at.15.32.24.mov

iOS: mWeb Safari

MacOS: Chrome / Safari

Screen.Recording.2025-03-27.at.15.18.48.mov

MacOS: Desktop

sumo-slonik · 2025-03-27T14:10:10Z

src/libs/actions/QuickActionNavigation.ts

        case CONST.QUICK_ACTIONS.TRACK_MANUAL:
        case CONST.QUICK_ACTIONS.TRACK_SCAN:
        case CONST.QUICK_ACTIONS.TRACK_DISTANCE:
            selectOption(() => startMoneyRequest(CONST.IOU.TYPE.TRACK, reportID, requestType, true), false);
+            return;
+        case CONST.QUICK_ACTIONS.CREATE_REPORT:
+            selectOption(() => createNewReport(currentUserPersonalDetails, policyID), true);
            break;


It can be changed to 'return' here to maintain consistency.

There's a linter rule prohibiting it for some reason :(. But I will change everything to break, so that it's consistent.

works!, but what's the issue that it throws?

sumo-slonik · 2025-03-27T14:24:42Z

src/libs/actions/Report.ts

        {optimisticData, successData, failureData},
    );
+    Navigation.navigate(ROUTES.SEARCH_MONEY_REQUEST_REPORT.getRoute({reportID: optimisticReportID, backTo: Navigation.getActiveRoute()}), {forceReplace: shouldForceReplaceScreen});


Good idea to move it here 😊

I feel that we should do it in the page rather than here, it's mostly what we have been following in the application NAB though, @mountiny thoughts ?

this is mainly because we later add conditional navigation to the routes, it's better to do it in the page than passing a new prop altogether

I was reluctant to add Navigation import to QuickActionNavigation.ts but after all, that doesn't seem so bad. I'll do it the way you suggest.

src/languages/es.ts

melvin-bot · 2025-03-27T15:11:13Z

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

mountiny · 2025-03-27T17:12:48Z

@thesahindia this is handled as part of the project

github-actions · 2025-03-27T17:14:21Z

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

mountiny · 2025-03-27T17:17:06Z

src/libs/actions/Report.ts

@@ -2528,6 +2528,15 @@ function buildNewReportOptimisticData(policy: OnyxEntry<Policy>, reportID: strin
            key: `${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${parentReport?.reportID}`,
            value: {[reportActionID]: optimisticReportPreview},
        },
+        {
+            onyxMethod: Onyx.METHOD.SET,


why do we use SET in all of these, I think we should just use Merge

@allgandalf can you think of a reason to use Set for these instead of Merge?

I found some comments from the previous implementation:

App/src/libs/actions/Report.ts

Lines 1012 to 1013 in 92a5a89

// Change the method to set for new reports because it doesn't exist yet, is faster,

// and we need the data to be available when we navigate to the chat page

Some quick docs from the upstream repo:

https://github.com/Expensify/react-native-onyx/blob/f8711eeac668020d93fb96d9c867cdd42eb50433/README.md?plain=1#L87-L93

It says:

Use set() when you need to delete an Onyx key completely from storage

Use set() when you need to completely reset an object or array of data

I say merge should be better here no than set, lets see what the authors thought process was

Every onyx data update(there's about 18 of them) of ONYXKEYS.NVP_QUICK_ACTION_GLOBAL_CREATE is a SET, for sake of consistence I also used SET.
That might be a good explanation, why we always use SET:

Use set() when you need to completely reset an object or array of data

new Quick Action is something different, that the old one and no stale data should be left, so using SET seems reasonable to me.

Right, but at the same time we only use the same keys so nothing stale would be left behind. NAB

mountiny · 2025-03-27T17:39:43Z

tests/unit/QuickActionNavigationTest.ts

Can you please add a test for the expected onyx data when the createReport action is executed? same when it fails

Automated tests are the new normal 😌

allgandalf · 2025-03-27T17:51:21Z

src/libs/actions/QuickActionNavigation.ts

+    policyID: string | undefined,
+    selectOption: (onSelected: () => void, shouldRestrictAction: boolean) => void,
+) {
+    const quickActionReportID = `${quickAction?.chatReportID ?? CONST.DEFAULT_NUMBER_ID}`;


If report ID is not present we pass it as undefined, so that the onyx gets the correct value, please update this one, let the undefined value be passed and deal with it whereever type check throws error

src/libs/actions/QuickActionNavigation.ts

github-actions · 2025-03-27T17:55:32Z

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖	iOS 🍎
❌ FAILED ❌	❌ FAILED ❌
The QR code can't be generated, because the Android build failed	The QR code can't be generated, because the iOS build failed
Android Hybrid 🤖🔄	iOS Hybrid 🍎🔄
N/A	N/A
N/A	N/A
Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/59167/NewExpensify.dmg	https://59167.pr-testing.expensify.com

👀 View the workflow run that generated this build 👀

SzymczakJ · 2025-03-28T10:33:13Z

Fixed comments and added test cases, all yours @allgandalf!

allgandalf · 2025-03-28T11:42:13Z

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 that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
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.2025-03-28.at.5.55.46.PM.mov

Android: mWeb Chrome

Screen.Recording.2025-03-28.at.5.55.02.PM.mov

iOS: Native

Screen.Recording.2025-03-28.at.5.57.27.PM.mov

iOS: mWeb Safari

Screen.Recording.2025-03-28.at.5.58.17.PM.mov

MacOS: Chrome / Safari

Screen.Recording.2025-03-28.at.5.48.57.PM.mov

MacOS: Desktop

Screen.Recording.2025-03-28.at.5.52.07.PM.mov

mountiny · 2025-03-28T11:40:12Z

src/libs/actions/Report.ts

@@ -2528,6 +2528,15 @@ function buildNewReportOptimisticData(policy: OnyxEntry<Policy>, reportID: strin
            key: `${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${parentReport?.reportID}`,
            value: {[reportActionID]: optimisticReportPreview},
        },
+        {
+            onyxMethod: Onyx.METHOD.SET,


Right, but at the same time we only use the same keys so nothing stale would be left behind. NAB

mountiny · 2025-03-28T11:43:24Z

tests/unit/QuickActionNavigationTest.ts

+            navigateToQuickAction(true, {action: CONST.QUICK_ACTIONS.ASSIGN_TASK, targetAccountID: 123}, {accountID: 1234}, undefined, (onSelected: () => void) => {
+                onSelected();
+            });
+            expect(startOutCreateTaskQuickAction).toHaveBeenCalled();


I think we should add a test where we ensure the QAB data was correctly set in onyx

agree ^, but not blocking my review for this

allgandalf · 2025-03-28T12:14:42Z

Why does the header change ? Can't we set it optimistically ?

Screen.Recording.2025-03-28.at.5.45.00.PM.mov

SzymczakJ · 2025-03-28T12:16:43Z

It's getting fixed in empty state PR.

allgandalf

Test LGTM!

mountiny · 2025-03-28T16:45:12Z

tests/actions/ReportTest.ts

+                    Onyx.disconnect(connection);
+
+                    // Then the quickAction.action should be set to CREATE_REPORT
+                    expect(quickAction?.action).toBe(CONST.QUICK_ACTIONS.CREATE_REPORT);


For future pr could you also assert the report id

OSBotify · 2025-03-28T16:53:29Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

github-actions · 2025-03-31T10:43:19Z

🚀 Deployed to staging by https://github.com/mountiny in version: 9.1.21-0 🚀

platform	result
🖥 desktop 🖥	success ✅
🕸 web 🕸	success ✅
🤖 android 🤖	success ✅
🍎 iOS 🍎	success ✅

izarutskaya · 2025-03-31T11:23:06Z

@SzymczakJ How we can enable it?

To test you need to have tableReportView beta enabled and a paid workspace with chat enabled.

mountiny · 2025-03-31T12:28:58Z

@izarutskaya all your applause test emails on the domain have the beta enabled already

izarutskaya · 2025-03-31T18:54:58Z

@mountiny What means this precondition, could you please explain this? Thank you

Prerequisite: have a default workspace that has a is past payment period and you cannot request money with it.

mountiny · 2025-03-31T20:07:22Z

@izarutskaya I think that means you had free trial on a workspace, did not put billing card on it and the trial expired so you cannot create new billable actions

izarutskaya · 2025-03-31T21:37:30Z

@mountiny I think we can't check this PR as applause account don' have free trial. We can see this only on gmail, but it's not in beta. Gmail accounts are restricted once the trial has expired, not Expensifail accounts. Let me know please if I something missed.

mountiny · 2025-04-01T14:26:44Z

All good, we will test it in the full walkthrough before releasing the feature

SzymczakJ · 2025-04-01T14:31:55Z

Sorry, for not responding earlier, @mountiny explained that correctly.

github-actions · 2025-04-01T15:02:11Z

🚀 Deployed to production by https://github.com/grgia in version: 9.1.21-3 🚀

platform	result
🖥 desktop 🖥	success ✅
🕸 web 🕸	success ✅
🤖 android 🤖	failure ❌
🍎 iOS 🍎	success ✅

add QAB optimistic data

422ec4d

trjExpensify mentioned this pull request Mar 27, 2025

[Due for payment 2025-04-08] [Report Creation UI] Add “Create report” action and quick action button and FAB #57657

Closed

clean up Create Report QAB

3ae66bd

SzymczakJ changed the title ~~[WIP] Add QAB for Create report flow~~ Add QAB for Create report flow Mar 27, 2025

sumo-slonik approved these changes Mar 27, 2025

View reviewed changes

fix PR comments

92a5a89

SzymczakJ marked this pull request as ready for review March 27, 2025 15:11

SzymczakJ requested a review from a team as a code owner March 27, 2025 15:11

melvin-bot bot requested review from thesahindia and removed request for a team March 27, 2025 15:11

mountiny removed the request for review from thesahindia March 27, 2025 17:12

mountiny assigned SzymczakJ Mar 27, 2025

mountiny requested a review from allgandalf March 27, 2025 17:13

mountiny reviewed Mar 27, 2025

View reviewed changes

allgandalf reviewed Mar 27, 2025

View reviewed changes

src/libs/actions/QuickActionNavigation.ts Show resolved Hide resolved

SzymczakJ added 2 commits March 28, 2025 10:50

fix PR comments

d78e97c

add tests for QuickActionNavigation

80dc09e

mountiny reviewed Mar 28, 2025

View reviewed changes

SzymczakJ added 3 commits March 28, 2025 13:57

add QAB test

a3f8e99

Merge branch 'main' into @szymczak/add-create-report-QAB

7876485

fix wrong navigation

575f1d4

allgandalf approved these changes Mar 28, 2025

View reviewed changes

melvin-bot bot requested a review from mountiny March 28, 2025 15:03

mountiny approved these changes Mar 28, 2025

View reviewed changes

mountiny merged commit 6c53307 into Expensify:main Mar 28, 2025
17 checks passed

github-actions bot mentioned this pull request Mar 31, 2025

Deploy Checklist: New Expensify 2025-03-31 #59334

Closed

62 tasks

	// Change the method to set for new reports because it doesn't exist yet, is faster,
	// and we need the data to be available when we navigate to the chat page

Add QAB for Create report flow #59167

Add QAB for Create report flow #59167

Uh oh!

Conversation

SzymczakJ commented Mar 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

melvin-bot bot commented Mar 27, 2025

Uh oh!

mountiny commented Mar 27, 2025

Uh oh!

github-actions bot commented Mar 27, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions bot commented Mar 27, 2025

Uh oh!

SzymczakJ commented Mar 28, 2025

Uh oh!

allgandalf commented Mar 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

allgandalf commented Mar 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

SzymczakJ commented Mar 28, 2025

Uh oh!

allgandalf left a comment

Choose a reason for hiding this comment

SzymczakJ commented Mar 26, 2025 •

edited

Loading

allgandalf commented Mar 28, 2025 •

edited

Loading

allgandalf commented Mar 28, 2025 •

edited

Loading