[Audit][Implementation] hasDraft replacement #37281

kacper-mikolajczak · 2024-02-27T12:16:32Z

Details

This PR is part of the Callstack performance audit. It aims to remove hasDraft property from Report model and re-use existing collection of ONYXKEY.COLLECTION.REPORT_DRAFT_COMMENT to serve the same functionality. It tries to remove overhead coming from calculating draft status when writing a message in the composer.

Fixed Issues

$ #37880
PROPOSAL: https://expensify.slack.com/archives/C05LX9D6E07/p1709036231433249

Tests

Open report
Write a draft message
Go back to LHN
Check if draft pencil icon is correctly displayed
Check if report position in the list has changed properly
Open the same report
Check if draft is correctly displayed
Remove message
Go back to LHN
Check if draft icon disappeared
Check if report position changed to original one

Offline tests

QA Steps

Same as tests

PR Author Checklist

Screenshots/Videos

Android: Native

android.mp4

Android: mWeb Chrome

androidweb.mp4

iOS: Native

ios.mp4

iOS: mWeb Safari

iosweb.mp4

MacOS: Chrome / Safari

web.mp4

MacOS: Desktop

desktop.mp4

This reverts commit 2f0555f.

This reverts commit cdef526.

kacper-mikolajczak · 2024-03-08T14:28:10Z

Due to coupling between Reports and gORIDs method, I was not able to successfully extract the draftReports from Reports. Main reason is lack of ability to dedupe members of one collection and another when merging them together without affecting performance. Below, picture is presented with general overview and issue I've encountered.

This means, at least for now we need to skip the performance benefit of removing hasDraft property. The PR still holds its value as it simplifies the Report model and cleans up a little.

kacper-mikolajczak · 2024-03-22T12:20:46Z

Does the message containing only spaces should be saved as a draft?

By comparing behaviour with Messenger app, the code here does not treat spaces-only messages as valid drafts, thus they are not saved. It can be changed anytime - just let me know what is the descision 👍

src/libs/DraftCommentUtils.ts

kacper-mikolajczak · 2024-03-28T10:08:52Z

tests/unit/SidebarOrderTest.ts

@@ -780,7 +784,12 @@ describe('Sidebar', () => {
                    })

                    // When a new report is added
-                    .then(() => Onyx.merge(`${ONYXKEYS.COLLECTION.REPORT}${report4.reportID}`, report4))
+                    .then(() =>
+                        Promise.all([


@shubham1206agra in order to sync the merges in Onyx, I've used Promise.all here. Let me know if that's the correct way 🙏

@kacper-mikolajczak Why do we need this? Can you explain this a bit?

@shubham1206agra AFAIK, there is no multiSet alternative (except for lower-level Onyx.update) so in order to merge those two values 'at once' (they are done separately but eventual consistency is what we care about), they are wrapped with Promise.all. I am not sure, if other methods would have exact same outcome.

tl;dr; It waits for all the values to be merged successfully so the test can operate on up-to-date values

shubham1206agra · 2024-04-01T11:41:10Z

@kacper-mikolajczak Can you merge main here?

kacper-mikolajczak · 2024-04-02T06:30:55Z

Hi @shubham1206agra, are changes introduced in this PR approved by you?

shubham1206agra · 2024-04-02T06:44:34Z

No 😆 . Its just a coincidence.

kacper-mikolajczak · 2024-04-02T07:50:36Z

@shubham1206agra Could you please review the PR as soon as I resolve the conflicts? Thanks!

PS

Let me know if any help is needed as the PR has some volume 👍

shubham1206agra · 2024-04-03T13:49:46Z

Screen.Recording.2024-04-03.at.7.17.59.PM.mov

@kacper-mikolajczak The LHN is not reordering correctly.

kacper-mikolajczak · 2024-04-04T07:34:17Z

@shubham1206agra Fixed ✅

shubham1206agra · 2024-04-04T14:18:03Z

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 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.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 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.
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-04-04.at.7.46.23.PM.mov

Android: mWeb Chrome

Screen.Recording.2024-04-04.at.7.15.34.PM.mov

iOS: Native

Screen.Recording.2024-04-04.at.7.32.42.PM.mov

iOS: mWeb Safari

Screen.Recording.2024-04-04.at.7.09.29.PM.mov

MacOS: Chrome / Safari

Screen.Recording.2024-04-04.at.7.02.45.PM.mov

MacOS: Desktop

Screen.Recording.2024-04-04.at.7.24.22.PM.mov

melvin-bot · 2024-04-04T14:19:08Z

We did not find an internal engineer to review this PR, trying to assign a random engineer to #37880 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

AndrewGable · 2024-04-04T17:18:37Z

Please fix conflicts and make sure tests are passing, thanks!

kacper-mikolajczak · 2024-04-04T20:03:00Z

Hi @AndrewGable 👋

Please fix conflicts

Conflicts resolved ✅

make sure tests are passing

The failing performance test is expected to happen (please see explanation here). We can set it as a new baseline 👍

AndrewGable · 2024-04-04T22:52:26Z

Merged with a failing perf-test due to #37281 (comment)

OSBotify · 2024-04-04T22:58:56Z

✋ 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-04-08T11:07:50Z

🚀 Deployed to staging by https://github.com/AndrewGable in version: 1.4.61-0 🚀

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

OSBotify · 2024-04-08T13:04:28Z

🚀 Deployed to staging by https://github.com/AndrewGable in version: 1.4.61-0 🚀

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

OSBotify · 2024-04-10T17:22:05Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.4.61-8 🚀

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

kacper-mikolajczak force-pushed the audit/implementation/hasDraft-replacement branch from c0ade66 to 272633a Compare February 27, 2024 16:54

kacper-mikolajczak added 2 commits February 27, 2024 17:57

remove hasDraft from Report model

00c81de

remove reportWithoutHasDraftSelector

d177314

kacper-mikolajczak force-pushed the audit/implementation/hasDraft-replacement branch from 272633a to d177314 Compare February 27, 2024 16:58

kacper-mikolajczak added 8 commits February 27, 2024 18:18

use draft comment to calculate hasDraftComment

eeec9ba

fix shouldREportBeInOptionList

7b8a757

trim the comment for hasDraftComment calculations

9df353b

create draft message store

8876c08

split gORIDs into smaller functions

cdef526

fixing complexity

2f0555f

Revert "fixing complexity"

74c658a

This reverts commit 2f0555f.

Revert "split gORIDs into smaller functions"

024a50c

This reverts commit cdef526.

kacper-mikolajczak force-pushed the audit/implementation/hasDraft-replacement branch from d2c0022 to 024a50c Compare March 8, 2024 14:24

kacper-mikolajczak added 9 commits March 8, 2024 15:40

invalidate reports order on drafts change

3330608

remove hasDraft from tests

bb2da17

fix draftComment computation

b166c50

change name

3fddd59

remain ordering of default Option object

c1214ab

make saveReportComment delete drafts for empty comments

1b245b4

cleanup

059ea4a

do not save drafts with spaces only

e599e5b

prepare draft comment util

7e2c3c5

hurali97 reviewed Mar 22, 2024

View reviewed changes

src/libs/DraftCommentUtils.ts Outdated Show resolved Hide resolved

kacper-mikolajczak added 3 commits March 22, 2024 14:04

waitForCollectionCallback in DraftCommentUtils

a3cd97d

rename draftCommentMap to draftCommentCollection

da1d823

merge & fix to main

7adfbc9

kacper-mikolajczak mentioned this pull request Mar 22, 2024

[HOLD for payment 2024-08-09] [HOLD for payment 2024-08-01] [$250] CRITICAL: Native - Message stays in the Composer after being sent #37896

Closed

6 tasks

fix tests

67a8736

kacper-mikolajczak commented Mar 28, 2024

View reviewed changes

merge main

1575de7

fix list reordering

b52bb0b

shubham1206agra approved these changes Apr 4, 2024

View reviewed changes

melvin-bot bot requested a review from AndrewGable April 4, 2024 14:19

Merge branch 'main' into audit/implementation/hasDraft-replacement

564933c

mountiny assigned kacper-mikolajczak Apr 4, 2024

AndrewGable approved these changes Apr 4, 2024

View reviewed changes

AndrewGable merged commit 9b22258 into Expensify:main Apr 4, 2024
15 of 16 checks passed

rayane-d mentioned this pull request Apr 5, 2024

Add possibility to leave from workspaces and workspace expense chats #35671

Merged

50 tasks

github-actions bot mentioned this pull request Apr 8, 2024

Deploy Checklist: New Expensify 2024-04-08 #39807

Closed

jasperhuangg mentioned this pull request Apr 8, 2024

[$250] mWeb - Chat - The keypad lagging, making it difficult to type or delete characters accurately in Redmi phones #39853

Closed

6 tasks

This was referenced Apr 12, 2024

Deploy Checklist: New Expensify 2024-04-08 #39807 Derevyaa/Expensify-App#1

Closed

Deploy Checklist: New Expensify 2024-04-09 #39808 Derevyaa/Expensify-App#2

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Audit][Implementation] hasDraft replacement #37281

[Audit][Implementation] hasDraft replacement #37281

kacper-mikolajczak commented Feb 27, 2024 •

edited by AndrewGable

Loading

kacper-mikolajczak commented Mar 8, 2024 •

edited

Loading

kacper-mikolajczak commented Mar 22, 2024

kacper-mikolajczak Mar 28, 2024

shubham1206agra Mar 28, 2024

kacper-mikolajczak Mar 28, 2024

shubham1206agra commented Apr 1, 2024

kacper-mikolajczak commented Apr 2, 2024 •

edited

Loading

shubham1206agra commented Apr 2, 2024

kacper-mikolajczak commented Apr 2, 2024 •

edited

Loading

shubham1206agra commented Apr 3, 2024

kacper-mikolajczak commented Apr 4, 2024

shubham1206agra commented Apr 4, 2024

melvin-bot bot commented Apr 4, 2024

AndrewGable commented Apr 4, 2024

kacper-mikolajczak commented Apr 4, 2024

AndrewGable commented Apr 4, 2024

OSBotify commented Apr 4, 2024

OSBotify commented Apr 8, 2024

OSBotify commented Apr 8, 2024

OSBotify commented Apr 10, 2024

[Audit][Implementation] hasDraft replacement #37281

[Audit][Implementation] hasDraft replacement #37281

Conversation

kacper-mikolajczak commented Feb 27, 2024 • edited by AndrewGable Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

kacper-mikolajczak commented Mar 8, 2024 • edited Loading

kacper-mikolajczak commented Mar 22, 2024

kacper-mikolajczak Mar 28, 2024

Choose a reason for hiding this comment

shubham1206agra Mar 28, 2024

Choose a reason for hiding this comment

kacper-mikolajczak Mar 28, 2024

Choose a reason for hiding this comment

shubham1206agra commented Apr 1, 2024

kacper-mikolajczak commented Apr 2, 2024 • edited Loading

shubham1206agra commented Apr 2, 2024

kacper-mikolajczak commented Apr 2, 2024 • edited Loading

shubham1206agra commented Apr 3, 2024

kacper-mikolajczak commented Apr 4, 2024

shubham1206agra commented Apr 4, 2024

Reviewer Checklist

Screenshots/Videos

melvin-bot bot commented Apr 4, 2024

AndrewGable commented Apr 4, 2024

kacper-mikolajczak commented Apr 4, 2024

AndrewGable commented Apr 4, 2024

OSBotify commented Apr 4, 2024

OSBotify commented Apr 8, 2024

OSBotify commented Apr 8, 2024

OSBotify commented Apr 10, 2024

kacper-mikolajczak commented Feb 27, 2024 •

edited by AndrewGable

Loading

kacper-mikolajczak commented Mar 8, 2024 •

edited

Loading

kacper-mikolajczak commented Apr 2, 2024 •

edited

Loading

kacper-mikolajczak commented Apr 2, 2024 •

edited

Loading