feat: updated Point to be a sendable struct

Deprecated addTag(key:value:), addField(key:value:), and time(time:) in favor of using the mutable properties.

BREAKING CHANGE: Point is now a value type which can cause breaking behaviour in code expecting the behaviour of a reference type.
BREAKING CHANGE: addTag(key:value:), addField(key:value:), and time(time:) have mutating versions when called and the result is discarded.
BREAKING CHANGE: Minimum swift version is now 5.7

Author: CraigSiemens

.gitignore

@@ -44,7 +44,7 @@ Package.resolved
 #
 # Xcode automatically generates this directory with a .xcworkspacedata file and xcuserdata
 # hence it is not needed unless you have added a package configuration file to your project
-# .swiftpm
+.swiftpm
 
 .build/
 

CHANGELOG.md

@@ -1,4 +1,14 @@
-## 1.8.0 [unreleased]
+## 2.0.0 [unreleased]
+
+`Point` has been updated from a class to a `Sendable` struct. This allows passing instances of `Point` across arbitrary concurrent contexts without introducing a risk of data races. Anywhere using `Point` will need to be updated to account for the change from a class to a struct.
+
+The minimum swift version has been raised to 5.7 to support the `Sendable` protocol.
+
+`addTag(key:value:)`, `addField(key:value:)`, and `time(time:)` have been deprecated in favor of passing values to `Point.init` or mutating the properties directly. Since the methods mutated the instance and returned the instance, they aren't compatible with `Point` becoming a struct. To simplify migration, each method now has two versions: one that mutates the instance and one that returns a new modified instance. The methods returning a new instance can still be chained together but the result must be assigned to a variable. The methods that mutate the instance can no longer be chained together, but don't require assigning the result to a variable.
+
+### Features
+1. [#69](https://github.com/influxdata/influxdb-client-swift/pull/69) Updated `Point` to be a sendable struct
+1. [#70](https://github.com/influxdata/influxdb-client-swift/pull/70): Improved usability of `Point` by adding tags, fields, and time to the initializer and making the properties public and mutable
 
 ## 1.7.0 [2024-05-17]
 

Package.swift

@@ -1,4 +1,4 @@
-// swift-tools-version:5.3
+// swift-tools-version:5.7
 // The swift-tools-version declares the minimum version of Swift required to build this package.
 
 import PackageDescription
@@ -11,21 +11,27 @@ let package = Package(
     ],
     dependencies: [
         // Dependencies declare other packages that this package depends on.
-         .package(name: "Gzip", url: "https://github.com/1024jp/GzipSwift", from: "5.1.1"),
-         .package(name: "CSV.swift", url: "https://github.com/yaslab/CSV.swift", from: "2.4.2"),
-         .package(name: "SwiftTestReporter", url: "https://github.com/allegro/swift-junit.git", from: "2.0.0"),
-         .package(name: "swift-log", url: "https://github.com/apple/swift-log.git", from: "1.0.0"),
+         .package(url: "https://github.com/1024jp/GzipSwift", from: "5.1.1"),
+         .package(url: "https://github.com/yaslab/CSV.swift", from: "2.4.2"),
+         .package(url: "https://github.com/allegro/swift-junit.git", from: "2.0.0"),
+         .package(url: "https://github.com/apple/swift-log.git", from: "1.0.0"),
     ],
     targets: [
         // Targets are the basic building blocks of a package. A target can define a module or a test suite.
         // Targets can depend on other targets in this package, and on products in packages this package depends on.
         .target(name: "InfluxDBSwift", dependencies: [
-            "Gzip",
+            .product(name: "Gzip", package: "GzipSwift"),
             .product(name: "CSV", package: "CSV.swift"),
             .product(name: "Logging", package: "swift-log")
         ]),
         .target(name: "InfluxDBSwiftApis", dependencies: ["InfluxDBSwift"]),
-        .testTarget(name: "InfluxDBSwiftTests", dependencies: ["InfluxDBSwift", "SwiftTestReporter"]),
-        .testTarget(name: "InfluxDBSwiftApisTests", dependencies: ["InfluxDBSwiftApis", "SwiftTestReporter"]),
+        .testTarget(name: "InfluxDBSwiftTests", dependencies: [
+            "InfluxDBSwift",
+                .product(name: "SwiftTestReporter", package: "swift-junit")
+        ]),
+        .testTarget(name: "InfluxDBSwiftApisTests", dependencies: [
+            "InfluxDBSwiftApis",
+            .product(name: "SwiftTestReporter", package: "swift-junit")
+        ]),
     ]
 )

Sources/InfluxDBSwift/InfluxDBClient.swift

@@ -24,7 +24,7 @@ import FoundationNetworking
 /// ````
 public struct InfluxDBClient {
     /// Version of client.
-    public static var version: String = "1.8.0dev"
+    public static var version: String = "2.0.0dev"
     /// InfluxDB host and port.
     public let url: String
     /// Authentication token.
@@ -247,7 +247,7 @@ extension InfluxDBClient {
 
     /// An enum represents the precision for the unix timestamps within the body line-protocol.
     /// - SeeAlso: https://docs.influxdata.com/influxdb/latest/write-data/#timestamp-precision
-    public enum TimestampPrecision: String, Codable, CaseIterable {
+    public enum TimestampPrecision: String, Codable, CaseIterable, Sendable {
         /// Milliseconds
         case ms
         /// Seconds

Sources/InfluxDBSwift/Point.swift

@@ -8,62 +8,31 @@ extension InfluxDBClient {
     /// Point defines the values that will be written to the database.
     ///
     /// - SeeAlso: http://bit.ly/influxdata-point
-    public class Point {
+    public struct Point: Sendable {
         /// The measurement name.
-        private let measurement: String
+        public let measurement: String
         // The measurement tags.
-        private var tags: [String: String?] = [:]
+        public var tags: [String: String]
         // The measurement fields.
-        private var fields: [String: FieldValue?] = [:]
+        public var fields: [String: FieldValue]
         /// The data point time.
-        var time: TimestampValue?
+        public var time: TimestampValue?
 
         /// Create a new Point with specified a measurement name and precision.
         ///
         /// - Parameters:
         ///   - measurement: the measurement name
         ///   - precision: the data point precision
-        public init(_ measurement: String) {
+        public init(
+            _ measurement: String,
+            tags: [String: String] = [:],
+            fields: [String: FieldValue] = [:],
+            time: TimestampValue? = nil
+        ) {
             self.measurement = measurement
-        }
-
-        /// Adds or replaces a tag value for this point.
-        ///
-        /// - Parameters:
-        ///   - key: the tag name
-        ///   - value: the tag value
-        /// - Returns: self
-        @discardableResult
-        public func addTag(key: String?, value: String?) -> Point {
-            if let key = key {
-                tags[key] = value
-            }
-            return self
-        }
-
-        /// Adds or replaces a field value for this point.
-        ///
-        /// - Parameters:
-        ///   - key: the field name
-        ///   - value: the field value
-        /// - Returns: self
-        @discardableResult
-        public func addField(key: String?, value: FieldValue?) -> Point {
-            if let key = key {
-                fields[key] = value
-            }
-            return self
-        }
-
-        /// Updates the timestamp for the point.
-        ///
-        /// - Parameters:
-        ///   - time: the timestamp. It can be `Int` or `Date`.
-        /// - Returns: self
-        @discardableResult
-        public func time(time: TimestampValue) -> Point {
+            self.tags = tags
+            self.fields = fields
             self.time = time
-            return self
         }
 
         /// Creates Line Protocol from Data Point.
@@ -73,7 +42,7 @@ extension InfluxDBClient {
         ///   - defaultTags: default tags for Point.
         /// - Returns: Line Protocol
         public func toLineProtocol(precision: TimestampPrecision = defaultTimestampPrecision,
-                                   defaultTags: [String: String?]? = nil) throws -> String? {
+                                   defaultTags: [String: String]? = nil) throws -> String? {
             let meas = escapeKey(measurement, false)
             let tags = escapeTags(defaultTags)
             let fields = try escapeFields()
@@ -117,8 +86,8 @@ extension InfluxDBClient {
             return self
         }
 
-        internal func evaluate() -> [String: String?] {
-            let map: [String: String?] = tags.mapValues { value in
+        internal func evaluate() -> [String: String] {
+            let map: [String: String] = tags.compactMapValues { value in
                 if let value = value, value.starts(with: "${env.") {
                     let start = value.index(value.startIndex, offsetBy: 6)
                     let end = value.index(value.endIndex, offsetBy: -1)
@@ -134,7 +103,7 @@ extension InfluxDBClient {
 
 extension InfluxDBClient.Point {
     /// Possible value types of Field
-    public enum FieldValue {
+    public enum FieldValue: Sendable {
         /// Support for Int8
         init(_ value: Int8) {
             self = .int(Int(value))
@@ -185,7 +154,7 @@ extension InfluxDBClient.Point {
     }
 
     /// Possible value types of Field
-    public enum TimestampValue: CustomStringConvertible {
+    public enum TimestampValue: CustomStringConvertible, Sendable {
         // The number of ticks since the UNIX epoch. The value has to be specified with correct precision.
         case interval(Int, InfluxDBClient.TimestampPrecision = InfluxDBClient.defaultTimestampPrecision)
         // The date timestamp.
@@ -205,29 +174,22 @@ extension InfluxDBClient.Point {
 extension InfluxDBClient.Point {
     /// Tuple definition for construct `Point`.
     public typealias Tuple = (measurement: String,
-                              tags: [String?: String?]?,
-                              fields: [String?: InfluxDBClient.Point.FieldValue?],
+                              tags: [String: String]?,
+                              fields: [String: InfluxDBClient.Point.FieldValue],
                               time: InfluxDBClient.Point.TimestampValue?)
     /// Create a new Point from Tuple.
     ///
     /// - Parameters:
     ///   - tuple: the tuple with keys: `measurement`, `tags`, `fields` and `time`
     ///   - precision: the data point precision
     /// - Returns: created Point
-    public class func fromTuple(_ tuple: Tuple) -> InfluxDBClient.Point {
-        let point = InfluxDBClient.Point(tuple.measurement)
-        if let tags = tuple.tags {
-            for tag in tags {
-                point.addTag(key: tag.0, value: tag.1)
-            }
-        }
-        for field in tuple.fields {
-            point.addField(key: field.0, value: field.1)
-        }
-        if let time = tuple.time {
-            point.time(time: time)
-        }
-        return point
+    public static func fromTuple(_ tuple: Tuple) -> InfluxDBClient.Point {
+        .init(
+            tuple.measurement,
+            tags: tuple.tags ?? [:],
+            fields: tuple.fields,
+            time: tuple.time
+        )
     }
 }
 
@@ -261,7 +223,7 @@ extension InfluxDBClient.Point {
         }
     }
 
-    private func escapeTags(_ defaultTags: [String: String?]?) -> String {
+    private func escapeTags(_ defaultTags: [String: String]?) -> String {
         tags
                 .merging(defaultTags ?? [:]) { current, _ in
                     current
@@ -272,11 +234,11 @@ extension InfluxDBClient.Point {
                     guard !keyValue.key.isEmpty else {
                         return
                     }
-                    if let value = keyValue.value, !value.isEmpty {
+                    if !keyValue.value.isEmpty {
                         result.append(",")
                         result.append(escapeKey(keyValue.key))
                         result.append("=")
-                        result.append(escapeKey(value))
+                        result.append(escapeKey(keyValue.value))
                     }
                 }
     }
@@ -288,10 +250,7 @@ extension InfluxDBClient.Point {
             if keyValue.key.isEmpty {
                 return
             }
-            guard let value = keyValue.value else {
-                return
-            }
-            if let escaped = try escapeValue(value) {
+            if let escaped = try escapeValue(keyValue.value) {
                 // key
                 result.append(escapeKey(keyValue.key))
                 // key=
@@ -386,3 +345,86 @@ extension InfluxDBClient.Point {
         return " \(sinceEpoch)"
     }
 }
+
+extension InfluxDBClient.Point {
+    /// Adds or replaces a tag value for this point.
+    ///
+    /// - Parameters:
+    ///   - key: the tag name
+    ///   - value: the tag value
+    /// - Returns: self
+    @_disfavoredOverload
+    @available(*, deprecated, message: "Pass tags to Point.init or use the tags property")
+    public func addTag(key: String?, value: String?) -> Self {
+        var point = self
+        if let key = key {
+            point.tags[key] = value
+        }
+        return point
+    }
+
+    /// Adds or replaces a tag value for this point.
+    ///
+    /// - Parameters:
+    ///   - key: the tag name
+    ///   - value: the tag value
+    /// - Returns: self
+    @available(*, deprecated, message: "Pass tags to Point.init or use the tags property")
+    public mutating func addTag(key: String?, value: String?) {
+        if let key = key {
+            tags[key] = value
+        }
+    }
+
+    /// Adds or replaces a field value for this point.
+    ///
+    /// - Parameters:
+    ///   - key: the field name
+    ///   - value: the field value
+    /// - Returns: self
+    @_disfavoredOverload
+    @available(*, deprecated, message: "Pass fields to Point.init or use the fields property")
+    public func addField(key: String?, value: FieldValue?) -> Self {
+        var point = self
+        if let key = key {
+            point.fields[key] = value
+        }
+        return point
+    }
+
+    /// Adds or replaces a field value for this point.
+    ///
+    /// - Parameters:
+    ///   - key: the field name
+    ///   - value: the field value
+    /// - Returns: self
+    @available(*, deprecated, message: "Pass fields to Point.init or use the fields property")
+    public mutating func addField(key: String?, value: FieldValue?) {
+        if let key = key {
+            fields[key] = value
+        }
+    }
+
+    /// Updates the timestamp for the point.
+    ///
+    /// - Parameters:
+    ///   - time: the timestamp. It can be `Int` or `Date`.
+    /// - Returns: self
+    @_disfavoredOverload
+    @available(*, deprecated, message: "Pass time to Point.init or use the time property")
+    public func time(time: TimestampValue) -> Self {
+        var point = self
+        point.time = time
+        return point
+    }
+
+    /// Updates the timestamp for the point.
+    ///
+    /// - Parameters:
+    ///   - time: the timestamp. It can be `Int` or `Date`.
+    /// - Returns: self
+    @available(*, deprecated, message: "Pass time to Point.init or use the time property")
+    public mutating func time(time: TimestampValue) {
+        self.time = time
+    }
+}

Sources/InfluxDBSwift/WriteAPI.swift

@@ -801,7 +801,7 @@ public struct WriteAPI {
 
     private func toLineProtocol(precision: InfluxDBClient.TimestampPrecision,
                                 any: Any,
-                                defaultTags: [String: String?]?,
+                                defaultTags: [String: String]?,
                                 lps: inout [String]) throws {
         // To avoid: "Could not cast value of type 'InfluxDBSwift.InfluxDBClient.Point' to 'Foundation.NSObject'."
         // on Linux - see:
@@ -831,7 +831,7 @@ public struct WriteAPI {
 
     private func toLineProtocol(precision: InfluxDBClient.TimestampPrecision,
                                 point: InfluxDBClient.Point,
-                                defaultTags: [String: String?]?,
+                                defaultTags: [String: String]?,
                                 lps: inout [String]) throws {
         if let lineProtocol = try point.toLineProtocol(precision: precision, defaultTags: defaultTags) {
             return toLineProtocol(