1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
|
import Foundation
import Observation
import AppKit
struct UpdateReleaseInfo: Equatable {
let tagName: String
let displayVersion: String
let versionNumber: Double
let buildNumber: Int
let notes: String
let downloadURL: URL
let assetName: String
}
struct AppUpdateMessage: Equatable {
enum Kind {
case info
case success
case error
}
let title: String
let detail: String
let kind: Kind
}
@Observable
final class AppUpdate {
static let shared = AppUpdate()
private init() {}
private enum CheckTrigger {
case automatic
case manual
}
var isChecking = false
var isDownloading = false
var showWindow = false
var release: UpdateReleaseInfo?
var releases: [UpdateReleaseInfo] = []
var message: AppUpdateMessage?
var userInitiated = false
var releaseNotesCombined: String?
// MARK: - Configuration
private let releasesURL = URL(string: "https://api.github.com/repos/mierau/hotline/releases?per_page=100")!
private let remindInterval: TimeInterval = 60 * 60 * 24 * 14
private let defaults = UserDefaults.standard
private let remindDateKey = "update.remind.date"
private let lastPromptedVersionKey = "update.last.prompt.version"
// MARK: - API
func checkForUpdatesOnLaunch() async {
await checkForUpdates(trigger: .automatic)
}
func checkForUpdatesManually() async {
await checkForUpdates(trigger: .manual)
}
@MainActor
func startDownload() {
guard let release, isDownloading == false else { return }
isDownloading = true
message = nil
Task(priority: .userInitiated) {
await self.downloadRelease(release)
}
}
@MainActor
func remindLater() {
guard let release else {
resetAndCloseWindow()
return
}
recordPrompt(for: release, remindLater: true)
resetAndCloseWindow()
}
@MainActor
func acknowledgeMessage() {
resetAndCloseWindow()
}
@MainActor
func handleWindowDismissed() {
guard showWindow else { return }
resetAndCloseWindow()
}
// MARK: - Implementation
private func checkForUpdates(trigger: CheckTrigger) async {
await MainActor.run {
self.isChecking = true
self.userInitiated = (trigger == .manual)
self.message = nil
self.releases = []
self.release = nil
self.releaseNotesCombined = nil
self.isDownloading = false
if trigger == .manual {
self.showWindow = false
}
}
do {
let newerReleases = try await fetchNewerReleases()
let latestRelease = newerReleases.first
let shouldShow: Bool
switch trigger {
case .manual:
shouldShow = latestRelease != nil
case .automatic:
if let latestRelease {
shouldShow = shouldPrompt(for: latestRelease)
} else {
shouldShow = false
}
}
await MainActor.run {
self.isChecking = false
if shouldShow, let latestRelease {
self.release = latestRelease
self.releases = newerReleases
self.releaseNotesCombined = combinedReleaseNotes(from: newerReleases)
self.isDownloading = false
self.message = nil
self.showWindow = true
} else {
self.release = nil
self.releases = []
self.releaseNotesCombined = nil
self.isDownloading = false
if trigger == .manual {
self.showUpToDateAlert()
// self.message = AppUpdateMessage(
// title: "Hotline is up to date",
// detail: "You're running the latest and greatest.",
// kind: .success
// )
// self.showWindow = true
} else {
self.message = nil
self.showWindow = false
}
}
}
} catch {
await MainActor.run {
self.isChecking = false
self.release = nil
self.releases = []
self.releaseNotesCombined = nil
self.isDownloading = false
if trigger == .manual {
self.message = AppUpdateMessage(
title: "Unable to Check for Updates",
detail: error.localizedDescription,
kind: .error
)
self.showWindow = true
}
}
}
}
private func showUpToDateAlert() {
let alert = NSAlert()
alert.messageText = "No Update Available"
alert.informativeText = "You are already using the latest version of Hotline!"
alert.runModal()
}
private func fetchNewerReleases() async throws -> [UpdateReleaseInfo] {
let (data, _) = try await URLSession.shared.data(from: releasesURL)
guard let jsonArray = try JSONSerialization.jsonObject(with: data, options: []) as? [[String: Any]] else {
throw NSError(domain: "AppUpdate", code: -10, userInfo: [NSLocalizedDescriptionKey: "Malformed GitHub releases response."])
}
let parsed = jsonArray.compactMap(parseRelease)
let newer = parsed.filter(isReleaseNewer)
return newer
}
private func parseRelease(_ json: [String: Any]) -> UpdateReleaseInfo? {
guard let tagName = json["tag_name"] as? String else {
return nil
}
let notes = (json["body"] as? String) ?? ""
guard
let assets = json["assets"] as? [[String: Any]],
let asset = assets.first,
let downloadString = asset["browser_download_url"] as? String,
let downloadURL = URL(string: downloadString)
else {
return nil
}
let assetName = (asset["name"] as? String) ?? downloadURL.lastPathComponent
let versionPattern = #"^([0-9\.]+)beta([0-9]+)"#
guard let regex = try? NSRegularExpression(pattern: versionPattern, options: []) else {
return nil
}
let range = NSRange(location: 0, length: tagName.utf16.count)
guard let match = regex.firstMatch(in: tagName, options: [], range: range),
match.numberOfRanges >= 3,
let versionRange = Range(match.range(at: 1), in: tagName),
let buildRange = Range(match.range(at: 2), in: tagName),
let versionNumber = Double(String(tagName[versionRange])),
let buildNumber = Int(String(tagName[buildRange]))
else {
return nil
}
let versionComponent = String(tagName[versionRange])
let buildComponent = String(tagName[buildRange])
let displayVersion = "\(versionComponent)b\(buildComponent)"
return UpdateReleaseInfo(
tagName: tagName,
displayVersion: displayVersion,
versionNumber: versionNumber,
buildNumber: buildNumber,
notes: notes,
downloadURL: downloadURL,
assetName: assetName
)
}
private func combinedReleaseNotes(from releases: [UpdateReleaseInfo]) -> String? {
guard let firstRelease = releases.first else { return nil }
let firstNotes = firstRelease.notes.trimmingCharacters(in: .whitespacesAndNewlines)
let firstBody = firstNotes.isEmpty ? "_No release notes provided._" : firstNotes
guard releases.count > 1 else {
return firstBody
}
let olderSections = releases.dropFirst().map { release -> String in
let trimmed = release.notes.trimmingCharacters(in: .whitespacesAndNewlines)
let body = trimmed.isEmpty ? "_No release notes provided._" : trimmed
return "## Hotline \(release.displayVersion)\n\n\(body)"
}
let olderCombined = olderSections.joined(separator: "\n\n---\n\n")
return "\(firstBody)\n\n---\n\n\(olderCombined)"
}
private func downloadRelease(_ release: UpdateReleaseInfo) async {
do {
let (temporaryURL, _) = try await URLSession.shared.download(from: release.downloadURL)
let destinationURL = URL.downloadsDirectory.appendingPathComponent(release.assetName)
if FileManager.default.fileExists(atPath: destinationURL.path) {
try? FileManager.default.removeItem(at: destinationURL)
}
try FileManager.default.moveItem(at: temporaryURL, to: destinationURL)
await MainActor.run {
self.isDownloading = false
NSWorkspace.shared.activateFileViewerSelecting([destinationURL])
self.resetAndCloseWindow()
}
} catch {
await MainActor.run {
self.isDownloading = false
self.message = AppUpdateMessage(
title: "Download Failed",
detail: error.localizedDescription,
kind: .error
)
self.showWindow = true
}
}
}
private func currentApplicationVersion() -> (version: Double, build: Int) {
let info = Bundle.main.infoDictionary ?? [:]
let versionString = info["CFBundleShortVersionString"] as? String ?? "0"
let buildString = info["CFBundleVersion"] as? String ?? "0"
let version = Double(versionString) ?? 0
let build = Int(buildString) ?? 0
return (version, build)
}
private func isReleaseNewer(_ release: UpdateReleaseInfo) -> Bool {
let current = currentApplicationVersion()
if release.versionNumber > current.version {
return true
}
if release.versionNumber == current.version {
return release.buildNumber > current.build
}
return false
}
private func shouldPrompt(for release: UpdateReleaseInfo) -> Bool {
if defaults.string(forKey: lastPromptedVersionKey) != release.tagName {
return true
}
guard let remindDate = defaults.object(forKey: remindDateKey) as? Date else {
return true
}
return remindDate <= Date()
}
@MainActor
private func recordPrompt(for release: UpdateReleaseInfo, remindLater: Bool) {
defaults.set(release.tagName, forKey: lastPromptedVersionKey)
if remindLater {
let nextReminder = Date().addingTimeInterval(remindInterval)
defaults.set(nextReminder, forKey: remindDateKey)
} else {
defaults.removeObject(forKey: remindDateKey)
}
}
@MainActor
private func resetAndCloseWindow() {
isChecking = false
isDownloading = false
release = nil
releases = []
releaseNotesCombined = nil
message = nil
userInitiated = false
showWindow = false
}
}
|