[CI] Make all CI checks green

# Motivation We just adopted GH actions and want to make sure all the CI checks are green. # Modification This PR makes the necessary changes to pass all checks. Including: - Adding a licenseignore file - Moving `swift-format` and adopting the config that we use in all other swift on server repos. # Result Green CI.
apple · Oct 23, 2024 · f46277f · f46277f
1 parent f9a647b
commit f46277f
Show file tree

Hide file tree

Showing 29 changed files with 541 additions and 207 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -14,12 +14,12 @@ jobs:
       linux_6_0_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error"
       linux_nightly_6_0_arguments_override: "--explicit-target-dependency-import-check error"
       linux_nightly_main_arguments_override: "--explicit-target-dependency-import-check error"
-      windows_6_0_enabled: true
-      windows_nightly_6_0_enabled: true
-      windows_nightly_main_enabled: true
-      windows_6_0_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
-      windows_nightly_6_0_arguments_override: "--explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
-      windows_nightly_main_arguments_override: "--explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
+
+  benchmarks:
+    name: Benchmarks
+    uses: apple/swift-nio/.github/workflows/benchmarks.yml@main
+    with:
+      benchmark_package_path: "Benchmarks"
 
   cxx-interop:
     name: Cxx interop

diff --git a/.github/workflows/pull_request.yml b/.github/workflows/pull_request.yml
@@ -20,12 +20,12 @@ jobs:
       linux_6_0_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error"
       linux_nightly_6_0_arguments_override: "--explicit-target-dependency-import-check error"
       linux_nightly_main_arguments_override: "--explicit-target-dependency-import-check error"
-      windows_6_0_enabled: true
-      windows_nightly_6_0_enabled: true
-      windows_nightly_main_enabled: true
-      windows_6_0_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
-      windows_nightly_6_0_arguments_override: "--explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
-      windows_nightly_main_arguments_override: "--explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
+
+  benchmarks:
+    name: Benchmarks
+    uses: apple/swift-nio/.github/workflows/benchmarks.yml@main
+    with:
+      benchmark_package_path: "Benchmarks"
 
   cxx-interop:
     name: Cxx interop

diff --git a/.github/workflows/scheduled.yml b/.github/workflows/scheduled.yml
@@ -14,12 +14,12 @@ jobs:
       linux_6_0_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error"
       linux_nightly_6_0_arguments_override: "--explicit-target-dependency-import-check error"
       linux_nightly_main_arguments_override: "--explicit-target-dependency-import-check error"
-      windows_6_0_enabled: true
-      windows_nightly_6_0_enabled: true
-      windows_nightly_main_enabled: true
-      windows_6_0_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
-      windows_nightly_6_0_arguments_override: "--explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
-      windows_nightly_main_arguments_override: "--explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
+
+  benchmarks:
+    name: Benchmarks
+    uses: apple/swift-nio/.github/workflows/benchmarks.yml@main
+    with:
+      benchmark_package_path: "Benchmarks"
 
   cxx-interop:
     name: Cxx interop

diff --git a/.licenseignore b/.licenseignore
@@ -0,0 +1,43 @@
+.gitignore
+**/.gitignore
+.licenseignore
+.gitattributes
+.git-blame-ignore-revs
+.mailfilter
+.mailmap
+.spi.yml
+.swift-format
+.editorconfig
+.github/*
+*.md
+*.txt
+*.yml
+*.yaml
+*.json
+Package.swift
+**/Package.swift
+Package@-*.swift
+**/Package@-*.swift
+Package.resolved
+**/Package.resolved
+Makefile
+*.modulemap
+**/*.modulemap
+**/*.docc/*
+*.xcprivacy
+**/*.xcprivacy
+*.symlink
+**/*.symlink
+Dockerfile
+**/Dockerfile
+Sources/CMakeLists.txt
+Sources/SwiftASN1/CMakeLists.txt
+dev/alloc-limits-from-test-output
+dev/boxed-existentials.d
+dev/git.commit.template
+dev/lldb-smoker
+dev/make-single-file-spm
+dev/malloc-aggregation.d
+dev/update-alloc-limits-to-last-completed-ci-build
+Benchmarks/Benchmarks/SwiftASN1Benchmark/ca-certificates/*.crt
+Benchmarks/Benchmarks/SwiftASN1Benchmark/ca-certificates/*/*.crt
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/.swiftformat b/.swiftformat
diff --git a/Benchmarks/Benchmarks/HTTPFieldsBenchmarks/Benchmarks.swift b/Benchmarks/Benchmarks/HTTPFieldsBenchmarks/Benchmarks.swift
@@ -16,8 +16,18 @@ import Benchmark
 import HTTPTypes
 
 let benchmarks = {
+    let defaultMetrics: [BenchmarkMetric] = [
+        .mallocCountTotal
+    ]
+
     Benchmark(
-        "Initialize HTTPFields from Dictionary Literal"
+        "HTTPFields.init(dictionaryLiteral:) ",
+        configuration: .init(
+            metrics: defaultMetrics,
+            scalingFactor: .kilo,
+            maxDuration: .seconds(10_000_000),
+            maxIterations: 10
+        )
     ) { _ in
         let fiels: HTTPFields = [
             .contentType: "application/json",

diff --git a/Benchmarks/Package.swift b/Benchmarks/Package.swift
@@ -5,7 +5,7 @@ import PackageDescription
 let package = Package(
     name: "Benchmarks",
     platforms: [
-        .macOS(.v13),
+        .macOS(.v13)
     ],
     dependencies: [
         .package(path: "../"),
@@ -20,8 +20,8 @@ let package = Package(
             ],
             path: "Benchmarks/HTTPFieldsBenchmarks",
             plugins: [
-                .plugin(name: "BenchmarkPlugin", package: "package-benchmark"),
+                .plugin(name: "BenchmarkPlugin", package: "package-benchmark")
             ]
-        ),
+        )
     ]
 )
diff --git a/Benchmarks/Thresholds/5.10/HTTPFieldsBenchmarks.HTTPFields.init(dictionaryLiteral:).p90.json b/Benchmarks/Thresholds/5.10/HTTPFieldsBenchmarks.HTTPFields.init(dictionaryLiteral:).p90.json
@@ -0,0 +1,3 @@
+{
+  "mallocCountTotal" : 8000
+}
diff --git a/Benchmarks/Thresholds/5.9/HTTPFieldsBenchmarks.HTTPFields.init(dictionaryLiteral:).p90.json b/Benchmarks/Thresholds/5.9/HTTPFieldsBenchmarks.HTTPFields.init(dictionaryLiteral:).p90.json
@@ -0,0 +1,3 @@
+{
+  "mallocCountTotal" : 8000
+}
diff --git a/Benchmarks/Thresholds/6.0/HTTPFieldsBenchmarks.HTTPFields.init(dictionaryLiteral:).p90.json b/Benchmarks/Thresholds/6.0/HTTPFieldsBenchmarks.HTTPFields.init(dictionaryLiteral:).p90.json
@@ -0,0 +1,3 @@
+{
+  "mallocCountTotal" : 8000
+}
diff --git a/.../Thresholds/nightly-6.0/HTTPFieldsBenchmarks.HTTPFields.init(dictionaryLiteral:).p90.json b/.../Thresholds/nightly-6.0/HTTPFieldsBenchmarks.HTTPFields.init(dictionaryLiteral:).p90.json
@@ -0,0 +1,3 @@
+{
+  "mallocCountTotal" : 8000
+}
diff --git a/...Thresholds/nightly-main/HTTPFieldsBenchmarks.HTTPFields.init(dictionaryLiteral:).p90.json b/...Thresholds/nightly-main/HTTPFieldsBenchmarks.HTTPFields.init(dictionaryLiteral:).p90.json
@@ -0,0 +1,3 @@
+{
+  "mallocCountTotal" : 8000
+}
diff --git a/Package.swift b/Package.swift
@@ -8,27 +8,24 @@ let package = Package(
         .library(name: "HTTPTypes", targets: ["HTTPTypes"]),
         .library(name: "HTTPTypesFoundation", targets: ["HTTPTypesFoundation"]),
     ],
-    dependencies: [
-        .package(url: "https://github.com/apple/swift-docc-plugin", from: "1.3.0"),
-    ],
     targets: [
         .target(name: "HTTPTypes"),
         .target(
             name: "HTTPTypesFoundation",
             dependencies: [
-                "HTTPTypes",
+                "HTTPTypes"
             ]
         ),
         .testTarget(
             name: "HTTPTypesTests",
             dependencies: [
-                "HTTPTypes",
+                "HTTPTypes"
             ]
         ),
         .testTarget(
             name: "HTTPTypesFoundationTests",
             dependencies: [
-                "HTTPTypesFoundation",
+                "HTTPTypesFoundation"
             ]
         ),
     ]

diff --git a/Sources/HTTPTypes/HTTPField.swift b/Sources/HTTPTypes/HTTPField.swift
@@ -112,7 +112,9 @@ public struct HTTPField: Sendable, Hashable {
     ///
     /// - Parameter body: The closure to be invoked with the buffer.
     /// - Returns: Result of the `body` closure.
-    public func withUnsafeBytesOfValue<Result>(_ body: (UnsafeBufferPointer<UInt8>) throws -> Result) rethrows -> Result {
+    public func withUnsafeBytesOfValue<Result>(
+        _ body: (UnsafeBufferPointer<UInt8>) throws -> Result
+    ) rethrows -> Result {
         try self.rawValue.withUnsafeBytes(body)
     }
 
@@ -135,7 +137,7 @@ public struct HTTPField: Sendable, Hashable {
             switch byte {
             case 0x09, 0x20:
                 break
-            case 0x21 ... 0x7E, 0x80 ... 0xFF:
+            case 0x21...0x7E, 0x80...0xFF:
                 break
             default:
                 return false
@@ -161,13 +163,15 @@ public struct HTTPField: Sendable, Hashable {
                 switch byte {
                 case 0x09, 0x20:
                     return byte
-                case 0x21 ... 0x7E, 0x80 ... 0xFF:
+                case 0x21...0x7E, 0x80...0xFF:
                     return byte
                 default:
                     return 0x20
                 }
             }
-            let trimmed = bytes.reversed().drop { $0 == 0x09 || $0 == 0x20 }.reversed().drop { $0 == 0x09 || $0 == 0x20 }
+            let trimmed = bytes.reversed().drop { $0 == 0x09 || $0 == 0x20 }.reversed().drop {
+                $0 == 0x09 || $0 == 0x20
+            }
             return ISOLatin1String(unchecked: String(decoding: trimmed, as: UTF8.self))
         }
     }
@@ -242,27 +246,33 @@ extension HTTPField: Codable {
         let name = try container.decode(Name.self, forKey: .name)
         let value = try container.decode(String.self, forKey: .value)
         guard Self.isValidValue(value) else {
-            throw DecodingError.dataCorruptedError(forKey: .value, in: container, debugDescription: "HTTP field value \"\(value)\" contains invalid characters")
+            throw DecodingError.dataCorruptedError(
+                forKey: .value,
+                in: container,
+                debugDescription: "HTTP field value \"\(value)\" contains invalid characters"
+            )
         }
         self.init(name: name, uncheckedValue: ISOLatin1String(unchecked: value))
         if let indexingStrategyValue = try container.decodeIfPresent(UInt8.self, forKey: .indexingStrategy),
-           let indexingStrategy = DynamicTableIndexingStrategy(rawValue: indexingStrategyValue) {
+            let indexingStrategy = DynamicTableIndexingStrategy(rawValue: indexingStrategyValue)
+        {
             self.indexingStrategy = indexingStrategy
         }
     }
 }
 
 extension HTTPField {
     static func isValidToken(_ token: some StringProtocol) -> Bool {
-        !token.isEmpty && token.utf8.allSatisfy {
-            switch $0 {
-            case 0x21, 0x23, 0x24, 0x25, 0x26, 0x27, 0x2A, 0x2B, 0x2D, 0x2E, 0x5E, 0x5F, 0x60, 0x7C, 0x7E:
-                return true
-            case 0x30 ... 0x39, 0x41 ... 0x5A, 0x61 ... 0x7A: // DIGHT, ALPHA
-                return true
-            default:
-                return false
+        !token.isEmpty
+            && token.utf8.allSatisfy {
+                switch $0 {
+                case 0x21, 0x23, 0x24, 0x25, 0x26, 0x27, 0x2A, 0x2B, 0x2D, 0x2E, 0x5E, 0x5F, 0x60, 0x7C, 0x7E:
+                    return true
+                case 0x30...0x39, 0x41...0x5A, 0x61...0x7A:  // DIGHT, ALPHA
+                    return true
+                default:
+                    return false
+                }
             }
-        }
     }
 }