Code quality cleanups

Author: Kile

.gitignore

@@ -1,6 +1,9 @@
 # Env file
 .env
 
+# SonarQube scan config
+.scannerwork/
+
 # VSCode config
 .vscode/
 

api/Dockerfile

@@ -1,6 +1,9 @@
 # Use an official Rust runtime as a parent image
 FROM rust:1.78 AS base
 
+ARG MYUID=1000
+ARG MYGID=1000
+
 # Set the working directory in the container
 WORKDIR /app
 
@@ -14,20 +17,30 @@ WORKDIR /app/api
 # Runs in development and production on port 8000 (in the container)
 EXPOSE 8000
 
-FROM base as prod
+FROM base AS prod
 
 # Build the Rust application
 RUN cargo build --release
 
+# Create a user and group to run the application
+RUN groupadd -g "${MYGID}" api \
+  && useradd --create-home --no-log-init -u "${MYUID}" -g "${MYGID}" api
+USER api
+
 # Set the binary as the entrypoint
 CMD ["./target/release/api"]
 
 # run without release flag for development
-FROM base as dev
+FROM base AS dev
 
 # Build the Rust application no cache
 RUN cargo build
 
+# Create a user and group to run the application
+RUN groupadd -g "${MYGID}" api \
+  && useradd --create-home --no-log-init -u "${MYUID}" -g "${MYGID}" api
+USER api
+
 # Set the binary as the entrypoint
 CMD ["./target/debug/api"]
 

docker-compose.yaml

@@ -14,6 +14,9 @@ services:
     build:
       context: "./zmq_proxy"
       target: ${MODE:-prod} # dev/prod
+      args:
+        - "MYUID=${MYUID:-1000}"
+        - "MYGID=${MYGID:-1000}"
     environment:
       - ZMQ_CLIENT_ADDRESS=tcp://*:5559
       - ZMQ_SERVER_ADDRESS=tcp://*:5560
@@ -26,6 +29,9 @@ services:
       context: ./
       dockerfile: ./api/Dockerfile
       target: ${MODE:-prod} # dev/prod
+      args:
+        - "MYUID=${MYUID:-1000}"
+        - "MYGID=${MYGID:-1000}"
     container_name: rust_api
     ports:
       - "6060:7650"
@@ -44,6 +50,9 @@ services:
       context: ./
       dockerfile: ./killua/Dockerfile
       target: ${MODE:-prod} # dev/prod
+      args:
+        - "MYUID=${MYUID:-1000}"
+        - "MYGID=${MYGID:-1000}"
     container_name: python_bot
     restart: unless-stopped
     environment:

killua/Dockerfile

@@ -1,6 +1,9 @@
 # Use an official Python runtime as a parent image
 FROM python:3.9-slim AS base
 
+ARG MYUID=1000
+ARG MYGID=1000
+
 # Set the working directory in the container
 WORKDIR /app
 
@@ -21,14 +24,25 @@ RUN apt-get update && apt-get install -y git
 # Install C++ cause a dependency needs it
 RUN apt-get install -y g++
 
+# Clean up the cache
+RUN apt-get clean
+
 # Upgrade pip
 RUN pip3 install --no-cache-dir --upgrade pip
 
 # Install any needed packages specified in requirements.txt
 RUN pip3 install --no-cache-dir -r requirements.txt
 
 FROM base AS dev
+# Create a user and group to run the application
+RUN groupadd -g "${MYGID}" python \
+&& useradd --create-home --no-log-init -u "${MYUID}" -g "${MYGID}" python
+USER python
 CMD ["python3", "-m", "killua", "--development", "--docker"]
 
-FROM base as prod
+FROM base AS prod
+# Create a user and group to run the application
+RUN groupadd -g "${MYGID}" python \
+&& useradd --create-home --no-log-init -u "${MYUID}" -g "${MYGID}" python
+USER python
 CMD ["python3", "-m", "killua", "--docker"]

killua/bot.py

@@ -13,7 +13,7 @@
 from logging import info
 from inspect import signature, Parameter
 from functools import partial
-from typing import Coroutine, Union, Dict, List, Optional
+from typing import Coroutine, Union, Dict, List, Optional, Tuple
 
 from .migrate import migrate_requiring_bot
 from .static.enums import Category
@@ -48,6 +48,10 @@ async def get_prefix(bot: "BaseBot", message: discord.Message):
         # in case message.guild is `None` or something went wrong getting the prefix the bot still NEEDS to react to mentions and k!
         return commands.when_mentioned_or("k!")(bot, message)
 
+class KilluaAPIException(Exception):
+    """Raised when the Killua API returns an error"""
+    def __init__(self, message: str):
+        self.message = message
 
 class BaseBot(commands.AutoShardedBot):
     def __init__(self, *args, **kwargs):
@@ -342,6 +346,67 @@ async def callback(
 
         return callback
 
+    async def _get_text_response_modal(
+        self, 
+        ctx: commands.Context, 
+        text: str, 
+        timeout: int = None, 
+        timeout_message: str = None, 
+        interaction: discord.Interaction = None, 
+        *args, 
+        **kwargs
+    ) -> Union[str, None]:
+        """Gets a response from a textinput UI"""
+        modal = Modal(title="Answer the question and click submit", timeout=timeout)
+        textinput = discord.ui.TextInput(label=text, *args, **kwargs)
+        modal.add_item(textinput)
+
+        if interaction:
+            await interaction.response.send_modal(modal)
+        else:
+            await ctx.interaction.response.send_modal(modal)
+
+        await modal.wait()
+        if modal.timed_out:
+            if timeout_message:
+                await ctx.send(timeout_message, delete_after=5)
+            return
+        await modal.interaction.response.defer()
+        return textinput.value
+    
+    async def _get_text_response_message(
+            self,
+            ctx: commands.Context,
+            text: str,
+            timeout: int = None,
+            timeout_message: str = None,
+            *args,
+            **kwargs,
+    ) -> Union[str, None]:
+        """Gets a response by waiting a message sent by the user"""
+        def check(m: discord.Message):
+            return m.author.id == ctx.author.id
+
+        msg = await ctx.send(text)
+        try:
+            confirm_msg: discord.Message = await self.wait_for(
+                "message", check=check, timeout=timeout
+            )
+        except asyncio.TimeoutError:
+            if timeout_message:
+                await ctx.send(timeout_message, delete_after=5)
+            res = None
+        else:
+            res = confirm_msg.content
+
+        await msg.delete()
+        try:
+            await confirm_msg.delete()
+        except discord.Forbidden:
+            pass
+
+        return res
+
     async def get_text_response(
         self,
         ctx: commands.Context,
@@ -352,53 +417,45 @@ async def get_text_response(
         *args,
         **kwargs,
     ) -> Union[str, None]:
-        """Gets a reponse from either a textinput UI or by waiting for a response"""
+        """Gets a response from either a textinput UI or by waiting for a response"""
 
         if (ctx.interaction and not ctx.interaction.response.is_done()) or interaction:
-            modal = Modal(
-                title="Anser the question(s) and click submit", timeout=timeout
+            return await self._get_text_response_modal(
+                ctx, text, timeout, timeout_message, interaction, *args, **kwargs
             )
-            textinput = discord.ui.TextInput(label=text, *args, **kwargs)
-            modal.add_item(textinput)
-
-            if interaction:
-                await interaction.response.send_modal(modal)
-            else:
-                await ctx.interaction.response.send_modal(modal)
-
-            await modal.wait()
-            if modal.timed_out:
-                if timeout_message:
-                    await ctx.send(timeout_message, delete_after=5)
-                return
-            await modal.interaction.response.defer()
-
-            return textinput.value
-
         else:
+            return await self._get_text_response_message(
+                ctx, text, timeout, timeout_message, *args, **kwargs
+            )
 
-            def check(m: discord.Message):
-                return m.author.id == ctx.author.id
+    async def make_embed_from_api(
+            self, 
+            image_url: str, 
+            embed: discord.Embed
+        ) -> Tuple[discord.Embed, Optional[discord.File]]:
+        """
+        Makes an embed from a Killua API image url.
 
-            msg = await ctx.send(text)
-            try:
-                confirmmsg: discord.Message = await self.wait_for(
-                    "message", check=check, timeout=timeout
-                )
-            except asyncio.TimeoutError:
-                if timeout_message:
-                    await ctx.send(timeout_message, delete_after=5)
-                res = None
-            else:
-                res = confirmmsg.content
+        If the bot is running in a dev environment, the image is downloaded 
+        and sent as a file.
 
-            await msg.delete()
-            try:
-                await confirmmsg.delete()
-            except commands.Forbidden:
-                pass
+        Raises:
+            KilluaAPIException: If the Killua API returns an error
+        """
+        file = None
+        if self.is_dev:
+            # Upload the image as attachment instead
+            data = await self.session.get(image_url)
+            if data.status != 200:
+                raise KilluaAPIException(await data.text())
+            
+            extension = image_url.split(".")[-1]
+            embed.set_image(url=f"attachment://image.{extension}")
+            file = discord.File(BytesIO(await data.read()), f"image.{extension}")
+        else:
+            embed.set_image(url=image_url)
+        return embed, file
 
-            return res
 
     async def update_presence(self):
         status = await DB.const.find_one({"_id": "presence"})

killua/cogs/__init__.py

@@ -28,7 +28,7 @@
             continue
         if spec.loader is None:
             continue
-        module = spec.loader.load_module()
+        module = spec.loader.load_module(name)
         # Make it a global.
         globals()[name] = module
         # Put it in the list.