Deprecate close() and Closeable APIs (#538)

Author: mickael-menu

CHANGELOG.md

@@ -12,6 +12,10 @@ All notable changes to this project will be documented in this file. Take a look
 
 * Support for streaming ZIP packages over HTTP. This lets you open a remote EPUB, audiobook, or any other ZIP-based publication without needing to download it first.
 
+### Deprecated
+
+* The `close()` and `Closeable` APIs are now deprecated. Resources are automatically released upon `deinit`, which aligns better with Swift.
+
 
 ## [3.0.0-beta.2]
 

Sources/Adapters/GCDWebServer/ResourceResponse.swift

@@ -112,8 +112,4 @@ class ResourceResponse: ReadiumGCDWebServerFileResponse, Loggable {
 
         return (try? lastReadData?.get()) ?? Data()
     }
-
-    override open func close() {
-        resource.close()
-    }
 }

Sources/LCP/Content Protection/LCPDecryptor.swift

@@ -101,10 +101,6 @@ final class LCPDecryptor {
             self.encryption = encryption
         }
 
-        func close() {
-            resource.close()
-        }
-
         let sourceURL: AbsoluteURL? = nil
 
         func properties() async -> ReadResult<ResourceProperties> {

Sources/Navigator/Audiobook/PublicationMediaLoader.swift

@@ -101,9 +101,7 @@ final class PublicationMediaLoader: NSObject, AVAssetResourceLoaderDelegate, Log
         req.task.cancel()
 
         if reqs.isEmpty {
-            if let (_, res) = resources.removeValue(forKey: href) {
-                res.close()
-            }
+            resources.removeValue(forKey: href)
             requests.removeValue(forKey: href)
         } else {
             requests[href] = reqs

Sources/Shared/Publication/Publication.swift

@@ -97,15 +97,6 @@ public class Publication: Closeable, Loggable {
             ?? container[href.anyURL.removingQuery().removingFragment()]
     }
 
-    /// Closes any opened resource associated with the `Publication`, including `services`.
-    public func close() {
-        container.close()
-
-        for service in services {
-            service.close()
-        }
-    }
-
     /// Finds the first `Publication.Service` implementing the given service type.
     ///
     /// e.g. `findService(PositionsService.self)`

Sources/Shared/Publication/Services/Content/Iterators/HTMLResourceContentIterator.swift

@@ -102,7 +102,6 @@ public class HTMLResourceContentIterator: ContentIterator {
             .tryMap { try SwiftSoup.parse($0) }
             .tryMap { try parse(document: $0, locator: locator, beforeMaxLength: beforeMaxLength) }
             .asyncMap { await adjustProgressions(of: $0) }
-        resource.close()
         return try result.get()
     }
 

Sources/Shared/Toolkit/Archive/Archive.swift

@@ -29,7 +29,6 @@ public protocol Archive {
     var entries: [ArchiveEntry] { get }
     func entry(at path: ArchivePath) -> ArchiveEntry?
     func readEntry(at path: ArchivePath) -> ArchiveEntryReader?
-    func close()
 }
 
 @available(*, unavailable)
@@ -56,9 +55,6 @@ public protocol ArchiveEntryReader {
     /// When `range` is nil, the whole content is returned. Out-of-range indexes are clamped to the available length
     /// automatically.
     func read(range: Range<UInt64>?) -> ArchiveResult<Data>
-
-    /// Closes any pending resources for this entry.
-    func close()
 }
 
 @available(*, unavailable, renamed: "ArchiveOpener")

Sources/Shared/Toolkit/Closeable.swift

@@ -10,6 +10,7 @@ import Foundation
 public protocol Closeable {
     /// Closes this object and releases any resources associated with it.
     /// If the object is already closed then invoking this method has no effect.
+    @available(*, deprecated, message: "Handle Resource deallocation with `deinit` instead.")
     func close()
 }
 
@@ -20,6 +21,7 @@ public extension Closeable {
 public extension Closeable {
     /// Executes the given block function on this resource and then closes it down correctly whether
     /// an error is thrown or not.
+    @available(*, deprecated, message: "The resource is automatically closed when deallocated")
     @inlinable func use<T>(_ block: (Self) throws -> T) rethrows -> T {
         // Can't use `defer` with async functions.
         do {

Sources/Shared/Toolkit/Data/Asset/Asset.swift

@@ -38,15 +38,6 @@ public enum Asset: AssetProtocol {
             }
         }
     }
-
-    public func close() {
-        switch self {
-        case let .resource(asset):
-            asset.close()
-        case let .container(asset):
-            asset.close()
-        }
-    }
 }
 
 /// A single resource asset.
@@ -58,10 +49,6 @@ public struct ResourceAsset: AssetProtocol {
         self.resource = resource
         self.format = format
     }
-
-    public func close() {
-        resource.close()
-    }
 }
 
 /// A container asset providing access to several resources.
@@ -73,8 +60,4 @@ public struct ContainerAsset: AssetProtocol {
         self.container = container
         self.format = format
     }
-
-    public func close() {
-        container.close()
-    }
 }

Sources/Shared/Toolkit/Data/Container/Container.swift

@@ -59,10 +59,4 @@ public class CompositeContainer: Container {
             container[url]
         }
     }
-
-    public func close() {
-        for container in containers {
-            container.close()
-        }
-    }
 }