Refactor storage.ts into testable modules and add unit tests #589
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
EhabY
commented
Sep 22, 2025
| @@ -0,0 +1,142 @@ | |||
| import { vi } from "vitest"; | |||
There was a problem hiding this comment.
Sadly we have to duplicate this "vscode" definition manually for tests because we cannot just import VS Code types
EhabY
commented
Sep 22, 2025
Comment on lines
+43
to
+47
| private readonly logger: Logger, | ||
| private readonly pathResolver: PathResolver, | ||
| private readonly mementoManager: MementoManager, | ||
| private readonly secretsManager: SecretsManager, | ||
| private readonly binaryManager: BinaryManager, |
There was a problem hiding this comment.
Potentially I can introduce something like a ServiceContainer that contains all our services/data objects
| /** | ||
| * Migrate the session token file from "session_token" to "session", if needed. | ||
| */ | ||
| private async migrateSessionToken(label: string) { |
There was a problem hiding this comment.
This util will be cleaned up as part of the effort for refactoring the remote.ts
| * Code API to get the contents of an output panel. We use this to get the | ||
| * active port so we can display network information. | ||
| */ | ||
| private async getRemoteSSHLogPath(): Promise<string | undefined> { |
EhabY
force-pushed
the
untangle-storage-ts
branch
from
878914a to
4ae208b
Compare
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.
Closes #588
This PR refactors
storage.tsinto small, isolated modules that are straightforward to unit test (with mocks). It also upgradesvitestto a version that plays nicely with VS Code extensions, so we can view coverage, run and debug tests directly in VS Code.VS Code Test Explorer:
Screencast.from.2025-09-22.16-54-03.webm
Why mock
vscode?With the current VS Code Extension API, we essentially have two testing layers:
vscode) : Validate our module's behavior independently of the VS Code API and external calls (e.g., Axios). These are fast, reliable, and cover most logic.By mocking
vscodefor unit tests, we keep feedback tight and deterministic, while reserving integration tests for end-to-end scenarios that require the actual runtime.