Replace MessageResponse with specific responses #2185

gantoine · 2025-08-02T17:47:11Z

Description
^{Explain the changes or enhancements you are proposing with this pull request.}

Removal of generic MessageResponse in favor of specific response types like TaskExecutionResponse, TaskStatusResponse, and BulkOperationResponse
Addition of a new task API module with proper response typing
Conversion of several endpoints to return None for operations that don't need response data
Hardcoded success messages in frontend components instead of relying on API responses

Checklist
^{Please check all that apply.}

I've tested the changes locally
I've updated relevant comments
I've assigned reviewers for this PR
I've added unit tests that cover the changes

trunk-io · 2025-08-02T17:47:35Z

Running Code Quality on PRs by uploading data to Trunk will soon be removed. You can still run checks on your PRs using trunk-action - see the migration guide for more information.

github-actions · 2025-08-02T17:49:23Z

Test Results

548 tests +5 547 ✅ +5 1m 0s ⏱️ -1s
1 suites ±0 1 💤 ±0
1 files ±0 0 ❌ ±0

Results for commit a6d078d. ± Comparison against base commit a9bc4ad.

♻️ This comment has been updated with latest results.

github-actions · 2025-08-02T18:38:53Z

☂️ Python Coverage

current status: ✅

Overall Coverage

Lines	Covered	Coverage	Threshold	Status
8737	6156	70%	0%	🟢

New Files

No new covered files...

Modified Files

File	Coverage	Status
backend/config/config_manager.py	46%	🟢
backend/endpoints/auth.py	65%	🟢
backend/endpoints/collections.py	29%	🟢
backend/endpoints/configs.py	38%	🟢
backend/endpoints/firmware.py	27%	🟢
backend/endpoints/platform.py	43%	🟢
backend/endpoints/responses/_init_.py	100%	🟢
backend/endpoints/responses/identity.py	100%	🟢
backend/endpoints/rom.py	39%	🟢
backend/endpoints/sockets/scan.py	23%	🟢
backend/endpoints/tasks.py	100%	🟢
backend/endpoints/user.py	56%	🟢
backend/handler/auth/middleware.py	77%	🟢
backend/handler/filesystem/resources_handler.py	70%	🟢
backend/handler/filesystem/roms_handler.py	70%	🟢
backend/handler/metadata/igdb_handler.py	69%	🟢
backend/tasks/manual/cleanup_orphaned_resources.py	27%	🟢
backend/tasks/scheduled/scan_library.py	89%	🟢
backend/tasks/scheduled/update_launchbox_metadata.py	98%	🟢
backend/tasks/scheduled/update_switch_titledb.py	100%	🟢
backend/tasks/tasks.py	100%	🟢
TOTAL	65%	🟢

updated for commit: a6d078d by action🐍

Copilot

Pull Request Overview

This PR replaces the generic MessageResponse type with specific response types throughout the API. The main goals are to improve type safety and provide more meaningful response data for various operations.

Key changes include:

Removal of generic MessageResponse in favor of specific response types like TaskExecutionResponse, TaskStatusResponse, and BulkOperationResponse
Addition of a new task API module with proper response typing
Conversion of several endpoints to return None for operations that don't need response data
Hardcoded success messages in frontend components instead of relying on API responses

Reviewed Changes

Copilot reviewed 49 out of 54 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
frontend/src/services/api/user.ts	Updated return types and removed MessageResponse imports
frontend/src/services/api/task.ts	New task API module with typed responses
frontend/src/services/api/rom.ts	Changed deleteRoms to return BulkOperationResponse
frontend/src/services/api/platform.ts	Removed MessageResponse return type
frontend/src/services/api/identity.ts	Removed MessageResponse return types
frontend/src/services/api/config.ts	Removed MessageResponse return types
frontend/src/services/api/collection.ts	Removed MessageResponse return types
frontend/src/components/common/Platform/Dialog/DeletePlatform.vue	Hardcoded success message
frontend/src/components/common/Navigation/SettingsDrawer.vue	Hardcoded logout success message
frontend/src/components/common/Game/Dialog/DeleteRom.vue	Updated to use BulkOperationResponse data
frontend/src/components/common/Collection/Dialog/DeleteSmartCollection.vue	Hardcoded success message
frontend/src/components/common/Collection/Dialog/DeleteCollection.vue	Hardcoded success message
frontend/src/components/Settings/Administration/TaskOption.vue	Updated to use new task API
backend/endpoints/user.py	Changed delete_user and refresh_retro_achievements return types
backend/endpoints/tasks.py	Major refactor to use specific response types
backend/endpoints/rom.py	Updated deleteRoms to return BulkOperationResponse with error handling
backend/endpoints/platform.py	Changed delete_platform to return None
backend/endpoints/firmware.py	Updated delete_firmware to return BulkOperationResponse
backend/endpoints/configs.py	Removed MessageResponse return types
backend/endpoints/collections.py	Removed MessageResponse return types
backend/endpoints/auth.py	Updated login/logout/password reset endpoints
backend/endpoints/responses/init.py	Replaced MessageResponse with new response types

Files not reviewed (5)

frontend/src/generated/index.ts: Language not supported
frontend/src/generated/models/BulkOperationResponse.ts: Language not supported
frontend/src/generated/models/JobStatus.ts: Language not supported
frontend/src/generated/models/TaskExecutionResponse.ts: Language not supported
frontend/src/generated/models/TaskStatusResponse.ts: Language not supported

backend/endpoints/user.py

backend/endpoints/responses/__init__.py

backend/endpoints/rom.py

backend/endpoints/firmware.py

frontend/src/components/Settings/Administration/TaskOption.vue

gantoine added 2 commits August 2, 2025 13:42

Replace MessageResponse with spcific responses

70fe562

cleanup auth resopnses

1f5fa94

fix tests

725546f

gantoine force-pushed the response-cleanup branch from f820000 to 725546f Compare August 2, 2025 18:36

gantoine added 4 commits August 2, 2025 14:39

get rid of delete response

7fba925

remove auth response

53f9b8c

remove config response

ff434b4

add endpoint to fetch task result

0acc9de

gantoine changed the title ~~Replace MessageResponse with spcific responses~~ Replace MessageResponse with specific responses Aug 2, 2025

gantoine requested a review from Copilot August 2, 2025 19:26

This comment was marked as outdated.

Sign in to view

gantoine added 4 commits August 2, 2025 17:55

fix tests and cleanup

8061db4

use fastapi status

8ce943a

remove all_items from bulk

72f5021

remove deleted_items

22665e8

gantoine requested review from zurdi15, Copilot and adamantike August 3, 2025 02:22

Copilot AI reviewed Aug 3, 2025

View reviewed changes

changes from code review

a6d078d

gantoine marked this pull request as ready for review August 3, 2025 02:28

gantoine removed the request for review from zurdi15 August 3, 2025 20:21

gantoine merged commit f4a65c3 into master Aug 6, 2025
10 checks passed

gantoine deleted the response-cleanup branch August 6, 2025 13:16

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Replace MessageResponse with specific responses #2185

Replace MessageResponse with specific responses #2185

Uh oh!

gantoine commented Aug 2, 2025 •

edited

Loading

Uh oh!

trunk-io bot commented Aug 2, 2025

Uh oh!

github-actions bot commented Aug 2, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Aug 2, 2025 •

edited

Loading

Uh oh!

This comment was marked as outdated.

Uh oh!

Copilot AI left a comment •

edited by gantoine

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Replace MessageResponse with specific responses #2185

Replace MessageResponse with specific responses #2185

Uh oh!

Conversation

gantoine commented Aug 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

trunk-io bot commented Aug 2, 2025

Uh oh!

github-actions bot commented Aug 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Test Results

Uh oh!

github-actions bot commented Aug 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

☂️ Python Coverage

Overall Coverage

New Files

Modified Files

Uh oh!

This comment was marked as outdated.

Uh oh!

Copilot AI left a comment • edited by gantoine Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gantoine commented Aug 2, 2025 •

edited

Loading

github-actions bot commented Aug 2, 2025 •

edited

Loading

github-actions bot commented Aug 2, 2025 •

edited

Loading

Copilot AI left a comment •

edited by gantoine

Loading