Update Workspace auto naming to include using First Name over the username of a public email #44109

allgandalf · 2024-06-20T18:41:45Z

Details

This PR changes the naming workspace naming logic, the new logic is as follows:

Use the private domain if they have that. If not,
Use the their First and/or Last name. If not,
Use their email username. If not,
Use their phone number.

Reference

Fixed Issues

$ #42677
PROPOSAL: #42677 (comment)

Tests

Same as QA Steps

Verify that no errors appear in the JS console

Offline tests

Same as QA steps (Note that creating a new account while offline is not possible so some of the below tests are not possible offline)

QA Steps

Test 1

Login with a new account with Public Domain (example: @gmail.com)
Click on something else in onboarding flow.
Enter your name
Go to settings
Click workspaces
Create a new workspace

Verify that the workspace created has the name: first name + last name (if exist)'s Workspace.

Test 2

Login with a new account with private domain
Click on something else in onboarding flow.
Enter your name
Go to settings
Click workspaces
Create a new workspace

Verify that the workspace created has the name: (private domain)'s Workspace.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2024-06-21.at.12.58.19.AM.mov

Android: mWeb Chrome

Screen.Recording.2024-06-21.at.1.21.25.AM.mov

iOS: Native

Screen.Recording.2024-06-21.at.1.35.15.AM.mov

iOS: mWeb Safari

Screen.Recording.2024-06-21.at.12.52.41.AM.mov

MacOS: Chrome / Safari

Screen.Recording.2024-06-21.at.12.46.23.AM.mov

MacOS: Desktop

Screen.Recording.2024-06-21.at.12.48.33.AM.mov

melvin-bot · 2024-06-20T18:41:51Z

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

allgandalf · 2024-06-20T18:45:06Z

Fixing some issue with my simulator will post over issue when the PR is ready for review

getusha · 2024-06-27T13:19:59Z

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

Screen.Recording.2024-07-03.at.7.04.05.in.the.evening.mov

Android: mWeb Chrome

Screen.Recording.2024-07-03.at.6.46.02.in.the.evening.mov

iOS: Native

Screen.Recording.2024-07-09.at.11.56.00.in.the.morning.mov

iOS: mWeb Safari

Screen.Recording.2024-07-03.at.6.42.55.in.the.evening.mov

MacOS: Chrome / Safari

Screen.Recording.2024-07-03.at.6.38.36.in.the.evening.mov

MacOS: Desktop

Screen.Recording.2024-07-03.at.6.52.15.in.the.evening.mov

getusha · 2024-06-27T14:27:11Z

src/libs/actions/Policy/test.md

I think this is added by mistake

opps my bad, will update in sometime

getusha · 2024-06-27T14:32:47Z

src/libs/actions/Policy/Policy.ts

        defaultWorkspaceName = `${Str.UCFirst(username)}'s Workspace`;
    } else {
-        defaultWorkspaceName = `${Str.UCFirst(domain.split('.')[0])}'s Workspace`;
+        defaultWorkspaceName = userDetails?.phoneNumber ?? '';


actually is there any possible case where we use a phone number? there'll always be an email associated with the account.

when you login via a new account with phone number, i guess at that time this case is used, I will confirm if that hypothesis is true in sometime

Lets keep this code, The comment does say that we should have a phone number case so better to keep :)

getusha · 2024-06-27T14:42:46Z

We should add a test case where the first and last names are not set. wdyt?

allgandalf · 2024-06-29T20:59:33Z

We should add a test case where the first and last names are not set. wdyt?

With the PR : #44375

There won't be a case where first name is not set, so i think the test case would not have significance, WDYT?

allgandalf · 2024-06-29T21:02:49Z

We're good for the checklist @getusha 👍

allgandalf · 2024-07-02T18:51:43Z

friendly bump @getusha

getusha · 2024-07-03T19:45:53Z

Stuck on iOS runtime error, trying to resolve it.

allgandalf · 2024-07-04T17:55:28Z

As this doesn't change any of the native files, i think it would be fine if you use my videos @getusha , but hope your simulator issues get solved at the earliest

allgandalf · 2024-07-08T14:24:01Z

any update here @getusha ?

getusha

lgtm, a couple of comments

getusha · 2024-07-09T11:37:55Z

src/libs/actions/Policy/Policy.ts

@@ -1355,11 +1356,17 @@ function generateDefaultWorkspaceName(email = ''): string {
    }
    const username = emailParts[0];
    const domain = emailParts[1];
+    const userDetails = PersonalDetailsUtils.getPersonalDetailByEmail(sessionEmail);
+    const displayName = `${userDetails?.firstName ?? ''}${userDetails?.lastName ? ` ${userDetails.lastName}` : ''}`;


Suggested change

const displayName = `${userDetails?.firstName ?? ''}${userDetails?.lastName ? ` ${userDetails.lastName}` : ''}`;

const displayName = userDetails?.displayName;

Are you sure that there is a displayName property ? and it would not add extra space if we do not have the last name?

Yes, there is 😄

and it would not add extra space if we do not have the last name?

We can trim it if that's the case!

umm, makes sense, i will update this PR by EOD.

getusha · 2024-07-09T11:38:13Z

src/libs/actions/Policy/Policy.ts

-    if (PUBLIC_DOMAINS.some((publicDomain) => publicDomain === domain.toLowerCase())) {
+    if (!PUBLIC_DOMAINS.some((publicDomain) => publicDomain === domain.toLowerCase())) {
+        defaultWorkspaceName = `${Str.UCFirst(domain.split('.')[0])}'s Workspace`;
+    } else if (displayName !== '') {


Suggested change

} else if (displayName !== '') {

} else if (!!displayName) {

allgandalf · 2024-07-10T13:18:53Z

I updated the PR @getusha :) thanks

getusha · 2024-07-10T16:16:55Z

@allgandalf we've got a couple of checks failing

src/libs/actions/Policy/Policy.ts

Co-authored-by: Getabalew <[email protected]>

allgandalf · 2024-07-13T15:17:31Z

Thanks for the suggestions, hope it fixes the issues :))

allgandalf · 2024-07-16T06:50:29Z

@getusha , can you please approve this

chiragsalian

LGTM

OSBotify · 2024-07-16T19:31:41Z

✋ 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-07-17T02:09:02Z

🚀 Deployed to staging by https://github.com/chiragsalian in version: 9.0.8-1 🚀

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

OSBotify · 2024-07-17T15:49:22Z

🚀 Cherry-picked to staging by https://github.com/Beamanator in version: 9.0.8-3 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

OSBotify · 2024-07-18T13:49:23Z

🚀 Deployed to production by https://github.com/mountiny in version: 9.0.8-6 🚀

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

OSBotify · 2024-07-19T19:36:02Z

🚀 Deployed to production by https://github.com/mountiny in version: 9.0.9-5 🚀

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

change workspace naming logic

e50bab6

allgandalf requested a review from a team as a code owner June 20, 2024 18:41

melvin-bot bot requested review from getusha and removed request for a team June 20, 2024 18:41

allgandalf added 2 commits June 21, 2024 00:20

Fix type

e91e472

fix lint

7f2896c

getusha reviewed Jun 27, 2024

View reviewed changes

remove test file

10cdf40

danielrvidal mentioned this pull request Jul 9, 2024

[HOLD for payment 2024-07-25] [$250] [CVP] Update Workspace auto naming to include using First Name over the username of a public email. #42677

Closed

getusha reviewed Jul 9, 2024

View reviewed changes

apply suggestions

6a403d3

getusha reviewed Jul 10, 2024

View reviewed changes

src/libs/actions/Policy/Policy.ts Outdated Show resolved Hide resolved

getusha reviewed Jul 10, 2024

View reviewed changes

src/libs/actions/Policy/Policy.ts Outdated Show resolved Hide resolved

Apply suggestions from code review

fee8c12

Co-authored-by: Getabalew <[email protected]>

getusha approved these changes Jul 16, 2024

View reviewed changes

melvin-bot bot requested a review from chiragsalian July 16, 2024 09:41

chiragsalian approved these changes Jul 16, 2024

View reviewed changes

chiragsalian merged commit 825821b into Expensify:main Jul 16, 2024
15 checks passed

github-actions bot mentioned this pull request Jul 17, 2024

Deploy Checklist: New Expensify 2024-07-17 #45538

Closed

48 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Workspace auto naming to include using First Name over the username of a public email #44109

Update Workspace auto naming to include using First Name over the username of a public email #44109

allgandalf commented Jun 20, 2024 •

edited

Loading

melvin-bot bot commented Jun 20, 2024

allgandalf commented Jun 20, 2024

getusha commented Jun 27, 2024 •

edited

Loading

getusha Jun 27, 2024

allgandalf Jun 27, 2024

getusha Jun 27, 2024

allgandalf Jun 27, 2024

allgandalf Jun 29, 2024

getusha commented Jun 27, 2024

allgandalf commented Jun 29, 2024

allgandalf commented Jun 29, 2024

allgandalf commented Jul 2, 2024

getusha commented Jul 3, 2024

allgandalf commented Jul 4, 2024

allgandalf commented Jul 8, 2024

getusha left a comment

getusha Jul 9, 2024

allgandalf Jul 9, 2024

getusha Jul 9, 2024

allgandalf Jul 9, 2024

getusha Jul 9, 2024

allgandalf commented Jul 10, 2024

getusha commented Jul 10, 2024

allgandalf commented Jul 13, 2024

allgandalf commented Jul 16, 2024

chiragsalian left a comment

OSBotify commented Jul 16, 2024

OSBotify commented Jul 17, 2024

OSBotify commented Jul 17, 2024

OSBotify commented Jul 18, 2024

OSBotify commented Jul 19, 2024

	const displayName = `${userDetails?.firstName ?? ''}${userDetails?.lastName ? ` ${userDetails.lastName}` : ''}`;
	const displayName = userDetails?.displayName;

Update Workspace auto naming to include using First Name over the username of a public email #44109

Update Workspace auto naming to include using First Name over the username of a public email #44109

Conversation

allgandalf commented Jun 20, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jun 20, 2024

allgandalf commented Jun 20, 2024

getusha commented Jun 27, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

getusha commented Jun 27, 2024

allgandalf commented Jun 29, 2024

allgandalf commented Jun 29, 2024

allgandalf commented Jul 2, 2024

getusha commented Jul 3, 2024

allgandalf commented Jul 4, 2024

allgandalf commented Jul 8, 2024

getusha left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

allgandalf commented Jul 10, 2024

getusha commented Jul 10, 2024

allgandalf commented Jul 13, 2024

allgandalf commented Jul 16, 2024

chiragsalian left a comment

Choose a reason for hiding this comment

OSBotify commented Jul 16, 2024

OSBotify commented Jul 17, 2024

OSBotify commented Jul 17, 2024

OSBotify commented Jul 18, 2024

OSBotify commented Jul 19, 2024

allgandalf commented Jun 20, 2024 •

edited

Loading

getusha commented Jun 27, 2024 •

edited

Loading