fix: Approver field in tag editor shows user email instead of user name by etCoderDysto · Pull Request #52961 · Expensify/App

etCoderDysto · 2024-11-22T14:26:57Z

Explanation of Change

Fixed Issues

$ #52678
PROPOSAL: #52678 (comment)

Tests

Precondition

Account should have beta access
Enable Workflows > enable Add approvals
Enable rules
Create tags

Go to staging.new.expensify.com
Go to workspace settings > Tags.
Click on any tag.
Click Approver.
Select a user with custom name.
Verify that that approver field displays the user's name instead of email

Verify that no errors appear in the JS console

Offline tests

Same as test steps

QA Steps

// TODO: These must be filled out, or the issue title must include "[No QA]."
Precondition

Account should have beta access
Enable Workflows > enable Add approvals
Enable rules
Create tags

Go to staging.new.expensify.com
Go to workspace settings > Tags.
Click on any tag.
Click Approver.
Select a user with custom name.
Verify that that approver field displays the user's name instead of email

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Android.mp4

Android: mWeb Chrome

Android.chrome.mp4

iOS: Native

ios.mp4

iOS: mWeb Safari

ios.safari.mp4

MacOS: Chrome / Safari

web.mp4

MacOS: Desktop

desktop.mp4

melvin-bot · 2024-11-22T14:27:03Z

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

etCoderDysto · 2024-11-22T14:47:10Z

@eh2077 The lint warrning is caused because I have added policy?.rules?.approvalRules to the useMemo dependency list. When selecting an approver, the approverText won't be calculated if I don't add approvalRules to the dependency list. Should I disable to the warrning?

App/src/pages/workspace/tags/TagSettingsPage.tsx

Line 60 in bf58af6

}, [policyID, route.params?.tagName, policy?.rules?.approvalRules]);

eh2077 · 2024-11-24T15:21:33Z

@etCoderDysto Please fix lint errors

eh2077 · 2024-11-24T15:56:36Z

@etCoderDysto I'd like to refrain from using // eslint-disable-next-line react-hooks/exhaustive-deps. Instead, I think you should consider improving the coding.

Let's step back a little bit before jumping to fixing. I think the reason you need to add policy?.rules?.approvalRules into the deps array is because the function PolicyUtils.getTagApproverRule depends on policy?.rules?.approvalRules internally.

So, I think you can try something like

const tagApprover = PolicyUtils.getTagApproverRule(policyID, route.params?.tagName)?.approver ?? '';
const approverText = useMemo(() => {
    const approver = PersonalDetailsUtils.getPersonalDetailByEmail(tagApprover);
    return approver?.displayName ?? tagApprover;
}, [policyID, route.params?.tagName, tagApprover]);

etCoderDysto · 2024-11-24T16:52:27Z

So, I think you can try something like

const tagApprover = PolicyUtils.getTagApproverRule(policyID, route.params?.tagName)?.approver ?? '';
const approverText = useMemo(() => {
    const approver = PersonalDetailsUtils.getPersonalDetailByEmail(tagApprover);
    return approver?.displayName ?? tagApprover;
}, [policyID, route.params?.tagName, tagApprover]);

This makes sense. I will make this change, and test it. Thanks!

eh2077 · 2024-11-25T07:48:45Z


+    const tagApprover = PolicyUtils.getTagApproverRule(policyID, route.params?.tagName)?.approver ?? '';
+    const approverText = useMemo(() => {
+        const approver = PersonalDetailsUtils.getPersonalDetailByEmail(tagApprover);


This method should be lightweight right? Do we still need to use the useMemo hook here?

Ahh yes, there is no expensive calculation in the useMemo since we took out getTagApproverRule from the hook. I will push a change.

mountiny · 2024-11-25T18:47:15Z

@etCoderDysto @eh2077 how is it looking? Do you think this can be ready for review / checklist completed today?

etCoderDysto · 2024-11-25T18:48:59Z

@mountiny I have a small change to make. It will be ready for further review in 30 minutes.

etCoderDysto · 2024-11-25T19:07:12Z

@eh2077 Pr is ready for further review.

eh2077 · 2024-11-26T14:12:07Z

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

0-android.mp4

Android: mWeb Chrome

0-mobile-chrome.mp4

iOS: Native

0-ios.mp4

iOS: mWeb Safari

0-mobile-safari.mp4

MacOS: Chrome / Safari

0-web.mp4

MacOS: Desktop

0-desktop.mp4

eh2077

LGTM and tested well!

OSBotify · 2024-11-26T17:53:10Z

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

github-actions · 2024-11-28T14:48:00Z

🚀 Deployed to staging by https://github.com/mountiny in version: 9.0.68-0 🚀

platform	result
🤖 android 🤖	false ❌
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	success ✅
🍎🔄 iOS HybridApp 🍎🔄	success ✅

github-actions · 2024-11-30T13:52:35Z

🚀 Deployed to production by https://github.com/mountiny in version: 9.0.68-7 🚀

platform	result
🤖 android 🤖	skipped 🚫
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	failure ❌
🍎🔄 iOS HybridApp 🍎🔄	failure ❌

show display name for approver field on tag settings page

bf58af6

etCoderDysto requested a review from a team as a code owner November 22, 2024 14:26

melvin-bot Bot requested review from eh2077 and removed request for a team November 22, 2024 14:27

fix lint error caused by approverText useMemo

8a0dff2

eh2077 reviewed Nov 25, 2024

View reviewed changes

mountiny assigned etCoderDysto Nov 25, 2024

mountiny self-requested a review November 25, 2024 18:47

Don't use useMemo to calculate approverText

97868c9

eh2077 approved these changes Nov 26, 2024

View reviewed changes

mountiny approved these changes Nov 26, 2024

View reviewed changes

mountiny merged commit ef751ff into Expensify:main Nov 26, 2024

github-actions Bot mentioned this pull request Nov 28, 2024

Deploy Checklist: New Expensify 2024-11-28 #53245

Closed

72 tasks done

melvin-bot Bot mentioned this pull request Nov 30, 2024

[HOLD for payment 2024-12-07] [$250] Tag rules - Approver field in tag editor shows user email instead of user name #52678

Closed

7 of 8 tasks

Conversation

etCoderDysto commented Nov 22, 2024

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot Bot commented Nov 22, 2024

Uh oh!

etCoderDysto commented Nov 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

eh2077 commented Nov 24, 2024

Uh oh!

eh2077 commented Nov 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

etCoderDysto commented Nov 24, 2024

Uh oh!

eh2077 Nov 25, 2024

Choose a reason for hiding this comment

Uh oh!

etCoderDysto Nov 25, 2024

Choose a reason for hiding this comment

Uh oh!

mountiny commented Nov 25, 2024

Uh oh!

etCoderDysto commented Nov 25, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

etCoderDysto commented Nov 25, 2024

Uh oh!

eh2077 commented Nov 26, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

eh2077 left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Nov 26, 2024

Uh oh!

github-actions Bot commented Nov 28, 2024

Uh oh!

github-actions Bot commented Nov 30, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

etCoderDysto commented Nov 22, 2024 •

edited

Loading

eh2077 commented Nov 24, 2024 •

edited

Loading

etCoderDysto commented Nov 25, 2024 •

edited

Loading

eh2077 commented Nov 26, 2024 •

edited

Loading