Clean up various `buildOptimistic*` methods. Clarify `sequenceNumber` usage in doc comments. by marcaaron · Pull Request #11219 · Expensify/App

marcaaron · 2022-09-22T19:12:56Z

cc @luacmartins @Gonals @mountiny @Julesssss

Details

While we are planning to deprecate sequenceNumber we are still using sequenceNumber. So, until we deprecate it we should not be replacing the sequenceNumber with a clientID, reportActionID or anything else.

Separately, there are a lot of methods that are not actions being added to the Report.js file so I moved them to ReportUtils.js for better organization.

Fixed Issues

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

Tests

Re-test the Add Comment and Add Attachment flows in TestRail

https://expensify.testrail.io/index.php?/suites/view/518&group_by=cases:section_id&group_order=asc&display_deleted_cases=0&group_id=101726

https://expensify.testrail.io/index.php?/suites/view/518&group_by=cases:section_id&group_order=asc&display_deleted_cases=0&group_id=135084

Verify that no errors appear in the JS console

PR Review Checklist

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

QA Steps

Re-test the Add Comment and Add Attachment flows in TestRail

https://expensify.testrail.io/index.php?/suites/view/518&group_by=cases:section_id&group_order=asc&display_deleted_cases=0&group_id=101726

https://expensify.testrail.io/index.php?/suites/view/518&group_by=cases:section_id&group_order=asc&display_deleted_cases=0&group_id=135084

Verify that no errors appear in the JS console

Screenshots

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

mountiny

I love this change, it is not required to make this but will make our lives much easier to keep this consistent before re deprecate the sequenceNumbers. Hopefully soon.

Just one NAB

mountiny · 2022-09-23T08:13:28Z

+}
+
+/**
+ * Returns the necessary reportAction onyx data to indicate that the chat has been created optimistically


NAB

Suggested change

* Returns the necessary reportAction onyx data to indicate that the chat has been created optimistically

* Returns the necessary reportAction onyx data to indicate that the chat has been created optimistically

mountiny

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
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 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.

mountiny · 2022-09-23T08:57:30Z

I have tested this locally with sending messages and attachments and all worked fine!

mountiny · 2022-09-23T09:02:07Z

^ this check is so incredibly annoying ngl.

mountiny

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
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 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.

Julesssss · 2022-09-23T10:17:51Z

+}
+
+/**
+ * Returns the necessary reportAction onyx data to indicate that the chat has been created optimistically


NAB, but maybe we should use this opportunity to better align the function comments, which are quite different:

Builds an optimistic chat report

Returns the necessary reportAction onyx data

Julesssss

This could well be an issue on my side, but I'm seeing a few issues:

A) 4 new message lines are being shown

B) Some, but not all of the users Avatar turns grey when offline

C) The pending messages don't always get sent once the connection is re-established (this has been reported separately already)

Julesssss

Additionally, I was left with this Encountered two children with the same key error:

It looks to me like this is caused because we're not removing the pending actions:

marcaaron · 2022-09-23T16:33:20Z

@Julesssss can you verify if those issues do or do not also happen on main?

We're not making too many changes here and just cleaning things up so kinda surprised to see.

It looks like some or all of them will be solved by switching to reportActionID for keys in reportActions_*. When you have duplicate keys lists in React show super weird stuff like what you're seeing. But if there's a reproduction for them let us know so we can look into it further.

marcaaron · 2022-09-23T16:36:09Z

Gonna merge this so @Gonals can integrate these changes into their App PR. We are currently working on the deprecate sequenceNumber changes and should have the detailed design for that out soon.

melvin-bot · 2022-09-23T16:36:27Z

@marcaaron looks like this was merged without passing tests. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

Not an emergency! It was the checklist thing again.

luacmartins

LGTM!

luacmartins · 2022-09-23T16:38:19Z

Oh lol was too late here. This was already merged 😅

Julesssss · 2022-09-23T16:39:21Z

I tested first thing this morning, then noticed the issues existing elsewhere, so I think you're fine to continue here. I can test again on Monday though

OSBotify · 2022-09-23T16:40:38Z

✋ 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-23T23:32:50Z

🚀 Deployed to staging by @marcaaron in version: 1.2.6-0 🚀

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

marcaaron · 2022-09-23T23:58:14Z

Not an emergency! It was the checklist thing again.

OSBotify · 2022-09-26T20:19:46Z

🚀 Deployed to production by @roryabraham in version: 1.2.6-0 🚀

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

marcaaron added 4 commits September 22, 2022 07:33

Moveall buildOptimisticSomething methods to ReportUtils

7b5670c

Clarify sequenceNumber usage

69a3117

clean up providedPersonalDetails

b19add5

Update comment

0397940

marcaaron self-assigned this Sep 22, 2022

marcaaron marked this pull request as ready for review September 22, 2022 19:15

marcaaron requested a review from a team as a code owner September 22, 2022 19:15

melvin-bot Bot requested review from sketchydroide and removed request for a team September 22, 2022 19:16

marcaaron changed the title ~~[No QA] Clean up various buildOptimistic* methods. Clarify sequenceNumber usage in doc comments.~~ Clean up various buildOptimistic* methods. Clarify sequenceNumber usage in doc comments. Sep 22, 2022

luacmartins self-requested a review September 22, 2022 19:33

Fix some dead code

7c26084

mountiny approved these changes Sep 23, 2022

View reviewed changes

Julesssss reviewed Sep 23, 2022

View reviewed changes

sketchydroide approved these changes Sep 23, 2022

View reviewed changes

marcaaron merged commit 3780e0f into main Sep 23, 2022

marcaaron deleted the marcaaron-refactorCreateOptimisticReportAction branch September 23, 2022 16:36

melvin-bot Bot added the Emergency label Sep 23, 2022

luacmartins reviewed Sep 23, 2022

View reviewed changes

OSBotify mentioned this pull request Sep 23, 2022

Deploy Checklist: New Expensify 2022-09-23 #11252

Closed

14 tasks

marcaaron removed the Emergency label Sep 23, 2022

kbecciv mentioned this pull request Sep 24, 2022

[$2000] mWeb/Chrome - Chat -After refresh the page while offline - the composed box is frizzed and message appears in composed box #11265

Closed

DylanDylann mentioned this pull request Dec 5, 2025

[Due for payment 2025-12-03][$250] Report - Workspace avatar is not visible the first time that expenses are opened offline. #75278

Closed

8 tasks

	* Returns the necessary reportAction onyx data to indicate that the chat has been created optimistically
	* Returns the necessary reportAction onyx data to indicate that the chat has been created optimistically

Conversation

marcaaron commented Sep 22, 2022 • edited by mountiny Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

PR Review Checklist

Contributor (PR Author) Checklist

PR Reviewer Checklist

QA Steps

Screenshots

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

Uh oh!

mountiny left a comment

Choose a reason for hiding this comment

Uh oh!

mountiny Sep 23, 2022

Choose a reason for hiding this comment

Uh oh!

mountiny left a comment

Choose a reason for hiding this comment

Uh oh!

mountiny commented Sep 23, 2022

Uh oh!

mountiny commented Sep 23, 2022

Uh oh!

mountiny left a comment

Choose a reason for hiding this comment

Uh oh!

Julesssss Sep 23, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Julesssss left a comment

Choose a reason for hiding this comment

Uh oh!

Julesssss left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

marcaaron commented Sep 23, 2022

Uh oh!

marcaaron commented Sep 23, 2022

Uh oh!

melvin-bot Bot commented Sep 23, 2022 • edited by marcaaron Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

luacmartins left a comment

Choose a reason for hiding this comment

Uh oh!

luacmartins commented Sep 23, 2022

Uh oh!

Julesssss commented Sep 23, 2022

Uh oh!

OSBotify commented Sep 23, 2022

Uh oh!

OSBotify commented Sep 23, 2022

Uh oh!

marcaaron commented Sep 23, 2022

Uh oh!

OSBotify commented Sep 26, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

marcaaron commented Sep 22, 2022 •

edited by mountiny

Loading

Julesssss Sep 23, 2022 •

edited

Loading

Julesssss left a comment •

edited

Loading

melvin-bot Bot commented Sep 23, 2022 •

edited by marcaaron

Loading