fix: add Code-Server authentication support for RooCloud #7263
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,133 @@ | ||
| import * as vscode from "vscode" | ||
| import { isCodeServerEnvironment } from "../../utils/environmentDetection" | ||
|
|
||
| /** | ||
| * Handles authentication for Code-Server environments where OAuth redirects may not work | ||
| */ | ||
| export class CodeServerAuthHandler { | ||
| private static readonly AUTH_TOKEN_KEY = "roocloud.authToken" | ||
| private static readonly MANUAL_AUTH_INSTRUCTIONS = ` | ||
| To authenticate with Roo Code Cloud in Code-Server: | ||
| 1. Open Roo Code in a regular browser or desktop VS Code | ||
| 2. Sign in to Roo Code Cloud there | ||
| 3. Go to Settings > Account and copy your authentication token | ||
| 4. Return here and paste the token when prompted | ||
| Alternatively, you can: | ||
| 1. Visit https://app.roo-code.com/auth/token | ||
|
Contributor
Author
There was a problem hiding this comment. Should this URL be configurable or at least defined as a constant? Hardcoding URLs makes it difficult to test or use different environments. |
||
| 2. Sign in with your account | ||
| 3. Copy the generated token | ||
| 4. Paste it here | ||
| ` | ||
|
|
||
| /** | ||
| * Attempts to handle authentication in Code-Server environment | ||
| * @returns The authentication token if successful, null otherwise | ||
| */ | ||
| public static async handleCodeServerAuth(context: vscode.ExtensionContext): Promise<string | null> { | ||
| if (!isCodeServerEnvironment()) { | ||
| return null | ||
| } | ||
|
|
||
| // Check if we have a stored token | ||
| const storedToken = await context.secrets.get(this.AUTH_TOKEN_KEY) | ||
| if (storedToken) { | ||
| const useStored = await vscode.window.showQuickPick(["Use stored token", "Enter new token"], { | ||
| placeHolder: "A stored authentication token was found. What would you like to do?", | ||
| }) | ||
|
|
||
| if (useStored === "Use stored token") { | ||
| return storedToken | ||
| } | ||
| } | ||
|
|
||
| // Show instructions and prompt for manual token entry | ||
| const action = await vscode.window.showInformationMessage( | ||
| "Code-Server detected: Manual authentication required for Roo Code Cloud", | ||
| "Enter Token", | ||
| "Show Instructions", | ||
| "Cancel", | ||
| ) | ||
|
|
||
| if (action === "Show Instructions") { | ||
| // Create a webview or show a document with detailed instructions | ||
| const doc = await vscode.workspace.openTextDocument({ | ||
| content: this.MANUAL_AUTH_INSTRUCTIONS, | ||
| language: "markdown", | ||
| }) | ||
| await vscode.window.showTextDocument(doc, { preview: true }) | ||
|
|
||
| // After showing instructions, ask again | ||
| const proceed = await vscode.window.showQuickPick(["Enter Token", "Cancel"], { | ||
| placeHolder: "Ready to enter your authentication token?", | ||
| }) | ||
|
|
||
| if (proceed !== "Enter Token") { | ||
| return null | ||
| } | ||
| } else if (action !== "Enter Token") { | ||
| return null | ||
| } | ||
|
|
||
| // Prompt for token input | ||
| const token = await vscode.window.showInputBox({ | ||
| prompt: "Enter your Roo Code Cloud authentication token", | ||
| placeHolder: "Paste your token here", | ||
| password: true, // Hide the token as it's being typed | ||
| ignoreFocusOut: true, | ||
| validateInput: (value) => { | ||
| if (!value || value.trim().length === 0) { | ||
| return "Token cannot be empty" | ||
| } | ||
| // Basic validation - tokens should have a certain format | ||
| if (value.trim().length < 20) { | ||
| return "Token appears to be too short" | ||
| } | ||
| return null | ||
| }, | ||
| }) | ||
|
|
||
| if (!token) { | ||
| return null | ||
| } | ||
|
|
||
| // Store the token securely | ||
| await context.secrets.store(this.AUTH_TOKEN_KEY, token.trim()) | ||
| vscode.window.showInformationMessage("Authentication token saved successfully") | ||
|
|
||
| return token.trim() | ||
| } | ||
|
|
||
| /** | ||
| * Clears the stored authentication token | ||
| */ | ||
| public static async clearStoredToken(context: vscode.ExtensionContext): Promise<void> { | ||
| await context.secrets.delete(this.AUTH_TOKEN_KEY) | ||
| } | ||
|
|
||
| /** | ||
| * Validates if a token is still valid by making a test API call | ||
| */ | ||
| public static async validateToken(token: string, apiUrl: string): Promise<boolean> { | ||
| try { | ||
| // This would need to be implemented based on the actual API | ||
| // For now, we'll assume the token is valid if it exists | ||
| return token.length > 0 | ||
|
Contributor
Author
There was a problem hiding this comment. This validation only checks if the token exists, not if it's actually valid. Could we add a proper validation call to the API here, or at least check the token format? Otherwise invalid tokens will be accepted and stored. |
||
| } catch (error) { | ||
| console.error("Token validation failed:", error) | ||
| return false | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Shows a notification about Code-Server limitations | ||
| */ | ||
| public static showCodeServerLimitations(): void { | ||
| vscode.window.showInformationMessage( | ||
| "Note: Some Roo Code Cloud features may be limited in Code-Server environments. " + | ||
| "For the best experience, use desktop VS Code when possible.", | ||
| "Understood", | ||
| ) | ||
| } | ||
| } | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,155 @@ | ||
| import { describe, it, expect, vi, beforeEach, afterEach } from "vitest" | ||
| import * as vscode from "vscode" | ||
| import { isCodeServerEnvironment, getEnvironmentInfo, shouldUseAlternativeAuth } from "../environmentDetection" | ||
|
|
||
| // Mock vscode module | ||
| vi.mock("vscode", () => ({ | ||
| env: { | ||
| uiKind: 1, // Default to Desktop | ||
| appName: "Visual Studio Code", | ||
| remoteName: undefined, | ||
| }, | ||
| UIKind: { | ||
| Desktop: 1, | ||
| Web: 2, | ||
| }, | ||
| })) | ||
|
|
||
| describe("environmentDetection", () => { | ||
| let originalEnv: NodeJS.ProcessEnv | ||
|
|
||
| beforeEach(() => { | ||
| // Save original environment | ||
| originalEnv = { ...process.env } | ||
| // Clear relevant environment variables | ||
| delete process.env.CODE_SERVER_VERSION | ||
| delete process.env.DOCKER_CONTAINER | ||
| delete process.env.KUBERNETES_SERVICE_HOST | ||
| delete process.env.COOLIFY_CONTAINER_NAME | ||
| delete process.env.COOLIFY_APP_ID | ||
| // Reset vscode mock to default values | ||
| vi.mocked(vscode.env).uiKind = vscode.UIKind.Desktop | ||
| vi.mocked(vscode.env).appName = "Visual Studio Code" | ||
| vi.mocked(vscode.env).remoteName = undefined | ||
| }) | ||
|
|
||
| afterEach(() => { | ||
| // Restore original environment | ||
| process.env = originalEnv | ||
| }) | ||
|
|
||
| describe("isCodeServerEnvironment", () => { | ||
| it("should return true when CODE_SERVER_VERSION is set", () => { | ||
| process.env.CODE_SERVER_VERSION = "4.0.0" | ||
| expect(isCodeServerEnvironment()).toBe(true) | ||
| }) | ||
|
|
||
| it("should return true when running in Web UI", () => { | ||
| vi.mocked(vscode.env).uiKind = vscode.UIKind.Web | ||
| expect(isCodeServerEnvironment()).toBe(true) | ||
| }) | ||
|
|
||
| it("should return false when running in Desktop UI", () => { | ||
| vi.mocked(vscode.env).uiKind = vscode.UIKind.Desktop | ||
| expect(isCodeServerEnvironment()).toBe(false) | ||
| }) | ||
|
|
||
| it("should return true when app name contains code-server", () => { | ||
| vi.mocked(vscode.env).appName = "Code-Server" | ||
| expect(isCodeServerEnvironment()).toBe(true) | ||
| }) | ||
|
|
||
| it("should return true when app name contains code server (with space)", () => { | ||
| vi.mocked(vscode.env).appName = "Code Server" | ||
| expect(isCodeServerEnvironment()).toBe(true) | ||
| }) | ||
|
|
||
| it("should return true when DOCKER_CONTAINER is set and UI is Web", () => { | ||
| process.env.DOCKER_CONTAINER = "true" | ||
| vi.mocked(vscode.env).uiKind = vscode.UIKind.Web | ||
| expect(isCodeServerEnvironment()).toBe(true) | ||
| }) | ||
|
|
||
| it("should return false when DOCKER_CONTAINER is set but UI is Desktop", () => { | ||
| process.env.DOCKER_CONTAINER = "true" | ||
| vi.mocked(vscode.env).uiKind = vscode.UIKind.Desktop | ||
| expect(isCodeServerEnvironment()).toBe(false) | ||
| }) | ||
|
|
||
| it("should return true when KUBERNETES_SERVICE_HOST is set and UI is Web", () => { | ||
| process.env.KUBERNETES_SERVICE_HOST = "10.0.0.1" | ||
| vi.mocked(vscode.env).uiKind = vscode.UIKind.Web | ||
| expect(isCodeServerEnvironment()).toBe(true) | ||
| }) | ||
|
|
||
| it("should return true when COOLIFY_CONTAINER_NAME is set", () => { | ||
| process.env.COOLIFY_CONTAINER_NAME = "my-app" | ||
| expect(isCodeServerEnvironment()).toBe(true) | ||
| }) | ||
|
|
||
| it("should return true when COOLIFY_APP_ID is set", () => { | ||
| process.env.COOLIFY_APP_ID = "app-123" | ||
| expect(isCodeServerEnvironment()).toBe(true) | ||
| }) | ||
|
|
||
| it("should return false in regular desktop VS Code", () => { | ||
| vi.mocked(vscode.env).uiKind = vscode.UIKind.Desktop | ||
| vi.mocked(vscode.env).appName = "Visual Studio Code" | ||
| expect(isCodeServerEnvironment()).toBe(false) | ||
| }) | ||
| }) | ||
|
|
||
| describe("getEnvironmentInfo", () => { | ||
| it("should return correct environment info for desktop VS Code", () => { | ||
| vi.mocked(vscode.env).uiKind = vscode.UIKind.Desktop | ||
| vi.mocked(vscode.env).appName = "Visual Studio Code" | ||
| vi.mocked(vscode.env).remoteName = undefined | ||
|
|
||
| const info = getEnvironmentInfo() | ||
| expect(info).toEqual({ | ||
| isCodeServer: false, | ||
| uiKind: "Desktop", | ||
| appName: "Visual Studio Code", | ||
| isRemote: false, | ||
| }) | ||
| }) | ||
|
|
||
| it("should return correct environment info for Code-Server", () => { | ||
| process.env.CODE_SERVER_VERSION = "4.0.0" | ||
| vi.mocked(vscode.env).uiKind = vscode.UIKind.Web | ||
| vi.mocked(vscode.env).appName = "Code-Server" | ||
| vi.mocked(vscode.env).remoteName = "ssh-remote" | ||
|
|
||
| const info = getEnvironmentInfo() | ||
| expect(info).toEqual({ | ||
| isCodeServer: true, | ||
| uiKind: "Web", | ||
| appName: "Code-Server", | ||
| isRemote: true, | ||
| }) | ||
| }) | ||
|
|
||
| it("should detect remote environment correctly", () => { | ||
| vi.mocked(vscode.env).remoteName = "wsl" | ||
| const info = getEnvironmentInfo() | ||
| expect(info.isRemote).toBe(true) | ||
| }) | ||
| }) | ||
|
|
||
| describe("shouldUseAlternativeAuth", () => { | ||
| it("should return true when in Code-Server environment", () => { | ||
| process.env.CODE_SERVER_VERSION = "4.0.0" | ||
| expect(shouldUseAlternativeAuth()).toBe(true) | ||
| }) | ||
|
|
||
| it("should return false when in desktop VS Code", () => { | ||
| vi.mocked(vscode.env).uiKind = vscode.UIKind.Desktop | ||
| expect(shouldUseAlternativeAuth()).toBe(false) | ||
| }) | ||
|
|
||
| it("should return true when UI is Web", () => { | ||
| vi.mocked(vscode.env).uiKind = vscode.UIKind.Web | ||
| expect(shouldUseAlternativeAuth()).toBe(true) | ||
| }) | ||
| }) | ||
| }) |
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we wrap this in a try-catch? If throws an error other than cancellation, it won't be handled properly.