🛠️ Refactor: Endpoints - Reduce Duplication and Enforce SOLID #612
Conversation
- Implemented `_extract_special_params` hook in `ListGetEndpointMixin` to handle subclass-specific parameters in `UsersEndpoint` and `RecordsEndpoint`. - Extracted `_prepare_create_request` in `RecordsEndpoint` to share validation and setup logic between sync and async creation. - Extracted `_filter_by_site` in `SubjectsEndpoint` to share filtering logic. - Extracted path building and response parsing helpers in `JobsEndpoint` to reduce duplication between sync and async methods. - Removed strict `_list_impl` overrides in favor of hooks and helpers. Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>
|
👋 Jules, reporting for duty! I'm here to lend a hand with this pull request. When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down. I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job! For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with New to Jules? Learn more at jules.google/docs. For security, I will only act on instructions from the user who triggered this task. |
- Implemented `_extract_special_params` hook in `ListGetEndpointMixin` to handle subclass-specific parameters in `UsersEndpoint` and `RecordsEndpoint`. - Extracted `_prepare_create_request` in `RecordsEndpoint` to share validation and setup logic between sync and async creation. - Extracted `_filter_by_site` in `SubjectsEndpoint` to share filtering logic. - Extracted path building and response parsing helpers in `JobsEndpoint` to reduce duplication between sync and async methods. - Removed strict `_list_impl` overrides in favor of hooks and helpers. - Reformatted affected files with `black`. Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>
This refactor addresses code duplication and structural debt in several endpoint classes, adhering to DRY and SOLID principles without altering runtime behavior.
Key Changes:
_extract_special_paramshook to allow subclasses to inject custom parameters into the request without overriding the entire_list_implmethod._list_imploverrides with_extract_special_params, simplifying the classes and decoupling them from the base class's internal list logic._prepare_create_requestto centralize validation, header building, and path construction for record creation._filter_by_sitehelper to deduplicate filtering logic in synchronous and asynchronous methods._get_job_path,_parse_job_status,_list_jobs_path, and_parse_job_listhelpers to share logic between sync and async methods.Verification:
tests/unit/endpoints/and verified no regressions.PR created automatically by Jules for task 8952715575847996726 started by @fderuiter