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

Refactor/34411 lhn previews refactor #34872

Merged
merged 21 commits into from
Jan 31, 2024

Conversation

koko57
Copy link
Contributor

@koko57 koko57 commented Jan 22, 2024

Details

PART OF THE REFACTOR: moved some logic to getLastMessageTextForReport, created a function to get last actor displayName

Fixed Issues

$ #34411
PROPOSAL:

Tests

Archived Rooms

  1. [User A] Create a new workspace (or use an existing one)
  2. [User A] Invite another user to the workspace (User B)
  3. [User A] Delete the workspace or remove User B from the workspace (ideally check both)
  4. Observe the LHN previews for both User A and User B (you can compare it with staging)
  5. Open Search Page - observe the previews. (reference here)

Last Actor Display Name

  1. For all the chat types the last actor name should be displayed (with the colon) verify that it's displayed properly.
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

Archived Rooms

  1. [User A] Create a new workspace (or use an existing one)
  2. [User A] Invite another user to the workspace (User B)
  3. [User A] Delete the workspace or remove User B from the workspace (ideally check both)
  4. Observe the LHN previews for both User A and User B (you can compare it with staging)
  5. Open Search Page - observe the previews.

Last Actor Display Name

  1. For all the chat types the last actor name should be displayed (with the colon) verify that it's displayed properly.
  • 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
    • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
      • 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 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 form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label 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.
  • I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native
Android: mWeb Chrome

Screenshot_1706018899
Screenshot_1706018920

iOS: Native

Simulator Screenshot - iPhone 15 Pro - 2024-01-23 at 14 57 24
Simulator Screenshot - iPhone 15 Pro - 2024-01-23 at 14 57 39

iOS: mWeb Safari

Simulator Screenshot - iPhone 15 Pro - 2024-01-23 at 15 26 09
Simulator Screenshot - iPhone 15 Pro - 2024-01-23 at 15 26 24

MacOS: Chrome / Safari Screenshot 2024-01-23 at 12 47 29 Screenshot 2024-01-23 at 12 53 25
MacOS: Desktop Screenshot 2024-01-23 at 14 20 34 Screenshot 2024-01-23 at 14 21 28

Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

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

@koko57 I think its looking good, great job!

src/libs/OptionsListUtils.js Outdated Show resolved Hide resolved
(lastReportActions[report.reportID] && lastReportActions[report.reportID].originalMessage && lastReportActions[report.reportID].originalMessage.reason) ||
CONST.REPORT.ARCHIVE_REASON.DEFAULT;
lastMessageText = Localize.translate(preferredLocale, `reportArchiveReasons.${archiveReason}`, {
displayName: archiveReason.displayName || PersonalDetailsUtils.getDisplayNameOrDefault(lastActorDetails),
Copy link
Contributor

Choose a reason for hiding this comment

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

This archiveReason.displayName has been wrong?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

it should be a string, shouldn't be? Or I'm missing a case where it can be an object?

Copy link
Contributor

Choose a reason for hiding this comment

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

Seems like you are right so it has been wrong 😄

src/libs/SidebarUtils.ts Outdated Show resolved Hide resolved
@@ -436,6 +451,15 @@ function getLastMessageTextForReport(report) {
lastMessageTextFromReport = lodashGet(lastReportAction, 'message[0].text', '');
} else if (ReportActionUtils.isCreatedTaskReportAction(lastReportAction)) {
lastMessageTextFromReport = TaskUtils.getTaskCreatedMessage(lastReportAction);
} else if (ReportUtils.isArchivedRoom(report)) {
const archiveReason =
(lastReportActions[report.reportID] && lastReportActions[report.reportID].originalMessage && lastReportActions[report.reportID].originalMessage.reason) ||
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we also make sure the .reason is one of the 3 options?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

You mean one of these 3: CONST.REPORT.ARCHIVE_REASON.ACCOUNT_CLOSED, CONST.REPORT.ARCHIVE_REASON.REMOVED_FROM_POLICY, CONST.REPORT.ARCHIVE_REASON.POLICY_DELETED? Like it was checked in SidebarUtils? Can we get another reason (apart from these ones)? Actually, now I see that we were not showing the MERGED reason there - we would also need to pass the oldDisplayName if so. Shou,d it be displayed or should we display DEFAULT instead

Copy link
Contributor

Choose a reason for hiding this comment

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

Lets focus on keeping the current behaviour in place. I think we can skip adding the merged consideration for now

@koko57
Copy link
Contributor Author

koko57 commented Jan 23, 2024

@mountiny thanks! I will fill in the author's checklist shortly. I will also check what's wrong with the reassure tests, but I've noticed that this particular test is failing for other PRs as well

@koko57
Copy link
Contributor Author

koko57 commented Jan 24, 2024

@mountiny could you please take a look on these comments? 🙏🏻
#34872 (comment)
#34872 (comment)

@mountiny
Copy link
Contributor

@koko57 answered

@koko57 koko57 marked this pull request as ready for review January 25, 2024 09:51
@koko57 koko57 requested a review from a team as a code owner January 25, 2024 09:51
@melvin-bot melvin-bot bot requested review from eVoloshchak and removed request for a team January 25, 2024 09:51
Copy link

melvin-bot bot commented Jan 25, 2024

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

@koko57
Copy link
Contributor Author

koko57 commented Jan 25, 2024

ok, @mountiny so it's ready to review. It also includes the fix @trjExpensify mentioned #34411 (comment)

This comment has been minimized.

@mountiny
Copy link
Contributor

@koko57 there seems to be some regression with archived workspace chat that had some requests in it

image

On staging we correctly show that its archived, on the build you can see there is the owes message

@koko57
Copy link
Contributor Author

koko57 commented Jan 25, 2024

@mountiny ah yes, I didn't thought of that case - this logic for archived room was overwriting the last message no matter what the last action was. I will look into it if I can change the conditions (without breaking the other messages) and leave the logic in getLastMessageTextForReport

@koko57
Copy link
Contributor Author

koko57 commented Jan 26, 2024

@mountiny fixed! I'm resolving now the conflicts after TS migration. I have one question: do we really need to check if last action was CLOSED like it was introduced here?
Screenshot 2024-01-26 at 09 30 16

@mountiny
Copy link
Contributor

@koko57 good question, there should be no other actions when it was archived. I think its safer to check for it though

@eVoloshchak
Copy link
Contributor

eVoloshchak commented Jan 26, 2024

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 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(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 form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label 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.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native Screenshot 2024-01-30 at 23 46 51 Screenshot 2024-01-30 at 23 46 34
Android: mWeb Chrome Screenshot 2024-01-30 at 23 48 09 Screenshot 2024-01-30 at 23 47 59
iOS: Native

Simulator Screenshot - iPhone 15 Pro - 2024-01-30 at 23 45 40
Simulator Screenshot - iPhone 15 Pro - 2024-01-30 at 23 45 33

iOS: mWeb Safari

Simulator Screenshot - iPhone 15 Pro - 2024-01-30 at 23 46 06
Simulator Screenshot - iPhone 15 Pro - 2024-01-30 at 23 45 59

MacOS: Chrome / Safari Screenshot 2024-01-30 at 23 45 26 Screenshot 2024-01-30 at 23 45 18
MacOS: Desktop Screenshot 2024-01-30 at 23 47 51 Screenshot 2024-01-30 at 23 47 44

@eVoloshchak
Copy link
Contributor

An owner's email is displayed instead of "This workspace chat is no longer active.." until you open a report

Screen.Recording.2024-01-26.at.19.23.49.mov

This happens only on DEV, ad-hoc build works fine
@mountiny, could you re-run the workflow to generate a new ad-hoc build please? Looks like this bug might be DEV only

@eVoloshchak
Copy link
Contributor

Screenshot 2024-01-26 at 19 45 40 Screenshot 2024-01-26 at 19 45 28

Shouldn't we show (archived) label for iou requests in an archived workspace?

@mountiny
Copy link
Contributor

No i dont think that is the case

@mountiny
Copy link
Contributor

@koko57 could you sync with main before I make another build

@koko57
Copy link
Contributor Author

koko57 commented Jan 29, 2024

@mountiny @eVoloshchak maybe if it will happen again I revert the changes for the archived rooms, leaving only the changes for displaying last actor's name and the fix for Workspace preview?

@mountiny
Copy link
Contributor

Copy link
Contributor

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖 iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/34872/index.html ❌ FAILED ❌
Android The QR code can't be generated, because the iOS build failed
Desktop 💻 Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/34872/NewExpensify.dmg https://34872.pr-testing.expensify.com
Desktop Web

👀 View the workflow run that generated this build 👀

@mountiny
Copy link
Contributor

mountiny commented Jan 29, 2024

@eVoloshchak whats your ETA here?

@eVoloshchak
Copy link
Contributor

@koko57, this behavior is still present in https://34872.pr-testing.expensify.com/

Screen.Recording.2024-01-29.at.21.45.06.mov

It doesn't work properly on https://new.expensify.com/ either, but instead of an email it displays "This chat room has been archived"

Screen.Recording.2024-01-29.at.21.33.02.mov

@mountiny
Copy link
Contributor

I believe the difference is that in the ad hoc build we rely on the CLOSED report action only whereas in production it seems to know the report state is closed and does not show the message. I believe we might not be loading the Closed report actions in OpenApp and that has been discussed in the past, we probably will not change anything about it.

I think if the report is the in closed state/status, we should keep the same behaviour you can see in production

@koko57
Copy link
Contributor Author

koko57 commented Jan 30, 2024

@mountiny thanks for the hint! I was able to change the condition a little bit, so now we've got the same behaviour as in the production (We can think of fixing it later).

Screen.Recording.2024-01-30.at.09.57.25.mov

@mountiny
Copy link
Contributor

@eVoloshchak Can you please proceed with the checklist? Thanks!

@koko57 koko57 requested a review from mountiny January 30, 2024 12:50
Copy link
Contributor

@eVoloshchak eVoloshchak left a comment

Choose a reason for hiding this comment

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

LGTM!

Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

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

Thanks! getting better bit by bit

@mountiny mountiny merged commit a1ac92d into Expensify:main Jan 31, 2024
16 checks passed
@francoisl francoisl mentioned this pull request Jan 31, 2024
50 tasks
@OSBotify
Copy link
Contributor

🚀 Cherry-picked to staging by https://github.com/francoisl in version: 1.4.33-5 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/mountiny in version: 1.4.34-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/mountiny in version: 1.4.34-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/francoisl in version: 1.4.34-1 🚀

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants