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

feat: update policy expense chat name #56735

Open
wants to merge 22 commits into
base: main
Choose a base branch
from

Conversation

nkdengineer
Copy link
Contributor

@nkdengineer nkdengineer commented Feb 12, 2025

Explanation of Change

  • Update policy expense chat name to ${user's displayname}'s expense
  • Update the subtitle of the all rooms related to the workspace with the prefix ${policyName} • if we have multiple workspace

Fixed Issues

$ #56123
PROPOSAL: #56123 (comment)

Tests

  1. Login with a new account
  2. Select Manage my team in the onboarding flow and complete the flow
  3. Notice LHN and verify that the policy expense chat name has the format ${Email upto @}'s Expenses
  4. Change the display name to a custom display name
  5. Go to LHN and verify that the policy expense chat name has the format ${user's displayname}'s expense
  6. Open any chat related to the workspace and add a message or create an expense
  7. Verify that the reports related to the workspace don't display the policy name at the prefix because we only have one workspace
  8. Create another workspace
  9. Notice LHN and verify that the subtitle of the reports related to the workspace has the policy name at the prefix
  10. Go FAB > Create expense
  11. Enter any amount > Confirmation page
  12. Click on To field
  13. On the participant page, verify that the subtitle of the policy expense chat has the policy name at the prefix
  • Verify that no errors appear in the JS console

Offline tests

Same

QA Steps

  1. Login with a new account
  2. Select Manage my team in the onboarding flow and complete the flow
  3. Notice LHN and verify that the policy expense chat name has the format ${Email upto @}'s Expenses
  4. Change the display name to a custom display name
  5. Go to LHN and verify that the policy expense chat name has the format ${user's displayname}'s expense
  6. Open any chat related to the workspace and add a message or create an expense
  7. Verify that the reports related to the workspace don't display the policy name at the prefix because we only have one workspace
  8. Create another workspace
  9. Notice LHN and verify that the subtitle of the reports related to the workspace has the policy name at the prefix
  10. Go FAB > Create expense
  11. Enter any amount > Confirmation page
  12. Click on To field
  13. On the participant page, verify that the subtitle of the policy expense chat has the policy name at the prefix

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 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 used JaimeGPT to get English > Spanish translation. I then posted it 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.ts 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.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • 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
Screen.Recording.2025-02-12.at.14.30.02.mov
Android: mWeb Chrome
Screen.Recording.2025-02-12.at.14.31.46.mov
iOS: Native
Screen.Recording.2025-02-12.at.14.30.42.mov
iOS: mWeb Safari
Screen.Recording.2025-02-12.at.14.31.30.mov
MacOS: Chrome / Safari
Screen.Recording.2025-02-12.at.14.27.56.mov
MacOS: Desktop
Screen.Recording.2025-02-12.at.14.34.32.mov

@nkdengineer nkdengineer marked this pull request as ready for review February 12, 2025 08:35
@nkdengineer nkdengineer requested a review from a team as a code owner February 12, 2025 08:35
@melvin-bot melvin-bot bot requested review from fedirjh and removed request for a team February 12, 2025 08:35
Copy link

melvin-bot bot commented Feb 12, 2025

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

@@ -2721,6 +2722,7 @@ const translations = {
defaultCategory: 'Default category',
viewTransactions: 'View transactions',
leaveConfirmation: "Are you sure you want to leave this workspace? Once you leave, you'll lose access to all data and settings associated with this workspace.",
policyExpenseChatName: ({displayName}: PolicyExpenseChatNameParams) => `${displayName}'s expense`,
Copy link
Contributor

Choose a reason for hiding this comment

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

It should be expenses not just expense

Also, I think we want just the first name or do we want the full display name of First Lastname? cc @dannymcclain for confirmation there

Copy link
Contributor

Choose a reason for hiding this comment

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

Agree about expenses, and I'm pretty positive we're going with displayName in case there are multiple users with the same first name 👍

@dannymcclain
Copy link
Contributor

Update the subtitle of the policy expense chat with the prefix ${policyName} •

Quick note about this one: we only want to do this when a user has multiple workspaces.

@nkdengineer
Copy link
Contributor Author

@dannymcclain What happens if the user has two workspaces and delete one of them, and in this case what the policy expense chat name should be?

@dannymcclain
Copy link
Contributor

What happens if the user has two workspaces and delete one of them, and in this case what the policy expense chat name should be?

I guess I would expect the little description text to go away? But cc @Expensify/design for a gut check on that one

@shawnborton
Copy link
Contributor

That makes sense to me 👍

@nkdengineer
Copy link
Contributor Author

What happens if the user has two workspaces and delete one of them, and in this case what the policy expense chat name should be?
Update the subtitle of the policy expense chat with the prefix ${policyName} •
Quick note about this one: we only want to do this when a user has multiple workspaces.

@dannymcclain Also in this case that I mentioned above, what should we display the the prefix ${policyName} •

@dannymcclain
Copy link
Contributor

Also in this case that I mentioned above, what should we display the the prefix ${policyName} •

Would you mind rephrasing? I'm not sure I'm following. Do these mocks help clarify anything?

image
image

@nkdengineer
Copy link
Contributor Author

@dannymcclain I understood the mock, the thing I need to confirm here is if we have two workspaces and we deleted one. What mock should be applied for this case? Single workspace or multiple workspace case?. The reason I asked this because when a workspace is deleted, the policy expense chat still exist.

@dannymcclain
Copy link
Contributor

The reason I asked this because when a workspace is deleted, the policy expense chat still exist.

Ahhh I didn't realize that! Thank you for clarifying. I think in that case, where multiple exist, we should probably stick with the multi-workspace pattern and include the prepended text. Does that sound right to you @Expensify/design?

@shawnborton
Copy link
Contributor

Hmm good question... I suppose that makes sense, though I would also expect us to append (archived) into the expense room title, so I would also be fine leaving the workspace name out if just one workspace exists.

@dannymcclain
Copy link
Contributor

That works for me as well.

@nkdengineer
Copy link
Contributor Author

Quick note about this one: we only want to do this when a user has multiple workspaces.

Updated with this expected.

@nkdengineer
Copy link
Contributor Author

@fedirjh It's ready for review.

@shawnborton
Copy link
Contributor

Oh great catches Danny!

@nkdengineer
Copy link
Contributor Author

nkdengineer commented Feb 18, 2025

@dannymcclain For the case display Workspace, maybe because we don't have subtitle which is the personal detail of the submit to user here.

App/src/libs/ReportUtils.ts

Lines 4601 to 4611 in e66ec9a

if ((isPolicyExpenseChat(report) && !!report?.isOwnPolicyExpenseChat) || isExpenseReport(report)) {
const submitToAccountID = getSubmitToAccountID(getPolicy(report?.policyID), report);
const submitsToAccountDetails = allPersonalDetails?.[submitToAccountID];
const subtitle = submitsToAccountDetails?.displayName ?? submitsToAccountDetails?.login;
if (!subtitle || !config.isCreateExpenseFlow) {
return translateLocal('workspace.common.workspace');
}
return translateLocal('iou.submitsTo', {name: subtitle ?? ''});
}

@trjExpensify
Copy link
Contributor

Did we decide if we wanted to change the subtext here from Workspace to be something like Expense room? I can't remember if we landed on anything,

I think the workspace name would be most useful here probably.

@nkdengineer
Copy link
Contributor Author

@dannymcclain The display in Search router is fixed now.

@shawnborton
Copy link
Contributor

@nkdengineer did you address our feedback above about using the Workspace name instead of just "Workspace" here?

@nkdengineer
Copy link
Contributor Author

@shawnborton I just updated.

@dannymcclain
Copy link
Contributor

Going to run another test build

Copy link
Contributor

🚧 @dannymcclain has triggered a test build. You can view the workflow run here.

Copy link
Contributor

@dannymcclain
Copy link
Contributor

Nice! Feeling pretty good to me.

@shawnborton
Copy link
Contributor

Yeah, same! I say let's get this into final review @fedirjh

});

expect(canCreate).toBe(false);
});
});

it('createOptionList() localization', () => {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@fedirjh Just a note here: I deleted this localization test because it's outdated now, we will show Workspace's name instead of Workspace work.

Copy link
Contributor

Choose a reason for hiding this comment

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

can we have a test for expenses room localization ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@fedirjh I updated.

Copy link
Contributor

@fedirjh fedirjh left a comment

Choose a reason for hiding this comment

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

Looks solid. left small review.

});

expect(canCreate).toBe(false);
});
});

it('createOptionList() localization', () => {
Copy link
Contributor

Choose a reason for hiding this comment

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

can we have a test for expenses room localization ?

Comment on lines -3251 to -3253
if (report?.isOwnPolicyExpenseChat) {
return getPolicyName({report, policy, policies, reports});
}
Copy link
Contributor

Choose a reason for hiding this comment

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

Why don't keep old behavior and early return at this point ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@fedirjh What do you mean?

Copy link
Contributor

Choose a reason for hiding this comment

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

I saw that you moved this early return to the bottom of the function. I suggested to keep the early return to avoid any extra calculation.

@fedirjh
Copy link
Contributor

fedirjh commented Feb 20, 2025

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 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.ts 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.
  • For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
  • 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.

@fedirjh
Copy link
Contributor

fedirjh commented Feb 20, 2025

Screenshots/Videos

Android: Native Screenshot 2025-02-20 at 9 08 52 PM Screenshot 2025-02-20 at 9 18 21 PM Screenshot 2025-02-20 at 9 18 45 PM Screenshot 2025-02-20 at 9 20 00 PM Screenshot 2025-02-20 at 9 22 00 PM
Android: mWeb Chrome Screenshot 2025-02-20 at 9 24 28 PM Screenshot 2025-02-20 at 9 24 47 PM Screenshot 2025-02-20 at 9 25 22 PM
iOS: Native Screenshot 2025-02-20 at 10 24 37 PM Screenshot 2025-02-20 at 10 24 51 PM Screenshot 2025-02-20 at 10 25 04 PM Screenshot 2025-02-20 at 10 25 10 PM Screenshot 2025-02-20 at 10 25 28 PM Screenshot 2025-02-20 at 10 25 39 PM Screenshot 2025-02-20 at 10 26 06 PM
iOS: mWeb Safari Screenshot 2025-02-20 at 10 27 23 PM Screenshot 2025-02-20 at 10 28 05 PM Screenshot 2025-02-20 at 10 28 18 PM
MacOS: Chrome / Safari Screenshot 2025-02-20 at 8 11 47 PM Screenshot 2025-02-20 at 8 11 52 PM Screenshot 2025-02-20 at 8 12 13 PM Screenshot 2025-02-20 at 8 12 28 PM Screenshot 2025-02-20 at 8 12 33 PM Screenshot 2025-02-20 at 8 12 53 PM Screenshot 2025-02-20 at 8 13 05 PM Screenshot 2025-02-20 at 8 13 59 PM Screenshot 2025-02-20 at 8 14 39 PM Screenshot 2025-02-20 at 8 15 37 PM Screenshot 2025-02-20 at 8 15 43 PM Screenshot 2025-02-20 at 8 16 37 PM Screenshot 2025-02-20 at 8 16 47 PM Screenshot 2025-02-20 at 8 23 34 PM
MacOS: Desktop Screenshot 2025-02-20 at 8 23 34 PM Screenshot 2025-02-20 at 8 57 08 PM Screenshot 2025-02-20 at 8 58 44 PM Screenshot 2025-02-20 at 8 59 40 PM

@fedirjh
Copy link
Contributor

fedirjh commented Feb 20, 2025

@shawnborton @dannymcclain Just noticed that when you have many workspaces and you select one , the workspace prefix is still applied to its rooms. should we keep it that way ?

Screenshot 2025-02-20 at 8 59 40 PM

@fedirjh
Copy link
Contributor

fedirjh commented Feb 20, 2025

Unavailable workspace is displayed for some public rooms, is that expected ?

Screenshot 2025-02-20 at 9 20 00 PM

@dannymcclain
Copy link
Contributor

Just noticed that when you have many workspaces and you select one , the workspace prefix is still applied to its rooms. should we keep it that way ?

Ooh great question. I don't think I have very strong feelings about this—I could honestly go either way. I guess it makes sense to remove it when filtered to a workspace, but at the same time it doesn't really bother me. @Expensify/design what about you all?

@dubielzyk-expensify
Copy link
Contributor

Yeah same, I could go either way. Part of me prefers the simplification, but I also just feel like while still are things evolving we're just adding complexity, so I think I lean on just keeping the workspace appended regardless of whether you have filtered a workspace or not.

@nkdengineer
Copy link
Contributor Author

Unavailable workspace is displayed for some public rooms, is that expected ?

Updated to fix this case.

@dannymcclain
Copy link
Contributor

Yeah that's a good point. Probably no need to add the extra complexity right now. If we find that this pattern sticks around for the long haul, we can do a follow up to perfectly perfect it. 👍

@shawnborton
Copy link
Contributor

Yeah, I can totally get down with that too. Then we can get some real world usage and see how it goes. I don't think many people even use the workspace filter IMO so I don't think it's the biggest deal anyways.

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.

6 participants