fix: consistent lhn preview for archived chats #18019

BeeMargarida · 2023-04-26T08:33:08Z

Details

Unify the preview or archived chats, showing always the archive reason (both for chatRooms and policy expense chats).

Expected behaviour changes: #17386 (comment)

Fixed Issues

$ #17386

Tests

Login into the account
Make a workspace
Write some messages in the chats
Archive the chat
See the preview of the chats (should show the archive reason)

Verify that no errors appear in the JS console

Offline tests

Not applicable, should work the same

QA Steps

Login into the account
Make a workspace
Write some messages in the chats
Archive the chat
See the preview of the chats (should show the archive reason)

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 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

Mobile Web - Safari

Desktop

iOS

Android

…d_chats

MelvinBot · 2023-05-04T13:17:01Z

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

mountiny

@BeeMargarida thanks! Could you look at if we could add this to theSidebarUtils test? I think there is one such automated test.

BeeMargarida · 2023-05-05T06:46:38Z

Could you look at if we could add this to theSidebarUtils test? I think there is one such automated test.

On it!

parasharrajat · 2023-05-05T06:55:28Z

Reviewing now. Can you please add the link #17386 (comment) to Expected behavior changes in the description?

src/libs/SidebarUtils.js

BeeMargarida · 2023-05-05T07:04:24Z

@parasharrajat Done!
@mountiny Regarding the unit tests, there are two suites related to the sidebar, one for checking the ordering and other for checking the filtering of the chats. Not really related to what is shown, since they only check the quantity of chats or the display names of them. If no new suite is to be added, I think the best place would be in the SidebarOrderTest. Just wanted to double check if that is the best spot or if a new suite should be created.

parasharrajat · 2023-05-05T10:48:27Z

src/libs/SidebarUtils.js

+        const actionsArray = ReportActionsUtils.getSortedReportActions(_.toArray(actions));
        lastReportActions[reportID] = _.last(actionsArray);

        // The report is only visible if it is the last action not deleted that
        // does not match a closed or created state.
        const reportActionsForDisplay = _.filter(actionsArray, (reportAction, actionKey) => (ReportActionsUtils.shouldReportActionBeVisible(reportAction, actionKey)
            && (reportAction.actionName !== CONST.REPORT.ACTIONS.TYPE.CREATED)));
-        visibleReportActionItems[reportID] = _.first(ReportActionsUtils.getSortedReportActions(reportActionsForDisplay, true));
+        visibleReportActionItems[reportID] = _.last(reportActionsForDisplay);


What is the purpose for this change?

The actions are an object that are converted to an array. This does not guarantee order, so getting the last element after that conversion could (and did) result in an action that was not the last. So I added the sort that was already being made below for the visible action.
Regarding the change from _.first to _.last, it came because I then noticed that the true param passed to the function reverted the sorting, which was not necessary, so I removed it and maintained the same logic of getting the _.last.

parasharrajat · 2023-05-05T11:20:36Z

I am noticing a defect. For Archived rooms when I click it. the last message changes as well as the message banner in the chat.

Screen.Recording.2023-05-05.at.4.49.33.PM.mov

BeeMargarida · 2023-05-05T11:37:41Z

I am noticing a defect. For Archived rooms when I click it. the last message changes as well as the message banner in the chat.
Screen.Recording.2023-05-05.at.4.49.33.PM.mov

That also happened to me, but only after running after this PR fix. From what I understand, this is expected, before the last action was outdated but after opening it fetches again and corrects. If you log out and then try again, you can't replicate this in the preview.

parasharrajat · 2023-05-05T11:53:31Z

Ok. Thanks for the clarification. I will complete the checklist shortly. Rest looks good to me.

BeeMargarida · 2023-05-05T13:25:08Z

@mountiny Added a check for archived chats content preview to the existing unit tests, but I'm not really convinced that is the correct spot for them. I think perhaps a new SidebarTest test suite be made for testing the content shown, since it's not really related to the ordering or filtering logic. Leaving here my opinion, but would like to get your feedback

parasharrajat · 2023-05-05T13:36:04Z

I would say that you create a new one. It is better to have short unit tests.

mountiny

That also happened to me, but only after running after this PR fix. From what I understand, this is expected, before the last action was outdated but after opening it fetches again and corrects. If you log out and then try again, you can't replicate this in the preview.

This is correct, basically we dont have the last report action in case of the closed one until we open the chat.

BeeMargarida · 2023-05-05T14:19:14Z

Updated with the unit test now in a new suite

parasharrajat · 2023-05-05T18:53:12Z

Screenshots

🔲 iOS / native

🔲 iOS / Safari

🔲 MacOS / Desktop

🔲 MacOS / Chrome

🔲 Android / Chrome

🔲 Android / native

parasharrajat

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.

cc: @mountiny

🎀 👀 🎀 C+ reviewed

mountiny

Thanks everyone for your perseverance on this issue 🙇 great job all around!

OSBotify · 2023-05-05T20:27:07Z

🚀 Deployed to staging by https://github.com/mountiny in version: 1.3.11-1 🚀

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

OSBotify · 2023-05-09T04:04:28Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.12-0 🚀

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

BeeMargarida added 4 commits April 21, 2023 08:39

fix: make LHN preview for archived rooms consistent

ee20df8

Merge branch 'main' into fix/17386-consistent_lhn_preview_for_archive…

f6d0a55

…d_chats

feat: show always archive reason on archived chats preview

6e16024

fix: sort actions before retrieving the last one

73afbe2

BeeMargarida marked this pull request as ready for review May 4, 2023 13:16

BeeMargarida requested a review from a team as a code owner May 4, 2023 13:16

melvin-bot bot requested review from deetergp and removed request for a team May 4, 2023 13:17

fix: remove log

e4b42f0

mountiny requested review from mountiny and parasharrajat May 4, 2023 22:36

mountiny assigned BeeMargarida May 4, 2023

mountiny reviewed May 4, 2023

View reviewed changes

parasharrajat reviewed May 5, 2023

View reviewed changes

src/libs/SidebarUtils.js Outdated Show resolved Hide resolved

fix: remove duplicated call

453c713

parasharrajat reviewed May 5, 2023

View reviewed changes

test: add check for archived messages preview content

09a572a

mountiny reviewed May 5, 2023

View reviewed changes

test: sidebar archive test

ca1854a

parasharrajat approved these changes May 5, 2023

View reviewed changes

mountiny approved these changes May 5, 2023

View reviewed changes

deetergp approved these changes May 5, 2023

View reviewed changes

mountiny merged commit 4fe41a8 into Expensify:main May 5, 2023

OSBotify mentioned this pull request May 5, 2023

Deploy Checklist: New Expensify 2023-05-05 #18498

Closed

31 tasks

melvin-bot bot mentioned this pull request May 9, 2023

[HOLD for payment 2023-05-16] [$1000] Make LHN Preview for Archived chats consistent #17386

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: consistent lhn preview for archived chats #18019

fix: consistent lhn preview for archived chats #18019

BeeMargarida commented Apr 26, 2023 •

edited

Loading

MelvinBot commented May 4, 2023

mountiny left a comment

BeeMargarida commented May 5, 2023

parasharrajat commented May 5, 2023

BeeMargarida commented May 5, 2023 •

edited

Loading

parasharrajat May 5, 2023

BeeMargarida May 5, 2023

parasharrajat commented May 5, 2023

BeeMargarida commented May 5, 2023

parasharrajat commented May 5, 2023

BeeMargarida commented May 5, 2023

parasharrajat commented May 5, 2023

mountiny left a comment

BeeMargarida commented May 5, 2023

parasharrajat commented May 5, 2023 •

edited

Loading

parasharrajat left a comment

mountiny left a comment

OSBotify commented May 5, 2023

OSBotify commented May 9, 2023

fix: consistent lhn preview for archived chats #18019

fix: consistent lhn preview for archived chats #18019

Conversation

BeeMargarida commented Apr 26, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

MelvinBot commented May 4, 2023

mountiny left a comment

Choose a reason for hiding this comment

BeeMargarida commented May 5, 2023

parasharrajat commented May 5, 2023

BeeMargarida commented May 5, 2023 • edited Loading

parasharrajat May 5, 2023

Choose a reason for hiding this comment

BeeMargarida May 5, 2023

Choose a reason for hiding this comment

parasharrajat commented May 5, 2023

BeeMargarida commented May 5, 2023

parasharrajat commented May 5, 2023

BeeMargarida commented May 5, 2023

parasharrajat commented May 5, 2023

mountiny left a comment

Choose a reason for hiding this comment

BeeMargarida commented May 5, 2023

parasharrajat commented May 5, 2023 • edited Loading

Screenshots

🔲 iOS / native

🔲 iOS / Safari

🔲 MacOS / Desktop

🔲 MacOS / Chrome

🔲 Android / Chrome

🔲 Android / native

parasharrajat left a comment

Choose a reason for hiding this comment

Reviewer Checklist

mountiny left a comment

Choose a reason for hiding this comment

OSBotify commented May 5, 2023

OSBotify commented May 9, 2023

BeeMargarida commented Apr 26, 2023 •

edited

Loading

BeeMargarida commented May 5, 2023 •

edited

Loading

parasharrajat commented May 5, 2023 •

edited

Loading