Convert StorageMetadata to Swift (#9979)

Author: paulb777

FirebaseStorage/CHANGELOG.md

@@ -1,3 +1,7 @@
+# Unreleased
+- [changed] Remove the storageReference property of StorageMetadata. It had never been implemented
+  and always returned `nil`.
+
 # 9.2.0
 - [fixed] Importing FirebaseStorage no longer exposes internal FirebaseCore APIs. (#9884)
 

FirebaseStorage/Sources/Internal/StorageGetMetadataTask.swift

@@ -69,9 +69,9 @@ internal class StorageGetMetadataTask: StorageTask, StorageTaskManagement {
         } else {
           if let data = data,
              let responseDictionary = try? JSONSerialization
-             .jsonObject(with: data) as? [String: Any] {
+             .jsonObject(with: data) as? [String: AnyHashable] {
             metadata = StorageMetadata(dictionary: responseDictionary)
-            metadata?.impl.type = .file
+            metadata?.fileType = .file
           } else {
             self.error = StorageErrorCode.error(withInvalidRequest: data)
           }

FirebaseStorage/Sources/Internal/StorageUpdateMetadataTask.swift

@@ -28,12 +28,12 @@ internal class StorageUpdateMetadataTask: StorageTask, StorageTaskManagement {
   private var fetcher: GTMSessionFetcher?
   private var fetcherCompletion: ((Data?, NSError?) -> Void)?
   private var taskCompletion: ((_ metadata: StorageMetadata?, _: Error?) -> Void)?
-  private var updateMetadata: FIRIMPLStorageMetadata
+  private var updateMetadata: StorageMetadata
 
   internal init(reference: FIRIMPLStorageReference,
                 fetcherService: GTMSessionFetcherService,
                 queue: DispatchQueue,
-                metadata: FIRIMPLStorageMetadata,
+                metadata: StorageMetadata,
                 completion: ((_: StorageMetadata?, _: Error?) -> Void)?) {
     updateMetadata = metadata
     super.init(reference: reference, service: fetcherService, queue: queue)
@@ -78,9 +78,9 @@ internal class StorageUpdateMetadataTask: StorageTask, StorageTaskManagement {
         } else {
           if let data = data,
              let responseDictionary = try? JSONSerialization
-             .jsonObject(with: data) as? [String: Any] {
+             .jsonObject(with: data) as? [String: AnyHashable] {
             metadata = StorageMetadata(dictionary: responseDictionary)
-            metadata?.impl.type = .file
+            metadata?.fileType = .file
           } else {
             self.error = StorageErrorCode.error(withInvalidRequest: data)
           }

FirebaseStorage/Sources/StorageMetadata.swift

@@ -29,67 +29,31 @@ import FirebaseStorageInternal
   /**
    * The name of the bucket containing this object.
    */
-  @objc public let bucket: String
+  @objc public let bucket: String?
 
   /**
    * Cache-Control directive for the object data.
    */
-  @objc public var cacheControl: String? {
-    get {
-      return impl.cacheControl
-    }
-    set(newValue) {
-      impl.cacheControl = newValue
-    }
-  }
-
+  @objc public var cacheControl: String?
   /**
    * Content-Disposition of the object data.
    */
-  @objc public var contentDisposition: String? {
-    get {
-      return impl.contentDisposition
-    }
-    set(newValue) {
-      impl.contentDisposition = newValue
-    }
-  }
+  @objc public var contentDisposition: String?
 
   /**
    * Content-Encoding of the object data.
    */
-  @objc public var contentEncoding: String? {
-    get {
-      return impl.contentEncoding
-    }
-    set(newValue) {
-      impl.contentEncoding = newValue
-    }
-  }
+  @objc public var contentEncoding: String?
 
   /**
    * Content-Language of the object data.
    */
-  @objc public var contentLanguage: String? {
-    get {
-      return impl.contentLanguage
-    }
-    set(newValue) {
-      impl.contentLanguage = newValue
-    }
-  }
+  @objc public var contentLanguage: String?
 
   /**
    * Content-Type of the object data.
    */
-  @objc public var contentType: String? {
-    get {
-      return impl.contentType
-    }
-    set(newValue) {
-      impl.contentType = newValue
-    }
-  }
+  @objc public var contentType: String?
 
   /**
    * MD5 hash of the data; encoded using base64.
@@ -104,14 +68,7 @@ import FirebaseStorageInternal
   /**
    * User-provided metadata, in key/value pairs.
    */
-  @objc public var customMetadata: [String: String]? {
-    get {
-      return impl.customMetadata
-    }
-    set(newValue) {
-      impl.customMetadata = newValue
-    }
-  }
+  @objc public var customMetadata: [String: String]?
 
   /**
    * The version of the metadata for this object at this generation. Used
@@ -123,26 +80,12 @@ import FirebaseStorageInternal
   /**
    * The name of this object, in gs://bucket/path/to/object.txt, this is object.txt.
    */
-  @objc public internal(set) var name: String? {
-    get {
-      return impl.name
-    }
-    set(newValue) {
-      impl.name = newValue
-    }
-  }
+  @objc public internal(set) var name: String?
 
   /**
    * The full path of this object, in gs://bucket/path/to/object.txt, this is path/to/object.txt.
    */
-  @objc public internal(set) var path: String? {
-    get {
-      return impl.path
-    }
-    set(newValue) {
-      impl.path = newValue
-    }
-  }
+  @objc public internal(set) var path: String?
 
   /**
    * Content-Length of the data in bytes.
@@ -159,83 +102,197 @@ import FirebaseStorageInternal
    */
   @objc public let updated: Date?
 
-  /**
-   * A reference to the object in Firebase Storage.
-   */
-  @objc public let storageReference: StorageReference?
-
   /**
    * Creates a Dictionary from the contents of the metadata.
    * @return A Dictionary that represents the contents of the metadata.
    */
-  @objc open func dictionaryRepresentation() -> [String: Any] {
-    return impl.dictionaryRepresentation()
+  @objc open func dictionaryRepresentation() -> [String: AnyHashable] {
+    var dictionary: [String: AnyHashable] = [:]
+    if let bucket = bucket {
+      dictionary["bucket"] = bucket
+    }
+    if let cacheControl = cacheControl {
+      dictionary["cacheControl"] = cacheControl
+    }
+    if let contentDisposition = contentDisposition {
+      dictionary["contentDisposition"] = contentDisposition
+    }
+    if let contentEncoding = contentEncoding {
+      dictionary["contentEncoding"] = contentEncoding
+    }
+    if let contentLanguage = contentLanguage {
+      dictionary["contentLanguage"] = contentLanguage
+    }
+    if let contentType = contentType {
+      dictionary["contentType"] = contentType
+    }
+    if let md5Hash = md5Hash {
+      dictionary["md5Hash"] = md5Hash
+    }
+    if let customMetadata = customMetadata {
+      dictionary["metadata"] = customMetadata
+    }
+    if size != 0 {
+      dictionary["size"] = size
+    }
+    if generation != 0 {
+      dictionary["generation"] = "\(generation)"
+    }
+    if metageneration != 0 {
+      dictionary["metageneration"] = "\(metageneration)"
+    }
+    if let timeCreated = timeCreated {
+      dictionary["timeCreated"] = StorageMetadata.RFC3339StringFromDate(timeCreated)
+    }
+    if let updated = updated {
+      dictionary["updated"] = StorageMetadata.RFC3339StringFromDate(updated)
+    }
+    if let path = path {
+      dictionary["name"] = path
+    }
+    return dictionary
   }
 
   /**
    * Determines if the current metadata represents a "file".
    */
-  @objc public let isFile: Bool
+  @objc public var isFile: Bool {
+    return fileType == .file
+  }
 
+  // TODO: Nothing in the implementation ever sets `.folder`.
   /**
    * Determines if the current metadata represents a "folder".
    */
-  @objc public let isFolder: Bool
+  @objc public var isFolder: Bool {
+    return fileType == .folder
+  }
 
   // MARK: - Public Initializers
 
   @objc override public convenience init() {
-    self.init(impl: FIRIMPLStorageMetadata(dictionary: [:])!)
+    self.init(dictionary: [:])
   }
 
   /**
    * Creates an instance of StorageMetadata from the contents of a dictionary.
    * @return An instance of StorageMetadata that represents the contents of a dictionary.
    */
-  @objc public convenience init(dictionary: [String: Any]) {
-    self.init(impl: FIRIMPLStorageMetadata(dictionary: dictionary)!)
+  @objc public init(dictionary: [String: AnyHashable]) {
+    initialMetadata = dictionary
+    bucket = dictionary["bucket"] as? String ?? nil
+    cacheControl = dictionary["cacheControl"] as? String ?? nil
+    contentDisposition = dictionary["contentDisposition"] as? String ?? nil
+    contentEncoding = dictionary["contentEncoding"] as? String ?? nil
+    contentLanguage = dictionary["contentLanguage"] as? String ?? nil
+    contentType = dictionary["contentType"] as? String ?? nil
+    customMetadata = dictionary["metadata"] as? [String: String] ?? nil
+    size = StorageMetadata.intFromDictionaryValue(dictionary["size"])
+    generation = StorageMetadata.intFromDictionaryValue(dictionary["generation"])
+    metageneration = StorageMetadata.intFromDictionaryValue(dictionary["metageneration"])
+    timeCreated = StorageMetadata.dateFromRFC3339String(dictionary["timeCreated"])
+    updated = StorageMetadata.dateFromRFC3339String(dictionary["updated"])
+    md5Hash = dictionary["md5Hash"] as? String ?? nil
+
+    // GCS "name" is our path, our "name" is just the last path component of the path
+    if let name = dictionary["name"] as? String {
+      path = name
+      self.name = (name as NSString).lastPathComponent
+    }
+    fileType = .unknown
   }
 
   // MARK: - NSObject overrides
 
   @objc override open func copy() -> Any {
-    return StorageMetadata(impl: impl.copy() as! FIRIMPLStorageMetadata)
+    let clone = StorageMetadata(dictionary: dictionaryRepresentation())
+    clone.initialMetadata = initialMetadata
+    return clone
   }
 
   @objc override open func isEqual(_ object: Any?) -> Bool {
     guard let ref = object as? StorageMetadata else {
       return false
     }
-    return impl.isEqual(ref.impl)
+    return ref.dictionaryRepresentation() == dictionaryRepresentation()
   }
 
   @objc override public var hash: Int {
-    return impl.hash
+    return (dictionaryRepresentation() as NSDictionary).hash
   }
 
   @objc override public var description: String {
-    return impl.description
+    return "\(type(of: self)) \(dictionaryRepresentation())"
   }
 
   // MARK: - Internal APIs
 
-  internal let impl: FIRIMPLStorageMetadata
-
-  internal init(impl: FIRIMPLStorageMetadata) {
-    self.impl = impl
-    bucket = impl.bucket
-    md5Hash = impl.md5Hash
-    generation = impl.generation
-    metageneration = impl.metageneration
-    size = impl.size
-    timeCreated = impl.timeCreated
-    updated = impl.updated
-    if let ref = impl.storageReference {
-      storageReference = StorageReference(ref)
-    } else {
-      storageReference = nil
-    }
-    isFile = impl.isFile
-    isFolder = impl.isFolder
+  internal func updatedMetadata() -> [String: AnyHashable] {
+    return remove(matchingMetadata: dictionaryRepresentation(), oldMetadata: initialMetadata)
+  }
+
+  internal enum StorageMetadataType {
+    case unknown
+    case file
+    case folder
+  }
+
+  internal var fileType: StorageMetadataType
+
+  // MARK: - Private APIs and data
+
+  private var initialMetadata: [String: AnyHashable]
+
+  private static func intFromDictionaryValue(_ value: Any?) -> Int64 {
+    if let value = value as? Int { return Int64(value) }
+    if let value = value as? Int64 { return value }
+    if let value = value as? String { return Int64(value) ?? 0 }
+    return 0
+  }
+
+  private static var dateFormatter: DateFormatter = {
+    let dateFormatter = DateFormatter()
+    dateFormatter.locale = Locale(identifier: "en_US_POSIX") // set locale to reliable US_POSIX
+    dateFormatter.dateFormat = "yyyy'-'MM'-'dd'T'HH':'mm':'ss.SSSZZZZZ"
+    dateFormatter.timeZone = TimeZone(secondsFromGMT: 0)
+    return dateFormatter
+  }()
+
+  private static func dateFromRFC3339String(_ value: Any?) -> Date? {
+    if let stringValue = value as? String {
+      return dateFormatter.date(from: stringValue) ?? nil
+    }
+    return nil
+  }
+
+  internal static func RFC3339StringFromDate(_ date: Date) -> String {
+    return dateFormatter.string(from: date)
+  }
+
+  private func remove(matchingMetadata: [String: AnyHashable],
+                      oldMetadata: [String: AnyHashable]) -> [String: AnyHashable] {
+    var newMetadata = matchingMetadata
+    for (key, oldValue) in oldMetadata {
+      guard let newValue = newMetadata[key] else {
+        // Adds 'NSNull' for entries that only exist in oldMetadata.
+        newMetadata[key] = NSNull()
+        continue
+      }
+      if let oldString = oldValue as? String,
+         let newString = newValue as? String {
+        if oldString == newString {
+          newMetadata[key] = nil
+        }
+      } else if let oldDictionary = oldValue as? [String: AnyHashable],
+                let newDictionary = newValue as? [String: AnyHashable] {
+        let outDictionary = remove(matchingMetadata: newDictionary, oldMetadata: oldDictionary)
+        if outDictionary.count == 0 {
+          newMetadata[key] = nil
+        } else {
+          newMetadata[key] = outDictionary
+        }
+      }
+    }
+    return newMetadata
   }
 }