Refactor buildOptimisticTransaction function by mkzie2 · Pull Request #54491 · Expensify/App

mkzie2 · 2024-12-24T04:32:38Z

Explanation of Change

Refactor buildOptimisticTransaction function

Fixed Issues

$ #54464
PROPOSAL: #54464 (comment)

Tests

Create any transaction (manually/distance/scan)
Verify that the transaction is created successfully and the data is correct what we entered

Verify that no errors appear in the JS console

Offline tests

Same

QA Steps

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

Create any transaction (manually/distance/scan)
Verify that the transaction is created successfully and the data is correct what we entered

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2024-12-24.at.11.24.18.mov

Android: mWeb Chrome

Screen.Recording.2024-12-24.at.11.19.43.mov

iOS: Native

Screen.Recording.2024-12-24.at.11.26.14.mov

iOS: mWeb Safari

Screen.Recording.2024-12-24.at.11.21.57.mov

MacOS: Chrome / Safari

Screen.Recording.2024-12-24.at.11.17.32.mov

MacOS: Desktop

Screen.Recording.2024-12-24.at.11.28.44.mov

melvin-bot · 2024-12-24T04:37:48Z

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

mkzie2 · 2024-12-24T04:38:44Z

Eslint error isn't related to our changes.

shubham1206agra · 2024-12-26T03:26:34Z

@mkzie2 You need to fix the error even if it is not related to PR.

mkzie2 · 2024-12-26T08:57:55Z

@shubham1206agra Fixed.

shubham1206agra · 2024-12-28T16:58:14Z

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 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.2024-12-28.at.10.23.04.PM.mov

Android: mWeb Chrome

Screen.Recording.2024-12-28.at.8.37.48.PM.mov

iOS: Native

Screen.Recording.2024-12-28.at.10.06.24.PM.mov

iOS: mWeb Safari

Screen.Recording.2024-12-28.at.8.30.35.PM.mov

MacOS: Chrome / Safari

Screen.Recording.2024-12-28.at.8.28.36.PM.mov

MacOS: Desktop

Screen.Recording.2024-12-28.at.9.48.06.PM.mov

neil-marcellini

It all looks good, but I would like to move a few fields

neil-marcellini · 2024-12-30T17:54:57Z

src/libs/TransactionUtils/index.ts

+};
+
+type BuildOptimisticTransactionParams = {
+    source?: string;


Don't you think source and filename should be part of the transactionParams? They relate to the transaction specifically so I would like to move them there.

@neil-marcellini I updated.

neil-marcellini

Good to go thanks

OSBotify · 2024-12-31T19:52:30Z

✋ 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 · 2024-12-31T22:18:04Z

🚀 Deployed to staging by https://github.com/neil-marcellini in version: 9.0.80-1 🚀

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

github-actions · 2025-01-06T18:17:37Z

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

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

refactor buildOptimisticTransaction

99e1503

mkzie2 marked this pull request as ready for review December 24, 2024 04:37

mkzie2 requested a review from a team as a code owner December 24, 2024 04:37

melvin-bot bot requested a review from shubham1206agra December 24, 2024 04:37

melvin-bot bot removed the request for review from a team December 24, 2024 04:37

mkzie2 mentioned this pull request Dec 24, 2024

[HOLD for payment 2025-01-13] [$250] Refactor buildOptimisticTransaction to use a parameter object #54464

Closed

mkzie2 added 4 commits December 26, 2024 15:00

merge main

8af96e6

fix lint

7db6695

remove empty string

07660f1

fix error

d44c9c8

shubham1206agra approved these changes Dec 28, 2024

View reviewed changes

melvin-bot bot requested a review from neil-marcellini December 28, 2024 16:58

mkzie2 added 4 commits December 30, 2024 15:52

Merge branch 'main' into mkzie2-issue/54464

9d4cb11

fix error

be4b9dc

merge main

faecf16

fix lint

70569d3

neil-marcellini requested changes Dec 30, 2024

View reviewed changes

move source and file name to transaction params

ad0136c

neil-marcellini approved these changes Dec 31, 2024

View reviewed changes

neil-marcellini merged commit f35cbc0 into Expensify:main Dec 31, 2024

github-actions bot mentioned this pull request Dec 31, 2024

Deploy Checklist: New Expensify 2024-12-31 #54686

Closed

68 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor buildOptimisticTransaction function#54491

Refactor buildOptimisticTransaction function#54491
neil-marcellini merged 10 commits intoExpensify:mainfrom
mkzie2:mkzie2-issue/54464

mkzie2 commented Dec 24, 2024

Uh oh!

melvin-bot bot commented Dec 24, 2024

Uh oh!

mkzie2 commented Dec 24, 2024

Uh oh!

shubham1206agra commented Dec 26, 2024

Uh oh!

mkzie2 commented Dec 26, 2024

Uh oh!

shubham1206agra commented Dec 28, 2024

Uh oh!

neil-marcellini left a comment

Uh oh!

neil-marcellini Dec 30, 2024

Uh oh!

mkzie2 Dec 31, 2024

Uh oh!

neil-marcellini left a comment

Uh oh!

OSBotify commented Dec 31, 2024

Uh oh!

github-actions bot commented Dec 31, 2024

Uh oh!

github-actions bot commented Jan 6, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

mkzie2 commented Dec 24, 2024

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Dec 24, 2024

Uh oh!

mkzie2 commented Dec 24, 2024

Uh oh!

shubham1206agra commented Dec 26, 2024

Uh oh!

mkzie2 commented Dec 26, 2024

Uh oh!

shubham1206agra commented Dec 28, 2024

Reviewer Checklist

Screenshots/Videos

Uh oh!

neil-marcellini left a comment

Choose a reason for hiding this comment

Uh oh!

neil-marcellini Dec 30, 2024

Choose a reason for hiding this comment

Uh oh!

mkzie2 Dec 31, 2024

Choose a reason for hiding this comment

Uh oh!

neil-marcellini left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Dec 31, 2024

Uh oh!

github-actions bot commented Dec 31, 2024

Uh oh!

github-actions bot commented Jan 6, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants