feat(manager): optimize service of the persistent cache task #3929
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Gaius <gaius.qi@gmail.com>
There was a problem hiding this comment.
Pull Request Overview
This pull request redefines endpoints and schema definitions for persistent cache functionality to improve clarity and consistency. Key changes include:
- Renaming endpoints from "/api/v1/persistent-caches" to "/api/v1/persistent-cache-tasks" and updating related routes, handlers, and mocks.
- Updating schema definitions and types in the manager package to align with the new naming conventions.
- Revising API documentation in swagger to reflect changes in endpoint paths and response models.
Reviewed Changes
Copilot reviewed 15 out of 17 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| scheduler/resource/persistentcache/task_manager_mock.go | Updates renamed mock function names to match persistent cache task methods. |
| scheduler/resource/persistentcache/task_manager.go | Adjusts type conversion and inline comments for clarity. |
| scheduler/resource/persistentcache/peer_manager.go & host_manager.go | Replaces []interface{} with []any for improved code consistency. |
| pkg/redis/redis.go | Removes unused imports and outdated helper functions. |
| manager/types/persistent_cache_task.go | Renames and updates schema definitions and types for persistent cache tasks. |
| manager/service/service.go & mocks/service_mock.go | Renames service methods to align with the new endpoint semantics. |
| manager/router/router.go | Modifies route paths and associated handler references for persistent cache tasks. |
| manager/handlers/persistent_cache_task.go | Introduces new handlers for persistent cache tasks. |
| manager/handlers/persistent_cache.go & persistent_cache_test.go | Removes obsolete handlers and tests for the previous persistent cache endpoints. |
| api/manager/docs.go | Updates API documentation to reflect new endpoints and schema references. |
Files not reviewed (2)
- api/manager/swagger.json: Language not supported
- api/manager/swagger.yaml: Language not supported
Comments suppressed due to low confidence (2)
scheduler/resource/persistentcache/task_manager_mock.go:103
- [nitpick] The renaming between 'LoadCurrentReplicaCount' and 'LoadCurrentPersistentReplicaCount' in the mock functions can be confusing. Please double-check that the function names and comments are consistently updated to reflect the persistent cache task changes.
func (m *MockTaskManager) LoadCurrentReplicaCount(arg0 context.Context, arg1 string) (uint64, error) {
manager/handlers/persistent_cache_task.go:17
- New persistent cache task handlers have been added without accompanying test cases. Consider adding test coverage to verify the behavior of these endpoints.
package handlers
CormickKneey
approved these changes
Apr 2, 2025
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #3929 +/- ##
==========================================
- Coverage 34.65% 34.54% -0.11%
==========================================
Files 339 339
Lines 39959 39956 -3
==========================================
- Hits 13847 13804 -43
- Misses 25201 25247 +46
+ Partials 911 905 -6
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 New features to boost your workflow:
|
yxxhero
approved these changes
Apr 2, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This pull request includes significant changes to the API documentation in
api/manager/docs.goandapi/manager/swagger.jsonfiles. The primary focus is on renaming endpoints and updating related schema definitions to improve clarity and consistency.API Endpoint Changes:
/api/v1/persistent-cachesto/api/v1/persistent-cache-tasksand updated all related descriptions, tags, and summaries accordingly. [1] [2]/api/v1/persistent-caches/{scheduler_cluster_id}/{task_id}to/api/v1/persistent-cache-tasks/{id}and updated the parameter types and locations. [1] [2]Schema Definition Updates:
GetPersistentCacheResponsetoPersistentCacheTaskin the response schema. [1] [2]d7y_io_dragonfly_v2_manager_types.GetPersistentCacheResponseandPersistentCachePeerschema definitions. [1] [2]PersistentCacheTaskandPersistentCachePeerschema definitions with updated properties.These changes ensure that the API documentation is more intuitive and aligns with the updated endpoint structure.
Related Issue
close #3892
Motivation and Context
Screenshots (if appropriate)
Types of changes
Checklist