sh-edraft.de/sh_discord_bot
5
1
Fork 1
Code Issues 26 Pull Requests Actions Packages Projects 3 Releases 27 Wiki Activity

Improved feature-flags & fixed logging

Browse Source
This commit is contained in:
Sven Heidemann
2022-10-03 13:39:09 +02:00
parent 1c3ec3c7e7
commit 04e8e64003
25 changed files with 125 additions and 118 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
src/bot_core/abc/module_abc.py
View File

@@ -1,19 +1,20 @@
from abc import abstractmethod
from typing import Callable
from cpl_core.application import StartupExtensionABC
from cpl_discord.service.discord_collection_abc import DiscordCollectionABC
from bot_core.configuration.feature_flags_enum import FeatureFlagsEnum
class ModuleABC(StartupExtensionABC):
@abstractmethod
def __init__(self, dc: DiscordCollectionABC, feature_flag: Callable = None):
def __init__(self, dc: DiscordCollectionABC, feature_flag: FeatureFlagsEnum):
StartupExtensionABC.__init__(self)
self._dc = dc
self._feature_flag = feature_flag
@property
def feature_flag(self) -> Callable:
def feature_flag(self) -> FeatureFlagsEnum:
return self._feature_flag

17
src/bot_core/configuration/feature_flags_enum.py Normal file
View File

@@ -0,0 +1,17 @@
from enum import Enum
class FeatureFlagsEnum(Enum):
# modules
admin_module = 'AdminModule'
base_module = 'BaseModule'
boot_log_module = 'BootLogModule'
core_module = 'CoreModule'
core_extension_module = 'CoreExtensionModule'
data_module = 'DataModule',
database_module = 'DatabaseModule',
moderator_module = 'ModeratorModule'
permission_module = 'PermissionModule'
# features
presence = 'Presence'

72
src/bot_core/configuration/feature_flags_settings.py
View File

@@ -1,65 +1,47 @@
import traceback
from typing import Optional
from typing import Optional, Callable
from cpl_core.configuration.configuration_model_abc import ConfigurationModelABC
from cpl_core.console import Console
from bot_core.configuration.feature_flags_enum import FeatureFlagsEnum
class FeatureFlagsSettings(ConfigurationModelABC):
def __init__(self):
ConfigurationModelABC.__init__(self)
self._admin_module = False # 02.10.2022 #48
self._base_module = True # 02.10.2022 #48
self._boot_log_module = True # 02.10.2022 #48
self._database_module = True # 02.10.2022 #48
self._moderator_module = False # 02.10.2022 #48
self._permission_module = True # 02.10.2022 #48
self._flags = {
# modules
FeatureFlagsEnum.admin_module.value: False, # 02.10.2022 #48
FeatureFlagsEnum.base_module.value: True, # 02.10.2022 #48
FeatureFlagsEnum.boot_log_module.value: True, # 02.10.2022 #48
FeatureFlagsEnum.core_module.value: True, # 03.10.2022 #56
FeatureFlagsEnum.core_extension_module.value: True, # 03.10.2022 #56
FeatureFlagsEnum.data_module.value: True, # 03.10.2022 #56
FeatureFlagsEnum.database_module.value: True, # 02.10.2022 #48
FeatureFlagsEnum.moderator_module.value: False, # 02.10.2022 #48
FeatureFlagsEnum.permission_module.value: True, # 02.10.2022 #48
# features
FeatureFlagsEnum.presence.value: True, # 03.10.2022 #56
}
@property
def admin_module(self) -> bool:
return self._admin_module
def get_flag(self, key: FeatureFlagsEnum) -> bool:
if key.value not in self._flags:
return False
return self._flags[key.value]
@property
def base_module(self) -> bool:
return self._base_module
def _load_flag(self, settings: dict, key: FeatureFlagsEnum):
if key.value not in settings:
return
@property
def boot_log_module(self) -> bool:
return self._boot_log_module
@property
def database_module(self) -> bool:
return self._database_module
@property
def moderator_module(self) -> bool:
return self._moderator_module
@property
def permission_module(self) -> bool:
return self._permission_module
self._flags[key.value] = bool(settings[key.value])
def from_dict(self, settings: dict):
try:
if 'AdminModule' in settings:
self._admin_module = settings['AdminModule']
if 'BaseModule' in settings:
self._base_module = settings['BaseModule']
if 'BootLogModule' in settings:
self._boot_log_module = settings['BootLogModule']
if 'DatabaseModule' in settings:
self._database_module = settings['DatabaseModule']
if 'ModeratorModule' in settings:
self._moderator_module = settings['ModeratorModule']
if 'PermissionModule' in settings:
self._permission_module = settings['PermissionModule']
for flag in [f.value for f in FeatureFlagsEnum]:
self._load_flag(settings, FeatureFlagsEnum(flag))
except Exception as e:
Console.error(f'[ ERROR ] [ {__name__} ]: Reading error in {type(self).__name__} settings')
Console.error(f'[ EXCEPTION ] [ {__name__} ]: {e} -> {traceback.format_exc()}')

3
src/bot_core/core_extension/core_extension_module.py
View File

@@ -5,13 +5,14 @@ from cpl_discord.discord_event_types_enum import DiscordEventTypesEnum
from cpl_discord.service.discord_collection_abc import DiscordCollectionABC
from bot_core.abc.module_abc import ModuleABC
from bot_core.configuration.feature_flags_enum import FeatureFlagsEnum
from bot_core.core_extension.core_extension_on_ready_event import CoreExtensionOnReadyEvent
class CoreExtensionModule(ModuleABC):
def __init__(self, dc: DiscordCollectionABC):
ModuleABC.__init__(self, dc, lambda x: x.base_module)
ModuleABC.__init__(self, dc, FeatureFlagsEnum.core_extension_module)
def configure_configuration(self, config: ConfigurationABC, env: ApplicationEnvironmentABC):
pass

18
src/bot_core/core_module.py
View File

@@ -1,18 +1,14 @@
from cpl_core.configuration import ConfigurationABC
from cpl_core.dependency_injection import ServiceCollectionABC
from cpl_core.environment import ApplicationEnvironmentABC
from cpl_core.logging import LoggerABC
from cpl_discord.discord_event_types_enum import DiscordEventTypesEnum
from cpl_discord.service.discord_collection_abc import DiscordCollectionABC
from bot_core.abc.client_utils_service_abc import ClientUtilsServiceABC
from bot_core.abc.custom_file_logger_abc import CustomFileLoggerABC
from bot_core.abc.message_service_abc import MessageServiceABC
from bot_core.abc.module_abc import ModuleABC
from bot_core.configuration.feature_flags_enum import FeatureFlagsEnum
from bot_core.events.core_on_ready_event import CoreOnReadyEvent
from bot_core.logging.command_logger import CommandLogger
from bot_core.logging.database_logger import DatabaseLogger
from bot_core.logging.message_logger import MessageLogger
from bot_core.pipes.date_time_offset_pipe import DateTimeOffsetPipe
from bot_core.service.client_utils_service import ClientUtilsService
from bot_core.service.message_service import MessageService
@@ -21,17 +17,12 @@ from bot_core.service.message_service import MessageService
class CoreModule(ModuleABC):
def __init__(self, dc: DiscordCollectionABC):
ModuleABC.__init__(self, dc, lambda x: x.base_module)
ModuleABC.__init__(self, dc, FeatureFlagsEnum.core_module)
def configure_configuration(self, config: ConfigurationABC, env: ApplicationEnvironmentABC):
pass
def configure_services(self, services: ServiceCollectionABC, env: ApplicationEnvironmentABC):
# custom logging
services.add_singleton(CustomFileLoggerABC, CommandLogger)
services.add_singleton(CustomFileLoggerABC, DatabaseLogger)
services.add_singleton(CustomFileLoggerABC, MessageLogger)
services.add_transient(MessageServiceABC, MessageService)
services.add_transient(ClientUtilsServiceABC, ClientUtilsService)
@@ -39,8 +30,3 @@ class CoreModule(ModuleABC):
services.add_transient(DateTimeOffsetPipe)
self._dc.add_event(DiscordEventTypesEnum.on_ready.value, CoreOnReadyEvent)
provider = services.build_service_provider()
# instantiate custom logger
for c in CustomFileLoggerABC.__subclasses__():
i: LoggerABC = provider.get_service(c)

4
src/bot_core/events/core_on_ready_event.py
View File

@@ -1,5 +1,3 @@
import asyncio
from cpl_core.logging import LoggerABC
from cpl_discord.events import OnReadyABC
from cpl_discord.service import DiscordBotServiceABC
@@ -15,7 +13,7 @@ class CoreOnReadyEvent(OnReadyABC):
logger: LoggerABC,
bot: DiscordBotServiceABC,
client_utils: ClientUtilsServiceABC,
t: TranslatePipe
t: TranslatePipe,
):
OnReadyABC.__init__(self)

9
src/bot_core/service/client_utils_service.py
View File

@@ -9,6 +9,8 @@ from discord.ext.commands import Context
from bot_core.abc.client_utils_service_abc import ClientUtilsServiceABC
from bot_core.abc.message_service_abc import MessageServiceABC
from bot_core.configuration.feature_flags_enum import FeatureFlagsEnum
from bot_core.configuration.feature_flags_settings import FeatureFlagsSettings
from bot_data.abc.client_repository_abc import ClientRepositoryABC
from bot_data.abc.server_repository_abc import ServerRepositoryABC
@@ -24,7 +26,8 @@ class ClientUtilsService(ClientUtilsServiceABC):
clients: ClientRepositoryABC,
message_service: MessageServiceABC,
db: DatabaseContextABC,
t: TranslatePipe
t: TranslatePipe,
feature_flags: FeatureFlagsSettings
):
ClientUtilsServiceABC.__init__(self)
self._config = config
@@ -35,6 +38,7 @@ class ClientUtilsService(ClientUtilsServiceABC):
self._message_service = message_service
self._db = db
self._t = t
self._feature_flags = feature_flags
def received_command(self, guild_id: int):
server = self._servers.get_server_by_discord_id(guild_id)
@@ -64,6 +68,9 @@ class ClientUtilsService(ClientUtilsServiceABC):
return False
async def presence_game(self, t_key: str):
if not self._feature_flags.get_flag(FeatureFlagsEnum.presence):
return
import bot
name = self._t.transform(t_key).format(bot.__version__)
await self._bot.change_presence(activity=discord.Game(name=name))