5 Commits
dev ... v0.1.0

Author SHA1 Message Date
b9aeaf5c86 Merge pull request 'v0.1.0' (#20) from dev into main
Reviewed-on: #20
2024-12-27 23:38:13 +02:00
6087349622 Merge pull request 'v0.1.0-rc.4' (#19) from dev into main
Reviewed-on: #19
2024-12-27 21:31:46 +02:00
3010dc02bc Merge pull request 'v0.1.0-rc.3' (#15) from dev into main
Reviewed-on: #15
2024-12-16 22:08:22 +02:00
4afcbc93d5 Merge pull request 'Fixed minor issues' (#6) from dev into main
Reviewed-on: #6
2024-06-23 13:14:08 +03:00
72ccaa04a4 Merge pull request 'v0.1.0-rc.1' (#5) from dev into main
Reviewed-on: #5
2024-06-23 13:06:12 +03:00
20 changed files with 163 additions and 515 deletions

View File

@@ -24,4 +24,4 @@ USER appuser
COPY . . COPY . .
ENTRYPOINT ["python", "main.py", "--migrate"] ENTRYPOINT ["python", "main.py"]

View File

@@ -30,27 +30,9 @@
3. Clone the repository: 3. Clone the repository:
`git clone https://git.end-play.xyz/HoloUA/Discord.git` `git clone https://git.end-play.xyz/HoloUA/Discord.git`
4. `cd Discord` 4. `cd Discord`
5. Create a virtual environment: 5. Install dependencies:
`python -m venv .venv` or `virtualenv .venv`
6. Activate the virtual environment:
Windows: `.venv\Scripts\activate.bat`
Linux/macOS: `.venv/bin/activate`
7. Install the dependencies:
`python -m pip install -r requirements.txt` `python -m pip install -r requirements.txt`
8. Run the bot with `python main.py` after completing the [configuration](#Configuration) 6. Run the bot with `python main.py` after completing the [configuration](#Configuration)
## Upgrading with Git
1. Go to the bot's directory
2. `git pull`
3. Activate the virtual environment:
Windows: `.venv\Scripts\activate.bat`
Linux/macOS: `.venv/bin/activate`
4. Update the dependencies:
`python -m pip install -r requirements.txt`
5. First start after the upgrade must initiate the migration:
`python main.py --migrate`
6. Now the bot is up to date and the next run will not require `--migrate` anymore
## Configuration ## Configuration
@@ -73,34 +55,6 @@ Mandatory keys to modify:
After all of that you're good to go! Happy using :) After all of that you're good to go! Happy using :)
## Caching
Although general database access speed is fast, caching might become helpful for
bigger servers with many bot interactions. Currently, Redis and Memcached are supported.
Configuration happens through the config key `caching`.
Set `caching.type` to the service of you choice ("redis" or "memcached") and then update
the URI to access the service. It's Redis' default URI format for Redis and "address:port"
for Memcached.
Which one should I choose?
| Service | Read/write speed | Config flexibility |
|-----------|------------------|--------------------|
| Redis | High | Very flexible |
| Memcached | Very high | Basic |
> Performance difference between Redis and Memcached is generally quite low, so your setup
> should normally depend more on the configuration flexibility than on raw speed.
## Debugging
There's a config key `debug` that can be set to `true` for debugging purposes.
It should be set to `false` in production, otherwise log becomes very verbose and might
contain data that shouldn't normally be logged.
## Docker [Experimental] ## Docker [Experimental]
As an experiment, Docker deployment option has been added. As an experiment, Docker deployment option has been added.

View File

View File

@@ -1,28 +1,6 @@
import logging
from logging import Logger
from typing import Literal
from libbot.cache.classes import CacheMemcached, CacheRedis
from libbot.cache.manager import create_cache_client
from libbot.pycord.classes import PycordBot from libbot.pycord.classes import PycordBot
logger: Logger = logging.getLogger(__name__)
class HoloBot(PycordBot): class HoloBot(PycordBot):
cache: CacheMemcached | CacheRedis | None = None
def __init__(self, *args, **kwargs): def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs) super().__init__(*args, **kwargs)
self._set_cache_engine()
def _set_cache_engine(self) -> None:
cache_type: Literal["redis", "memcached"] | None = self.config["cache"]["type"]
if "cache" in self.config and cache_type is not None:
self.cache = create_cache_client(
self.config,
cache_type,
prefix=self.config["cache"][cache_type]["prefix"],
default_ttl_seconds=3600,
)

View File

@@ -1,84 +1,75 @@
import logging import logging
from logging import Logger from logging import Logger
from typing import Any, Dict, Optional from typing import Any, Dict
from bson import ObjectId from bson import ObjectId
from discord import User, Member from discord import User, Member
from libbot.cache.classes import Cache
from libbot.utils import config_get from libbot.utils import config_get
from pymongo.results import InsertOneResult
from errors import UserNotFoundError from errors import UserNotFoundError
from modules.database import col_users from modules.database import col_warnings, sync_col_users, sync_col_warnings, col_users
logger: Logger = logging.getLogger(__name__) logger: Logger = logging.getLogger(__name__)
class HoloUser: class HoloUser:
def __init__( def __init__(self, user: User | Member | int) -> None:
self,
_id: ObjectId,
id: int,
custom_role: int | None,
custom_channel: int | None,
) -> None:
self._id: ObjectId = _id
self.id: int = id
self.custom_role: int | None = custom_role
self.custom_channel: int | None = custom_channel
@classmethod
async def from_user(
cls,
user: User | Member,
allow_creation: bool = True,
cache: Optional[Cache] = None,
) -> "HoloUser":
"""Get an object that has a proper binding between Discord ID and database """Get an object that has a proper binding between Discord ID and database
### Args: ### Args:
* `user` (User | Member): Object from which an ID can be extracted * `user` (User | Member | int): Object from which ID can be extracted
* `allow_creation` (bool, optional): Whether to allow creation of a new user record if none found. Defaults to True.
* `cache` (Cache, optional): Cache engine to get the cache from
### Raises: ### Raises:
* `UserNotFoundError`: User with such ID does not seem to exist in database * `UserNotFoundError`: User with such ID does not seem to exist in database
""" """
if cache is not None:
cached_entry: Dict[str, Any] | None = cache.get_json(f"user_{user.id}")
if cached_entry is not None: self.id: int = user if not hasattr(user, "id") else user.id
return cls(**cached_entry)
db_entry: Dict[str, Any] | None = await col_users.find_one({"id": user.id}) jav_user: Dict[str, Any] | None = sync_col_users.find_one({"user": self.id})
if db_entry is None: if jav_user is None:
if not allow_creation: raise UserNotFoundError(user=user, user_id=self.id)
raise UserNotFoundError(user=user, user_id=user.id)
db_entry = HoloUser.get_defaults(user.id) self.db_id: ObjectId = jav_user["_id"]
insert_result: InsertOneResult = await col_users.insert_one(db_entry) self.customrole: int | None = jav_user["customrole"]
self.customchannel: int | None = jav_user["customchannel"]
self.warnings: int = self.warns()
db_entry["_id"] = insert_result.inserted_id def warns(self) -> int:
"""Get number of warnings user has
if cache is not None: ### Returns:
cache.set_json(f"user_{user.id}", db_entry) * `int`: Number of warnings
"""
warns: Dict[str, Any] | None = sync_col_warnings.find_one({"user": self.id})
return cls(**db_entry) return 0 if warns is None else warns["warns"]
@classmethod async def warn(self, count=1, reason: str = "Not provided") -> None:
async def from_id(cls, user_id: int) -> "HoloUser": """Warn and add count to warns number
raise NotImplementedError()
async def _set(self, key: str, value: Any, cache: Optional[Cache] = None) -> None: ### Args:
"""Set attribute data and save it into the database * `count` (int, optional): Count of warnings to be added. Defaults to 1.
"""
warns: Dict[str, Any] | None = await col_warnings.find_one({"user": self.id})
if warns is not None:
await col_warnings.update_one(
{"_id": self.db_id},
{"$set": {"warns": warns["warns"] + count}},
)
else:
await col_warnings.insert_one(document={"user": self.id, "warns": count})
logger.info("User %s was warned %s times due to: %s", self.id, count, reason)
async def set(self, key: str, value: Any) -> None:
"""Set attribute data and save it into database
### Args: ### Args:
* `key` (str): Attribute to be changed * `key` (str): Attribute to be changed
* `value` (Any): Value to set * `value` (Any): Value to set
* `cache` (Cache, optional): Cache engine to write the update into
""" """
if not hasattr(self, key): if not hasattr(self, key):
raise AttributeError() raise AttributeError()
@@ -86,102 +77,10 @@ class HoloUser:
setattr(self, key, value) setattr(self, key, value)
await col_users.update_one( await col_users.update_one(
{"_id": self._id}, {"$set": {key: value}}, upsert=True {"_id": self.db_id}, {"$set": {key: value}}, upsert=True
) )
self._update_cache(cache) logger.info("Set attribute %s of user %s to %s", key, self.id, value)
logger.info("Set attribute '%s' of user %s to '%s'", key, self.id, value)
async def _remove(self, key: str, cache: Optional[Cache] = None) -> None:
"""Remove attribute data and save it into the database
### Args:
* `key` (str): Attribute to be removed
* `cache` (Cache, optional): Cache engine to write the update into
"""
if not hasattr(self, key):
raise AttributeError()
default_value: Any = HoloUser.get_default_value(key)
setattr(self, key, default_value)
await col_users.update_one(
{"_id": self._id}, {"$set": {key: default_value}}, upsert=True
)
self._update_cache(cache)
logger.info("Removed attribute '%s' of user %s", key, self.id)
def _get_cache_key(self) -> str:
return f"user_{self.id}"
def _update_cache(self, cache: Optional[Cache] = None) -> None:
if cache is None:
return
user_dict: Dict[str, Any] = self._to_dict()
if user_dict is not None:
cache.set_json(self._get_cache_key(), user_dict)
else:
self._delete_cache(cache)
def _delete_cache(self, cache: Optional[Cache] = None) -> None:
if cache is None:
return
cache.delete(self._get_cache_key())
@staticmethod
def get_defaults(user_id: int | None = None) -> Dict[str, Any]:
return {
"id": user_id,
"custom_role": None,
"custom_channel": None,
}
@staticmethod
def get_default_value(key: str) -> Any:
if key not in HoloUser.get_defaults():
raise KeyError(f"There's no default value for key '{key}' in HoloUser")
return HoloUser.get_defaults()[key]
def _to_dict(self) -> Dict[str, Any]:
return {
"_id": self._id,
"id": self.id,
"custom_role": self.custom_role,
"custom_channel": self.custom_channel,
}
async def set_custom_channel(
self, channel_id: int, cache: Optional[Cache] = None
) -> None:
await self._set("custom_channel", channel_id, cache=cache)
async def set_custom_role(
self, role_id: int, cache: Optional[Cache] = None
) -> None:
await self._set("custom_role", role_id, cache=cache)
async def remove_custom_channel(self, cache: Optional[Cache] = None) -> None:
await self._remove("custom_channel", cache=cache)
async def remove_custom_role(self, cache: Optional[Cache] = None) -> None:
await self._remove("custom_role", cache=cache)
async def purge(self, cache: Optional[Cache] = None) -> None:
"""Completely remove user data from database. Only removes the user record from users collection.
### Args:
* `cache` (Cache, optional): Cache engine to write the update into
"""
await col_users.delete_one({"_id": self._id})
self._delete_cache(cache)
@staticmethod @staticmethod
async def is_moderator(member: User | Member) -> bool: async def is_moderator(member: User | Member) -> bool:

View File

@@ -56,7 +56,7 @@ class Analytics(commands.Cog):
# Insert entry into the database # Insert entry into the database
await col_analytics.insert_one( await col_analytics.insert_one(
{ {
"user_id": message.author.id, "user": message.author.id,
"channel": message.channel.id, "channel": message.channel.id,
"content": message.content, "content": message.content,
"stickers": stickers, "stickers": stickers,

View File

@@ -25,7 +25,7 @@ class CustomChannels(commands.Cog):
@commands.Cog.listener() @commands.Cog.listener()
async def on_guild_channel_delete(self, channel: GuildChannel) -> None: async def on_guild_channel_delete(self, channel: GuildChannel) -> None:
await col_users.find_one_and_update( await col_users.find_one_and_update(
{"custom_channel": channel.id}, {"$set": {"custom_channel": None}} {"customchannel": channel.id}, {"$set": {"customchannel": None}}
) )
custom_channel_group: SlashCommandGroup = SlashCommandGroup( custom_channel_group: SlashCommandGroup = SlashCommandGroup(
@@ -47,9 +47,7 @@ class CustomChannels(commands.Cog):
Command to create a custom channel for a user. Command to create a custom channel for a user.
""" """
holo_user_ctx: HoloUser = await HoloUser.from_user( holo_user_ctx: HoloUser = HoloUser(ctx.user)
ctx.user, cache=self.client.cache
)
# Return if the user is using the command outside of a guild # Return if the user is using the command outside of a guild
if not hasattr(ctx.author, "guild"): if not hasattr(ctx.author, "guild"):
@@ -64,7 +62,7 @@ class CustomChannels(commands.Cog):
return return
# Return if the user already has a custom channel # Return if the user already has a custom channel
if holo_user_ctx.custom_channel is not None: if holo_user_ctx.customchannel is not None:
await ctx.defer(ephemeral=True) await ctx.defer(ephemeral=True)
await ctx.respond( await ctx.respond(
embed=Embed( embed=Embed(
@@ -82,7 +80,7 @@ class CustomChannels(commands.Cog):
reason=f"Користувач {guild_name(ctx.user)} отримав власний приватний канал", reason=f"Користувач {guild_name(ctx.user)} отримав власний приватний канал",
category=ds_utils.get( category=ds_utils.get(
ctx.author.guild.categories, ctx.author.guild.categories,
id=await config_get("custom_channels", "categories"), id=await config_get("customchannels", "categories"),
), ),
) )
@@ -102,9 +100,7 @@ class CustomChannels(commands.Cog):
manage_channels=True, manage_channels=True,
) )
await holo_user_ctx.set_custom_channel( await holo_user_ctx.set("customchannel", created_channel.id)
created_channel.id, cache=self.client.cache
)
await ctx.respond( await ctx.respond(
embed=Embed( embed=Embed(
@@ -140,12 +136,10 @@ class CustomChannels(commands.Cog):
Command to change properties of a custom channel. Command to change properties of a custom channel.
""" """
holo_user_ctx: HoloUser = await HoloUser.from_user( holo_user_ctx: HoloUser = HoloUser(ctx.user)
ctx.user, cache=self.client.cache
)
custom_channel: TextChannel | None = ds_utils.get( custom_channel: TextChannel | None = ds_utils.get(
ctx.guild.channels, id=holo_user_ctx.custom_channel ctx.guild.channels, id=holo_user_ctx.customchannel
) )
# Return if the channel was not found # Return if the channel was not found
@@ -188,12 +182,10 @@ class CustomChannels(commands.Cog):
"""Command /customchannel remove [<confirm>] """Command /customchannel remove [<confirm>]
Command to remove a custom channel. Requires additional confirmation.""" Command to remove a custom channel. Requires additional confirmation."""
holo_user_ctx: HoloUser = await HoloUser.from_user( holo_user_ctx: HoloUser = HoloUser(ctx.user)
ctx.user, cache=self.client.cache
)
# Return if the user does not have a custom channel # Return if the user does not have a custom channel
if holo_user_ctx.custom_channel is None: if holo_user_ctx.customchannel is None:
await ctx.defer(ephemeral=True) await ctx.defer(ephemeral=True)
await ctx.respond( await ctx.respond(
embed=Embed( embed=Embed(
@@ -207,7 +199,7 @@ class CustomChannels(commands.Cog):
await ctx.defer() await ctx.defer()
custom_channel: TextChannel | None = ds_utils.get( custom_channel: TextChannel | None = ds_utils.get(
ctx.guild.channels, id=holo_user_ctx.custom_channel ctx.guild.channels, id=holo_user_ctx.customchannel
) )
# Return if the channel was not found # Return if the channel was not found
@@ -219,7 +211,7 @@ class CustomChannels(commands.Cog):
color=Color.FAIL, color=Color.FAIL,
) )
) )
await holo_user_ctx.remove_custom_channel(cache=self.client.cache) await holo_user_ctx.set("customchannel", None)
return return
# Return if the confirmation is missing # Return if the confirmation is missing
@@ -235,7 +227,7 @@ class CustomChannels(commands.Cog):
await custom_channel.delete(reason="Власник запросив видалення") await custom_channel.delete(reason="Власник запросив видалення")
await holo_user_ctx.remove_custom_channel(cache=self.client.cache) await holo_user_ctx.set("customchannel", None)
try: try:
await ctx.respond( await ctx.respond(

View File

@@ -14,6 +14,7 @@ from libbot.utils import config_get, json_write
from classes.holo_bot import HoloBot from classes.holo_bot import HoloBot
from classes.holo_user import HoloUser from classes.holo_user import HoloUser
from enums import Color from enums import Color
from modules.database import col_users
from modules.utils_sync import guild_name from modules.utils_sync import guild_name
logger: Logger = logging.getLogger(__name__) logger: Logger = logging.getLogger(__name__)
@@ -89,19 +90,17 @@ class Data(commands.Cog):
{ {
"id": member.id, "id": member.id,
"nick": member.nick, "nick": member.nick,
"username": member.name, "username": f"{member.name}#{member.discriminator}",
"bot": member.bot, "bot": member.bot,
} }
) )
# Temporary file must be written synchronously, # Temporary file must be written synchronously,
# otherwise it will not be there when ctx.respond() is be called # otherwise it will not be there when ctx.respond() is be called
# TODO Find a way to give this file to Pycord without FS operations
json_write(users, Path(f"tmp/{uuid}")) json_write(users, Path(f"tmp/{uuid}"))
await ctx.respond(file=File(Path(f"tmp/{uuid}"), filename="users.json")) await ctx.respond(file=File(Path(f"tmp/{uuid}"), filename="users.json"))
# TODO Deprecate this command
@data.command( @data.command(
name="migrate", name="migrate",
description="Мігрувати всіх користувачів до бази", description="Мігрувати всіх користувачів до бази",
@@ -165,7 +164,20 @@ class Data(commands.Cog):
if member.bot: if member.bot:
continue continue
await HoloUser.from_user(member, cache=self.client.cache) if (await col_users.find_one({"user": member.id})) is None:
user: Dict[str, Any] = {}
defaults: Dict[str, Any] = await config_get("user", "defaults")
user["user"] = member.id
for key in defaults:
user[key] = defaults[key]
await col_users.insert_one(document=user)
logging.info(
"Added DB record for user %s during migration", member.id
)
await ctx.respond( await ctx.respond(
embed=Embed( embed=Embed(

View File

@@ -1,5 +1,6 @@
import logging import logging
from logging import Logger from logging import Logger
from typing import Dict, Any
from discord import Member, Message, TextChannel, MessageType from discord import Member, Message, TextChannel, MessageType
from discord import utils as ds_utils from discord import utils as ds_utils
@@ -7,7 +8,6 @@ from discord.ext import commands
from libbot.utils import config_get from libbot.utils import config_get
from classes.holo_bot import HoloBot from classes.holo_bot import HoloBot
from classes.holo_user import HoloUser
from modules.database import col_users from modules.database import col_users
logger: Logger = logging.getLogger(__name__) logger: Logger = logging.getLogger(__name__)
@@ -25,13 +25,22 @@ class Logger(commands.Cog):
and (message.author.bot is False) and (message.author.bot is False)
and (message.author.system is False) and (message.author.system is False)
): ):
await HoloUser.from_user(message.author, cache=self.client.cache) if (await col_users.find_one({"user": message.author.id})) is None:
user: Dict[str, Any] = {}
defaults: Dict[str, Any] = await config_get("user", "defaults")
user["user"] = message.author.id
for key in defaults:
user[key] = defaults[key]
await col_users.insert_one(document=user)
if ( if (
(message.type == MessageType.thread_created) (message.type == MessageType.thread_created)
and (message.channel is not None) and (message.channel is not None)
and ( and (
await col_users.count_documents({"custom_channel": message.channel.id}) await col_users.count_documents({"customchannel": message.channel.id})
> 0 > 0
) )
): ):
@@ -60,21 +69,30 @@ class Logger(commands.Cog):
id=await config_get("rules", "channels", "text"), id=await config_get("rules", "channels", "text"),
) )
if welcome_chan is None:
logger.warning("Could not find a welcome channel by its id")
if ( if (
(member != self.client.user) (member != self.client.user)
and (member.bot is False) and (member.bot is False)
and (member.system is False) and (member.system is False)
): ):
if welcome_chan is not None and rules_chan is not None: await welcome_chan.send(
await welcome_chan.send( content=(await config_get("welcome", "messages")).format(
content=(await config_get("welcome", "messages")).format( mention=member.mention, rules=rules_chan.mention
mention=member.mention, rules=rules_chan.mention
)
) )
else: )
logger.warning("Could not find a welcome and/or rules channel by id")
await HoloUser.from_user(member, cache=self.client.cache) if (await col_users.find_one({"user": member.id})) is None:
user: Dict[str, Any] = {}
defaults: Dict[str, Any] = await config_get("user", "defaults")
user["user"] = member.id
for key in defaults:
user[key] = defaults[key]
await col_users.insert_one(document=user)
def setup(client: HoloBot) -> None: def setup(client: HoloBot) -> None:

View File

@@ -22,24 +22,18 @@
"port": 27017, "port": 27017,
"name": "holo_discord" "name": "holo_discord"
}, },
"cache": {
"type": null,
"memcached": {
"uri": "127.0.0.1:11211",
"prefix": null
},
"redis": {
"uri": "redis://127.0.0.1:6379/0",
"prefix": null
}
},
"logging": { "logging": {
"size": 512, "size": 512,
"location": "logs" "location": "logs"
}, },
"defaults": {}, "defaults": {
"user": {
"customrole": null,
"customchannel": null
}
},
"categories": { "categories": {
"custom_channels": 0 "customchannels": 0
}, },
"channels": { "channels": {
"text": { "text": {

41
main.py
View File

@@ -1,7 +1,5 @@
import contextlib
import logging import logging
import sys import sys
from argparse import ArgumentParser
from logging import Logger from logging import Logger
from pathlib import Path from pathlib import Path
@@ -9,49 +7,30 @@ from discord import LoginFailure, Intents
from libbot.utils import config_get from libbot.utils import config_get
from classes.holo_bot import HoloBot from classes.holo_bot import HoloBot
from modules.migrator import migrate_database
from modules.scheduler import scheduler from modules.scheduler import scheduler
if not Path("config.json").exists():
print(
"Config file is missing: Make sure the configuration file 'config.json' is in place.",
flush=True,
)
sys.exit()
logging.basicConfig( logging.basicConfig(
level=logging.INFO if not config_get("debug") else logging.DEBUG, level=logging.INFO,
format="%(name)s.%(funcName)s | %(levelname)s | %(message)s", format="%(name)s.%(funcName)s | %(levelname)s | %(message)s",
datefmt="[%X]", datefmt="[%X]",
) )
logger: Logger = logging.getLogger(__name__) logger: Logger = logging.getLogger(__name__)
# Declare the parser that retrieves the command line arguments try:
parser = ArgumentParser( import uvloop # type: ignore
prog="HoloUA Discord",
description="Discord bot for the HoloUA community.",
)
# Add a switch argument --migrate to be parsed...
parser.add_argument("--migrate", action="store_true")
# ...and parse the arguments we added
args = parser.parse_args()
# Try to import the module that improves performance
# and ignore errors when module is not installed
with contextlib.suppress(ImportError):
import uvloop
uvloop.install() uvloop.install()
except ImportError:
pass
def main() -> None: def main() -> None:
# Perform migration if command line argument was provided if not Path("config.json").exists():
if args.migrate: logger.error(
logger.info("Performing migrations...") "Config file is missing: Make sure the configuration file 'config.json' is in place."
migrate_database() )
sys.exit()
intents: Intents = Intents().all() intents: Intents = Intents().all()
client: HoloBot = HoloBot(intents=intents, scheduler=scheduler) client: HoloBot = HoloBot(intents=intents, scheduler=scheduler)

View File

@@ -1,79 +0,0 @@
import logging
from logging import Logger
from libbot.utils import config_get, config_set, config_delete
from mongodb_migrations.base import BaseMigration
logger: Logger = logging.getLogger(__name__)
class Migration(BaseMigration):
def upgrade(self):
try:
# Categories
config_set(
"custom_channels",
config_get("customchannels", "categories"),
"categories",
)
config_delete("customchannels", "categories")
# User defaults
config_delete(
"user",
"defaults",
)
except Exception as exc:
logger.error(
"Could not upgrade the config during migration '%s' due to: %s",
__name__,
exc,
)
self.db.users.update_many(
{"customchannel": {"$exists": True}},
{"$rename": {"customchannel": "custom_channel"}},
)
self.db.users.update_many(
{"customrole": {"$exists": True}},
{"$rename": {"customrole": "custom_role"}},
)
def downgrade(self):
try:
# Categories
config_set(
"customchannels",
config_get("custom_channels", "categories"),
"categories",
)
config_delete("custom_channels", "categories")
# User defaults
config_set(
"customrole",
None,
"defaults",
"user",
)
config_set(
"customchannel",
None,
"defaults",
"user",
)
except Exception as exc:
logger.error(
"Could not downgrade the config during migration '%s' due to: %s",
__name__,
exc,
)
self.db.users.update_many(
{"custom_channel": {"$exists": True}},
{"$rename": {"custom_channel": "customchannel"}},
)
self.db.users.update_many(
{"custom_role": {"$exists": True}},
{"$rename": {"custom_role": "customrole"}},
)

View File

@@ -1,63 +0,0 @@
import logging
from logging import Logger
from libbot.utils import config_set, config_delete
from mongodb_migrations.base import BaseMigration
logger: Logger = logging.getLogger(__name__)
class Migration(BaseMigration):
def upgrade(self):
try:
config_set(
"cache",
{
"type": None,
"memcached": {"uri": "127.0.0.1:11211"},
"redis": {"uri": "redis://127.0.0.1:6379/0"},
},
*[],
)
except Exception as exc:
logger.error(
"Could not upgrade the config during migration '%s' due to: %s",
__name__,
exc,
)
self.db.users.update_many(
{"user": {"$exists": True}},
{"$rename": {"user": "id"}},
)
self.db.analytics.update_many(
{"user": {"$exists": True}},
{"$rename": {"user": "user_id"}},
)
self.db.warnings.update_many(
{"user": {"$exists": True}},
{"$rename": {"user": "user_id"}},
)
def downgrade(self):
try:
config_delete("cache", *[])
except Exception as exc:
logger.error(
"Could not downgrade the config during migration '%s' due to: %s",
__name__,
exc,
)
self.db.users.update_many(
{"id": {"$exists": True}},
{"$rename": {"id": "user"}},
)
self.db.analytics.update_many(
{"user": {"$exists": True}},
{"$rename": {"user_id": "user"}},
)
self.db.warnings.update_many(
{"user": {"$exists": True}},
{"$rename": {"user_id": "user"}},
)

View File

@@ -1,31 +0,0 @@
import logging
from logging import Logger
from libbot.utils import config_set, config_delete
from mongodb_migrations.base import BaseMigration
logger: Logger = logging.getLogger(__name__)
class Migration(BaseMigration):
def upgrade(self):
try:
config_set("prefix", None, "cache", "memcached")
config_set("prefix", None, "cache", "redis")
except Exception as exc:
logger.error(
"Could not upgrade the config during migration '%s' due to: %s",
__name__,
exc,
)
def downgrade(self):
try:
config_delete("prefix", "cache", "redis")
config_delete("prefix", "cache", "memcached")
except Exception as exc:
logger.error(
"Could not downgrade the config during migration '%s' due to: %s",
__name__,
exc,
)

View File

@@ -2,6 +2,9 @@ from typing import Dict, Any
from async_pymongo import AsyncClient, AsyncCollection, AsyncDatabase from async_pymongo import AsyncClient, AsyncCollection, AsyncDatabase
from libbot.utils import config_get from libbot.utils import config_get
from pymongo import MongoClient
from pymongo.synchronous.collection import Collection
from pymongo.synchronous.database import Database
db_config: Dict[str, Any] = config_get("database") db_config: Dict[str, Any] = config_get("database")
@@ -20,12 +23,18 @@ con_string: str = (
) )
db_client: AsyncClient = AsyncClient(con_string) db_client: AsyncClient = AsyncClient(con_string)
db_client_sync: MongoClient = MongoClient(con_string)
# Async declarations per default # Async declarations per default
db: AsyncDatabase = db_client.get_database(name=db_config["name"]) db: AsyncDatabase = db_client.get_database(name=db_config["name"])
col_users: AsyncCollection = db.get_collection("users") col_users: AsyncCollection = db.get_collection("users")
col_warnings: AsyncCollection = db.get_collection("warnings")
col_analytics: AsyncCollection = db.get_collection("analytics") col_analytics: AsyncCollection = db.get_collection("analytics")
# Update indexes # Sync declarations as a fallback
db.dispatch.get_collection("users").create_index("id", unique=True) sync_db: Database = db_client_sync.get_database(name=db_config["name"])
sync_col_users: Collection = sync_db.get_collection("users")
sync_col_warnings: Collection = sync_db.get_collection("warnings")
sync_col_analytics: Collection = sync_db.get_collection("analytics")

View File

@@ -1,22 +0,0 @@
from typing import Any, Mapping
from libbot.utils import config_get
from mongodb_migrations.cli import MigrationManager
from mongodb_migrations.config import Configuration
def migrate_database() -> None:
"""Apply migrations from folder `migrations/` to the database"""
database_config: Mapping[str, Any] = config_get("database")
manager_config = Configuration(
{
"mongo_host": database_config["host"],
"mongo_port": database_config["port"],
"mongo_database": database_config["name"],
"mongo_username": database_config["user"],
"mongo_password": database_config["password"],
}
)
manager = MigrationManager(manager_config)
manager.run()

View File

@@ -5,9 +5,7 @@ requests>=2.32.2
aiofiles~=24.1.0 aiofiles~=24.1.0
apscheduler>=3.10.0 apscheduler>=3.10.0
async_pymongo==0.1.11 async_pymongo==0.1.11
libbot[speed,pycord,cache]==4.4.0 libbot[speed,pycord]==4.0.0
mongodb-migrations==1.3.1 typing-extensions~=4.12.2
pymemcache~=4.0.0 ujson~=5.10.0
redis~=6.4.0
ujson~=5.11.0
WaifuPicsPython==0.2.0 WaifuPicsPython==0.2.0

View File

@@ -1,14 +1,14 @@
{ {
"$jsonSchema": { "$jsonSchema": {
"required": [ "required": [
"user_id", "user",
"channel", "channel",
"content", "content",
"stickers", "stickers",
"attachments" "attachments"
], ],
"properties": { "properties": {
"user_id": { "user": {
"bsonType": "long", "bsonType": "long",
"description": "Discord ID of user" "description": "Discord ID of user"
}, },
@@ -17,10 +17,7 @@
"description": "Discord ID of a channel" "description": "Discord ID of a channel"
}, },
"content": { "content": {
"bsonType": [ "bsonType": ["null", "string"],
"null",
"string"
],
"description": "Text of the message" "description": "Text of the message"
}, },
"stickers": { "stickers": {
@@ -43,7 +40,7 @@
"format": { "format": {
"bsonType": "array" "bsonType": "array"
}, },
"user_id": { "user": {
"bsonType": "string" "bsonType": "string"
} }
} }

View File

@@ -1,27 +1,22 @@
{ {
"$jsonSchema": { "$jsonSchema": {
"required": [ "required": [
"id", "user",
"custom_role", "customrole",
"custom_channel" "customchannel"
], ],
"properties": { "properties": {
"id": { "user": {
"bsonType": "long", "bsonType": "long",
"description": "Discord ID of user" "description": "Discord ID of user"
}, },
"custom_role": { "customrole": {
"bsonType": [ "bsonType": ["null", "long"],
"null",
"long"
],
"description": "Discord ID of custom role or 'null' if not set" "description": "Discord ID of custom role or 'null' if not set"
}, },
"custom_channel": { "customchannel": {
"bsonType": [ "bsonType": ["null", "long"],
"null",
"long"
],
"description": "Discord ID of custom channel or 'null' if not set" "description": "Discord ID of custom channel or 'null' if not set"
} }
} }

18
validation/warnings.json Normal file
View File

@@ -0,0 +1,18 @@
{
"$jsonSchema": {
"required": [
"user",
"warns"
],
"properties": {
"user": {
"bsonType": "long",
"description": "Discord ID of user"
},
"warns": {
"bsonType": "int",
"description": "Number of warnings on count"
}
}
}
}