Fix newMarker disappearing when deleting the comment that was marked unread. by tylerkaraszewski · Pull Request #14032 · Expensify/App

tylerkaraszewski · 2023-01-05T20:00:25Z

Details

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/251047
PROPOSAL: N/A

Tests

Create a conversation between two users. Send several messages from user 1 to user 2.
As user 1 (the one who created the messages) mark one of your own messages unread (not the last one).
You should see a "new" marker above the message marked as unread.
Delete the message marked as unread.
The "new" marker should remain in the same location, above the next newer message.
Switch away from the chat. It should remain bolded as "unread" in the LHN. Note that you need to switch to an entirely different chat in the compact/mobile view, not simply switch the the list of chats.
Switch back to the chat. It should no longer show as "unread" in the LHN, but the "new" marker should remain in the same location.
Switch away from the chat again.
Switch back to the chat again, the "new" marker should be gone.

For clarification, please watch one of the videos in the video/screenshot section.

Verify that no errors appear in the JS console

Offline tests

The same as above, except that the deleted comment should show as "greyed out" and stricken instead of disappearing. See the "offline" video in the "web" portion of the screenshots/videos section for an example.

QA Steps

Please repeat the "tests" section steps from above.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

web.mov

Offline:

screen_recording_web_offline.mov

Mobile Web - Chrome

andriod-web.mov

Mobile Web - Safari

ios-web.mov

Desktop

desktop.mov

iOS

ios.mov

Android

android.mov

melvin-bot · 2023-01-05T20:00:55Z

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

tylerkaraszewski · 2023-01-05T20:40:35Z

Current state of this is it works, until onyx is updated, which makes the newMarker disappear. Navigating away and then back to the chat draws it again as intended.

tylerkaraszewski · 2023-01-06T00:03:01Z

I still have to run the android tests.

thienlnam · 2023-01-06T00:06:45Z

+
+            if (this.newMarkerReportActionID !== '') {
+                this.setState({newMarkerReportActionID: ReportUtils.getNewMarkerReportActionID(nextProps.report, this.sortedAndFilteredReportActions)});
+            }
+


Updating state in shouldComponentUpdate is actually an anti-pattern, this is more intended to determine if the component should update at all. This should live in componentDidUpdate

Where should I do it? componentDidUpdate doesn't run until after render happens. We want to update it before/during render.

Ah I see is that why you were running into the flickering? Another idea would be to check if when the action is deleted, if Report.subscribeToNewActionEvent is called - if so you could put it in there

tylerkaraszewski · 2023-01-09T22:26:28Z

@thienlnam - before I run through my complete test suite here, do you mind taking a look and seeing if you like this approach better?

thienlnam

We keep newMarkerReportActionID in state because we want it to re-render every time it changes, but this approach just adds another variable to track the same thing.

I still think we should have this in the action event subscriber. Deleting a report comment should trigger that callback, which is where you can update the newMarkerReportActionID in state

tylerkaraszewski · 2023-01-18T18:44:46Z

@thienlnam - deleting a comment doesn't seem to trigger that callback. That doesn't actually seem to be called anywhere except from componentWillUnmount. That doesn't seem to align with the comment on the callback.

tylerkaraszewski · 2023-01-20T21:43:57Z

@grgia and @thienlnam This is updated and ready to go!

thienlnam

Code changes look good 👍 just need to run through testing screenshots

thienlnam · 2023-01-20T21:46:34Z

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 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 correct English and 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 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.
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-01-20.at.2.09.58.PM.mov

Mobile Web - Chrome

Screen.Recording.2023-01-20.at.2.10.37.PM.mov

Mobile Web - Safari

Screen.Recording.2023-01-20.at.2.16.12.PM.mov

Desktop

Screen.Recording.2023-01-20.at.2.18.25.PM.mov

iOS

Screen.Recording.2023-01-20.at.2.14.53.PM.mov

Android

android emulator broken

OSBotify · 2023-01-20T22:27:51Z

✋ 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 · 2023-01-23T18:27:07Z

🚀 Deployed to staging by https://github.com/thienlnam in version: 1.2.58-0 🚀

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

OSBotify · 2023-01-25T02:11:18Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.2.58-4 🚀

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

Mostly fixes it except for it disappears and then returns for a sec.

335994f

tylerkaraszewski requested a review from a team as a code owner January 5, 2023 20:00

tylerkaraszewski self-assigned this Jan 5, 2023

melvin-bot Bot requested review from grgia and removed request for a team January 5, 2023 20:00

This should update state correctly

520d8fa

tylerkaraszewski changed the title ~~[WIP] Mostly fixes it except for it disappears and then returns for a sec.~~ Fix newMarker disappearing when deleting the comment that was marked unread. Jan 5, 2023

thienlnam self-requested a review January 5, 2023 23:17

thienlnam suggested changes Jan 6, 2023

View reviewed changes

tylerkaraszewski added 3 commits January 9, 2023 14:22

I think this fixes it

88ca8c8

Oops, don't change project files.

7dee9f4

Style

e0b3a3a

tylerkaraszewski requested a review from thienlnam January 9, 2023 22:26

thienlnam suggested changes Jan 10, 2023

View reviewed changes

Merge branch 'main' into tyler-fix-disappearing-newMarker

760f4e1

tylerkaraszewski added 10 commits January 18, 2023 11:43

Maybe the third time is the charm.

c83f52a

Linter fixes

810fa8f

Trying a different thing

4b1d189

Revert src/libs/actions/Report.js

a1340ce

Reset state

4359edd

Might actually work.

456845f

I think this might actually work

7eadfc5

Cleanup

050c868

Save progress

0184738

Merge branch 'main' into tyler-fix-disappearing-newMarker

8b00323

tylerkaraszewski added 2 commits January 20, 2023 10:05

Merge branch 'main' into tyler-fix-disappearing-newMarker

05baaa1

Use correct length property

942912f

thienlnam approved these changes Jan 20, 2023

View reviewed changes

thienlnam merged commit f9fe42b into main Jan 20, 2023

thienlnam deleted the tyler-fix-disappearing-newMarker branch January 20, 2023 22:23

OSBotify mentioned this pull request Jan 23, 2023

Deploy Checklist: New Expensify 2023-01-23 #14471

Closed

17 tasks

kbecciv mentioned this pull request Jan 23, 2023

Chat - The unread message marker reappears when user come back online #14488

Closed

6 tasks

Conversation

tylerkaraszewski commented Jan 5, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot Bot commented Jan 5, 2023

Uh oh!

tylerkaraszewski commented Jan 5, 2023

Uh oh!

tylerkaraszewski commented Jan 6, 2023

Uh oh!

thienlnam Jan 6, 2023

Choose a reason for hiding this comment

Uh oh!

tylerkaraszewski Jan 6, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

thienlnam Jan 6, 2023

Choose a reason for hiding this comment

Uh oh!

tylerkaraszewski commented Jan 9, 2023

Uh oh!

thienlnam left a comment

Choose a reason for hiding this comment

Uh oh!

tylerkaraszewski commented Jan 18, 2023

Uh oh!

tylerkaraszewski commented Jan 20, 2023

Uh oh!

thienlnam left a comment

Choose a reason for hiding this comment

Uh oh!

thienlnam commented Jan 20, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

OSBotify commented Jan 20, 2023

Uh oh!

OSBotify commented Jan 23, 2023

Uh oh!

OSBotify commented Jan 25, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

tylerkaraszewski commented Jan 5, 2023 •

edited

Loading

tylerkaraszewski Jan 6, 2023 •

edited

Loading

thienlnam commented Jan 20, 2023 •

edited

Loading