chore: extract CoderSDK to framework

Coder Desktop/Coder Desktop.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved

@@ -1,15 +1,6 @@
 {
-  "originHash" : "1cd4f7368eeddbaa35ef829e13093bc7081a4e6d3da9492d22db0757464ad473",
+  "originHash" : "ec40e522ec1a2416e8e8f5cbe97424ab3e4a614e6ef453c10ea28e84e88b6771",
   "pins" : [
-    {
-      "identity" : "alamofire",
-      "kind" : "remoteSourceControl",
-      "location" : "https://github.com/Alamofire/Alamofire",
-      "state" : {
-        "revision" : "513364f870f6bfc468f9d2ff0a95caccc10044c5",
-        "version" : "5.10.2"
-      }
-    },
     {
       "identity" : "fluid-menu-bar-extra",
       "kind" : "remoteSourceControl",

Coder Desktop/Coder Desktop.xcodeproj/xcshareddata/xcschemes/Coder Desktop.xcscheme

@@ -79,6 +79,17 @@
                ReferencedContainer = "container:Coder Desktop.xcodeproj">
             </BuildableReference>
          </TestableReference>
+         <TestableReference
+            skipped = "NO"
+            parallelizable = "YES">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "AA3B40972D2FC8560099996A"
+               BuildableName = "CoderSDKTests.xctest"
+               BlueprintName = "CoderSDKTests"
+               ReferencedContainer = "container:Coder Desktop.xcodeproj">
+            </BuildableReference>
+         </TestableReference>
       </Testables>
    </TestAction>
    <LaunchAction

Coder Desktop/Coder Desktop.xctestplan

@@ -19,8 +19,17 @@
     {
       "target" : {
         "containerPath" : "container:Coder Desktop.xcodeproj",
-        "identifier" : "9616790E2CFF100E00B2B6DF",
-        "name" : "Coder DesktopTests"
+        "identifier" : "AA3B40972D2FC8560099996A",
+        "name" : "CoderSDKTests"
+      }
+    },
+    {
+      "enabled" : false,
+      "parallelizable" : true,
+      "target" : {
+        "containerPath" : "container:Coder Desktop.xcodeproj",
+        "identifier" : "961679182CFF100E00B2B6DF",
+        "name" : "Coder DesktopUITests"
       }
     },
     {
@@ -31,12 +40,10 @@
       }
     },
     {
-      "enabled" : false,
-      "parallelizable" : true,
       "target" : {
         "containerPath" : "container:Coder Desktop.xcodeproj",
-        "identifier" : "961679182CFF100E00B2B6DF",
-        "name" : "Coder DesktopUITests"
+        "identifier" : "9616790E2CFF100E00B2B6DF",
+        "name" : "Coder DesktopTests"
       }
     }
   ],

Coder Desktop/Coder Desktop/Coder_DesktopApp.swift

@@ -11,7 +11,7 @@ struct DesktopApp: App {
             EmptyView()
         }
         Window("Sign In", id: Windows.login.rawValue) {
-            LoginForm<PreviewClient, PreviewSession>()
+            LoginForm<PreviewSession>()
         }.environmentObject(appDelegate.session)
             .windowResizability(.contentSize)
     }

Coder Desktop/Coder Desktop/Views/LoginForm.swift

@@ -1,6 +1,7 @@
+import CoderSDK
 import SwiftUI
 
-struct LoginForm<C: Client, S: Session>: View {
+struct LoginForm<S: Session>: View {
     @EnvironmentObject var session: S
     @Environment(\.dismiss) private var dismiss
 
@@ -69,7 +70,7 @@ struct LoginForm<C: Client, S: Session>: View {
         }
         loading = true
         defer { loading = false }
-        let client = C(url: url, token: sessionToken)
+        let client = Client(url: url, token: sessionToken)
         do {
             _ = try await client.user("me")
         } catch {
@@ -188,6 +189,6 @@ enum LoginField: Hashable {
 }
 
 #Preview {
-    LoginForm<PreviewClient, PreviewSession>()
+    LoginForm<PreviewSession>()
         .environmentObject(PreviewSession())
 }

Coder Desktop/Coder DesktopTests/LoginFormTests.swift

@@ -1,4 +1,6 @@
 @testable import Coder_Desktop
+@testable import CoderSDK
+import Mocker
 import SwiftUI
 import Testing
 import ViewInspector
@@ -7,12 +9,12 @@ import ViewInspector
 @Suite(.timeLimit(.minutes(1)))
 struct LoginTests {
     let session: MockSession
-    let sut: LoginForm<MockClient, MockSession>
+    let sut: LoginForm<MockSession>
     let view: any View
 
     init() {
         session = MockSession()
-        sut = LoginForm<MockClient, MockSession>()
+        sut = LoginForm<MockSession>()
         view = sut.environmentObject(session)
     }
 
@@ -68,14 +70,16 @@ struct LoginTests {
 
     @Test
     func testFailedAuthentication() async throws {
-        let login = LoginForm<MockErrorClient, MockSession>()
+        let login = LoginForm<MockSession>()
+        let url = URL(string: "https://testFailedAuthentication.com")!
+        Mock(url: url.appendingPathComponent("/api/v2/users/me"), statusCode: 401, data: [.get: Data()]).register()
 
         try await ViewHosting.host(login.environmentObject(session)) {
             try await login.inspection.inspect { view in
-                try view.find(ViewType.TextField.self).setInput("https://coder.example.com")
+                try view.find(ViewType.TextField.self).setInput(url.absoluteString)
                 try view.find(button: "Next").tap()
                 #expect(throws: Never.self) { try view.find(text: "Session Token") }
-                try view.find(ViewType.SecureField.self).setInput("valid-token")
+                try view.find(ViewType.SecureField.self).setInput("invalid-token")
                 try await view.actualView().submit()
                 #expect(throws: Never.self) { try view.find(ViewType.Alert.self) }
             }
@@ -84,9 +88,33 @@ struct LoginTests {
 
     @Test
     func testSuccessfulLogin() async throws {
+        let url = URL(string: "https://testSuccessfulLogin.com")!
+
+        let user = User(
+            id: UUID(),
+            username: "admin",
+            avatar_url: "",
+            name: "admin",
+            email: "[email protected]",
+            created_at: Date.now,
+            updated_at: Date.now,
+            last_seen_at: Date.now,
+            status: "active",
+            login_type: "none",
+            theme_preference: "dark",
+            organization_ids: [],
+            roles: []
+        )
+
+        try Mock(
+            url: url.appendingPathComponent("/api/v2/users/me"),
+            statusCode: 200,
+            data: [.get: Client.encoder.encode(user)]
+        ).register()
+
         try await ViewHosting.host(view) {
             try await sut.inspection.inspect { view in
-                try view.find(ViewType.TextField.self).setInput("https://coder.example.com")
+                try view.find(ViewType.TextField.self).setInput(url.absoluteString)
                 try view.find(button: "Next").tap()
                 try view.find(ViewType.SecureField.self).setInput("valid-token")
                 try await view.actualView().submit()

Coder Desktop/Coder DesktopTests/Util.swift

@@ -27,7 +27,7 @@ class MockVPNService: VPNService, ObservableObject {
 
 class MockSession: Session {
     @Published
-    var hasSession: Bool = true
+    var hasSession: Bool = false
     @Published
     var sessionToken: String? = "fake-token"
     @Published
@@ -50,33 +50,4 @@ class MockSession: Session {
     }
 }
 
-struct MockClient: Client {
-    init(url _: URL, token _: String? = nil) {}
-
-    func user(_: String) async throws(ClientError) -> Coder_Desktop.User {
-        User(
-            id: UUID(),
-            username: "admin",
-            avatar_url: "",
-            name: "admin",
-            email: "admin@coder.com",
-            created_at: Date.now,
-            updated_at: Date.now,
-            last_seen_at: Date.now,
-            status: "active",
-            login_type: "none",
-            theme_preference: "dark",
-            organization_ids: [],
-            roles: []
-        )
-    }
-}
-
-struct MockErrorClient: Client {
-    init(url _: URL, token _: String?) {}
-    func user(_: String) async throws(ClientError) -> Coder_Desktop.User {
-        throw .reqError(.explicitlyCancelled)
-    }
-}
-
 extension Inspection: @unchecked Sendable, @retroactive InspectionEmissary {}

Coder Desktop/Coder DesktopTests/VPNMenuTests.swift

@@ -104,6 +104,7 @@ struct VPNMenuTests {
 
     @Test
     func testOffWhenFailed() async throws {
+        session.hasSession = true
         try await ViewHosting.host(view) {
             try await sut.inspection.inspect { view in
                 let toggle = try view.find(ViewType.Toggle.self)

Coder Desktop/CoderSDK/Client.swift

@@ -0,0 +1,137 @@
+import Foundation
+
+public struct Client {
+    public let url: URL
+    public var token: String?
+    public var headers: [HTTPHeader]
+
+    public init(url: URL, token: String? = nil, headers: [HTTPHeader] = []) {
+        self.url = url
+        self.token = token
+        self.headers = headers
+    }
+
+    static let decoder: JSONDecoder = {
+        var dec = JSONDecoder()
+        dec.dateDecodingStrategy = .iso8601withOptionalFractionalSeconds
+        return dec
+    }()
+
+    static let encoder: JSONEncoder = {
+        var enc = JSONEncoder()
+        enc.dateEncodingStrategy = .iso8601withFractionalSeconds
+        return enc
+    }()
+
+    private func doRequest(
+        path: String,
+        method: HTTPMethod,
+        body: Data? = nil
+    ) async throws(ClientError) -> HTTPResponse {
+        let url = self.url.appendingPathComponent(path)
+        var req = URLRequest(url: url)
+        if let token { req.addValue(token, forHTTPHeaderField: Headers.sessionToken) }
+        req.httpMethod = method.rawValue
+        for header in headers {
+            req.addValue(header.value, forHTTPHeaderField: header.header)
+        }
+        req.httpBody = body
+        let data: Data
+        let resp: URLResponse
+        do {
+            (data, resp) = try await URLSession.shared.data(for: req)
+        } catch {
+            throw .network(error)
+        }
+        guard let httpResponse = resp as? HTTPURLResponse else {
+            throw .unexpectedResponse(data)
+        }
+        return HTTPResponse(resp: httpResponse, data: data, req: req)
+    }
+
+    func request<T: Encodable & Sendable>(
+        _ path: String,
+        method: HTTPMethod,
+        body: T
+    ) async throws(ClientError) -> HTTPResponse {
+        let encodedBody: Data?
+        do {
+            encodedBody = try Client.encoder.encode(body)
+        } catch {
+            throw .encodeFailure(error)
+        }
+        return try await doRequest(path: path, method: method, body: encodedBody)
+    }
+
+    func request(
+        _ path: String,
+        method: HTTPMethod
+    ) async throws(ClientError) -> HTTPResponse {
+        return try await doRequest(path: path, method: method)
+    }
+
+    func responseAsError(_ resp: HTTPResponse) -> ClientError {
+        do {
+            let body = try Client.decoder.decode(Response.self, from: resp.data)
+            let out = APIError(
+                response: body,
+                statusCode: resp.resp.statusCode,
+                method: resp.req.httpMethod!,
+                url: resp.req.url!
+            )
+            return .api(out)
+        } catch {
+            return .unexpectedResponse(resp.data.prefix(1024))
+        }
+    }
+}
+
+public struct APIError: Decodable {
+    let response: Response
+    let statusCode: Int
+    let method: String
+    let url: URL
+
+    var description: String {
+        var components = ["\(method) \(url.absoluteString)\nUnexpected status code \(statusCode):\n\(response.message)"]
+        if let detail = response.detail {
+            components.append("\tError: \(detail)")
+        }
+        if let validations = response.validations, !validations.isEmpty {
+            let validationMessages = validations.map { "\t\($0.field): \($0.detail)" }
+            components.append(contentsOf: validationMessages)
+        }
+        return components.joined(separator: "\n")
+    }
+}
+
+public struct Response: Decodable {
+    let message: String
+    let detail: String?
+    let validations: [FieldValidation]?
+}
+
+public struct FieldValidation: Decodable {
+    let field: String
+    let detail: String
+}
+
+public enum ClientError: Error {
+    case api(APIError)
+    case network(any Error)
+    case unexpectedResponse(Data)
+    case encodeFailure(any Error)
+
+    public var description: String {
+        switch self {
+        case let .api(error):
+            return error.description
+        case let .network(error):
+            return error.localizedDescription
+        case let .unexpectedResponse(data):
+            return "Unexpected or non HTTP response: \(data)"
+        case let .encodeFailure(error):
+            return "Failed to encode body: \(error)"
+        }
+    }
+}

Coder Desktop/CoderSDK/CoderSDK.h

@@ -0,0 +1,11 @@
+#import <Foundation/Foundation.h>
+
+//! Project version number for CoderSDK.
+FOUNDATION_EXPORT double CoderSDKVersionNumber;
+
+//! Project version string for CoderSDK.
+FOUNDATION_EXPORT const unsigned char CoderSDKVersionString[];
+
+// In this header, you should import all the public headers of your framework using statements like #import <CoderSDK/PublicHeader.h>
+
+

Coder Desktop/Coder Desktop/SDK/Date.swift → Coder Desktop/CoderSDK/Date.swift

@@ -28,3 +28,9 @@ extension JSONEncoder.DateEncodingStrategy {
         try container.encode($0.formatted(.iso8601withFractionalSeconds))
     }
 }
+
+public extension Date {
+    static func == (lhs: Date, rhs: Date) -> Bool {
+        abs(lhs.timeIntervalSince1970 - rhs.timeIntervalSince1970) < 0.001
+    }
+}

Coder Desktop/CoderSDK/Deployment.swift

@@ -0,0 +1,32 @@
+public extension Client {
+    func buildInfo() async throws(ClientError) -> BuildInfoResponse {
+        let res = try await request("/api/v2/buildinfo", method: .get)
+        guard res.resp.statusCode == 200 else {
+            throw responseAsError(res)
+        }
+        do {
+            return try Client.decoder.decode(BuildInfoResponse.self, from: res.data)
+        } catch {
+            throw .unexpectedResponse(res.data.prefix(1024))
+        }
+    }
+}
+
+public struct BuildInfoResponse: Encodable, Decodable, Equatable, Sendable {
+    public let external_url: String
+    public let version: String
+    public let dashboard_url: String
+    public let telemetry: Bool
+    public let workspace_proxy: Bool
+    public let agent_api_version: String
+    public let provisioner_api_version: String
+    public let upgrade_message: String
+    public let deployment_id: String
+
+    // `version` in the form `[0-9]+.[0-9]+.[0-9]+`
+    public var semver: String? {
+        return try? NSRegularExpression(pattern: #"v(\d+\.\d+\.\d+)"#)
+            .firstMatch(in: version, range: NSRange(version.startIndex ..< version.endIndex, in: version))
+            .flatMap { Range($0.range(at: 1), in: version).map { String(version[$0]) } }
+    }
+}

Coder Desktop/CoderSDK/HTTP.swift

@@ -0,0 +1,26 @@
+public struct HTTPResponse {
+    let resp: HTTPURLResponse
+    let data: Data
+    let req: URLRequest
+}
+
+public struct HTTPHeader: Sendable {
+    public let header: String
+    public let value: String
+    public init(header: String, value: String) {
+        self.header = header
+        self.value = value
+    }
+}
+
+enum HTTPMethod: String, Equatable, Hashable, Sendable {
+    case get = "GET"
+    case post = "POST"
+    case delete = "DELETE"
+    case put = "PUT"
+    case head = "HEAD"
+}
+
+enum Headers {
+    static let sessionToken = "Coder-Session-Token"
+}

Coder Desktop/CoderSDK/User.swift

@@ -0,0 +1,73 @@
+import Foundation
+
+public extension Client {
+    func user(_ ident: String) async throws(ClientError) -> User {
+        let res = try await request("/api/v2/users/\(ident)", method: .get)
+        guard res.resp.statusCode == 200 else {
+            throw responseAsError(res)
+        }
+        do {
+            return try Client.decoder.decode(User.self, from: res.data)
+        } catch {
+            throw .unexpectedResponse(res.data.prefix(1024))
+        }
+    }
+}
+
+public struct User: Encodable, Decodable, Equatable, Sendable {
+    public let id: UUID
+    public let username: String
+    public let avatar_url: String
+    public let name: String
+    public let email: String
+    public let created_at: Date
+    public let updated_at: Date
+    public let last_seen_at: Date
+    public let status: String
+    public let login_type: String
+    public let theme_preference: String
+    public let organization_ids: [UUID]
+    public let roles: [Role]
+
+    public init(
+        id: UUID,
+        username: String,
+        avatar_url: String,
+        name: String,
+        email: String,
+        created_at: Date,
+        updated_at: Date,
+        last_seen_at: Date,
+        status: String,
+        login_type: String,
+        theme_preference: String,
+        organization_ids: [UUID],
+        roles: [Role]
+    ) {
+        self.id = id
+        self.username = username
+        self.avatar_url = avatar_url
+        self.name = name
+        self.email = email
+        self.created_at = created_at
+        self.updated_at = updated_at
+        self.last_seen_at = last_seen_at
+        self.status = status
+        self.login_type = login_type
+        self.theme_preference = theme_preference
+        self.organization_ids = organization_ids
+        self.roles = roles
+    }
+}
+
+public struct Role: Encodable, Decodable, Equatable, Sendable {
+    public let name: String
+    public let display_name: String
+    public let organization_id: UUID?
+
+    public init(name: String, display_name: String, organization_id: UUID?) {
+        self.name = name
+        self.display_name = display_name
+        self.organization_id = organization_id
+    }
+}

Coder Desktop/CoderSDKTests/CoderSDKTests.swift

@@ -0,0 +1,76 @@
+@testable import CoderSDK
+import Mocker
+import Testing
+
+@Suite(.timeLimit(.minutes(1)))
+struct CoderSDKTests {
+    @Test
+    func user() async throws {
+        let now = Date.now
+        let user = User(
+            id: UUID(),
+            username: "johndoe",
+            avatar_url: "https://example.com/img.png",
+            name: "John Doe",
+            email: "john.doe@example.com",
+            created_at: now,
+            updated_at: now,
+            last_seen_at: now,
+            status: "active",
+            login_type: "email",
+            theme_preference: "dark",
+            organization_ids: [UUID()],
+            roles: [
+                Role(name: "user", display_name: "User", organization_id: UUID()),
+            ]
+        )
+
+        let url = URL(string: "https://example.com")!
+        let token = "fake-token"
+        let client = Client(url: url, token: token, headers: [.init(header: "X-Test-Header", value: "foo")])
+        var mock = try Mock(
+            url: url.appending(path: "api/v2/users/johndoe"),
+            contentType: .json,
+            statusCode: 200,
+            data: [.get: Client.encoder.encode(user)]
+        )
+        var correctHeaders = false
+        mock.onRequestHandler = OnRequestHandler { req in
+            correctHeaders = req.value(forHTTPHeaderField: Headers.sessionToken) == token &&
+                req.value(forHTTPHeaderField: "X-Test-Header") == "foo"
+        }
+        mock.register()
+
+        let retUser = try await client.user(user.username)
+        #expect(user == retUser)
+        #expect(correctHeaders)
+    }
+
+    @Test
+    func buildInfo() async throws {
+        let buildInfo = BuildInfoResponse(
+            external_url: "https://example.com",
+            version: "v2.18.2-devel+630fd7c0a",
+            dashboard_url: "https://example.com/dashboard",
+            telemetry: true,
+            workspace_proxy: false,
+            agent_api_version: "1.0",
+            provisioner_api_version: "1.2",
+            upgrade_message: "foo",
+            deployment_id: UUID().uuidString
+        )
+
+        let url = URL(string: "https://example.com")!
+        let client = Client(url: url)
+        try Mock(
+            url: url.appending(path: "api/v2/buildinfo"),
+            contentType: .json,
+            statusCode: 200,
+            data: [.get: Client.encoder.encode(buildInfo)]
+        ).register()
+
+        let retBuildInfo = try await client.buildInfo()
+        #expect(buildInfo == retBuildInfo)
+        #expect(retBuildInfo.semver == "2.18.2")
+    }
+}

Coder Desktop/VPN/Manager.swift

@@ -1,3 +1,4 @@
+import CoderSDK
 import NetworkExtension
 import os
 import VPNLib
@@ -30,8 +31,18 @@ actor Manager {
         } catch {
             throw .download(error)
         }
+        let client = Client(url: cfg.serverUrl)
+        let buildInfo: BuildInfoResponse
         do {
-            try SignatureValidator.validate(path: dest)
+            buildInfo = try await client.buildInfo()
+        } catch {
+            throw .serverInfo(error.description)
+        }
+        guard let semver = buildInfo.semver else {
+            throw .serverInfo("invalid version: \(buildInfo.version)")
+        }
+        do {
+            try SignatureValidator.validate(path: dest, expectedVersion: semver)
         } catch {
             throw .validation(error)
         }
@@ -181,6 +192,7 @@ enum ManagerError: Error {
     case validation(ValidationError)
     case incorrectResponse(Vpn_TunnelMessage)
     case failedRPC(any Error)
+    case serverInfo(String)
     case errorResponse(msg: String)
     case noTunnelFileDescriptor
 }

Coder Desktop/VPNLib/Download.swift

@@ -37,15 +37,15 @@ public class SignatureValidator {
     private static let expectedName = "CoderVPN"
     private static let expectedIdentifier = "com.coder.Coder-Desktop.VPN.dylib"
     private static let expectedTeamIdentifier = "4399GN35BJ"
-    private static let minDylibVersion = "2.18.1"
 
     private static let infoIdentifierKey = "CFBundleIdentifier"
     private static let infoNameKey = "CFBundleName"
     private static let infoShortVersionKey = "CFBundleShortVersionString"
 
     private static let signInfoFlags: SecCSFlags = .init(rawValue: kSecCSSigningInformation)
 
-    public static func validate(path: URL) throws(ValidationError) {
+    // `expectedVersion` must be of the form `[0-9]+.[0-9]+.[0-9]+`
+    public static func validate(path: URL, expectedVersion: String) throws(ValidationError) {
         guard FileManager.default.fileExists(atPath: path.path) else {
             throw .fileNotFound
         }
@@ -94,7 +94,7 @@ public class SignatureValidator {
         }
 
         guard let dylibVersion = infoPlist[infoShortVersionKey] as? String,
-              minDylibVersion.compare(dylibVersion, options: .numeric) != .orderedDescending
+              expectedVersion.compare(dylibVersion, options: .numeric) != .orderedDescending
         else {
             throw .invalidVersion(version: infoPlist[infoShortVersionKey] as? String)
         }