feat: Add an "Invite" button to the workspace profile page
Explanation of Change
- Adds an invite button beside
sharebutton on workspace profile page.
Fixed Issues
$ https://github.com/Expensify/App/issues/53716 PROPOSAL: https://github.com/Expensify/App/issues/53716#issuecomment-2523951365
Tests
- Go settings > workspaces > select a workspace where you are admin
- On profile page verify there is a invite button beside
sharebutton - Click on the invite button > verify you are taken to invite members page and members page is loaded in the background
- [x] Verify that no errors appear in the JS console
Offline tests
- Go settings > workspaces > select a workspace where you are admin
- On profile page verify there is a invite button beside
sharebutton - Click on the invite button > verify you are taken to invite members page and members page is loaded in the background
QA Steps
- Go settings > workspaces > select a workspace where you are admin
- On profile page verify there is a invite button beside
sharebutton - Click on the invite button > verify you are taken to invite members page and members page is loaded in the background
- [x] Verify that no errors appear in the JS console
PR Author Checklist
- [x] I linked the correct issue in the
### Fixed Issuessection above - [x] I wrote clear testing steps that cover the changes made in this PR
- [x] I added steps for local testing in the
Testssection - [x] I added steps for the expected offline behavior in the
Offline stepssection - [x] I added steps for Staging and/or Production testing in the
QA stepssection - [x] I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- [x] 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)
- [x] 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).
- [x] I added steps for local testing in the
- [x] I included screenshots or videos for tests on all platforms
- [x] I ran the tests on all platforms & verified they passed on:
- [x] Android: Native
- [x] Android: mWeb Chrome
- [x] iOS: Native
- [x] iOS: mWeb Safari
- [x] MacOS: Chrome / Safari
- [x] MacOS: Desktop
- [x] 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)
- [x] I followed proper code patterns (see Reviewing the code)
- [x] 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.
toggleReportand notonIconClick) - [x] I verified that comments were added to code that is not self explanatory
- [x] 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.
- [x] I verified any copy / text shown in the product is localized by adding it to
src/languages/*files and using the translation method- [x] 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:
- [x] I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- [x] 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)
- [x] 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.
- [x] I verified the JSDocs style guidelines (in
STYLE.md) were followed
- [x] 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.
- [x] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
- [x] I followed the guidelines as stated in the Review Guidelines
- [x] 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 usingAvatarare working as expected) - [x] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
- [x] 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
- [x] I verified that if a function's arguments changed that all usages have also been updated correctly
- [x] If any new file was added I verified that:
- [x] 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
- [x] If a new CSS style is added I verified that:
- [x] A similar style doesn't already exist
- [x] The style can't be created with an existing StyleUtils function (i.e.
StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
- [x] 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.
- [x] 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
Avataris modified, I verified thatAvataris working as expected in all cases) - [x] 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.
- [x] 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.
- [x] 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:
- [x] I verified that all the inputs inside a form are aligned with each other.
- [x] I added
Designlabel and/or tagged@Expensify/designso the design team can review the changes.
- [x] If a new page is added, I verified it's using the
ScrollViewcomponent to make it scrollable when more elements are added to the page. - [x] If the
mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps.
Screenshots/Videos
Android: Native
https://github.com/user-attachments/assets/3e4b612e-e771-4037-8a72-a3b7dab41617
Android: mWeb Chrome
https://github.com/user-attachments/assets/43a638df-042d-4232-9e91-4159a5f11eae
iOS: Native
https://github.com/user-attachments/assets/52af2243-62cc-475c-b038-bad41b12a22e
iOS: mWeb Safari
https://github.com/user-attachments/assets/31b37385-98fe-4d27-9374-1fc198923d5d
MacOS: Chrome / Safari
https://github.com/user-attachments/assets/b9e99d6d-49eb-463b-a629-aa354c0434e7
MacOS: Desktop
https://github.com/user-attachments/assets/7a808e89-9e56-43d5-ba9c-004db4b21b1c
@allgandalf Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]
@allgandalf @neil-marcellini, while recoding the platform videos I found 2 issues that we might want to solve:
- On small-width devices, when navigating to the invite page from the profile page, there is a flash that appears to be from the members page.
- When going back twice from the invite page, the initial settings page is shown instead of the profile page.
Possible solution: We can add a param ?invite=true in workspace members page and instead of directly navigating to invite page, we can navigate to members page and on initial render we can check the param and it is true we will instantly navigate to invite page.
https://github.com/user-attachments/assets/d4394717-6af5-4c9e-8d44-7c169a58f6db
https://github.com/user-attachments/assets/06afe116-e165-4f3a-bfe4-6093e5a151cf
@Krishna2323 I don't really see any problems in those two videos that seem worth fixing. I think the navigation makes sense.
Reviewer Checklist
- [x] I have verified the author checklist is complete (all boxes are checked off).
- [x] I verified the correct issue is linked in the
### Fixed Issuessection above - [x] I verified testing steps are clear and they cover the changes made in this PR
- [x] I verified the steps for local testing are in the
Testssection - [x] I verified the steps for Staging and/or Production testing are in the
QA stepssection - [x] 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)
- [x] 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)
- [x] I verified the steps for local testing are in the
- [x] I checked that screenshots or videos are included for tests on all platforms
- [x] I included screenshots or videos for tests on all platforms
- [x] I verified tests pass on all platforms & I tested again on:
- [x] Android: Native
- [x] Android: mWeb Chrome
- [x] iOS: Native
- [x] iOS: mWeb Safari
- [x] MacOS: Chrome / Safari
- [x] MacOS: Desktop
- [x] 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
- [x] I verified proper code patterns were followed (see Reviewing the code)
- [x] 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.
toggleReportand notonIconClick). - [x] I verified that comments were added to code that is not self explanatory
- [x] 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.
- [x] I verified any copy / text shown in the product is localized by adding it to
src/languages/*files and using the translation method - [x] I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- [x] 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)
- [x] 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.
- [x] I verified the JSDocs style guidelines (in
STYLE.md) were followed
- [x] 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.
- [x] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
- [x] I verified that this PR follows the guidelines as stated in the Review Guidelines
- [x] 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 usingAvatarhave been tested & I retested again) - [x] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
- [x] 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
- [x] If a new component is created I verified that:
- [x] A similar component doesn't exist in the codebase
- [x] All props are defined accurately and each prop has a
/** comment above it */ - [x] The file is named correctly
- [x] The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- [x] The only data being stored in the state is data necessary for rendering and nothing else
- [x] For Class Components, any internal methods passed to components event handlers are bound to
thisproperly so there are no scoping issues (i.e. foronClick={this.submit}the methodthis.submitshould be bound tothisin the constructor) - [x] Any internal methods bound to
thisare necessary to be bound (i.e. avoidthis.submit = this.submit.bind(this);ifthis.submitis never passed to a component event handler likeonClick) - [x] All JSX used for rendering exists in the render method
- [x] 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
- [x] If any new file was added I verified that:
- [x] 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
- [x] If a new CSS style is added I verified that:
- [x] A similar style doesn't already exist
- [x] The style can't be created with an existing StyleUtils function (i.e.
StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
- [x] 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.
- [x] 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
Avataris modified, I verified thatAvataris working as expected in all cases) - [x] 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.
- [x] 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.
- [x] 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:
- [x] I verified that all the inputs inside a form are aligned with each other.
- [x] I added
Designlabel and/or tagged@Expensify/designso the design team can review the changes.
- [x] If a new page is added, I verified it's using the
ScrollViewcomponent to make it scrollable when more elements are added to the page. - [x] For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
- [x] If the
mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps. - [x] I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.
Screenshots/Videos
Android: Native
https://github.com/user-attachments/assets/067300b8-8b06-4234-8cb1-742b85984352
Android: mWeb Chrome
https://github.com/user-attachments/assets/4e84af3e-f79a-4c65-8071-b4b79932bbe6
iOS: Native
https://github.com/user-attachments/assets/aa43f1cf-c734-4c16-97c6-00cb85da0e10
iOS: mWeb Safari
https://github.com/user-attachments/assets/a72a04f3-9793-4471-a3f0-8f764ec7fe44
MacOS: Chrome / Safari
https://github.com/user-attachments/assets/a18472b0-ba8b-4ad4-b692-ff12cf735ed2
MacOS: Desktop
https://github.com/user-attachments/assets/712fa044-72c0-4f93-9d98-411ecc31bf8f
c.c. @Expensify/design as this is a new feature, can you take a look at the videos and give 👍 from design perspective , thanks
Videos are looking good to me.
Regarding this:
On small-width devices, when navigating to the invite page from the profile page, there is a flash that appears to be from the members page.
I actually think this might be a good thing because it might be easy to feel "lost" once you click the invite button, so showing a snippet of where the invite page is coming from is potentially a good thing. 🤷♂️
Yup, agree with those comments from Danny above, looking good!
Thanks, completing the checklist now
Happy to merge this, but seeing this now I actually think the RHP should fly out with the current page (Workspace profile) still underneath and only if you successfully add someone, land on members page highlighting the newly invited people.
The jump from Invite button press to Members page feels a bit disorienting to me.
Keen to hear @Expensify/design thoughts on that, but happy to move on still
I can totally see that Jon, happy to go with your recommendation as I can see where it might make things feel a bit more clear.
The original intention was to "teach someone how to fish" by taking them first to the Members page but after seeing it in action I think I agree, the quick jump to a different page feels unexpected for a button like this.
Yep, I originally proposed exactly the flow you laid out for all the reasons that you mentioned, but others in the thread wanted to go the Members page route because of the "teach you to fish" idea that Shawn mentioned and because it was deemed as easier/faster to implement since the invite flow on the members page already exists.
TLDR: I'm very much for making the invite RHP open over the profile. We might want to check and see if the rest of the team is down with that change though.
Hmm why a follow up? This feature doesn't exist yet so if we're going to change it, I feel like it makes sense to do so before merging this.
Ok that's fine too. It wasn't clear to me that the comments from the design team were blocking. Heads up, I'm going to be OOO for the rest of the week. I'm sure if you post in engineering chat someone can help review after the fix.
If all of @Expensify/design is aligned, I recon we go with the change then:
- Click Invite button
- Invite member panel opens in RHP with Workspace Profile underneath
- If dismissed, RHP goes away
- If successfully invited someone, auto-navigate/land on Members screen with the newly added member highlighted
Let us know if we decide on these changes, then @Krishna2323 can work on those accordingly
I say let's consider it decided - Jon has spoken - let's move forward with the changes 👍
Agree. I think it's a much better experience that way.
all good!, @Krishna2323 do you have any doubts for this implementation ?
No doubts about the expected result, will work on that today.
@allgandalf, implementing the new behaviour will have the issue as this one, we would need to remove the mapping from SCREENS.WORKSPACE.MEMBERS and it will work as expected, the only issue we will face is that on refresh the central pane will be changed to default and copy pasting the link will also open the invite page with default central pane.
One solution can be: we can create separate screens for that and use the same components.
https://github.com/Expensify/App/blob/b6ebedb611a549bb755aee934ca7f7707ce13798/src/libs/Navigation/linkingConfig/FULL_SCREEN_TO_RHP_MAPPING.ts#L13-L15
One solution can be: we can create separate screens for that and use the same components.
Not sure if I am onboard with this one, give me a day i will ask on #quality and get back
Asked here
@allgandalf If you want to have different screens under the overlay depending on context (e.g. the way the user gets there) you should use the backTo param. It has higher priority than the values hardcoded in mappings for filling the missing screen under RHP.
@Krishna2323 please update the PR accordingly
@Krishna2323 please fix the failing tests
@Expensify/design, does this look correct?
https://github.com/user-attachments/assets/c0d98bb2-14c5-4b33-9d93-46784310a031
I assume most of the team is out 📆
That looks pretty good to me!
:hand: This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.
🚀 Deployed to staging by https://github.com/neil-marcellini in version: 9.0.79-0 🚀
| platform | result |
|---|---|
| 🤖 android 🤖 | success ✅ |
| 🖥 desktop 🖥 | success ✅ |
| 🍎 iOS 🍎 | success ✅ |
| 🕸 web 🕸 | success ✅ |
| 🤖🔄 android HybridApp 🤖🔄 | success ✅ |
| 🍎🔄 iOS HybridApp 🍎🔄 | success ✅ |