Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix "New message" button shows when resolving an actionable mention whisper #50247

Conversation

bernhardoj
Copy link
Contributor

Details

Resolving an actionable mention whisper causes the "New message" button to shows up.

Fixed Issues

$ #49824
PROPOSAL: #49824 (comment)

Tests

Same as QA Steps

  • Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

  1. Open a room or create a new one with at least 25 messages
  2. Mention a user that is not in the room
  3. After receiving the concierge whisper, close (switch) and reopen the room
  4. Press "Do nothing" on the whisper
  5. Verify there is no floating "New message" button shows
  • Verify that no errors appear in the JS console

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: mWeb Chrome
    • iOS: Native
    • iOS: mWeb 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 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 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 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.

Screenshots/Videos

Android: Native
android.mp4
Android: mWeb Chrome
iOS: Native
ios.mp4
iOS: mWeb Safari
ios.mweb.mp4
MacOS: Chrome / Safari
web.mp4
MacOS: Desktop
desktop.mp4

@bernhardoj bernhardoj requested a review from a team as a code owner October 4, 2024 15:04
@melvin-bot melvin-bot bot requested review from ishpaul777 and removed request for a team October 4, 2024 15:05
Copy link

melvin-bot bot commented Oct 4, 2024

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

@bernhardoj
Copy link
Contributor Author

bernhardoj commented Oct 4, 2024

Can't send message on android mweb.

android.mweb.mp4

@@ -715,8 +735,7 @@ function shouldReportActionBeVisibleAsLastAction(reportAction: OnyxInputOrEntry<
return (
shouldReportActionBeVisible(reportAction, reportAction.reportActionID) &&
!(isWhisperAction(reportAction) && !isReportPreviewAction(reportAction) && !isMoneyRequestAction(reportAction)) &&
!(isDeletedAction(reportAction) && !isDeletedParentAction(reportAction)) &&
!isResolvedActionTrackExpense(reportAction)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I remove checking isResolvedActionTrackExpense because shouldReportActionBeVisible already covers it with the new condition.

@@ -329,8 +329,7 @@ Onyx.connect({
ReportActionUtils.shouldReportActionBeVisible(reportAction, actionKey) &&
!ReportActionUtils.isWhisperAction(reportAction) &&
reportAction.actionName !== CONST.REPORT.ACTIONS.TYPE.CREATED &&
reportAction.pendingAction !== CONST.RED_BRICK_ROAD_PENDING_ACTION.DELETE &&
!ReportActionUtils.isResolvedActionTrackExpense(reportAction),
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

reportScrollManager.scrollToIndex(index);
}
}, [index, originalMessage, prevActionResolution, reportScrollManager, isActionableWhisper, hasResolutionInOriginalMessage]);

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed this workaround because the issue doesn't happen anymore after we exclude the resolved actionable whisper from the list.

@ishpaul777
Copy link
Contributor

ishpaul777 commented Oct 8, 2024

will finish this today in few hours

@ishpaul777
Copy link
Contributor

Open a room or create a new one with at least 25 messages
Mention a user that is not in the room
After receiving the concierge whisper, close (switch) and reopen the room
Press "Do nothing" on the whisper
Verify there is no floating "New message" button shows

For these steps it works well, but after log out and log in and opening the room again shows the floating "New message" button again, can you please investigate if we can resolve it @bernhardoj

Screen.Recording.2024-10-09.at.2.19.00.AM.mov

@bernhardoj
Copy link
Contributor Author

I'm able to repro it by simply reopening the report. Here is what happens:

  1. Send a user mention that is not part of the room
  2. A whisper shows as the last action, but the report lastVisibleActionCreated is not updated (BE issue)
  3. Close and reopen the report, the updated report lastVisibleActionCreated is received from OpenReport
  4. Resolve the whisper, we optimistically update the lastVisibleActionCreated to the previous action, that is the user mention, but the last action is still the whisper, which what we are fixing here.
  5. Close and reopen the report, OpenReport sends the resolved whisper created as the report lastVisibleActionCreated.

Since we don't include the whisper as the last action anymore, the new message shows.

I think BE shouldn't send the resolved whisper created as the report lastVisibleActionCreated.


However, if that's the expected behavior, then we shouldn't optimistically update the lastVisibleActionCreated to the previous action when resolving whisper (step 4).

@ishpaul777
Copy link
Contributor

ishpaul777 commented Oct 9, 2024

Thanks for investigation!

I think BE shouldn't send the resolved whisper created as the report lastVisibleActionCreated.

i do agree with this 👍, pulling @youssef-lr early on this PR to get some help with this bug which appears to need BE changes

@ishpaul777
Copy link
Contributor

ishpaul777 commented Oct 16, 2024

Not overdue, I bumped Youssef in slack (C+ channel) yesterday

@paultsimura
Copy link
Contributor

We need to resolve this as well because it is blocking #49599:

  1. A whisper shows as the last action, but the report lastVisibleActionCreated is not updated (BE issue)

IMO, we should make the following BE changes:

  • When sending an actionable whisper, the server must update the report.lastVisibleActionCreated with the creation date of this AW.
  • When resolving the actionable whisper, the server must update the report.lastVisibleActionCreated with the creation date of the action that goes before this resolved AW.

@youssef-lr
Copy link
Contributor

I'm able to repro it by simply reopening the report. Here is what happens:

  1. Send a user mention that is not part of the room
  2. A whisper shows as the last action, but the report lastVisibleActionCreated is not updated (BE issue)
  3. Close and reopen the report, the updated report lastVisibleActionCreated is received from OpenReport
  4. Resolve the whisper, we optimistically update the lastVisibleActionCreated to the previous action, that is the user mention, but the last action is still the whisper, which what we are fixing here.
  5. Close and reopen the report, OpenReport sends the resolved whisper created as the report lastVisibleActionCreated.

I'm not able to reproduce this locally, can we try again?

@bernhardoj
Copy link
Contributor Author

bernhardoj commented Oct 19, 2024

@youssef-lr Still happens for me.

web.mp4

The new message doesn't show because the room has less than 25 messages. I forgot to add more messages before recording, but the above video shows the comparison between the report.lastVisibleActionCreated and the last action created.

const canScrollToNewerComments = !isLoadingInitialReportActions && !hasNewestReportAction && sortedReportActions.length > 25 && !isLastPendingActionIsDelete;

Here is the video with the new message shows.

web.2.mp4

@bernhardoj
Copy link
Contributor Author

@youssef-lr just in case you missed the above comment ☝️

@ishpaul777
Copy link
Contributor

@youssef-lr gentle bump 🙇

@ishpaul777
Copy link
Contributor

ishpaul777 commented Oct 29, 2024

@bernhardoj can you please sync main & retest again and start a thread in #expensify-open-source if issue is still reproducable, Tag me if you do. Thanks!

@bernhardoj
Copy link
Contributor Author

It's still reproducible. Here is the thread.

@paultsimura
Copy link
Contributor

@dangrous could you please confirm these BE changes also cover the BE part of this PR?

@dangrous
Copy link
Contributor

hi @paultsimura! The backend changes do NOT currently cover this case - I only updated the behavior when receiving the whisper, not when resolving it. I can look into that too, but I wasn't aware of it at the time

@ishpaul777
Copy link
Contributor

ishpaul777 commented Nov 18, 2024

@bernhardoj Will you please merge main give this a test and let us know if there's any left to do or it works well as is?

Copy link
Contributor

@dangrous dangrous left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ugh that new lint rule makes these very hard to review. I think the actual code diff looks good! One minor change and then should be good on my end

src/libs/ReportActionsUtils.ts Show resolved Hide resolved
@youssef-lr
Copy link
Contributor

Conflicts @bernhardoj

@bernhardoj
Copy link
Contributor Author

Fixed

@ishpaul777
Copy link
Contributor

@bernhardoj we have conflicts 😭

@bernhardoj
Copy link
Contributor Author

@youssef-lr @ishpaul777 fixed

dangrous
dangrous previously approved these changes Jan 21, 2025
Copy link
Contributor

@dangrous dangrous left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! One Typescript question I'm curious about - not a blocker though!

src/libs/ReportActionsUtils.ts Show resolved Hide resolved
@dangrous
Copy link
Contributor

@ishpaul777 I think the reviewer checklist must have changed since you filled it out, mind updating with the latest so the check is happy?

@ishpaul777
Copy link
Contributor

done!

@ishpaul777
Copy link
Contributor

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
Screen.Recording.2025-01-14.at.1.54.53.AM.mov
Android: mWeb Chrome
Screen.Recording.2025-01-14.at.1.58.44.AM.mov
iOS: Native
Screen.Recording.2025-01-14.at.1.36.39.AM.mov
iOS: mWeb Safari
Screen.Recording.2025-01-14.at.1.36.39.AM.mov
MacOS: Chrome / Safari
Screen.Recording.2025-01-14.at.2.04.55.AM.mov
MacOS: Desktop
Screen.Recording.2025-01-11.at.1.20.22.AM.mov

@dangrous
Copy link
Contributor

Great. @youssef-lr all yours, though I think you may be out sick? I can merge tomorrow if you're still not around. I hope you feel better!

@dangrous
Copy link
Contributor

oh noooo i was coming in here to merge, but looks like we have conflicts now. @bernhardoj mind handling those?

@bernhardoj
Copy link
Contributor Author

@dangrous fixed

Copy link
Contributor

@dangrous dangrous left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@dangrous dangrous merged commit d930fea into Expensify:main Jan 23, 2025
17 checks passed
@OSBotify
Copy link
Contributor

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

Copy link
Contributor

🚀 Deployed to staging by https://github.com/dangrous in version: 9.0.90-0 🚀

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

@pecanoro
Copy link
Contributor

I think this PR caused this bug here.

Copy link
Contributor

🚀 Deployed to production by https://github.com/yuwenmemon in version: 9.0.90-6 🚀

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

@dangrous
Copy link
Contributor

@ishpaul777 @bernhardoj I know you partially reverted this PR to fix that bug ^ - do we need a new fix for this, or are we good?

@bernhardoj
Copy link
Contributor Author

I explained the root cause of that issue on the PR and provided a proper fix without partially reverting the PR.

@dangrous
Copy link
Contributor

Ah okay great!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants