improve diagnostics when registry configuration is broken (#6331)

tomerd · MaxDesiatov · web-flow · commit d52001bb7fad · 2023-03-27T14:13:11.000-07:00
motivation: better user experience

changes: catch the JSON error and wrap it with a more detailed diagnostics

Co-authored-by: Max Desiatov &lt;m_desiatov@apple.com&gt;
diff --git a/Sources/Workspace/Workspace+Configuration.swift b/Sources/Workspace/Workspace+Configuration.swift
@@ -684,9 +684,12 @@ extension Workspace.Configuration {
                 return RegistryConfiguration()
             }
 
-            let data: Data = try fileSystem.readFileContents(self.path)
-            let decoder = JSONDecoder.makeWithDefaults()
-            return try decoder.decode(RegistryConfiguration.self, from: data)
+            do {
+                let decoder = JSONDecoder.makeWithDefaults()
+                return try decoder.decode(path: self.path, fileSystem: self.fileSystem, as: RegistryConfiguration.self)
+            } catch {
+                throw StringError("Failed loading registries configuration from '\(self.path)': \(error)")
+            }
         }
 
         public func save(_ configuration: RegistryConfiguration) throws {

Original file line number	Diff line number	Diff line change
`@@ -684,9 +684,12 @@ extension Workspace.Configuration {`
`684`	`684`	`return RegistryConfiguration()`
`685`	`685`	`}`
`686`	`686`
`687`		`- let data: Data = try fileSystem.readFileContents(self.path)`
`688`		`- let decoder = JSONDecoder.makeWithDefaults()`
`689`		`- return try decoder.decode(RegistryConfiguration.self, from: data)`
	`687`	`+ do {`
	`688`	`+ let decoder = JSONDecoder.makeWithDefaults()`
	`689`	`+ return try decoder.decode(path: self.path, fileSystem: self.fileSystem, as: RegistryConfiguration.self)`
	`690`	`+ } catch {`
	`691`	`+ throw StringError("Failed loading registries configuration from '\(self.path)': \(error)")`
	`692`	`+ }`
`690`	`693`	`}`
`691`	`694`
`692`	`695`	`public func save(_ configuration: RegistryConfiguration) throws {`