Add FastAPI Dashboard + WebSocket + DB Persistence

[Vamsi-aki]

This PR addresses the following issues:

• Add FastAPI Homepage UI to Visualize Query Data #44: Adds a FastAPI dashboard at /dashboard that uses Chart.js to display real-time query stats.
• Add Unit Tests for Real-Time WebSocket Broadcasting #45: Adds WebSocket broadcasting with unit tests for connection, message format, and edge cases.
• Add Optional Database Support for Persisting Tracked Queries #46: Adds optional database persistence using SQLAlchemy with a config toggle (persist_to_db), including schema and DBWriter logic.

All changes are modular and driven by config.py settings.

[MuddyHope]

Let me test it out. Thanks for the contribution.

…

On Sat, Jun 28, 2025 at 11:48 PM Vamsi Akisetti ***@***.***> wrote: This PR addresses the following issues: - #44 <#44>: Adds a FastAPI dashboard at /dashboard that uses Chart.js to display real-time query stats. - #45 <#45>: Adds WebSocket broadcasting with unit tests for connection, message format, and edge cases. - #46 <#46>: Adds optional database persistence using SQLAlchemy with a config toggle ( persist_to_db), including schema and DBWriter logic. All changes are modular and driven by config.py settings. Screenshot.From.2025-06-28.18-01-36.png (view on web) <https://github.com/user-attachments/assets/24ee0a10-d3c0-4308-8cfb-41394c355822> ------------------------------ You can view, comment on, or merge this pull request online at: #47 Commit Summary - 9714499 <9714499> Add dashboard UI, WebSocket broadcasting, and DB persistence File Changes (15 files <https://github.com/MuddyHope/pyquerytracker/pull/47/files>) - *A* pyquerytracker/api.py <https://github.com/MuddyHope/pyquerytracker/pull/47/files#diff-ba59aa96d30e125934fbec176af777949b15b4f485001a3148aa3649ccf17229> (49) - *M* pyquerytracker/config.py <https://github.com/MuddyHope/pyquerytracker/pull/47/files#diff-b767b2f2b10d64481e8463008ada627673ef42c93cf4e4e62aefa3fcfe6e833c> (3) - *M* pyquerytracker/core.py <https://github.com/MuddyHope/pyquerytracker/pull/47/files#diff-ccfc00fed7f96345c70b39227355f55d7fea0020a1ca9cd95f9114c958f4f5eb> (16) - *A* pyquerytracker/db/models.py <https://github.com/MuddyHope/pyquerytracker/pull/47/files#diff-f8db3119854a45c94e83063d57720fbcbb908266d3af6f0c382f2d3f1537286a> (18) - *A* pyquerytracker/db/querytracker.db <https://github.com/MuddyHope/pyquerytracker/pull/47/files#diff-34309a6d750f5fa5379d1286a1cf368391a4a72eaac6ad5ffb597747484c2f48> (0) - *A* pyquerytracker/db/session.py <https://github.com/MuddyHope/pyquerytracker/pull/47/files#diff-01718f94d3f845b5b5ca90dcfc291529cd91dacac50bed4314a6af6a7b23b4e1> (6) - *A* pyquerytracker/db/writer.py <https://github.com/MuddyHope/pyquerytracker/pull/47/files#diff-16655e989d83239ac66ff204bd93d9901a1d4608591c547a2386c31d6d521a58> (25) - *A* pyquerytracker/main.py <https://github.com/MuddyHope/pyquerytracker/pull/47/files#diff-5fc66f48e605b2d9db408a2fab662fc8ab7914597fce358fb3d87a0aa5b283a0> (6) - *A* pyquerytracker/tracker.py <https://github.com/MuddyHope/pyquerytracker/pull/47/files#diff-aec3301c2164c3a444b9c092d57b26372c8d9d5199eb735b5f0fe8f30e3a4011> (17) - *A* pyquerytracker/websocket.py <https://github.com/MuddyHope/pyquerytracker/pull/47/files#diff-5c937737d1a529dcc21de60e5e00dea86e0ae34bde4f969b5a197aba49e144c3> (25) - *M* requirements-dev.txt <https://github.com/MuddyHope/pyquerytracker/pull/47/files#diff-2b4945591edfeaa4cf4d3f155e66d4b43d1bda7a55d881d5cf3107f1b05abbbc> (5) - *A* templates/dashboard.html <https://github.com/MuddyHope/pyquerytracker/pull/47/files#diff-cc5c88ed689fd481d078931f741f7293e57874d5510f875b3edbec1d4b650e6b> (91) - *A* tests/test_dashboard.py <https://github.com/MuddyHope/pyquerytracker/pull/47/files#diff-37f37eddbedf6e2deac58b85ba731696800ae8670a251d57d6cc5bde95e8baa1> (29) - *A* tests/test_persist.py <https://github.com/MuddyHope/pyquerytracker/pull/47/files#diff-2097621c1746ebddabbe6cdd4124722b8caeffb0b80c829c0cd159a11b8f1cc8> (8) - *A* tests/test_websocket.py <https://github.com/MuddyHope/pyquerytracker/pull/47/files#diff-9425b38ceab70e79c4ef222a507554fb63f7af8ffe58e79ce688be5bb0b84534> (59) Patch Links: - https://github.com/MuddyHope/pyquerytracker/pull/47.patch - https://github.com/MuddyHope/pyquerytracker/pull/47.diff — Reply to this email directly, view it on GitHub <#47>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AOKTJ2ZNUBR4H2QVQWMYNAD3F6D3PAVCNFSM6AAAAACAL2J5OGVHI2DSMVQWIX3LMV43ASLTON2WKOZTGE4DKOBRG42TMNY> . You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>

[MuddyHope]

HI @Vamsi-aki, can you make sure the test PR and lintings are passing?? Also can you make sure the dashboard is more optimized? Thank you.

[Vamsi-aki]

Hi @MuddyHope, I've made the requested changes — optimized the dashboard, verified that tests and linting are passing. Let me know if anything else is needed. Thanks!

[Vamsi-aki]

Hi @MuddyHope, I've fixed the linting issues and all style, tests checks are passing now. Please make sure sqlalchemy is installed via the updated requirements.txt. Thank you.

[MuddyHope]

@Vamsi-aki, can you check the tests again?

[Vamsi-aki]

Hi @MuddyHope , all the issues have been resolved and checks are passing. Could you please review it again. Thanks!

[Vamsi-aki]

Hi @MuddyHope, Fixed issue between flake8 and black. Updated requirements.txt . Could you please review it again? Thanks!

[MuddyHope]

Hi @Vamsi-aki,
Could you please run make lint to ensure everything is clean? Also, could you update the README to reflect your script—specifically, how someone can use the decorator and run the server alongside it?

[Vamsi-aki]

Hi @MuddyHope , Working on decorator files will update and make another commit. Thanks!

[Vamsi-aki]

Hi @MuddyHope, Fixed lint issues and updated README, Please let me know if there are any issues or further changes needed. Thank you!

[MuddyHope]

Hi @Vamsi-aki,

The commands in your readme doesn't match the actual commands.
uvicorn pyquerytracker.api:app --reload

Firstly, I don't see anything in the dashboard being reflected from the DB.
The DB is working fine. All the queries are being inserted into the DB, but can you ensure the calls to the server are handled accurately. I'm happy to jump on a call if you are having any issues committing. Thanks.

[Vamsi-aki]

Hi @MuddyHope,

-- Fixed Dashboard
-- Updated README
-- All checks passed (make lint, pytest)

Please let me know if there are any issues or further changes needed. Thank you!

[MuddyHope]

Let me test it @Vamsi-aki.

[MuddyHope]

Looks good @Vamsi-aki, but in the dashboard can you show the function name also? Instead of slow or normal execution?

---

[Vamsi-aki]

Hi @MuddyHope ,

-- Optimized the Dashboard
-- All Checks Passed

Please let me know if there are any issues or further changes needed. Thank you!

[MuddyHope]

Looks good @Vamsi-aki, thanks for contributing.

[MuddyHope]

LGTM. We will take up the / home page and other enhancements in the future release.

[Vamsi-aki]

Thank you @MuddyHope, for reviewing and merging my first open source PR. I appreciate your patience throughout the process despite the multiple commits. Glad to contribute!

Thank You!