feat: add workspace apps #136
+680
−37
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
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
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,209 @@ | ||
| import CoderSDK | ||
| import os | ||
| import SDWebImageSwiftUI | ||
| import SwiftUI | ||
|
|
||
| struct WorkspaceAppIcon: View { | ||
| let app: WorkspaceApp | ||
| @Environment(\.openURL) private var openURL | ||
|
|
||
| @State var isHovering: Bool = false | ||
| @State var isPressed = false | ||
|
|
||
| var body: some View { | ||
| Group { | ||
| Group { | ||
| WebImage( | ||
| url: app.icon, | ||
| context: [.imageThumbnailPixelSize: Theme.Size.appIconSize] | ||
| ) { $0 } | ||
| placeholder: { | ||
| if app.icon != nil { | ||
| ProgressView() | ||
| } else { | ||
| Text(app.displayName).frame( | ||
| width: Theme.Size.appIconWidth, | ||
| height: Theme.Size.appIconHeight | ||
| ) | ||
| } | ||
| }.frame( | ||
| width: Theme.Size.appIconWidth, | ||
| height: Theme.Size.appIconHeight | ||
| ) | ||
| }.padding(4) | ||
| } | ||
| .clipShape(RoundedRectangle(cornerRadius: 8)) | ||
| .overlay( | ||
| RoundedRectangle(cornerRadius: Theme.Size.rectCornerRadius * 2) | ||
| .stroke(.secondary, lineWidth: 1) | ||
| .opacity(isHovering && !isPressed ? 0.6 : 0.3) | ||
| ).onHoverWithPointingHand { hovering in isHovering = hovering } | ||
| .simultaneousGesture( | ||
| DragGesture(minimumDistance: 0) | ||
| .onChanged { _ in | ||
| withAnimation(.easeInOut(duration: 0.1)) { | ||
| isPressed = true | ||
| } | ||
| } | ||
| .onEnded { _ in | ||
| withAnimation(.easeInOut(duration: 0.1)) { | ||
| isPressed = false | ||
| } | ||
| openURL(app.url) | ||
| } | ||
| ).help(app.displayName) | ||
| } | ||
| } | ||
|
|
||
| struct WorkspaceApp { | ||
| let slug: String | ||
| let displayName: String | ||
| let url: URL | ||
| let icon: URL? | ||
|
|
||
| var id: String { slug } | ||
|
|
||
| private static let magicTokenString = "$SESSION_TOKEN" | ||
|
|
||
| init(slug: String, displayName: String, url: URL, icon: URL?) { | ||
| self.slug = slug | ||
| self.displayName = displayName | ||
| self.url = url | ||
| self.icon = icon | ||
| } | ||
|
|
||
| init( | ||
| _ original: CoderSDK.WorkspaceApp, | ||
| iconBaseURL: URL, | ||
| sessionToken: String | ||
| ) throws(WorkspaceAppError) { | ||
| slug = original.slug | ||
| displayName = original.display_name | ||
|
|
||
| guard original.external else { | ||
| throw .isWebApp | ||
| } | ||
|
|
||
| guard let originalUrl = original.url else { | ||
| throw .missingURL | ||
| } | ||
|
|
||
| if let command = original.command, !command.isEmpty { | ||
| throw .isCommandApp | ||
| } | ||
|
|
||
| // We don't want to show buttons for any websites, like internal wikis | ||
| // or portals. Those *should* have 'external' set, but if they don't: | ||
| guard originalUrl.scheme != "https", originalUrl.scheme != "http" else { | ||
| throw .isWebApp | ||
| } | ||
|
|
||
| let newUrlString = originalUrl.absoluteString.replacingOccurrences( | ||
| of: Self.magicTokenString, | ||
| with: sessionToken | ||
| ) | ||
| guard let newUrl = URL(string: newUrlString) else { | ||
| throw .invalidURL | ||
| } | ||
| url = newUrl | ||
|
|
||
| var icon = original.icon | ||
| if let originalIcon = original.icon, | ||
| var components = URLComponents(url: originalIcon, resolvingAgainstBaseURL: false) | ||
| { | ||
| if components.host == nil { | ||
| components.port = iconBaseURL.port | ||
| components.scheme = iconBaseURL.scheme | ||
| components.host = iconBaseURL.host(percentEncoded: false) | ||
| } | ||
|
|
||
| if let newIconURL = components.url { | ||
| icon = newIconURL | ||
| } | ||
| } | ||
| self.icon = icon | ||
| } | ||
| } | ||
|
|
||
| enum WorkspaceAppError: Error { | ||
| case invalidURL | ||
| case missingURL | ||
| case isCommandApp | ||
| case isWebApp | ||
|
|
||
| var description: String { | ||
| switch self { | ||
| case .invalidURL: | ||
| "Invalid URL" | ||
| case .missingURL: | ||
| "Missing URL" | ||
| case .isCommandApp: | ||
| "is a Command App" | ||
| case .isWebApp: | ||
| "is an External App" | ||
| } | ||
| } | ||
|
|
||
| var localizedDescription: String { description } | ||
| } | ||
|
|
||
| func agentToApps( | ||
| _ logger: Logger, | ||
| _ agent: CoderSDK.WorkspaceAgent, | ||
| _ host: String, | ||
| _ baseAccessURL: URL, | ||
| _ sessionToken: String | ||
| ) -> [WorkspaceApp] { | ||
| let workspaceApps = agent.apps.compactMap { app in | ||
| do throws(WorkspaceAppError) { | ||
| return try WorkspaceApp(app, iconBaseURL: baseAccessURL, sessionToken: sessionToken) | ||
| } catch { | ||
| logger.warning("Skipping WorkspaceApp '\(app.slug)' for \(host): \(error.localizedDescription)") | ||
| return nil | ||
| } | ||
| } | ||
|
|
||
| let displayApps = agent.display_apps.compactMap { displayApp in | ||
| switch displayApp { | ||
| case .vscode: | ||
| return vscodeDisplayApp( | ||
| hostname: host, | ||
| baseIconURL: baseAccessURL, | ||
| path: agent.expanded_directory | ||
| ) | ||
| case .vscode_insiders: | ||
| return vscodeInsidersDisplayApp( | ||
| hostname: host, | ||
| baseIconURL: baseAccessURL, | ||
| path: agent.expanded_directory | ||
| ) | ||
| default: | ||
| logger.info("Skipping DisplayApp '\(displayApp.rawValue)' for \(host)") | ||
| return nil | ||
| } | ||
| } | ||
|
|
||
| return displayApps + workspaceApps | ||
| } | ||
|
|
||
| func vscodeDisplayApp(hostname: String, baseIconURL: URL, path: String? = nil) -> WorkspaceApp { | ||
| let icon = baseIconURL.appendingPathComponent("/icon/code.svg") | ||
| return WorkspaceApp( | ||
| // Leading hyphen as to not conflict with a real app slug, since we only use | ||
| // slugs as SwiftUI IDs | ||
| slug: "-vscode", | ||
| displayName: "VS Code Desktop", | ||
| url: URL(string: "vscode://vscode-remote/ssh-remote+\(hostname)/\(path ?? "")")!, | ||
| icon: icon | ||
| ) | ||
| } | ||
|
|
||
| func vscodeInsidersDisplayApp(hostname: String, baseIconURL: URL, path: String? = nil) -> WorkspaceApp { | ||
| let icon = baseIconURL.appendingPathComponent("/icon/code.svg") | ||
| return WorkspaceApp( | ||
| slug: "-vscode-insiders", | ||
| displayName: "VS Code Insiders Desktop", | ||
| url: URL(string: "vscode-insiders://vscode-remote/ssh-remote+\(hostname)/\(path ?? "")")!, | ||
| icon: icon | ||
| ) | ||
| } |
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,243 @@ | ||
| @testable import Coder_Desktop | ||
| import CoderSDK | ||
| import os | ||
| import Testing | ||
|
|
||
| @MainActor | ||
| @Suite | ||
| struct WorkspaceAppTests { | ||
| let logger = Logger(subsystem: "com.coder.Coder-Desktop-Tests", category: "WorkspaceAppTests") | ||
| let baseAccessURL = URL(string: "https://coder.example.com")! | ||
| let sessionToken = "test-session-token" | ||
| let host = "test-workspace.coder.test" | ||
|
|
||
| @Test | ||
| func testCreateWorkspaceApp_Success() throws { | ||
| let sdkApp = CoderSDK.WorkspaceApp( | ||
| id: UUID(), | ||
| url: URL(string: "vscode://myworkspace.coder/foo")!, | ||
| external: true, | ||
| slug: "test-app", | ||
| display_name: "Test App", | ||
| command: nil, | ||
| icon: URL(string: "/icon/test-app.svg")!, | ||
| subdomain: false, | ||
| subdomain_name: nil | ||
| ) | ||
|
|
||
| let workspaceApp = try WorkspaceApp( | ||
| sdkApp, | ||
| iconBaseURL: baseAccessURL, | ||
| sessionToken: sessionToken | ||
| ) | ||
|
|
||
| #expect(workspaceApp.slug == "test-app") | ||
| #expect(workspaceApp.displayName == "Test App") | ||
| #expect(workspaceApp.url.absoluteString == "vscode://myworkspace.coder/foo") | ||
| #expect(workspaceApp.icon?.absoluteString == "https://coder.example.com/icon/test-app.svg") | ||
| } | ||
|
|
||
| @Test | ||
| func testCreateWorkspaceApp_SessionTokenReplacement() throws { | ||
| let sdkApp = CoderSDK.WorkspaceApp( | ||
| id: UUID(), | ||
| url: URL(string: "vscode://myworkspace.coder/foo?token=$SESSION_TOKEN")!, | ||
| external: true, | ||
| slug: "token-app", | ||
| display_name: "Token App", | ||
| command: nil, | ||
| icon: URL(string: "/icon/test-app.svg")!, | ||
| subdomain: false, | ||
| subdomain_name: nil | ||
| ) | ||
|
|
||
| let workspaceApp = try WorkspaceApp( | ||
| sdkApp, | ||
| iconBaseURL: baseAccessURL, | ||
| sessionToken: sessionToken | ||
| ) | ||
|
|
||
| #expect( | ||
| workspaceApp.url.absoluteString == "vscode://myworkspace.coder/foo?token=test-session-token" | ||
| ) | ||
| } | ||
|
|
||
| @Test | ||
| func testCreateWorkspaceApp_MissingURL() throws { | ||
| let sdkApp = CoderSDK.WorkspaceApp( | ||
| id: UUID(), | ||
| url: nil, | ||
| external: true, | ||
| slug: "no-url-app", | ||
| display_name: "No URL App", | ||
| command: nil, | ||
| icon: nil, | ||
| subdomain: false, | ||
| subdomain_name: nil | ||
| ) | ||
|
|
||
| #expect(throws: WorkspaceAppError.missingURL) { | ||
| try WorkspaceApp( | ||
| sdkApp, | ||
| iconBaseURL: baseAccessURL, | ||
| sessionToken: sessionToken | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| func testCreateWorkspaceApp_CommandApp() throws { | ||
| let sdkApp = CoderSDK.WorkspaceApp( | ||
| id: UUID(), | ||
| url: URL(string: "vscode://myworkspace.coder/foo")!, | ||
| external: true, | ||
| slug: "command-app", | ||
| display_name: "Command App", | ||
| command: "echo 'hello'", | ||
| icon: nil, | ||
| subdomain: false, | ||
| subdomain_name: nil | ||
| ) | ||
|
|
||
| #expect(throws: WorkspaceAppError.isCommandApp) { | ||
| try WorkspaceApp( | ||
| sdkApp, | ||
| iconBaseURL: baseAccessURL, | ||
| sessionToken: sessionToken | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| func testDisplayApps_VSCode() throws { | ||
| let agent = createMockAgent(displayApps: [.vscode, .web_terminal, .ssh_helper, .port_forwarding_helper]) | ||
|
|
||
| let apps = agentToApps(logger, agent, host, baseAccessURL, sessionToken) | ||
|
|
||
| #expect(apps.count == 1) | ||
| #expect(apps[0].slug == "-vscode") | ||
| #expect(apps[0].displayName == "VS Code Desktop") | ||
| #expect(apps[0].url.absoluteString == "vscode://vscode-remote/ssh-remote+test-workspace.coder.test//home/user") | ||
| #expect(apps[0].icon?.absoluteString == "https://coder.example.com/icon/code.svg") | ||
| } | ||
|
|
||
| @Test | ||
| func testDisplayApps_VSCodeInsiders() throws { | ||
| let agent = createMockAgent( | ||
| displayApps: [ | ||
| .vscode_insiders, | ||
| .web_terminal, | ||
| .ssh_helper, | ||
| .port_forwarding_helper, | ||
| ] | ||
| ) | ||
|
|
||
| let apps = agentToApps(logger, agent, host, baseAccessURL, sessionToken) | ||
|
|
||
| #expect(apps.count == 1) | ||
| #expect(apps[0].slug == "-vscode-insiders") | ||
| #expect(apps[0].displayName == "VS Code Insiders Desktop") | ||
| #expect(apps[0].icon?.absoluteString == "https://coder.example.com/icon/code.svg") | ||
| #expect( | ||
| apps[0].url.absoluteString == """ | ||
| vscode-insiders://vscode-remote/ssh-remote+test-workspace.coder.test//home/user | ||
| """ | ||
| ) | ||
| } | ||
|
|
||
| @Test | ||
| func testCreateWorkspaceApp_WebAppFilter() throws { | ||
| let sdkApp = CoderSDK.WorkspaceApp( | ||
| id: UUID(), | ||
| url: URL(string: "https://myworkspace.coder/foo")!, | ||
| external: false, | ||
| slug: "web-app", | ||
| display_name: "Web App", | ||
| command: nil, | ||
| icon: URL(string: "/icon/web-app.svg")!, | ||
| subdomain: false, | ||
| subdomain_name: nil | ||
| ) | ||
|
|
||
| #expect(throws: WorkspaceAppError.isWebApp) { | ||
| try WorkspaceApp( | ||
| sdkApp, | ||
| iconBaseURL: baseAccessURL, | ||
| sessionToken: sessionToken | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| func testAgentToApps_MultipleApps() throws { | ||
| let sdkApp1 = CoderSDK.WorkspaceApp( | ||
| id: UUID(), | ||
| url: URL(string: "vscode://myworkspace.coder/foo1")!, | ||
| external: true, | ||
| slug: "app1", | ||
| display_name: "App 1", | ||
| command: nil, | ||
| icon: URL(string: "/icon/foo1.svg")!, | ||
| subdomain: false, | ||
| subdomain_name: nil | ||
| ) | ||
|
|
||
| let sdkApp2 = CoderSDK.WorkspaceApp( | ||
| id: UUID(), | ||
| url: URL(string: "jetbrains://myworkspace.coder/foo2")!, | ||
| external: true, | ||
| slug: "app2", | ||
| display_name: "App 2", | ||
| command: nil, | ||
| icon: URL(string: "/icon/foo2.svg")!, | ||
| subdomain: false, | ||
| subdomain_name: nil | ||
| ) | ||
|
|
||
| // Command app; skipped | ||
| let sdkApp3 = CoderSDK.WorkspaceApp( | ||
| id: UUID(), | ||
| url: URL(string: "vscode://myworkspace.coder/foo3")!, | ||
| external: true, | ||
| slug: "app3", | ||
| display_name: "App 3", | ||
| command: "echo 'skip me'", | ||
| icon: nil, | ||
| subdomain: false, | ||
| subdomain_name: nil | ||
| ) | ||
|
|
||
| // Web app skipped | ||
| let sdkApp4 = CoderSDK.WorkspaceApp( | ||
| id: UUID(), | ||
| url: URL(string: "https://myworkspace.coder/foo4")!, | ||
| external: true, | ||
| slug: "app4", | ||
| display_name: "App 4", | ||
| command: nil, | ||
| icon: URL(string: "/icon/foo4.svg")!, | ||
| subdomain: false, subdomain_name: nil | ||
| ) | ||
|
|
||
| let agent = createMockAgent(apps: [sdkApp1, sdkApp2, sdkApp3, sdkApp4], displayApps: [.vscode]) | ||
| let apps = agentToApps(logger, agent, host, baseAccessURL, sessionToken) | ||
|
|
||
| #expect(apps.count == 3) | ||
| let appSlugs = apps.map(\.slug) | ||
| #expect(appSlugs.contains("app1")) | ||
| #expect(appSlugs.contains("app2")) | ||
| #expect(appSlugs.contains("-vscode")) | ||
| } | ||
|
|
||
| private func createMockAgent( | ||
| apps: [CoderSDK.WorkspaceApp] = [], | ||
| displayApps: [DisplayApp] = [] | ||
| ) -> CoderSDK.WorkspaceAgent { | ||
| CoderSDK.WorkspaceAgent( | ||
| id: UUID(), | ||
| expanded_directory: "/home/user", | ||
| apps: apps, | ||
| display_apps: displayApps | ||
| ) | ||
| } | ||
| } |
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,98 @@ | ||
| public extension Client { | ||
| func workspace(_ id: UUID) async throws(SDKError) -> Workspace { | ||
| let res = try await request("/api/v2/workspaces/\(id.uuidString)", method: .get) | ||
| guard res.resp.statusCode == 200 else { | ||
| throw responseAsError(res) | ||
| } | ||
| return try decode(Workspace.self, from: res.data) | ||
| } | ||
| } | ||
|
|
||
| public struct Workspace: Codable, Identifiable, Sendable { | ||
| public let id: UUID | ||
| public let name: String | ||
| public let latest_build: WorkspaceBuild | ||
|
|
||
| public init(id: UUID, name: String, latest_build: WorkspaceBuild) { | ||
| self.id = id | ||
| self.name = name | ||
| self.latest_build = latest_build | ||
| } | ||
| } | ||
|
|
||
| public struct WorkspaceBuild: Codable, Identifiable, Sendable { | ||
| public let id: UUID | ||
| public let resources: [WorkspaceResource] | ||
|
|
||
| public init(id: UUID, resources: [WorkspaceResource]) { | ||
| self.id = id | ||
| self.resources = resources | ||
| } | ||
| } | ||
|
|
||
| public struct WorkspaceResource: Codable, Identifiable, Sendable { | ||
| public let id: UUID | ||
| public let agents: [WorkspaceAgent]? // `omitempty` | ||
|
|
||
| public init(id: UUID, agents: [WorkspaceAgent]?) { | ||
| self.id = id | ||
| self.agents = agents | ||
| } | ||
| } | ||
|
|
||
| public struct WorkspaceAgent: Codable, Identifiable, Sendable { | ||
| public let id: UUID | ||
| public let expanded_directory: String? // `omitempty` | ||
| public let apps: [WorkspaceApp] | ||
| public let display_apps: [DisplayApp] | ||
|
|
||
| public init(id: UUID, expanded_directory: String?, apps: [WorkspaceApp], display_apps: [DisplayApp]) { | ||
| self.id = id | ||
| self.expanded_directory = expanded_directory | ||
| self.apps = apps | ||
| self.display_apps = display_apps | ||
| } | ||
| } | ||
|
|
||
| public struct WorkspaceApp: Codable, Identifiable, Sendable { | ||
| public let id: UUID | ||
| // Not `omitempty`, but `coderd` sends empty string if `command` is set | ||
| public var url: URL? | ||
| public let external: Bool | ||
| public let slug: String | ||
| public let display_name: String | ||
| public let command: String? // `omitempty` | ||
| public let icon: URL? // `omitempty` | ||
| public let subdomain: Bool | ||
| public let subdomain_name: String? // `omitempty` | ||
|
|
||
| public init( | ||
| id: UUID, | ||
| url: URL?, | ||
| external: Bool, | ||
| slug: String, | ||
| display_name: String, | ||
| command: String?, | ||
| icon: URL?, | ||
| subdomain: Bool, | ||
| subdomain_name: String? | ||
| ) { | ||
| self.id = id | ||
| self.url = url | ||
| self.external = external | ||
| self.slug = slug | ||
| self.display_name = display_name | ||
| self.command = command | ||
| self.icon = icon | ||
| self.subdomain = subdomain | ||
| self.subdomain_name = subdomain_name | ||
| } | ||
| } | ||
|
|
||
| public enum DisplayApp: String, Codable, Sendable { | ||
| case vscode | ||
| case vscode_insiders | ||
| case web_terminal | ||
| case port_forwarding_helper | ||
| case ssh_helper | ||
| } |
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
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.
Uh oh!
There was an error while loading. Please reload this page.
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.
SwiftUI has a great
AsyncImageView, but it doesn't support svgs. FWICT there's not even a public macOS API for rendering them.I also found this https://gist.github.com/erezhod/6e8e6af3c940d88a706a9d936c8838e6, but it doesn't have a license attached, and I didn't feel like reaching out to the two separate authors to ask.