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

Add new Profile page #20144

Merged
merged 26 commits into from
Jun 8, 2023
Merged

Add new Profile page #20144

merged 26 commits into from
Jun 8, 2023

Conversation

puneetlath
Copy link
Contributor

@puneetlath puneetlath commented Jun 4, 2023

Details

This PR adds a new ProfilePage which is based on accountID to replace the current DetailsPage. However, we aren't removing the DetailsPage yet since it is still needed for mentions.

Fixed Issues

#20070

Tests

  1. Click on someone's avatar in the chat
  2. Verify that you are taken to their profile (you will know because it will say "profile" at the top instead of "details"
  3. Make sure it shows the correct avatar/display name/etc
  4. Go directly to the profile if someone you don't know using their accountID (e.g. https://new.expensify.com/a/64708047)
  5. You should see a loading spinner and then eventually the profile will populate
  6. Make sure the only info that you see is avatar and display name (no email or other contact info) (the display name will show as "hidden" if that user doesn't have one set)
  7. Make sure that everywhere in the app where you click on something to see a profile, it works as expected
  • Verify that no errors appear in the JS console

Offline tests

The profile should be accessible when online of someone you know. Going to the profile via URL of someone you don't know while offline should just show a loading spinner.

QA Steps

Same as test steps.

  • 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 / Chrome
    • iOS / native
    • iOS / 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 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 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 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(themeColors.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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web image image
Mobile Web - Chrome Screenshot 2023-06-05 at 2 38 54 PM Screenshot 2023-06-05 at 2 38 38 PM
Mobile Web - Safari Screenshot 2023-06-05 at 2 39 41 PM Screenshot 2023-06-05 at 2 39 28 PM
Desktop image
iOS Screenshot 2023-06-05 at 2 20 18 PM
Android Screenshot 2023-06-05 at 2 32 08 PM

@puneetlath puneetlath requested a review from a team as a code owner June 4, 2023 17:16
@puneetlath puneetlath self-assigned this Jun 4, 2023
@melvin-bot melvin-bot bot requested review from arosiclair and removed request for a team June 4, 2023 17:17
@melvin-bot
Copy link

melvin-bot bot commented Jun 4, 2023

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

@puneetlath puneetlath removed the request for review from arosiclair June 4, 2023 17:20
@puneetlath puneetlath marked this pull request as draft June 4, 2023 17:21
@puneetlath puneetlath marked this pull request as ready for review June 5, 2023 17:35
@puneetlath puneetlath requested review from Beamanator, mananjadhav and allroundexperts and removed request for mananjadhav June 5, 2023 17:35
Copy link
Contributor

@Beamanator Beamanator left a comment

Choose a reason for hiding this comment

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

A few small requested changes, overall looking good! i haven't tested yet though, waiting for C+ for that :D

src/libs/actions/PersonalDetails.js Outdated Show resolved Hide resolved
src/pages/ProfilePage.js Show resolved Hide resolved
src/pages/ProfilePage.js Outdated Show resolved Hide resolved
src/pages/ProfilePage.js Outdated Show resolved Hide resolved
src/pages/ProfilePage.js Outdated Show resolved Hide resolved
src/pages/ProfilePage.js Outdated Show resolved Hide resolved
@allroundexperts
Copy link
Contributor

@puneetlath If the request fails (like its failing right now because of the missing endpoint), I see an endless spinner. Should we show some sort of error message?
Screenshot 2023-06-06 at 12 12 54 AM

@allroundexperts
Copy link
Contributor

allroundexperts commented Jun 5, 2023

Opening someone's profile from group members page (eg admin) still opens previous profile version. Same for thread participant page and workspace participant page.

Screenshot 2023-06-06 at 12 17 51 AM

@allroundexperts
Copy link
Contributor

allroundexperts commented Jun 5, 2023

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 / Chrome
    • iOS / native
    • iOS / 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(themeColors.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 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

Web
Screen.Recording.2023-06-08.at.4.22.44.PM.mov
Mobile Web - Chrome
Screen.Recording.2023-06-08.at.4.27.50.PM.mov
Mobile Web - Safari
Screen.Recording.2023-06-08.at.4.28.28.PM.mov
Desktop
Screen.Recording.2023-06-08.at.4.25.48.PM.mov
iOS
Screen.Recording.2023-06-08.at.4.32.51.PM.mov
Android
Screen.Recording.2023-06-08.at.4.31.41.PM.mov

Copy link
Contributor

@Beamanator Beamanator left a comment

Choose a reason for hiding this comment

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

LGTM

@puneetlath
Copy link
Contributor Author

@allroundexperts please test again when you get a chance. If you don't find any issues other than the group chat thing, then I think we're ok. Thanks!

@allroundexperts
Copy link
Contributor

@allroundexperts please test again when you get a chance. If you don't find any issues other than the group chat thing, then I think we're ok. Thanks!

On it now!

</CommunicationsLink>
</View>
) : null}
{pronouns ? (
Copy link
Contributor

Choose a reason for hiding this comment

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

NAB: {Boolean(pronouns) &&

Copy link
Contributor Author

Choose a reason for hiding this comment

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

ESLint is saying it's redundant for this one.

Copy link
Contributor

@allroundexperts allroundexperts left a comment

Choose a reason for hiding this comment

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

Looks good!

@allroundexperts
Copy link
Contributor

allroundexperts commented Jun 8, 2023

Following warnings are generated which are un-related to this PR. The first one is already posted in Slack here. I wasn't able to find second one posted anywhere so I've posted about it in Slack here.

Screenshot 2023-06-08 at 4 32 31 PM Screenshot 2023-06-08 at 4 33 34 PM

@puneetlath
Copy link
Contributor Author

Thanks for filing those bugs @allroundexperts!

@Beamanator Beamanator merged commit fd0c6a9 into main Jun 8, 2023
@Beamanator Beamanator deleted the profile-by-accountID branch June 8, 2023 13:50
@Beamanator
Copy link
Contributor

Nice work team! 💪

@OSBotify
Copy link
Contributor

OSBotify commented Jun 8, 2023

✋ 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
Copy link
Contributor

OSBotify commented Jun 8, 2023

🚀 Deployed to staging by https://github.com/Beamanator in version: 1.3.26-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/AndrewGable in version: 1.3.26-4 🚀

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

@@ -97,7 +98,7 @@ const ReportWelcomeText = (props) => {
<Tooltip text={tooltip}>
<Text
style={[styles.textStrong]}
onPress={() => Navigation.navigate(ROUTES.getDetailsRoute(participants[index]))}
onPress={() => Navigation.navigate(ROUTES.getProfileRoute(participantAccountIDs[index]))}
Copy link
Contributor

Choose a reason for hiding this comment

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

This was overlooked. participantAccountIDs order was different from participants and it caused regression - Web - New Group - Wrong user details page opens on clicking at display names

Copy link
Contributor

Choose a reason for hiding this comment

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

#20583 (comment) for more details about the root cause.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oh wow, that makes total sense. Should've considered that. Thanks for the feedback!

@sobitneupane
Copy link
Contributor

While adding NewProfilePage, this issue was overlooked. When user opens a profile page with some undefined accountID (like letters), profile page loads forever.

@puneetlath
Copy link
Contributor Author

Good catch. Thanks for linking!

@@ -114,10 +114,12 @@ export default {
SET_PASSWORD_WITH_VALIDATE_CODE: 'setpassword/:accountID/:validateCode',
DETAILS: 'details',
getDetailsRoute: (login) => `details?login=${encodeURIComponent(login)}`,
PROFILE: 'a/:accountID',
Copy link
Contributor

Choose a reason for hiding this comment

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

👋 Just a heads-up that this has caused a regression in #21969
Deep linking wasn't working for the new PROFILE route.

When adding a new route we should also add it to App/well-known
/apple-app-site-association
for iOS

{ "/": "/a/*", "comment": "Profile Page" }

And to AndroidManifest.xml for Android

<data android:scheme="https" android:host="new.expensify.com" android:pathPrefix="/a"/> 

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oh wow. I had no idea. Can we make that obvious somehow? Like with a checklist item or lint rule or something.

Copy link
Contributor

Choose a reason for hiding this comment

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

@puneetlath, I proposed to add a checklist item in https://expensify.slack.com/archives/C049HHMV9SM/p1690395182200269
Looks like we should add it, I'll do that tomorrow (not sure what the process is just yet, will find it)

const phoneNumber = getPhoneNumber(details);
const phoneOrEmail = isSMSLogin ? getPhoneNumber(details) : login;

const isCurrentUser = _.keys(props.loginList).includes(login);
Copy link
Contributor

@s77rt s77rt Oct 16, 2023

Choose a reason for hiding this comment

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

We should have used the account ID to check if is current user because:

  • Users are now identified by account ids
  • The account ID is available from the route where the login is from onyx. Using data from onyx results in a delay where the first render will always evaluate isCurrentUser as false and causing this bug

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah good catch, thanks for letting me know!

const optimisticData = [
{
onyxMethod: Onyx.METHOD.MERGE,
key: ONYXKEYS.PERSONAL_DETAILS_LIST,
Copy link
Contributor

Choose a reason for hiding this comment

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

Adding isLoading to PERSONAL_DETAILS_LIST changes personalDetailsList. Lots of components subscribe to this and rerender causing a performance issue. #37986

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants