MILAB-2444: ssh: refactoring: split to more steps

[Snyssfx]

No description provided.

[notion-workspace]

[ml] Restart SSH deployment if any of arguments has changed

[changeset-bot]

⚠️ No Changeset found

Latest commit: 5ab05b9

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[gemini-code-assist]

Summary of Changes

Hello @Snyssfx, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request primarily focuses on improving the debuggability and maintainability of platforma deployments. It achieves this by adding more comprehensive error logging and by refactoring the core initialization logic into a more modular and understandable structure. Additionally, it enhances the developer workflow by introducing new Docker-related commands and updating relevant documentation.

Highlights

• Improved Error Logging: Enhanced error messages during platforma start and stop operations to include stderr logs, providing more detailed diagnostic information for debugging.
• Refactored Platforma Initialization: The platformaInit method has been extensively refactored into a series of smaller, more focused asynchronous steps (doStep... methods). This significantly improves the readability, maintainability, and clarity of the deployment process flow.
• Enhanced Developer Experience: New pnpm scripts have been added to facilitate Docker-based development, and the README.md has been updated with comprehensive instructions for setting up dev containers and managing supervisor commands.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in issue comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments or fill out our survey to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request primarily adds more detailed error logging by capturing stderr from platforma processes, which will be very helpful for debugging. It also includes a significant and beneficial refactoring of the platformaInit method, breaking it down into smaller, more manageable steps.

I've identified a critical issue in the new logic that could prevent fresh installations from succeeding, along with a few other points related to breaking API changes and a new external dependency. The proposed suggestions should address these issues.

[cursor]

Bug: Platforma Initialization and Configuration Issues

The platformaInit method now unconditionally attempts to read existing Platforma configuration. Previously, this was only done if Platforma was already running. This refactoring introduces two bugs:

1. Initialization failure: If no configuration file exists (e.g., on a fresh installation), reading the config will throw an error, preventing initialization.
2. Potential null pointer: The doStepCheckIfMinioIsUsed step accesses state.existedSettings with a non-null assertion, but the null check for existedSettings was moved to a later step (doStepNeedRestart), creating a potential runtime error.

lib/node/pl-deployments/src/ssh/pl.ts#L191-L205

platforma/lib/node/pl-deployments/src/ssh/pl.ts

Lines 191 to 205 in 5ab05b9

	private async doStepReadExistedConfig(
	state: PlatformaInitState,
	onProgress: OnProgressCallback,
	) {
	state.step = 'readExistedConfig';
	await onProgress?.('Reading existed config...');
	state.existedSettings = await readExistedConfig(this.sshClient, state.remoteHome!);
	}
	private async doStepCheckIfMinioIsUsed(state: PlatformaInitState, onProgress: OnProgressCallback) {
	state.step = 'checkIfMinioIsUsed';
	await onProgress?.('Checking if minio is used...');
	state.shouldUseMinio = state.existedSettings!.minioIsUsed ?? false;
	this.logger.info(`SshPl.platformaInit: should use minio? ${state.shouldUseMinio}`);

Fix in Cursor • Fix in Web

---

Bugbot free trial expires on August 3, 2025
Learn more in the Cursor dashboard.

Was this report helpful? Give feedback by reacting with 👍 or 👎