[Team Management 2.0] - Show exact reason for error during invitation

[maxceem]

When we invite Topcoder or Project Team members, there are various reasons why members couldn't be invited.

Actual Bahiour

Now we always show very general error alert YOU ARE UNABLE TO INVITE MEMBERS SUCCESSFULLY.

Expected Bahiour

It could be helpfull to see the exact reason why we cannot invite a member. Server usually retuns the exact error reason why we cannot invite a particular member which we can show instead of a general error message.

Steps to reproduce

For example. I'm trying to invite pshash_customer user as a Manager:

pshah_customer doesn't have enough rights to be a Manager, so server rejects inviting him and we see the next error:

While server returns the next response:

{
  "id": "21e38f17-cc41-41bf-9979-77af23705516",
  "result": {
    "success": false,
    "status": 403,
    "content": {
      "message": "40152922 cannot be added with a Manager role to the project"
    },
    "debug": "..."
  }
}

So we can show the particular error meesage 40152922 cannot be added with a Manager role to the project.

Note

It would be better to also update project service to use in the error message the data we typed into the fieled. Like if we add user by handle @pshah_customer server should format error message using handle @pshah_customer cannot be added with a Manager role to the project. If we invited user using email like pshah_customer@topcoder.com, server should format error message using email: pshah_customer@topcoder.com cannot be added with a Manager role to the project.

@RishiRajSahu what do you think?

[RishiRajSahu]

@maxceem yeah I am too aware of this, we should show correct error as per returned by server. So there are multiple things to be taken care -
1.In the error on UI instead of userId we have to show handle or email as the per invite
2.We have a support of adding multiple users at same role as per new feature, so suppose if someone is trying to adding 4-5 members with handle at manager role and one of them is normal topcoder user in that case the red popup will be overwhelmed with too much handles present in error text.
3.Should we have this kind of behaviour instead, showing generic reason in the red popup like -
User(s) cannot be added with a Manager role to the project and also showing a error below the invite text area with user handles or email in red ?
4.Could you also write all the possible invite scenarios to not miss any error message ?

Also, we can use handles and emails details here to be passed to reducers and later used for displaying correct error.

[RishiRajSahu]

For eg. some of the possible invite scenarios -

1.Adding manager user as copilot - success
2.Adding manager user as manager - success
3.Adding manager user as observer - success

1.Adding topcoder user as copilot - success
2.Adding topcoder user as manager - Show correct error
3.Adding topcoder user as observer - Show correct error

1.Adding connect-admin user as copilot - success
2.Adding connect-admin user as manager - success
3.Adding connect-admin user as observer - Show correct error

FYI - Currently only managers could be added at observer roles

[maxceem]

1.In the error on UI instead of userId we have to show handle or email as the per invite

I guess this should be fixed server side, right? As the client doesn't have information to match userIds and emails/handles.

Also, we can use handles and emails details here to be passed to reducers and later used for displaying correct error.

I'm not sure I got the idea. As the server returns an error message containing userIds, but the client doesn't have information on how to match userids and emails/handles. See the error message from the server for a several users 40152922,40035291 cannot be added with a Manager role to the project.
Also, server returns only error message in text format 40152922,40035291 cannot be added with a Manager role to the project so we don't have list of users which were added successfully and which had errors.

I guess we have to update project service to include data about successfull and failed invites when we invite multiple users.

[RishiRajSahu]

I guess we have to update project service to include data about successfull and failed invites when we invite multiple users.

That's a different case to be taken care , as right now project service don't create partial invites, it either creates all or none.

how to match userids and emails/handles

On UI side we already fetch members details here I am planning to use this details for matching instead of making the same call on backend again to fetch the data.

[maxceem]

On UI side we already fetch members details here

Thank you for pointing it.

As the server doesn't return failed invites only text error message, do you think we should parse error message to get userIds? Or better to update project service to return a list of failed/successful userIds?

[RishiRajSahu]

Other than scenarios mentioned here #2758 (comment) , there are few other cases to be thought on -
1.Partial invites are not getting created right now. for eg - if inviting multiple member on particular role and few doesn't fit for that role then the invite is not getting created for any of them.
2.Server returns just the id's of non fit members for that role with status 403.
3.Should we handle it server side to create a correct error error message OR should we just return handles instead of IDs from server OR should we map IDs returned by server, as its right now, on UI only and create a correct error message ?
4.Where should the error to be shown, should the detailed error be shown in the invite model only around the text area and popup with generic error only ?

fyi @maxceem @vikasrohit

[maxceem]

@RishiRajSahu this issue is handled by two PRs:
topcoder-platform/tc-project-service#258
#2877