Adopt swift-format (#2794)

* Apply formatting * Apply no block comments rule * Apply OmitExplicitReturns * Apple OnlyOneTrailingClosureArgument * Apply NoAssignmentInExpressions * Fix up DontRepeatTypeInStaticProperties lint errors * Apply `OrderedImports` * Apply `ReplaceForEachWithForLoop` * format file * Enable the formatting pipeline * Adopt `AmbiguousTrailingClosureOverload` * Fix license header * Fix format check * Fix `EndOfLineComment` * Fix CI * Adapt CI script to check if changes when running formatting * Separate lint and format into to steps * Fix format * Adopt `UseEarlyExits` * Revert "Adopt `UseEarlyExits`" This reverts commit d1ac5bb.
apple · Jul 19, 2024 · c9756e1 · c9756e1
1 parent 980bd3e
commit c9756e1
Show file tree

Hide file tree

Showing 374 changed files with 24,007 additions and 14,905 deletions.
diff --git a/.github/workflows/pull_request.yml b/.github/workflows/pull_request.yml
@@ -10,7 +10,6 @@ jobs:
     uses: ./.github/workflows/pull_request_soundness.yml
     with:
       license_header_check_project_name: "SwiftNIO"
-      format_check_enabled: false
 
   call-pull-request-unit-tests-workflow:
     name: Unit tests

diff --git a/.github/workflows/pull_request_soundness.yml b/.github/workflows/pull_request_soundness.yml
@@ -123,5 +123,12 @@ jobs:
     steps:
     - name: Checkout repository
       uses: actions/checkout@v4
-    - name: Run format check
-      run: swift format lint --parallel --recursive --strict
+    - name: Mark the workspace as safe
+    # https://github.com/actions/checkout/issues/766
+      run: git config --global --add safe.directory ${GITHUB_WORKSPACE}
+    - name: Run format lint check
+      run:  swift format lint --strict --recursive --parallel .
+    - name: Run format and check for modified files
+      run: |
+        swift format format --parallel --recursive --in-place .
+        git diff-index --quiet HEAD
diff --git a/.swift-format b/.swift-format
@@ -0,0 +1,62 @@
+{
+  "version" : 1,
+  "indentation" : {
+    "spaces" : 4
+  },
+  "tabWidth" : 4,
+  "fileScopedDeclarationPrivacy" : {
+    "accessLevel" : "private"
+  },
+  "spacesAroundRangeFormationOperators" : false,
+  "indentConditionalCompilationBlocks" : false,
+  "indentSwitchCaseLabels" : false,
+  "lineBreakAroundMultilineExpressionChainComponents" : false,
+  "lineBreakBeforeControlFlowKeywords" : false,
+  "lineBreakBeforeEachArgument" : true,
+  "lineBreakBeforeEachGenericRequirement" : true,
+  "lineLength" : 120,
+  "maximumBlankLines" : 1,
+  "respectsExistingLineBreaks" : true,
+  "prioritizeKeepingFunctionOutputTogether" : true,
+  "rules" : {
+    "AllPublicDeclarationsHaveDocumentation" : false,
+    "AlwaysUseLiteralForEmptyCollectionInit" : false,
+    "AlwaysUseLowerCamelCase" : false,
+    "AmbiguousTrailingClosureOverload" : true,
+    "BeginDocumentationCommentWithOneLineSummary" : false,
+    "DoNotUseSemicolons" : true,
+    "DontRepeatTypeInStaticProperties" : true,
+    "FileScopedDeclarationPrivacy" : true,
+    "FullyIndirectEnum" : true,
+    "GroupNumericLiterals" : true,
+    "IdentifiersMustBeASCII" : true,
+    "NeverForceUnwrap" : false,
+    "NeverUseForceTry" : false,
+    "NeverUseImplicitlyUnwrappedOptionals" : false,
+    "NoAccessLevelOnExtensionDeclaration" : true,
+    "NoAssignmentInExpressions" : true,
+    "NoBlockComments" : true,
+    "NoCasesWithOnlyFallthrough" : true,
+    "NoEmptyTrailingClosureParentheses" : true,
+    "NoLabelsInCasePatterns" : true,
+    "NoLeadingUnderscores" : false,
+    "NoParensAroundConditions" : true,
+    "NoVoidReturnOnFunctionSignature" : true,
+    "OmitExplicitReturns" : true,
+    "OneCasePerLine" : true,
+    "OneVariableDeclarationPerLine" : true,
+    "OnlyOneTrailingClosureArgument" : true,
+    "OrderedImports" : true,
+    "ReplaceForEachWithForLoop" : true,
+    "ReturnVoidInsteadOfEmptyTuple" : true,
+    "UseEarlyExits" : false,
+    "UseExplicitNilCheckInConditions" : false,
+    "UseLetInEveryBoundCaseVariable" : false,
+    "UseShorthandTypeNames" : true,
+    "UseSingleLinePropertyGetter" : false,
+    "UseSynthesizedInitializer" : false,
+    "UseTripleSlashForDocumentationComments" : true,
+    "UseWhereClausesInForLoops" : false,
+    "ValidateDocumentationComments" : false
+  }
+}
diff --git a/Benchmarks/Benchmarks/NIOCoreBenchmarks/Benchmarks.swift b/Benchmarks/Benchmarks/NIOCoreBenchmarks/Benchmarks.swift
@@ -18,7 +18,7 @@ import NIOEmbedded
 
 let benchmarks = {
     let defaultMetrics: [BenchmarkMetric] = [
-        .mallocCountTotal,
+        .mallocCountTotal
     ]
 
     Benchmark(
@@ -28,7 +28,7 @@ let benchmarks = {
         // Elide the cost of the 'EmbeddedChannel'. It's only used for its pipeline.
         var channels: [EmbeddedChannel] = []
         channels.reserveCapacity(benchmark.scaledIterations.count)
-        for _ in 0 ..< benchmark.scaledIterations.count {
+        for _ in 0..<benchmark.scaledIterations.count {
             channels.append(EmbeddedChannel())
         }
 

diff --git a/Benchmarks/Benchmarks/NIOPosixBenchmarks/Benchmarks.swift b/Benchmarks/Benchmarks/NIOPosixBenchmarks/Benchmarks.swift
@@ -19,7 +19,7 @@ private let eventLoop = MultiThreadedEventLoopGroup.singleton.next()
 
 let benchmarks = {
     let defaultMetrics: [BenchmarkMetric] = [
-        .mallocCountTotal,
+        .mallocCountTotal
     ]
 
     Benchmark(

diff --git a/Benchmarks/Benchmarks/NIOPosixBenchmarks/TCPEchoAsyncChannel.swift b/Benchmarks/Benchmarks/NIOPosixBenchmarks/TCPEchoAsyncChannel.swift
@@ -22,7 +22,7 @@ func runTCPEchoAsyncChannel(numberOfWrites: Int, eventLoop: EventLoop) async thr
             port: 0
         ) { channel in
             channel.eventLoop.makeCompletedFuture {
-                return try NIOAsyncChannel(
+                try NIOAsyncChannel(
                     wrappingChannelSynchronously: channel,
                     configuration: .init(
                         inboundType: ByteBuffer.self,
@@ -38,7 +38,7 @@ func runTCPEchoAsyncChannel(numberOfWrites: Int, eventLoop: EventLoop) async thr
             port: serverChannel.channel.localAddress!.port!
         ) { channel in
             channel.eventLoop.makeCompletedFuture {
-                return try NIOAsyncChannel(
+                try NIOAsyncChannel(
                     wrappingChannelSynchronously: channel,
                     configuration: .init(
                         inboundType: ByteBuffer.self,
@@ -55,7 +55,9 @@ func runTCPEchoAsyncChannel(numberOfWrites: Int, eventLoop: EventLoop) async thr
         group.addTask {
             try await serverChannel.executeThenClose { serverChannelInbound in
                 for try await connectionChannel in serverChannelInbound {
-                    try await connectionChannel.executeThenClose { connectionChannelInbound, connectionChannelOutbound in
+                    try await connectionChannel.executeThenClose {
+                        connectionChannelInbound,
+                        connectionChannelOutbound in
                         for try await inboundData in connectionChannelInbound {
                             try await connectionChannelOutbound.write(inboundData)
                         }
@@ -68,7 +70,7 @@ func runTCPEchoAsyncChannel(numberOfWrites: Int, eventLoop: EventLoop) async thr
             // This child task is collecting the echoed back responses.
             group.addTask {
                 var receivedData = 0
-                for try await inboundData in inbound  {
+                for try await inboundData in inbound {
                     receivedData += inboundData.readableBytes
 
                     if receivedData == numberOfWrites * messageSize {

diff --git a/Benchmarks/Benchmarks/NIOPosixBenchmarks/Util/GlobalExecutor.swift b/Benchmarks/Benchmarks/NIOPosixBenchmarks/Util/GlobalExecutor.swift
@@ -25,9 +25,9 @@ import Glibc
 typealias EnqueueGlobalHook = @convention(thin) (UnownedJob, @convention(thin) (UnownedJob) -> Void) -> Void
 
 var swiftTaskEnqueueGlobalHook: EnqueueGlobalHook? {
-  get { _swiftTaskEnqueueGlobalHook.pointee }
-  set { _swiftTaskEnqueueGlobalHook.pointee = newValue }
+    get { _swiftTaskEnqueueGlobalHook.pointee }
+    set { _swiftTaskEnqueueGlobalHook.pointee = newValue }
 }
 
 private let _swiftTaskEnqueueGlobalHook: UnsafeMutablePointer<EnqueueGlobalHook?> =
-  dlsym(dlopen(nil, RTLD_LAZY), "swift_task_enqueueGlobal_hook").assumingMemoryBound(to: EnqueueGlobalHook?.self)
+    dlsym(dlopen(nil, RTLD_LAZY), "swift_task_enqueueGlobal_hook").assumingMemoryBound(to: EnqueueGlobalHook?.self)
diff --git a/Benchmarks/Package.swift b/Benchmarks/Package.swift
@@ -5,7 +5,7 @@ import PackageDescription
 let package = Package(
     name: "benchmarks",
     platforms: [
-        .macOS("14"),
+        .macOS("14")
     ],
     dependencies: [
         .package(path: "../"),

diff --git a/IntegrationTests/allocation-counter-tests-framework/template/AtomicCounter/Package.swift b/IntegrationTests/allocation-counter-tests-framework/template/AtomicCounter/Package.swift
@@ -19,12 +19,13 @@ import PackageDescription
 let package = Package(
     name: "AtomicCounter",
     products: [
-        .library(name: "AtomicCounter", type: .dynamic, targets: ["AtomicCounter"]),
+        .library(name: "AtomicCounter", type: .dynamic, targets: ["AtomicCounter"])
     ],
-    dependencies: [ ],
+    dependencies: [],
     targets: [
         .target(
             name: "AtomicCounter",
-            dependencies: []),
+            dependencies: []
+        )
     ]
 )
diff --git a/...tionTests/allocation-counter-tests-framework/template/HookedFunctionsDoHook/Package.swift b/...tionTests/allocation-counter-tests-framework/template/HookedFunctionsDoHook/Package.swift
@@ -19,12 +19,12 @@ import PackageDescription
 let package = Package(
     name: "HookedFunctions",
     products: [
-        .library(name: "HookedFunctions", type: .dynamic, targets: ["HookedFunctions"]),
+        .library(name: "HookedFunctions", type: .dynamic, targets: ["HookedFunctions"])
     ],
     dependencies: [
-        .package(url: "../AtomicCounter/", branch: "main"),
+        .package(url: "../AtomicCounter/", branch: "main")
     ],
     targets: [
-        .target(name: "HookedFunctions", dependencies: ["AtomicCounter"]),
+        .target(name: "HookedFunctions", dependencies: ["AtomicCounter"])
     ]
 )
diff --git a/...nTests/allocation-counter-tests-framework/template/HookedFunctionsDoNotHook/Package.swift b/...nTests/allocation-counter-tests-framework/template/HookedFunctionsDoNotHook/Package.swift
@@ -19,12 +19,12 @@ import PackageDescription
 let package = Package(
     name: "HookedFunctions",
     products: [
-        .library(name: "HookedFunctions", type: .dynamic, targets: ["HookedFunctions"]),
+        .library(name: "HookedFunctions", type: .dynamic, targets: ["HookedFunctions"])
     ],
     dependencies: [
-        .package(url: "../AtomicCounter/", branch: "main"),
+        .package(url: "../AtomicCounter/", branch: "main")
     ],
     targets: [
-        .target(name: "HookedFunctions", dependencies: ["AtomicCounter"]),
+        .target(name: "HookedFunctions", dependencies: ["AtomicCounter"])
     ]
 )
diff --git a/IntegrationTests/allocation-counter-tests-framework/template/scaffolding.swift b/IntegrationTests/allocation-counter-tests-framework/template/scaffolding.swift
@@ -12,8 +12,9 @@
 //
 //===----------------------------------------------------------------------===//
 
-import Foundation
 import AtomicCounter
+import Foundation
+
 #if canImport(Darwin)
 import Darwin
 #elseif canImport(Glibc)
@@ -24,7 +25,7 @@ import Glibc
 
 func waitForThreadsToQuiesce(shouldReachZero: Bool) {
     func getUnfreed() -> Int {
-        return AtomicCounter.read_malloc_counter() - AtomicCounter.read_free_counter()
+        AtomicCounter.read_malloc_counter() - AtomicCounter.read_free_counter()
     }
 
     var oldNumberOfUnfreed = getUnfreed()
@@ -35,7 +36,8 @@ func waitForThreadsToQuiesce(shouldReachZero: Bool) {
             return
         }
         count += 1
-        usleep(shouldReachZero ? 50_000 : 200_000) // allocs/frees happen on multiple threads, allow some cool down time
+        // allocs/frees happen on multiple threads, allow some cool down time
+        usleep(shouldReachZero ? 50_000 : 200_000)
         let newNumberOfUnfreed = getUnfreed()
         if oldNumberOfUnfreed == newNumberOfUnfreed && (!shouldReachZero || newNumberOfUnfreed <= 0) {
             // nothing happened in the last 100ms, let's assume everything's
@@ -57,7 +59,11 @@ struct Measurement {
 }
 
 extension Array where Element == Measurement {
-    private func printIntegerMetric(_ keyPath: KeyPath<Measurement, Int>, description desc: String, metricName k: String) {
+    private func printIntegerMetric(
+        _ keyPath: KeyPath<Measurement, Int>,
+        description desc: String,
+        metricName k: String
+    ) {
         let vs = self.map { $0[keyPath: keyPath] }
         print("\(desc).\(k): \(vs.min() ?? -1)")
     }
@@ -90,13 +96,13 @@ func measureAll(trackFDs: Bool, _ fn: () -> Int) -> [Measurement] {
             AtomicCounter.begin_tracking_fds()
         }
 
-#if canImport(Darwin)
+        #if canImport(Darwin)
         autoreleasepool {
             _ = fn()
         }
-#else
+        #else
         _ = fn()
-#endif
+        #endif
         waitForThreadsToQuiesce(shouldReachZero: !throwAway)
         let frees = AtomicCounter.read_free_counter()
         let mallocs = AtomicCounter.read_malloc_counter()
@@ -121,7 +127,7 @@ func measureAll(trackFDs: Bool, _ fn: () -> Int) -> [Measurement] {
         )
     }
 
-    _ = measureOne(throwAway: true, trackFDs: trackFDs, fn) /* pre-heat and throw away */
+    _ = measureOne(throwAway: true, trackFDs: trackFDs, fn)  // pre-heat and throw away
 
     var measurements: [Measurement] = []
     for _ in 0..<10 {
@@ -132,19 +138,19 @@ func measureAll(trackFDs: Bool, _ fn: () -> Int) -> [Measurement] {
     return measurements
 }
 
-func measureAndPrint(desc: String, trackFDs: Bool, fn: () -> Int) -> Void {
+func measureAndPrint(desc: String, trackFDs: Bool, fn: () -> Int) {
     let measurements = measureAll(trackFDs: trackFDs, fn)
     measurements.printTotalAllocations(description: desc)
     measurements.printRemainingAllocations(description: desc)
     measurements.printTotalAllocatedBytes(description: desc)
     measurements.printLeakedFDs(description: desc)
-    
+
     print("DEBUG: \(measurements)")
 }
 
 public func measure(identifier: String, trackFDs: Bool = false, _ body: () -> Int) {
     measureAndPrint(desc: identifier, trackFDs: trackFDs) {
-        return body()
+        body()
     }
 }
 
@@ -160,7 +166,7 @@ func measureAll(trackFDs: Bool, _ fn: @escaping () async -> Int) -> [Measurement
             }
             group.wait()
         }
-        
+
         if trackFDs {
             AtomicCounter.begin_tracking_fds()
         }
@@ -169,13 +175,13 @@ func measureAll(trackFDs: Bool, _ fn: @escaping () async -> Int) -> [Measurement
         AtomicCounter.reset_malloc_counter()
         AtomicCounter.reset_malloc_bytes_counter()
 
-#if canImport(Darwin)
+        #if canImport(Darwin)
         autoreleasepool {
             run(fn)
         }
-#else
+        #else
         run(fn)
-#endif
+        #endif
         waitForThreadsToQuiesce(shouldReachZero: !throwAway)
         let frees = AtomicCounter.read_free_counter()
         let mallocs = AtomicCounter.read_malloc_counter()
@@ -200,7 +206,7 @@ func measureAll(trackFDs: Bool, _ fn: @escaping () async -> Int) -> [Measurement
         )
     }
 
-    _ = measureOne(throwAway: true, trackFDs: trackFDs, fn) /* pre-heat and throw away */
+    _ = measureOne(throwAway: true, trackFDs: trackFDs, fn)  // pre-heat and throw away
 
     var measurements: [Measurement] = []
     for _ in 0..<10 {
@@ -212,7 +218,7 @@ func measureAll(trackFDs: Bool, _ fn: @escaping () async -> Int) -> [Measurement
 }
 
 @available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *)
-func measureAndPrint(desc: String, trackFDs: Bool, fn: @escaping () async -> Int) -> Void {
+func measureAndPrint(desc: String, trackFDs: Bool, fn: @escaping () async -> Int) {
     let measurements = measureAll(trackFDs: trackFDs, fn)
     measurements.printTotalAllocations(description: desc)
     measurements.printRemainingAllocations(description: desc)