fix: update ListrrAPI validate method to use correct path #906
Conversation
WalkthroughThe changes in the pull request focus on the Changes
Sequence Diagram(s)sequenceDiagram
participant Client
participant ListrrAPI
participant ListrrRequestHandler
Client->>ListrrAPI: Call validate()
ListrrAPI->>ListrrRequestHandler: Execute with endpoint ""
ListrrAPI->>Client: Response
Client->>ListrrAPI: Call get_items_from_Listrr(content_type, content_lists)
ListrrAPI->>ListrrAPI: Process content lists
ListrrAPI->>Client: Return list[MediaItem] | list[str]
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (1)
src/program/apis/listrr_api.py (1)
Line range hint
42-89: Consider breaking down the complex method into smaller functionsThe method has multiple responsibilities and could be more maintainable if split into smaller, focused functions. This would also make it easier to test individual components.
Consider refactoring into these components:
def get_items_from_Listrr(self, content_type, content_lists) -> list[str]: unique_ids = set() if not content_lists: return list(unique_ids) for list_id in self._filter_valid_list_ids(content_lists): ids = self._fetch_list_items(content_type, list_id) unique_ids.update(ids) return list(unique_ids) def _filter_valid_list_ids(self, content_lists: list[str]) -> list[str]: return [list_id for list_id in content_lists if list_id and len(list_id) == 24] def _fetch_list_items(self, content_type: str, list_id: str) -> set[str]: unique_ids = set() page, total_pages = 1, 1 while page <= total_pages: try: data = self._fetch_page(content_type, list_id, page) total_pages = data.get("pages", 1) unique_ids.update(self._extract_ids(content_type, data.get("items", []))) page += 1 except HTTPError as e: if e.response.status_code in [400, 404, 429, 500]: break except Exception as e: logger.error(f"An error occurred: {e}") break return unique_ids def _fetch_page(self, content_type: str, list_id: str, page: int): url = f"api/List/{content_type}/{list_id}/ReleaseDate/Descending/{page}" response = self.request_handler.execute(HttpMethod.GET, url) return response.data def _extract_ids(self, content_type: str, items: list) -> set[str]: ids = set() for item in items: if imdb_id := item.get("imDbId"): ids.add(imdb_id) elif content_type == "Movies" and (tmdb_id := item.get("tmDbId")): if imdb_id := self.trakt_api.get_imdbid_from_tmdb(tmdb_id): ids.add(imdb_id) return ids
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
src/program/apis/listrr_api.py(1 hunks)
🔇 Additional comments (1)
src/program/apis/listrr_api.py (1)
40-40: Correct fix for the validate endpoint path
The change to use an empty string as the endpoint is correct. The base URL is already handled by the ListrrRequestHandler, so passing an empty string prevents double URL prefixing.
Let's verify that this is the only instance where we might have similar URL path issues:
✅ Verification successful
The validate endpoint change is correct and no similar issues exist
The code analysis confirms that:
- The
ListrrRequestHandlercorrectly handles base URL concatenation in the request module (src/program/utils/request.py line 142) - No other instances of incorrect BASE_URL usage as endpoints were found in the Listrr API
- Other APIs (Trakt, Plex, etc.) properly use BASE_URL in their endpoint construction with specific paths
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Search for other potential cases where BASE_URL might be incorrectly used as an endpoint
ast-grep --pattern 'execute($_, self.BASE_URL, $_)'
Length of output: 53
Script:
#!/bin/bash
# Let's try a broader search for BASE_URL usage in method calls
ast-grep --pattern 'self.BASE_URL'
# Also search for execute method calls to see all endpoint patterns
ast-grep --pattern 'execute($_, $_, $_)'
# And let's see the full content of listrr_api.py to understand the context better
rg -l "class ListrrAPI" | xargs cat
Length of output: 5701
| @@ -37,7 +37,7 @@ def __init__(self, api_key: str): | |||
| self.trakt_api = di[TraktAPI] | |||
|
|
|||
| def validate(self): | |||
| return self.request_handler.execute(HttpMethod.GET, self.BASE_URL) | |||
| return self.request_handler.execute(HttpMethod.GET, "") | |||
|
|
|||
| def get_items_from_Listrr(self, content_type, content_lists) -> list[MediaItem] | list[str]: # noqa: C901, PLR0912 | |||
There was a problem hiding this comment.
Type annotation appears inconsistent with implementation
The method is annotated to return list[MediaItem] | list[str], but the implementation only returns a list of IMDb ID strings (list[str]). There's no code path that returns MediaItem objects.
Consider one of these fixes:
-def get_items_from_Listrr(self, content_type, content_lists) -> list[MediaItem] | list[str]:
+def get_items_from_Listrr(self, content_type, content_lists) -> list[str]:Or if MediaItem objects should be returned, update the implementation accordingly.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| def get_items_from_Listrr(self, content_type, content_lists) -> list[MediaItem] | list[str]: # noqa: C901, PLR0912 | |
| def get_items_from_Listrr(self, content_type, content_lists) -> list[str]: # noqa: C901, PLR0912 |
Pull Request Check List
Resolves: #issue-number-here
Description:
Fixes #905