fix: handle missing user theme_preference on sign in

ethanndickson · ethanndickson · commit 404de0d1ade0 · 2025-03-06T13:39:38.000+11:00
diff --git a/Coder Desktop/CoderSDK/Client.swift b/Coder Desktop/CoderSDK/Client.swift
@@ -44,7 +44,7 @@ public struct Client {
             throw .network(error)
         }
         guard let httpResponse = resp as? HTTPURLResponse else {
-            throw .unexpectedResponse(data)
+            throw .unexpectedResponse(String(data: data, encoding: .utf8) ?? "<non-utf8 data>")
         }
         return HTTPResponse(resp: httpResponse, data: data, req: req)
     }
@@ -72,7 +72,7 @@ public struct Client {
 
     func responseAsError(_ resp: HTTPResponse) -> ClientError {
         do {
-            let body = try Client.decoder.decode(Response.self, from: resp.data)
+            let body = try decode(Response.self, from: resp.data)
             let out = APIError(
                 response: body,
                 statusCode: resp.resp.statusCode,
@@ -81,7 +81,24 @@ public struct Client {
             )
             return .api(out)
         } catch {
-            return .unexpectedResponse(resp.data.prefix(1024))
+            return .unexpectedResponse(String(data: resp.data, encoding: .utf8) ?? "<non-utf8 data>")
+        }
+    }
+
+    // Wrapper around JSONDecoder.decode that displays useful error messages from `DecodingError`.
+    func decode<T>(_: T.Type, from data: Data) throws(ClientError) -> T where T: Decodable {
+        do {
+            return try Client.decoder.decode(T.self, from: data)
+        } catch let DecodingError.keyNotFound(_, context) {
+            throw .unexpectedResponse("Key not found: \(context.debugDescription)")
+        } catch let DecodingError.valueNotFound(_, context) {
+            throw .unexpectedResponse("Value not found: \(context.debugDescription)")
+        } catch let DecodingError.typeMismatch(_, context) {
+            throw .unexpectedResponse("Type mismatch: \(context.debugDescription)")
+        } catch let DecodingError.dataCorrupted(context) {
+            throw .unexpectedResponse("Data corrupted: \(context.debugDescription)")
+        } catch {
+            throw .unexpectedResponse(String(data: data.prefix(1024), encoding: .utf8) ?? "<non-utf8 data>")
         }
     }
 }
@@ -119,7 +136,7 @@ public struct FieldValidation: Decodable, Sendable {
 public enum ClientError: Error {
     case api(APIError)
     case network(any Error)
-    case unexpectedResponse(Data)
+    case unexpectedResponse(String)
     case encodeFailure(any Error)
 
     public var description: String {
@@ -129,7 +146,7 @@ public enum ClientError: Error {
         case let .network(error):
             error.localizedDescription
         case let .unexpectedResponse(data):
-            "Unexpected or non HTTP response: \(data)"
+            "Unexpected response: \(data)"
         case let .encodeFailure(error):
             "Failed to encode body: \(error.localizedDescription)"
         }
diff --git a/Coder Desktop/CoderSDK/Deployment.swift b/Coder Desktop/CoderSDK/Deployment.swift
@@ -6,11 +6,7 @@ public extension Client {
         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))
-        }
+        return try decode(BuildInfoResponse.self, from: res.data)
     }
 }
 
diff --git a/Coder Desktop/CoderSDK/User.swift b/Coder Desktop/CoderSDK/User.swift
@@ -6,11 +6,7 @@ public extension Client {
         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))
-        }
+        return try decode(User.self, from: res.data)
     }
 }
 
@@ -25,9 +21,10 @@ public struct User: Encodable, Decodable, Equatable, Sendable {
     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]
+    // Deprecated and missing from responses as of Coder v2.21
+    public let theme_preference: String?
 
     public init(
         id: UUID,

Original file line number	Diff line number	Diff line change
`@@ -6,11 +6,7 @@ public extension Client {`
`6`	`6`	`guard res.resp.statusCode == 200 else {`
`7`	`7`	`throw responseAsError(res)`
`8`	`8`	`}`
`9`		`- do {`
`10`		`- return try Client.decoder.decode(BuildInfoResponse.self, from: res.data)`
`11`		`- } catch {`
`12`		`- throw .unexpectedResponse(res.data.prefix(1024))`
`13`		`- }`
	`9`	`+ return try decode(BuildInfoResponse.self, from: res.data)`
`14`	`10`	`}`
`15`	`11`	`}`
`16`	`12`