Merge pull request #21 from lucka-me/query-metadata-before-update

Query metadata before update
lucka-me · Mar 5, 2024 · 1ad210d · 1ad210d
2 parents b2ceafa + dc30a4a
commit 1ad210d
Show file tree

Hide file tree

Showing 6 changed files with 90 additions and 41 deletions.
diff --git a/App/Shared/Data/ScriptManager+Task.swift b/App/Shared/Data/ScriptManager+Task.swift
@@ -16,11 +16,7 @@ extension ScriptManager {
 }
 
 extension ScriptManager {
-    func updateScripts(reporting progress: Progress) async throws {
-        defer {
-            progress.completedUnitCount = 0
-        }
-
+    func updateScripts(reporting progress: Progress, currentMainScriptVersion: String?) async throws {        
         try Self.ensureInternalDirectories()
 
         let internalPlugins = try internalPluginNames
@@ -41,7 +37,7 @@ extension ScriptManager {
         let channel = UserDefaults.shared.buildChannel
         try await withThrowingTaskGroup(of: Void.self) { group in
             group.addTask {
-                try await Self.downloadMainScript(from: channel)
+                try await Self.downloadMainScript(from: channel, currentVersion: currentMainScriptVersion)
                 await MainActor.run { progress.completedUnitCount += 1 }
             }
 
@@ -82,13 +78,23 @@ extension ScriptManager {
         }
     }
 
-    static func downloadMainScript(from channel: BuildChannel) async throws {
-        let downloadURL = Self.websiteBuildURL
+    static func downloadMainScript(from channel: BuildChannel, currentVersion: String?) async throws {
+        let scriptURL = Self.websiteBuildURL
             .appending(path: channel.rawValue)
             .appending(path: FileConstants.mainScriptFilename)
-            .appendingPathExtension("user.js")
+        if let currentVersion {
+            // Check version from metadata
+            guard await checkUpdate(
+                from: scriptURL.appendingPathExtension(FileConstants.scriptMetadataExtension),
+                currentVersion: currentVersion
+            ) else {
+                return
+            }
+        }
 
-        let temporaryURL = try await URLSession.shared.download(from: downloadURL)
+        let temporaryURL = try await URLSession.shared.download(
+            from: scriptURL.appendingPathExtension(FileConstants.userScriptExtension)
+        )
 
         let fileManager = FileManager.default
         var succeed = false
@@ -110,12 +116,30 @@ extension ScriptManager {
     }
 
     func downloadInternalPlugin(_ filename: String, from channel: BuildChannel) async throws {
-        let downloadURL = Self.websiteBuildURL
+        let predicate = #Predicate<Plugin> {
+            $0.isInternal && $0.filename == filename
+        }
+        var descriptor = FetchDescriptor(predicate: predicate)
+        descriptor.fetchLimit = 1
+        let item = try modelContext.fetch(descriptor).first
+
+        let pluginURL = Self.websiteBuildURL
             .appending(path: channel.rawValue)
             .appending(path: "plugins")
             .appending(path: filename)
-            .appendingPathExtension("user.js")
-        let temporaryURL = try await URLSession.shared.download(from: downloadURL)
+        if let currentVersion = item?.version {
+            // Check version from metadata
+            guard await Self.checkUpdate(
+                from: pluginURL.appendingPathExtension(FileConstants.scriptMetadataExtension),
+                currentVersion: currentVersion
+            ) else {
+                return
+            }
+        }
+
+        let temporaryURL = try await URLSession.shared.download(
+            from: pluginURL.appendingPathExtension(FileConstants.userScriptExtension)
+        )
 
         let fileManager = FileManager.default
         var succeed = false
@@ -136,12 +160,7 @@ extension ScriptManager {
         }
         try fileManager.moveItem(at: temporaryURL, to: destinationURL)
 
-        let predicate = #Predicate<Plugin> {
-            $0.isInternal && $0.filename == filename
-        }
-        var descriptor = FetchDescriptor(predicate: predicate)
-        descriptor.fetchLimit = 1
-        if let item = try modelContext.fetch(descriptor).first {
+        if let item {
             item.update(from: metadata)
         } else {
             let item = Plugin(metadata: metadata, isInternal: true, filename: filename)
@@ -171,7 +190,13 @@ fileprivate extension ScriptManager {
     static var websiteBuildURL: URL { .init(string: "https://iitc.app/build/")! }
 
     private func updateExternal(plugin: Plugin, in externalURL: URL) async throws {
-        // TODO: Use updateURL to fetch metadata
+        if let currentVersion = plugin.version, let updateURL = plugin.updateURL {
+            // Check version from update URL
+            guard await Self.checkUpdate(from: updateURL, currentVersion: currentVersion) else {
+                return
+            }
+        }
+
         guard let downloadURL = plugin.downloadURL else { return }
         let temporaryURL = try await URLSession.shared.download(from: downloadURL)
 
@@ -210,3 +235,23 @@ fileprivate extension ScriptManager {
         }
     }
 }
+
+fileprivate extension ScriptManager {
+    static func checkUpdate(from url: URL, currentVersion: String) async -> Bool {
+        // Allow all errors
+        guard
+            let data = try? await URLSession.shared.data(from: url),
+            let content = String(data: data, encoding: .utf8),
+            let updateVersion = try? UserScriptMetadataDecoder()
+                .decode(VersionedMetadata.self, from: content)
+                .version
+        else {
+            return false
+        }
+        return updateVersion != currentVersion
+    }
+}
+
+fileprivate struct VersionedMetadata : Decodable {
+    var version: String
+}
diff --git a/App/Shared/IntelStackApp.swift b/App/Shared/IntelStackApp.swift
@@ -95,9 +95,12 @@ struct IntelStackApp: App {
     @MainActor
     private func updatePlugins() async throws {
         guard updateStatus == .idle else { return }
+        updateProgress.completedUnitCount = 0
         updateStatus = .updating
         defer { updateStatus = .idle }
-        try await scriptManager.updateScripts(reporting: updateProgress)
+        try await scriptManager.updateScripts(
+            reporting: updateProgress, currentMainScriptVersion: mainScriptVersion
+        )
         updateMainScriptVersion()
     }
 }
diff --git a/App/Shared/Views/CommunityPluginListView.swift b/App/Shared/Views/CommunityPluginListView.swift
@@ -174,9 +174,7 @@ struct CommunityPluginListView: View {
                 }
             }
 
-            if
-                let homepageURLString = preview.metadata.homepageURL,
-                let homepageURL = URL(string: homepageURLString) {
+            if let homepageURL = preview.metadata.homepageURL {
                 Link(destination: homepageURL) {
                     Label("CommunityPluginListView.Homepage", systemImage: "house")
                         .capsule(.green)

diff --git a/Shared/Data/PluginMetadata.swift b/Shared/Data/PluginMetadata.swift
@@ -14,11 +14,11 @@ struct PluginMetadata : Decodable {
 
     var author: String?
     var description: String?
-    var downloadURL: String?
-    var updateURL: String?
+    var downloadURL: URL?
+    var updateURL: URL?
     var version: String?
 
-    var homepageURL: String?
+    var homepageURL: URL?
 }
 
 extension Plugin {
@@ -34,12 +34,8 @@ extension Plugin {
         self.author = metadata.author
         self.scriptDescription = metadata.description
         self.version = metadata.version
-        if let downloadURL = metadata.downloadURL {
-            self.downloadURL = URL(string: downloadURL)
-        }
-        if let updateURL = metadata.updateURL {
-            self.updateURL = URL(string: updateURL)
-        }
+        self.downloadURL = metadata.downloadURL
+        self.updateURL = metadata.updateURL
     }
 
     func update(from metadata: PluginMetadata) {
@@ -48,11 +44,7 @@ extension Plugin {
         self.author = metadata.author
         self.scriptDescription = metadata.description
         self.version = metadata.version
-        if let downloadURL = metadata.downloadURL {
-            self.downloadURL = URL(string: downloadURL)
-        }
-        if let updateURL = metadata.updateURL {
-            self.updateURL = URL(string: updateURL)
-        }
+        self.downloadURL = metadata.downloadURL
+        self.updateURL = metadata.updateURL
     }
 }
diff --git a/Shared/Data/UserScriptMetadataDecoder.swift b/Shared/Data/UserScriptMetadataDecoder.swift
@@ -169,7 +169,7 @@ fileprivate struct KeyedContainer<Key: CodingKey> : KeyedDecodingContainerProtoc
         try value(of: key)
     }
 
-    func decode<T>(_ type: T.Type, forKey key: Key) throws -> T where T : Decodable {
+    func decode<T : Decodable>(_ type: T.Type, forKey key: Key) throws -> T {
         let rawValue = try rawValue(of: key)
         switch type {
         case let aType as LosslessStringConvertible.Type:
@@ -185,6 +185,17 @@ fileprivate struct KeyedContainer<Key: CodingKey> : KeyedDecodingContainerProtoc
                 )
             }
             return value as! T
+        case let aType as URL.Type:
+            guard let value = aType.init(string: rawValue) else {
+                throw DecodingError.typeMismatch(
+                    type,
+                    .init(
+                        codingPath: [ key ],
+                        debugDescription: "The raw value \(rawValue) can not be converted into \(type)"
+                    )
+                )
+            }
+            return value as! T
         // TODO: Add more cases if needed
         default:
             throw DecodingError.typeMismatch(

diff --git a/Tests/UserScriptMetadataDecoderTests.swift b/Tests/UserScriptMetadataDecoderTests.swift
@@ -60,7 +60,7 @@ final class UserScriptMetadataDecoderTests: XCTestCase {
         XCTAssertEqual(metadata.author, author)
         XCTAssertEqual(metadata.description, description)
         XCTAssertNil(metadata.downloadURL)
-        XCTAssertEqual(metadata.updateURL, updateURL)
+        XCTAssertEqual(metadata.updateURL, .init(string: updateURL)!)
         XCTAssertEqual(metadata.version, version)
     }