feat: Phase 0 - Microservices Migration Foundation (#103)

Co-authored-by: Claude <[email protected]>
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>

Author: 3 people

.coveragerc

@@ -0,0 +1,37 @@
+# Coverage configuration file
+# This complements the pyproject.toml coverage settings
+
+[run]
+source =
+    byte_bot
+    packages/byte-common/src/byte_common
+omit =
+    */tests/*
+    */__init__.py
+    */migrations/*
+    */.venv/*
+    */site-packages/*
+branch = True
+parallel = True
+
+[report]
+precision = 2
+show_missing = True
+skip_covered = False
+exclude_lines =
+    pragma: no cover
+    if TYPE_CHECKING:
+    except ImportError as e:
+    except ImportError:
+    def __repr__
+    raise NotImplementedError
+    raise AssertionError
+    if __name__ == "__main__":
+    @abstractmethod
+    @abc.abstractmethod
+
+[html]
+directory = htmlcov
+
+[xml]
+output = coverage.xml

.pre-commit-config.yaml

@@ -3,12 +3,12 @@ default_language_version:
 default_install_hook_types: [commit-msg, pre-commit]
 repos:
   - repo: https://github.com/compilerla/conventional-pre-commit
-    rev: v4.2.0
+    rev: v4.3.0
     hooks:
       - id: conventional-pre-commit
         stages: [commit-msg]
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v5.0.0
+    rev: v6.0.0
     hooks:
       - id: check-ast
       - id: check-case-conflict
@@ -18,13 +18,13 @@ repos:
       - id: mixed-line-ending
       - id: trailing-whitespace
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: "v0.11.13"
+    rev: "v0.14.6"
     hooks:
       - id: ruff-check
         args: ["--fix"]
       - id: ruff-format
   - repo: https://github.com/sourcery-ai/sourcery
-    rev: v1.37.0
+    rev: v1.40.0
     hooks:
       - id: sourcery
         args: [--diff=git diff HEAD, --no-summary]
@@ -39,7 +39,7 @@ repos:
               .*\.json |.*\.svg |docs/changelog.rst
           )$
   - repo: https://github.com/asottile/blacken-docs
-    rev: 1.19.1
+    rev: 1.20.0
     hooks:
       - id: blacken-docs
   - repo: https://github.com/pre-commit/mirrors-prettier
@@ -88,7 +88,7 @@ repos:
   #             discord-py,
   #           ]
   - repo: https://github.com/RobertCraigie/pyright-python
-    rev: v1.1.402
+    rev: v1.1.407
     hooks:
       - id: pyright
         additional_dependencies:
@@ -144,6 +144,6 @@ repos:
             discord-py,
           ]
   - repo: https://github.com/sphinx-contrib/sphinx-lint
-    rev: "v1.0.0"
+    rev: "v1.0.2"
     hooks:
       - id: sphinx-lint

byte_bot/byte/lib/utils.py

@@ -107,7 +107,7 @@ def run_ruff_format(code: str) -> str:
     Returns:
         str: The formatted code.
     """
-    result = subprocess.run(  # noqa: S603
+    result = subprocess.run(
         ["ruff", "format", "-"],  # noqa: S607
         input=code,
         capture_output=True,

byte_bot/cli.py

@@ -33,7 +33,7 @@ def frontend() -> None:
     log.config.configure()
     logger.info("🎨 Starting Tailwind Compiler.")
     try:
-        subprocess.run(  # noqa: S603
+        subprocess.run(
             [  # noqa: S607
                 "tailwindcss",
                 "-i",
@@ -56,7 +56,7 @@ def bot() -> None:
     log.config.configure()
     logger.info("🤖 Starting Byte.")
     try:
-        subprocess.run(["python", "byte_bot/byte/bot.py"], check=True)  # noqa: S603, S607
+        subprocess.run(["python", "byte_bot/byte/bot.py"], check=True)  # noqa: S607
     finally:
         for process in multiprocessing.active_children():
             process.terminate()

packages/byte-common/README.md

@@ -0,0 +1,80 @@
+# Byte Common Package
+
+Shared code package for all Byte Bot services.
+
+## Overview
+
+This package contains shared utilities, models, and configurations used across all Byte Bot services (bot, api, worker).
+
+## Contents
+
+The package will include:
+
+- **Models**: Shared Pydantic models and database schemas
+- **Configuration**: Environment configuration and settings
+- **Utilities**: Common helper functions and utilities
+- **Constants**: Shared constants and enums
+- **Types**: Shared type definitions
+- **Database**: Shared database models and migrations
+
+## Technology Stack
+
+- Python 3.12+
+- Pydantic for models
+- Pydantic Settings for configuration
+- Advanced Alchemy for database models
+
+## Status
+
+**Phase 0.2**: Package implementation complete. All core modules extracted.
+
+## Structure
+
+```
+packages/byte-common/
+├── src/
+│   └── byte_common/
+│       ├── __init__.py
+│       ├── models/              # SQLAlchemy database models
+│       │   ├── __init__.py
+│       │   ├── guild.py
+│       │   ├── github_config.py
+│       │   ├── forum_config.py
+│       │   ├── sotags_config.py
+│       │   ├── allowed_users_config.py
+│       │   └── user.py
+│       ├── schemas/             # Pydantic schemas for API
+│       │   ├── __init__.py
+│       │   ├── guild.py
+│       │   └── github.py
+│       ├── settings/            # Settings base classes
+│       │   ├── __init__.py
+│       │   ├── base.py
+│       │   └── database.py
+│       ├── clients/             # External service clients
+│       │   ├── __init__.py
+│       │   └── github.py
+│       ├── utils/               # Shared utilities
+│       │   ├── __init__.py
+│       │   ├── strings.py
+│       │   └── encoding.py
+│       └── constants.py         # Shared constants
+├── tests/                       # Package tests (TODO)
+├── pyproject.toml               # Package configuration
+└── README.md                    # This file
+```
+
+## Development
+
+This package was created in Phase 0.2 by extracting shared code from the existing monolith.
+
+## Usage
+
+Services will depend on this package in their `pyproject.toml`:
+
+```toml
+dependencies = [
+    "byte-common",
+    # ... other dependencies
+]
+```

packages/byte-common/pyproject.toml

@@ -0,0 +1,22 @@
+[project]
+name = "byte-common"
+version = "0.2.0"
+description = "Shared code package for all Byte Bot services"
+authors = [
+    { name = "Jacob Coffee", email = "[email protected]" },
+]
+dependencies = [
+    "pydantic>=2.5.2",
+    "pydantic-settings>=2.1.0",
+    "sqlalchemy>=2.0.23",
+    "advanced-alchemy>=0.6.1",
+    "githubkit[auth-app] @ git+https://github.com/yanyongyu/githubkit.git",
+    "python-dotenv>=1.0.0",
+]
+requires-python = ">=3.12,<4.0"
+readme = "README.md"
+license = { text = "MIT" }
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"

packages/byte-common/src/byte_common/__init__.py

@@ -0,0 +1,7 @@
+"""Byte Common - Shared code package for all Byte Bot services."""
+
+from __future__ import annotations
+
+__version__ = "0.2.0"
+
+__all__ = ["__version__"]

packages/byte-common/src/byte_common/clients/__init__.py

@@ -0,0 +1,7 @@
+"""External service clients."""
+
+from __future__ import annotations
+
+from byte_common.clients.github import create_github_client
+
+__all__ = ("create_github_client",)

packages/byte-common/src/byte_common/clients/github.py

@@ -0,0 +1,57 @@
+"""GitHub client factory."""
+
+from __future__ import annotations
+
+from githubkit import AppInstallationAuthStrategy, GitHub  # type: ignore[reportMissingImports]
+
+__all__ = ("create_github_client",)
+
+
+def create_github_client(
+    app_id: int,
+    private_key: str,
+    installation_id: int,
+    client_id: str,
+    client_secret: str,
+) -> GitHub:
+    """Create a GitHub client for an app installation.
+
+    This factory function creates a GitHub client authenticated as a GitHub App installation.
+    Unlike the hardcoded client in the monolith, this allows for dynamic installation IDs
+    so different guilds can use different GitHub App installations.
+
+    Args:
+        app_id: GitHub App ID.
+        private_key: GitHub App private key (PEM format).
+        installation_id: GitHub App installation ID.
+        client_id: GitHub App client ID.
+        client_secret: GitHub App client secret.
+
+    Returns:
+        Configured GitHub client instance.
+
+    Example:
+        ```python
+        from byte_common.clients import create_github_client
+
+        client = create_github_client(
+            app_id=480575,
+            private_key=settings.github.APP_PRIVATE_KEY,
+            installation_id=guild_installation_id,
+            client_id=settings.github.APP_CLIENT_ID,
+            client_secret=settings.github.APP_CLIENT_SECRET,
+        )
+
+        # Use the client
+        repo = await client.rest.repos.async_get("owner", "repo")
+        ```
+    """
+    return GitHub(
+        AppInstallationAuthStrategy(
+            app_id=app_id,
+            private_key=private_key,
+            installation_id=installation_id,
+            client_id=client_id,
+            client_secret=client_secret,
+        )
+    )

packages/byte-common/src/byte_common/constants.py

@@ -0,0 +1,29 @@
+"""Shared constants for all Byte services."""
+
+from __future__ import annotations
+
+__all__ = (
+    "DEFAULT_GUILD_PREFIX",
+    "MAX_GUILD_NAME_LENGTH",
+    "MAX_PREFIX_LENGTH",
+    "MAX_TAG_NAME_LENGTH",
+    "MAX_USER_NAME_LENGTH",
+)
+
+# Guild constants
+DEFAULT_GUILD_PREFIX = "!"
+"""Default command prefix for guilds."""
+
+MAX_GUILD_NAME_LENGTH = 100
+"""Maximum length for guild names."""
+
+MAX_PREFIX_LENGTH = 5
+"""Maximum length for command prefixes."""
+
+# Tag constants
+MAX_TAG_NAME_LENGTH = 50
+"""Maximum length for Stack Overflow tag names."""
+
+# User constants
+MAX_USER_NAME_LENGTH = 100
+"""Maximum length for user names."""