[NoQA] feat: show next steps for draft reports #29309

BeeMargarida · 2023-10-11T13:10:46Z

Details

Added support for showing the next steps of a draft report on the header of a money request report. It only contains support for showing the next step message (no actions or buttons).

Fixed Issues

$ #28767

Tests

To test this currently, it requires some setup. Check the dropdown below. Use Staging server.

Required setup

Open or create a money request report connected to a workspace and take note of its ID, which is present in the URL
Go to MoneyReportHeader.js and copy paste the code below inside the useEffect with empty dependency array. Use the report ID of the previous post. This will make the report have the status of open/draft.
Open the money request report from the workspace report
Set the app to offline (so that the report info is not updated)
Refresh the page when inside the money request report page

Onyx.merge('report_<REPORT_ID>', {
    statusNum: 0,
    stateNum: 0,
});

Open a money request report that is currently in draft state
Check that the header contains a next steps section. The next steps message might not match the draft state since this state is forced.

Verify that no errors appear in the JS console

Offline tests

Similar to the one above

QA Steps

N/A cant be tested right now

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

With bigger text:

Android: mWeb Chrome

With bigger text:

iOS: Native

With bigger text:

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

src/components/MoneyReportHeaderStatusBar.js

BeeMargarida · 2023-10-11T13:15:09Z

Oops, conflicts 🏃‍♀️

src/components/MoneyReportHeaderStatusBar.js

src/pages/nextStepPropTypes.js

rezkiy37

LGTM, left a minor comment.

melvin-bot · 2023-10-12T09:13:24Z

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

robertKozik · 2023-10-12T10:52:11Z

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

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

robertKozik

LGTM

mountiny · 2023-10-17T00:12:02Z

src/components/MoneyReportHeaderStatusBar.js

+        let nextStepHTML = '';
+
+        const messageArray = _.isEmpty(nextStep.expenseMessage) ? nextStep.message : nextStep.expenseMessage;
+        _.each(messageArray, (part) => {
+            const tagType = part.type || 'span';
+            nextStepHTML += `<${tagType}>${Str.safeEscape(part.text)}</${tagType}>`;
+        });
+
+        return nextStepHTML
+            .replace(/%expenses/g, 'this expense')
+            .replace(/%Expenses/g, 'This expense')
+            .replace(/%tobe/g, 'is');


I think we should move this to some Utils file. Maybe NextStepUtils.js and create a parseMessage method there

mountiny · 2023-10-17T00:12:39Z

src/pages/nextStepPropTypes.js

+    /** The title for the next step */
+    title: PropTypes.string,
+
+    /** Whether the the user must take some sort of action in order to unblock the report */


Suggested change

/** Whether the the user must take some sort of action in order to unblock the report */

/** Whether the user should take some sort of action in order to unblock the report */

mountiny · 2023-10-17T00:13:14Z

src/pages/nextStepPropTypes.js

+    /** If the "Undo submit" button should be visible */
+    showUndoSubmit: PropTypes.bool,
+
+    /** If the next step  should be displayed on mobile */


Suggested change

/** If the next step should be displayed on mobile */

/** Deprecated - If the next step should be displayed on mobile, related to OldApp */

koko57 · 2023-10-17T12:48:42Z

@mountiny I'll take over this issue from Ana

koko57 · 2023-10-17T13:54:10Z

@mountiny done 🙂

mountiny · 2023-10-17T19:39:43Z

src/components/MoneyReportHeader.js

-                    />
-                </View>
-            )}
+            <View style={[styles.dFlex, styles.flexColumn, styles.borderBottom]}>


One last nitpick 🤓 @koko57 This leads to double bottom border if there is no next steps:

mountiny · 2023-10-19T15:43:06Z

src/components/MoneyReportHeader.js

+    const shouldShowAnyButton = shouldShowSettlementButton || shouldShowApproveButton || shouldShowSubmitButton || shouldShowNextSteps;
    const bankAccountRoute = ReportUtils.getBankAccountRoute(chatReport);
    const formattedAmount = CurrencyUtils.convertToDisplayString(reimbursableTotal, moneyRequestReport.currency);
+    const isShowingMoreContent = shouldShowSettlementButton || shouldShowApproveButton || shouldShowSubmitButton || shouldShowNextSteps;


these two expressions are now same I think we could reuse it

mountiny · 2023-10-19T17:20:08Z

I think the double border is still there in wide view

mountiny

Thanks for help!

mountiny · 2023-10-19T18:15:57Z

src/components/MoneyReportHeader.js

    const bankAccountRoute = ReportUtils.getBankAccountRoute(chatReport);
    const formattedAmount = CurrencyUtils.convertToDisplayString(reimbursableTotal, moneyRequestReport.currency);
+    const isMoreContentShown = shouldShowNextSteps || (shouldShowAnyButton && isSmallScreenWidth);


NAB we can do this in another PR but I think we can name this const like hasSecondRow which would suit it better

OSBotify · 2023-10-19T18:23:56Z

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

OSBotify · 2023-10-20T21:38:27Z

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

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

OSBotify · 2023-10-23T04:50:39Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.3.88-11 🚀

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

Ollyws · 2024-01-15T10:21:00Z

Emails were not wrapping correctly in the next steps message so we dealt with this in #32910

BeeMargarida added 2 commits October 10, 2023 15:30

feat: show next steps for draft reports

b4b68f8

fix: text wrap in native devices

b6a9476

koko57 reviewed Oct 11, 2023

View reviewed changes

src/components/MoneyReportHeaderStatusBar.js Outdated Show resolved Hide resolved

BeeMargarida added 3 commits October 11, 2023 14:16

Merge branch 'main' into feat/28767-next-steps

8c71c20

fix: remove brackets

a1467e6

refactor: prettier

4db6a9e

adhorodyski reviewed Oct 12, 2023

View reviewed changes

src/components/MoneyReportHeaderStatusBar.js Outdated Show resolved Hide resolved

adhorodyski approved these changes Oct 12, 2023

View reviewed changes

rezkiy37 reviewed Oct 12, 2023

View reviewed changes

src/pages/nextStepPropTypes.js Outdated Show resolved Hide resolved

rezkiy37 reviewed Oct 12, 2023

View reviewed changes

refactor: break into newlines

536ca6f

rezkiy37 approved these changes Oct 12, 2023

View reviewed changes

BeeMargarida marked this pull request as ready for review October 12, 2023 09:13

BeeMargarida requested a review from a team as a code owner October 12, 2023 09:13

melvin-bot bot requested review from robertKozik and removed request for a team October 12, 2023 09:13

mountiny assigned BeeMargarida Oct 12, 2023

robertKozik approved these changes Oct 12, 2023

View reviewed changes

melvin-bot bot requested a review from mountiny October 12, 2023 10:52

mountiny changed the title ~~feat: show next steps for draft reports~~ [NoQA] feat: show next steps for draft reports Oct 12, 2023

mountiny assigned mountiny and unassigned mountiny Oct 12, 2023

mountiny requested changes Oct 17, 2023

View reviewed changes

koko57 added 2 commits October 17, 2023 15:18

fix: resolve conflicts

6dd690c

fix: apply requested changes

fa77838

mountiny requested changes Oct 17, 2023

View reviewed changes

fix: minor style fix

c2ca6b0

mountiny reviewed Oct 19, 2023

View reviewed changes

fix: minor fix

127ccff

fix: minor style fix

fdc60fb

mountiny approved these changes Oct 19, 2023

View reviewed changes

mountiny merged commit fd04739 into Expensify:main Oct 19, 2023
14 checks passed

OSBotify mentioned this pull request Oct 20, 2023

Deploy Checklist: New Expensify 2023-10-20 #30108

Closed

melvin-bot bot mentioned this pull request Oct 23, 2023

[HOLD for payment 2023-10-30] [Wave 6: Drafts] Show the Next step in the MoneyReportHeader #28767

Closed

Ollyws mentioned this pull request Jan 15, 2024

[Awaiting checklist completion] [Wave 6: Workspace Chats] Expense - 'Marked as reimbursed' message in expense report is not wrapped #32286

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[NoQA] feat: show next steps for draft reports #29309

[NoQA] feat: show next steps for draft reports #29309

BeeMargarida commented Oct 11, 2023 •

edited by mountiny

Loading

BeeMargarida commented Oct 11, 2023

rezkiy37 left a comment

melvin-bot bot commented Oct 12, 2023

robertKozik commented Oct 12, 2023

robertKozik left a comment

mountiny Oct 17, 2023

mountiny Oct 17, 2023

mountiny Oct 17, 2023

koko57 commented Oct 17, 2023

koko57 commented Oct 17, 2023

mountiny Oct 17, 2023

mountiny Oct 19, 2023

mountiny commented Oct 19, 2023

mountiny left a comment

mountiny Oct 19, 2023

OSBotify commented Oct 19, 2023

OSBotify commented Oct 20, 2023

OSBotify commented Oct 23, 2023

Ollyws commented Jan 15, 2024

	/** Whether the the user must take some sort of action in order to unblock the report */
	/** Whether the user should take some sort of action in order to unblock the report */

	/** If the next step should be displayed on mobile */
	/** Deprecated - If the next step should be displayed on mobile, related to OldApp */

[NoQA] feat: show next steps for draft reports #29309

[NoQA] feat: show next steps for draft reports #29309

Conversation

BeeMargarida commented Oct 11, 2023 • edited by mountiny Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

BeeMargarida commented Oct 11, 2023

rezkiy37 left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Oct 12, 2023

robertKozik commented Oct 12, 2023

Reviewer Checklist

Screenshots/Videos

robertKozik left a comment

Choose a reason for hiding this comment

mountiny Oct 17, 2023

Choose a reason for hiding this comment

mountiny Oct 17, 2023

Choose a reason for hiding this comment

mountiny Oct 17, 2023

Choose a reason for hiding this comment

koko57 commented Oct 17, 2023

koko57 commented Oct 17, 2023

mountiny Oct 17, 2023

Choose a reason for hiding this comment

mountiny Oct 19, 2023

Choose a reason for hiding this comment

mountiny commented Oct 19, 2023

mountiny left a comment

Choose a reason for hiding this comment

mountiny Oct 19, 2023

Choose a reason for hiding this comment

OSBotify commented Oct 19, 2023

OSBotify commented Oct 20, 2023

OSBotify commented Oct 23, 2023

Ollyws commented Jan 15, 2024

BeeMargarida commented Oct 11, 2023 •

edited by mountiny

Loading