Fixes (#7419)

* Restores ML Pods after M77.

* Fix Package.swift

* Re-add catalyst to GHA workflow.

* Restrict multiple model info and model downloads; fix modelPath check + minor fixes.

* Replace static property for downloadStatus.

* Add TODO for merging requests.

* Add .notStarted download status and move TODO.

Author: manjanac

FirebaseMLModelDownloader/Apps/Sample/MLDownloaderTestApp.xcodeproj/project.pbxproj

@@ -633,8 +633,10 @@
 			buildSettings = {
 				ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
 				ASSETCATALOG_COMPILER_GLOBAL_ACCENT_COLOR_NAME = AccentColor;
-				CODE_SIGN_STYLE = Automatic;
+				CODE_SIGN_IDENTITY = "iPhone Developer";
+				CODE_SIGN_STYLE = Manual;
 				DEVELOPMENT_ASSET_PATHS = "\"MLDownloaderTestApp/Preview Content\"";
+				DEVELOPMENT_TEAM = EQHXZ8M8AV;
 				ENABLE_PREVIEWS = YES;
 				INFOPLIST_FILE = MLDownloaderTestApp/Info.plist;
 				LD_RUNPATH_SEARCH_PATHS = (
@@ -643,6 +645,7 @@
 				);
 				PRODUCT_BUNDLE_IDENTIFIER = com.google.MLDownloaderTestApp;
 				PRODUCT_NAME = "$(TARGET_NAME)";
+				PROVISIONING_PROFILE_SPECIFIER = "Google Development";
 				SWIFT_VERSION = 5.0;
 				TARGETED_DEVICE_FAMILY = "1,2";
 			};
@@ -654,8 +657,10 @@
 			buildSettings = {
 				ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
 				ASSETCATALOG_COMPILER_GLOBAL_ACCENT_COLOR_NAME = AccentColor;
-				CODE_SIGN_STYLE = Automatic;
+				CODE_SIGN_IDENTITY = "iPhone Developer";
+				CODE_SIGN_STYLE = Manual;
 				DEVELOPMENT_ASSET_PATHS = "\"MLDownloaderTestApp/Preview Content\"";
+				DEVELOPMENT_TEAM = EQHXZ8M8AV;
 				ENABLE_PREVIEWS = YES;
 				INFOPLIST_FILE = MLDownloaderTestApp/Info.plist;
 				LD_RUNPATH_SEARCH_PATHS = (
@@ -664,6 +669,7 @@
 				);
 				PRODUCT_BUNDLE_IDENTIFIER = com.google.MLDownloaderTestApp;
 				PRODUCT_NAME = "$(TARGET_NAME)";
+				PROVISIONING_PROFILE_SPECIFIER = "Google Development";
 				SWIFT_VERSION = 5.0;
 				TARGETED_DEVICE_FAMILY = "1,2";
 			};

FirebaseMLModelDownloader/Apps/Sample/MLDownloaderTestApp/AppDelegate.swift

@@ -23,6 +23,7 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
                      .LaunchOptionsKey: Any]?) -> Bool {
     // Override point for customization after application launch.
     FirebaseApp.configure()
+    FirebaseConfiguration.shared.setLoggerLevel(.debug)
     return true
   }
 

FirebaseMLModelDownloader/Sources/ModelDownloadTask.swift

@@ -43,7 +43,7 @@ class ModelDownloadTask: NSObject {
   /// User defaults to which local model info should ultimately be written.
   private let defaults: UserDefaults
   /// Keeps track of download associated with this model download task.
-  private(set) var downloadStatus: ModelDownloadStatus
+  private(set) var downloadStatus: ModelDownloadStatus = .notStarted
   /// Downloader instance.
   private let downloader: FileDownloader
   /// Telemetry logger.
@@ -59,19 +59,18 @@ class ModelDownloadTask: NSObject {
     self.downloader = downloader
     self.telemetryLogger = telemetryLogger
     self.defaults = defaults
-    downloadStatus = .notStarted
   }
 }
 
 extension ModelDownloadTask {
   /// Name for model file stored on device.
   var downloadedModelFileName: String {
-    return "fbml_model__\(appName)__\(remoteModelInfo.name)"
+    return "fbml_model__\(appName)__\(remoteModelInfo.name).tflite"
   }
 
   func download(progressHandler: ProgressHandler?, completion: @escaping Completion) {
     /// Prevent multiple concurrent downloads.
-    guard downloadStatus == .notStarted else {
+    guard downloadStatus != .inProgress else {
       DeviceLogger.logEvent(level: .debug,
                             message: ModelDownloadTask.ErrorDescription.anotherDownloadInProgress,
                             messageCode: .anotherDownloadInProgressError)
@@ -85,12 +84,14 @@ extension ModelDownloadTask {
     telemetryLogger?.logModelDownloadEvent(eventName: .modelDownload,
                                            status: .downloading,
                                            downloadErrorCode: .noError)
+    downloadStatus = .inProgress
     downloader.downloadFile(with: remoteModelInfo.downloadURL,
                             progressHandler: { downloadedBytes, totalBytes in
                               /// Fraction of model file downloaded.
                               let calculatedProgress = Float(downloadedBytes) / Float(totalBytes)
                               progressHandler?(calculatedProgress)
                             }) { result in
+      self.downloadStatus = .complete
       switch result {
       case let .success(response):
         DeviceLogger.logEvent(level: .debug,
@@ -147,7 +148,6 @@ extension ModelDownloadTask {
 
   /// Handle model download response.
   func handleResponse(response: HTTPURLResponse, tempURL: URL, completion: @escaping Completion) {
-    downloadStatus = .complete
     guard (200 ..< 299).contains(response.statusCode) else {
       switch response.statusCode {
       /// Possible failure due to download URL expiry.

FirebaseMLModelDownloader/Sources/ModelDownloader.swift

@@ -248,7 +248,8 @@ public class ModelDownloader {
           mainQueueHandler(completion(.failure(.internalError(description: description))))
           return
         }
-        guard modelInfo.path == path.absoluteString else {
+        guard let pathURL = URL(string: modelInfo.path)?.standardizedFileURL,
+          pathURL == path.standardizedFileURL else {
           DeviceLogger.logEvent(level: .debug,
                                 message: ModelDownloader.ErrorDescription.outdatedModelPath,
                                 messageCode: .outdatedModelPathError)
@@ -377,6 +378,7 @@ extension ModelDownloader {
                             progressHandler: ((Float) -> Void)? = nil,
                             completion: @escaping (Result<CustomModel, DownloadError>)
                               -> Void) {
+    // TODO: Merge if there are multiple same requests.
     modelInfoRetriever.downloadModelInfo { result in
       switch result {
       case let .success(downloadModelInfoResult):

FirebaseMLModelDownloader/Sources/ModelInfoRetriever.swift

@@ -16,6 +16,13 @@ import Foundation
 import FirebaseCore
 import FirebaseInstallations
 
+/// Possible states of model downloading.
+enum ModelInfoDownloadStatus {
+  case notStarted
+  case inProgress
+  case complete
+}
+
 /// URL Session to use while retrieving model info.
 protocol ModelInfoRetrieverSession {
   func getModelInfo(with request: URLRequest,
@@ -76,6 +83,8 @@ class ModelInfoRetriever {
   private let apiKey: String
   /// Current Firebase app name.
   private let appName: String
+  /// Keeps track of download associated with this model download task.
+  private(set) var downloadStatus: ModelInfoDownloadStatus = .notStarted
   /// Local model info to validate model freshness.
   private let localModelInfo: LocalModelInfo?
   /// Telemetry logger.
@@ -144,6 +153,18 @@ class ModelInfoRetriever {
   /// Get model info from server.
   func downloadModelInfo(completion: @escaping (Result<DownloadModelInfoResult, DownloadError>)
     -> Void) {
+    /// Prevent multiple concurrent downloads.
+    guard downloadStatus != .inProgress else {
+      DeviceLogger.logEvent(level: .debug,
+                            message: ModelInfoRetriever.ErrorDescription.anotherDownloadInProgress,
+                            messageCode: .anotherDownloadInProgressError)
+      telemetryLogger?.logModelDownloadEvent(eventName: .modelDownload,
+                                             status: .failed,
+                                             downloadErrorCode: .downloadFailed)
+      completion(.failure(.internalError(description: ModelInfoRetriever.ErrorDescription
+          .anotherDownloadInProgress)))
+      return
+    }
     authTokenProvider { result in
       switch result {
       /// Successfully received FIS token.
@@ -165,9 +186,11 @@ class ModelInfoRetriever {
               .invalidModelInfoFetchURL)))
           return
         }
+        self.downloadStatus = .inProgress
         /// Download model info.
         self.session.getModelInfo(with: request) {
           data, response, error in
+          self.downloadStatus = .complete
           if let downloadError = error {
             let description = ModelInfoRetriever.ErrorDescription
               .failedModelInfoRetrieval(downloadError.localizedDescription)
@@ -478,5 +501,6 @@ extension ModelInfoRetriever {
       "Invalid download URL expiry time from server."
     static let modelHashMismatch = "Unexpected model hash value."
     static let permissionDenied = "Invalid or missing permissions to retrieve model info."
+    static let anotherDownloadInProgress = "Model info download already in progress."
   }
 }