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

Subheader update and parent navigation #20484

Merged
merged 17 commits into from
Jun 13, 2023
Merged

Conversation

chiragsalian
Copy link
Contributor

@chiragsalian chiragsalian commented Jun 8, 2023

Details

The inability to go "back" to where the thread originated was quickly flagged as a major problem by EC3 users. This has spawned a long conversation on how to normalize headers to include a "parent link". (the rest was discussed on slack)

TLDRs:

  1. For a DM thread, we want the subheader to show From <root report persons name/email>. The same translates to group DM where it shows you From <root report group of persons name/email>. So in the root report if you see "Marc", the in the subheader of the child reports you should see "From Marc"
  2. For a workspace thread, we want the subheader to show From <parent report> in <workspace>.
  3. For both threads, the From ... should look like a link (including the "From" from what i gather)
  4. Clicking the From ... link should go up one parent level.

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/290078
PROPOSAL: GH_LINK_ISSUE(COMMENT)

Tests

  1. Create a DM with someone. Confirm in the report header you only see the person's full name/email.
  2. Leave a comment and thread it. In the thread, confirm for the subheader you see From <full name/email> and it looks like a link. The full name/email should be the same as what you see on the parent rows first line.
  3. The first row of the report header for a thread is the parent action, the second row of the report header is called the subheader. Confirm clicking the first row opens up the report details. Confirm clicking the second row navigates to parent report.
  4. Create a workspace. Create a public room under this workspace. Confirm in the public room the subheader is not a link and clicking on the report header opens the report details.
  5. Create a thread in the public room. Confirm for the public room thread you see From <parent report> in <workspace name> and it looks like a link.
  6. Repeat step 3 for the parent thread to confirm parent navigation.
  7. Create a group chat with someone. Confirm in the report Header you see a format like UserA, UserB.
  8. Leave a comment and thread it. In the thread, confirm for the subheader you see From <UserA>, <UserB> and it looks like a link. The full name/email of the thread subheader should say From UserA, UserB.

Sample DM/group DM screenshot.
If the parent report looks like this, (Notice the first line says Marc, Rocio)
image

Confirm the threaded UI matches what was on the parent report i.e., From Marc, Rocio
image

  • Verify that no errors appear in the JS console

Offline tests

You can test the above same steps and it should work offline

QA Steps

Same as tests.

  • 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

DM thread
image

Workspace thread
image

Mobile Web - Chrome

DM thread
image

Workspace thread
image

Mobile Web - Safari
Desktop

Dm thread
image

Workspace thread
image

iOS

DM thread
image

Workspace thread
image

Android

@chiragsalian chiragsalian self-assigned this Jun 8, 2023
@chiragsalian
Copy link
Contributor Author

lint is failing on something unrelated which is being tackled here

@chiragsalian
Copy link
Contributor Author

I wasn't able to test on android. Can someone test this on android for me?

@chiragsalian chiragsalian requested a review from a team June 9, 2023 00:02
@chiragsalian chiragsalian marked this pull request as ready for review June 9, 2023 00:02
@melvin-bot melvin-bot bot requested review from abdulrahuman5196 and youssef-lr and removed request for a team June 9, 2023 00:03
@melvin-bot
Copy link

melvin-bot bot commented Jun 9, 2023

@abdulrahuman5196 @youssef-lr 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]

@chiragsalian chiragsalian requested a review from a team as a code owner June 9, 2023 00:25
@melvin-bot melvin-bot bot removed the request for review from a team June 9, 2023 00:25
@melvin-bot
Copy link

melvin-bot bot commented Jun 9, 2023

@mananjadhav @youssef-lr 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]

@melvin-bot melvin-bot bot requested a review from mananjadhav June 9, 2023 00:25
function getChatRoomSubtitle(report) {
if (isThread(report)) {
if (!getChatType(report)) {
return `From ${getDMRootReportName(report)}`;
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 moved this method down since it refers getDMRootReportName . The only change to this method is this line and this one.

@chiragsalian
Copy link
Contributor Author

I'm not sure when i requested two puller bears. I think manan was added accidentally so I'll remove him.

@chiragsalian chiragsalian requested review from grgia and removed request for mananjadhav June 9, 2023 00:33
@abdulrahuman5196
Copy link
Contributor

@chiragsalian Could you kindly add the issue description here or clone the issue to Expensify/App? I don't have access to view Expensify/Expensify issues. And is the PR ready for review, wanted to confirm if any pending actions are left?

@abdulrahuman5196
Copy link
Contributor

@chiragsalian Is this the expected behaviour to show 'owes' in the subheader for thread created from IOU?

Screen.Recording.2023-06-14.at.1.24.36.AM.mov

@abdulrahuman5196
Copy link
Contributor

Same shows 'paid' in case of settled, which seems very odd
Screenshot 2023-06-14 at 1 29 23 AM

@chiragsalian
Copy link
Contributor Author

chiragsalian commented Jun 13, 2023

Is this the expected behaviour to show 'owes' in the subheader for thread created from IOU?

Interesting, i didn't test IOU too much. I'll ping someone and ask about IOU expectations. It also can be refined as needed in future so I'm not worrying too much about it.

For now can you confirm if the PR looks fine for everything not IOU related? Meanwhile I'll hit up others and discuss about the IOU expectations.

@abdulrahuman5196
Copy link
Contributor

Sure. As far as i tested in web there weren't any other issues. Will work on testing on all other platforms and update the checklist soon.

@chiragsalian
Copy link
Contributor Author

Is this the expected behaviour to show 'owes' in the subheader for thread created from IOU?

For now yes, for non-policy chats the From description matches what you see on the LHN so that's good for now.
Screenshot 2023-06-13 at 1 28 50 PM

Yup, it also matches for when its paid,
Screenshot 2023-06-13 at 1 34 05 PM

So yeah i think for now that's fine. We have also discussed internally that we're just trying one approach and that we'll refine the text in the future as necessary.

@chiragsalian
Copy link
Contributor Author

I also just updated the link to use PressableWithoutFeedback to match some of the recent changes that was on main.

@abdulrahuman5196
Copy link
Contributor

abdulrahuman5196 commented Jun 13, 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
Untitled.33.mp4
Mobile Web - Chrome
Untitled.30.mp4
Mobile Web - Safari
Untitled.34.mp4
Desktop
Untitled.31.mp4
iOS
Untitled.32.mp4
Android
Untitled.35.mp4

@chiragsalian
Copy link
Contributor Author

Updated the code, can you check again @abdulrahuman5196.

Copy link
Contributor

@abdulrahuman5196 abdulrahuman5196 left a comment

Choose a reason for hiding this comment

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

Changes looks good and works well. Reviewers checklist is also complete.

All yours @chiragsalian / @grgia

@melvin-bot
Copy link

melvin-bot bot commented Jun 13, 2023

🎯 @abdulrahuman5196, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: #20723.

@chiragsalian
Copy link
Contributor Author

chiragsalian commented Jun 13, 2023

Cool, i'll self merge since @grgia has approved it previously and the changes are minor since then.
Thanks @abdulrahuman5196.

Edit: Looks like i can't self-merge it. I'll request someone else to merge it.

Copy link
Contributor

@PauloGasparSv PauloGasparSv left a comment

Choose a reason for hiding this comment

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

Approving and then merging this since @grgia already approved too! More info here

@PauloGasparSv PauloGasparSv merged commit d7c45a2 into main Jun 13, 2023
@PauloGasparSv PauloGasparSv deleted the chirag-subheader-navigation branch June 13, 2023 22:19
@OSBotify
Copy link
Contributor

✋ 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

🚀 Deployed to staging by https://github.com/PauloGasparSv in version: 1.3.28-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/AndrewGable in version: 1.3.28-5 🚀

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

accessibilityLabel={subtitle}
accessibilityRole="link"
>
<Text
Copy link
Collaborator

@mananjadhav mananjadhav Jul 10, 2023

Choose a reason for hiding this comment

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

When we added this component, the content is stretched and hence clicking the blank space was opening user chat instead of the chat details. This caused a regression here.

I think the issue occurred because we copy pasted the Text content, which didn't have the click behavior earlier.

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.

6 participants