Page MenuHomePhabricator

Implementation - Multiple organizer support
Closed, ResolvedPublic

Description

As an event organizer, I want to be able to add other organizes to my event, so that they can also view and manage registration in the same way that I can.

Acceptance Criteria:

  • Allow organizer to add other organizers to event registration by specifying their username
    • The text should read: "Add the usernames of other organizers to give them permission to manage this event."
  • Allow organizer to remove organizer
    • There should be an area for the organizer to add in the usernames
  • If a new organizer is added to an event, they have all basic organizer privileges, including being able to:
    • Edit event registration information
    • Cancel the registration of a participant
    • Open or close event registration
    • Delete event registration
  • Should your username of the event creator be in the list?
    • Yes.
  • Should you be able to remove yourself, as an event creator?
    • Every event should have at least 1 organizer. So you can only remove yourself if there is more than one organizer. If there is more than one organizer, you can remove yourself.
  • If you're not the event creator, should you be able to remove the event creator?
    • No. The primary organizer name should be displayed separately and it should be non-editable by other organizers.
  • Note that all organizers will have the same rights for V1, but they will have the option to have different rights in V2 (see T316138).
  • Update the API documentation for the new "set event organizers" endpoint.

Note: we need to check how the widget works when there's a large number of organizers.

Proposed Design
Prototype
Design file

When there is at least one usernameWarning message when the field is blankError message when the user tries to the submit form with a blank field
Screenshot 2023-01-11 at 10.52.35.png (348ร—784 px, 30 KB)
Screenshot 2023-01-11 at 10.52.49.png (432ร—784 px, 37 KB)
Screenshot 2023-01-11 at 10.54.32.png (464ร—784 px, 44 KB)

Decisions

  • 2023-03-01: Event creators can remove themselves as organizers if all of the following criteria are met:
    • At least one other organizer has been added to the event
    • The event has been created (that is, the organizer cannot remove themselves while they are creating the event)

For the MVP of this feature, we will allow 10 organizers per event

Event Timeline

There are a very large number of changes, so older changes are hidden. Show Older Changes

Change 881753 had a related patch set uploaded (by Cmelo; author: Cmelo):

[mediawiki/core@master] Add an option to be able filter users by group on UserMultSelectWidget

https://gerrit.wikimedia.org/r/881753

Change 881752 had a related patch set uploaded (by Cmelo; author: Cmelo):

[mediawiki/extensions/CampaignEvents@master] Add suport for multple organizers

https://gerrit.wikimedia.org/r/881752

Hey @cmelo , at this week's Design/Engineering meeting we decided to add a verification for users whose organizer right had been removed, so that they would no longer be able to administer event registrations they previously could. Do you think we should create a new task for the verification, or add to the acceptance criteria in this task?

Change 889124 had a related patch set uploaded (by Daimona Eaytoy; author: Daimona Eaytoy):

[mediawiki/extensions/CampaignEvents@master] Add support for multiple organizers to the API

https://gerrit.wikimedia.org/r/889124

Change 889129 had a related patch set uploaded (by Daimona Eaytoy; author: Daimona Eaytoy):

[mediawiki/extensions/CampaignEvents@master] Add support for multiple organizers to the frontend

https://gerrit.wikimedia.org/r/889129

@Daimona has caught some bugs; TBD whether the list is complete and whether they are release blocking:
T330362
T285252
T330353

Full list of related bugs:

I think none of these are serious enough to block the release on their own, but they surely add up, and it's 4 of them... It's probably still fine to release as the MVP, but I'd like to have these fixed soon(TM).

Change 895234 had a related patch set uploaded (by Daimona Eaytoy; author: Daimona Eaytoy):

[operations/mediawiki-config@master] Enable $wgCampaignEventsEnableMultipleOrganizers on beta

https://gerrit.wikimedia.org/r/895234

Change 881752 merged by jenkins-bot:

[mediawiki/extensions/CampaignEvents@master] Add support for multiple organizers, backend only

https://gerrit.wikimedia.org/r/881752

Change 889129 merged by jenkins-bot:

[mediawiki/extensions/CampaignEvents@master] Add support for multiple organizers to the frontend

https://gerrit.wikimedia.org/r/889129

Change 895326 had a related patch set uploaded (by Daimona Eaytoy; author: Daimona Eaytoy):

[mediawiki/extensions/CampaignEvents@master] Fix crash in MWPermissionsLookup with anons

https://gerrit.wikimedia.org/r/895326

Change 895326 merged by jenkins-bot:

[mediawiki/extensions/CampaignEvents@master] Fix crash in MWPermissionsLookup with anons

https://gerrit.wikimedia.org/r/895326

Change 895234 merged by jenkins-bot:

[operations/mediawiki-config@master] Enable $wgCampaignEventsEnableMultipleOrganizers on beta

https://gerrit.wikimedia.org/r/895234

Change 889124 merged by jenkins-bot:

[mediawiki/extensions/CampaignEvents@master] Add support for multiple organizers to the API

https://gerrit.wikimedia.org/r/889124

Change 881753 abandoned by Cmelo:

[mediawiki/core@master] Add an option to be able filter users by group on UserMultSelectWidget

Reason:

https://gerrit.wikimedia.org/r/881753

@vaughnwalters We changed our implementation after T327470#8642549 was written, so the only expected bugs are:

  • T285252 - Pressing tab while the field is focused will remove an item
  • T331421 - If you have an event created by user A, add B as organizer, then go to Special:EditEventRegistration while logged in as B, you will see that the card with A is disabled. However, you can still remove A by highlighting their name in the dropdown menu of the field and pressing enter. Backend validation will still make the form submission fail.

Acceptance Criteria:

  • โœ… Allow organizer to add other organizers to event registration by specifying their username
    • โœ… The text should read: "Add the usernames of other organizers to give them permission to manage this event."
      Screenshot 2023-03-10 at 12.36.21 PM.png (158ร—1 px, 33 KB)
  • โœ… Allow organizer to remove organizer
    Screen Recording 2023-03-10 at 1.39.10 PM.gif (1ร—1 px, 549 KB)
    • โœ… There should be an area for the organizer to add in the usernames
  • โœ… If a new organizer is added to an event, they have all basic organizer privileges, including being able to:
    • โœ… Edit event registration information
      Screen Recording 2023-03-10 at 2.11.50 PM.gif (1ร—1 px, 564 KB)
    • โœ… Cancel the registration of a participant
      Screen Recording 2023-03-10 at 2.19.57 PM.gif (608ร—1 px, 227 KB)
    • โœ… Open or close event registration
      Screen Recording 2023-03-10 at 2.15.57 PM.gif (1ร—1 px, 1 MB)
    • โœ… Delete event registration
      Screen Recording 2023-03-10 at 2.31.42 PM.gif (1ร—1 px, 479 KB)
  • Should your username of the event creator be in the list?
    • โœ… Yes.
      Screenshot 2023-03-10 at 2.56.34 PM.png (194ร—1 px, 40 KB)
      Screenshot 2023-03-10 at 2.57.38 PM.png (1ร—954 px, 108 KB)
  • Should you be able to remove yourself, as an event creator?
    • โœ… Every event should have at least 1 organizer. So you can only remove yourself if there is more than one organizer. If there is more than one organizer, you can remove yourself.
      Screen Recording 2023-03-10 at 2.45.22 PM.gif (1ร—1 px, 347 KB)
  • If you're not the event creator, should you be able to remove the event creator?
    • โœ… No. The primary organizer name should be displayed separately and it should be non-editable by other organizers.
      Screen Recording 2023-03-10 at 2.41.21 PM.gif (1ร—1 px, 1 MB)
  • Note that all organizers will have the same rights for V1, but they will have the option to have different rights in V2 (see T316138).
  • ๐Ÿ”ด Update the API documentation for the new "set event organizers" endpoint.

Note: we need to check how the widget works when there's a large number of organizers.

  • ๐Ÿ”ด โžก Right now only 10 organizers can be added.

Design
๐Ÿ”ด When there is at least one username

  • โžก Placeholder text should be Add username

comp:

Screenshot 2023-01-11 at 10.52.35.png (348ร—784 px, 30 KB)
build:
Screenshot 2023-03-10 at 3.35.52 PM.png (176ร—1 px, 32 KB)


๐Ÿ”ด Warning message when the field is blank

  • โžก Placeholder text should be Add username
  • โžก Icon should be the yellow caution icon
  • โžก Copy in the error message should be Events need to have at least one organizer. Please add an organizer.

comp:

Screenshot 2023-01-11 at 10.52.49.png (432ร—784 px, 37 KB)

build:
build.png (242ร—1 px, 37 KB)


๐Ÿ”ด Error message when the user tries to the submit form with a blank field

  • โžก Placeholder text should be Add username
  • โžก Copy in the error message should be Events need to have at least one organizer. Please add an organizer.

comp:

Screenshot 2023-01-11 at 10.54.32.png (464ร—784 px, 44 KB)

build:
build.png (242ร—1 px, 37 KB)



Heya @cmelo A few notes after going through this, and i put a ๐Ÿ”ด and โžก in the notes above, beside of the things I am talking about so it's hopefully easier to reference.

  1. there is no documentation for this endpoint on the api doc - let me know whenever you get that added in as I would like to test the API as well
  1. there is discrepancy between the comp and the build in the copy and icons if there are no organizers in the field, I made a few notes above about those.
  1. Here is a bug I found:

There is an error when an organizer is either suppressed or deleted by central auth:

The user is correctly shown as deleted or suppressed, but then the organizer is no longer able to edit the event, and it displays the following internal error for suppressed user:

[ZBDHpMa7OaHm64f@SFLXygAAAAo] /wiki/Special:EditEventRegistration/118 MediaWiki\Extension\CampaignEvents\MWEntity\HiddenCentralUserException: Central ID 215879 belongs to a hidden user

screencap for Central ID 215879 belongs to a hidden user

Screen Recording 2023-03-14 at 2.14.45 PM.gif (1ร—3 px, 1 MB)

and it displays the following internal error for deleted user:

[ZBDJTca7OaHm64f@SFLY7wAAAAQ] /wiki/Special:EditEventRegistration/118 MediaWiki\Extension\CampaignEvents\MWEntity\CentralUserNotFoundException: Central ID 215933 does not belong to any user

screencap of error for Central ID 215933 does not belong to any user

Screen Recording 2023-03-14 at 2.39.21 PM.gif (1ร—3 px, 987 KB)

As this bug is fixed, I think it is worth considering special attention to the case if the creator of the event is deleted or suppressed, since that user under normal circumstances can not be removed by any other organizer of the event. So even if we wanted to not display deleted or suppressed users, or give organizers the ability to delete them, then there would possibly have to be some exception for the creator of the event, to allow them to be removed in this case.

Here is an example where I suppressed the creator. I added @cmelo as an organizer as well so you can see the error when you try to edit the registration:
https://en.wikipedia.beta.wmflabs.org/wiki/Special:EventDetails/209


  1. Here is one more bug I found:

If you try to add anyone who can not be an organizer, it will quickly flash an error message, but it is too fast to be able to read, and but is still displays generic error message at the top of the page:

This is an example of trying to add a deleted user as organizer:
screencap:

Screen Recording 2023-03-14 at 3.11.02 PM.gif (1ร—3 px, 603 KB)

But it quickly disappears, so here is a screenshot of the text that flashes:
Screenshot 2023-03-14 at 3.12.58 PM.png (264ร—1 px, 177 KB)

Here is an example of trying to add a user that doesn't have permissions as an organizer:
screencap:

adding user that doesn't have permissions.gif (1ร—1 px, 698 KB)

But same as above, the notice that is helpful disappears, so here is a screenshot of the text that flashes:
Screenshot 2023-03-14 at 3.16.16 PM.png (258ร—1 px, 121 KB)

These helpful error messages should remain on the page so the user knows what the specific problem is

  • ๐Ÿ”ด Update the API documentation for the new "set event organizers" endpoint.

Done, thanks!!! Update organizers API

Note: we need to check how the widget works when there's a large number of organizers.

  • ๐Ÿ”ด โžก Right now only 10 organizers can be added.

The limit of organizers per event is 10 for the MVP, I didn't find where we mention that, but I will add it to the acceptance criteria, thanks

@vaughnwalters @gonyeahialam @ldelench_wmf @VPuffetMichel

Change 899959 had a related patch set uploaded (by Cmelo; author: Cmelo):

[mediawiki/extensions/CampaignEvents@master] Change organizer filed place holder message

https://gerrit.wikimedia.org/r/899959

Change 899987 had a related patch set uploaded (by Cmelo; author: Cmelo):

[mediawiki/extensions/CampaignEvents@master] Fix - Icon should be the yellow caution icon Fix - Copy in the error message should be ...

https://gerrit.wikimedia.org/r/899987

๐Ÿ”ด Warning message when the field is blank

  • โžก Placeholder text should be Add username
  • โžก Icon should be the yellow caution icon

For consistence, I think the icon should be the same as when the user submits the form, also because this is trick to implement (I mean show one icon on live validation and another one after submitting the form), the JS is responsible for adding this message, so there is not a beauty way to know whether this is a live validation or not.

@vaughnwalters @gonyeahialam

Change 899987 abandoned by Cmelo:

[mediawiki/extensions/CampaignEvents@master] Fix - Icon should be the yellow caution icon Fix - Copy in the error message should be ...

Reason:

https://gerrit.wikimedia.org/r/899987

Change 899959 merged by jenkins-bot:

[mediawiki/extensions/CampaignEvents@master] Change organizer field placeholder message

https://gerrit.wikimedia.org/r/899959

Change 902181 had a related patch set uploaded (by Cmelo; author: Cmelo):

[mediawiki/extensions/CampaignEvents@master] Fix error when an organizer is deleted on edit event special page Do not display "deleted user" in case an organizer is deleted Display "This event doesn't have an organizer" in case there is no organizer

https://gerrit.wikimedia.org/r/902181

Change 902408 had a related patch set uploaded (by Cmelo; author: Cmelo):

[mediawiki/extensions/CampaignEvents@master] Change error messsage in case the user remove all organizers

https://gerrit.wikimedia.org/r/902408

Change 902181 had a related patch set uploaded (by Cmelo; author: Cmelo):

[mediawiki/extensions/CampaignEvents@master] Fix error when an organizer is deleted on edit event special page

https://gerrit.wikimedia.org/r/902181

Change 902181 merged by jenkins-bot:

[mediawiki/extensions/CampaignEvents@master] Fix error when an organizer is deleted on edit event special page

https://gerrit.wikimedia.org/r/902181

Change 902408 merged by jenkins-bot:

[mediawiki/extensions/CampaignEvents@master] Change error messsage in case the user remove all organizers

https://gerrit.wikimedia.org/r/902408

I think all issues reported by @vaughnwalters have been fixed, except for the flashing text issue that I'm unable to reproduce.

I think all issues reported by @vaughnwalters have been fixed, except for the flashing text issue that I'm unable to reproduce.

@Daimona here is an event that I created and added you as organizer so you can test this:
https://en.wikipedia.beta.wmflabs.org/wiki/Special:EditEventRegistration/212

try adding this user as an organizer (you might have to delete the last two characters the 12 to be able to search correctly for it)
v13827615369812

here is what I am seeing:

Screen Recording 2023-03-30 at 11.48.09 AM.gif (1ร—2 px, 1 MB)

and the quick flash that is showing is this:

Screenshot 2023-03-30 at 11.50.33 AM.png (122ร—614 px, 44 KB)

Let me know if you are still having problems reproducing

Thanks, now I get it. I wasn't able to reproduce it locally, but it's perfectly reproducible on beta. The reason is that the configuration is different: my local is configured so that only users in a given user group can be organizers, whereas on beta everyone can be an organizer. This specific issue happens when a user has the needed organizer rights (and on beta, every logged-in user does), but fails some other permission check; in particular, I think this can only happen if they're blocked or do not have a central account. This is a known limitation, as the live validation is only meant to perform the simplest permission checks. The trouble is, when we setup the live validation, all errors on the field are erased. We shouldn't be doing that, we should merge and selectively remove errors instead. This is something I remember noticing in code review, but then we forgot about it. Let me try and fix it.

Change 904612 had a related patch set uploaded (by Daimona Eaytoy; author: Daimona Eaytoy):

[mediawiki/extensions/CampaignEvents@master] Add extra layer of validation for organizers when editing an event

https://gerrit.wikimedia.org/r/904612

Hmmmm this is a bit of a mess... The above can be done, but then the result becomes something between ugly and wrong when you start using the field (i.e., duplicated or out-of-date error messages). I tried a different approach.

Change 904612 merged by jenkins-bot:

[mediawiki/extensions/CampaignEvents@master] Add extra layer of validation for organizers when editing an event

https://gerrit.wikimedia.org/r/904612

Api checks:
โœ… 400 Organizer who is not the event creator is not allowed to remove the event creator.

Screenshot 2023-04-04 at 4.52.59 PM.png (1ร—2 px, 225 KB)

โœ… 400 Can not add more than 10 organizers

Screenshot 2023-04-04 at 5.07.18 PM.png (1ร—2 px, 243 KB)

โœ… 400 If a user does not exist, an error displays that the user doesn't have the needed permissions to be an organizer. Technically this is correct, since the user does not exist they can not have the needed permissions to be an organizer.

Screenshot 2023-04-04 at 5.10.05 PM.png (1ร—2 px, 254 KB)

โœ… 403 if not allowed to edit event registration (logged in user is not an organizer of the event in this case):

Screenshot 2023-04-04 at 5.14.29 PM.png (1ร—2 px, 237 KB)

โœ… 404 if event does not exist:

Screenshot 2023-04-04 at 5.16.08 PM.png (1ร—1 px, 198 KB)


Notes from defects found earlier that are now corrected:

โœ… The flashing error text noted at T327470#8742742 is now fixed:

Screenshot 2023-04-03 at 4.30.08 PM.png (1ร—1 px, 184 KB)

โœ… Suppressed organizers no longer cause the page to have errors:

Screenshot 2023-04-04 at 5.37.23 PM.png (1ร—1 px, 125 KB)

โœ… Deleted organizers no longer cause the page to have errors:

Screenshot 2023-04-04 at 5.39.54 PM.png (1ร—2 px, 153 KB)

โœ… The error message is now correct. Tagging @gonyeahialam to also sign off on the UX of this.

Screenshot 2023-04-04 at 5.42.32 PM.png (280ร—1 px, 51 KB)



A few notes about the API:
๐Ÿ”ด The api doc for this endpoint is incorrect. It has id and organizer_usernames listed as parameters, but organizer_usernames should be listed as request schema, and id needs to be in the request URL. As it currently is documented, when I follow the docs and add them as parameters, I get this:

Screenshot 2023-04-04 at 4.31.06 PM.png (1ร—2 px, 235 KB)

but when I add organizer_usernames into the body as request schema, it works correctly (it doesn't need id in the request body, only in the URL:

Screenshot 2023-04-04 at 4.37.49 PM.png (1ร—2 px, 192 KB)

So, the endpoint is working correctly, it is just the doc that needs updated to reflect this.


๐Ÿ”ด If I put some extra characters in the organizer_username, then it throws a 500 error. Should this 500 error be handled differently or maybe just be documented in the doc? @cmelo @Daimona

Screenshot 2023-04-04 at 5.29.42 PM.png (1ร—1 px, 416 KB)

These are the only two remaining things, let me know what you think of the 500 error and when the docs are updated and then we can move this to design sign off.

Change 905765 had a related patch set uploaded (by Daimona Eaytoy; author: Daimona Eaytoy):

[mediawiki/extensions/CampaignEvents@master] Manually validate organizer usernames in SetOrganizersHandler

https://gerrit.wikimedia.org/r/905765

@vaughnwalters Thanks, I've already updated the API docs, and pushed a fix for the validation issue.

Change 905765 merged by jenkins-bot:

[mediawiki/extensions/CampaignEvents@master] Manually validate organizer usernames in SetOrganizersHandler

https://gerrit.wikimedia.org/r/905765

@vaughnwalters Thanks, I've already updated the API docs, and pushed a fix for the validation issue.

โœ… Api docs for this endpoint is correct now

โœ… Validation issue for extra characters in the organizer_username is fixed

Screenshot 2023-04-10 at 3.39.47 PM.png (1ร—1 px, 212 KB)