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

feat: Add an "Invite" button to the workspace profile page #53719

Merged
merged 8 commits into from
Dec 24, 2024

Conversation

Krishna2323
Copy link
Contributor

@Krishna2323 Krishna2323 commented Dec 6, 2024

Explanation of Change

  • Adds an invite button beside share button on workspace profile page.

Fixed Issues

$ #53716
PROPOSAL: #53716 (comment)

Tests

  1. Go settings > workspaces > select a workspace where you are admin
  2. On profile page verify there is a invite button beside share button
  3. Click on the invite button > verify you are taken to invite members page and members page is loaded in the background
  • Verify that no errors appear in the JS console

Offline tests

  1. Go settings > workspaces > select a workspace where you are admin
  2. On profile page verify there is a invite button beside share button
  3. Click on the invite button > verify you are taken to invite members page and members page is loaded in the background

QA Steps

  1. Go settings > workspaces > select a workspace where you are admin
  2. On profile page verify there is a invite button beside share button
  3. Click on the invite button > verify you are taken to invite members page and members page is loaded in the background
  • 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 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
android_native.mp4
Android: mWeb Chrome
android_chrome.mp4
iOS: Native
ios_native.mp4
iOS: mWeb Safari
ios_safari.mp4
MacOS: Chrome / Safari
web_chrome.mp4
MacOS: Desktop
desktop_app.mp4

Signed-off-by: krishna2323 <belivethatkg@gmail.com>
Signed-off-by: krishna2323 <belivethatkg@gmail.com>
@Krishna2323 Krishna2323 requested a review from a team as a code owner December 6, 2024 19:31
@melvin-bot melvin-bot bot requested review from allgandalf and removed request for a team December 6, 2024 19:31
Copy link

melvin-bot bot commented Dec 6, 2024

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

@Krishna2323 Krishna2323 changed the title Krishna2323/issue/53716 feat: Add an "Invite" button to the workspace profile page Dec 6, 2024
@Krishna2323
Copy link
Contributor Author

@allgandalf @neil-marcellini, while recoding the platform videos I found 2 issues that we might want to solve:

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

ios_native.mp4
android_native.mp4

@neil-marcellini
Copy link
Contributor

@Krishna2323 I don't really see any problems in those two videos that seem worth fixing. I think the navigation makes sense.

Copy link
Contributor

@neil-marcellini neil-marcellini left a comment

Choose a reason for hiding this comment

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

Looks great, assuming C+ testing passes

@allgandalf
Copy link
Contributor

allgandalf commented Dec 11, 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
Screen.Recording.2024-12-15.at.8.51.01.PM.mov
Android: mWeb Chrome
Screen.Recording.2024-12-15.at.8.52.48.PM.mov
iOS: Native
Screen.Recording.2024-12-15.at.8.40.45.PM.mov
iOS: mWeb Safari
Screen.Recording.2024-12-15.at.8.41.17.PM.mov
MacOS: Chrome / Safari
Screen.Recording.2024-12-15.at.8.37.34.PM.mov
MacOS: Desktop
Screen.Recording.2024-12-15.at.8.38.26.PM.mov

@allgandalf
Copy link
Contributor

c.c. @Expensify/design as this is a new feature, can you take a look at the videos and give 👍 from design perspective , thanks

@dannymcclain
Copy link
Contributor

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. 🤷‍♂️

@shawnborton
Copy link
Contributor

Yup, agree with those comments from Danny above, looking good!

@allgandalf
Copy link
Contributor

Thanks, completing the checklist now

Copy link
Contributor

@allgandalf allgandalf 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 neil-marcellini December 15, 2024 15:24
@dubielzyk-expensify
Copy link
Contributor

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

@shawnborton
Copy link
Contributor

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.

@dannymcclain
Copy link
Contributor

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.

Copy link
Contributor

@neil-marcellini neil-marcellini left a comment

Choose a reason for hiding this comment

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

Good to go. If we decide to change the UX later we can do that in a follow up.

@shawnborton
Copy link
Contributor

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.

@neil-marcellini
Copy link
Contributor

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.

@dubielzyk-expensify
Copy link
Contributor

If all of @Expensify/design is aligned, I recon we go with the change then:

  1. Click Invite button
  2. Invite member panel opens in RHP with Workspace Profile underneath
  3. If dismissed, RHP goes away
  4. If successfully invited someone, auto-navigate/land on Members screen with the newly added member highlighted

@allgandalf
Copy link
Contributor

Let us know if we decide on these changes, then @Krishna2323 can work on those accordingly

@shawnborton
Copy link
Contributor

I say let's consider it decided - Jon has spoken - let's move forward with the changes 👍

@dannymcclain
Copy link
Contributor

Agree. I think it's a much better experience that way.

@allgandalf
Copy link
Contributor

all good!, @Krishna2323 do you have any doubts for this implementation ?

@Krishna2323
Copy link
Contributor Author

No doubts about the expected result, will work on that today.

@Krishna2323
Copy link
Contributor Author

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

[SCREENS.WORKSPACE.MEMBERS]: [
SCREENS.WORKSPACE.INVITE,
SCREENS.WORKSPACE.INVITE_MESSAGE,

@allgandalf
Copy link
Contributor

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

@allgandalf
Copy link
Contributor

Asked here

@adamgrzybowski
Copy link
Contributor

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

@allgandalf
Copy link
Contributor

@Krishna2323 please update the PR accordingly

@allgandalf
Copy link
Contributor

@Krishna2323 please fix the failing tests

Signed-off-by: krishna2323 <belivethatkg@gmail.com>
@Krishna2323
Copy link
Contributor Author

@Expensify/design, does this look correct?

Monosnap.screencast.2024-12-23.15-55-53.mp4

@allgandalf
Copy link
Contributor

allgandalf commented Dec 24, 2024

I assume most of the team is out 📆

@shawnborton
Copy link
Contributor

That looks pretty good to me!

Copy link
Contributor

@neil-marcellini neil-marcellini left a comment

Choose a reason for hiding this comment

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

Looks good to me

@neil-marcellini neil-marcellini merged commit 5c750c5 into Expensify:main Dec 24, 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.

Copy link
Contributor

🚀 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 ✅

@izarutskaya
Copy link

Copy link
Contributor

🚀 Deployed to production by https://github.com/puneetlath in version: 9.0.79-5 🚀

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

<Button
accessibilityLabel={translate('common.invite')}
text={translate('common.invite')}
onPress={() => Navigation.navigate(ROUTES.WORKSPACE_INVITE.getRoute(route.params.policyID, Navigation.getActiveRouteWithoutParams()))}
Copy link
Member

Choose a reason for hiding this comment

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

We didn't clear the draft while reopening the page which caused the previous selection to stay. #54604

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.

10 participants