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

Handle blocked copilot and Expensify card flows gracefully #52103

Open
wants to merge 32 commits into
base: main
Choose a base branch
from

Conversation

ChavdaSachin
Copy link
Contributor

@ChavdaSachin ChavdaSachin commented Nov 6, 2024

Explanation of Change

This PR aims to restrict copilots from performing certain actions on behalf of the owner.
As A Part of Solution Primarily Show DelegetNoAccessModal when copilot tries to perform any restricted action
And restrict delegate from accessing any restricted page using deeplink by wrapping those pages with DelegateNoAccessWrapper.

List of Actions Restricted for Copilot on Behalf of Owner,

  • Modifying Private Profile Credentials(Legal Name, DOB, Phone Number, Address).
  • Add, Delete or Modify Bank Account.
  • Enable Wallet.
  • Enable/Disable 2FA.
  • Close Account.
  • Add, Remove or Change Access Level of other Copilots.
  • Modify Subscription Plans/ Add Payment Card for Subscription.
  • Switch To Expensify Classic.

Fixed Issues

$ #50796
PROPOSAL: NA

Tests

Same As QA.

  • Verify that no errors appear in the JS console

Offline tests

Same As QA.

QA Steps

Important

All of the following tests should be performed as a copilot.
For Steps To Add Copilot Visit - https://help.expensify.com/articles/expensify-classic/copilots-and-delegates/Assign-or-remove-a-Copilot

Test 1.

  1. Go to Settings > Profile.
  2. Press Legal Name.
  3. Verify "Not So Fast..." Modal pops up when trying to save.
  4. Perform Step 2-3 for Date of Birth, Phone Number, Address.

Test 2.

  1. Go to Settings > Wallet.
  2. Try to add/remove Bank Account.
  3. Verify "Not So Fast..." Modal Pops Up When Trying to add/remove Bank Account.

Test 3.(For Accounts With Wallet Not Enabled)

  1. Go to Settings > Wallet.
  2. Click Enable Wallet.
  3. Verify "Not So Fast..." Modal Pops Up.

Test 4.

  1. Go to Settings > Security.
  2. Click Two Factor Authentication/Close Account.
  3. Verify "Not So Fast..." Modal Pops Up.

Test 5.

  1. Go to Settings > Security.
  2. Open ThreeDot Menu for Any Copilot.
  3. Click Change Access Level/Remove Copilot.
  4. Verify "Not So Fast..." Modal Pops Up.

Test 6.

  1. Go to Settings > Subscription.
  2. Click Add Payment Card.
  3. Verify "Not So Fast..." Modal Pops Up.
  4. Repeat step 2-3 for Request Early Cancellation, Change Plan(Annual<->Pay Per Use),Subscription size option(Only visible if current plan is annual), Toggle Auto Renew, Toggle Auto-Increase annual seats.

Test 7.

  1. Go to Settings.
  2. Click Switch to Expensify Classic.
  3. Verify "Not So Fast..." Modal Pops Up.

Test 8.

  1. Visit Deeplink https://dev.new.expensify.com:8082/settings/profile/contact-methods/new.(Note - change domain as per the need ie. staging.newExpensify.com or new.expensify.com from dev.new.expensify.com:8082).
  2. Verify No Access Page is Visible.
  3. Repeat step 1-2 for following Deeplinks.

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 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 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 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 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.

Screenshots/Videos

Android: Native

Test 1-7

Screen.Recording.2024-11-23.at.5.14.42.AM.mov

Test 8

Screen.Recording.2024-11-23.at.5.13.20.AM.mov
Android: mWeb Chrome

Test 1-7

Screen.Recording.2024-11-23.at.6.08.18.AM.mov

Test 8

Screen.Recording.2024-11-23.at.6.04.51.AM.mov
iOS: Native

Test 1-7

Screen.Recording.2024-11-23.at.3.43.54.AM.mov

Test 8

Screen.Recording.2024-11-23.at.4.34.17.AM.mov
iOS: mWeb Safari

Test 1-7

Screen.Recording.2024-11-23.at.3.02.24.AM.mov

Test 8

Screen.Recording.234.mov
MacOS: Chrome / Safari

Test 1-7

Screen.Recording.2024-11-23.at.2.44.44.AM.mov

Test 8

Screen.Recording.123.mov
MacOS: Desktop

Test 1-7

Screen.Recording.2024-11-23.at.4.47.01.AM.mov

Test 8

Screen.Recording.2024-11-23.at.4.44.54.AM.mov

Copy link

melvin-bot bot commented Nov 6, 2024

Hey! I see that you made changes to our Form component. Make sure to update the docs in FORMS.md accordingly. Cheers!

@ChavdaSachin
Copy link
Contributor Author

ChavdaSachin commented Nov 6, 2024

@Julesssss draft is up.
Working on DelegateNoAccessWrapper to accept PageNotFound props, and subscription page.

Quick question -
On security page in delegates section, both menu items are restricted actions, should we hide three dot menu there?
Screenshot 2024-11-06 at 5 18 39 PM

Same question for payment methods list on wallet page.
Screenshot 2024-11-06 at 5 22 34 PM

@ChavdaSachin
Copy link
Contributor Author

One more important note here,

For privateProfileOptions fields (legal name,legal address......) following two options came to my mind.

  1. Show noDelegateAccessModal as soon as delegate clicks on option from profile page.
  2. Let delegate open RHP edit page for the option but show noDelegateAccessModal as soon as delegate tries to submit.

IMO option 2 aligns more with rest of the app.

Now again for option 2 there was an important decision about validation.

  • I have decided to skip validation check for the actions where delegate would ultimately see noDelegateAccessModal when trying to submit.
  • Or delegate might take time to clear all validations and at the end would not be able to make any changes, that is kind of frustrating for the user.

Thoughts?

…ocked-copilot-and-Expensify-card-flows-gracefully
Copy link
Contributor

@Julesssss Julesssss left a comment

Choose a reason for hiding this comment

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

We have design approval now, thanks for sharing the questions!

@ChavdaSachin
Copy link
Contributor Author

ChavdaSachin commented Nov 14, 2024

One more task for design team,
When a delegate use deeplink to access the page which is restricted, what message should we display?
I suggest the message could be "As a delegate you don't have access to this page." with title "Hmm... it's not here"....
Screenshot 2024-11-14 at 3 42 29 PM

Sounds good?

@shawnborton
Copy link
Contributor

I think something like that would work, but I could also see just using the same exact "Not found" page we use elsewhere in terms of the exact copy and text. cc @Expensify/design

@ChavdaSachin
Copy link
Contributor Author

Currently we display either of "Oops, this page cannot be found" or "You don't have access to this chat" for not found page subtitle.

@shawnborton
Copy link
Contributor

Got it, so maybe something like:

Title: You don't have access to this
Body: As a delegate, you can not access this page.

Or something like that. cc @jamesdeanexpensify for a quick looksie.

@ChavdaSachin
Copy link
Contributor Author

One more input request,
Which of the following pages should contain back button for page not found view?

  1. Desktop - Full screen page not found view.
  2. Desktop - RHP page not found.
  3. Mobile - page not found view.

@shawnborton
Copy link
Contributor

Hmm I would think all of the, right? How do the current "not found" pages work?

@ChavdaSachin ChavdaSachin mentioned this pull request Nov 21, 2024
49 tasks
@ChavdaSachin
Copy link
Contributor Author

#52103 (comment)

  • I have decided to skip validation check for the actions where delegate would ultimately see noDelegateAccessModal when trying to submit.

Please keep this important detail in mind while reviewing.

@ChavdaSachin ChavdaSachin marked this pull request as ready for review November 23, 2024 01:19
@ChavdaSachin ChavdaSachin requested a review from a team as a code owner November 23, 2024 01:19
@melvin-bot melvin-bot bot requested review from c3024 and dubielzyk-expensify and removed request for a team November 23, 2024 01:19
Copy link

melvin-bot bot commented Nov 23, 2024

@dubielzyk-expensify @c3024 One of you needs to 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]

@ChavdaSachin
Copy link
Contributor Author

@Julesssss manually tagging you here, coz Malvin again tagged Jon here.

Copy link
Contributor

@c3024 c3024 left a comment

Choose a reason for hiding this comment

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

Great job. 🙇

I will test and see if I find anything.

Couple of comments.

onSubmit={handleValidateMagicCode}
submitButtonText={translate('common.add')}
style={[styles.flexGrow1, styles.mh5]}
<DelegateNoAccessWrapper accessDeniedVariants={[CONST.DELEGATE.DENIED_ACCESS_VARIANTS.DELEGATE]}>
Copy link
Contributor

Choose a reason for hiding this comment

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

DelegateNoAccessWrapper is wrapped within ScreenWrapper everywhere else except here. Any reason for this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It is a mistake, It should be inside ScreenWrapper. Fixing...

@c3024
Copy link
Contributor

c3024 commented Nov 23, 2024

@ChavdaSachin, you raised this, but I somehow missed it—sorry!

The first option seems better to me.

Currently, with the changes in the PR, the delegate goes to the legal name (or date of birth or address) page, fills out the fields, clicks on Submit, and then discovers they cannot edit them. Furthermore, they need to dismiss the “no access” modal and then the RHP to navigate to the profile details page.

Screen.Recording.2024-11-23.at.12.33.37.PM.mov

So, I think showing the “no access” modal directly when the option is clicked and displaying the “not found” page when deep-linked to these pages, like you did for other pages, is better.

cc: @Expensify/design

@ChavdaSachin
Copy link
Contributor Author

@c3024 I thought option 2 was more appropriate coz that is the exact same flow we implemented for add new contact method in This PR, based on This Comment from design team.

Currently, with the changes in the PR, the delegate goes to the legal name (or date of birth or address) page, fills out the fields, clicks on Submit, and then discovers they cannot edit them. Furthermore, they need to dismiss the “no access” modal and then the RHP to navigate to the profile details page.

Regarding this hideous flow you mentioned, We could dismiss RHP as soon as user close "Not So Fast..." Modal.

Screen.Recording.2024-11-23.at.1.38.18.PM.mov
Screen.Recording.2024-11-23.at.1.59.42.PM.mov

@dannymcclain
Copy link
Contributor

Personally I think it would be better to pop open the not so fast modal as soon as the user clicked on the option row. I think it's weird to let them edit the value and then only show the modal when they try to save.

I also think that's inline with what we did for contact method, because in that flow we're not letting the user edit anything—we're popping the modal as soon as they click something that would allow them to edit.

So, I think showing the “no access” modal directly when the option is clicked and displaying the “not found” page when deep-linked to these pages, like you did for other pages, is better.

Basically I agree with the above comment ☝️

@ChavdaSachin
Copy link
Contributor Author

Hey @c3024 I am facing a weird problem on IOS - Native and Android - Native after new changes.
I tried multiple ways, but nothing seem to work.

Problem Description:
"Not So Fast.." Modal pops up when clicking any of the private credentials for the first time, but as soon as Modal is closed.
All the items rather than 'Share QR' buttons goes unresponsive. While add contact page seems working fine.

See the videos....

Profile Page ❌
Screen.Recording.2024-11-26.at.1.25.57.AM.mov
Add Contact Page ✅
Screen.Recording.2024-11-26.at.1.27.57.AM.mov

@c3024
Copy link
Contributor

c3024 commented Nov 27, 2024

@ChavdaSachin

We have a logic for not opening multiple items when pressed on quickly one after another on native apps particularly Android. Since, there was no navigation happening here, it seems that the isExecuting is not reset so the later press events are not working. We can disable the single execution when the user is acting as a delegate.

Here

- <>
+ <MenuItemGroup shouldUseSingleExecution={!isActingAsDelegate}>

@ChavdaSachin
Copy link
Contributor Author

Great, this might work

@Julesssss
Copy link
Contributor

This is looking good. Seems like we just have some lint issues remaining.

@ChavdaSachin
Copy link
Contributor Author

a small change and PR will be ready for review

@ChavdaSachin
Copy link
Contributor Author

ChavdaSachin commented Nov 28, 2024

Ready for review
cc. @c3024

@c3024
Copy link
Contributor

c3024 commented Nov 29, 2024

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 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.ts 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.
  • For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
  • 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
notAndroid.mp4
Android: mWeb Chrome
notiOSmWeb-compressed.mp4
iOS: Native
notiOS.mp4
iOS: mWeb Safari
notiOSmWeb-compressed.mp4
MacOS: Chrome / Safari
notChrome1.mp4
notChrome2.mp4
notChrome3.mp4
MacOS: Desktop
notDesktop.mp4

Copy link
Contributor

@c3024 c3024 left a comment

Choose a reason for hiding this comment

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

LGTM!

@melvin-bot melvin-bot bot requested a review from Julesssss November 29, 2024 10:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants