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

The app should take the user back to the profile page when the user clicks the back button in the web browser #28999

Merged
merged 43 commits into from
Jan 23, 2024

Conversation

dukenv0307
Copy link
Contributor

@dukenv0307 dukenv0307 commented Oct 6, 2023

Details

When viewing the profile photo, the app should take the user back to the profile page when the user clicks the back button in the web browser

Fixed Issues

$ #27856
PROPOSAL: #27856 (comment)

Tests

  • Profile avatar page
  1. Go to settings > profile
  2. Click on avatar and add a photo if you don't have any
  3. Click on the avatar again
  4. Click on View photo
  5. Click on the system/browser back button
  6. Verify that the app takes the user back to the setting profile page
  • Report avatar page
  1. Open the workspace chat
  2. Click on header to open detail page
  3. Click on the avatar of the workspace
  4. Click on the system/browser back button
  5. Verify that the app takes the user back to the detail page
  • Workspace avatar page
  1. Go to settings> workspace > select a workspace > setting
  2. Add a custom avatar for workspace
  3. Click on the avatar > View photo
  4. Click on the system/browser back button
  5. Verify that the app takes the user back to the setting workspace page
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  • Profile avatar page
  1. Go to settings > profile
  2. Click on avatar and add a photo if you don't have any
  3. Click on the avatar again
  4. Click on View photo
  5. Click on the system/browser back button
  6. Verify that the app takes the user back to the setting profile page
  • Report avatar page
  1. Open the workspace chat
  2. Click on the header to open detail page
  3. Click on the avatar of the workspace
  4. Click on the system/browser back button
  5. Verify that the app takes the user back to the detail page
  • Workspace avatar page
  1. Go to settings> workspace > select a workspace > setting
  2. Add a custom avatar for workspace
  3. Click on the avatar > View photo
  4. Click on the system/browser back button
  5. Verify that the app takes the user back to the setting workspace page
  • 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: 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 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 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.

Screenshots/Videos

Web
web.mov
Mobile Web - Chrome
chrome.mov
Mobile Web - Safari
safari.mov
Desktop
desktop.mov
iOS
ios.mov
Android
android.mov

@dukenv0307 dukenv0307 changed the title Fix/27856 The app should take the user back to the profile page when the user clicks the back button in the web browser Oct 8, 2023
@dukenv0307 dukenv0307 marked this pull request as ready for review October 8, 2023 16:14
@dukenv0307 dukenv0307 requested a review from a team as a code owner October 8, 2023 16:14
@melvin-bot melvin-bot bot removed the request for review from a team October 8, 2023 16:15
@melvin-bot
Copy link

melvin-bot bot commented Oct 8, 2023

@aimane-chnaif 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]

Copy link
Contributor

@aimane-chnaif aimane-chnaif left a comment

Choose a reason for hiding this comment

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

Also apply to other user profile avatars, workspace avatars

Screen.Recording.2023-10-08.at.5.19.47.PM.mov

src/ROUTES.ts Outdated Show resolved Hide resolved
if (typeof props.onModalClose === 'function') {
props.onModalClose();
}
}, [props]);
Copy link
Contributor

Choose a reason for hiding this comment

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

Only onModalClose prop is required for dependency, isn't it?

Copy link
Contributor

Choose a reason for hiding this comment

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

@dukenv0307 can you answer here?

Copy link
Contributor

Choose a reason for hiding this comment

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

React Hook useCallback has a missing dependency: 'props'. Either include it or remove the dependency array. However, 'props' will change when *any* prop changes, so the preferred fix is to destructure the 'props' object outside of the useCallback call and refer to those specific props inside useCallback

We can destructure props as alternative

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes you're right.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@aimane-chnaif Updated the dependency.

@dukenv0307
Copy link
Contributor Author

@aimane-chnaif If we also apply change to these pages as mentioned in this comment, we have two options

  1. Create 2 additional routes ( 3 in total ) to handle each page. This could be a problem since the code is duplicated and if any new image is introduced, we have to create another new route for it

  2. Create a unique modal route for all image modals. This could apply to any new image modal coming in the future
    Please let me know which options that you prefer

@aimane-chnaif
Copy link
Contributor

@aimane-chnaif If we also apply change to these pages as mentioned in this comment, we have two options

  1. Create 2 additional routes ( 3 in total ) to handle each page. This could be a problem since the code is duplicated and if any new image is introduced, we have to create another new route for it
  2. Create a unique modal route for all image modals. This could apply to any new image modal coming in the future
    Please let me know which options that you prefer

I am fine either option. 2nd one seems better.
@johnmlee101 thoughts?

@johnmlee101
Copy link
Contributor

Create a unique modal route for all image modals. This could apply to any new image modal coming in the future
Please let me know which options that you prefer

Can you elaborate on what these new routes would look like?

@dukenv0307
Copy link
Contributor Author

@johnmlee101

  1. Create a new route for the image modal like this:
MODAL_PHOTO: {
        route: 'modal/photo',
        getRoute: (source: string) => `modal/photo?source=${source}`,
    },

Then this route can be applied to all image modals including profile avatar, other users' profile avatar, workspace avatar along with any upcoming images

@aimane-chnaif
Copy link
Contributor

I think it's fine to have separate routes. If any new type of preview is introduced in the future, we can add new route always.
@johnmlee101 what do you think?

@aimane-chnaif
Copy link
Contributor

aimane-chnaif commented Oct 12, 2023

cc: @Expensify/design
context: #28999 (comment)

  1. profile avatar (/profile/:accountID/avatar), workspace avatar (/workspace/:policyID/avatar), chat attachment (/r/:reportID/attachment?source=xxx)
  2. /modal/photo?source=xxx

@johnmlee101
Copy link
Contributor

Yeah separate routes seems fine for now 👍

@aimane-chnaif
Copy link
Contributor

Yeah separate routes seems fine for now 👍

Thanks

@dukenv0307 is your code in good shape and ready for review?

@aimane-chnaif
Copy link
Contributor

@dukenv0307 my feedback is not addressed yet. Let me know when ready for review

@aimane-chnaif
Copy link
Contributor

@dukenv0307 bump ^. Also fix conflict. I see you're active on other issues

@dukenv0307
Copy link
Contributor Author

@aimane-chnaif The PR is ready for review.

@aimane-chnaif
Copy link
Contributor

Unverified commits

Screenshot 2023-10-18 at 7 34 40 AM

@aimane-chnaif
Copy link
Contributor

Too slow to move forward step by step on this PR.
If you wanna focus on other issues, you can go ahead and we can reassign this one to someone else.

@dukenv0307
Copy link
Contributor Author

@aimane-chnaif I'm available now, you can review the PR and I will update this.

@aimane-chnaif
Copy link
Contributor

When open workspace avatar page from another account that has no access to that workspace:

Screenshot 2023-10-18 at 9 44 52 AM

In this case, we should display not found page

Screenshot 2023-10-18 at 9 45 17 AM

@dukenv0307
Copy link
Contributor Author

@aimane-chnaif We should display not found page in the attachment modal or return not found page on WorkspaceAttachment?

@aimane-chnaif
Copy link
Contributor

@aimane-chnaif We should display not found page in the attachment modal or return not found page on WorkspaceAttachment?

What's the difference?

@aimane-chnaif
Copy link
Contributor

This should be display name

Screenshot 2023-10-18 at 9 53 04 AM

src/ROUTES.ts Outdated
Comment on lines 120 to 131
PROFILE_AVATAR: {
route: 'profile/:accountID/avatar',
getRoute: (accountID: string) => `profile/${accountID}/avatar`,
},

WORKSPACE_AVATAR: {
route: 'workspace/:policyID/avatar',
getRoute: (policyID: string) => `workspace/${policyID}/avatar`,
},
Copy link
Contributor

@aimane-chnaif aimane-chnaif Oct 18, 2023

Choose a reason for hiding this comment

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

I am concerned about these routes.
Everyone in the room should be able to see avatar no matter admin or member.
policyID should be visible to only admins. We should use reportID.
Let's update the routes like this:

  • workspace: r/6449050474229627/avatar or r/6449050474229627/details/avatar
  • user: a/13040813/avatar

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@aimane-chnaif So what URL we will display when we click on view photo in WorkspaceSettingPage?

Copy link
Contributor

Choose a reason for hiding this comment

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

@aimane-chnaif So what URL we will display when we click on view photo in WorkspaceSettingPage?

I think we should open this back to discussion. Can you raise on slack?

http://localhost:8082/r/7392845470252151 - this is example public room where policy doesn't exist in Onyx and thus shows wrong avatar

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@aimane-chnaif Do you think we should add a new route for report avatar?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

So what URL we will display when we click on view photo in WorkspaceSettingPage?

And /workspace/:policyID/avatar this will be the URL for this case.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@dukenv0307
Copy link
Contributor Author

This should be display name
When open workspace avatar page from another account that has no access to that workspace:

Updated these case

@aimane-chnaif
Copy link
Contributor

Let's hold this until we get confirmation about route definitions on slack

@dukenv0307
Copy link
Contributor Author

@aimane-chnaif Update the PR after we confirmed in Slack.

@dukenv0307
Copy link
Contributor Author

@aimane-chnaif Updated.

src/components/AttachmentModal.js Outdated Show resolved Hide resolved
@@ -482,7 +519,6 @@ function AttachmentModal(props) {
isWorkspaceAvatar={props.isWorkspaceAvatar}
fallbackSource={props.fallbackSource}
isUsedInAttachmentModal
transactionID={props.transaction.transactionID}
Copy link
Contributor

Choose a reason for hiding this comment

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

Why was this removed?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That is my mistake, updated.

@aimane-chnaif
Copy link
Contributor

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
android.mov
Android: mWeb Chrome
mchrome.mov
iOS: Native
ios.mov
iOS: mWeb Safari
msafari.mov
MacOS: Chrome / Safari
web.mov
web-back-button.mov
MacOS: Desktop
desktop.mov

@aimane-chnaif
Copy link
Contributor

@dukenv0307 please add more test cases in QA Steps. All 3 pages (profile, workspace, report)
And pull main again to see if fixes Reassure Performance Tests

@dukenv0307
Copy link
Contributor Author

@aimane-chnaif Updated test step and merged main. Wait for perf-test.

@aimane-chnaif
Copy link
Contributor

Still failing but it's known. Not caused by this PR so not blocker

Screenshot 2024-01-23 at 6 35 00 AM

@melvin-bot melvin-bot bot requested a review from johnmlee101 January 23, 2024 05:36
Copy link
Contributor

@johnmlee101 johnmlee101 left a comment

Choose a reason for hiding this comment

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

Okay tested it out a bit, it seems good 👍

@johnmlee101 johnmlee101 merged commit b31ea3a into Expensify:main Jan 23, 2024
16 checks passed
@OSBotify
Copy link
Contributor

✋ 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

🚀 Deployed to production by https://github.com/thienlnam in version: 1.4.31-7 🚀

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

return (
<AttachmentModal
// @ts-expect-error TODO: Remove this once AttachmentModal (https://github.com/Expensify/App/issues/25130) is migrated to TypeScript.
headerTitle={personalDetail?.displayName ?? ''}
Copy link
Contributor

Choose a reason for hiding this comment

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

✋ Coming from #35514

The header title here will show empty on a hidden user. So we should use PersonalDetailsUtils.getDisplayNameOrDefault to get the correct display name for such a condition.

function ReportAvatar({report = {} as Report, policies, isLoadingApp = true}: ReportAvatarProps) {
const policy = policies?.[`${ONYXKEYS.COLLECTION.POLICY}${report?.policyID ?? '0'}`];
const isArchivedRoom = ReportUtils.isArchivedRoom(report);
const policyName = isArchivedRoom ? report?.oldPolicyName : policy?.name;
Copy link
Contributor

Choose a reason for hiding this comment

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

We should have used ReportUtils.getPolicyName(report, false, policy) to get the policy name. This caused #35262

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.

7 participants