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 20759] Remove the *New* notifiers just as the deletion starts. #21557

Merged
merged 10 commits into from
Jul 3, 2023
Merged

[FIX 20759] Remove the *New* notifiers just as the deletion starts. #21557

merged 10 commits into from
Jul 3, 2023

Conversation

DanutGavrus
Copy link
Contributor

Details

When deleting the last unread message, the New marker briefly appears for a second before disappearing & New Messages notification persists after message is deleted.

Fixed Issues

$ #20759
PROPOSAL: #20759 (comment)

Tests

Same as QA Steps.

  • Verify that no errors appear in the JS console

Offline tests

No offline tests.

QA Steps

I. New marker delay at hiding:

  1. Open any chat;
  2. Send a new message;
  3. Mark it as unread;
  4. Delete the last message;
  5. Verify that the green New marker disappears with no delay.

II. New Messages infinite notification:

  1. Open any chat;
  2. Send enough messages so you are able to scroll;
  3. Mark the last message as unread;
  4. Start scrolling up and see that the New Messages* notification appears;
  5. Delete the last message;
  6. Start scrolling up and verify that no New Messages notification disappears.
  • 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 / 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
web.mp4
Mobile Web - Chrome
android_web.mp4
Mobile Web - Safari
ios_safari.mp4
Desktop
desktop.mp4
iOS
ios_native.mp4
Android
android_native.mp4

@DanutGavrus DanutGavrus requested a review from a team as a code owner June 26, 2023 11:37
@melvin-bot melvin-bot bot requested review from mollfpr and removed request for a team June 26, 2023 11:37
@melvin-bot
Copy link

melvin-bot bot commented Jun 26, 2023

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

@@ -218,6 +219,15 @@ class ReportActionsView extends React.Component {
});
}

// If the last unread message was deleted, remove the *New* green marker and the *New Messages* notification at scroll just as the deletion starts.
if (this.props.reportActions.length > 0 && this.props.reportActions[0].pendingAction === CONST.RED_BRICK_ROAD_PENDING_ACTION.DELETE && !this.props.network.isOffline) {
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've added !this.props.network.isOffline in order to have a consistent behavior while offline. In current staging, while offline, the New markers do not disappear. In this PR, without this check, while offline, the New markers would disappear only for the last message. See this video:

offline_consistency.mp4

Copy link
Contributor

Choose a reason for hiding this comment

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

Great improvement @DanutGavrus 👍

Copy link
Contributor

Choose a reason for hiding this comment

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

Screen.Recording.2023-06-28.at.01.09.36.mov

I think the condition can be improved. Right now, it's called twice.

Copy link
Contributor Author

@DanutGavrus DanutGavrus Jun 28, 2023

Choose a reason for hiding this comment

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

I've added a new condition in order to prevent unnecessary re-renders.

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've also added now ReportUtils.isUnread(this.props.report) inside the condition, such that is does not return true anymore when deleting the last message if it(or any other one) was NOT marked as unread.

@mollfpr
Copy link
Contributor

mollfpr commented Jun 26, 2023

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
21557.Web.mov
Mobile Web - Chrome
21557.mWeb.Chrome.webm
Mobile Web - Safari
21557.mWeb.Safari.mp4
Desktop
21557.Desktop.mov
iOS
21557.iOS.mp4
Android
21557.Android.webm

@mollfpr
Copy link
Contributor

mollfpr commented Jun 27, 2023

@DanutGavrus The marker is immediately removed for the last new message, but it's still delayed for the oldest last message.

Screen.Recording.2023-06-27.at.23.10.41.mov

@DanutGavrus
Copy link
Contributor Author

@mollfpr

The marker is immediately removed for the last new message, but it's still delayed for the oldest last message.

I can not reproduce. Is it still happening to you? If so, are you able to always reproduce it?

reproduce.mp4

@mollfpr
Copy link
Contributor

mollfpr commented Jun 27, 2023

The chat I opened is messed up. The delay is gone after I re-sign into the account and open the same chat.

Thanks @DanutGavrus for confirming it!

Copy link
Contributor

@mollfpr mollfpr left a comment

Choose a reason for hiding this comment

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

Tests well, but we still can improve the condition to prevent unnecessary re-render.

@@ -218,6 +219,15 @@ class ReportActionsView extends React.Component {
});
}

// If the last unread message was deleted, remove the *New* green marker and the *New Messages* notification at scroll just as the deletion starts.
if (this.props.reportActions.length > 0 && this.props.reportActions[0].pendingAction === CONST.RED_BRICK_ROAD_PENDING_ACTION.DELETE && !this.props.network.isOffline) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Screen.Recording.2023-06-28.at.01.09.36.mov

I think the condition can be improved. Right now, it's called twice.

@DanutGavrus
Copy link
Contributor Author

@mollfpr I've run npm run prettier but there's still a lint check fail. Do you know what I should do now? Thanks!

const newMarkerReportActionID = ReportUtils.getNewMarkerReportActionID(this.props.report, reportActionsWithoutPendingOne);
if (newMarkerReportActionID !== this.state.newMarkerReportActionID) {
this.setState({
newMarkerReportActionID: newMarkerReportActionID,
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
newMarkerReportActionID: newMarkerReportActionID,
newMarkerReportActionID,

Fix the lint.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@mollfpr Thanks! Fixed lint issue & merged main again.

@mollfpr
Copy link
Contributor

mollfpr commented Jun 29, 2023

@DanutGavrus There's still a delay after going to the last message using the new message button at the top.

Screen.Recording.2023-06-29.at.17.46.07.mov

Step:

  1. Open chat that has enough message to scroll
  2. Mark as unread on the last message
  3. Scroll up and press New message at the top to scroll to bottom of the chat
  4. Delete the message

@mollfpr
Copy link
Contributor

mollfpr commented Jun 29, 2023

@DanutGavrus I mean, there's a delay on the new marker removed from the page.

@DanutGavrus
Copy link
Contributor Author

I mean, there's a delay on the new marker removed from the page.

@mollfpr Investigating now. Sorry for the confusion, I deleted my last comment as I've re-read your Steps.

@DanutGavrus
Copy link
Contributor Author

DanutGavrus commented Jun 29, 2023

There's still a delay after going to the last message using the new message button at the top.

  1. Clicking on the button calls scrollToBottomAndMarkReportAsRead;
  2. I've added ReportUtils.isUnread(this.props.report) in my condition in a previous commit in order to not execute the condition if the report has no unread messages;
  3. Removing ReportUtils.isUnread(this.props.report) would work, but it seems like a workaround, not a fix.

I've reported a similar bug on Slack here and that fix will also fix your finding from the root cause. Would you suggest to implement that in this PR too?

@DanutGavrus
Copy link
Contributor Author

@mollfpr The issue has been created meanwhile:
#21875

@mollfpr
Copy link
Contributor

mollfpr commented Jun 30, 2023

Clicking the New Message** floating button should remove the marker. In that case, the issue I mentioned earlier here will not exist.

@DanutGavrus The bug you reported might be related to the above issue, so I am continuing the PR test.

Copy link
Contributor

@mollfpr mollfpr left a comment

Choose a reason for hiding this comment

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

LGTM and tests well 👍

@melvin-bot melvin-bot bot requested a review from techievivek June 30, 2023 18:04
Copy link
Contributor

@techievivek techievivek left a comment

Choose a reason for hiding this comment

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

Looks good.

@techievivek techievivek merged commit d8e6cdf into Expensify:main Jul 3, 2023
@OSBotify
Copy link
Contributor

OSBotify commented Jul 3, 2023

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

@DanutGavrus DanutGavrus deleted the fix/20759-remove-new-notifiers-when-deleting-last-message branch July 3, 2023 10:46
@OSBotify
Copy link
Contributor

OSBotify commented Jul 3, 2023

🚀 Deployed to staging by https://github.com/techievivek in version: 1.3.36-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Jul 5, 2023

🚀 Deployed to production by https://github.com/Julesssss in version: 1.3.36-5 🚀

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

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.

4 participants