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 header/lhn for threads #18880

Merged
merged 5 commits into from
May 15, 2023
Merged

Fix header/lhn for threads #18880

merged 5 commits into from
May 15, 2023

Conversation

stitesExpensify
Copy link
Contributor

@stitesExpensify stitesExpensify commented May 12, 2023

Details

We were showing the name of the current report in the lhn/header:
2023-05-12_13-21-10

We wanted to show the name of the parent report:
2023-05-12_13-21-23

Fixed Issues

$ #18863
PROPOSAL:n/a

Tests

  1. Open a workspace chat
  2. Create a thread from a comment
  3. Make sure that the LHN has the name of the current chat as the title, and the name of the workspace and the name of the parent chat in the the subtitle in the Header
2023-05-12_13-21-23 4. Make sure that the LHN has the name of the current chat as the title, and the name of the workspace and the name of the parent chat in the the subtitle in the LHN 2023-05-12_16-33-52
  • Verify that no errors appear in the JS console

Offline tests

n/a

QA Steps

  1. Open a workspace chat
  2. Create a thread from a comment
  3. Make sure that the LHN has the name of the current chat as the title, and the name of the workspace and the name of the parent chat in the the subtitle in the Header
2023-05-12_13-21-23 4. Make sure that the LHN has the name of the current chat as the title, and the name of the workspace and the name of the parent chat in the the subtitle in the LHN 2023-05-12_16-33-52
  • 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 2023-05-12_16-39-02
Mobile Web - Chrome 2023-05-12_17-22-26
Mobile Web - Safari 2023-05-12_17-24-23
Desktop 2023-05-12_17-06-40
iOS
Android

@stitesExpensify stitesExpensify self-assigned this May 12, 2023
@stitesExpensify stitesExpensify changed the title Fix head/lhn for threads Fix header/lhn for threads May 12, 2023
@@ -45,7 +45,7 @@ const defaultProps = {

const AvatarWithDisplayName = (props) => {
const title = ReportUtils.getDisplayNameForParticipant(props.report.ownerEmail, true);
const subtitle = ReportUtils.getChatRoomSubtitle(props.report, props.policies);
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This second param wasn't doing anything because the method only had one parameter. Now that I added a second, this could cause problems, so I removed it

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 added another parameter to the method, and this call of the method was already sending a second parameter but it wasn't doing anything. I had to remove it because otherwise the code would think the props.policies is a parentReport when it isn't

@grgia
Copy link
Contributor

grgia commented May 15, 2023

here ya go, level 1 thread and then level 2 thread

IOS ANDROID CHROME SAFARI
image image image image
image image image image

@stitesExpensify stitesExpensify marked this pull request as ready for review May 15, 2023 19:09
@stitesExpensify stitesExpensify requested a review from a team as a code owner May 15, 2023 19:09
@melvin-bot melvin-bot bot requested review from jasperhuangg and rushatgabhane and removed request for a team May 15, 2023 19:09
@melvin-bot
Copy link

melvin-bot bot commented May 15, 2023

@rushatgabhane @jasperhuangg One of you needs to 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]

@@ -75,9 +75,9 @@ const HeaderView = (props) => {
const isChatRoom = ReportUtils.isChatRoom(props.report);
const isPolicyExpenseChat = ReportUtils.isPolicyExpenseChat(props.report);
const isTaskReport = ReportUtils.isTaskReport(props.report);
const reportHeaderData = isTaskReport && !_.isEmpty(props.parentReport) && (!isThread || isTaskReport) ? props.parentReport : props.report;
const reportHeaderData = (isTaskReport || !isThread) && !_.isEmpty(props.parentReport) ? props.parentReport : props.report;
Copy link
Member

@rushatgabhane rushatgabhane May 15, 2023

Choose a reason for hiding this comment

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

@stitesExpensify bug: header data is empty for all workspace rooms

steps:

  1. Click +
  2. Create a new workspace room

OR

  1. Go to any existing workspace room
  2. Notice that there is no room avatar and room name
image

Copy link
Contributor Author

Choose a reason for hiding this comment

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

good find, looking now

if (isThread(report)) {
if (!getChatType(report)) {
return '';
}

// If thread is not from a DM or group chat, the subtitle will follow the pattern 'Workspace Name • #roomName'
const workspaceName = getPolicyName(report);
const roomName = isChatRoom(report) ? lodashGet(report, 'displayName') : '';
let roomName = '';
Copy link
Member

@rushatgabhane rushatgabhane May 15, 2023

Choose a reason for hiding this comment

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

we also have some uncommited prettier changes

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'm not seeing these?

@stitesExpensify
Copy link
Contributor Author

@rushatgabhane are there console logs? I'm not seeing that error
2023-05-15_14-49-26
2023-05-15_14-49-18

@rushatgabhane
Copy link
Member

rushatgabhane commented May 15, 2023

@stitesExpensify there are no related console errors

I can consistently repro the bug

  1. Open any report A
  2. Navigate to report B
  3. Navigate back to report A
  4. Observe that the header disappears after the OpenReport API command is complete.
Screen.Recording.2023-05-16.at.02.26.52.mov

@chiragsalian
Copy link
Contributor

chiragsalian commented May 15, 2023

Observe that the header disappears after the OpenReport API command is complete.

Is your app connected to production or staging API endpoint. Because the issue you mentioned sounds like a bug that's addressed on staging but not on production. Also we've had some auth reverts so i don't know how well this would work on staging either.

Tthe PR seems to work well for me on dev.

Copy link
Contributor

@chiragsalian chiragsalian left a comment

Choose a reason for hiding this comment

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

Code LGTM, and works well on dev.

@rushatgabhane

This comment was marked as resolved.

@rushatgabhane
Copy link
Member

It works well on staging API!!
@chiragsalian thanks for the help

@rushatgabhane
Copy link
Member

rushatgabhane commented May 15, 2023

@stitesExpensify @chiragsalian sorry, let me know if you can help me get access to an account that's on the threads beta (or get rushatgabhane@gmail.com on it). Otherwise I won't be able to test this PR because the API doesn't return any header data.

In any case, everything looks good to me!

image

@rushatgabhane
Copy link
Member

rushatgabhane commented May 15, 2023

@stitesExpensify because my account isn't on the beta, I thought I could test it all offline.

But there is no subtitle and room name in the header while offline. I'm guessing offline support isn't of a priority yet

image

@stitesExpensify
Copy link
Contributor Author

Correct, offline is not required at this time due to the urgency of the project

@chiragsalian
Copy link
Contributor

chiragsalian commented May 15, 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
Mobile Web - Chrome
Mobile Web - Safari
Desktop
iOS
Android

@chiragsalian
Copy link
Contributor

let me know if you can help me get access to an account that's on the threads beta (or get rushatgabhane@gmail.com on it)

Ah yes, we should remember to add reviewers to the threads beta. In the interest of time since there are no code concerns I'll be moving ahead and merging this. The testing of threads is not very stable on staging so i wouldn't want to add anyone to the beta just yet.

@chiragsalian chiragsalian merged commit da8c1c5 into main May 15, 2023
@chiragsalian chiragsalian deleted the stites-fixThreadHeader branch May 15, 2023 23:03
@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/chiragsalian in version: 1.3.15-0 🚀

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

@isagoico
Copy link

Hi! @stitesExpensify this PR is a pass in workspace #rooms but a fail in workspace individual chats. Not sure if this is known atm. Let us know if we should raise an issue for this.
image

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.3.15-12 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 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.

7 participants