core:services:kraken: Reduce install function code complexity
#3627
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
* Reduce code complexity of install function by spliting in multiple parts
Reviewer's GuideRefactor install method into modular helpers to streamline extension installation flow by extracting disabling, settings setup, authentication, image pulling, and cleanup steps into separate functions. Sequence diagram for refactored install process in ExtensionsequenceDiagram
participant E as Extension
participant S as ExtensionSettings
participant D as DockerCtx
participant Auth as Docker Auth
participant Other as Other Extension Tags
E->>E: _disable_running_extension()
E->>E: _create_extension_settings()
E->>E: _prepare_docker_auth()
E->>D: _pull_docker_image(docker_auth)
D-->>E: progress updates
E->>E: _clear_remaining_tags()
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
joaomariolago
requested review from
joaoantoniocardoso,
nicoschmdt and
patrickelectric
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey there - I've reviewed your changes and they look great!
Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments
### Comment 1
<location> `core/services/kraken/extension/extension.py:173-178` </location>
<code_context>
self._save_settings(new_extension)
+ return new_extension
+
+ def _prepare_docker_auth(self) -> Optional[str]:
+ """Prepare Docker authentication string from source auth credentials."""
+ if self.source.auth is None:
+ return None
+ docker_auth = f"{self.source.auth.username}:{self.source.auth.password}"
+ return base64.b64encode(docker_auth.encode("utf-8")).decode("utf-8")
+
+ async def _pull_docker_image(self, docker_auth: Optional[str]) -> AsyncGenerator[bytes, None]:
</code_context>
<issue_to_address>
**suggestion:** Consider handling empty username or password in Docker auth preparation.
Validate that both username and password are non-empty before encoding, and raise an error if either is missing to prevent invalid Docker auth strings.
```suggestion
def _prepare_docker_auth(self) -> Optional[str]:
"""Prepare Docker authentication string from source auth credentials."""
if self.source.auth is None:
return None
username = getattr(self.source.auth, "username", None)
password = getattr(self.source.auth, "password", None)
if not username or not password:
raise ValueError("Docker authentication requires both non-empty username and password.")
docker_auth = f"{username}:{password}"
return base64.b64encode(docker_auth.encode("utf-8")).decode("utf-8")
```
</issue_to_address>
### Comment 2
<location> `core/services/kraken/extension/extension.py:206` </location>
<code_context>
+ # First we should make sure no other tag is running
+ running_ext = await self._disable_running_extension()
+ self._create_extension_settings()
try:
self.lock(self.unique_entry)
</code_context>
<issue_to_address>
**suggestion (bug_risk):** Extension settings are created before acquiring the lock.
Moving the creation and saving of extension settings inside the locked section will prevent race conditions during concurrent installs.
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Comment on lines
+173
to
+178
| def _prepare_docker_auth(self) -> Optional[str]: | ||
| """Prepare Docker authentication string from source auth credentials.""" | ||
| if self.source.auth is None: | ||
| return None | ||
| docker_auth = f"{self.source.auth.username}:{self.source.auth.password}" | ||
| return base64.b64encode(docker_auth.encode("utf-8")).decode("utf-8") |
There was a problem hiding this comment.
suggestion: Consider handling empty username or password in Docker auth preparation.
Validate that both username and password are non-empty before encoding, and raise an error if either is missing to prevent invalid Docker auth strings.
Suggested change
| def _prepare_docker_auth(self) -> Optional[str]: | |
| """Prepare Docker authentication string from source auth credentials.""" | |
| if self.source.auth is None: | |
| return None | |
| docker_auth = f"{self.source.auth.username}:{self.source.auth.password}" | |
| return base64.b64encode(docker_auth.encode("utf-8")).decode("utf-8") | |
| def _prepare_docker_auth(self) -> Optional[str]: | |
| """Prepare Docker authentication string from source auth credentials.""" | |
| if self.source.auth is None: | |
| return None | |
| username = getattr(self.source.auth, "username", None) | |
| password = getattr(self.source.auth, "password", None) | |
| if not username or not password: | |
| raise ValueError("Docker authentication requires both non-empty username and password.") | |
| docker_auth = f"{username}:{password}" | |
| return base64.b64encode(docker_auth.encode("utf-8")).decode("utf-8") |
| # First we should make sure no other tag is running | ||
| running_ext = await self._disable_running_extension() | ||
|
|
||
| self._create_extension_settings() |
There was a problem hiding this comment.
suggestion (bug_risk): Extension settings are created before acquiring the lock.
Moving the creation and saving of extension settings inside the locked section will prevent race conditions during concurrent installs.
patrickelectric
approved these changes
Nov 5, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary by Sourcery
Refactor the install function by extracting its substeps into private helper methods to reduce complexity and improve readability
Enhancements:
_disable_running_extension_create_extension_settings_prepare_docker_auth_pull_docker_image_clear_remaining_tagsinstallmethod by orchestrating the new helper methods