[MINI-6258]Download Miniapp (#525)

* Download Miniapp

* SDK Changes

* Demo app changes

* Sample app changes

* TC fix

* Changelog

Author: rleojoseph

CHANGELOG.md

@@ -1,5 +1,14 @@
 ## CHANGELOG
 
+### 5.4.0 (2023-08-29)
+**SDK**
+- **Feature:** Added a new interface `downloadMiniApp(appId:versionId:completionHandler:)` to download Miniapp from platform in background if needed.
+- **Feature:** Added a utility method to know if Miniapp has beend downloaded properly. `isMiniAppCacheAvailable(appId: String, versionId:)`
+- **Refactor:** Updated unzip Miniapp method with optional completion handler that will let the host app know if the download is success. `unzipMiniApp(fileName:miniAppId:versionId:completionHandler:)`
+
+**Sample App**
+- **Feature:** Added Menu in list view to Download and check if Miniapp is downloaded already.
+
 ### 5.3.1 (2023-08-02)
 **SDK**
 - **Feature:** Updated `loadFromBundle(miniAppManifest:completionHandler)` interface with optional MiniAppManifest object. 

Example/Controllers/SwiftUI/Features/List/MiniAppListRowCell.swift

@@ -1,11 +1,16 @@
 import SwiftUI
+import MiniApp
 
 struct MiniAppListRowCell: View {
 
     @State var iconUrl: URL?
     @State var displayName: String
+    @State var miniAppId: String
     @State var versionTag: String
     @State var versionId: String
+    @State var listType: ListType
+    @State private var showingAlert = false
+    @State private var alertDescription = "false"
 
     var body: some View {
         HStack {
@@ -17,6 +22,9 @@ struct MiniAppListRowCell: View {
                             .resizable()
                             .aspectRatio(contentMode: .fill)
                             .frame(width: 40, height: 40, alignment: .center)
+                            .contextMenu {
+                                menuItems
+                            }
                     }, placeholder: {
                         Rectangle()
                             .fill(Color(.systemGray3))
@@ -25,6 +33,9 @@ struct MiniAppListRowCell: View {
                 } else {
                     RemoteImageView(urlString: iconUrl?.absoluteString ?? "")
                         .frame(width: 60, height: 40, alignment: .center)
+                        .contextMenu {
+                            menuItems
+                        }
                 }
                 Spacer()
             }
@@ -50,17 +61,53 @@ struct MiniAppListRowCell: View {
                     Spacer()
                 }
             }
+            .alert(isPresented: $showingAlert) {
+                Alert(
+                    title: Text("Info"),
+                    message: Text(alertDescription),
+                    dismissButton: .default(Text("OK")))
+            }
             .padding(10)
         }
     }
+
+    var menuItems: some View {
+        Group {
+            Button("Download", action: downloadMiniAppInBackground)
+            Button("Available already?", action: isMiniAppCacheAvailable)
+        }
+    }
+
+    func downloadMiniAppInBackground() {
+        MiniApp.shared(with: ListConfiguration(listType: listType).sdkConfig).downloadMiniApp(appId: miniAppId, versionId: versionId) { result in
+            switch result {
+            case .success:
+                print("Download Completed")
+            case .failure(let error):
+                print("Error downloading Miniapp:", error)
+            }
+        }
+    }
+
+    func isMiniAppCacheAvailable() {
+        if MiniApp.isMiniAppCacheAvailable(appId: miniAppId, versionId: versionId) {
+            showingAlert = true
+            alertDescription = "MiniApp is available"
+        } else {
+            showingAlert = true
+            alertDescription = "MiniApp is not downloaded"
+        }
+    }
 }
 
 struct MiniAppListRowCell_Previews: PreviewProvider {
     static var previews: some View {
         MiniAppListRowCell(
             displayName: "MiniApp Sample",
+            miniAppId: "123",
             versionTag: "0.7.2",
-            versionId: "abcdefgh-12345678-abcdefgh-12345678"
+            versionId: "abcdefgh-12345678-abcdefgh-12345678",
+            listType: .listI
         )
     }
 }

Example/Controllers/SwiftUI/Features/List/MiniAppListView.swift

@@ -113,8 +113,10 @@ extension MiniAppListView {
                                     MiniAppListRowCell(
                                         iconUrl: info.icon,
                                         displayName: info.displayName ?? "",
+                                        miniAppId: info.id,
                                         versionTag: info.version.versionTag,
-                                        versionId: info.version.versionId
+                                        versionId: info.version.versionId,
+                                        listType: viewModel.type
                                     )
                                 }
                             }

Sources/Classes/core/Downloader/MiniAppDownloader.swift

@@ -52,7 +52,7 @@ class MiniAppDownloader: MiniAppDownloaderInterface {
         }
     }
 
-    private func download(appId: String, versionId: String, completionHandler: @escaping (Result<URL, MASDKError>) -> Void) {
+    internal func download(appId: String, versionId: String, completionHandler: @escaping (Result<URL, MASDKError>) -> Void) {
         let miniAppStoragePath = FileManager.getMiniAppVersionDirectory(with: appId, and: versionId)
         self.manifestDownloader.fetchManifest(apiClient: self.miniAppClient, appId: appId, versionId: versionId) { (result) in
             switch result {
@@ -78,6 +78,28 @@ class MiniAppDownloader: MiniAppDownloaderInterface {
         }
     }
 
+    internal func downloadMiniApp(appId: String, versionId: String, completionHandler: @escaping (Result<URL, MASDKError>) -> Void) {
+        let miniAppStoragePath = FileManager.getMiniAppVersionDirectory(with: appId, and: versionId)
+        self.manifestDownloader.fetchManifest(apiClient: self.miniAppClient, appId: appId, versionId: versionId) { (result) in
+            switch result {
+            case .success(let responseData):
+                self.startDownloadingFiles(urls: responseData.manifest, to: miniAppStoragePath, miniAppId: appId, miniAppVersion: versionId) { downloadResult in
+                    switch downloadResult {
+                    case .success:
+                        DispatchQueue.main.async {
+                            self.cacheVerifier.storeHash(for: appId, version: versionId)
+                        }
+                        fallthrough
+                    default:
+                        completionHandler(downloadResult)
+                    }
+                }
+            case .failure(let error):
+                completionHandler(.failure(error))
+            }
+        }
+    }
+
     func isMiniAppAlreadyDownloaded(appId: String, versionId: String) -> Bool {
         if miniAppStatus.isDownloaded(appId: appId, versionId: versionId) {
             let versionDirectory = FileManager.getMiniAppVersionDirectory(with: appId, and: versionId)

Sources/Classes/core/MiniApp.swift

@@ -206,8 +206,33 @@ public class MiniApp: NSObject {
         try? MiniAppSecureStorage.wipeSecureStorage(for: miniAppId)
     }
 
-    public static func unzipMiniApp(fileName: String, miniAppId: String, versionId: String) {
-        MiniAppSDKUtility.unzipMiniApp(fileName: fileName, miniAppId: miniAppId, versionId: versionId)
+    /// Unzip the provided archive file from bundle.
+    /// - Parameters:
+    ///   - fileName: File name of the Bundle that you want to extract in MiniApp folder
+    ///   - miniAppId: MiniApp ID
+    ///   - versionId: Version ID
+    ///   - completionHandler: Status of the Unzip feature
+    public static func unzipMiniApp(fileName: String, miniAppId: String, versionId: String, completionHandler: ((Result<Bool, MASDKError>) -> Void)? = nil) {
+        MiniAppSDKUtility.unzipMiniApp(fileName: fileName, miniAppId: miniAppId, versionId: versionId, completionHandler: completionHandler)
+    }
+
+    /// Download a specific MiniApp from the Platform, please note that the MiniApp should be available before start downloading
+    /// - Parameters:
+    ///   - appId: MiniApp ID
+    ///   - versionId: VersionID of the MiniApp
+    ///   - completionHandler: Completion handler that tells the status of the download
+    public func downloadMiniApp(appId: String, versionId: String, completionHandler: @escaping (Result<Bool, MASDKError>) -> Void) {
+        realMiniApp.downloadMiniApp(appId: appId, versionId: versionId, completionHandler: completionHandler)
+    }
+
+    /// Check and return TRUE if the MiniApp is available for a given MiniAppID and VersionID.
+    /// This method not only checks if the folder is available, but also checks if index.html is available.
+    /// - Parameters:
+    ///   - appId: MiniApp ID
+    ///   - versionId: VersionID of the MiniApp
+    /// - Returns: TRUE if MiniApp is available
+    public static func isMiniAppCacheAvailable(appId: String, versionId: String) -> Bool {
+        return MiniAppSDKUtility.isMiniAppAvailable(appId: appId, versionId: versionId)
     }
 }
 

Sources/Classes/core/RealMiniApp.swift

@@ -437,6 +437,23 @@ internal class RealMiniApp {
             completionHandler(.failure(.miniAppCorrupted))
         }
     }
+
+    func downloadMiniApp(appId: String, versionId: String, completionHandler: @escaping (Result<Bool, MASDKError>) -> Void) {
+        if appId.isEmpty {
+            return completionHandler(.failure(.invalidAppId))
+        }
+        if versionId.isEmpty {
+            return completionHandler(.failure(.invalidVersionId))
+        }
+        miniAppDownloader.downloadMiniApp(appId: appId, versionId: versionId) { result in
+            switch result {
+            case .success:
+                completionHandler(.success(true))
+            case .failure(let error):
+                completionHandler(.failure(error))
+            }
+        }
+    }
 }
 
 extension RealMiniApp: MiniAppMessageDelegate {

Sources/Classes/core/Utilities/MiniAppSDKUtility.swift

@@ -2,16 +2,39 @@ import Foundation
 import CommonCrypto
 
 class MiniAppSDKUtility {
-    internal static func unzipMiniApp(fileName: String, miniAppId: String, versionId: String) {
+    internal static func unzipMiniApp(fileName: String, miniAppId: String, versionId: String, completionHandler: ((Result<Bool, MASDKError>) -> Void)? = nil) {
         let cacheVerifier = MiniAppCacheVerifier()
         guard let filePath = Bundle.main.url(forResource: fileName, withExtension: "zip") else {
+            completionHandler?(.failure(.unknownError(domain: MASDKLocale.localize(.unknownError), code: 1, description: "MiniApp Bundle Zip file not found")))
             return
         }
         do {
             try FileManager.default.unzipItem(at: filePath, to: FileManager.getMiniAppVersionDirectory(with: miniAppId, and: versionId), skipCRC32: true)
             cacheVerifier.storeHash(for: miniAppId, version: versionId)
+            return
         } catch let err {
-            MiniAppLogger.e("error unzipping archive", err)
+            MiniAppLogger.e("Error unzipping archive", err)
+            completionHandler?(.failure(.unknownError(domain: MASDKLocale.localize(.unknownError), code: 1, description: "Failed to Unzip Miniapp with Error: \(err)")))
+            return
+        }
+    }
+
+    internal static func cleanMiniAppVersions(appId: String, exceptForVersionId: String) {
+        guard !appId.isEmpty, !exceptForVersionId.isEmpty else {
+            return
+        }
+        MiniAppStorage.cleanVersions(for: appId, differentFrom: exceptForVersionId)
+    }
+
+    internal static func isMiniAppAvailable(appId: String, versionId: String) -> Bool {
+        guard !appId.isEmpty, !versionId.isEmpty else {
+            return false
+        }
+        let versionDirectory = FileManager.getMiniAppVersionDirectory(with: appId, and: versionId)
+        let miniAppRootPath = "\(versionDirectory.path)/\(Constants.rootFileName)"
+        if FileManager.default.fileExists(atPath: miniAppRootPath) {
+            return true
         }
+        return false
     }
 }

Sources/Classes/core/View/MiniAppView.swift

@@ -186,6 +186,7 @@ public class MiniAppView: UIView, MiniAppViewable {
             case let .success(webView):
                 self?.state.send(.active)
                 self?.setupWebView(webView: webView)
+                self?.cleanVersions()
                 completion(.success(true))
             case let .failure(error):
                 self?.state.send(.error(error))
@@ -194,6 +195,16 @@ public class MiniAppView: UIView, MiniAppViewable {
         }
     }
 
+    /// This method will clean all versions of MiniApp except for the version that is passed/loaded
+    internal func cleanVersions() {
+        guard let versionId = miniAppHandler.version, !versionId.isEmpty else {
+            return
+        }
+        if !miniAppHandler.appId.isEmpty {
+            MiniAppSDKUtility.cleanMiniAppVersions(appId: miniAppHandler.appId, exceptForVersionId: versionId)
+        }
+    }
+
     public var alertInfo: CloseAlertInfo? {
         return miniAppHandler.miniAppShouldClose()
     }

Sources/Classes/core/View/MiniAppViewHandler.swift

@@ -182,7 +182,7 @@ class MiniAppViewHandler: NSObject {
                         queryParams: self.queryParams
                     )
                 } catch {
-                    completion(.failure(.unknownError(domain: "", code: 0, description: "internal error: could not load the miniapp")))
+                    completion(.failure(.unknownError(domain: "", code: 0, description: "Internal error: could not load the miniapp")))
                 }
                 completion(.success(newWebView))
             }
@@ -191,7 +191,7 @@ class MiniAppViewHandler: NSObject {
 
         getMiniAppInfo(miniAppId: appId, miniAppVersion: version ?? "") { [weak self] result in
             guard let self = self else {
-                completion(.failure(.unknownError(domain: "", code: 0, description: "miniapp download failed")))
+                completion(.failure(.unknownError(domain: "", code: 0, description: "Miniapp download failed")))
                 return
             }
             switch result {
@@ -202,7 +202,7 @@ class MiniAppViewHandler: NSObject {
                     switch result {
                     case let .success(state):
                         guard state else {
-                            completion(.failure(.unknownError(domain: "", code: 0, description: "miniapp download failed")))
+                            completion(.failure(.unknownError(domain: "", code: 0, description: "MiniApp download failed")))
                             return
                         }
                         MiniAppLogger.d("MiniApp loaded with state: \(state)")
@@ -222,7 +222,7 @@ class MiniAppViewHandler: NSObject {
                                     queryParams: self.queryParams
                                 )
                             } catch {
-                                completion(.failure(.unknownError(domain: "", code: 0, description: "internal error")))
+                                completion(.failure(.unknownError(domain: "", code: 0, description: "Internal error")))
                             }
                             completion(.success(newWebView))
                         }
@@ -240,10 +240,8 @@ class MiniAppViewHandler: NSObject {
         if appId.isEmpty {
             return completion(.failure(.invalidAppId))
         }
-        guard
-            !miniAppClient.environment.isPreviewMode
-        else {
-            return completion(.failure(.unknownError(domain: "", code: 0, description: "MiniApp is not in preview mode")))
+        guard !miniAppClient.environment.isPreviewMode else {
+            return completion(.failure(.unknownError(domain: "", code: 0, description: "MiniApp is in preview mode")))
         }
         guard
             let cachedVersion = miniAppDownloader.getCachedMiniAppVersion(appId: appId, versionId: version ?? "")
@@ -276,7 +274,7 @@ class MiniAppViewHandler: NSObject {
                                     queryParams: self.queryParams
                                 )
                             } catch {
-                                completion(.failure(.unknownError(domain: "", code: 0, description: "internal error")))
+                                completion(.failure(.unknownError(domain: "", code: 0, description: "Internal error")))
                             }
                             completion(.success(newWebView))
                         }
@@ -316,7 +314,7 @@ class MiniAppViewHandler: NSObject {
                                 queryParams: self.queryParams
                             )
                         } catch {
-                            completion(.failure(.unknownError(domain: "", code: 0, description: "internal error")))
+                            completion(.failure(.unknownError(domain: "", code: 0, description: "Internal error")))
                         }
                         completion(.success(newWebView))
                     }
@@ -345,7 +343,7 @@ class MiniAppViewHandler: NSObject {
         navigationView: (UIView & MiniAppNavigationDelegate)? = nil
     ) throws {
         guard let messageInterface = messageDelegate else {
-            throw MASDKError.unknownError(domain: "", code: 0, description: "no message interface provided")
+            throw MASDKError.unknownError(domain: "", code: 0, description: "No message interface provided")
         }
 
         webView.navigationDelegate = self

Tests/Unit/MiniAppViewTests.swift

@@ -204,7 +204,7 @@ class MiniAppViewTests: XCTestCase {
             case .success:
                 XCTFail("should not succeed")
             case let .failure(error):
-                XCTAssertTrue(error.localizedDescription.contains("MiniApp is not in preview mode"))
+                XCTAssertTrue(error.localizedDescription.contains("MiniApp is in preview mode"))
             }
             expectation.fulfill()
         }