Added a clash of code module by RedsTom · Pull Request #5 · adraug/Vesta

RedsTom · 2023-05-19T23:57:08Z

Object: Adding a module to be able to share a clash of code game with part or all a discord server

Clash of code module

Main features:

/clash-of-code [link] to share a game of clash of code
/config coc-role [role] to configure the role to be pinged when a game is shared
/config coc-channel [channel] to configure the channel where the ping message will be sent
Live update of the game's information

Technical features:

Checks for the validity of the link
Updates the announcement message even on restart thanks to vesta/services/clash_of_code_helper#resume_update_loops

Breaking changes:

The structure of the Guild table has been updated to add some more configuration

Technical changes:

Rework of the /config command to be able to add a configuration command more easily. Still needs some work, but in an other PR.
Added the requests module to the list of dependencies to be able to poll the Codingame API
Renamed lang to lang_file to avoid confusion between the lang.py file and the lang variable managing the translations

…ember and did not have permission to do so

…g the precised role and start a game, subject to a cooldown

…lement the command.

…for command, edited the way translations work to allow nesting, and worked more on the structure of the database

…he api, did not succeed yet, but I need to sleep sometimes so let's continue that tomorrow

…tyle issues, still need some work to get clean code =D

… up mess and globally made something clean. => Ready for review

RedsTom · 2023-05-19T23:57:55Z

Review requested:

Astremy

Don't put the lang changes in the same PR, don't do synchronous requests in an asynchronous bot, just use a foreign key to another table in the guild table, don't put _ in front of half of the functions... some other things

Astremy · 2023-05-20T09:35:18Z

vesta/commands/clash_of_code.py

+        return
+
+    try:
+        (game, game_id) = _get_game(link)


why some _ in the start of the function? That's not a library, and that's not some not-to-call methods of an object

Astremy · 2023-05-20T09:36:29Z

vesta/__init__.py

 from yaml import load, Loader
 with open("vesta/data/lang.yml") as file:
-    lang = Lang(load(file.read(), Loader), session_maker)
+    lang_file = Lang(load(file.read(), Loader), session_maker)


why letting the lang file named as "lang" and renaming the lang as "lang file"?

Ask @adraug

vesta/commands/clash_of_code.py

Astremy · 2023-05-20T09:38:58Z

vesta/commands/clash_of_code.py

+    start_update_loop(message=announcement_message, guild=interaction.guild)
+
+
+def _get_game(link: str):


don't put some _ in front of the function name, as said before

Astremy · 2023-05-20T09:48:39Z

vesta/commands/clash_of_code.py

+    return game, game_id
+
+
+def _get_guild_game(interaction: discord.Interaction) -> ClashOfCodeGuildGame:


if you have only one clash of code game per guild, maybe just use a foreign key in the guild table to a clash of code game

Astremy · 2023-05-20T10:11:41Z

vesta/services/clash_of_code_helper.py

+
+    :return: Nothing
+    """
+    from .. import session_maker, vesta_client


Weird imports place

If imported at the top of the file, creates a circular import, so it's a workaround that works to avoid it, needs more debugging to find where the circular import takes place

Astremy · 2023-05-20T10:15:30Z

vesta/services/clash_of_code_helper.py

+    :param guild: The guild to update the data for
+    :return: Nothing
+    """
+    from .. import session_maker


Same, weird imports

Same reason as above

Astremy · 2023-05-20T10:17:45Z

vesta/services/clash_of_code_helper.py

+
+            await asyncio.sleep(10)
+
+    asyncio.create_task(update_loop(fetched_game))


NO. Don't start a while True task for each one. If you want to do something like that properly, start one task, and use an updating queue. It will prevent any "oh it never actually finish for some weird reasons" problem

That's an absolutely must not

Should never happen because the API always ends the game at a moment

Will fix anyway

Astremy · 2023-05-20T10:19:00Z

vesta/tables/clash_of_code.py

+    __tablename__ = "clash_of_code_guild_game"
+
+    guild_id = db.Column(db.BigInteger, nullable=False, primary_key=True)
+    last_clash_id = db.Column(db.String(511), nullable=True)


Is there a need for a so long ID? verify the actual size before setting random values

Astremy · 2023-05-20T10:19:41Z

vesta/tables/clash_of_code.py

+
+session = session_maker()
+
+class ClashOfCodeGuildGame(Base):


Why is it not just "ClashOfCodeGame" if there is only one per guild?

As said maybe use a foreign key from guild to link it up

ClashOfCodeGame is already used to talk about the representation of an api object

RedsTom added 13 commits May 18, 2023 00:35

Fixed orthography and syntax

666c224

Fixed the multiple errors in console when the bot tried to update a m…

b085cfd

…ember and did not have permission to do so

Fixed lang

a48f76f

Started to add configuration for clash of code, with a command to pin…

f79c721

…g the precised role and start a game, subject to a cooldown

Started to work on the link with the codingame api and started to imp…

624a942

…lement the command.

Continued to work on the clash of code system, added errors and ping …

e141ba0

…for command, edited the way translations work to allow nesting, and worked more on the structure of the database

Revert changed made to lang.py

54476dc

Continued to fix bugs and implement the clash of code stuff

ff6e295

Enhanced some messages, tried to add a cron to check for updates on t…

d127906

…he api, did not succeed yet, but I need to sleep sometimes so let's continue that tomorrow

Fixed the bugs, working loop and resuming correctly, and fixed some s…

3df4875

…tyle issues, still need some work to get clean code =D

Removed the ranking as it is not used yet, and the unused methods

b91c8ae

Clarified messages, added some doc, added some more consistency

da1fd32

Fixed all the bugs, added some more information on the embed, cleaned…

065b1db

… up mess and globally made something clean. => Ready for review

RedsTom marked this pull request as ready for review May 19, 2023 23:57

Astremy requested changes May 20, 2023

View reviewed changes

		start_update_loop(message=announcement_message, guild=interaction.guild)


		def _get_game(link: str):

		return game, game_id


		def _get_guild_game(interaction: discord.Interaction) -> ClashOfCodeGuildGame:


		await asyncio.sleep(10)

		asyncio.create_task(update_loop(fetched_game)) No newline at end of file


		session = session_maker()

		class ClashOfCodeGuildGame(Base):

Comments

Conversation

RedsTom commented May 19, 2023

Clash of code module

Uh oh!

RedsTom commented May 19, 2023

Uh oh!

Astremy left a comment

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!

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!

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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants