[No QA] Fix `CREATE` mutations being dropped by merging transactions #53313

j-piasecki · 2024-11-29T11:05:10Z

Explanation of Change

The changes between different versions of the UI are run as transactions by React Native. When there is more than one transaction in the same cycle (for example by using useLayoutEffect) those transactions are merged (merging simply adds mutations from one transaction to the other) so that they are executed atomically. To optimize sending the data from the C++ layer to the native mounting layer in Java, the mutations are reordered so that the mutations of the same type are clustered together. There's a predefined order in which mutations will be executed, and DELETE operations are executed last. This allows the following to happen:

A transaction with mutations: REMOVE X, DELETE X is scheduled
A transaction with mutations CREATE X, INSERT X is scheduled
The two are merged resulting in REMOVE X, DELETE X, CREATE X, INSERT X
The mutations are packed to a buffer with reordering and optimizations resulting in: INSERT X, REMOVE X, DELETE X
The transaction is executed, the view X gets deleted
The states of the mounting layer and diffing layer diverge - the view X exists in one but not the other
If there's a UPDATE X operation, it will result in Unable to find viewState for tag X exception

There is work happening to fix this upstream in React Native but I think it should be patched temporarily in the App. This PR adds a patch that will check whether the two transactions would result in the above case by comparing the views deleted by the first and created by the second. If those results are in the wrong state, the merge will not happen. The downside is the possibility of showing the intermediate UI state as the two transactions may get executed separately. This will only happen in places where the crash would have happened which makes me believe it's an acceptable tradeoff.

The above doesn't affect iOS due to differences in mounting implementation.

Fixed Issues

$ #50463
PROPOSAL:

Tests

Verify that no errors appear in the JS console

Offline tests

QA Steps

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2024-11-29T11:05:16Z

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

DylanDylann · 2024-12-02T16:06:59Z

Start on reviewing

DylanDylann · 2024-12-02T16:39:27Z

@j-piasecki Do we have any related reference to this change already known on react-native

j-piasecki · 2024-12-03T08:37:54Z

Not that I'm aware of. There's an issue I've opened that may be used to track progress there - facebook/react-native#47960 - but the current implementation of the fix doesn't work yet.

DylanDylann · 2024-12-10T04:46:07Z

Give me more time to deep dive into this change

…tions

github-actions · 2024-12-12T09:32:40Z

🚧 @mountiny has triggered a test build. You can view the workflow run here.

github-actions · 2024-12-12T10:00:30Z

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖	iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/53313/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/53313/index.html

Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/53313/NewExpensify.dmg	https://53313.pr-testing.expensify.com

👀 View the workflow run that generated this build 👀

shubham1206agra · 2024-12-14T13:10:46Z

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

WhatsApp.Video.2024-12-14.at.18.38.00.mp4

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

srikarparsi

I don't have a lot of context on this but based on this explanation it does make sense. @mountiny do you think you could check this as well if you have a chance?

mountiny · 2024-12-16T12:46:53Z

@shubham1206agra i think you mentioned you have been able to reproduce this crash before, now on this PR you are not able to, right?

if there are no tests/qa can we add a noQA to the title if there is no clear way to test this?

@j-piasecki can you please merge main too?

shubham1206agra · 2024-12-16T12:57:22Z

@shubham1206agra i think you mentioned you have been able to reproduce this crash before, now on this PR you are not able to, right?

Yes

…tions

j-piasecki · 2024-12-16T15:59:31Z

if there are no tests/qa can we add a noQA to the title if there is no clear way to test this?

There already is [No QA] at the beginning of the title. Or did you mean something else?

mountiny · 2024-12-18T00:26:57Z

@j-piasecki apologies, I was on mobile and midread it, all good.

@srikarparsi feel free to merge this PR

OSBotify · 2024-12-19T05:18:59Z

✋ 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-23T20:57:07Z

🚀 Deployed to staging by https://github.com/srikarparsi in version: 9.0.78-0 🚀

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

github-actions · 2024-12-23T21:41:03Z

🚀 Deployed to staging by https://github.com/srikarparsi in version: 9.0.78-0 🚀

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

github-actions · 2024-12-23T21:48:33Z

🚀 Deployed to staging by https://github.com/srikarparsi in version: 9.0.78-0 🚀

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

github-actions · 2024-12-24T00:04:18Z

🚀 Deployed to staging by https://github.com/srikarparsi in version: 9.0.78-0 🚀

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

github-actions · 2024-12-24T00:51:57Z

🚀 Deployed to staging by https://github.com/srikarparsi in version: 9.0.78-0 🚀

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

github-actions · 2024-12-24T19:42:04Z

🚀 Deployed to staging by https://github.com/srikarparsi in version: 9.0.78-0 🚀

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

github-actions · 2024-12-24T19:59:00Z

🚀 Deployed to staging by https://github.com/srikarparsi in version: 9.0.78-0 🚀

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

github-actions · 2024-12-26T20:26:15Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 9.0.78-6 🚀

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

Fix mutation dropping

1bb78b9

j-piasecki requested a review from a team as a code owner November 29, 2024 11:05

melvin-bot bot requested review from DylanDylann and removed request for a team November 29, 2024 11:05

j-piasecki added 2 commits December 12, 2024 10:24

Merge branch 'main' into @jpiasecki/fix-dropping-mutations-in-transac…

51b0c46

…tions

Update patch

8a414e6

mountiny assigned j-piasecki Dec 12, 2024

mountiny added the Ready To Build label Dec 12, 2024

shubham1206agra mentioned this pull request Dec 13, 2024

[$250] [Crash] Android: SurfaceMountingManager.getViewState #50482

Closed

shubham1206agra approved these changes Dec 14, 2024

View reviewed changes

melvin-bot bot requested a review from srikarparsi December 14, 2024 13:11

srikarparsi approved these changes Dec 16, 2024

View reviewed changes

Merge branch 'main' into @jpiasecki/fix-dropping-mutations-in-transac…

35eda8b

…tions

srikarparsi merged commit 1d33fee into Expensify:main Dec 19, 2024
7 checks passed

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

Deploy Checklist: New Expensify 2024-12-23 #54476

Closed

melvin-bot bot mentioned this pull request Dec 26, 2024

[HOLD for payment 2025-01-02] [$250] Android - Crash when kill the app and reopen it #50463

Open

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[No QA] Fix `CREATE` mutations being dropped by merging transactions #53313

[No QA] Fix `CREATE` mutations being dropped by merging transactions #53313

j-piasecki commented Nov 29, 2024

melvin-bot bot commented Nov 29, 2024

DylanDylann commented Dec 2, 2024

DylanDylann commented Dec 2, 2024

j-piasecki commented Dec 3, 2024

DylanDylann commented Dec 10, 2024

github-actions bot commented Dec 12, 2024

github-actions bot commented Dec 12, 2024

shubham1206agra commented Dec 14, 2024

srikarparsi left a comment

mountiny commented Dec 16, 2024

shubham1206agra commented Dec 16, 2024

j-piasecki commented Dec 16, 2024

mountiny commented Dec 18, 2024

OSBotify commented Dec 19, 2024

github-actions bot commented Dec 23, 2024

github-actions bot commented Dec 23, 2024

github-actions bot commented Dec 23, 2024

github-actions bot commented Dec 24, 2024

github-actions bot commented Dec 24, 2024

github-actions bot commented Dec 24, 2024

github-actions bot commented Dec 24, 2024

github-actions bot commented Dec 26, 2024

[No QA] Fix CREATE mutations being dropped by merging transactions #53313

[No QA] Fix CREATE mutations being dropped by merging transactions #53313

Conversation

j-piasecki commented Nov 29, 2024

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Nov 29, 2024

DylanDylann commented Dec 2, 2024

DylanDylann commented Dec 2, 2024

j-piasecki commented Dec 3, 2024

DylanDylann commented Dec 10, 2024

github-actions bot commented Dec 12, 2024

github-actions bot commented Dec 12, 2024

shubham1206agra commented Dec 14, 2024

Reviewer Checklist

Screenshots/Videos

srikarparsi left a comment

Choose a reason for hiding this comment

mountiny commented Dec 16, 2024

shubham1206agra commented Dec 16, 2024

j-piasecki commented Dec 16, 2024

mountiny commented Dec 18, 2024

OSBotify commented Dec 19, 2024

github-actions bot commented Dec 23, 2024

github-actions bot commented Dec 23, 2024

github-actions bot commented Dec 23, 2024

github-actions bot commented Dec 24, 2024

github-actions bot commented Dec 24, 2024

github-actions bot commented Dec 24, 2024

github-actions bot commented Dec 24, 2024

github-actions bot commented Dec 26, 2024

[No QA] Fix `CREATE` mutations being dropped by merging transactions #53313

[No QA] Fix `CREATE` mutations being dropped by merging transactions #53313