Create the buildOptimisticReportObject function #10801

Julesssss · 2022-09-02T16:13:07Z

Details

Creates a function that builds an optimistic iouReport.

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/225603

Contributor (PR Author) Checklist

PR Reviewer Checklist

The Contributor+ will copy/paste it into a new comment and complete it after the author checklist is completed

Tests

No QA for Applause!

A) Verify the report data is created locally (web/Desktop)

Add the following lines to a component (for example, in IOUModal):

// import at top of file
`import * as ReportUtils from '../../libs/ReportUtils';`

// include somewhere in the Component, so you can call on demand
console.log(ReportUtils.buildOptimisticIOUReport('jules@expensify.com', 'hariseldon@trantor.com', 12345, 987, 'USD', 'en'));

Open the log console, and clear it
Open the IOUModal, or whichever component you added the above line to
Confirm that the report was generated and matches the following object:

B) Verify that no errors appear in the JS console

# Conflicts: # src/components/ScreenWrapper/index.android.js

Julesssss · 2022-09-05T16:50:34Z

I was stuck with VM and NPM issues today. Made improvements but won't be able to submit the PR until tomorrow.

@mountiny & @luacmartins feel free to do an early review of the report object in the meantime!

Julesssss · 2022-09-06T08:58:15Z

@ctkochan22 @mountiny, @luacmartins this is now ready for review, thanks!

Julesssss · 2022-09-06T09:00:21Z

Also @Gonals, as you'll be using this new function.

src/libs/actions/Report.js

luacmartins

Left a few comments

src/libs/actions/Report.js

Julesssss · 2022-09-06T19:58:32Z

Sorry, but the PR is on hold while I deal with a mobile deploy fire. Will ping you when i have a spare 5 mins to update the PR.

ctkochan22 · 2022-09-07T09:31:10Z

Comments mirror @luacmartins . Let me knwo when its ready for another review!

Julesssss · 2022-09-07T14:02:05Z

Dealing with a 4th deploy blocking issue in a row so I still can't work on this. Sorry

src/libs/actions/Report.js

Gonals · 2022-09-07T15:42:33Z

Do we need to throw the transactionID in here somewhere? It doesn't look like we optimistically add it in Onyx anywhere else

Julesssss · 2022-09-07T19:16:59Z

@luacmartins please take another look. I'm happy to make those changes if my arguments didn't convince you

luacmartins

I still think that we should move this to ReportUtils and create a CONST for submitted, but I won't block on it.

mountiny

Oh yeah, lets move this to ReportUtils

Julesssss · 2022-09-08T10:24:35Z

I'll resubmit after a meeting and once I figure out how to call the new function without this error 😕

mountiny · 2022-09-08T11:08:08Z

Error: 591:19 error 'ReportUtils' is not defined no-undef

I thin kit will be related to the lint error

Julesssss · 2022-09-08T11:23:57Z

Ah, I copy/pasted the test instructions without updating Report. Thanks

mountiny · 2022-09-08T12:04:54Z

@Julesssss I think you need to merge main for the contirbutor plus action to work

Julesssss · 2022-09-08T12:16:57Z

Hey @Gonals @luacmartins @mountiny. Appologies for the delay here, I've only just found a moment to work on my issues. I have updated the test steps with additional info. Ready for review

mountiny

PR 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 verified tests pass on all platforms & I tested again on:
- iOS / native
- Android / native
- iOS / Safari
- Android / Chrome
- MacOS / Chrome
- 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 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 was added in all src/languages/* files
- I verified any copy / text that was added to the app is correct English and approved by marketing by tagging the marketing team 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 */
- Any functional components have the displayName property
- 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 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 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.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

OSBotify · 2022-09-08T15:46:58Z

✋ 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 · 2022-09-09T06:07:39Z

🚀 Deployed to staging by @mountiny in version: 1.1.99-0 🚀

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

mountiny · 2022-09-09T10:09:51Z

@Julesssss The QA mentions being able to create a new chat while being offline. Is that already implemented? I thought that is not done yet, I cannot create a chat while offline on staging right now

Julesssss · 2022-09-09T10:24:53Z

@mountiny great point. I was mistaken when adding that test step. Removed it

Julesssss · 2022-09-12T10:15:14Z

Oh yeah, lets move this to ReportUtils

I still think that we should move this to ReportUtils and create a CONST for submitted, but I won't block on it.

@mountiny @luacmartins here's a follow up issue to ensure the helper functions are moved from the Report actions file into ReportUtils

Julesssss added 2 commits August 31, 2022 16:22

build initial optimistic IOU report object

b695af4

improve the optimistic report object data

a2fe1ae

Julesssss self-assigned this Sep 2, 2022

Julesssss mentioned this pull request Sep 2, 2022

Build optimistic IOU report object #10727

Closed

93 tasks

Julesssss added 5 commits September 2, 2022 18:18

use shorthand property names

168220a

Merge branch 'main' into jules-KeyboardFix

b36a46c

# Conflicts: # src/components/ScreenWrapper/index.android.js

Merge branch 'main' into jules-buildOptimisticIOUReport

1fef1c8

fix numer formatting and add a function doc

a5f2f92

further formatting fixes

24137ed

mountiny self-requested a review September 2, 2022 18:51

Julesssss added 2 commits September 5, 2022 12:03

Merge branch 'main' into jules-buildOptimisticIOUReport

ead5868

further formatting fixes

918fcf8

fix unexpected newline

1b5cbd7

luacmartins self-requested a review September 5, 2022 16:56

fix number formatting logic

fc618ee

Julesssss changed the title ~~Create the buildOptimisticReportObject function~~ [NO QA] Create the buildOptimisticReportObject function Sep 6, 2022

Julesssss marked this pull request as ready for review September 6, 2022 08:48

Julesssss requested a review from a team as a code owner September 6, 2022 08:48

melvin-bot bot requested review from ctkochan22 and removed request for a team September 6, 2022 08:49

Gonals reviewed Sep 6, 2022

View reviewed changes

src/libs/actions/Report.js Outdated Show resolved Hide resolved

luacmartins reviewed Sep 6, 2022

View reviewed changes

src/libs/actions/Report.js Outdated Show resolved Hide resolved

src/libs/actions/Report.js Outdated Show resolved Hide resolved

src/libs/actions/Report.js Outdated Show resolved Hide resolved

src/libs/actions/Report.js Outdated Show resolved Hide resolved

Gonals reviewed Sep 7, 2022

View reviewed changes

src/libs/actions/Report.js Outdated Show resolved Hide resolved

Julesssss force-pushed the jules-buildOptimisticIOUReport branch from 5594358 to 22c5612 Compare September 7, 2022 16:23

add emails to optimistic report, as we know them already

409ae57

luacmartins previously approved these changes Sep 8, 2022

View reviewed changes

use consts for state and status

6a99e9c

Julesssss dismissed luacmartins’s stale review via 6a99e9c September 8, 2022 09:54

mountiny previously approved these changes Sep 8, 2022

View reviewed changes

mountiny reviewed Sep 8, 2022

View reviewed changes

replace confusing CONST with integer

5d2e3cc

Julesssss dismissed mountiny’s stale review via 5d2e3cc September 8, 2022 09:59

refactor optimistic iouReport to ReportUtils

4ed3c6a

tidy params after switching file

1c857bb

Julesssss changed the title ~~[NO QA] Create the buildOptimisticReportObject function~~ Create the buildOptimisticReportObject function Sep 8, 2022

mountiny approved these changes Sep 8, 2022

View reviewed changes

Merge branch 'main' into jules-buildOptimisticIOUReport

81abe37

luacmartins approved these changes Sep 8, 2022

View reviewed changes

mountiny approved these changes Sep 8, 2022

View reviewed changes

mountiny merged commit d7a7334 into main Sep 8, 2022

mountiny deleted the jules-buildOptimisticIOUReport branch September 8, 2022 15:41

OSBotify mentioned this pull request Sep 9, 2022

Deploy Checklist: New Expensify 2022-09-09 #10916

Closed

16 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Create the buildOptimisticReportObject function #10801

Create the buildOptimisticReportObject function #10801

Julesssss commented Sep 2, 2022 •

edited

Loading

Julesssss commented Sep 5, 2022

Julesssss commented Sep 6, 2022

Julesssss commented Sep 6, 2022

luacmartins left a comment

Julesssss commented Sep 6, 2022

ctkochan22 commented Sep 7, 2022

Julesssss commented Sep 7, 2022

Gonals commented Sep 7, 2022

Julesssss commented Sep 7, 2022

luacmartins left a comment

mountiny left a comment

Julesssss commented Sep 8, 2022

mountiny commented Sep 8, 2022

Julesssss commented Sep 8, 2022

mountiny commented Sep 8, 2022

Julesssss commented Sep 8, 2022

mountiny left a comment

OSBotify commented Sep 8, 2022

OSBotify commented Sep 9, 2022

mountiny commented Sep 9, 2022

Julesssss commented Sep 9, 2022

Julesssss commented Sep 12, 2022 •

edited

Loading

Create the buildOptimisticReportObject function #10801

Create the buildOptimisticReportObject function #10801

Conversation

Julesssss commented Sep 2, 2022 • edited Loading

Details

Fixed Issues

Contributor (PR Author) Checklist

PR Reviewer Checklist

Tests

Julesssss commented Sep 5, 2022

Julesssss commented Sep 6, 2022

Julesssss commented Sep 6, 2022

luacmartins left a comment

Choose a reason for hiding this comment

Julesssss commented Sep 6, 2022

ctkochan22 commented Sep 7, 2022

Julesssss commented Sep 7, 2022

Gonals commented Sep 7, 2022

Julesssss commented Sep 7, 2022

luacmartins left a comment

Choose a reason for hiding this comment

mountiny left a comment

Choose a reason for hiding this comment

Julesssss commented Sep 8, 2022

mountiny commented Sep 8, 2022

Julesssss commented Sep 8, 2022

mountiny commented Sep 8, 2022

Julesssss commented Sep 8, 2022

mountiny left a comment

Choose a reason for hiding this comment

PR Reviewer Checklist

OSBotify commented Sep 8, 2022

OSBotify commented Sep 9, 2022

mountiny commented Sep 9, 2022

Julesssss commented Sep 9, 2022

Julesssss commented Sep 12, 2022 • edited Loading

Julesssss commented Sep 2, 2022 •

edited

Loading

Julesssss commented Sep 12, 2022 •

edited

Loading