Update benchmarking + Support Android + add .swift-format + other ref…

…inements (#227)
vapor · Feb 14, 2025 · d5c5e02 · d5c5e02
1 parent 03f5013
commit d5c5e02
Show file tree

Hide file tree

Showing 56 changed files with 355 additions and 181 deletions.
diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml
@@ -1,20 +1,17 @@
 name: benchmark
 on:
   workflow_dispatch:
+    inputs:
+      sha:
+        type: string
+        required: true
+        description: "The commit SHA to run the benchmarks against."
   push:
     branches: [main]
-  pull_request_review:
-    types: [submitted]
-  pull_request:
-    branches: [main]
-    types: [synchronize]
-    paths:
-      - Sources/*.swift
-      - Benchmarks/
-      - .github/workflows/benchmark.yml
 
 jobs:
   benchmark:
-    if: github.run_attempt > 1 || github.event.review.state == 'approved' || startsWith(github.event_name, 'pull_request') != true
     uses: vapor/ci/.github/workflows/run-benchmark.yml@main
+    with:
+      sha: ${{ inputs.sha }}
     secrets: inherit
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -4,14 +4,14 @@ concurrency:
   cancel-in-progress: true
 on:
   pull_request: { types: [opened, reopened, synchronize, ready_for_review] }
-  push: { branches: [ main ] }
+  push: { branches: [main] }
 
-jobs:  
+jobs:
   linux-integration:
     if: ${{ !(github.event.pull_request.draft || false) }}
     runs-on: ubuntu-latest
-    container: swift:jammy
-    steps: 
+    container: swift:noble
+    steps:
       - name: Check out JWTKit
         uses: actions/checkout@v4
         with:
@@ -34,5 +34,6 @@ jobs:
       with_linting: true
       with_windows: true
       with_musl: true
+      with_android: true
       ios_scheme_name: jwt-kit
-    secrets: inherit
+    secrets: inherit
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,6 @@
 Packages
 .build
+.index-build
 .DS_Store
 *.xcodeproj
 Package.pins

diff --git a/.swift-format b/.swift-format
@@ -0,0 +1,70 @@
+{
+  "fileScopedDeclarationPrivacy": {
+    "accessLevel": "private"
+  },
+  "indentation": {
+    "spaces": 4
+  },
+  "indentConditionalCompilationBlocks": false,
+  "indentSwitchCaseLabels": false,
+  "lineBreakAroundMultilineExpressionChainComponents": false,
+  "lineBreakBeforeControlFlowKeywords": false,
+  "lineBreakBeforeEachArgument": false,
+  "lineBreakBeforeEachGenericRequirement": false,
+  "lineLength": 140,
+  "maximumBlankLines": 1,
+  "multiElementCollectionTrailingCommas": true,
+  "noAssignmentInExpressions": {
+    "allowedFunctions": [
+      "XCTAssertNoThrow"
+    ]
+  },
+  "prioritizeKeepingFunctionOutputTogether": false,
+  "respectsExistingLineBreaks": true,
+  "rules": {
+    "AllPublicDeclarationsHaveDocumentation": false,
+    "AlwaysUseLiteralForEmptyCollectionInit": false,
+    "AlwaysUseLowerCamelCase": true,
+    "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,
+    "NoPlaygroundLiterals": true,
+    "NoVoidReturnOnFunctionSignature": true,
+    "OmitExplicitReturns": false,
+    "OneCasePerLine": true,
+    "OneVariableDeclarationPerLine": true,
+    "OnlyOneTrailingClosureArgument": true,
+    "OrderedImports": true,
+    "ReplaceForEachWithForLoop": true,
+    "ReturnVoidInsteadOfEmptyTuple": true,
+    "TypeNamesShouldBeCapitalized": true,
+    "UseEarlyExits": false,
+    "UseExplicitNilCheckInConditions": true,
+    "UseLetInEveryBoundCaseVariable": true,
+    "UseShorthandTypeNames": true,
+    "UseSingleLinePropertyGetter": true,
+    "UseSynthesizedInitializer": true,
+    "UseTripleSlashForDocumentationComments": true,
+    "UseWhereClausesInForLoops": false,
+    "ValidateDocumentationComments": false
+  },
+  "spacesAroundRangeFormationOperators": false,
+  "tabWidth": 4,
+  "version": 1
+}
diff --git a/Benchmarks/.gitignore b/Benchmarks/.gitignore
@@ -0,0 +1 @@
+../.gitignore
diff --git a/Benchmarks/.swiftformat b/Benchmarks/.swiftformat
@@ -0,0 +1 @@
+../.swiftformat
diff --git a/Benchmarks/Package.swift b/Benchmarks/Package.swift
@@ -18,7 +18,7 @@ let package = Package(
                 .product(name: "Benchmark", package: "package-benchmark"),
                 .product(name: "JWTKit", package: "jwt-kit"),
             ],
-            path: "Benchmarks/Signing",
+            path: "Signing",
             plugins: [
                 .plugin(name: "BenchmarkPlugin", package: "package-benchmark")
             ]
@@ -29,7 +29,7 @@ let package = Package(
                 .product(name: "Benchmark", package: "package-benchmark"),
                 .product(name: "JWTKit", package: "jwt-kit"),
             ],
-            path: "Benchmarks/Verifying",
+            path: "Verifying",
             plugins: [
                 .plugin(name: "BenchmarkPlugin", package: "package-benchmark")
             ]
@@ -40,7 +40,7 @@ let package = Package(
                 .product(name: "Benchmark", package: "package-benchmark"),
                 .product(name: "JWTKit", package: "jwt-kit"),
             ],
-            path: "Benchmarks/TokenLifecycle",
+            path: "TokenLifecycle",
             plugins: [
                 .plugin(name: "BenchmarkPlugin", package: "package-benchmark")
             ]

diff --git a/Benchmarks/Benchmarks/Signing/Signing.swift → Benchmarks/Signing/Signing.swift b/Benchmarks/Benchmarks/Signing/Signing.swift → Benchmarks/Signing/Signing.swift
diff --git a/...marks/TokenLifecycle/TokenLifecycle.swift → ...marks/TokenLifecycle/TokenLifecycle.swift b/...marks/TokenLifecycle/TokenLifecycle.swift → ...marks/TokenLifecycle/TokenLifecycle.swift
diff --git a/...arks/Benchmarks/Verifying/Verifying.swift → Benchmarks/Verifying/Verifying.swift b/...arks/Benchmarks/Verifying/Verifying.swift → Benchmarks/Verifying/Verifying.swift
diff --git a/Snippets/JWKExamples.swift b/Snippets/JWKExamples.swift
@@ -1,9 +1,9 @@
 import JWTKit
 
 #if !canImport(Darwin)
-    import FoundationEssentials
+import FoundationEssentials
 #else
-    import Foundation
+import Foundation
 #endif
 
 let rsaModulus = "..."

diff --git a/Snippets/JWTKitExamples.swift b/Snippets/JWTKitExamples.swift
@@ -2,9 +2,9 @@
 import JWTKit
 
 #if !canImport(Darwin)
-    import FoundationEssentials
+import FoundationEssentials
 #else
-    import Foundation
+import Foundation
 #endif
 
 // Signs and verifies JWTs

diff --git a/Sources/JWTKit/Claims/ExpirationClaim.swift b/Sources/JWTKit/Claims/ExpirationClaim.swift
@@ -1,7 +1,7 @@
 #if !canImport(Darwin)
-    import FoundationEssentials
+import FoundationEssentials
 #else
-    import Foundation
+import Foundation
 #endif
 
 /// The "exp" (expiration time) claim identifies the expiration time on

diff --git a/Sources/JWTKit/Claims/IssuedAtClaim.swift b/Sources/JWTKit/Claims/IssuedAtClaim.swift
@@ -1,7 +1,7 @@
 #if !canImport(Darwin)
-    import FoundationEssentials
+import FoundationEssentials
 #else
-    import Foundation
+import Foundation
 #endif
 
 /// The "iat" (issued at) claim identifies the time at which the JWT was

diff --git a/Sources/JWTKit/Claims/JWTMultiValueClaim.swift b/Sources/JWTKit/Claims/JWTMultiValueClaim.swift
@@ -1,7 +1,7 @@
 #if !canImport(Darwin)
-    import FoundationEssentials
+import FoundationEssentials
 #else
-    import Foundation
+import Foundation
 #endif
 
 public protocol JWTMultiValueClaim: JWTClaim where Value: Collection, Value.Element: Codable {

diff --git a/Sources/JWTKit/Claims/JWTUnixEpochClaim.swift b/Sources/JWTKit/Claims/JWTUnixEpochClaim.swift
@@ -1,7 +1,7 @@
 #if !canImport(Darwin)
-    import FoundationEssentials
+import FoundationEssentials
 #else
-    import Foundation
+import Foundation
 #endif
 
 public protocol JWTUnixEpochClaim: JWTClaim where Value == Date {}

diff --git a/Sources/JWTKit/Claims/LocaleClaim.swift b/Sources/JWTKit/Claims/LocaleClaim.swift
@@ -1,7 +1,7 @@
 #if !canImport(Darwin)
-    import FoundationEssentials
+import FoundationEssentials
 #else
-    import Foundation
+import Foundation
 #endif
 
 public struct LocaleClaim: JWTClaim, Equatable, ExpressibleByStringLiteral {

diff --git a/Sources/JWTKit/Claims/NotBeforeClaim.swift b/Sources/JWTKit/Claims/NotBeforeClaim.swift
@@ -1,7 +1,7 @@
 #if !canImport(Darwin)
-    import FoundationEssentials
+import FoundationEssentials
 #else
-    import Foundation
+import Foundation
 #endif
 
 /// The "nbf" (not before) claim identifies the time before which the JWT

diff --git a/Sources/JWTKit/ECDSA/ECDSA.swift b/Sources/JWTKit/ECDSA/ECDSA.swift
@@ -2,9 +2,9 @@ import Crypto
 import X509
 
 #if !canImport(Darwin)
-    import FoundationEssentials
+import FoundationEssentials
 #else
-    import Foundation
+import Foundation
 #endif
 
 public enum ECDSA: Sendable {}

diff --git a/Sources/JWTKit/ECDSA/ECDSAKeyTypes.swift b/Sources/JWTKit/ECDSA/ECDSAKeyTypes.swift
@@ -2,9 +2,9 @@ import Crypto
 import X509
 
 #if !canImport(Darwin)
-    import FoundationEssentials
+import FoundationEssentials
 #else
-    import Foundation
+import Foundation
 #endif
 
 /// A typealias representing the parameters of an ECDSA (Elliptic Curve Digital Signature Algorithm) key.

diff --git a/Sources/JWTKit/ECDSA/ECDSASigner.swift b/Sources/JWTKit/ECDSA/ECDSASigner.swift
@@ -1,7 +1,7 @@
 #if !canImport(Darwin)
-    import FoundationEssentials
+import FoundationEssentials
 #else
-    import Foundation
+import Foundation
 #endif
 
 struct ECDSASigner<Key: ECDSAKey>: JWTAlgorithm, CryptoSigner {

diff --git a/Sources/JWTKit/ECDSA/P256+CurveType.swift b/Sources/JWTKit/ECDSA/P256+CurveType.swift
@@ -1,9 +1,9 @@
 import Crypto
 
 #if !canImport(Darwin)
-    import FoundationEssentials
+import FoundationEssentials
 #else
-    import Foundation
+import Foundation
 #endif
 
 // TODO: Remove @unchecked Sendable when Crypto is updated to use Sendable

diff --git a/Sources/JWTKit/ECDSA/P384+CurveType.swift b/Sources/JWTKit/ECDSA/P384+CurveType.swift
@@ -1,9 +1,9 @@
 import Crypto
 
 #if !canImport(Darwin)
-    import FoundationEssentials
+import FoundationEssentials
 #else
-    import Foundation
+import Foundation
 #endif
 
 // TODO: Remove @unchecked Sendable when Crypto is updated to use Sendable

diff --git a/Sources/JWTKit/ECDSA/P521+CurveType.swift b/Sources/JWTKit/ECDSA/P521+CurveType.swift
@@ -1,9 +1,9 @@
 import Crypto
 
 #if !canImport(Darwin)
-    import FoundationEssentials
+import FoundationEssentials
 #else
-    import Foundation
+import Foundation
 #endif
 
 // TODO: Remove @unchecked Sendable when Crypto is updated to use Sendable

diff --git a/Sources/JWTKit/EdDSA/EdDSA.swift b/Sources/JWTKit/EdDSA/EdDSA.swift
@@ -1,9 +1,9 @@
 import Crypto
 
 #if !canImport(Darwin)
-    import FoundationEssentials
+import FoundationEssentials
 #else
-    import Foundation
+import Foundation
 #endif
 
 /// Namespace for the EdDSA (Edwards-curve Digital Signature Algorithm) signing algorithm.

diff --git a/Sources/JWTKit/EdDSA/EdDSASigner.swift b/Sources/JWTKit/EdDSA/EdDSASigner.swift
@@ -1,9 +1,9 @@
 import Crypto
 
 #if !canImport(Darwin)
-    import FoundationEssentials
+import FoundationEssentials
 #else
-    import Foundation
+import Foundation
 #endif
 
 struct EdDSASigner: JWTAlgorithm, Sendable {

diff --git a/Sources/JWTKit/EdDSA/JWTKeyCollection+EdDSA.swift b/Sources/JWTKit/EdDSA/JWTKeyCollection+EdDSA.swift
@@ -1,9 +1,9 @@
 import Crypto
 
 #if !canImport(Darwin)
-    import FoundationEssentials
+import FoundationEssentials
 #else
-    import Foundation
+import Foundation
 #endif
 
 extension JWTKeyCollection {

diff --git a/Sources/JWTKit/HMAC/HMAC.swift b/Sources/JWTKit/HMAC/HMAC.swift
@@ -1,9 +1,9 @@
 @preconcurrency import Crypto
 
 #if !canImport(Darwin)
-    import FoundationEssentials
+import FoundationEssentials
 #else
-    import Foundation
+import Foundation
 #endif
 
 public struct HMACKey: Sendable {

diff --git a/Sources/JWTKit/HMAC/HMACSigner.swift b/Sources/JWTKit/HMAC/HMACSigner.swift
@@ -1,9 +1,9 @@
 @preconcurrency import Crypto
 
 #if !canImport(Darwin)
-    import FoundationEssentials
+import FoundationEssentials
 #else
-    import Foundation
+import Foundation
 #endif
 
 struct HMACSigner<SHAType>: JWTAlgorithm where SHAType: HashFunction {

diff --git a/Sources/JWTKit/HMAC/JWTKeyCollection+HMAC.swift b/Sources/JWTKit/HMAC/JWTKeyCollection+HMAC.swift
@@ -1,9 +1,9 @@
 import Crypto
 
 #if !canImport(Darwin)
-    import FoundationEssentials
+import FoundationEssentials
 #else
-    import Foundation
+import Foundation
 #endif
 
 extension JWTKeyCollection {