Zero icon indicating copy to clipboard operation
Zero copied to clipboard
verified publisher icon Mail-0

feat: custom shortcuts, fixed reset, optimised

Open krakenftw opened this issue 7 months ago • 3 comments

READ CAREFULLY THEN REMOVE

Remove bullet points that are not relevant.

PLEASE REFRAIN FROM USING AI TO WRITE YOUR CODE AND PR DESCRIPTION. IF YOU DO USE AI TO WRITE YOUR CODE PLEASE PROVIDE A DESCRIPTION AND REVIEW IT CAREFULLY. MAKE SURE YOU UNDERSTAND THE CODE YOU ARE SUBMITTING USING AI.

  • Pull requests that do not follow these guidelines will be closed without review or comment.
  • If you use AI to write your PR description your pr will be close without review or comment.
  • If you are unsure about anything, feel free to ask for clarification.

Description

Please provide a clear description of your changes.

Added custom shortcuts, user can record keys and it will be saved in db, pull from db on page load and if overrides found, it will use those as shortcut.

Type of Change

Please delete options that are not relevant.

  • [x] 🐛 Bug fix (non-breaking change which fixes an issue)
  • [x] ✨ New feature (non-breaking change which adds functionality)
  • [ ] 💥 Breaking change (fix or feature with breaking changes)
  • [ ] 📝 Documentation update
  • [ ] 🎨 UI/UX improvement
  • [ ] 🔒 Security enhancement
  • [x] ⚡ Performance improvement

Areas Affected

Please check all that apply:

  • [ ] Email Integration (Gmail, IMAP, etc.)
  • [ ] User Interface/Experience
  • [ ] Authentication/Authorization
  • [ ] Data Storage/Management
  • [ ] API Endpoints
  • [ ] Documentation
  • [ ] Testing Infrastructure
  • [ ] Development Workflow
  • [ ] Deployment/Infrastructure

Testing Done

Describe the tests you've done:

  • [ ] Unit tests added/updated
  • [ ] Integration tests added/updated
  • [ ] Manual testing performed
  • [ ] Cross-browser testing (if UI changes)
  • [ ] Mobile responsiveness verified (if UI changes)

Security Considerations

For changes involving data or authentication:

  • [ ] No sensitive data is exposed
  • [ ] Authentication checks are in place
  • [ ] Input validation is implemented
  • [ ] Rate limiting is considered (if applicable)

Checklist

  • [ ] I have read the CONTRIBUTING document
  • [ ] My code follows the project's style guidelines
  • [ ] I have performed a self-review of my code
  • [ ] I have commented my code, particularly in complex areas
  • [ ] I have updated the documentation
  • [ ] My changes generate no new warnings
  • [ ] I have added tests that prove my fix/feature works
  • [ ] All tests pass locally
  • [ ] Any dependent changes are merged and published

Additional Notes

Add any other context about the pull request here.

Screenshots/Recordings

Add screenshots or recordings here if applicable.

By submitting this pull request, I confirm that my contribution is made under the terms of the project's license.

Summary by CodeRabbit

  • New Features

    • Enabled full keyboard shortcut customization, including hotkey recording and resetting to defaults.
    • Added the ability to fetch, update, and reset user-specific keyboard shortcuts with immediate feedback.

  • Improvements

    • Shortcut management is now dynamic and synced with the server for a more consistent experience across devices.
    • Enhanced shortcut formatting for better readability and usability in the interface.

  • Bug Fixes

    • Resolved issues with shortcut state not updating correctly after changes.

krakenftw avatar Jun 24 '25 18:06 krakenftw

@ahmetskilinc here you go, also apologies for all the chaos

krakenftw avatar Jun 24 '25 18:06 krakenftw 

## Walkthrough

This change replaces the static and SWR-based keyboard shortcut management with a dynamic React Query and tRPC-powered store throughout the mail app. It enables live updating, resetting, and recording of user shortcuts, updates the UI to use these new features, and introduces corresponding backend procedures for fetching and pruning user hotkeys.

## Changes

| File(s)                                                                                         | Change Summary                                                                                           |
|-------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------|
| apps/mail/app/(routes)/settings/shortcuts/page.tsx                                              | Switched to `useShortcutStore` for shortcut management, enabled shortcut recording/reset, UI logic cleanup|
| apps/mail/lib/hotkeys/compose-hotkeys.tsx<br>apps/mail/lib/hotkeys/global-hotkeys.tsx<br>apps/mail/lib/hotkeys/mail-list-hotkeys.tsx<br>apps/mail/lib/hotkeys/navigation-hotkeys.tsx<br>apps/mail/lib/hotkeys/thread-display-hotkeys.tsx | All hotkey modules now use `useShortcutStore` for dynamic shortcut retrieval instead of static config     |
| apps/mail/lib/hotkeys/use-hotkey-utils.ts                                                       | Replaced SWR shortcut cache with React Query/tRPC store, added reset, updated key formatting              |
| apps/server/src/db/schema.ts                                                                    | Added type import for `Shortcut` (no logic change)                                                       |
| apps/server/src/main.ts                                                                         | Updated `findUserHotkeys` to return a single record, added `pruneUserHotkeys` method                     |
| apps/server/src/trpc/routes/shortcut.ts                                                         | Added `get` and `prune` procedures to shortcutRouter for fetching and pruning user hotkeys               |

## Sequence Diagram(s)

```mermaid
sequenceDiagram
    participant User
    participant ShortcutsPage
    participant useShortcutStore
    participant tRPC_Server
    participant Database

    User->>ShortcutsPage: Open Shortcuts Settings
    ShortcutsPage->>useShortcutStore: Fetch shortcuts
    useShortcutStore->>tRPC_Server: get user hotkeys
    tRPC_Server->>Database: query userHotkeys
    Database-->>tRPC_Server: return hotkeys
    tRPC_Server-->>useShortcutStore: return hotkeys
    useShortcutStore-->>ShortcutsPage: provide merged shortcuts

    User->>ShortcutsPage: Click "Reset Shortcuts"
    ShortcutsPage->>useShortcutStore: resetShortcuts()
    useShortcutStore->>tRPC_Server: prune user hotkeys
    tRPC_Server->>Database: delete userHotkeys
    Database-->>tRPC_Server: confirm deletion
    tRPC_Server-->>useShortcutStore: success
    useShortcutStore-->>ShortcutsPage: update shortcuts

Possibly related PRs

  • Mail-0/Zero#1341: Updates ZeroDB methods for user hotkeys management, including pruning, directly related to backend changes in this PR.
  • Mail-0/Zero#649: Introduces foundational hotkey hooks and recorder components that this PR activates and builds upon.

Suggested labels

High Priority

Suggested reviewers

  • ahmetskilinc
  • MrgSub

Poem

In the meadow of code, shortcuts bloom anew,
With stores and queries, their magic grew.
Rabbits hop and reset with glee,
Recording keys for all to see.
Backend and frontend now dance in sync—
Hotkeys refreshed in a single blink!
🐇⌨️✨


<!-- walkthrough_end -->


---

<details>
<summary>📜 Recent review details</summary>

**Configuration used: CodeRabbit UI**
**Review profile: CHILL**
**Plan: Pro**


<details>
<summary>📥 Commits</summary>

Reviewing files that changed from the base of the PR and between 33408bc587bc010835a61df8f41b79427bc6841d and 7c0723d72e3df2aac3e55fca644ca5cada7397c7.

</details>

<details>
<summary>📒 Files selected for processing (5)</summary>

* `apps/mail/app/(routes)/settings/shortcuts/page.tsx` (4 hunks)
* `apps/mail/lib/hotkeys/use-hotkey-utils.ts` (3 hunks)
* `apps/server/src/db/schema.ts` (1 hunks)
* `apps/server/src/main.ts` (3 hunks)
* `apps/server/src/trpc/routes/shortcut.ts` (2 hunks)

</details>

<details>
<summary>✅ Files skipped from review due to trivial changes (1)</summary>

* apps/server/src/db/schema.ts

</details>

<details>
<summary>🚧 Files skipped from review as they are similar to previous changes (4)</summary>

* apps/mail/lib/hotkeys/use-hotkey-utils.ts
* apps/mail/app/(routes)/settings/shortcuts/page.tsx
* apps/server/src/main.ts
* apps/server/src/trpc/routes/shortcut.ts

</details>

</details>
<!-- internal state start -->


<!-- DwQgtGAEAqAWCWBnSTIEMB26CuAXA9mAOYCmGJATmriQCaQDG+Ats2bgFyQAOFk+AIwBWJBrngA3EsgEBPRvlqU0AgfFwA6NPEgQAfACgjoCEYDEZyAAUASpETZWaCrKNwSPbABsvkCiQBHbGlcSHFcLzpIACIAMxJqLgZsRAJme1h8Clxk3EQAGkhY+AAPKP9EElxC/G5xZiQ6aMgAdzRkBwEG3Bp6OTDYDxTKSABrKlGyWNwW9GRbSAxHARGARgAWAHYAJg0YQchmbSx46mx/FAxcCkVsBijUXAOVeC91eVisyGGKZAJGfzUDzJVIsMYkWQCfDOeiITLZXIyeT+JgUWjwDBEcHyJjMNQYajwfAYAqtBAMWDoC5PMj2NBSegYgYeWjUFTtEh7ACq3GJPDQpEgXmhtEKNPQ3G4bwYhL5/mu8BIUj+g0qdIZGSyOTwyEw9DQkre0mZzBqUgoFHg6MxzMgSliaG8oThWsRKFijBSaX45GQJBKSE0+xZ0gYlrqRKwGIYXmwSl19muxKxGHwNG+FCIGKxTCuloEeCyf3wjGcJFi3i8yIS9HFRGwVpIb196Aw+ok+Ct30Q2cgAEEAJLEMjKXoKJT8PjxsPwCPE5AtdSZPA8G7cEb+CSK2Z675tyipPXZvbuax2VBHCiTfUJgtY4olQrkWanXDnEiFXfriifChHDD3CgzC8PgUhsFcewAHIlog64MPAxQMFSCS6rE8RiHQYohL236/mwoqTvYojnO8Cgko2VDiPOrSUB4GLojKvSfm2iwwWGJBkC6eSESiWTWkQC60auoGNrQJ4HLmCoFlRUbIEcE7YPufDiiBIhiAA5Mg0qcR4NB/ogGjmJYADCLDgdxDhOC4bgSWZ7DIHyTyoNwlZ+IEwSpMhhwYvARxeOJHiOk8WSFOMaCTBg0wtIUFS8vutYlmg3YjAS+GQAAAmgsBsHkoyvNGkD9PR8CMb2TzULa/hBCEUQUpgpAOXwGJ4bKWCwPSHgrLSIFbko+osQa+DClmABeUS/q2OLEhWPZ8l86KIHxIy0CRNoqTc9yIAZ/apjSfA/IUmXZVUiB5c2DCfgwoypi0kS0KQtYSe1mLSIU5mRlE5WhDS8gtEJMb4D2a2DPAfD4C0WD+F4QL0C5PhudVqTMTe15jBMUwzGEJa5j2Sh8Li5nILENzpGmgx8HDvhVR53H/A68FvLgQKQChip8Ju27bX2tDojJaA+LIn7JXwqVRAAspmADK2ACGElpEKQ/j6oVaYKE4LHRHeUKhBQin5M0vDSI4KhVljlzqPAzNBSwMNhNhNpfBSoijNt0FFOce12kgIKzRgMVKpzNT43ZVyCRcvFolEjkIMglMIzThkGPoxjgFAZD0PgHrW8O5CUbVIecKu/DCKI4jKoVU14yoaiaNouhgIYJhQHAqCoJgOAEDno756w7BcFQsyWZe8j9EwVeqOoWg6MnKemAYBrcIgAD0RyvEvC9LwAFDceDSAAlEvlQ9Nmy8ugiOpL9wAqcnkJQcAY0SPwYFj9kOpC57bQ/OPImeMM9DU2WBIoDw/gpRoE2raAABsMSW8JtS4GMuAwYkDICZHwKMVoS5IDQMqLA10eBJYEH8Cgia/4BS9kmJCaEaJNTnzyIUaMsZ+JFCqBSbMhRsDcFZOITEyM3JHx4ViM+8DtqngqFUQqeACBRiwOKT4aYRhtzEJIW2u4ezATeMUT62N+a+EgeI3AeC6GIE3nvFB6IUQRF+lgygNw+DPVoM2LEu4Fom2NOKaS0i7SrSxLwRSx5gy0PgUKQMbklK9lQP4FqPRxpfEBKyNQjNrHBRXMNEqf96rSACtgox8CUG4jiuwViL5KzyDIG45AmRcCULcqiZh/RFIE3YL2Xc4Cy6EmBh4Q86ZdxKiKQ4yIvwzYEAVpEWpfFezMGAa2WEHVFgkEHnA3I2JREHEgQMkgAAJNMlCbCiCWrQEhjSZIoGQI0guURdycO4do5K2CYFLIIUQkgJCvjXI6UIx59DVzSEoFuTpk54BZgJL4YRuRNKHCqGgbhaA+GMLjMaWxXwBm9kXE8ewdxNrLyRcpaEqRVkeEgds6pEI9l1MoPklghSrinPQF4Rae4mlXEuSxDENAiB5wSvwdcWAWiDEhvstEETdTKKkHsAA8uaXRYonqZJFe09Mhstz4BSKbJlvQwAqudF88ZQqbS7gMYIlhZwKiFEQGiikZskrojQrRGlYKVzdI8GQ0g5lUH4HQXwmMCQsCcMgFyAclw9JtMjEKfAWYkLgLqdmKsicjL9i8MGmSxZbRKBjM4VqDkPT+l5NkKOFMZbShZlcC20gjBQDdnVF6Kac1anzZ4AQRbmm4HkGm6GlFIyIAANx0t8FMm1JVM1eTZZQEFwy1m5MRFYa+lLgLEiKbucUwoZR6MnXgWd1LQhooQFgSBC9l6ry8OvSUW8d40EQAfARJ9D5fOXlfUgGhb6QMMo/aI5a577pXtoI9bwBBLyqZQ5eBTAYkDAABiEBlb731fc/Swg4u6coxVZH+Hoq0AIMKeXyubQi/xwSQNdeQUFtGQLifEURt22iw1qfgHo8MEcIVkF5RQSa2kQGgNghxbiRGyWPDwN03IKj6SqQlDrCNUioB8Fj4o6NfIY8Q916DLipBrDRr2ljTZUeyL2SBlCoQwgI4gEhUnbKRSBecVq2TiiJsoL2X+omU3BTVBR8UiAmDrmwepYDlR1IoLboaRUXKnLIFoLIVKg6BbFyZhiKIkD7MoOcBJvw1ByYDHbi5pm4gkI6YhHptEBnKUkiZhBQJFQcMeiXeGkqDCAJMLKgcDZQyrlscFLhh5+DCP+1XiSRl/86BxtgwmpNnbx0hnTR26iv9a15ozgWxt6Tm2KkQEYaC5BslTbHBWACJzIGmTnZUYlgGUH+C62cgCvXGRYB7EQAkb4Li7i3D2RJ7wX1PyTh+yUB7v1L1/f+nZEGl5EGFAIfmYG/uyEg4gO+D8n4v3g+/busJHDD1U2hstGGDiabK9g3T1DaD5eY2CcUuZij1nGycV4gUWLikUsMRkc7siqbwwANU7PcIjQljugT65AAchWawysJW1uhcmmNoIwcRoC2HxrGa6ex51XHArIBk+1wzexee410msgA4kD/mB2INHK25GAX2C4vibQPIVA/HBBRfIPQYmhO1lC/gSLlBYukue3KicGXiZCRZZx/p29vn6dBlPFZvStmPT2YrradSgPBD83UvYNzdFdT+duUFu0oX2PpNi0H83lu+fQtU+tAOKrECm1p77zLITUjZNKyXg4aSLqXBjHGOrHgGu6ipwcYYjPneIiI1guRrw9JRHs5144p3UdiSMPGvs1mycOYOG2jNybVPrfrS5ObSEFto4rdjXrYdnXQt0iWcUq+l+ESuzd98WaWYlClzNhtTaS3iGNEySBOuE9eH1+D590Ob6b2YARgn6h6328Af64G4OX6rwYAbwqQoOJK4Oj6kO0GMOcGb8I4iGX8LgKOR+gCku1GuGAeeW+eDu6QRO00ZmZORQFOrQ7QbkUyGoBqJAYC9wfQluIe2mA+TyjGRmjuHgy6/M9ylQSBlCYAeArwhmnGK03GPO5EE40mYs36AAMoGH/jIZtsosSCbtHmWMUpFscNLoIaIfhrJs8m7h6qMBCnnirigiBN+C2kpjQMXr/KXsqqqlwU/tjjlrjvjjjEVqHgcOHjZg7FHrejHq5rUCAiQCdj1pkgRNJCgKENbt+ECA5LIivtng0CuqbPKJaH0vQHYcYgIZQQcKCOHMliMF7ugNXuksTjQRZiViEI3kIZVi3vCswtTmqK1rgvnv8P4FmMpspCEaPrRLCJEc5iDPYnqIMqSMdlPqxnLv1rDovkOv8BfqIO2kOpNo/nWs/tvq/uEItuWpAJWkfjRBcPJGfqmtsWvsNl8DfiasaHsT4V8EcfNm/otpcNgioa8OoakJoQATBsAaAR9rAT+pAb9sgcvASFuEQK1OIRBqgVDjBrDlgR/GOLgShhktWoQZjozqQXjuQT7o0aTq1HQWMhLpziwSxKAtDBwTHpjjwf0e1q7gTuUe0SumYcibIJIeIPSigv2t4JyAoRrlApBPSECq1MCWrJunoZEQYdbgILblECFmFnkSPDiLoqyeYeyc8qYvFixPGNcHcLdtpmbhQSkdVspm4R6CkB3vUVqUQdNr4VQoHvYZZuMZaOEUEm6P0NEe5osRiMJnSBxskVbuDBKFKAFiNlnpqbotWIJhqCUSIkdtUaMWlhURlg0dQRSTJPXq0e4U3h0dVm3t0QcPCTKScl3jMraH3n0fqaUQpqMJPqGQkS9LPnPmsUNtRJsSvvcVfm8QcYRJ8bvt8fvucYfnKlcSfkoefoOWNrsXwM8bdq8dmvsW6R8YWl8ScR/rulKQibKWDqroAe+iAfPBCeAT9tAcvE8PEmAAtGAvyXeaiegW+hiQhp/Ejt/PgXKgSSHtXnEfZHOW5FkIiRgPAGNLQFwHhnAPEjIbuNlh6WQfYWBbSZhPWcrsLpYQwbqDzCYekM+kvMMHyQKdIc+uKY2FAghTWAACJIAvlynaEyQm5pmD4F60oqlqn24sY4Uu6GlmIuEqa/wsn6rOnum5YknoXknmaFmBKhG+lYh2aRGBkp7JQqioAak55ZZm4JYW4e4pa1EeFEheGunYm5lIQIHBGxGeQlntERrlm1Y2h1m7ju4pDXztndaNLnarFwbrHr4DmjY7Hr4jnbmzbHGlpLYGArZimnhrnvhtEP4+GsWhqQJ0XQqMWwTQyyBykhk+VnaJEvZAEQCXlgFfa3mnmkViHQEUX0qoEfkDZw7YE/nIb/n4no5AITgMngLGhJTqp0CaoriSwADqNgYAwOlQkx7WpYbCrl1hkAm8AluQiCTskCe8mC6KSUz4rZZh9GeFX0mlkAeybSkAAAisEHgYujYFYMZEUF8PEDkDukQBwlwh8nwn4lBTaD8NiNJf6TqNkrte7k9U7B0JEVuElElLgLdfddVC4IUD1I2HJHgEOhNO8kal+LrN9Z8irnwi6saMIb4DKE7N8O9eetyvUIGOFqbBRjcD4MDldD6CzBaEWGrqENCrQAmPor8oYvnjlJkFyl9UMJUKuUqayhgBIPzFaMzETkgvFWslzhaI2PjmlXyGwJmMaL9dHhRvaI6Imn9bjgDd8obPEMrT9aLfwOaJaPGInLzlAtEgANIG7uxG66G2g1JHCSi9jN60rQpCBeh0BcDig1JRlhovR8DCh/QUAyjTWFTliMaQD0UdgTCHALzsL1kj5jryjnB27YiJjKV+1eBtDg5hrR2x3c4tx+gkh35kQ9jKY0pR2UAV38B4AuQc0sSoiWJJ0p3hRp3e2YhFn2XlYhFZBHDHw2i+0FXT5+VGCSrKA+Am6o7IBso3ArSARJQVgRYjocqfw6qVEeAUai3mj2ChaRqd3y1p0EiursD+zsFOlKpmUdBviqBRBjV2ALw3BIJ8JRLRb53RJGorDtTKoUD+WDajjDbBV2hDm7GbnvGRV7nRVnEABixyoa/gos/UsIQKt+FwM+cFvBCC8tm8PwA4tAAA/FwKkMpcJYAEmE+1FhjGRpvxe615lV0Jd5NVoGdVUhDVhGSckAqDbtl2ODLxnZD0kioQvtGNQd2CTtEGm8gGVDComIAA2gALqQAAA+e49o0WtAe8yjylvmu6FVa8VVsJXD5FvDEOkC55YJV5i8h8fylAh8MdS8tAf6rmgwRwjV55X58OOBv5eBv8y9RgfYUYQFTqbqEunNtyhJ4oLa7mkCBGZRtoIpYyz6GgEBXjQe4kqAqOQaa9dw/VYQsg7mhJyRtA+Axou06AtqYgk0D+1Nk9ZZYQbi0DxQUFyaQcyePj1qMD6+TII+3Gc+zVgVkDi5IVDxE2cDo5O5O+xa+5MVcV9jZV4JTjx9rjiA7jXWfj6JmB352JwTuJYTXVFlyVKTXyKCSTHg1pJFP2ZusThFYkChUCAAWpQPgPRQAEIoL0XmaNoeDiolyNPppbQm4C2KByP0Rcii1ykS4z5mw50UBYBJRAyA4i0jDQG6r0DLVdO0DIOgypAbUiX2mHBOizhjL4v0QqEYCyAbVwrcQouyLlOH2MEyP6gMDRqYimz/DosxoeCCBqQ4b7T7hdOV1rKhmUC4BwuUBylQu0AQpXxUA5Q1Fsv4V4kSPWntwGW4kX5shTV0QkgytlPub8tosWiGW4apN7B9jzKzCKvYLC1ysUAIuMFxMER8olSUhKCRAU26LCzuqwlzCLTwS2wUZJRZhSC+qW0Dj0WJy9kQP9lTPQPLlhVzMRUv6IPv4xVQBixVCC32CiPrlk03KwXYLtBn10FtiuuaEkOi1kNGPZiGPWAkyNDACby3O/w/CaEaAAAkzUlAksTYpce8GjegKC9De6iA1bBLdbp5DblATbBdLbXAVg7blQwA3bDp8Lp5A7Q7FAI7kQjTOjikejduk7vx4LSunzNwvzJjlbEJWzFAbjDAsBGAqBdj+bhb0LiVFwnLcFVbAESmMrC7sJS7FAK71DGd9mXAXbbLPbe7sJB7kUy7Jr2Q476jdDlbs7IH0r2Q4HgGkH0HKjr1xtiAXABGGjwlTIN72Cd73zfzLDn6L7b7H7X7AjBbwU+oLzQHeHSELryHxHpDFbMHmItHWA9HkCjHD7LHz7Ljr7Oz77ez/DoJ6zjjp8in7H1w3A77Z60gN67W+zGBr8Rz4+JzHV6Gp4y96APMdRu1kCpAuAKC8N8gIEHBSV/wHFeANgWqFKqWHNAnsANwqY5lBRio5cv1d5nJqahrHID1oxwI5wGDzo0gvsQbrBt23WNI6QkbZr4+ZpYgSVpGPkAKMKRrfTcR6Lo7OhaLA0lriWNr1zxcIrBKzTqQPB5NTGzAqNJyF4igCEcZ/wV8W0rG6Xoav18bKV0o6gpsjBI+vwHNmYjgRS3nBHsrwnLtoZrhGcqG7QRqLmkRGI7dZse69LVF9rjnwtwpfXoaHndASVrceYtwHBhQ3rlqwHFIoX5eaquiSuQn8rp5Q+6KLmE3fIU39FZs3q7cfq0X+7gSmOuoAH3XXKXRmuhKqTBXmdTuW3/+VXRwiXZrOE5wvIlQBkYzSbV+UDl+sDKV8zCDE5yzZx3MfU2CznrnV17nG0j31IJYPnMN/nFAj7rDmz2nynS8un+n/np8XyX7W1lI/7JA98kA2CkCkCeQBgqvznXAvAKiNAG7+Ann/gGgbnwAAA3lr6rxR/Bzu8LH24O2h0e7V6EAAGSQDm82+QDUeaMAC+m1Z74r+jXaVvvvhgqv6v37kAYsg3WixRMjt3uZfID3K0Fwn+omfnu8wv8nYvFA5oOnFAenS8BnsvxnYm/whTct8M63GHm3QPsJZRKvavGvS2qvaAbQ6gdoAgGgG3RHCj+h3esge8IfEf6vVvBAVvkfmvbfHfoQnjPftfff4Om85PvsrrPfBE9mw/k/Y/UArPMWN3FLSfWAKfXn/PGfQvIvrH4v7jUvxfMvRndC8vR9Jb74TfU/rfq4ikyvq4+vJAhvxvTkL12P6bwvuS1T3mIBKCQB/ekAAALx6A22LADth2CtB6A94O/Oxupwbizw04LEX+NnECa2x1U/cdvkhmRyjxgEVACeLXGnjYCm4asboAAH0rQiARgRzAWR0BGBh4BnDPHoEABmPgesAAAMAADgEAMAAArCIM2DiChBqwUQXwIkFoAAAbKsFoCxARBsQdYKsAECbAAAnOsG2AyCGAygkQdoPoDJx6BmwBgEIJ2B8DaAOwEgPYNiDbA0A4CPgSQAkESDYgMoZQesHWAygJBMoVkJsD4F6DrBmweuIYAMD0CCY6gZgVzTYEBwOBtARgenCiFAA== -->

<!-- internal state end -->
<!-- finishing_touch_checkbox_start -->

<details open="true">
<summary>✨ Finishing Touches</summary>

- [ ] <!-- {"checkboxId": "7962f53c-55bc-4827-bfbf-6a18da830691"} --> 📝 Generate Docstrings

</details>

<!-- finishing_touch_checkbox_end -->
<!-- tips_start -->

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

<details>
<summary>❤️ Share</summary>

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai)
- [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai)
- [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai)
- [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

</details>

<details>
<summary>🪧 Tips</summary>

### Chat

There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai?utm_source=oss&utm_medium=github&utm_campaign=Mail-0/Zero&utm_content=1472):

- Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  - `I pushed a fix in commit <commit_id>, please review it.`
  - `Explain this complex logic.`
  - `Open a follow-up GitHub issue for this discussion.`
- Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples:
  - `@coderabbitai explain this code block.`
  -	`@coderabbitai modularize this function.`
- PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.`
  - `@coderabbitai read src/utils.ts and explain its main purpose.`
  - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.`
  - `@coderabbitai help me debug CodeRabbit configuration file.`

### Support

Need help? Create a ticket on our [support page](https://www.coderabbit.ai/contact-us/support) for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

### CodeRabbit Commands (Invoked using PR comments)

- `@coderabbitai pause` to pause the reviews on a PR.
- `@coderabbitai resume` to resume the paused reviews.
- `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
- `@coderabbitai full review` to do a full review from scratch and review all the files again.
- `@coderabbitai summary` to regenerate the summary of the PR.
- `@coderabbitai generate docstrings` to [generate docstrings](https://docs.coderabbit.ai/finishing-touches/docstrings) for this PR.
- `@coderabbitai generate sequence diagram` to generate a sequence diagram of the changes in this PR.
- `@coderabbitai resolve` resolve all the CodeRabbit review comments.
- `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository.
- `@coderabbitai help` to get help.

### Other keywords and placeholders

- Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed.
- Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description.
- Add `@coderabbitai` anywhere in the PR title to generate the title automatically.

### CodeRabbit Configuration File (`.coderabbit.yaml`)

- You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository.
- Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information.
- If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json`

### Documentation and Community

- Visit our [Documentation](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit.
- Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback.
- Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

</details>

<!-- tips_end -->

coderabbitai[bot] avatar Jun 24 '25 18:06 coderabbitai[bot]

@MrgSub lgtm, please review. closing my pr.

@krakenftw please consider the comments from the other prs you opened, to make it easier for us.

ahmetskilinc avatar Jun 24 '25 18:06 ahmetskilinc

bugbot run

MrgSub avatar Jun 27 '25 19:06 MrgSub

Will it auto rerun or manual trigger required? @MrgSub

krakenftw avatar Jun 27 '25 19:06 krakenftw

bugbot run

MrgSub avatar Jun 27 '25 20:06 MrgSub

bump @MrgSub

krakenftw avatar Jul 03 '25 12:07 krakenftw

This PR has merge conflicts and has been open for more than 3 days. It will be automatically closed. Please resolve the conflicts and reopen the PR if you'd like to continue working on it.

github-actions[bot] avatar Aug 07 '25 07:08 github-actions[bot]