Complete rewrite for V6 release

[mariusbegby]

This pull request is for the complete rewrite of this project. The aim is to create a robust codebase that is modular, flexible and easy to maintain. Below is a list of features and functionality that is to be implemented. The list is updated continuously and might change as development is progressing.

Functionality list

• [ ] Unit tests
  • [ ] Common mock utilities: Create common mocks and utilities used when creating unit tests.
  • [ ] Good coverage: Aim for high test coverage through unit testing all possible components in the application.
• [ ] Core
  • [x] Application entrypoint: Starting file (index.ts).
  • [x] ShardClient: The client responsible for connecting a set of shards.
  • [ ] ShardManager: The manager responsible for spawning a set of shard clients to utilize multiple processes.
  • Needs clarification with Eris.
  • [x] DeploymentDispatcher: Manages verification and deployment of application commands to Discord API.
  • [x] CoreValidator: Responsible for validating critical configuration and required dependencies.
• [ ] Events
  • [ ] Client
  • [ ] guildCreate, interactionCreate, ready, etc.: Handle relevant events from discord.js client.
  • [ ] Player
  • [ ] playerStart, playerFinish, willAutoPlay, etc.: Handle relevant events from discord-player player.
  • [ ] Process
  • [ ] uncaughtException, unhandledRejection, etc.: Handle relevant events from Node.js process.
  • [x] EventHandlerManager: Initializes event listeners for the defined event handlers.
• [ ] Interactions
  • [ ] Autocomplete:
  • [ ] Play: Execution logic for autocomplete trigger in the /play command.
  • [ ] Lyrics: Execution logic for autocomplete trigger in the /lyrics command.
  • [ ] Component
  • [ ] ButtonPauseResumeTrack: Execution logic for button component used to pause and resume tracks.
  • [ ] ButtonPreviousTrack: Execution logic for button component used to go back in queue.
  • [ ] ButtonNextTrack: Execution logic for button component used to go forward in queue.
  • [ ] ButtonFiltersDisable: Execution logic for button component used to disable current audio filters.
  • [ ] SelectMenuFilters: Execution logic for select menu component used to select audio filters.
  • [ ] Others: Other components not yet planned.
  • [ ] Slashcommand
  • [ ] Back: Execution logic for the /back slash command.
  • [ ] Filters: Execution logic for the /filters slash command.
  • [ ] Help: Execution logic for the /help slash command.
  • [ ] History: Execution logic for the /history slash command.
  • [ ] Join: Execution logic for the /join slash command.
  • [ ] Leave: Execution logic for the /leave slash command.
  • [ ] Loop: Execution logic for the /loop slash command.
  • [ ] Lyrics: Execution logic for the /lyrics slash command.
  • [ ] Move: Execution logic for the /move slash command.
  • [ ] Nowplaying: Execution logic for the /nowplaying slash command.
  • [ ] Pause: Execution logic for the /pause slash command.
  • [ ] Play: Execution logic for the /play slash command.
  • [ ] Queue: Execution logic for the /queue slash command.
  • [ ] Remove: Execution logic for the /remove slash command.
  • [ ] Seek: Execution logic for the /seek slash command.
  • [ ] Settings: Execution logic for the /settings slash command.
  • [ ] Shards: Execution logic for the /shards slash command.
  • [ ] Shuffle: Execution logic for the /shuffle slash command.
  • [ ] Skip: Execution logic for the /skip slash command.
  • [ ] Status: Execution logic for the /status slash command.
  • [ ] Stop: Execution logic for the /stop slash command.
  • [ ] Volume: Execution logic for the /volume slash command.
  • [x] InteractionHandler: Responsible for handling incoming interactions and routing them to correct executor.
  • [ ] HookManager: Manages loading and execution of hooks for interactions.
• [ ] Services
  • [ ] Insights
  • [x] LoggerService: The logger service used throughout the application.
  • [x] HealthCheckService: Health check service for managing and running defined health checks.
  • [ ] MetricService: Service used throughout the application to collect different metrics.
  • [ ] Player
  • [ ] PlayerService: The service used for interfacing against discord-player.
  • [ ] Security
  • [ ] RateLimitService: The service used for managing rate limits for users.
  • [ ] Storage
  • [ ] PrismaClient: Client for prisma ORM.
  • [ ] StorageClient: The storage client used for storing and retrieving persistent data.
• [ ] Utilities
  • [ ] EmbedHelper: Helper utility for generating embeds, replies and related data.
  • [ ] LocaleHelper: Helper utility for translation throughout the bot.
  • [ ] FormattingUtility: Helper utility for formatting values.
• [ ] Validation
  • [ ] ValidationHandler: Handles the validators defined in subfolder.

Other notable changes

• The project now follows a more object-oriented approach, utilizing dependency inversion to allow for unit testing.
• Change from npm to pnpm for a faster package manager.
• Change from eslint and prettier w/ their extensions to @biomejs/biome for a faster and all-in-one linter and formatter.
• Change from discord.js to eris as Discord API client library to reduce memory consumption.

[mariusbegby]

Closing, will be tracked at https://github.com/mariusbegby/cadence/issues/9 instead.