Skip to content

Fix thread header for workspace chats#19185

Merged
madmax330 merged 3 commits intomainfrom
georgia-threadHeaderMatchWorkspace
Jun 8, 2023
Merged

Fix thread header for workspace chats#19185
madmax330 merged 3 commits intomainfrom
georgia-threadHeaderMatchWorkspace

Conversation

@grgia
Copy link
Contributor

@grgia grgia commented May 18, 2023

Details

We should not append the • if the chat is in a workspace and not a room.

Fixed Issues

$ #19186

Tests

  • Verify that no errors appear in the JS console

  • Open a thread made in a workspace chat (not a workspace room chat)

  • Verify that the header title is the thread parent and the subtitle is <Workspace Name>

  • Open a thread from a workspace room chat.

  • Verify that the header title is the thread parent and the subtitle is <Workspace Name • Subtitle >

Offline tests

QA Steps

  • Verify that no errors appear in the JS console

  • Verify that no errors appear in the JS console

  • Create a new workspace and add a member

  • Send a message in the workspace chat

  • Create a thread from that message

  • Verify that the header title is the thread parent and the subtitle is <Workspace Name>

  • Create a room in the workspace

  • Send a message in the workspace room

  • Create a thread from that message

  • Verify that the header title is the thread parent and the subtitle is <Workspace Name • Subtitle >

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 image
Mobile Web - Chrome image
Mobile Web - Safari image
Desktop image
iOS image
Android image

@grgia grgia self-assigned this May 18, 2023
@grgia grgia marked this pull request as ready for review May 18, 2023 11:19
@grgia grgia requested a review from a team as a code owner May 18, 2023 11:19
@melvin-bot melvin-bot bot requested review from Santhosh-Sellavel and madmax330 and removed request for a team May 18, 2023 11:19
@melvin-bot
Copy link

melvin-bot bot commented May 18, 2023

@Santhosh-Sellavel @madmax330 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]

@grgia grgia mentioned this pull request May 18, 2023
71 tasks
@Santhosh-Sellavel
Copy link
Collaborator

@grgia
Verify that the header title is the thread parent and the subtitle is ❌ Fails for me

Screen.Recording.2023-05-18.at.9.46.12.PM.mov

@Santhosh-Sellavel
Copy link
Collaborator

  • Verify that no errors appear in the JS console ✅

  • Create a new workspace and add a member ✅

  • Send a message in the workspace chat ✅

  • Create a thread from that message ❌

  • Verify that the header title is the thread parent and the subtitle is ❌

  • Create a room in the workspace ✅

  • Send a message in the workspace room ✅

  • Create a thread from that message ✅

  • Verify that the header title is the thread parent and the subtitle is <Workspace Name • Subtitle > ✅

Screen.Recording.2023-05-18.at.9.52.36.PM.mov

@grgia

While creating a thread from a message sent on the workspace chat. Two times API's hit both seemed to fail with following response

Response for first API

{"jsonCode":500,"message":"500 Unhandled Exception","onyxData":[{"onyxMethod":"merge","key":"report_1967114620644697","value":{"errorFields":{"createChat":{"1684427314147476":"Auth OpenReport returned an error"}}}},{"onyxMethod":"merge","key":"report_1967114620644697","value":{"errorFields":{"createChat":{"1684427314147476":"Auth OpenReport returned an error"}}}}],"requestID":"7c9579584d20f3f5-SJC"}

Repsonse for second API

{"onyxData":[],"jsonCode":403,"requestID":"7c95795a9944f3f5-BOM"}

@grgia
Copy link
Contributor Author

grgia commented May 22, 2023

@Santhosh-Sellavel the optimistic data being wrong for the loading screen seems to be a separate bug. But cc @chiragsalian it looks like there's a problem with creating workspace threads in NON-ROOM workspace chats

@Santhosh-Sellavel
Copy link
Collaborator

@grgia so what's next here? Should we skip testing these steps

  • Send a message in the workspace chat
  • Create a thread from that message
  • Verify that the header title is the thread parent and the subtitle is

@Santhosh-Sellavel
Copy link
Collaborator

@grgia bump!

@grgia
Copy link
Contributor Author

grgia commented May 24, 2023

@Santhosh-Sellavel yes, let's skip those steps.

@Santhosh-Sellavel
Copy link
Collaborator

@grgia Test steps are wrong as we know that cannot create a thread from workspace chat messages on creating from workspace rooms work

@grgia
Copy link
Contributor Author

grgia commented May 26, 2023

@Santhosh-Sellavel I'll add ONYX test steps. We'll just manually add a correctly formatted report in console to test. I'll ping you when I've added it

@grgia
Copy link
Contributor Author

grgia commented Jun 2, 2023

@Santhosh-Sellavel I believe we pushed a fix and this can be tested with original steps now

@grgia
Copy link
Contributor Author

grgia commented Jun 5, 2023

@Santhosh-Sellavel @madmax330 bump

@Santhosh-Sellavel
Copy link
Collaborator

Sorry on it today

@Santhosh-Sellavel
Copy link
Collaborator

@grgia thread created now. An error is shown while sending a message on the workspace chat thread.

Screenshot 2023-06-05 at 11 16 20 PM

@grgia
Copy link
Contributor Author

grgia commented Jun 6, 2023

@chiragsalian could you take a look at this flow one more time? #19185 (comment)

@grgia
Copy link
Contributor Author

grgia commented Jun 7, 2023

@Santhosh-Sellavel this PR should not be blocked by the last bug, we just need to be able to test the headers

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented Jun 7, 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
Screen.Recording.2023-06-07.at.9.43.46.PM.mov
Mobile Web - Chrome & Mobile Web - Safari
Screen.Recording.2023-06-07.at.10.13.55.PM.mov
Desktop
Screen.Recording.2023-06-07.at.9.44.34.PM.mov
iOS & Android
Screen.Recording.2023-06-07.at.10.23.35.PM.mov

Copy link
Collaborator

@Santhosh-Sellavel Santhosh-Sellavel left a comment

Choose a reason for hiding this comment

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

LGTM, tests well!

}

return [workspaceName, roomName].join(' • ');
return roomName ? [workspaceName, roomName].join(' • ') : workspaceName;
Copy link
Collaborator

Choose a reason for hiding this comment

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

NAB shouldn't the symbol be in the CONST?

@madmax330 madmax330 merged commit 4cad248 into main Jun 8, 2023
@madmax330 madmax330 deleted the georgia-threadHeaderMatchWorkspace branch June 8, 2023 10:38
@OSBotify
Copy link
Contributor

OSBotify commented Jun 8, 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.

@OSBotify
Copy link
Contributor

OSBotify commented Jun 8, 2023

🚀 Deployed to staging by https://github.com/madmax330 in version: 1.3.26-0 🚀

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

@isagoico

This comment was marked as resolved.

@Santhosh-Sellavel
Copy link
Collaborator

@isagoico • That is for thread from workspace room chat.

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/AndrewGable in version: 1.3.26-4 🚀

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.

5 participants