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

Invite user to workspace via invite link #37525

Merged
merged 37 commits into from
Mar 7, 2024

Conversation

narefyev91
Copy link
Contributor

@narefyev91 narefyev91 commented Feb 29, 2024

Details

Implement the invite flow from the Simplified Collect: Profile, Members, Categories design doc

Fixed Issues

$ #36946
PROPOSAL: #36946

Tests

Preconditions:

  1. Has a workspace (new or existing one)
  2. Prepare join url link - use WorkspaceID and admin email for that workspace - ex. https://dev.new.expensify.com:8082/workspace/7DE6960B26D79E36/[email protected]

For user:

  1. Open link in a new tab (for a new user / or user which already logged in)
  2. Verify that loading indicator is shown
  3. Verify that user redirects to all workspaces screen
  4. Verify that user sees a new line with workspace (in which join link was executed) and user sees chip with text "Requested"
  5. Verify that user could not interact with that workspace
  6. Wait until admin accept/decline request - verify that user will have/not have access to the workspace

For Admin:

  1. When user used join link - verify that a new message is shown in admin room for that workspace
  2. Verify that 2 buttons are shown - "Accept"/"Decline"
  3. Click on any of them - verify that API request will be send, verify that message will be removed from admin room
  • Verify that no errors appear in the JS console

Offline tests

For user:

  1. User should be able to put in queue request to join workspace
  2. User should be redirected to all workspaces page

For admin:

  1. Admin should be able to put in queue request to accept/decline
  2. Message should be removed after interact with accept/decline buttons

QA Steps

Preconditions:

  1. Has a workspace (new or existing one)
  2. Prepare join url link - use WorkspaceID and admin email for that workspace - ex. https://dev.new.expensify.com:8082/workspace/7DE6960B26D79E36/[email protected]

For user:

  1. Open link in a new tab (for a new user / or user which already logged in)
  2. Verify that loading indicator is shown
  3. Verify that user redirects to all workspaces screen
  4. Verify that user sees a new line with workspace (in which join link was executed) and user sees chip with text "Requested"
  5. Verify that user could not interact with that workspace
  6. Wait until admin accept/decline request - verify that user will have/not have access to the workspace

For Admin:

  1. When user used join link - verify that a new message is shown in admin room for that workspace
  2. Verify that 2 buttons are shown - "Accept"/"Decline"
  3. Click on any of them - verify that API request will be send, verify that message will be removed from admin room
  • Verify that no errors appear in the JS console

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
    • I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
    • MacOS: Desktop
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
    • I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
      • If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label so the design team can review the changes.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

Android: Native

android-user
android-admin

Android: mWeb Chrome

android-web
android-user-web

iOS: Native

ios-user

admin-ios

iOS: mWeb Safari
ios-web-user.mov

user-ios-web

MacOS: Chrome / Safari
web.mov
web-admin Screenshot 2024-03-07 at 10 26 17
MacOS: Desktop admin-desktop

@luacmartins luacmartins self-requested a review February 29, 2024 18:29
src/ROUTES.ts Outdated Show resolved Hide resolved
src/libs/API/parameters/JoinPolicyInviteLink.ts Outdated Show resolved Hide resolved
src/libs/ReportActionsUtils.ts Outdated Show resolved Hide resolved
src/libs/actions/Policy.ts Outdated Show resolved Hide resolved
src/libs/actions/Policy.ts Outdated Show resolved Hide resolved
src/pages/home/report/ReportActionItem.js Outdated Show resolved Hide resolved
src/types/onyx/OriginalMessage.ts Outdated Show resolved Hide resolved
src/types/onyx/PolicyJoinMember.ts Outdated Show resolved Hide resolved
src/types/onyx/PolicyJoinMember.ts Outdated Show resolved Hide resolved
src/pages/workspace/WorkspaceJoinUserPage.tsx Outdated Show resolved Hide resolved
Copy link
Contributor

@luacmartins luacmartins left a comment

Choose a reason for hiding this comment

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

I noticed that we're making 3 requests to JoinWorkspaceViaInviteLink for each page load:
Screenshot 2024-02-29 at 1 24 48 PM

src/pages/workspace/WorkspaceJoinUserPage.tsx Outdated Show resolved Hide resolved
Copy link
Contributor

@luacmartins luacmartins left a comment

Choose a reason for hiding this comment

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

The requested badge position breaks in narrower screens
Screenshot 2024-02-29 at 1 27 33 PM

Copy link
Contributor

@luacmartins luacmartins left a comment

Choose a reason for hiding this comment

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

We need to hide the buttons once a user chooses either accept or decline

src/pages/home/report/ReportActionItem.js Outdated Show resolved Hide resolved
src/pages/home/report/ReportActionItem.js Outdated Show resolved Hide resolved
src/pages/home/report/ReportActionItem.js Outdated Show resolved Hide resolved
@narefyev91
Copy link
Contributor Author

We need to hide the buttons once a user chooses either accept or decline

I think when API fill be working - this buttons will automatically be hidden - because it will remove 'ACTIONABLEJOINREQUEST' - from action type of the message

@rushatgabhane
Copy link
Member

rushatgabhane commented Mar 1, 2024

Requested access to design doc. Will begin reviewing today :)

# Conflicts:
#	src/libs/actions/Policy.ts
@narefyev91
Copy link
Contributor Author

Something strange with GH - send 2 commits - and they did not appeared, and also already merged main to branch and resolve conflicts - but GH is not view that

@rushatgabhane
Copy link
Member

github is having sync issues.
image

@luacmartins
Copy link
Contributor

@rushatgabhane I shared the doc with you

# Conflicts:
#	src/pages/home/report/ReportActionItem.tsx
@rushatgabhane
Copy link
Member

rushatgabhane commented Mar 7, 2024

  1. Request to join workspace. Notice that your request is shown in workspace list page.
  2. As admin decline the request.
  3. Request to join the workspace again.
  4. The request does not show in workspace list page.
image

@luacmartins @narefyev91 small bug ^

Again, I think this is because the backend send empty onyxData.

Copy link
Member

@rushatgabhane rushatgabhane left a comment

Choose a reason for hiding this comment

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

@luacmartins LGTM! tested after resolving the tiny conflict.

Checklist - #37525 (comment)

Copy link
Contributor

@luacmartins luacmartins left a comment

Choose a reason for hiding this comment

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

LGTM! We're still investigating the crash on Decline, but that is a backend issue

@luacmartins luacmartins merged commit 9d56f35 into Expensify:main Mar 7, 2024
15 checks passed
Copy link

melvin-bot bot commented Mar 7, 2024

@luacmartins looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

@melvin-bot melvin-bot bot added the Emergency label Mar 7, 2024
@rushatgabhane
Copy link
Member

shhh melvin. all tests pass

@OSBotify
Copy link
Contributor

OSBotify commented Mar 7, 2024

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

@luacmartins
Copy link
Contributor

What's up with this tests not passing stuff. I'm seeing that a lot lately, but all tests were passing when I merged.

@OSBotify
Copy link
Contributor

OSBotify commented Mar 8, 2024

🚀 Deployed to staging by https://github.com/luacmartins in version: 1.4.49-0 🚀

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

@rushatgabhane
Copy link
Member

rushatgabhane commented Mar 11, 2024

What's up with this tests not passing stuff. I'm seeing that a lot lately, but all tests were passing when I merged.

@luacmartins is it possible that the tests pass on this branch but not after merging it into main?

@rushatgabhane
Copy link
Member

Btw I can't find which test has failed. All looks green to me

image

@luacmartins
Copy link
Contributor

I think we have some issue with GH secrets not being available when we run the action after merging the PR from a contributor's fork. We're working on it

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/luacmartins in version: 1.4.50-5 🚀

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

rowStyles={hovered && styles.hoveredComponentBG}
layoutWidth={isSmallScreenWidth ? CONST.LAYOUT_WIDTH.NARROW : CONST.LAYOUT_WIDTH.WIDE}
layoutWidth={isLessThanMediumScreen ? CONST.LAYOUT_WIDTH.NARROW : CONST.LAYOUT_WIDTH.WIDE}
Copy link
Member

Choose a reason for hiding this comment

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

Coming from #38058

Small bug. The back button shows in medium screen also

}
const isPolicyMember = PolicyUtils.isPolicyMember(policyID, policies as Record<string, Policy>);
if (isPolicyMember) {
Navigation.goBack(undefined, false, true);
Copy link
Contributor

Choose a reason for hiding this comment

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

Simply using goBack here caused an issue (#38824) with the navigation after pressing the WS invitation, we fixed this in #38984.

import type * as OnyxCommon from './OnyxCommon';

type PolicyJoinMember = {
/** Role of the user in the policy */
Copy link
Contributor

Choose a reason for hiding this comment

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

Hmm "Role of the user" is stored in policyID? Should this be updated?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes, it should. Thanks for noticing this! #41462

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.

8 participants