fix: remove getDisplayNameForTypingIndicator by koko57 · Pull Request #31495 · Expensify/App

koko57 · 2023-11-17T17:42:43Z

First PR for #31312

Details

Fixed Issues

$ #31312
PROPOSAL: $ #31312 (comment)

Tests

Log in to app with two different accounts (can be on different devices or browsers).
Start a new chat (or open the existing one) between these two users.
Both users should have the chat between them opened.
Type something.
Verify that you see the typing user display name like this: [Typing User Name] is typing...

Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Log in to app with two different accounts (can be on different devices or browsers).
Start a new chat (or open the existing one) between these two users.
Both users should have the chat between them opened.
Type something.
Verify that you see the typing user display name like this: [Typing User Name] is typing...

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

fabioh8010 · 2023-11-20T09:02:03Z

    }

+    const firstUserTyping = usersTyping[0];
+    const firstUserTypingID = Number.isNaN(firstUserTyping) ? PersonalDetailsUtils.getAccountIDsByLogins([firstUserTyping])[0] : firstUserTyping;


What is the data structure of usersTyping[0]?

@fabioh8010 usersTyping is an array of the ids of the users typing in the report, so the usersTyping[0] is a string or a number

I'm having some difficult to understand what this line is doing 😅

For example, are you using Number.isNaN(firstUserTyping) for checking if string or number?

yes, it was the logic from the removed method that I moved here. But I forgot to wrap the usersTyping[0] in Number as it is supposed to be a string (I will check it for sure)

adhorodyski · 2023-11-20T09:24:28Z

    }

+    const firstUserTyping = usersTyping[0];
+    const firstUserTypingID = Number.isNaN(firstUserTyping) ? PersonalDetailsUtils.getAccountIDsByLogins([firstUserTyping])[0] : firstUserTyping;


PersonalDetailsUtils.getAccountIDsByLogins does a traverse on the personalDetails - imo worth memoising this call, could you please try it?

…thods

melvin-bot · 2023-11-21T11:21:38Z

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

koko57 · 2023-11-28T13:01:06Z

@situchan friendly bump 🙂

situchan · 2023-11-29T19:59:48Z

    userTypingStatuses: {},
 };

 function ReportTypingIndicator(props) {


As we're touching this component, can we destructure props?

…thods

situchan · 2023-11-30T15:00:03Z

-    const usersTyping = useMemo(() => _.filter(_.keys(props.userTypingStatuses), (loginOrAccountID) => props.userTypingStatuses[loginOrAccountID]), [props.userTypingStatuses]);
+    const usersTyping = useMemo(() => _.filter(_.keys(userTypingStatuses), (loginOrAccountID) => userTypingStatuses[loginOrAccountID]), [userTypingStatuses]);
+    const firstUserTyping = usersTyping[0];
+    const firstUserTypingID = useMemo(


Please move old comment to here

// If the user is typing on OldDot, firstUserTyping will be a string (the user's login)

situchan

I think we can optimize a bit like this:

situchan · 2023-11-30T15:03:19Z

+
    // If we are offline, the user typing statuses are not up-to-date so do not show them
-    if (props.network.isOffline) {
+    if (isOffline) {


Suggested change

if (isOffline) {

if (isOffline || !firstUserTyping) {

situchan · 2023-11-30T15:03:40Z

    const numUsersTyping = _.size(usersTyping);



Suggested change

const numUsersTyping = _.size(usersTyping);

situchan · 2023-11-30T15:07:20Z

@@ -44,8 +49,8 @@ function ReportTypingIndicator(props) {
        case 1:


replace switch/case with ? :

return usersTyping.length === 1 ? <TextWithEllipsis /> : <Text />

as the components for this are not one-liners I'd rather do it with an if statement, it'll be more readable

…thods

koko57 · 2023-12-01T09:50:17Z

@situchan changes applied 🙂

situchan · 2023-12-01T13:16:56Z

When type message from oldDot, it says "Someone is typing..."

Screen.Recording.2023-12-01.at.7.15.05.PM.mov

situchan · 2023-12-01T13:30:40Z

ok so I know what the issue is.
When typing from oldDot, pusher sends display name in reportUserIsTyping_, not login.

In old logic, it fallback to this:

return detailsByLogin?.displayName || userAccountIDOrLogin;

@koko57 we should apply same to new logic

koko57 · 2023-12-01T14:38:50Z

@situchan fixed!

situchan · 2023-12-01T14:40:13Z

-                    leadingTextParentStyle={styles.chatItemComposeSecondaryRowOffset}
-                />
-            );
+    // If the user is typing on OldDot, firstUserTyping will be a string (the user's login)


Suggested change

// If the user is typing on OldDot, firstUserTyping will be a string (the user's login)

// If the user is typing on OldDot, firstUserTyping will be a string (the user's displayName)

situchan · 2023-12-01T14:43:01Z

-                />
-            );
+    // If the user is typing on OldDot, firstUserTyping will be a string (the user's login)
+    const firstUserTypingDisplayName = ReportUtils.getDisplayNameForParticipant(firstUserTypingID, false, false) || firstUserTyping;


I don't think this will work when users don't know each other.
There's case when Somone is typing... but with this change, it will never happen

I have 2 solutions in mind:

getAccountIDsByLogins accepts 2nd parameter - shouldGenerateAccountID. If it's obvious that 1st param is not login but displayName, no need to generate random accountID but just return 0 or null. And then update this line like this:

const firstUserTypingDisplayName = firstUserTypingID ? ReportUtils.getDisplayNameForParticipant(firstUserTypingID, false, false) : firstUserTyping;

check displayName if it comes from oldDot by doing email/phone validation

I prefer 1st one since user can still set any random email as display name

@situchan can even such a scenario occur? How could I reproduce it?

which one are you not able to reproduce?

Here's repro step:

on A, create new chat with B

A sends any message to B

on B, type something

Observe chat on A

Please don't set display name on both accounts and try again

I think the purpose of hidden logic is to secure sensitive info (login in our case)
So if display name not set, show "Hidden"
if display name set, show that display name

but for one of them it was set automatically

Maybe you logged with google?
Btw you can unset display name in setting

I unset it, still the same. I'll get back to it on Monday

Screen.Recording.2023-12-01.at.18.40.35.mp4

situchan · 2023-12-12T15:35:24Z

+    const firstUserTypingID = useMemo(
+        () => (firstUserTyping && isUserTypingADisplayName ? PersonalDetailsUtils.getAccountIDsByLogins([firstUserTyping])[0] : firstUserTyping),
+        [firstUserTyping, isUserTypingADisplayName],
+    );


As per below line, this code block will never run.

const firstUserTypingDisplayName = isUserTypingADisplayName ? firstUserTyping : ReportUtils.getDisplayNameForParticipant(firstUserTypingID, false, false);

This will cause regression of displaying email instead of displayName whenfirstUserTyping is login

do we have such a case? Can you reproduce it for me? For all the users I have in the OldDot firstUserTyping is an id of digits.

I am not sure about that case too. But I am just concerned about deprecating this old code which tries to find user info with login

App/src/libs/actions/PersonalDetails.ts

Lines 71 to 79 in 617c2dd

// If the user is typing on OldDot, userAccountIDOrLogin will be a string (the user's login),

// so Number(string) is NaN. Search for personalDetails by login to get the display name.

if (Number.isNaN(accountID)) {

const detailsByLogin = Object.entries(allPersonalDetails ?? {}).find(([, value]) => value?.login === userAccountIDOrLogin)?.[1];

// It's possible for displayName to be empty string, so we must use "||" to fallback to userAccountIDOrLogin.

// eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing

return detailsByLogin?.displayName || userAccountIDOrLogin;

}

This old code should have been simplified like this if there's not such case of login

if (Number.isNaN(accountID)) { return userAccountIDOrLogin; }

Does my concern make sense?

but from the old code we would still return userAccountIDOrLogin (whatever is saved as firstUserTyping) to be shown and here we also show it

What I'd like to confirm is that the old code was redundant and could be simplified like this:

if (Number.isNaN(accountID)) { return userAccountIDOrLogin; }

situchan · 2023-12-12T15:50:04Z

-                />
-            );
+    // If the user is typing on OldDot, firstUserTyping will be a string (the user's displayName)
+    const firstUserTypingDisplayName = isUserTypingADisplayName ? firstUserTyping : ReportUtils.getDisplayNameForParticipant(firstUserTypingID, false, false);


If there's no case of login as firstUserTyping, this code can be updated like this:

Suggested change

const firstUserTypingDisplayName = isUserTypingADisplayName ? firstUserTyping : ReportUtils.getDisplayNameForParticipant(firstUserTypingID, false, false);

const firstUserTypingDisplayName = isUserTypingADisplayName ? firstUserTyping : ReportUtils.getDisplayNameForParticipant(firstUserTyping, false, false);

And remove unnecessary firstUserTypingID

So is there a posibility that firstUserTyping is a login or not? In which case then? Maybe I'm missing something

Do you agree with my code suggestion above?

situchan · 2023-12-12T16:24:07Z

@puneetlath can you please confirm in backend reportUserIsTyping_ has no login but only accountID or displayName?

App/src/libs/actions/PersonalDetails.ts

Lines 71 to 79 in 617c2dd

    
           // If the user is typing on OldDot, userAccountIDOrLogin will be a string (the user's login), 
        
           // so Number(string) is NaN. Search for personalDetails by login to get the display name. 
        
           if (Number.isNaN(accountID)) { 
        
               const detailsByLogin = Object.entries(allPersonalDetails ?? {}).find(([, value]) => value?.login === userAccountIDOrLogin)?.[1]; 
        
               // It's possible for displayName to be empty string, so we must use "||" to fallback to userAccountIDOrLogin. 
        
               // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing 
        
               return detailsByLogin?.displayName || userAccountIDOrLogin; 
        
           }

This old code which gets personal details by login doesn't make sense to me. Not able to find this case.
userAccountIDOrLogin could be simply returned

puneetlath · 2023-12-14T16:53:17Z

Oh interesting. It looks like the back-end does still use login for reportUserIsTyping. We should update it to use accountID.

situchan · 2023-12-14T16:54:30Z

Oh interesting. It looks like the back-end does still use login for reportUserIsTyping. We should update it to use accountID.

Upon testing, I think it's not login but displayName. Can you double check?

koko57 · 2023-12-18T13:42:55Z

@puneetlath @situchan what's the final decision about this login/display name logic?

koko57 · 2023-12-19T10:24:55Z

@puneetlath @situchan friendly bump 🙂

I think that this logic @situchan question here doesn't cause this regression.

…thods

koko57 · 2023-12-28T08:30:49Z

@situchan?

situchan · 2023-12-28T08:47:05Z

Anything pending from me?
I think we're waiting confirmation from @puneetlath on #31495 (comment)

puneetlath · 2023-12-28T23:07:09Z

My apologies for the delay. Yes, it looks like only login is not sent in reportUserIsTyping_

…thods

koko57 · 2023-12-29T10:53:40Z

@situchan so as we're not getting login I'm not insisting on the logic I've added. I applied the changes removing this check. Asking for re-review 🙂

situchan · 2023-12-29T14:40:54Z

please fix lint

koko57 · 2023-12-29T15:20:13Z

@situchan fixed!

situchan · 2023-12-29T16:29:47Z

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 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(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 form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label 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

desktop-android-hidden-user.mov

Android: mWeb Chrome

iOS: Native

ios.mov

iOS: mWeb Safari

msafari.mov

MacOS: Chrome / Safari

newdot.mov

olddot.mov

MacOS: Desktop

desktop-android-hidden-user.mov

situchan

puneetlath

Great job with this. Sorry for the delays on my side.

OSBotify · 2023-12-29T20:40:28Z

✋ 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 · 2024-01-02T23:50:58Z

🚀 Deployed to staging by https://github.com/puneetlath in version: 1.4.21-0 🚀

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

OSBotify · 2024-01-04T18:53:34Z

🚀 Deployed to production by https://github.com/marcaaron in version: 1.4.21-4 🚀

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

OSBotify · 2024-01-04T19:18:24Z

🚀 Deployed to production by https://github.com/marcaaron in version: 1.4.21-4 🚀

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

OSBotify · 2024-01-04T20:15:51Z

🚀 Deployed to production by https://github.com/marcaaron in version: 1.4.21-4 🚀

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

fix: remove getDisplayNameForTypingIndicator

a57d229

koko57 mentioned this pull request Nov 17, 2023

[HOLD for payment 2024-02-14] [HOLD for payment 2024-01-18] Consolidate GetDislplayName methods #31312

Closed

fabioh8010 reviewed Nov 20, 2023

View reviewed changes

adhorodyski reviewed Nov 20, 2023

View reviewed changes

koko57 added 3 commits November 20, 2023 12:12

Merge branch 'main' into refactor/31312-consolidate-getdisplayname-me…

9093ff3

…thods

Merge branch 'main' into refactor/31312-consolidate-getdisplayname-me…

6358b1e

…thods

fix: apply requested changes

1ff3017

fabioh8010 approved these changes Nov 21, 2023

View reviewed changes

fix: run prettier

b30cb29

koko57 marked this pull request as ready for review November 21, 2023 11:21

koko57 requested a review from a team as a code owner November 21, 2023 11:21

melvin-bot Bot requested review from situchan and removed request for a team November 21, 2023 11:21

situchan reviewed Nov 29, 2023

View reviewed changes

koko57 added 2 commits November 30, 2023 08:54

Merge branch 'main' into refactor/31312-consolidate-getdisplayname-me…

921a070

…thods

fix: destructure props

2ffcec2

situchan reviewed Nov 30, 2023

View reviewed changes

koko57 added 3 commits December 1, 2023 09:32

Merge branch 'main' into refactor/31312-consolidate-getdisplayname-me…

5fec558

…thods

fix: apply requested changes

fe1e320

fix: run prettier

e7d667c

fix: minor fix

8af4811

situchan reviewed Dec 1, 2023

View reviewed changes

situchan reviewed Dec 12, 2023

View reviewed changes

koko57 added 2 commits December 18, 2023 15:45

fix: resolve conflicts

8fb1f2f

fix: prettier

69ba3a0

Merge branch 'main' into refactor/31312-consolidate-getdisplayname-me…

c1435f4

…thods

koko57 added 2 commits December 29, 2023 11:36

Merge branch 'main' into refactor/31312-consolidate-getdisplayname-me…

a4e422f

…thods

fix: do not check for login if is present in personalDetails

10f49fa

fix: lint

1bab5a9

situchan approved these changes Dec 29, 2023

View reviewed changes

melvin-bot Bot requested a review from puneetlath December 29, 2023 16:31

puneetlath approved these changes Dec 29, 2023

View reviewed changes

puneetlath merged commit 48a0c82 into Expensify:main Dec 29, 2023

github-actions Bot mentioned this pull request Jan 2, 2024

Deploy Checklist: New Expensify 2024-01-02 #33855

Closed

58 tasks

		@@ -44,8 +49,8 @@ function ReportTypingIndicator(props) {
		case 1:

	// If the user is typing on OldDot, firstUserTyping will be a string (the user's login)
	// If the user is typing on OldDot, firstUserTyping will be a string (the user's displayName)

	// If the user is typing on OldDot, userAccountIDOrLogin will be a string (the user's login),
	// so Number(string) is NaN. Search for personalDetails by login to get the display name.
	if (Number.isNaN(accountID)) {
	const detailsByLogin = Object.entries(allPersonalDetails ?? {}).find(([, value]) => value?.login === userAccountIDOrLogin)?.[1];

	// It's possible for displayName to be empty string, so we must use "\|\|" to fallback to userAccountIDOrLogin.
	// eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
	return detailsByLogin?.displayName \|\| userAccountIDOrLogin;
	}

	const firstUserTypingDisplayName = isUserTypingADisplayName ? firstUserTyping : ReportUtils.getDisplayNameForParticipant(firstUserTypingID, false, false);
	const firstUserTypingDisplayName = isUserTypingADisplayName ? firstUserTyping : ReportUtils.getDisplayNameForParticipant(firstUserTyping, false, false);

Uh oh!

Conversation

koko57 commented Nov 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

melvin-bot Bot commented Nov 21, 2023

Uh oh!

koko57 commented Nov 28, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

situchan left a comment

Choose a reason for hiding this comment

Uh oh!

situchan Nov 30, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

koko57 commented Dec 1, 2023

Uh oh!

situchan commented Dec 1, 2023

Uh oh!

situchan commented Dec 1, 2023

Uh oh!

koko57 commented Dec 1, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

situchan Dec 1, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

koko57 Dec 1, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

koko57 commented Nov 17, 2023 •

edited

Loading

situchan Nov 30, 2023 •

edited

Loading

situchan Dec 1, 2023 •

edited

Loading

koko57 Dec 1, 2023 •

edited

Loading