feat: Use formula for the optimistic expense report #37160

paultsimura · 2024-02-23T19:32:02Z

Details

When creating an expense report in a Policy that supports report fields, build the expense report name using the formula.

Fixed Issues

for #36267
PROPOSAL: #36267 (comment)

Tests

Same as QA

Offline tests

Same as QA

QA Steps

Preconditions: be a member of a collect policy, have no active expense report with this policy, and have the "report fields" beta turned on.

Go offline
Request money from the workspace
Verify the newly created expense report uses the formula from OD in the title
Verify the fields like these are populated correctly with the optimistic data:

{report:id}
{report:type}
{report:startdate}
{report:total}
{report:currency}
{report:policyname}

Verify the other formula fields are removed
If the formula contains only the fields that are non in the list above – verify the raw formula is used (as there is no optimistic data to replace the fields)

For instance, in my recordings, I used the formula with {report:type} and {report:startdate} fields.

PR Author Checklist

Screenshots/Videos

Android: Native

android-compressed.mp4

Android: mWeb Chrome

chrome-compressed.mp4

iOS: Native

Simulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2024-02-23.at.23.42.32-compressed.mp4

iOS: mWeb Safari

Simulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2024-02-23.at.23.41.26-compressed.mp4

MacOS: Chrome / Safari

Screen.Recording.2024-02-23.at.22.52.16.mov

MacOS: Desktop

Screen.Recording.2024-02-23.at.23.22.57-compressed.mp4

melvin-bot · 2024-02-23T22:45:53Z

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

mananjadhav · 2024-02-27T16:59:53Z

I was unwell past few days and I've requested for the report fields. The code changes look fine to me. Will work on the checklist as soon as I am added to the beta.

melvin-bot · 2024-02-27T21:05:00Z

❗ Please, do not use Github auto-linking keywords such as these: close, closes, closed, fix, fixes, fixed, resolve, resolves or resolved.

For more details, see the Contributing Guidelines, specifically Submit your pull request for a final review 📖.

mananjadhav · 2024-02-28T18:33: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(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 form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label 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.
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

android-report-fields.mov

Android: mWeb Chrome

mweb-chrome-report-fields.mov

iOS: Native

ios-report-fields.mov

iOS: mWeb Safari

mweb-safari-report-fields.mov

MacOS: Chrome / Safari

web-report-fields.mov

MacOS: Desktop

desktop-report-fields.mov

mananjadhav · 2024-02-28T18:34:31Z

I could test other properties to the formula, except for the last case .replaceAll(/\{report:(.+)}/g, '');. I tested this forcefully because the OldDot didn't allow adding random properties (or atleast I wasn't aware).

thienlnam

Looking good, just a few comments

src/libs/ReportUtils.ts

thienlnam · 2024-02-28T19:32:06Z

src/libs/ReportUtils.ts

+ * Each formula field is either replaced with a value, or removed.
+ * If after all replacements the formula is empty, the original formula is returned.
+ */
+function populateOptimisticReportFormula(formula: string, report: OptimisticExpenseReport, policy: Policy | EmptyObject): string {


There's a couple more we can handle here optimistically

{report:created}
{report:created:yyyy-MM-dd}
{report:status}
{user:email}
{user:email|frontPart} would output bob assuming that is the currently logged in Expensify user’s email.

src/libs/ReportUtils.ts

paultsimura · 2024-02-28T21:51:10Z

Thanks @thienlnam, addressed your comments ✔️

thienlnam

Great, thanks!

OSBotify · 2024-02-28T22:21:08Z

✋ 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 · 2024-02-29T00:07:55Z

🚀 Deployed to staging by https://github.com/thienlnam in version: 1.4.45-0 🚀

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

kavimuru · 2024-02-29T20:46:38Z

This PR is still failing and able to reproduce #36267 in all the platforms.
https://platform.applause.com/services/links/v1/external/5c7f30811439b15eed6f2c1c365120f2b88f67fad94db0c1c606e513826ac53b
https://platform.applause.com/services/links/v1/external/fb0d1cf6a08e5bc13f38e513150d22f3724aa8c9a882e715e6c7e67d7673fcfc
https://platform.applause.com/services/links/v1/external/126cb5c4af490af518dc01a6dcb132f6c776d9e90911181b81e0c797c0298781

paultsimura · 2024-02-29T20:51:29Z

@kavimuru if I understand correctly, the total and id fields are misbehaving, right?

paultsimura · 2024-02-29T21:04:55Z

Ok, I've updated the PR description: removed the $ so it doesn't auto-close the linked issue. Will double-check what needs to be fixed and will create a follow-up PR, thanks!

cc: @mananjadhav

OSBotify · 2024-02-29T23:32:23Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.4.45-6 🚀

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

Use formula for the optimistic expense report

903527f

paultsimura marked this pull request as ready for review February 23, 2024 22:45

paultsimura requested a review from a team as a code owner February 23, 2024 22:45

melvin-bot bot removed the request for review from a team February 23, 2024 22:45

melvin-bot bot requested a review from mananjadhav February 23, 2024 22:45

paultsimura mentioned this pull request Feb 23, 2024

[HOLD for payment 2024-03-14] [$500] [MEDIUM] Expense Report - In an offline created expense report, a negative request amount is displayed in the Header and Title #36267

Closed

6 tasks

mananjadhav approved these changes Feb 28, 2024

View reviewed changes

melvin-bot bot requested a review from thienlnam February 28, 2024 19:07

thienlnam requested changes Feb 28, 2024

View reviewed changes

paultsimura added 2 commits February 28, 2024 21:58

Merge branch 'main' into fix/36267-report-name-formula

77c360b

Add more formulas

f898f07

paultsimura requested a review from thienlnam February 28, 2024 21:50

thienlnam approved these changes Feb 28, 2024

View reviewed changes

thienlnam merged commit 85c7119 into Expensify:main Feb 28, 2024
15 checks passed

github-actions bot mentioned this pull request Feb 28, 2024

Deploy Checklist: New Expensify 2024-02-28 #37459

Closed

91 tasks

lanitochka17 mentioned this pull request Feb 29, 2024

[$250] [Report Fields] Title - Form fields in expense are updated when the formula changes, only when the page refreshes #37567

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Use formula for the optimistic expense report #37160

feat: Use formula for the optimistic expense report #37160

paultsimura commented Feb 23, 2024 •

edited

Loading

melvin-bot bot commented Feb 23, 2024

mananjadhav commented Feb 27, 2024

melvin-bot bot commented Feb 27, 2024

mananjadhav commented Feb 28, 2024 •

edited

Loading

mananjadhav commented Feb 28, 2024 •

edited

Loading

thienlnam left a comment

thienlnam Feb 28, 2024

paultsimura commented Feb 28, 2024

thienlnam left a comment

OSBotify commented Feb 28, 2024

OSBotify commented Feb 29, 2024

kavimuru commented Feb 29, 2024

paultsimura commented Feb 29, 2024

paultsimura commented Feb 29, 2024

OSBotify commented Feb 29, 2024

feat: Use formula for the optimistic expense report #37160

feat: Use formula for the optimistic expense report #37160

Conversation

paultsimura commented Feb 23, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Feb 23, 2024

mananjadhav commented Feb 27, 2024

melvin-bot bot commented Feb 27, 2024

mananjadhav commented Feb 28, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

mananjadhav commented Feb 28, 2024 • edited Loading

thienlnam left a comment

Choose a reason for hiding this comment

thienlnam Feb 28, 2024

Choose a reason for hiding this comment

paultsimura commented Feb 28, 2024

thienlnam left a comment

Choose a reason for hiding this comment

OSBotify commented Feb 28, 2024

OSBotify commented Feb 29, 2024

kavimuru commented Feb 29, 2024

paultsimura commented Feb 29, 2024

paultsimura commented Feb 29, 2024

OSBotify commented Feb 29, 2024

paultsimura commented Feb 23, 2024 •

edited

Loading

mananjadhav commented Feb 28, 2024 •

edited

Loading

mananjadhav commented Feb 28, 2024 •

edited

Loading