First pass at marking types as Sendable

domkm · domkm · commit 8ccf6ed514aa · 2024-06-07T12:00:39.000-07:00
diff --git a/Sources/Internal/JSON.swift b/Sources/Internal/JSON.swift
@@ -8,7 +8,7 @@ import Foundation
 
 /// Wraps a dictionary parsed from a JSON string.
 /// This is a trick to keep the Web Publication structs equatable without having to override `==` and compare all the other properties.
-public struct JSONDictionary {
+public struct JSONDictionary: @unchecked Sendable {
     public var json: [String: Any]
 
     public init() {
diff --git a/Sources/Shared/Publication/Accessibility.swift b/Sources/Shared/Publication/Accessibility.swift
@@ -11,7 +11,7 @@ import ReadiumInternal
 ///
 /// https://www.w3.org/2021/a11y-discov-vocab/latest/
 /// https://readium.org/webpub-manifest/schema/a11y.schema.json
-public struct Accessibility: Hashable {
+public struct Accessibility: Hashable, Sendable {
     /// An established standard to which the described resource conforms.
     public var conformsTo: [Profile]
 
@@ -49,7 +49,7 @@ public struct Accessibility: Hashable {
     public var hazards: [Hazard]
 
     /// Accessibility profile.
-    public struct Profile: Hashable {
+    public struct Profile: Hashable, Sendable {
         public let uri: String
 
         public init(_ uri: String) {
@@ -64,7 +64,7 @@ public struct Accessibility: Hashable {
         public static let epubA11y10WCAG20AAA = Profile("http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-aaa")
     }
 
-    public struct Certification: Hashable {
+    public struct Certification: Hashable, Sendable {
         /// Identifies a party responsible for the testing and certification of the accessibility of a Publication.
         ///
         /// https://www.w3.org/TR/epub-a11y/#certifiedBy
@@ -89,7 +89,7 @@ public struct Accessibility: Hashable {
         }
     }
 
-    public struct AccessMode: Hashable {
+    public struct AccessMode: Hashable, Sendable {
         public let id: String
 
         public init(_ id: String) {
@@ -134,7 +134,7 @@ public struct Accessibility: Hashable {
         public static let visual = AccessMode("visual")
     }
 
-    public enum PrimaryAccessMode: String, Hashable {
+    public enum PrimaryAccessMode: String, Hashable, Sendable {
         /// Indicates that auditory perception is necessary to consume the information.
         case auditory
 
@@ -151,7 +151,7 @@ public struct Accessibility: Hashable {
         case visual
     }
 
-    public struct Feature: Hashable {
+    public struct Feature: Hashable, Sendable {
         public let id: String
 
         public init(_ id: String) {
@@ -306,7 +306,7 @@ public struct Accessibility: Hashable {
         public static let none = Feature("none")
     }
 
-    public struct Hazard: Hashable {
+    public struct Hazard: Hashable, Sendable {
         public let id: String
 
         public init(_ id: String) {
diff --git a/Sources/Shared/Publication/Asset/FileAsset.swift b/Sources/Shared/Publication/Asset/FileAsset.swift
@@ -7,7 +7,7 @@
 import Foundation
 
 /// Represents a publication stored as a file on the local file system.
-public final class FileAsset: PublicationAsset, Loggable {
+public final class FileAsset: PublicationAsset, Loggable, Sendable {
     /// File URL on the file system.
     public let file: FileURL
 
diff --git a/Sources/Shared/Publication/Asset/PublicationAsset.swift b/Sources/Shared/Publication/Asset/PublicationAsset.swift
@@ -7,7 +7,7 @@
 import Foundation
 
 /// Represents a digital medium (e.g. a file) offering access to a publication.
-public protocol PublicationAsset {
+public protocol PublicationAsset: Sendable {
     /// Name of the asset, e.g. a filename.
     var name: String { get }
 
diff --git a/Sources/Shared/Publication/Contributor.swift b/Sources/Shared/Publication/Contributor.swift
@@ -8,7 +8,7 @@ import Foundation
 import ReadiumInternal
 
 /// https://readium.org/webpub-manifest/schema/contributor-object.schema.json
-public struct Contributor: Hashable {
+public struct Contributor: Hashable, Sendable {
     /// The name of the contributor.
     public var localizedName: LocalizedString
     public var name: String { localizedName.string }
diff --git a/Sources/Shared/Publication/Link.swift b/Sources/Shared/Publication/Link.swift
@@ -14,7 +14,7 @@ public enum LinkError: Error, Equatable {
 
 /// Link Object for the Readium Web Publication Manifest.
 /// https://readium.org/webpub-manifest/schema/link.schema.json
-public struct Link: JSONEquatable, Hashable {
+public struct Link: JSONEquatable, Hashable, Sendable {
     /// URI or URI template of the linked resource.
     /// Note: a String because templates are lost with URL.
     public var href: String // URI
diff --git a/Sources/Shared/Publication/LinkRelation.swift b/Sources/Shared/Publication/LinkRelation.swift
@@ -7,7 +7,7 @@
 import Foundation
 
 /// Link relations as defined in https://readium.org/webpub-manifest/relationships.html
-public struct LinkRelation {
+public struct LinkRelation: Sendable {
     /// The string representation of this link relation.
     public let string: String
 
diff --git a/Sources/Shared/Publication/LocalizedString.swift b/Sources/Shared/Publication/LocalizedString.swift
@@ -10,7 +10,7 @@ import Foundation
 /// Can be either:
 ///   - a single nonlocalized string
 ///   - a dictionary of localized strings indexed by the BCP 47 language tag
-public enum LocalizedString: Hashable {
+public enum LocalizedString: Hashable, Sendable {
     case nonlocalized(String)
     case localized([String: String])
 
diff --git a/Sources/Shared/Publication/Locator.swift b/Sources/Shared/Publication/Locator.swift
@@ -8,7 +8,7 @@ import Foundation
 import ReadiumInternal
 
 /// https://github.com/readium/architecture/tree/master/locators
-public struct Locator: Hashable, CustomStringConvertible, Loggable {
+public struct Locator: Hashable, CustomStringConvertible, Loggable, Sendable {
     /// The URI of the resource that the Locator Object points to.
     public var href: String // URI
 
@@ -120,7 +120,7 @@ public struct Locator: Hashable, CustomStringConvertible, Loggable {
     ///
     /// Properties are mutable for convenience when making a copy, but the `locations` property
     /// is immutable in `Locator`, for safety.
-    public struct Locations: Hashable, Loggable, WarningLogger {
+    public struct Locations: Hashable, Loggable, WarningLogger, Sendable {
         /// Contains one or more fragment in the resource referenced by the `Locator`.
         public var fragments: [String]
         /// Progression in the resource expressed as a percentage (between 0 and 1).
@@ -197,7 +197,7 @@ public struct Locator: Hashable, CustomStringConvertible, Loggable {
         public subscript(key: String) -> Any? { otherLocations[key] }
     }
 
-    public struct Text: Hashable, Loggable {
+    public struct Text: Hashable, Loggable, Sendable {
         public var after: String?
         public var before: String?
         public var highlight: String?
diff --git a/Sources/Shared/Publication/Manifest.swift b/Sources/Shared/Publication/Manifest.swift
@@ -11,7 +11,7 @@ import ReadiumInternal
 /// Manifest.
 ///
 /// See. https://readium.org/webpub-manifest/
-public struct Manifest: JSONEquatable, Hashable {
+public struct Manifest: JSONEquatable, Hashable, Sendable {
     public var context: [String] // @context
 
     public var metadata: Metadata
diff --git a/Sources/Shared/Publication/Metadata.swift b/Sources/Shared/Publication/Metadata.swift
@@ -8,7 +8,7 @@ import Foundation
 import ReadiumInternal
 
 /// https://readium.org/webpub-manifest/schema/metadata.schema.json
-public struct Metadata: Hashable, Loggable, WarningLogger {
+public struct Metadata: Hashable, Loggable, WarningLogger, Sendable {
     /// Collection type used for collection/series metadata.
     /// For convenience, the JSON schema reuse the Contributor's definition.
     public typealias Collection = Contributor
diff --git a/Sources/Shared/Publication/Properties.swift b/Sources/Shared/Publication/Properties.swift
@@ -9,7 +9,7 @@ import ReadiumInternal
 
 /// Link Properties
 /// https://readium.org/webpub-manifest/schema/properties.schema.json
-public struct Properties: Hashable, Loggable, WarningLogger {
+public struct Properties: Hashable, Loggable, WarningLogger, Sendable {
     /// Additional properties for extensions.
     public var otherProperties: [String: Any] {
         get { otherPropertiesJSON.json }
diff --git a/Sources/Shared/Publication/Publication.swift b/Sources/Shared/Publication/Publication.swift
@@ -141,7 +141,7 @@ public class Publication: Loggable {
     ///
     /// For a list of supported profiles, see the registry:
     /// https://readium.org/webpub-manifest/profiles/
-    public struct Profile: Hashable {
+    public struct Profile: Hashable, Sendable {
         public let uri: String
 
         public init(_ uri: String) {
diff --git a/Sources/Shared/Publication/PublicationCollection.swift b/Sources/Shared/Publication/PublicationCollection.swift
@@ -10,7 +10,7 @@ import ReadiumInternal
 /// Core Collection Model
 /// https://readium.org/webpub-manifest/schema/subcollection.schema.json
 /// Can be used as extension point in the Readium Web Publication Manifest.
-public struct PublicationCollection: JSONEquatable, Hashable {
+public struct PublicationCollection: JSONEquatable, Hashable, Sendable {
     public var metadata: [String: Any] {
         get { metadataJSON.json }
         set { metadataJSON = JSONDictionary(newValue) ?? JSONDictionary() }
diff --git a/Sources/Shared/Publication/ReadingProgression.swift b/Sources/Shared/Publication/ReadingProgression.swift
@@ -6,7 +6,7 @@
 
 import Foundation
 
-public enum ReadingProgression: String {
+public enum ReadingProgression: String, Sendable {
     /// Left to right
     case ltr
     /// Right to left
diff --git a/Sources/Shared/Publication/Subject.swift b/Sources/Shared/Publication/Subject.swift
@@ -8,7 +8,7 @@ import Foundation
 import ReadiumInternal
 
 // https://github.com/readium/webpub-manifest/tree/master/contexts/default#subjects
-public struct Subject: Hashable {
+public struct Subject: Hashable, Sendable {
     public var localizedName: LocalizedString
     public var name: String { localizedName.string }
     public var sortAs: String?
diff --git a/Sources/Shared/Toolkit/HTTP/HTTPClient.swift b/Sources/Shared/Toolkit/HTTP/HTTPClient.swift
@@ -206,7 +206,7 @@ public extension HTTPClient {
 }
 
 /// Represents a successful HTTP response received from a server.
-public struct HTTPResponse: Equatable {
+public struct HTTPResponse: Equatable, Sendable {
     /// Request associated with the response.
     public let request: HTTPRequest
 
diff --git a/Sources/Shared/Toolkit/HTTP/HTTPError.swift b/Sources/Shared/Toolkit/HTTP/HTTPError.swift
@@ -11,7 +11,7 @@ public typealias HTTPDeferred<Success> = Deferred<Success, HTTPError>
 
 /// Represents an error occurring during an `HTTPClient` activity.
 public struct HTTPError: LocalizedError, Equatable, Loggable {
-    public enum Kind: Equatable {
+    public enum Kind: Equatable, Sendable {
         /// The provided request was not valid.
         case malformedRequest(url: String?)
         /// The received response couldn't be decoded.
diff --git a/Sources/Shared/Toolkit/HTTP/HTTPProblemDetails.swift b/Sources/Shared/Toolkit/HTTP/HTTPProblemDetails.swift
@@ -9,7 +9,7 @@ import Foundation
 /// Problem Details for HTTP APIs.
 ///
 /// https://tools.ietf.org/html/rfc7807
-public struct HTTPProblemDetails: Decodable, Equatable {
+public struct HTTPProblemDetails: Decodable, Equatable, Sendable {
     public enum Error: Swift.Error {
         case malformed(json: String?)
     }
diff --git a/Sources/Shared/Toolkit/HTTP/HTTPRequest.swift b/Sources/Shared/Toolkit/HTTP/HTTPRequest.swift
@@ -7,15 +7,15 @@
 import Foundation
 
 /// Holds the information about an HTTP request performed by an `HTTPClient`.
-public struct HTTPRequest: Equatable {
+public struct HTTPRequest: Equatable, Sendable {
     /// Address of the remote resource to request.
     public var url: HTTPURL
 
     /// HTTP method to use for the request.
     public var method: Method
 
     /// Supported HTTP methods.
-    public enum Method: String, Equatable {
+    public enum Method: String, Equatable, Sendable {
         case delete = "DELETE"
         case get = "GET"
         case head = "HEAD"
@@ -32,7 +32,7 @@ public struct HTTPRequest: Equatable {
     public var body: Body?
 
     /// Supported body values.
-    public enum Body: Equatable {
+    public enum Body: Equatable, Sendable {
         case data(Data)
         case file(URL)
     }
@@ -130,7 +130,7 @@ public protocol HTTPRequestConvertible {
 }
 
 public enum HTTPRequestError: Error {
-    case invalidURL(CustomStringConvertible)
+    case invalidURL(CustomStringConvertible & Sendable)
 }
 
 extension HTTPRequest: HTTPRequestConvertible {
diff --git a/Sources/Shared/Toolkit/Language.swift b/Sources/Shared/Toolkit/Language.swift
@@ -6,7 +6,7 @@
 
 import Foundation
 
-public struct Language: Hashable {
+public struct Language: Hashable, Sendable {
     public static var current: Language {
         Language(locale: Locale.current)
     }
@@ -16,7 +16,7 @@ public struct Language: Hashable {
         Locale.availableIdentifiers
             .map { Language(code: .bcp47($0)) }
 
-    public enum Code: Hashable {
+    public enum Code: Hashable, Sendable {
         case bcp47(String)
 
         public var bcp47: String {
diff --git a/Sources/Shared/Toolkit/Media Type/MediaType.swift b/Sources/Shared/Toolkit/Media Type/MediaType.swift
@@ -27,7 +27,7 @@ import Foundation
 ///     }
 /// }
 /// ```
-public struct MediaType: Hashable, Loggable {
+public struct MediaType: Hashable, Loggable, Sendable {
     /// The string representation of this media type.
     public var string: String {
         let params = parameters
diff --git a/Sources/Shared/Toolkit/URL/Absolute URL/AbsoluteURL.swift b/Sources/Shared/Toolkit/URL/Absolute URL/AbsoluteURL.swift
@@ -88,7 +88,7 @@ public extension AbsoluteURL {
 }
 
 /// A URL scheme, e.g. http or file.
-public struct URLScheme: RawRepresentable, CustomStringConvertible, Hashable {
+public struct URLScheme: RawRepresentable, CustomStringConvertible, Hashable, Sendable {
     public static let data = URLScheme(rawValue: "data")
     public static let file = URLScheme(rawValue: "file")
     public static let ftp = URLScheme(rawValue: "ftp")
diff --git a/Sources/Shared/Toolkit/URL/Absolute URL/FileURL.swift b/Sources/Shared/Toolkit/URL/Absolute URL/FileURL.swift
@@ -9,7 +9,7 @@ import Foundation
 /// Represents an absolute URL with the special scheme `file`.
 ///
 /// See https://url.spec.whatwg.org/#special-scheme
-public struct FileURL: AbsoluteURL, Hashable {
+public struct FileURL: AbsoluteURL, Hashable, Sendable {
     public init?(url: URL) {
         let url = url.standardizedFileURL
         guard
diff --git a/Sources/Shared/Toolkit/URL/Absolute URL/HTTPURL.swift b/Sources/Shared/Toolkit/URL/Absolute URL/HTTPURL.swift
@@ -9,7 +9,7 @@ import Foundation
 /// Represents an absolute URL with the special schemes `http` or `https`.
 ///
 /// See https://url.spec.whatwg.org/#special-scheme
-public struct HTTPURL: AbsoluteURL, Hashable {
+public struct HTTPURL: AbsoluteURL, Hashable, Sendable {
     public init?(url: URL) {
         guard
             let scheme = url.scheme.map(URLScheme.init(rawValue:)),
