Consolekit 5

.github/workflows/api-docs.yml

@@ -13,5 +13,5 @@ jobs:
      secrets: inherit
      with:
        package_name: console-kit
-       modules: ConsoleKit,ConsoleKitTerminal,ConsoleKitCommands
-       pathsToInvalidate: /consolekit/* /consolekitterminal/* /consolekitcommands/*
+       modules: ConsoleKit,ConsoleLogger
+       pathsToInvalidate: /consolekit/* /consolelogger/*

.github/workflows/benchmark.yml

@@ -0,0 +1,21 @@
+name: benchmark
+on:
+  workflow_dispatch:
+    inputs:
+      sha:
+        type: string
+        required: true
+        description: "The commit SHA to run the benchmarks against."
+  push:
+    branches: [main]
+permissions:
+  contents: read
+  id-token: write
+  pull-requests: write
+
+jobs:
+  benchmark:
+    uses: vapor/ci/.github/workflows/run-benchmark.yml@main
+    with:
+      sha: ${{ inputs.sha }}
+    secrets: inherit

.github/workflows/test.yml

@@ -14,9 +14,23 @@ jobs:
       contents: read
     uses: vapor/ci/.github/workflows/run-unit-tests.yml@main
     with:
-       with_windows: true
-       with_musl: true
+      with_windows: true
+      with_musl: true
+      with_android: true
+      with_linting: true
+      enable_all_traits: true
     secrets: inherit
+
+  package-traits:
+    permissions:
+      contents: read
+    runs-on: ubuntu-latest
+    container: swift:noble
+    steps:
+      - name: Check out ConsoleKit
+        uses: actions/checkout@v6
+      - name: Run tests with traits disabled
+        run: swift test --disable-default-traits
 
   submit-dependencies:
     permissions:
@@ -25,15 +39,13 @@ jobs:
     uses: vapor/ci/.github/workflows/submit-deps.yml@main
     secrets: inherit
 
-  integration-check:
-    permissions:
-      contents: read
-    runs-on: ubuntu-latest
-    container: swift:noble
-    steps:
-      - uses: actions/checkout@v6
-        with: { path: console-kit }
-      - uses: actions/checkout@v6
-        with: { repository: 'vapor/vapor', path: vapor }
-      - run: swift package --package-path vapor edit console-kit --path console-kit
-      - run: swift test --package-path vapor
+  # integration-check:
+  #   runs-on: ubuntu-latest
+  #   container: swift:noble
+  #   steps:
+  #     - uses: actions/checkout@v6
+  #       with: { path: console-kit }
+  #     - uses: actions/checkout@v6
+  #       with: { repository: 'vapor/vapor', path: vapor }
+  #     - run: swift package --package-path vapor edit console-kit --path console-kit
+  #     - run: swift test --package-path vapor

.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": 8,
+  "version": 1
+}

Benchmarks/.gitignore

@@ -0,0 +1,10 @@
+.build
+Packages
+*.xcodeproj
+Package.pins
+Package.resolved
+.DS_Store
+DerivedData
+.swiftpm
+Tests/LinuxMain.swift
+.vscode

Benchmarks/.swift-format

@@ -0,0 +1 @@
+../.swift-format

Benchmarks/ConsoleLoggerBenchmarks/ConsoleLoggerBenchmarks.swift

@@ -0,0 +1,80 @@
+import Benchmark
+import ConsoleLogger
+import Logging
+
+let benchmarks: @Sendable () -> Void = {
+    Benchmark.defaultConfiguration = .init(
+        metrics: [.peakMemoryResident, .mallocCountTotal],
+        thresholds: [
+            .peakMemoryResident: .init(
+                // Tolerate up to 4% of difference compared to the threshold.
+                relative: [.p90: 4],
+                // Tolerate up to one million bytes of difference compared to the threshold.
+                absolute: [.p90: 1_100_000]
+            ),
+            .mallocCountTotal: .init(
+                // Tolerate up to 1% of difference compared to the threshold.
+                relative: [.p90: 1],
+                // Tolerate up to 2 malloc calls of difference compared to the threshold.
+                absolute: [.p90: 2]
+            ),
+        ]
+    )
+
+    Benchmark(
+        "Logging",
+        configuration: .init(
+            setup: {
+                ConsoleLogger.bootstrap(
+                    metadataProvider: .init {
+                        ["provided1": "from metadata provider", "provided2": "another metadata provider"]
+                    }
+                )
+            }
+        )
+    ) { benchmark in
+        var logger = Logger(label: "codes.vapor.console")
+        logger.logLevel = .trace
+        logger[metadataKey: "value"] = "one"
+
+        for _ in benchmark.scaledIterations {
+            logger.info(
+                "Info",
+                metadata: ["from-log": "value", "also-from-log": "other"]
+            )
+        }
+    }
+
+    Benchmark(
+        "LoggerFragmentBuilder",
+        configuration: .init(
+            setup: {
+                ConsoleLogger.bootstrap(
+                    metadataProvider: .init {
+                        ["provided1": "from metadata provider", "provided2": "another metadata provider"]
+                    }
+                ) {
+                    // This is the default logger fragment, but built using LoggerFragmentBuilder
+                    SpacedFragment {
+                        LabelFragment().maxLevel(.trace)
+                        LevelFragment()
+                        MessageFragment()
+                        MetadataFragment()
+                        SourceLocationFragment().maxLevel(.debug)
+                    }
+                }
+            }
+        )
+    ) { benchmark in
+        var logger = Logger(label: "codes.vapor.console")
+        logger.logLevel = .trace
+        logger[metadataKey: "value"] = "one"
+
+        for _ in benchmark.scaledIterations {
+            logger.info(
+                "Info",
+                metadata: ["from-log": "value", "also-from-log": "other"]
+            )
+        }
+    }
+}

Benchmarks/Package.swift

@@ -0,0 +1,42 @@
+// swift-tools-version:6.1
+import PackageDescription
+
+let package = Package(
+    name: "benchmarks",
+    platforms: [
+        .macOS(.v15)
+    ],
+    dependencies: [
+        .package(path: "../"),
+        .package(url: "https://github.com/ordo-one/package-benchmark.git", from: "1.29.2"),
+        .package(url: "https://github.com/apple/swift-log.git", from: "1.6.3"),
+    ],
+    targets: [
+        .executableTarget(
+            name: "ConsoleLoggerBenchmarks",
+            dependencies: [
+                .product(name: "Benchmark", package: "package-benchmark"),
+                .product(name: "ConsoleLogger", package: "console-kit"),
+                .product(name: "ConsoleKit", package: "console-kit"),
+                .product(name: "Logging", package: "swift-log"),
+            ],
+            path: "ConsoleLoggerBenchmarks",
+            swiftSettings: swiftSettings,
+            plugins: [
+                .plugin(name: "BenchmarkPlugin", package: "package-benchmark")
+            ]
+        )
+    ]
+)
+
+var swiftSettings: [SwiftSetting] {
+    [
+        .enableUpcomingFeature("ExistentialAny"),
+        .enableUpcomingFeature("MemberImportVisibility"),
+        .enableUpcomingFeature("ExistentialAny"),
+        .enableUpcomingFeature("InternalImportsByDefault"),
+        .enableUpcomingFeature("MemberImportVisibility"),
+        .enableUpcomingFeature("InferIsolatedConformances"),
+        .enableUpcomingFeature("ImmutableWeakCaptures"),
+    ]
+}

Benchmarks/Thresholds/ConsoleLoggerBenchmarks.LoggerFragmentBuilder.p90.json

@@ -0,0 +1,4 @@
+{
+  "mallocCountTotal" : 38,
+  "peakMemoryResident" : 11042816
+}

Benchmarks/Thresholds/ConsoleLoggerBenchmarks.Logging.p90.json

@@ -0,0 +1,4 @@
+{
+  "mallocCountTotal" : 30,
+  "peakMemoryResident" : 11108352
+}