Add HOC `withParentReportAction` #18638

grgia · 2023-05-09T13:31:01Z

Details

Create a HOC so we can subscribe to the parent report action.

Uses same pattern as for useCurrentUserPersonalDetails

Fixed Issues

#18755

$ #18769

Tests

Verify that no errors appear in the JS console
Open New Dot in two windows with two accounts A and B
Send a message from A to B (on parent report)
Thread the message and send a reply
Go back to the parent report on A and keep the thread (child report) open on B
Edit the thread parent message on A and ensure that both the header and parent report action preview updates in real-time on B
(WEB) open a thread, focus on compose box and click on the up arrow on keyboard and observe that it edits the message.

QA Steps

Open New Dot in two windows with two accounts A and B
Send a message from A to B (on parent report)
Thread the message and send a reply
Go back to the parent report on A and keep the thread (child report) open on B
Edit the thread parent message on A and ensure that both the header and parent report action preview updates in real-time on B

PR Author Checklist

I linked the correct issue in the ### Fixed Issues section above
I wrote clear testing steps that cover the changes made in this PR
- I added steps for local testing in the Tests section
- I added steps for the expected offline behavior in the Offline steps section
- I added steps for Staging and/or Production testing in the QA steps section
- I added steps to cover 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 tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
I included screenshots or videos for tests on all platforms
I ran the tests on all platforms & verified they passed on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
I followed proper code patterns (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
  - If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
- 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 Copy label 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
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I followed the guidelines as stated in the Review Guidelines
I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
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
I verified that if a function's arguments changed that all usages have also been updated correctly
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(themeColors.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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Mobile Web - Chrome

N/A

Mobile Web - Safari

N/A

Desktop

N/A

iOS

N/A

Android

N/A

src/components/withParentReportAction.js

melvin-bot · 2023-05-10T15:22:41Z

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

chiragsalian

It feels like this HOC should be created and implemented at least in one place. Otherwise its kinda hard to see its benefit.

grgia · 2023-05-11T08:44:45Z

@chiragsalian I agree, let's hold on https://github.com/Expensify/App/pull/18522/files

…eport action

grgia · 2023-05-25T11:33:41Z

will update this week, just lower priority (refactor) than other thread bugs

fedirjh · 2023-06-08T08:38:11Z

@grgia When you edit the parent report action from the thread, the edit input appears. However, when you save it, the parent report action is not updated, unlike when you update it from the parent report. I think we should either fix this issue or disable the ability to edit the parent report action from the thread.

Screen.Recording.2023-06-08.at.9.33.37.AM.mov

grgia · 2023-06-08T12:43:23Z

@fedirjh is this reproducible on main?

grgia · 2023-06-08T12:53:35Z

Dropping as a todo: need to use here too #20273

fedirjh · 2023-06-08T18:52:33Z

is this reproducible on main?

Yes , the update comment request is made to server however the component doesn’t re-render.

Bug.mov

fedirjh · 2023-06-15T08:23:25Z

Wa have a failing lint test . should run prettier

grgia · 2023-06-15T10:14:20Z

@fedirjh done, thank you!

fedirjh · 2023-06-15T14:52:21Z

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 / Chrome
- iOS / native
- iOS / 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 approved by marketing by adding the Waiting for Copy label 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
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(themeColors.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 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

Web

Screen.Recording.2023-06-15.at.12.22.31.PM.mov

Mobile Web - Chrome

Screen.Recording.2023-06-15.at.1.14.00.PM.mov

Mobile Web - Safari

Screen.Recording.2023-06-15.at.12.53.35.PM.mov

Desktop

Screen.Recording.2023-06-15.at.12.42.48.PM.mov

Screen.Recording.2023-06-15.at.12.42.17.PM.mov

iOS

Screen.Recording.2023-06-15.at.12.52.57.PM.mov

Android

Screen.Recording.2023-06-15.at.1.12.27.PM.mov

fedirjh

Looks good and tests well , we still have this issue but it's not related to this PR

cc @chiragsalian

melvin-bot · 2023-06-16T15:07:53Z

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

grgia · 2023-06-19T10:49:26Z

@fedirjh merged main

fedirjh

LGTM and tests well

🎀 👀 🎀 C+ reviewed

melvin-bot · 2023-06-23T07:53:53Z

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

marcochavezf

LGTM, just a minor comment

marcochavezf · 2023-06-23T18:27:44Z

src/components/withParentReportAction.js

+        parentReportActions: {},
+    };
+    function WithParentReportAction(props) {
+        const parentReportActionID = props.report && props.report.parentReportActionID ? props.report.parentReportActionID : {};


Ah why are we setting an empty object for parentReportActionID? Additionally, shouldn't we add parentReportActionID to reportPropTypes?

chiragsalian · 2023-06-23T21:40:52Z

I am concerned if this PR is needed tbh. I would rather see a proper long-term solution i.e., using withOnyx that would work for any onyx keys to achieve this same behavior vs building a very specific withParentReportAction.js component. Only because I'm concerned others would copy the same pattern instead of us building a single reusable solution.

@marcaaron since you are more familiar with withOnyx tagging you here for your opinion (assigning review to you for visibility but feel free to unassign if you are unable to review/share thoughts).

grgia · 2023-07-03T11:00:02Z

@chiragsalian I agree with that solution, we attempted a selector pattern with Onyx, but couldn't get it working with dependencies from other onyx props. For example, needing to subscribe to a certain report you're referencing to get the parentReportActionID from. You'd initialize both withOnyx values at the same time, even though one depends on the other (which was what was breaking the selector when we were attempting to get that to work)

chiragsalian · 2023-07-03T16:55:37Z

we attempted a selector pattern with Onyx, but couldn't get it working with dependencies from other onyx props

So I guess my question is, since there is no rush to get this feature out the door why not focus on a solution that can be reused in multiple places? Do we feel like its not worth focusing on a more scalable solution now?

marcaaron · 2023-07-03T22:28:58Z

I would rather see a proper long-term solution i.e., using withOnyx that would work for any onyx keys to achieve this same behavior

Ok so I see the behavior we want is to get a particular report action that belongs to the props.report.parentReportActionID.

My suggestion would be to:

Pass the report as we are already planning to do
Get the specific report action by using a selector (maybe we can make it reusable) like so:

parentReportAction: {
    key: ({report}) => `${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${report.parentReportID}`,
    selector: (parentReportActions, props) => parentReportActions[props.report.parentReportActionID],
},

I think something like this would work and maybe a bit simpler than creating a new HOC.

marcaaron · 2023-07-12T19:52:05Z

Checking in to see if anyone had thoughts on the comment I shared above? Thanks!

grgia · 2023-07-13T12:28:06Z

@marcaaron I apologize for the delay, I agree and I will close this PR. I think we need to add the selector. So long as we pass the entire report down, that should work

grgia · 2023-07-13T12:31:48Z

As a note, I think we should work on that approach in a separate issue as it will require ONYX changes since we could not originally get passing props to the selector to work when we were in the first phase of implementation @marcaaron

Add HOC for subscribing to Parent Report Action

9541ca9

grgia self-assigned this May 9, 2023

grgia requested a review from chiragsalian May 9, 2023 13:36

grgia added 2 commits May 9, 2023 14:47

Remove usage change for easy merge

48ab2e9

Fix lodashGet to match key

d97026b

grgia mentioned this pull request May 9, 2023

Pass withOnyx instance props to selectors Expensify/react-native-onyx#247

Merged

grgia commented May 9, 2023

View reviewed changes

src/components/withParentReportAction.js Outdated Show resolved Hide resolved

grgia changed the title ~~[WIP] Add HOC withParentReportAction~~ Add HOC withParentReportAction May 10, 2023

grgia marked this pull request as ready for review May 10, 2023 15:22

grgia requested a review from a team as a code owner May 10, 2023 15:22

melvin-bot bot requested review from marcochavezf and removed request for a team May 10, 2023 15:22

chiragsalian reviewed May 10, 2023

View reviewed changes

grgia changed the title ~~Add HOC withParentReportAction~~ [HOLD PR 18522] Add HOC withParentReportAction May 11, 2023

grgia added 9 commits May 11, 2023 11:46

Merge branch 'main' into georgia-ThreadWithParentReportActionHOC

c77546f

prettier, use in HeaderView

ed9ed7b

Merge branch 'main' into georgia-ThreadWithParentReportActionHOC

793412e

Make inline thread UI subscribe to changes on child report / parent r…

6f0ef3c

…eport action

Merge branch 'main' into georgia-ThreadWithParentReportActionHOC

b7bb772

undo ReportActionItemThread

d9b2ce0

Undo changes to ReportActionItem

e86e09f

use HOC in ReportActionItemParentAction

43a402a

prettier

db913ba

grgia changed the title ~~[HOLD PR 18522] Add HOC withParentReportAction~~ Add HOC withParentReportAction May 17, 2023

grgia changed the title ~~Add HOC withParentReportAction~~ [HOLD updating ] Add HOC withParentReportAction May 17, 2023

Merge branch 'main' into georgia-ThreadWithParentReportActionHOC

fd496e2

tienifr mentioned this pull request May 22, 2023

[HOLD for payment 2023-07-05] [$1000] delete message functionality not working for first message in thread #19363

Closed

6 tasks

prettier

89a1fe7

grgia changed the title ~~Add HOC withParentReportAction~~ [updating] Add HOC withParentReportAction Jun 8, 2023

grgia added 2 commits June 14, 2023 13:30

Merge branch 'main' into georgia-ThreadWithParentReportActionHOC

acf5446

use HOC in ReportActionCompose

4417f90

grgia changed the title ~~[updating] Add HOC withParentReportAction~~ Add HOC withParentReportAction Jun 14, 2023

functional comp

2cabfa6

prettier

f2399d2

fedirjh approved these changes Jun 16, 2023

View reviewed changes

Merge branch 'main' into georgia-ThreadWithParentReportActionHOC

cac067c

fedirjh approved these changes Jun 23, 2023

View reviewed changes

marcochavezf reviewed Jun 23, 2023

View reviewed changes

chiragsalian requested a review from marcaaron June 23, 2023 21:40

grgia closed this Jul 13, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add HOC `withParentReportAction` #18638

Add HOC `withParentReportAction` #18638

grgia commented May 9, 2023 •

edited

Loading

melvin-bot bot commented May 10, 2023

chiragsalian left a comment

grgia commented May 11, 2023

grgia commented May 25, 2023

fedirjh commented Jun 8, 2023

grgia commented Jun 8, 2023

grgia commented Jun 8, 2023

fedirjh commented Jun 8, 2023

fedirjh commented Jun 15, 2023 •

edited

Loading

grgia commented Jun 15, 2023

fedirjh commented Jun 15, 2023

fedirjh left a comment

melvin-bot bot commented Jun 16, 2023

grgia commented Jun 19, 2023

fedirjh left a comment

melvin-bot bot commented Jun 23, 2023

marcochavezf left a comment •

edited

Loading

marcochavezf Jun 23, 2023

chiragsalian commented Jun 23, 2023

grgia commented Jul 3, 2023

chiragsalian commented Jul 3, 2023

marcaaron commented Jul 3, 2023

marcaaron commented Jul 12, 2023

grgia commented Jul 13, 2023

grgia commented Jul 13, 2023

Add HOC withParentReportAction #18638

Add HOC withParentReportAction #18638

Conversation

grgia commented May 9, 2023 • edited Loading

Details

Fixed Issues

Tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented May 10, 2023

chiragsalian left a comment

Choose a reason for hiding this comment

grgia commented May 11, 2023

grgia commented May 25, 2023

fedirjh commented Jun 8, 2023

grgia commented Jun 8, 2023

grgia commented Jun 8, 2023

fedirjh commented Jun 8, 2023

fedirjh commented Jun 15, 2023 • edited Loading

grgia commented Jun 15, 2023

fedirjh commented Jun 15, 2023

Reviewer Checklist

Screenshots/Videos

fedirjh left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Jun 16, 2023

grgia commented Jun 19, 2023

fedirjh left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Jun 23, 2023

marcochavezf left a comment • edited Loading

Choose a reason for hiding this comment

marcochavezf Jun 23, 2023

Choose a reason for hiding this comment

chiragsalian commented Jun 23, 2023

grgia commented Jul 3, 2023

chiragsalian commented Jul 3, 2023

marcaaron commented Jul 3, 2023

marcaaron commented Jul 12, 2023

grgia commented Jul 13, 2023

grgia commented Jul 13, 2023

Add HOC `withParentReportAction` #18638

Add HOC `withParentReportAction` #18638

grgia commented May 9, 2023 •

edited

Loading

fedirjh commented Jun 15, 2023 •

edited

Loading

marcochavezf left a comment •

edited

Loading