Remove Onyx.connect for the key REPORT_DRAFT_COMMENT#79456
Conversation
melvin-bot
Bot
requested review from
heyjennahay and
parasharrajat
and removed request for
a team
|
@parasharrajat 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] |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 7ab394cb0c
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
| } | ||
|
|
||
| handlePreexistingReport(report); | ||
| handlePreexistingReport(report, allReportDraftComments?.[`${ONYXKEYS.COLLECTION.REPORT_DRAFT_COMMENT}${report.reportID}`]); | ||
|
|
There was a problem hiding this comment.
Because draftReportComment is captured from allReportDraftComments at report-collection time, the value is fixed before the InteractionManager.runAfterInteractions callback runs. If the user’s draft comment is saved to Onyx between the report collection callback and the InteractionManager callback (a common timing window when an optimistic DM is replaced by a preexisting report), handlePreexistingReport will treat it as missing and skip the transfer, then clear the optimistic report draft—effectively dropping the user’s draft. Previously the draft was read inside handlePreexistingReport right before the transfer, so late-arriving drafts were still moved.
Useful? React with 👍 / 👎.
Codecov Report❌ Looks like you've decreased code coverage for some files. Please write tests to increase, or at least maintain, the existing level of code coverage. See our documentation here for how to interpret this table.
|
| }); | ||
|
|
||
| let allReportDraftComments: Record<string, string | undefined> = {}; | ||
| Onyx.connectWithoutView({ |
There was a problem hiding this comment.
Add a comment explaining the use of this.
There was a problem hiding this comment.
Can you please review this if we can remove this key completely?
There was a problem hiding this comment.
I don't think we can remove it completely because handlePreexistingReport is used in this util file, not in the React component, and it needs the reportDraftComment
There was a problem hiding this comment.
We already used many connectWithoutView in this file, so I think it's better to move allReportDraftComments here
There was a problem hiding this comment.
So we need to refactor the report subscription as well, so that we can use connectWithoutView here. There is already a issue for that. Then we can remove this as well.
There was a problem hiding this comment.
I mean, we should first remove the report key subscription at line 1071 so that we don't need to pass draft_comment to handlePreexistingReport.
There was a problem hiding this comment.
I don't think we need to remove this report key subscription. Here's my plan
- Remove Onyx.connect for the key REPORT_DRAFT_COMMENT in actions/Report.ts
- Keep Onyx.connectWithoutView for the key ONYXKEYS.COLLECTION.REPORT in ReportUtils.ts, but just use it to trigger
handlePreexistingReportand removereportsByPolicyIDbecausehandlePreexistingReportonly run on background. If we want to remove connectWithoutView for the key ONYXKEYS.COLLECTION.REPORT totally, we have to handlehandlePreexistingReportsomewhere else, as I think it's not necessary - Refactor all functions that use reportsByPolicyID in ReportUtils.ts
What do you think?
There was a problem hiding this comment.
OK, I read through all that, and looked at the code, and I think @dukenv0307 is on the right track, with one small suggestion:
Keep Onyx.connectWithoutView for the key ONYXKEYS.COLLECTION.REPORT in ReportUtils.ts
Let's move it somewhere else, to it's own file, where handlePreexistingReport is the ONLY thing done in that file. This is what we prefer for code that uses Onyx.connectWithoutView() because it makes it much more apparant that it's completely separated from any UI anywhere.
Refactor all functions that use reportsByPolicyID in ReportUtils.ts
100% agree here.
|
Product review not required. Removing myself and unsubscribing |
|
@parasharrajat It's ready for review again |
parasharrajat
left a comment
parasharrajat
left a comment
There was a problem hiding this comment.
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 Issuessection 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
Testssection - I verified the steps for Staging and/or Production testing are in the
QA stepssection - 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 verified the steps for local testing are in the
- 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.
toggleReportand notonIconClick). - 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 approved by marketing by adding the
Waiting for Copylabel for a copy review 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
- 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.
- 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 usingAvatarhave 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
thisproperly so there are no scoping issues (i.e. foronClick={this.submit}the methodthis.submitshould be bound tothisin the constructor) - Any internal methods bound to
thisare necessary to be bound (i.e. avoidthis.submit = this.submit.bind(this);ifthis.submitis never passed to a component event handler likeonClick) - 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
Avataris modified, I verified thatAvataris 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 form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added
Designlabel so the design team can review the changes.
- If a new page is added, I verified it's using the
ScrollViewcomponent to make it scrollable when more elements are added to the page. - If the
mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps. - I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.
22.01.2026_16.17.59_REC.mp4
🎀 👀 🎀 C+ reviewed
|
We did not find an internal engineer to review this PR, trying to assign a random engineer to #73663 as well as to this PR... Please reach out for help on Slack if no one gets assigned! |
| callback: (value) => (allReportDraftComments = value ?? {}), | ||
| }); | ||
|
|
||
| Onyx.connectWithoutView({ |
There was a problem hiding this comment.
This is great, I really love seeing this here. Would you mind adding some pretty verbose comments to explain what the purpose of this is? I don't think I really understand why we have handlePreexistingReport() in the first place.
| @@ -0,0 +1,32 @@ | |||
| import type {OnyxCollection} from 'react-native-onyx'; | |||
| import Onyx from 'react-native-onyx'; | |||
| import {handlePreexistingReport} from '@libs/actions/Report'; | |||
There was a problem hiding this comment.
How difficult would it be to move the entire function to this file, since this is the only file it's referenced in?
| continue; | ||
| } | ||
|
|
||
| handlePreexistingReport(report, allReportDraftComments?.[`${ONYXKEYS.COLLECTION.REPORT_DRAFT_COMMENT}${report.reportID}`]); |
There was a problem hiding this comment.
Methods should be named for what the do, not what they "handle", so I think handlePreexistingReport() needs renamed to be more specific. After looking at the code a little more, maybe we should call this replaceOptimisticReportWithActualReport() or something like that.
| }); | ||
| }); | ||
|
|
||
| describe('replaceOptimisticReportWithActualReport', () => { |
There was a problem hiding this comment.
Please move this also in its own file now.
|
@parasharrajat Thanks, it's ready for review again |
| let allReports: OnyxCollection<Report>; | ||
|
|
||
| const allReportActions: OnyxCollection<ReportActions> = {}; | ||
| Onyx.connect({ |
| import {DeviceEventEmitter, InteractionManager} from 'react-native'; | ||
| import type {OnyxCollection} from 'react-native-onyx'; | ||
| import Onyx from 'react-native-onyx'; | ||
| import {saveReportDraftComment} from '@libs/actions/Report'; |
There was a problem hiding this comment.
@parasharrajat, sorry, what do you mean?
There was a problem hiding this comment.
There is an warning here @dukenv0307 Check the files.
There was a problem hiding this comment.
Unexpected subpath import via alias '@libs/actions/Report'. Use './Report' instead
| let allReports: OnyxCollection<Report>; | ||
|
|
||
| const allReportActions: OnyxCollection<ReportActions> = {}; | ||
| Onyx.connectWithoutView({ |
There was a problem hiding this comment.
Each ConnectWithoutView needs a comment on why we are using this. Can you please add one liner comments one each
tgolen
left a comment
tgolen
left a comment
There was a problem hiding this comment.
The comment you added looks really great. Thank you!
|
@dukenv0307 2 comments then we can merge. |
|
@parasharrajat Done |
|
✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release. |
|
🚀 Deployed to staging by https://github.com/inimaga in version: 9.3.9-0 🚀
|
|
🚀 Deployed to production by https://github.com/roryabraham in version: 9.3.9-2 🚀
|
6 participants
Explanation of Change
Fixed Issues
$ #73663
PROPOSAL:
Tests
Offline tests
QA Steps
PR Author Checklist
### Fixed Issuessection aboveTestssectionOffline stepssectionQA stepssectioncanBeMissingparam foruseOnyxtoggleReportand notonIconClick)src/languages/*files and using the translation methodSTYLE.md) were followedAvatar, I verified the components usingAvatarare working as expected)StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))npm run compress-svg)Avataris modified, I verified thatAvataris working as expected in all cases)Designlabel and/or tagged@Expensify/designso the design team can review the changes.ScrollViewcomponent to make it scrollable when more elements are added to the page.mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps.Screenshots/Videos
Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
web-resize.mp4