use getReportName and getParentNavigationSubtitle from ReportUtils for reports with title or subtitle as empty string for QR code page

[c3024]

Details

Fixed Issues

$ #27265
PROPOSAL: #27265 (comment)

Tests

Test 1

1. Create a workspace
2. Go to the workspace chat created
3. Click on the header
4. Click on 'Share Code' in right hand panel
5. Verify that the workspace name is shown below the QR code

Test 2

1. Go to an archived room
2. Click on the header
3. Click on 'Share Code' in right hand panel
4. Verify that the room name is shown as "roomName (archived)" below QR code

Test 3

1. Reply to any message in the workspace to create a thread
2. Go to the chat thread in a workspace chat
3. Click on the header
4. Click on 'Share Code' in right hand panel
5. Verify that threadName is shown as title and workSpace is shown as subtitle below QR code.

Test 4

1. Create a task in a workspace chat
2. Click on the task header
3. Click on 'Share Code' in right hand panel
4. Verify that taskName is shown as title and workSpace is shown as subtitle below QR code.

• Verify that no errors appear in the JS console

Offline tests

Test 1

1. Create a workspace
2. Go to the workspace chat created
3. Click on the header
4. Click on 'Share Code' in right hand panel
5. Verify that the workspace name is shown below the QR code

Test 2

1. Go to an archived room
2. Click on the header
3. Click on 'Share Code' in right hand panel
4. Verify that the room name is shown as "roomName (archived)" below QR code

Test 3

1. Reply to any message in the workspace to create a thread
2. Go to the chat thread in a workspace chat
3. Click on the header
4. Click on 'Share Code' in right hand panel
5. Verify that threadName is shown as title and workSpace is shown as subtitle below QR code.

Test 4

1. Create a task in a workspace chat
2. Click on the task header
3. Click on 'Share Code' in right hand panel
4. Verify that taskName is shown as title and workSpace is shown as subtitle below QR code.

QA Steps

Test 1

1. Create a workspace
2. Go to the workspace chat created
3. Click on the header
4. Click on 'Share Code' in right hand panel
5. Verify that the workspace name is shown below the QR code

Test 2

1. Go to an archived room
2. Click on the header
3. Click on 'Share Code' in right hand panel
4. Verify that the room name is shown as "roomName (archived)" below QR code

Test 3

1. Reply to any message in the workspace to create a thread
2. Go to the chat thread in a workspace chat
3. Click on the header
4. Click on 'Share Code' in right hand panel
5. Verify that threadName is shown as title and workSpace is shown as subtitle below QR code.

Test 4

1. Create a task in a workspace chat
2. Click on the task header
3. Click on 'Share Code' in right hand panel
4. Verify that taskName is shown as title and workSpace is shown as subtitle below QR code.

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

Workspace Room

Owner Workspace Chat

Owner view of Chat of Invited Member to Workspace

Archived Workspace Chat

Archived Room

Task in Room

Task in Workspace

Subtask inside Task in Workspace

Thread in Workspace

Thread in Room of Workspace

Non-workspace Thread

Mobile Web - Chrome

qrCodeWebChrome.mp4

Mobile Web - Safari

qrCode-iOSSafari.mov

Desktop

qrCode-Web.mov

iOS

qrCode-iOSNative.mov

Android

Screen.Recording.2023-09-14.at.7.49.47.PM.mov

[melvin-bot]

@0xmiroslav 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]

[c3024]

Bump @0xmiroslav

[0xmiros]

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

• workspace chat

• room chat

• archived chats

• thread

• task

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

[0xmiros]

LGTM!
Asked for design confirmation here

[dangrous]

Code looks good! I commented on the issue but I'd like to wait for design to confirm that this works for them too. I made one suggestion on how to make it a little easier for them to confirm. Thanks!

[c3024]

@dangrous
Shall I push a commit using getReportName for all report QR codes?

[dangrous]

Sounds like yes! We can just update this PR if that works for you.

Did you see the comment about the subtitle? Do you think you can handle that here as well?

[0xmiros]

@c3024 please update screenshots accordingly based on latest change.
On web screenshots, add all possible cases

[c3024]

I updated tests and screenshots for all cases that changed from existing behaviour. Please review and suggest any changes if required. @0xmiroslav

In the context of this comment here, I just want to clarify that for a thread or task created directly in a workspace chat, the QR code subtitle shows workspaceName like this as asked.

But for a thread created inside a room (custom or # admins etc.) the subtitle in the QR code shows the roomName like this.

I think this is fine and what we expect. Please let me know if we need to change anything else. @dangrous

[0xmiros]

Screenshots

#admins

archived workspace

room

subtask

task in room

thread in iou report

thread in iou request

workspace chat

[0xmiros]

LGTM!
@dangrous all yours

[dangrous]

Suggested change

	const subtitle = isReport ? ReportUtils.getChatRoomSubtitle(this.props.report) || ReportUtils.getParentNavigationSubtitle(this.props.report).rootReportName : formattedEmail;
	const subtitle = isReport ? (ReportUtils.getChatRoomSubtitle(this.props.report) || ReportUtils.getParentNavigationSubtitle(this.props.report).rootReportName) : formattedEmail;

just to make this a little easier to understand

[c3024]

Prettier is not allowing to add parentheses here.

[dangrous]

weird! never mind then haha

[dangrous]

One tiny change - this looks good though, we can merge once this is done!

[dangrous]

Oh wait sorry - I just noticed. So in the Slack thread Jason suggested that the subtitle for the threads (and tasks, IOUs, etc.) should be the workspace name (if it exists), rather than the parent thread. Can we make that change? So basically everything should have either Workspace or the Workspace name as the subtitle. And this catches this comment too, right?

[c3024]

I think this commit settles all we want.

1. Threads and tasks inside rooms show subtitle as workspace and not the name of the room
2. I understand this comment as

• owner's workspace chat should have title of QR code as workspace, and subtitle as the text Workspace
• owner's view for an invited member chat in workspace shows the invited member as title, and workspace name as subtitle in the QR code. (please refer screenshots for more clarity)

3. Non-workspace threads have no subtitle which is okay as per the Slack discussion.

I updated screenshots for all the cases I found for workspace.

@dangrous please suggest if I missed anything.

cc @0xmiroslav

[dangrous]

Yep those screenshots look good - I think we're good to go!

[dangrous]

@0xmiroslav do you mind taking one last look as well? I'm not sure why it didn't dismiss your review since there have been changes.

[0xmiros]

LGTM2
Not sure if it's bug but once C+ approved, ✅ keeps remaining even though author pushed more changes 😄

[OSBotify]

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

[dangrous]

not sure why my review got dismissed, but I approved this!

[OSBotify]

🚀 Deployed to staging by https://github.com/dangrous in version: 1.3.73-0 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.73-1 🚀

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

[OSBotify]

🚀 Deployed to staging by https://github.com/dangrous in version: 1.3.74-0 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.3.74-3 🚀

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