Skip to content

"Group/room name" field out of Settings and into Report - #40858

Closed
dragnoir wants to merge 41 commits into
Expensify:mainfrom
dragnoir:40262-fix
Closed

dragnoir wants to merge 41 commits into
Expensify:mainfrom
dragnoir:40262-fix

Conversation

@dragnoir

@dragnoir dragnoir commented Apr 24, 2024 •

Copy link
Copy Markdown
Contributor

Details

This PR move the Group Chat "Group/Room name" field out of Settings and into Report Details

Fixed Issues

$ #40262
PROPOSAL: #40262 (comment)

Tests

  1. Open a group report or a room
  2. click on the header to open the details page
  3. check if there's a new menu item for the Group/Room name
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  1. Open a group report or a room
  2. click on the header to open the details page
  3. check if there's a new menu item for the Group/Room name
  • 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: mWeb Chrome
    • iOS: Native
    • iOS: mWeb 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • 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 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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design 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.

Screenshots/Videos

Android: Native

image

Android: mWeb Chrome

image

iOS: Native

image

iOS: mWeb Safari

image

MacOS: Chrome / Safari

image

MacOS: Desktop

image

@melvin-bot
melvin-bot Bot removed the request for review from a team April 26, 2024 10:00
@melvin-bot

melvin-bot Bot commented Apr 26, 2024

Copy link
Copy Markdown

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

@melvin-bot
melvin-bot Bot requested a review from eVoloshchak April 26, 2024 10:00
@dragnoir

Copy link
Copy Markdown
Contributor Author

Some screenshots:

Groupe:

image

Room:

image

Admin room:

image

Deprecated group:

image

Long workspace name:

image

Long group name:

image

long room name:

image

@dragnoir

Copy link
Copy Markdown
Contributor Author

Archived room:

image

@dragnoir

Copy link
Copy Markdown
Contributor Author

@shawnborton you may want to review this!

Comment thread src/components/MenuItem.tsx Outdated
onFocus?: () => void;

/** The text to display under the title */
underTitle?: string;

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We don't need this as we already have a furtherDetails prop, which does the same

Comment thread src/pages/ReportDetailsPage.tsx Outdated
titleStyle={styles.newKansasLarge}
shouldCheckActionAllowedOnPress={false}
description={isGroupChat ? translate('groupConfirmPage.groupName') : translate('newRoomPage.roomName')}
underTitle={chatRoomSubtitle && !isGroupChat ? `${translate('threads.in')} ${chatRoomSubtitle}` : ''} // "in Workspace X"

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
underTitle={chatRoomSubtitle && !isGroupChat ? `${translate('threads.in')} ${chatRoomSubtitle}` : ''} // "in Workspace X"
furtherDetails={chatRoomSubtitle && !isGroupChat ? `${translate('threads.in')} ${chatRoomSubtitle}` : ''}

@shawnborton

Copy link
Copy Markdown
Contributor

For archived rooms, I think they should look identical to room names that can't be edited, like so:
image

No need to create a separate design style for archived rooms in my opinion. cc @Expensify/design for vis.

Otherwise will spin up a test build now.

@github-actions

This comment has been minimized.

@dannymcclain

Copy link
Copy Markdown
Contributor

Test build is looking pretty good!

@shawnborton

Copy link
Copy Markdown
Contributor

Testing now and reporting a few things:

For workspace chats, we should also update the way we display the name:
CleanShot 2024-04-29 at 15 24 42@2x

From our mocks:
CleanShot 2024-04-29 at 15 26 17@2x

Note that we want to update the workspace room avatar, but I think we can handle that in a different PR.

@dragnoir

Copy link
Copy Markdown
Contributor Author

For archived rooms, I think they should look identical to room names that can't be edited

Archived rooms don't belong to Workspaces. Do I have just to remove the part where the workspace is? "In....."

@shawnborton

Copy link
Copy Markdown
Contributor

Archived rooms are indeed on workspaces, for example:
CleanShot 2024-04-29 at 15 43 04@2x

@dragnoir

Copy link
Copy Markdown
Contributor Author

For workspace chats, we should also update the way we display the nam

for this, updates as we have on groups?

Workspace name:
My WorkspaceName

@shawnborton

Copy link
Copy Markdown
Contributor

So the thing with workspace rooms is that they have a different title depending if the Submitter or Admin is viewing them.

Submitter sees:
CleanShot 2024-04-29 at 15 55 20@2x

Admin currently sees:
CleanShot 2024-04-29 at 15 54 41@2x

So maybe something like this makes sense?
CleanShot 2024-04-29 at 15 58 13@2x

Thoughts @Expensify/design?

@dragnoir

Copy link
Copy Markdown
Contributor Author

I think the "Workspace" label will be double, top and bottom

image

@shawnborton

Copy link
Copy Markdown
Contributor

Yeah, that's why I am suggesting we just reuse "Room name" - see my mock above

@shawnborton

Copy link
Copy Markdown
Contributor

Also I don't think you can rename those, so there wouldn't be an arrow on the right.

@dannymcclain

Copy link
Copy Markdown
Contributor

Looks good to me Shawn & I agree.

And here's a quick mock of an archived room for reference. Look right to you @shawnborton?
CleanShot 2024-04-29 at 15 33 42@2x

@shawnborton

Copy link
Copy Markdown
Contributor

Love it, that looks perfect to me.

@dubielzyk-expensify

Copy link
Copy Markdown
Contributor

That looks great from my end as well

@shawnborton

Copy link
Copy Markdown
Contributor

I think the idea is to include the small text below the task title, like so:
CleanShot 2024-05-17 at 13 14 50@2x

Basically make the details view match the report header view?

@thienlnam

Copy link
Copy Markdown
Contributor

Oh yeah cool, sounds like something an external contributor can do - I can spin up an issue to have it fixed

@eVoloshchak

eVoloshchak commented May 19, 2024 •

Copy link
Copy Markdown
Contributor

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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • 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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design 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_20240519-194349
Screenshot_20240519-194308

Android: mWeb Chrome Screenshot 2024-05-19 at 19 42 32 Screenshot 2024-05-19 at 19 41 51
iOS: Native

Simulator Screenshot - iPhone 15 Pro - 2024-05-19 at 19 37 49
Simulator Screenshot - iPhone 15 Pro - 2024-05-19 at 19 37 38

iOS: mWeb Safari

Simulator Screenshot - iPhone 15 Pro - 2024-05-19 at 19 41 14
Simulator Screenshot - iPhone 15 Pro - 2024-05-19 at 19 41 02

MacOS: Chrome / Safari Screenshot 2024-05-19 at 19 36 28 Screenshot 2024-05-19 at 19 35 46 Screenshot 2024-05-19 at 19 35 27
MacOS: Desktop Screenshot 2024-05-19 at 19 42 48 Screenshot 2024-05-19 at 19 42 41

@eVoloshchak eVoloshchak left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks good and tests well!

@melvin-bot
melvin-bot Bot requested a review from marcaaron May 19, 2024 17:48
Comment thread src/components/MenuItem.tsx Outdated
Comment thread src/components/MenuItem.tsx
Comment thread src/pages/ReportDetailsPage.tsx Outdated
Comment thread src/pages/ReportDetailsPage.tsx
Comment thread src/pages/ReportDetailsPage.tsx Outdated
const shouldDisableRename = useMemo(() => ReportUtils.shouldDisableRename(report, linkedWorkspace), [report, linkedWorkspace]);
const isDeprecatedGroupDM = useMemo(() => ReportUtils.isDeprecatedGroupDM(report), [report]);
const isPolicyExpenseChat = useMemo(() => ReportUtils.isPolicyExpenseChat(report), [report]);
const shouldShowRoomName = isPolicyExpenseChat || (!ReportUtils.isChatThread(report) && !isTaskReport && !isDeprecatedGroupDM && !isMoneyRequestReport && !isInvoiceRoom);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

thought: it would be better to put here report types that can have their names modified vs. one thing that can and then several things that can't. Each new report type that should not show the room name will have to join this list to avoid incorrect behavior.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I updated to

// List the report types that can have their names modified
const canModifyRoomName = !ReportUtils.isChatThread(report) && !isDeprecatedGroupDM && !isPolicyExpenseChat;

// Set shouldShowRoomName based on the new condition
const shouldShowRoomName = canModifyRoomName && !isTaskReport && !isMoneyRequestReport && !isInvoiceRoom;

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

ah sorry, that doesn't really address my concern. Is it clear to you which report types have modifiable names?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

ah sorry, that doesn't really address my concern. Is it clear to you which report types have modifiable names?

No, it's a bit complicated 😅 I took the same logic from other components.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Ok, thanks for being transparent - but can we use the open source channel in Slack to confirm what the behavior should be? I am not too sure myself. Or maybe @eVoloshchak can help us since they already approved the PR.

Comment thread src/pages/ReportDetailsPage.tsx Outdated
Comment thread src/pages/ReportDetailsPage.tsx Outdated
Comment thread src/pages/ReportDetailsPage.tsx Outdated
Comment thread src/pages/ReportDetailsPage.tsx
Comment thread src/pages/ReportDetailsPage.tsx Outdated
@marcaaron

Copy link
Copy Markdown
Contributor

@dragnoir whenever this is ready for another review please leave a comment that says "Updated!" so we know to look again. Thanks!

@dragnoir

dragnoir commented Jun 4, 2024

Copy link
Copy Markdown
Contributor Author

Updated!

const shouldDisableRename = useMemo(() => ReportUtils.shouldDisableRename(report, linkedWorkspace), [report, linkedWorkspace]);
const isDeprecatedGroupDM = useMemo(() => ReportUtils.isDeprecatedGroupDM(report), [report]);
const parentNavigationSubtitleData = ReportUtils.getParentNavigationSubtitle(report);
const shouldShowRoomName =

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We're changing

const shouldShowRoomName = !ReportUtils.isPolicyExpenseChat(report) && !ReportUtils.isChatThread(report) && !ReportUtils.isInvoiceRoom(report);

to

const shouldShowRoomName =
  !ReportUtils.isChatThread(report) &&
  !isDeprecatedGroupDM &&
  !isPolicyExpenseChat &&
  !isTaskReport &&
  !isMoneyRequestReport &&
  !isInvoiceRoom &&
  !(isMoneyRequestReport || isInvoiceReport || isMoneyRequest);

I agree we should confirm this behavior on Slack (and implement it inside of ReportUtils).
@dragnoir, could you start a slack thread to confirm the behavior?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

shouldShowRoomName is taken from here

const shouldShowRoomName = !ReportUtils.isPolicyExpenseChat(report) && !ReportUtils.isChatThread(report) && !ReportUtils.isInvoiceRoom(report);

and I added the new behavior we needed. I don't think it needs to be a utility, because it's used just once on the ReportDetailsPage.

About the last discussion, #40858 (comment) shouldShowRoomName is different from shouldShowRoomName

confirm this behavior

Can you please explain what behavior you mean?

Those new adjustments we already discussed it starting from this comment #40858 (comment) so I think the new behavior of the shouldShowRoomName is already approved.

What do you think?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@dragnoir, thank you! Missed the summary of changes in #40858 (comment), we should probably include it in the issue details
Could you merge the latest main please?

@shawnborton

Copy link
Copy Markdown
Contributor

I think we can just close this one out now.

@shawnborton shawnborton closed this Jul 3, 2024
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.

7 participants