Update swiftformat (#151)

jpgrayson · web-flow · commit 267b83ab5690 · 2023-11-28T14:32:21.000Z
* Update to swiftformat 0.52.10

This is the latest version of swiftformat.

The .swiftformat config is modified to target Swift 5.7, which is the
oldest Swift currently supported by mqtt-nio.

The validate.sh script is updated to resolve some shellcheck issues.

Signed-off-by: Peter Grayson &lt;pete@jpgrayson.net&gt;

* Formatting fixes for swiftformat 0.52.10

Signed-off-by: Peter Grayson &lt;pete@jpgrayson.net&gt;

---------

Signed-off-by: Peter Grayson &lt;pete@jpgrayson.net&gt;
diff --git a/.github/workflows/validate.yml b/.github/workflows/validate.yml
@@ -14,6 +14,6 @@ jobs:
     - name: Install Dependencies
       run: |
         brew install mint
-        mint install nicklockwood/swiftformat@0.48.17 --no-link
+        mint install nicklockwood/swiftformat@0.52.10 --no-link
     - name: run script
       run: ./scripts/validate.sh
diff --git a/.swiftformat b/.swiftformat
@@ -1,8 +1,8 @@
 # Minimum swiftformat version
---minversion 0.47.4
+--minversion 0.52.0
 
 # Swift version
---swiftversion 5.1
+--swiftversion 5.7
 
 # file options
 --exclude .build
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -35,4 +35,4 @@ docker-compose run test
 
 ### Formatting
 
-We use Nick Lockwood's SwiftFormat for formatting code. PRs will not be accepted if they haven't be formatted. The current version of SwiftFormat we are using is v0.48.17.
+We use Nick Lockwood's SwiftFormat for formatting code. PRs will not be accepted if they haven't be formatted. The current version of SwiftFormat we are using is v0.52.10.
diff --git a/Sources/MQTTNIO/AsyncAwaitSupport/MQTTClient+async.swift b/Sources/MQTTNIO/AsyncAwaitSupport/MQTTClient+async.swift
@@ -28,7 +28,7 @@ extension MQTTClient {
     public func shutdown(queue: DispatchQueue = .global()) async throws {
         return try await withUnsafeThrowingContinuation { cont in
             self.shutdown(queue: queue) { error in
-                if let error = error {
+                if let error {
                     cont.resume(throwing: error)
                 } else {
                     cont.resume()
diff --git a/Sources/MQTTNIO/ChannelHandlers/WebSocketHandler.swift b/Sources/MQTTNIO/ChannelHandlers/WebSocketHandler.swift
@@ -107,7 +107,7 @@ final class WebSocketHandler: ChannelDuplexHandler {
 
     /// Send ping and setup task to check for pong and send new ping
     private func sendPingAndWait(context: ChannelHandlerContext) {
-        guard context.channel.isActive, let pingInterval = pingInterval else {
+        guard context.channel.isActive, let pingInterval else {
             return
         }
         if self.waitingOnPong {
diff --git a/Sources/MQTTNIO/MQTTClient.swift b/Sources/MQTTNIO/MQTTClient.swift
@@ -74,7 +74,7 @@ public final class MQTTClient {
         return self.host
     }
 
-    internal let globalPacketId = ManagedAtomic<UInt16>(1)
+    let globalPacketId = ManagedAtomic<UInt16>(1)
     /// default logger that logs nothing
     private static let loggingDisabled = Logger(label: "MQTT-do-not-log", factory: { _ in SwiftLogNoOpLogHandler() })
     /// inflight messages
@@ -101,7 +101,7 @@ public final class MQTTClient {
         configuration: Configuration = Configuration()
     ) {
         self.host = host
-        if let port = port {
+        if let port {
             self.port = port
         } else {
             switch (configuration.useSSL, configuration.useWebSockets) {
@@ -190,7 +190,7 @@ public final class MQTTClient {
         var errorStorage: Error?
         let continuation = DispatchWorkItem {}
         self.shutdown(queue: DispatchQueue(label: "mqtt-client.shutdown")) { error in
-            if let error = error {
+            if let error {
                 errorStorageLock.withLock {
                     errorStorage = error
                 }
@@ -334,7 +334,7 @@ public final class MQTTClient {
             will: publish
         )
 
-        return self.connect(packet: packet).map { $0.sessionPresent }
+        return self.connect(packet: packet).map(\.sessionPresent)
     }
 
     /// Publish message to topic
@@ -441,7 +441,7 @@ public final class MQTTClient {
         self.shutdownListeners.removeListener(named: name)
     }
 
-    internal func updatePacketId() -> UInt16 {
+    func updatePacketId() -> UInt16 {
         let id = self.globalPacketId.wrappingIncrementThenLoad(by: 1, ordering: .relaxed)
 
         // packet id must be non-zero
@@ -468,7 +468,7 @@ public final class MQTTClient {
     private var lock = NIOLock()
 }
 
-internal extension MQTTClient {
+extension MQTTClient {
     /// connect to broker
     func connect(
         packet: MQTTConnectPacket,
@@ -513,7 +513,7 @@ internal extension MQTTClient {
                     }
                 case let auth as MQTTAuthPacket:
                     // auth messages require an auth workflow closure
-                    guard let authWorkflow = authWorkflow else { return eventLoop.makeFailedFuture(MQTTError.authWorkflowRequired) }
+                    guard let authWorkflow else { return eventLoop.makeFailedFuture(MQTTError.authWorkflowRequired) }
                     return self.processAuth(auth, authWorkflow: authWorkflow, on: eventLoop)
                         .flatMapThrowing { result -> MQTTConnAckPacket in
                             // once auth workflow is finished we should receive a connack
diff --git a/Sources/MQTTNIO/MQTTClientV5.swift b/Sources/MQTTNIO/MQTTClientV5.swift
@@ -187,7 +187,7 @@ extension MQTTClient {
                 if auth.reason == .success {
                     return eventLoop.makeSucceededFuture(auth)
                 }
-                guard let authWorkflow = authWorkflow else { return eventLoop.makeFailedFuture(MQTTError.authWorkflowRequired) }
+                guard let authWorkflow else { return eventLoop.makeFailedFuture(MQTTError.authWorkflowRequired) }
                 return self.client.processAuth(authPacket, authWorkflow: authWorkflow, on: eventLoop)
             }
             .flatMapThrowing { response -> MQTTAuthV5 in
diff --git a/Sources/MQTTNIO/MQTTInflight.swift b/Sources/MQTTNIO/MQTTInflight.swift
@@ -24,22 +24,22 @@ struct MQTTInflight {
     /// add packet
     mutating func add(packet: MQTTPacket) {
         self.lock.withLock {
-            packets.append(packet)
+            self.packets.append(packet)
         }
     }
 
     /// remove packert
     mutating func remove(id: UInt16) {
         self.lock.withLock {
             guard let first = packets.firstIndex(where: { $0.packetId == id }) else { return }
-            packets.remove(at: first)
+            self.packets.remove(at: first)
         }
     }
 
     /// remove all packets
     mutating func clear() {
         self.lock.withLock {
-            packets = []
+            self.packets = []
         }
     }
 
diff --git a/Sources/MQTTNIO/MQTTListeners.swift b/Sources/MQTTNIO/MQTTListeners.swift
@@ -28,13 +28,13 @@ final class MQTTListeners<ReturnType> {
 
     func addListener(named name: String, listener: @escaping Listener) {
         self.lock.withLock {
-            listeners[name] = listener
+            self.listeners[name] = listener
         }
     }
 
     func removeListener(named name: String) {
         self.lock.withLock {
-            listeners[name] = nil
+            self.listeners[name] = nil
         }
     }
 
diff --git a/Sources/MQTTNIO/MQTTPacket.swift b/Sources/MQTTNIO/MQTTPacket.swift
@@ -13,7 +13,7 @@
 
 import NIOCore
 
-internal enum InternalError: Swift.Error {
+enum InternalError: Swift.Error {
     case incompletePacket
     case notImplemented
 }
@@ -99,7 +99,7 @@ struct MQTTConnectPacket: MQTTPacket {
         byteBuffer.writeInteger(version.versionByte)
         // connect flags
         var flags = self.cleanSession ? ConnectFlags.cleanSession : 0
-        if let will = will {
+        if let will {
             flags |= ConnectFlags.willFlag
             flags |= will.retain ? ConnectFlags.willRetain : 0
             flags |= will.qos.rawValue << ConnectFlags.willQoSShift
@@ -116,17 +116,17 @@ struct MQTTConnectPacket: MQTTPacket {
 
         // payload
         try MQTTSerializer.writeString(self.clientIdentifier, to: &byteBuffer)
-        if let will = will {
+        if let will {
             if version == .v5_0 {
                 try will.properties.write(to: &byteBuffer)
             }
             try MQTTSerializer.writeString(will.topicName, to: &byteBuffer)
             try MQTTSerializer.writeBuffer(will.payload, to: &byteBuffer)
         }
-        if let userName = userName {
+        if let userName {
             try MQTTSerializer.writeString(userName, to: &byteBuffer)
         }
-        if let password = password {
+        if let password {
             try MQTTSerializer.writeString(password, to: &byteBuffer)
         }
     }
@@ -149,7 +149,7 @@ struct MQTTConnectPacket: MQTTPacket {
         // client identifier
         size += self.clientIdentifier.utf8.count + 2
         // will publish
-        if let will = will {
+        if let will {
             // properties
             if version == .v5_0 {
                 let propertiesPacketSize = will.properties.packetSize
@@ -161,11 +161,11 @@ struct MQTTConnectPacket: MQTTPacket {
             size += will.payload.readableBytes + 2
         }
         // user name
-        if let userName = userName {
+        if let userName {
             size += userName.utf8.count + 2
         }
         // password
-        if let password = password {
+        if let password {
             size += password.utf8.count + 2
         }
         return size
@@ -370,7 +370,7 @@ struct MQTTPubAckPacket: MQTTPacket {
     let reason: MQTTReasonCode
     let properties: MQTTProperties
 
-    internal init(
+    init(
         type: MQTTPacketType,
         packetId: UInt16,
         reason: MQTTReasonCode = .success,
diff --git a/Sources/MQTTNIO/MQTTTask.swift b/Sources/MQTTNIO/MQTTTask.swift
@@ -23,7 +23,7 @@ final class MQTTTask {
         let promise = eventLoop.makePromise(of: MQTTPacket.self)
         self.promise = promise
         self.checkInbound = checkInbound
-        if let timeout = timeout {
+        if let timeout {
             self.timeoutTask = eventLoop.scheduleTask(in: timeout) {
                 promise.fail(MQTTError.timeout)
             }
diff --git a/Sources/MQTTNIO/TSTLSConfiguration.swift b/Sources/MQTTNIO/TSTLSConfiguration.swift
@@ -104,7 +104,7 @@ public struct TSTLSConfiguration {
         public static func pem(_ filename: String) throws -> Self {
             let certificates = try NIOSSLCertificate.fromPEMFile(filename)
             let secCertificates = try certificates.map { certificate -> SecCertificate in
-                guard let certificate = SecCertificateCreateWithData(nil, Data(try certificate.toDERBytes()) as CFData) else { throw TSTLSConfiguration.Error.invalidData }
+                guard let certificate = try SecCertificateCreateWithData(nil, Data(certificate.toDERBytes()) as CFData) else { throw TSTLSConfiguration.Error.invalidData }
                 return certificate
             }
             return .init(certificates: secCertificates)
@@ -254,7 +254,7 @@ extension TSTLSConfiguration {
                     }
                     if #available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *) {
                         SecTrustEvaluateAsyncWithError(trust, Self.tlsDispatchQueue) { _, result, error in
-                            if let error = error {
+                            if let error {
                                 print("Trust failed: \(error.localizedDescription)")
                             }
                             sec_protocol_verify_complete(result)
diff --git a/scripts/validate.sh b/scripts/validate.sh
@@ -13,21 +13,22 @@
 ##
 ##===----------------------------------------------------------------------===##
 
-SWIFT_VERSION=5.3
-SWIFT_FORMAT_VERSION=0.48.17
+SWIFT_FORMAT_VERSION=0.52.10
 
 set -eu
-here="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
 
-which swiftformat > /dev/null 2>&1 || (echo "swiftformat not installed. You can install it using 'mint install nicklockwood/swiftformat'" ; exit -1)
+command -v swiftformat >/dev/null || {
+  echo "swiftformat not installed. You can install it using 'mint install nicklockwood/swiftformat'"
+  exit 1
+}
 
 printf "=> Checking format... "
 FIRST_OUT="$(git status --porcelain)"
 if [[ -n "${CI-""}" ]]; then
-  printf "(using v$(mint run NickLockwood/SwiftFormat@$SWIFT_FORMAT_VERSION --version)) "
+  printf "(using v%s) " "$(mint run NickLockwood/SwiftFormat@$SWIFT_FORMAT_VERSION --version)"
   mint run NickLockwood/SwiftFormat@$SWIFT_FORMAT_VERSION . > /dev/null 2>&1
 else
-  printf "(using v$(swiftformat --version)) "
+  printf "(using v%s) " "$(swiftformat --version)"
   swiftformat . > /dev/null 2>&1
 fi
 SECOND_OUT="$(git status --porcelain)"

Original file line number	Diff line number	Diff line change
`@@ -35,4 +35,4 @@ docker-compose run test`
`35`	`35`
`36`	`36`	`### Formatting`
`37`	`37`
`38`		`-We use Nick Lockwood's SwiftFormat for formatting code. PRs will not be accepted if they haven't be formatted. The current version of SwiftFormat we are using is v0.48.17.`
	`38`	`+We use Nick Lockwood's SwiftFormat for formatting code. PRs will not be accepted if they haven't be formatted. The current version of SwiftFormat we are using is v0.52.10.`
Original file line number	Diff line number	Diff line change
`@@ -107,7 +107,7 @@ final class WebSocketHandler: ChannelDuplexHandler {`
`107`	`107`
`108`	`108`	`/// Send ping and setup task to check for pong and send new ping`
`109`	`109`	`private func sendPingAndWait(context: ChannelHandlerContext) {`
`110`		`- guard context.channel.isActive, let pingInterval = pingInterval else {`
	`110`	`+ guard context.channel.isActive, let pingInterval else {`
`111`	`111`	`return`
`112`	`112`	`}`
`113`	`113`	`if self.waitingOnPong {`
Original file line number	Diff line number	Diff line change
`@@ -187,7 +187,7 @@ extension MQTTClient {`
`187`	`187`	`if auth.reason == .success {`
`188`	`188`	`return eventLoop.makeSucceededFuture(auth)`
`189`	`189`	`}`
`190`		`- guard let authWorkflow = authWorkflow else { return eventLoop.makeFailedFuture(MQTTError.authWorkflowRequired) }`
	`190`	`+ guard let authWorkflow else { return eventLoop.makeFailedFuture(MQTTError.authWorkflowRequired) }`
`191`	`191`	`return self.client.processAuth(authPacket, authWorkflow: authWorkflow, on: eventLoop)`
`192`	`192`	`}`
`193`	`193`	`.flatMapThrowing { response -> MQTTAuthV5 in`
Original file line number	Diff line number	Diff line change
`@@ -24,22 +24,22 @@ struct MQTTInflight {`
`24`	`24`	`/// add packet`
`25`	`25`	`mutating func add(packet: MQTTPacket) {`
`26`	`26`	`self.lock.withLock {`
`27`		`- packets.append(packet)`
	`27`	`+ self.packets.append(packet)`
`28`	`28`	`}`
`29`	`29`	`}`
`30`	`30`
`31`	`31`	`/// remove packert`
`32`	`32`	`mutating func remove(id: UInt16) {`
`33`	`33`	`self.lock.withLock {`
`34`	`34`	`guard let first = packets.firstIndex(where: { $0.packetId == id }) else { return }`
`35`		`- packets.remove(at: first)`
	`35`	`+ self.packets.remove(at: first)`
`36`	`36`	`}`
`37`	`37`	`}`
`38`	`38`
`39`	`39`	`/// remove all packets`
`40`	`40`	`mutating func clear() {`
`41`	`41`	`self.lock.withLock {`
`42`		`- packets = []`
	`42`	`+ self.packets = []`
`43`	`43`	`}`
`44`	`44`	`}`
`45`	`45`
Original file line number	Diff line number	Diff line change
`@@ -28,13 +28,13 @@ final class MQTTListeners<ReturnType> {`
`28`	`28`
`29`	`29`	`func addListener(named name: String, listener: @escaping Listener) {`
`30`	`30`	`self.lock.withLock {`
`31`		`- listeners[name] = listener`
	`31`	`+ self.listeners[name] = listener`
`32`	`32`	`}`
`33`	`33`	`}`
`34`	`34`
`35`	`35`	`func removeListener(named name: String) {`
`36`	`36`	`self.lock.withLock {`
`37`		`- listeners[name] = nil`
	`37`	`+ self.listeners[name] = nil`
`38`	`38`	`}`
`39`	`39`	`}`
`40`	`40`