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

Fix/28925: Anonymous user can edit profile #29248

Conversation

DylanDylann
Copy link
Contributor

@DylanDylann DylanDylann commented Oct 11, 2023

Details

Public room as anonymous user can able to edit profile

Fixed Issues

$ #28925
PROPOSAL: #28925 (comment)

Tests

  1. Go to a public room as an anonymous user like https://staging.new.expensify.com/r/207591744844000
  2. Click on the search icon.
  3. Close the login menu.
  4. Enter url in chrome /settings/profile, /settings/profile/display-name
  5. Verify that the login modal is displayed
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  1. Go to a public room as an anonymous user like https://staging.new.expensify.com/r/207591744844000
  2. Click on the search icon.
  3. Close the login menu.
  4. Enter url in chrome /settings/profile, /settings/profile/display-name
  5. Verify that the login modal is displayed
  • 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 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
    • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
    • 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 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 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

Android: Native

There is a problem when testing with mobile native platform: Go to the public room with an anonymous user encountered the bellow error: (Which existed in the latest staging as well)

Screenshot from 2023-10-11 16-47-07

Android: mWeb Chrome
Screencast.from.11-10-2023.09.21.00.webm
iOS: Native

There is a problem when testing with mobile native platform: Go to the public room with an anonymous user encountered the bellow error: (Which existed in the latest staging as well)

Screenshot from 2023-10-11 16-47-07

iOS: mWeb Safari
Safari-room-output.mp4
MacOS: Chrome / Safari
MacOS-room-output.mp4
MacOS: Desktop

Cannot go to the public room with an anonymous user on desktop

@DylanDylann
Copy link
Contributor Author

  1. There is a problem when testing with mobile native platform: Go to the public room with an anonymous user encountered the bellow error: (Which existed in the latest staging as well)

Screenshot from 2023-10-11 16-47-07

  1. Also I cannot go to the public room with an anonymous user on desktop.

So currently, I am missing the mobile native and desktop screenshots

@DylanDylann DylanDylann marked this pull request as ready for review October 11, 2023 09:52
@DylanDylann DylanDylann requested a review from a team as a code owner October 11, 2023 09:52
@melvin-bot melvin-bot bot requested review from burczu and removed request for a team October 11, 2023 09:52
@melvin-bot
Copy link

melvin-bot bot commented Oct 11, 2023

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

@DylanDylann
Copy link
Contributor Author

@burczu please help review this PR when you have a chance. Thanks

@burczu
Copy link
Contributor

burczu commented Oct 13, 2023

@DylanDylann In terms native and desktop, I think we can skip testing them here, so please check all the checkboxes and leave a suitable comments in screenshots/videos section of native environments.

@burczu
Copy link
Contributor

burczu commented Oct 13, 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: 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(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 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 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-10-26.at.10.41.05.mov
Mobile Web - Chrome
Mobile Web - Safari
Desktop
iOS
Android

@burczu
Copy link
Contributor

burczu commented Oct 13, 2023

@DylanDylann I've encountered strange behaviour while testing this PR. Please take a look at the video below:

Screen.Recording.2023-10-13.at.07.42.57.mov

I think this should be handled here too, because it may case a regression.

@DylanDylann
Copy link
Contributor Author

@DylanDylann I've encountered strange behaviour while testing this PR. Please take a look at the video below:

Screen.Recording.2023-10-13.at.07.42.57.mov
I think this should be handled here too, because it may case a regression.

Do you have any suggestions about the expected behavior?

@burczu
Copy link
Contributor

burczu commented Oct 13, 2023

@DylanDylann Two options: clicking back should do nothing or removing this back button.

@burczu
Copy link
Contributor

burczu commented Oct 13, 2023

@DylanDylann Actually - wait :) I think this back button should actually just close the sidebar. What do you think?

@DylanDylann
Copy link
Contributor Author

@burczu yeah. So i think we just need to close the side bar when clicking on back button

@DylanDylann
Copy link
Contributor Author

@burczu just updated the PR and here is the result:

Screencast.from.13-10-2023.13.40.40.webm

@DylanDylann
Copy link
Contributor Author

@burczu please help review this PR when you have a chance. Thanks

@burczu
Copy link
Contributor

burczu commented Oct 16, 2023

@DylanDylann Thanks for addressing the issue with back button. Unfortunately I've encountered the same issue (second sidebar shows up for a second) event when I try to open /settings/profile or /settings/profile/display-name...

Screen.Recording.2023-10-16.at.14.21.26.mov

@DylanDylann
Copy link
Contributor Author

DylanDylann commented Oct 16, 2023

@burczu I think it is an edge case because I can just handle the onStateChange event. Any suggestion for this case?

@DylanDylann
Copy link
Contributor Author

DylanDylann commented Oct 17, 2023

@burczu Friendly BUMP - Do you have any suggestion for this one or we will consider it as an edge case ?#29248 (comment)

@DylanDylann
Copy link
Contributor Author

@DylanDylann Thanks for addressing the issue with back button. Unfortunately I've encountered the same issue (second sidebar shows up for a second) event when I try to open /settings/profile or /settings/profile/display-name...

Screen.Recording.2023-10-16.at.14.21.26.mov

@stitesExpensify should we consider it as an edge case?

@burczu
Copy link
Contributor

burczu commented Oct 18, 2023

@DylanDylann I don't think we should consider it as an edge case - there is a glitch and I bet it will be raised as a bug in the future, so I think we should try to find a solution for this. Sorry for the delayed answer, I had a lot other thinks to work on. I'll think about the possible solution here later today.

@burczu
Copy link
Contributor

burczu commented Oct 25, 2023

Hey @DylanDylann I've checked the new solution and I think it's the step in a good direction - I still can see the /settings/profile modal but for a really short amount of time which is better than before. I think the problem here is with this navigation - it looks like it starts before the redirection to the login modal page is made. Maybe we could somehow postpone it a little bit?

I tend to think I could approve it and see what the Expensify engineer thinks about it.

@DylanDylann DylanDylann force-pushed the fix/28925-public-room-anonymous-user-able-to-edit branch 2 times, most recently from cd4148c to a14e7ff Compare October 25, 2023 11:34
@DylanDylann
Copy link
Contributor Author

@burczu I`ve fixed the conflict but the latest change in the main branch makes the app crash so I cannot test. Will ping you when it is fixed #30228 (comment)

@DylanDylann
Copy link
Contributor Author

DylanDylann commented Oct 26, 2023

@burczu the main is fixed, just tested and it works well. Here is the result:

Screencast.from.26-10-2023.10.11.23.webm

Copy link
Contributor

@burczu burczu left a comment

Choose a reason for hiding this comment

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

Code LGTM

@burczu
Copy link
Contributor

burczu commented Oct 26, 2023

@stitesExpensify I've approved this PR, but there is one thing that concerns me. Please see the below video:

Screen.Recording.2023-10-26.at.10.41.05.mov

When we type /settings/profile or /settings/profile/display-name the page is correctly redirected to the sign in sidebar page, bot for milliseconds we see the settings page, until the sliding animation of the sign in sidebar ends - I'm not sure if this acceptable, so please decide about it.

@DylanDylann
Copy link
Contributor Author

@stitesExpensify please help review this PR when you have a chance

@DylanDylann
Copy link
Contributor Author

@stitesExpensify friendly bump in case you miss this one

@stitesExpensify stitesExpensify merged commit 5ae80bd into Expensify:main Nov 2, 2023
14 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Nov 2, 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 Nov 6, 2023

🚀 Deployed to staging by https://github.com/stitesExpensify in version: 1.3.96-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Nov 9, 2023

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.96-15 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.97-7 🚀

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

@@ -24,7 +24,7 @@ function SignInModal() {
shouldEnableMaxHeight
testID={SignInModal.displayName}
>
<HeaderWithBackButton />
<HeaderWithBackButton onBackButtonPress={Navigation.dismissModal} />
Copy link
Contributor

Choose a reason for hiding this comment

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

This caused inconsistency between browser back button and modal back button. (Coming from #33417)

* @param {string} route
*/

const canAccessRouteByAnonymousUser = (route: string) => {
Copy link
Contributor

Choose a reason for hiding this comment

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

canAnonymousUserAccessRoute would sound better

if (route.startsWith('/')) {
routeRemovedReportId = routeRemovedReportId.slice(1);
}
const routesCanAccessByAnonymousUser = [ROUTES.SIGN_IN_MODAL, ROUTES.REPORT_WITH_ID_DETAILS.route, ROUTES.REPORT_WITH_ID_DETAILS_SHARE_CODE.route];
Copy link
Contributor

Choose a reason for hiding this comment

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

routesAccessibleByAnonymousUser would sound better

Copy link
Contributor

Choose a reason for hiding this comment

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

Fixed here: #37952

@@ -871,6 +871,33 @@ function waitForUserSignIn(): Promise<boolean> {
});
}

/**
* check if the route can be accessed by anonymous user
Copy link
Contributor

Choose a reason for hiding this comment

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

Updating this comment (or adding a comment in the function) to say why an anonymous user can only access different routes would be helpful for future programmers like me who don't have context on why this exists (in general, comments should be used to explain why the code is like that, not what the code is obviously doing)

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