Adopt NIO formatting rules & enable CI (#1178)

Author: rnro

.github/workflows/pull_request.yml

@@ -9,7 +9,6 @@ jobs:
  name: Soundness
  uses: swiftlang/github-workflows/.github/workflows/soundness.yml@main
  with:
- format_check_enabled: false
  license_header_check_project_name: "Swift Distributed Actors"
  # We need to move to 6.0 here but have to fix the new warnings first
  docs_check_container_image: "swift:5.10-noble"

InternalPlugins/FishyDocs/Package.swift

@@ -15,9 +15,9 @@ let package = Package(
  .plugin(
  name: "FishyDocsPlugin",
  targets: [
- "FishyDocsPlugin",
+ "FishyDocsPlugin"
  ]
- ),
+ )
  ],
  dependencies: [
  .package(url: "https://github.com/apple/swift-markdown.git", branch: "main"),
@@ -26,10 +26,10 @@ let package = Package(
  targets: [
  .plugin(
  name: "FishyDocsPlugin",
-// capability: .command(intent: .custom(verb: "fishy-docs", description: "Extracts source snippets from fishy-docs annotated docc documentation files")),
+ // capability: .command(intent: .custom(verb: "fishy-docs", description: "Extracts source snippets from fishy-docs annotated docc documentation files")),
  capability: .buildTool(),
  dependencies: [
- "FishyDocs",
+ "FishyDocs"
  ]
  ),
  .executableTarget(
@@ -42,7 +42,7 @@ let package = Package(
  .testTarget(
  name: "FishyDocsTests",
  dependencies: [
- "FishyDocs",
+ "FishyDocs"
  ]
  ),
  ]

InternalPlugins/FishyDocs/Sources/FishyDocs/FishyDocsMain.swift

@@ -151,7 +151,7 @@ struct ConcatCodeBlocks: MarkupWalker {
 
  codeBlockStrings.append(s)
  }
- codeBlockStrings.append("}") // end of __test()
+ codeBlockStrings.append("}")  // end of __test()
 
  return codeBlockStrings.joined(separator: "\n")
  }

InternalPlugins/FishyDocs/Tests/FishyDocsTests/FishyDocsTests.swift

@@ -11,9 +11,10 @@
 // SPDX-License-Identifier: Apache-2.0
 //
 //===----------------------------------------------------------------------===//
-@testable import FishyDocsLib
 import XCTest
 
+@testable import FishyDocsLib
+
 final class FishyDocsTests: XCTestCase {
  func testExample() throws {}
 }

MultiNodeTests/DistributedActorsMultiNodeTests/MultiNode+ClusterSingletonTests.swift

@@ -59,11 +59,11 @@ public final class MultiNodeClusterSingletonTests: MultiNodeTestSuite {
  TheSingleton(greeting: "Hello-\(actorSystem.name)", actorSystem: actorSystem)
  }
 
- try await multiNode.checkPoint("Hosted singleton") // ----------------------------------------------------------
+ try await multiNode.checkPoint("Hosted singleton")  // ----------------------------------------------------------
  let reply = try await ref.greet(name: "Hello from \(multiNode.system.name)")
  print("[ON: \(multiNode.system.name)] Got reply: \(reply)")
 
- try await multiNode.checkPoint("Got reply from singleton") // --------------------------------------------------
+ try await multiNode.checkPoint("Got reply from singleton")  // --------------------------------------------------
  // Since now all nodes have made a message exchange with the singleton, we can exit this process.
  // This barrier is important in so that we don't exit the host of the singleton WHILE the others are still getting to talking to it.
  }

MultiNodeTests/DistributedActorsMultiNodeTests/MultiNode+MultiNodeConductorTests.swift

@@ -45,7 +45,7 @@ public final class MultiNodeConductorTests: MultiNodeTestSuite {
  }
 
  public static func configureActorSystem(settings: inout ClusterSystemSettings) {
-// settings.logging.logLevel = .debug
+ // settings.logging.logLevel = .debug
  }
 
  public let testCrashSecondNode = MultiNodeTest(MultiNodeConductorTests.self) { multiNode in

MultiNodeTests/DistributedActorsMultiNodeTests/MultiNode+ReceptionistTests.swift

@@ -46,7 +46,7 @@ public final class MultiNodeReceptionistTests: MultiNodeTestSuite {
  // *All* nodes spawn an echo actor
  let localEcho = await DistributedEcho(greeting: "Hi from \(multiNode.system.name), ", actorSystem: multiNode.system)
 
- try await multiNode.checkPoint("Spawned actors") // ------------------------------------------------------------
+ try await multiNode.checkPoint("Spawned actors")  // ------------------------------------------------------------
 
  let expectedCount = Nodes.allCases.count
  var discovered: Set<DistributedEcho> = []
@@ -59,7 +59,7 @@ public final class MultiNodeReceptionistTests: MultiNodeTestSuite {
  }
  }
 
- try await multiNode.checkPoint("All members found \(expectedCount) actors") // ---------------------------------
+ try await multiNode.checkPoint("All members found \(expectedCount) actors")  // ---------------------------------
  }
 
  distributed actor DistributedEcho {

Package.swift

@@ -1,9 +1,10 @@
 // swift-tools-version:5.10
 // The swift-tools-version declares the minimum version of Swift required to build this package.
 
-import class Foundation.ProcessInfo
 import PackageDescription
 
+import class Foundation.ProcessInfo
+
 // Workaround: Since we cannot include the flat just as command line options since then it applies to all targets,
 // and ONE of our dependencies currently produces one warning, we have to use this workaround to enable it in _our_
 // targets when the flag is set. We should remove the dependencies and then enable the flag globally though just by passing it.
@@ -16,7 +17,7 @@ let products: [PackageDescription.Product] = [
  .library(
  name: "DistributedCluster",
  targets: ["DistributedCluster"]
- ),
+ )
 ]
 
 // ==== ----------------------------------------------------------------------------------------------------------------
@@ -30,7 +31,7 @@ var targets: [PackageDescription.Target] = [
  name: "DistributedCluster",
  dependencies: [
  "DistributedActorsConcurrencyHelpers",
- "CDistributedActorsMailbox", // TODO(swift): remove mailbox runtime, use Swift actors directly
+ "CDistributedActorsMailbox",  // TODO(swift): remove mailbox runtime, use Swift actors directly
  .product(name: "OrderedCollections", package: "swift-collections"),
  .product(name: "Atomics", package: "swift-atomics"),
  .product(name: "SWIM", package: "swift-cluster-membership"),
@@ -88,7 +89,7 @@ var targets: [PackageDescription.Target] = [
  name: "MultiNodeTestPlugin",
  capability: .command(
  intent: .custom(verb: "multi-node", description: "Run MultiNodeTestKit based tests across multiple processes or physical compute nodes")
- /* permissions: needs full network access */
+ // permissions: needs full network access
  ),
  dependencies: []
  ),
@@ -122,7 +123,7 @@ var targets: [PackageDescription.Target] = [
  .target(
  name: "DistributedActorsMultiNodeTests",
  dependencies: [
- "MultiNodeTestKit",
+ "MultiNodeTestKit"
  ],
  path: "MultiNodeTests/DistributedActorsMultiNodeTests"
  ),
@@ -134,7 +135,7 @@ var targets: [PackageDescription.Target] = [
  .executableTarget(
  name: "it_Clustered_swim_suspension_reachability",
  dependencies: [
- "DistributedCluster",
+ "DistributedCluster"
  ],
  path: "IntegrationTests/tests_01_cluster/it_Clustered_swim_suspension_reachability"
  ),
@@ -155,7 +156,7 @@ var targets: [PackageDescription.Target] = [
  name: "DistributedActorsConcurrencyHelpers",
  dependencies: [],
  exclude: [
- "README.md",
+ "README.md"
  ]
  ),
 ]
@@ -164,7 +165,7 @@ var dependencies: [Package.Dependency] = [
  .package(url: "https://github.com/apple/swift-atomics", from: "1.1.0"),
 
  // .package(url: "https://github.com/apple/swift-cluster-membership", from: "0.3.0"),
-// .package(name: "swift-cluster-membership", path: "Packages/swift-cluster-membership"), // FIXME: just work in progress
+ // .package(name: "swift-cluster-membership", path: "Packages/swift-cluster-membership"), // FIXME: just work in progress
  .package(url: "https://github.com/apple/swift-cluster-membership", branch: "main"),
 
  .package(url: "https://github.com/apple/swift-nio", from: "2.61.1"),
@@ -184,7 +185,7 @@ var dependencies: [Package.Dependency] = [
  // ~~~ Observability ~~~
  .package(url: "https://github.com/apple/swift-log", from: "1.0.0"),
  // swift-metrics 1.x and 2.x are almost API compatible, so most clients should use
- .package(url: "https://github.com/apple/swift-metrics", "1.0.0" ..< "3.0.0"),
+ .package(url: "https://github.com/apple/swift-metrics", "1.0.0"..<"3.0.0"),
  .package(url: "https://github.com/apple/swift-service-discovery", from: "1.3.0"),
 
  // ~~~ SwiftPM Plugins ~~~
@@ -207,13 +208,13 @@ if ProcessInfo.processInfo.environment["VALIDATE_DOCS"] != nil {
  .testTarget(
  name: "DocsTests",
  dependencies: [
- "DistributedCluster",
+ "DistributedCluster"
  ],
  exclude: [
- "README.md",
+ "README.md"
  ],
  plugins: [
- .plugin(name: "FishyDocsPlugin", package: "FishyDocsPlugin"),
+ .plugin(name: "FishyDocsPlugin", package: "FishyDocsPlugin")
  ]
  )
  )

Plugins/MultiNodeTestPlugin/plugin.swift

@@ -87,18 +87,20 @@ final class MultiNodeTestPlugin: CommandPlugin {
  }
 
  func usage(arguments: [String]) throws -> Never {
- throw UsageError(message: """
- ILLEGAL INVOCATION: \(arguments)
- USAGE:
- > swift package --disable-sandbox multi-node [OPTIONS] COMMAND
-
- OPTIONS:
- -c release/debug - to build in release or debug mode (default: \(self.buildConfiguration))
-
- COMMAND:
- test - run multi-node tests
- _exec
- """)
+ throw UsageError(
+ message: """
+ ILLEGAL INVOCATION: \(arguments)
+ USAGE:
+ > swift package --disable-sandbox multi-node [OPTIONS] COMMAND
+
+ OPTIONS:
+ -c release/debug - to build in release or debug mode (default: \(self.buildConfiguration))
+
+ COMMAND:
+ test - run multi-node tests
+ _exec
+ """
+ )
  }
 }
 
@@ -114,14 +116,14 @@ struct UsageError: Error, CustomStringConvertible {
 extension Process {
  var binaryPath: String? {
  get {
- if #available(macOS 10.13, /* Linux */ *) {
+ if #available(macOS 10.13, *) { // '*' covers Linux
  return self.executableURL?.path
  } else {
  return self.launchPath
  }
  }
  set {
- if #available(macOS 10.13, /* Linux */ *) {
+ if #available(macOS 10.13, *) { // '*' covers Linux
  self.executableURL = newValue.map { URL(fileURLWithPath: $0) }
  } else {
  self.launchPath = newValue

Samples/Package.swift

@@ -6,11 +6,11 @@ import PackageDescription
 var globalSwiftSettings: [SwiftSetting]
 
 var globalConcurrencyFlags: [String] = [
- "-Xfrontend", "-disable-availability-checking", // TODO(distributed): remove this flag
+ "-Xfrontend", "-disable-availability-checking",  // TODO(distributed): remove this flag
 ]
 
 globalSwiftSettings = [
- SwiftSetting.unsafeFlags(globalConcurrencyFlags),
+ SwiftSetting.unsafeFlags(globalConcurrencyFlags)
 ]
 
 var targets: [PackageDescription.Target] = [
@@ -20,7 +20,7 @@ var targets: [PackageDescription.Target] = [
  .executableTarget(
  name: "SampleDiningPhilosophers",
  dependencies: [
- .product(name: "DistributedCluster", package: "swift-distributed-actors"),
+ .product(name: "DistributedCluster", package: "swift-distributed-actors")
  ],
  path: "Sources/SampleDiningPhilosophers",
  exclude: [
@@ -29,20 +29,19 @@ var targets: [PackageDescription.Target] = [
  ]
  ),
 
- /* --- tests --- */
+ // --- tests ---
 
  // no-tests placeholder project to not have `swift test` fail on Samples/
  .testTarget(
  name: "NoopTests",
- dependencies: [
- ],
+ dependencies: [],
  path: "Tests/NoopTests"
  ),
 ]
 
 var dependencies: [Package.Dependency] = [
  // ~~~~~~~ parent ~~~~~~~
- .package(name: "swift-distributed-actors", path: "../"),
+ .package(name: "swift-distributed-actors", path: "../")
 
  // ~~~~~~~ only for samples ~~~~~~~
 ]
@@ -57,12 +56,12 @@ let package = Package(
  .watchOS(.v9),
  ],
  products: [
- /* --- samples --- */
+ // --- samples ---
 
  .executable(
  name: "SampleDiningPhilosophers",
  targets: ["SampleDiningPhilosophers"]
- ),
+ )
  ],
 
  dependencies: dependencies,