Add sendable conformance (#219)

* Bump swift tools version

* Enable complete concurrency checking

* Add sendable conformance

Author: mattesmohr

.github/workflows/test.yml

@@ -9,7 +9,7 @@ on:
 jobs:
   test-pushpull:
     runs-on: ubuntu-latest
-    container: swift:5.9.2-jammy
+    container: swift:5.10.1-jammy
     steps:
     - uses: actions/checkout@v3
     - name: Run tests

Package.swift

@@ -1,4 +1,4 @@
-// swift-tools-version:5.9
+// swift-tools-version:5.10
 
 import PackageDescription
 
@@ -25,16 +25,21 @@ let package = Package(
         .package(url: "https://github.com/apple/swift-collections.git", from: "1.1.4"),
         .package(url: "https://github.com/apple/swift-docc-plugin", from: "1.4.3"),
         .package(url: "https://github.com/apple/swift-log.git", from: "1.6.3"),
-        .package(url: "https://github.com/vapor/vapor.git", from: "4.114.1")
+        .package(url: "https://github.com/vapor/vapor.git", from: "4.114.1"),
+        .package(url: "https://github.com/apple/swift-nio.git", from: "2.86.2")
     ],
     targets: [
         .target(
             name: "HTMLKit",
             dependencies: [
                 .product(name: "Collections", package: "swift-collections"),
                 .product(name: "Logging", package: "swift-log"),
+                .product(name: "NIO", package: "swift-nio")
             ],
-            exclude: ["Abstraction/README.md", "Framework/README.md"]
+            exclude: ["Abstraction/README.md", "Framework/README.md"],
+            swiftSettings: [
+                .enableExperimentalFeature("StrictConcurrency=complete")
+            ]
         ),
         .target(
             name: "HTMLKitConverter",
@@ -56,6 +61,10 @@ let package = Package(
             dependencies: [
                 .target(name: "HTMLKit"),
                 .product(name: "Vapor", package: "vapor"),
+                .product(name: "NIO", package: "swift-nio")
+            ],
+            swiftSettings: [
+                .enableExperimentalFeature("StrictConcurrency=complete")
             ]
         ),
         .target(

Sources/HTMLKit/Framework/Environment/Environment.swift

@@ -1,10 +1,11 @@
 import Foundation
+import NIOConcurrencyHelpers
 
 /// A class that represents the environment
 ///
 /// The environment provides storage for various settings used by the renderer
 @_documentation(visibility: internal)
-public final class Environment {
+public final class Environment: @unchecked Sendable {
 
     /// An enumeration of possible rendering errors.
     public enum Errors: Error {
@@ -43,10 +44,14 @@ public final class Environment {
     /// The storage of the environment
     private var storage: [AnyKeyPath: Any]
 
+    /// A lock to get sure, we are thread safe here
+    private var lock: NIOLock
+    
     /// Initializes the environment
     public init() {
 
         self.storage = [:]
+        self.lock = .init()
     }
 
     /// The current time zone of the environment
@@ -87,7 +92,10 @@ public final class Environment {
     ///
     /// - Returns: The value
     public func retrieve(for path: AnyKeyPath) -> Any? {
-        return storage[path]
+
+        return lock.withLock {
+            return storage[path]
+        }
     }
 
     /// Inserts or updates a value in the environment for the given key path
@@ -96,7 +104,10 @@ public final class Environment {
     ///   - value: The value to be stored or updated
     ///   - path: The key path that identifies where the value is stored
     public func upsert<T>(_ value: T, for path: AnyKeyPath) {
-        storage[path] = value
+
+        lock.withLock {
+            storage[path] = value
+        }
     }
 
     /// Resolves an environment value

Sources/HTMLKit/Framework/Localization/Locale.swift

@@ -2,10 +2,10 @@
 ///
 /// A locale holds information about language, region and cultural preferences.
 @_documentation(visibility: internal)
-public struct Locale: Hashable {
+public struct Locale: Hashable, Sendable {
 
     /// A enumeration of potential language tags
-    public enum Tag: String {
+    public enum Tag: String, Sendable {
 
         case arabic = "ar"
         case belarusian = "be"

Sources/HTMLKit/Framework/Localization/Localization.swift

@@ -2,7 +2,7 @@ import Foundation
 
 /// A type that represents the localization
 @_documentation(visibility: internal)
-public class Localization {
+public struct Localization: Sendable {
 
     /// A enumeration of errors regarding the localization rendering
     public enum Errors: Error, Equatable {
@@ -81,14 +81,14 @@ public class Localization {
     /// Sets the source directory
     ///
     /// - Parameter source: The directory where the translations should be loaded from.
-    public func set(source: URL) {
+    public mutating func set(source: URL) {
         self.tables = load(source: source)
     }
 
     /// Sets the default locale
     ///
     /// - Parameter locale: A locale tag e.g. en-US
-    public func set(locale: String) {
+    public mutating func set(locale: String) {
         self.locale = Locale(tag: locale)
     }
 

Sources/HTMLKit/Framework/Localization/TranslationTable.swift

@@ -1,7 +1,7 @@
 /// A type that represents a translation table
 ///
 /// A translation table stores multiple localized strings, mapping unique string keys to their corresponding translations
-internal struct TranslationTable {
+internal struct TranslationTable: Sendable {
 
     /// The name of the table
     internal let name: String

Sources/HTMLKit/Framework/Rendering/Encoding/Encoder.swift

@@ -7,13 +7,13 @@ import Foundation
 /// > Note: The encoder does not utilize unicode encoding for some languages, such as JS and CSS. 
 /// > It primarily aims to preserve the code integrity and to protect against code injection within an 
 /// > HTML context.
-internal struct Encoder {
+internal struct Encoder: Sendable {
 
     /// An enumeration of potential encoding mechanism
-    internal enum Mechanism {
+    internal enum Mechanism: Sendable {
 
         /// The context the mechanism should be based on
-        internal enum Context {
+        internal enum Context: Sendable {
 
             /// Mechanism to use on an attribute value
             case attribute

Sources/HTMLKit/Framework/Rendering/Encoding/Sanitizer.swift

@@ -1,5 +1,5 @@
 /// A type responsible for sanitizing the renderer output
-internal struct Sanitizer {
+internal struct Sanitizer: Sendable {
 
     /// Strip a tag from a given string
     /// 

Sources/HTMLKit/Framework/Rendering/Features.swift

@@ -1,7 +1,7 @@
 /// An option set of different features
 ///
 /// The feature set provides the flexibility to enable experimental features if desired.
-public struct Features: Swift.OptionSet {
+public struct Features: Swift.OptionSet, Sendable {
 
     public var rawValue: Int
 

Sources/HTMLKit/Framework/Rendering/Markdown/Markdown.swift

@@ -1,6 +1,6 @@
 import Foundation
 
-internal final class Markdown {
+internal struct Markdown: Sendable {
 
     /// The markdowns characters
     internal static let characters = CharacterSet(charactersIn: "*_~[`")