User Events Management system #1269

RohanJnr · 2020-11-02T04:47:37Z

This PR uses the new API endpoints and features implemented in python-discord/site#410
Hence, this PR should be merged only after the Site PR is merged and deployed.

Commands/Functionality the Cog provides:

Create a new user event.
Delete user event.
Schedule a user event.
Cancel scheduled user event.
Open/Close user events voice channel.
Announce during event start by tagging all event subscribers.
Modify user event description.

How does this work?

Whenever a new user event is created, it will be listed in a new channel called #user-events-list (name can be flexible). This channel is used to display all the user events and also show their status such as:
- Scheduled on DateTime in readable format
- Not Scheduled
- Live
The event message ID will be stored in the site DB for further usage.
Users will be able to subscribe to the event by reacting to the ✔️ reaction on the message.
When the user event is scheduled, the status in the event message is edited.

Also, another message is sent in the #user-event-announcement channel, like the one below:

30min before the event start time, the organizer is given the ongoing role and has access to commands to open/close the user event voice channel and also the announce command.

Conditions

2 Events with the same name cannot exist.
An organizer cannot have multiple events scheduled.
No two events can overlap (in terms of time).
There must be a minimum of 30min gap between 2 scheduled events.

Note: All the above checks are handled by the site in form of validation checks, the bot just catches the ResponseCodeError exception.

Channels used

#use-events-list(need to be created)
#user-event-announcements
#user-event-coordinators(need to be created-not sure if its already present)

Roles used

Developers role(verified role)
user_event_coordinator
user_event_ongoing

…n up.

The user events cog file uses the channel and role IDs from the constants file

ks129

First batch of reviews

bot/exts/fun/user_events.py

ks129 · 2020-11-06T15:45:35Z

bot/exts/fun/user_events.py

+        if not self.check_if_user_is_organizer(ctx.author.id, event_name):
+            await ctx.send("You can only modify your events!")
+            return
+        data = {


Move this 1 key to call and don't assign it to variable.

…ser_events_management

coveralls · 2020-11-23T13:33:52Z

Coverage decreased (-0.5%) to 56.003% when pulling 6137d45 on RohanJnr:user_events_management into 7aec121 on python-discord:master.

ks129 · 2020-11-23T19:41:59Z

bot/exts/fun/user_events.py

+        self.user_event_coord_channel = None
+        self.user_event_announcement_channel = None
+        self.user_events_list_channel = None
+        self.user_event_voice_channel = None
+
+        # Load required roles.
+        self.developers_role = None
+        self.user_event_ongoing_role = None


This is place where adding type hint to variable is good.

ks129 · 2020-11-23T19:46:12Z

bot/exts/fun/user_events.py

+        self.user_event_coord_channel = self.bot.get_channel(Channels.user_event_coordinators)
+        self.user_event_announcement_channel = self.bot.get_channel(Channels.user_event_announcements)
+        self.user_events_list_channel = self.bot.get_channel(Channels.user_event_list)
+        self.user_event_voice_channel = self.bot.get_channel(Channels.user_event_voice)
+
+        # Load required roles.
+        self.developers_role = self.guild.get_role(Roles.verified)
+        self.user_event_ongoing_role = self.guild.get_role(Roles.user_event_ongoing)


Use here get or fetch pattern. When some channel/role is not found, this should unload cog and show warning about it, because everything is required there. Also, use asyncio.Event to wait for items loading.

Discordpy does not provide the fetch method for channels.
I am going for the following pattern:

using properties like before

add a custom property decorator that caches the value and unloads the cog if the property value is None.

discord.py have fetch_channel method.

oh, right, how did I miss that.

what if I check if get_channel or get_role returns None, then I unload the cog with appropriate logging instead of fetch_channel raising an error and unloading the cog?

We must be ready that channels or role(s) is not in cache, so we need to fetch them.

Xithrius · 2020-12-20T05:23:40Z

bot/exts/fun/user_events.py

+}
+
+NOT_SCHEDULED = "Not scheduled"
+LIVE = "Live"


Why is this a constant, if it's only used once?

These strings had getter functions before, I asked moving them from functions to constants.

Xithrius · 2021-02-25T08:55:09Z

Current state of this PR: Organization Issue.

@janine9vn what would you like to do with this PR? I believe you had some suggestions/plans?

janine9vn · 2021-05-20T19:26:33Z

I've chatted with @RohanJnr about converting this code for a different but very similar purpose. He'll be using a new branch and PR but has requested this stay open for a bit longer to reference some implementation details.

Xithrius · 2021-05-20T20:44:49Z

@janine9vn Thank you for the update.

Xithrius · 2021-06-04T15:31:48Z

@RohanJnr do you still need this PR to exist?

RohanJnr · 2021-06-06T06:35:56Z

Closing this as a new one will be opened for #1603 .

RohanJnr added 5 commits November 2, 2020 09:51

Add UserEvents cog for managing/scheduling user events.

32b4f68

Add methods for various statuses

b0e0753

Add method to check if user is event organizer.

6a40986

Add method to modify event description.

a0515ff

Code cleanup, and renaming functions.

5a6cd83

RohanJnr mentioned this pull request Nov 4, 2020

User events management python-discord/site#410

Closed

RohanJnr and others added 12 commits November 5, 2020 01:34

fix bug: coroutine was never awaited.

0991043

More checks to error handler and fix bugs.

4591781

Replace command checks with a single cog check.

4f57675

Improve docs, bot responses and code.

87ed463

Merge branch 'master' into user_events_management

26d4635

Move channel check to cog_check() method.

a5efff0

Remove embed footer config done in user_event_embed() method and clea…

4aaae7e

…n up.

Update config and constants to house required role and channel IDs.

d815215

The user events cog file uses the channel and role IDs from the constants file

Improve event scheduled message.

867c554

Add comments for better code clarity.

375e8ae

Add bot responses after command execution.

2158228

Simplify code.

73174ad

RohanJnr force-pushed the user_events_management branch from f642bdb to 73174ad Compare November 6, 2020 15:12

RohanJnr marked this pull request as ready for review November 6, 2020 15:21

RohanJnr requested a review from a team as a code owner November 6, 2020 15:21

RohanJnr requested review from kosayoda and lemonsaurus and removed request for a team November 6, 2020 15:21

ghost added the needs 2 approvals label Nov 6, 2020

ks129 requested changes Nov 6, 2020

View reviewed changes

ghost added s: waiting for author Waiting for author to address a review or respond to a comment and removed needs 2 approvals labels Nov 6, 2020

Add user_event_list and user_event_coordinators channel ID to config.

8b6b6a3

ghost removed the s: waiting for author Waiting for author to address a review or respond to a comment label Nov 6, 2020

ghost added s: waiting for author Waiting for author to address a review or respond to a comment and removed needs 2 approvals labels Nov 14, 2020

RohanJnr added 2 commits November 21, 2020 23:25

Remove redundant status methods.

ec45fcf

Normalize usage of update_user_event_message() method.

f06c52c

ghost added needs 2 approvals and removed s: waiting for author Waiting for author to address a review or respond to a comment labels Nov 21, 2020

RohanJnr added 3 commits November 22, 2020 22:26

Merge branch 'master' of https://github.com/python-discord/bot into u…

e188518

…ser_events_management

Load discord guild, channel and role objects in __init__() method.

9829c87

Fix lint errors.

4ba3fc1

RohanJnr requested a review from ks129 November 23, 2020 15:24

ks129 requested changes Nov 23, 2020

View reviewed changes

ghost added s: waiting for author Waiting for author to address a review or respond to a comment and removed needs 2 approvals labels Nov 23, 2020

Xithrius reviewed Dec 20, 2020

View reviewed changes

Merge branch 'master' into user_events_management

6137d45

Xithrius added a: backend Related to internal functionality and utilities (error_handler, logging, security, utils and core) p: 3 - low Low Priority t: feature New feature or request labels Feb 25, 2021

Xithrius added s: deferred Will be done at a later time and removed s: waiting for author Waiting for author to address a review or respond to a comment labels Feb 25, 2021

Base automatically changed from master to main March 13, 2021 19:40

janine9vn mentioned this pull request May 20, 2021

Small Event Management System #1603

Closed

RohanJnr closed this Jun 6, 2021

hedyhli mentioned this pull request Mar 23, 2024

Event scheduling system python-discord/site#1269

Open

Uh oh!

User Events Management system #1269

User Events Management system #1269

Uh oh!

Conversation

RohanJnr commented Nov 2, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Commands/Functionality the Cog provides:

How does this work?

Conditions

Channels used

Roles used

Uh oh!

ks129 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

coveralls commented Nov 23, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Xithrius commented Feb 25, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

janine9vn commented May 20, 2021

Uh oh!

Xithrius commented May 20, 2021

Uh oh!

Xithrius commented Jun 4, 2021

Uh oh!

RohanJnr commented Jun 6, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

RohanJnr commented Nov 2, 2020 •

edited

Loading

coveralls commented Nov 23, 2020 •

edited

Loading

Xithrius commented Feb 25, 2021 •

edited

Loading