mirror of
https://github.com/apple/swift-log
synced 2026-11-22 03:40:39 +00:00
main
368
Commits
| Author | SHA1 | Message | Date | |
|---|---|---|---|---|
|
|
82cf87d893 |
bump minimum Swift tools version to 6.2.3 (#534)
closes #533 |
||
|
|
47655e0c23 |
Adopt /swiftlang CI workflows (#536)
Switch from swift-nio to swiftlang CI workflows. As there is no tag yet available, let's use the latest hash for now. ### Motivation: Modernize and unify workflows with swiftlang. ### Modifications: CI configuration updated. ### Result: No swift-nio references in CI workflows. Additionally, Swift tools version triplet is now supported to unblock #534 |
||
|
|
d05c8efdae |
Make benchmarks more reliable by using the scale factor (#539)
### Motivation: Currently the benchmark machinery overhead is causing a lot of noise in benchmarks of very efficient/fast code. ### Modifications: Use the scaling factor to amortize the fixed overhead and let the actual tested code account for most of the measured metrics. ### Result: More reliable benchmarks that don't fail 20% of the time. |
||
|
|
c7413d967b |
Make MultiplexLogHandler.metadataProvider setter replace the initializer's provider (#537)
### Motivation: `MultiplexLogHandler.metadataProvider`'s setter only forwards the new provider to the underlying handlers. Since #522, `log(event:)` also merges the provider passed to `init(_:metadataProvider:)` on top of the underlying handlers' metadata, so after a set that old provider still overrides the new one for conflicting keys, setting `nil` doesn't remove it, and the getter keeps returning it. This shows up through `Logger(label:metadataProvider:)`, which calls the factory and then sets `handler.metadataProvider`. If the bootstrapped factory returns a `MultiplexLogHandler` with its own provider, the provider the library passed is silently overridden. With a plain handler the same code uses the library's provider, which is what `Logger(label:metadataProvider:)` documents ("the custom metadata provider this logger should invoke, instead of the system wide bootstrapped one"). ### Modifications: - In the setter, also replace the multiplex handler's own provider with the new value. It is still forwarded to the underlying handlers as before. - Document the setter. - Add regression tests: setting a provider replaces the initializer's provider for one and two handlers, and setting `nil` clears it (both the getter and emitted logs). Another test covers an underlying handler that doesn't support metadata providers. I kept forwarding to the underlying handlers and replace the multiplex handler's own provider as well, rather than clearing it. Clearing it would drop provider metadata for underlying handlers that use the default `metadataProvider` implementation in the `Logger(label:metadataProvider:)` case, which works today. ### Result: After `handler.metadataProvider = p`, logs and the getter use `p`. After `handler.metadataProvider = nil`, no provider metadata is added. In the common setup where the factory passes its provider into the `MultiplexLogHandler` initializer, the number of provider calls per log stays the same. When the multiplex handler had no provider of its own, a set now also applies the provider once at the multiplex level, so underlying handlers without provider support get its metadata too. The new tests fail on main and pass with this change. All tests pass locally on macOS (Swift 6.3.3), and `swift format lint` is clean on the changed files. I couldn't run the benchmarks locally. This change was drafted with Claude Code (claude-opus-5-5); the test results above are from the runs described.1.17.2 |
||
|
|
34b131f794 |
Support raw-identifier module names in Logger.currentModule. (#535)
When a module name (via `-module-alias`) is a raw identifier (SE-0451), `#fileID` formats the module component enclosed in backticks (for example, `` `/a/b/c`/File.swift ``). If the raw identifier contains '/', splitting on the first '/' in `#fileID` truncates the module name at the slash inside the backticks. When `#fileID` starts with a backtick, advance past the matching closing backtick before searching for the '/' separator that ends the module name, preserving the enclosing backticks.1.17.1 |
||
|
|
e3da040787 |
Fix metadata priority in MultiplexLogHandler.metadata (#530)
Fixes #498 ## Problem `MultiplexLogHandler` had inconsistent metadata priority: - `subscript(metadataKey:)` reads the value from the **first** handler that has the key (documented: "the first handler's values are more important") - `metadata` (full dictionary) merged handlers **last-wins**, so the value came from the **last** handler with that key ## Fix The `metadata` getter now merges handlers in their initialization order, keeping the already-stored value on conflicts — the **first handler wins**, matching the subscript and the docs. The multiplex handler's own `metadataProvider` still takes priority over all underlying handlers/providers, matching its documented role ("runs after all metadata providers of the multiplexed handlers"). ## Testing - Updated `multiplexLogHandlerMetadata_readingHandlerMetadata` and `multiplexMetadataProviderSet`, which encoded the last-wins behavior - Extended `multiplexMetadataProviderSet` with subscript-vs-dictionary consistency checks (both must give the first handler's value on conflicting keys, including provider-provided metadata) - Full suite: 174 tests in 17 suites, all passing --------- Co-authored-by: awaisdev <awais@airtechsolutions.pk> Co-authored-by: awaisdev5765 <awaisdev5765@users.noreply.github.com> Co-authored-by: Vladimir Kukushkin <kukushechkin@apple.com>1.17.0 |
||
|
|
209524e4da |
Remove unnecessary optional so example compiles (#501)
There's an unnecessary optional return here that prevents the example from compiling. ### Motivation: It took me a moment to figure out how to fix this, but in the end it was very straightforward. The `prepareMetadata` doesn't ever need to return nil. ### Modifications: A small type change fixes the compilation errors in `log(event:)` ### Result: The example in the documentation can now be used unmodified. |
||
|
|
c44b210eee |
Add opt-in millisecond precision to StreamLogHandler timestamp (#483)
`StreamLogHandler` timestamps only have second precision, so when several log lines land in the same second you can't tell what order they happened in. This adds an **opt-in** setting for millisecond precision. The default output doesn't change, since some users parse it. **Changes** - Adds `public var timestampPrecision: TimestampPrecision = .seconds` to `StreamLogHandler`. - Adds a nested `TimestampPrecision` enum (`@nonexhaustive`, `Sendable`) with `.seconds` and `.milliseconds`. - With `.milliseconds`, the timestamp includes a 3-digit millisecond field: - default (`.seconds`): `2021-11-06T18:47:14+0300 info myapp: message` - `.milliseconds`: `2021-11-06T18:47:14.123+0300 info myapp: message` - How each platform reads the time: - Darwin, Linux and Android use `clock_gettime(CLOCK_REALTIME)`. - Windows uses `_ftime64_s`. - WASI only has second resolution (`CLOCK_REALTIME` isn't importable there), so `.milliseconds` always prints `.000`. The doc comments say so. - Both new symbols are added to the DocC reference page. **Tests** - The default precision is `.seconds`. - `.milliseconds` produces the expected format (checked with a regex). - Milliseconds are always zero-padded to 3 digits. - The existing output-format tests are unchanged and still pass, which confirms the default format. Fixes #212 |
||
|
|
d0f784af9e |
Bump swiftlang/github-workflows/.github/workflows/soundness.yml from 0.0.16 to 0.0.17 (#531)
Bumps [swiftlang/github-workflows/.github/workflows/soundness.yml](https://github.com/swiftlang/github-workflows) from 0.0.16 to 0.0.17. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/swiftlang/github-workflows/releases">swiftlang/github-workflows/.github/workflows/soundness.yml's releases</a>.</em></p> <blockquote> <h2>0.0.17</h2> <h2>What's Changed</h2> <ul> <li>Add embedded_wasm_sdk_build_command option to swift_package_test by <a href="https://github.com/jmschonfeld"><code>@jmschonfeld</code></a> in <a href="https://redirect.github.com/swiftlang/github-workflows/pull/323">swiftlang/github-workflows#323</a></li> <li>Update proposal validation workflow to use Swift 6.4 by <a href="https://github.com/dempseyatgithub"><code>@dempseyatgithub</code></a> in <a href="https://redirect.github.com/swiftlang/github-workflows/pull/328">swiftlang/github-workflows#328</a></li> <li>Soundness: add additional tool arguments input to API breakage check by <a href="https://github.com/bkhouri"><code>@bkhouri</code></a> in <a href="https://redirect.github.com/swiftlang/github-workflows/pull/324">swiftlang/github-workflows#324</a></li> <li>Add documentation for the Soundness API breakage check by <a href="https://github.com/bkhouri"><code>@bkhouri</code></a> in <a href="https://redirect.github.com/swiftlang/github-workflows/pull/325">swiftlang/github-workflows#325</a></li> </ul> <h2>New Contributors</h2> <ul> <li><a href="https://github.com/jmschonfeld"><code>@jmschonfeld</code></a> made their first contribution in <a href="https://redirect.github.com/swiftlang/github-workflows/pull/323">swiftlang/github-workflows#323</a></li> </ul> <p><strong>Full Changelog</strong>: <a href="https://github.com/swiftlang/github-workflows/compare/0.0.16...0.0.17">https://github.com/swiftlang/github-workflows/compare/0.0.16...0.0.17</a></p> </blockquote> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/swiftlang/github-workflows/commit/87329d126a6992483ba89aabefa1eaef1e5b0aad"><code>87329d1</code></a> Add documentation for the Soundness API breakage check (<a href="https://redirect.github.com/swiftlang/github-workflows/issues/325">#325</a>)</li> <li><a href="https://github.com/swiftlang/github-workflows/commit/f2b93cfd0a54ad78f875a58c846180f6729f7e28"><code>f2b93cf</code></a> Soundness: add additional tool arguments input to API breakage check (<a href="https://redirect.github.com/swiftlang/github-workflows/issues/324">#324</a>)</li> <li><a href="https://github.com/swiftlang/github-workflows/commit/3a7b5fccc7bb752a47c9ea0a0e605bb774077bc3"><code>3a7b5fc</code></a> Update proposal validation workflow to use Swift 6.4 (<a href="https://redirect.github.com/swiftlang/github-workflows/issues/328">#328</a>)</li> <li><a href="https://github.com/swiftlang/github-workflows/commit/c80652d51ee2b4df69e8d0d26d78a9d2ff466ecd"><code>c80652d</code></a> Add embedded_wasm_sdk_build_command option to swift_package_test (<a href="https://redirect.github.com/swiftlang/github-workflows/issues/323">#323</a>)</li> <li>See full diff in <a href="https://github.com/swiftlang/github-workflows/compare/0.0.16...0.0.17">compare view</a></li> </ul> </details> <br /> [](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) </details> Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> |
||
|
|
c9c6bb9d27 |
Mutate the logger's handler in place on metadata writes (#529)
Give `Logger.handler` a `_modify` accessor and replace its `get` with `_read`, so metadata writes update the stored handler instead of a copy. ### Motivation: `Logger.handler` only has `get` and `set`. A write such as `logger[metadataKey: "k"] = "v"` gets a copy of the handler, writes to it while the stored handler still shares the metadata dictionary, and sets it back. So every write copies the whole dictionary, and `withLogger(mergingMetadata:)` does that once per key. ### Modifications: - Give `Logger.handler` `_read`, `set` and `_modify` accessors. `_read` yields the stored handler. `_modify` keeps the existing uniqueness check on the storage and then yields the stored handler, so metadata and log level writes change it in place. `set` keeps the same check for plain `logger.handler = newHandler` assignments, which are cheaper through a setter than through `_modify`. - Add a test handler that counts copies of its metadata, with tests for direct writes and for `withLogger(mergingMetadata:)`. Without the change they report 10 copies instead of 0, and 5 instead of 1. ### Result: A metadata write on a logger that owns its storage no longer copies the dictionary. A copied logger still copies once on its first write, so value semantics are unchanged. 1,000 metadata writes with a handler that keeps metadata in a plain dictionary, debug build, three runs each: | Keys on the logger | Before | After | |---|---|---| | 10 | 7.2 to 8.1 ms | 0.46 to 0.50 ms | | 1,000 | 20.2 to 20.6 ms | 0.46 to 0.55 ms | | 10,000 | 134.0 to 134.4 ms | 0.47 to 0.50 ms | | 100,000 | 1.29 to 1.30 s | 0.32 to 0.35 ms | `withLogger(mergingMetadata:)` with 10,000 keys went from 0.64 to 0.65 s down to 2.9 to 3.1 ms. `StreamLogHandler` still rebuilds its pretty metadata string on every write; this change does not touch that. All 176 tests pass on macOS with Swift 6.4, and `swift format lint --strict` and `swift package diagnose-api-breaking-changes` are clean. Once yielding accessors land, `_read` and `_modify` can become `yielding borrow` and `yielding mutate`. Fixes #526.1.16.2 |
||
|
|
6404842475 |
Bump swiftlang/github-workflows/.github/workflows/soundness.yml from 0.0.15 to 0.0.16 (#528)
Bumps [swiftlang/github-workflows/.github/workflows/soundness.yml](https://github.com/swiftlang/github-workflows) from 0.0.15 to 0.0.16. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/swiftlang/github-workflows/releases">swiftlang/github-workflows/.github/workflows/soundness.yml's releases</a>.</em></p> <blockquote> <h2>0.0.16</h2> <h2>What's Changed</h2> <ul> <li>sha-pin for dependencies-action by <a href="https://github.com/madrob"><code>@madrob</code></a> in <a href="https://redirect.github.com/swiftlang/github-workflows/pull/317">swiftlang/github-workflows#317</a></li> <li>Update all Swift package test defaults to 6.4 by <a href="https://github.com/finagolfin"><code>@finagolfin</code></a> in <a href="https://redirect.github.com/swiftlang/github-workflows/pull/319">swiftlang/github-workflows#319</a></li> <li>Fix check-docs.sh failing on macOS when an option has no values by <a href="https://github.com/jakepetroules"><code>@jakepetroules</code></a> in <a href="https://redirect.github.com/swiftlang/github-workflows/pull/320">swiftlang/github-workflows#320</a></li> <li>Make CONTRIBUTORS.txt optional in license headers by <a href="https://github.com/crleonard"><code>@crleonard</code></a> in <a href="https://redirect.github.com/swiftlang/github-workflows/pull/268">swiftlang/github-workflows#268</a></li> <li>Add configurable timeouts for Linux, Static SDK, Wasm, and Android builds by <a href="https://github.com/austenstone"><code>@austenstone</code></a> in <a href="https://redirect.github.com/swiftlang/github-workflows/pull/321">swiftlang/github-workflows#321</a></li> <li>Use the new LTS Android NDK alone for both testing packages and for workflow pulls here by <a href="https://github.com/finagolfin"><code>@finagolfin</code></a> in <a href="https://redirect.github.com/swiftlang/github-workflows/pull/315">swiftlang/github-workflows#315</a></li> </ul> <h2>New Contributors</h2> <ul> <li><a href="https://github.com/crleonard"><code>@crleonard</code></a> made their first contribution in <a href="https://redirect.github.com/swiftlang/github-workflows/pull/268">swiftlang/github-workflows#268</a></li> <li><a href="https://github.com/austenstone"><code>@austenstone</code></a> made their first contribution in <a href="https://redirect.github.com/swiftlang/github-workflows/pull/321">swiftlang/github-workflows#321</a></li> </ul> <p><strong>Full Changelog</strong>: <a href="https://github.com/swiftlang/github-workflows/compare/0.0.15...0.0.16">https://github.com/swiftlang/github-workflows/compare/0.0.15...0.0.16</a></p> </blockquote> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/swiftlang/github-workflows/commit/3137ed1a48293ae9f4312fce349ed6210251db89"><code>3137ed1</code></a> Use the new LTS Android NDK alone for both testing packages and for workflow ...</li> <li><a href="https://github.com/swiftlang/github-workflows/commit/b9dfa3cb6e7361cac9170478c8569df324683ce6"><code>b9dfa3c</code></a> Add configurable step timeouts for Linux, Static SDK, Wasm, and Android build...</li> <li><a href="https://github.com/swiftlang/github-workflows/commit/a0e26726cfe9f46c9eec63f7af64060bb733761f"><code>a0e2672</code></a> Make CONTRIBUTORS.txt optional in license headers (<a href="https://redirect.github.com/swiftlang/github-workflows/issues/268">#268</a>)</li> <li><a href="https://github.com/swiftlang/github-workflows/commit/b9633883fec533530ebd7d5e82ef8ca832c2035f"><code>b963388</code></a> Fix check-docs.sh failing on macOS when an option has no values (<a href="https://redirect.github.com/swiftlang/github-workflows/issues/320">#320</a>)</li> <li><a href="https://github.com/swiftlang/github-workflows/commit/fa1e46cf0f07ffde2de131e9ed5bd66a488c289c"><code>fa1e46c</code></a> Update all Swift package test defaults to 6.4 (<a href="https://redirect.github.com/swiftlang/github-workflows/issues/319">#319</a>)</li> <li><a href="https://github.com/swiftlang/github-workflows/commit/81d865a4ea288ffefb0055d23ce4a748a845db20"><code>81d865a</code></a> sha-pin for dependencies-action (<a href="https://redirect.github.com/swiftlang/github-workflows/issues/317">#317</a>)</li> <li>See full diff in <a href="https://github.com/swiftlang/github-workflows/compare/0.0.15...0.0.16">compare view</a></li> </ul> </details> <br /> [](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) </details> Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> |
||
|
|
fcd893317d |
Update benchmark expectations (#527)
_[One line description of your change]_ ### Motivation: Update benchmark expectations, with the updated performance level ### Modifications: Update json file with the new instruction count ### Result: passing test |
||
|
|
65b3417512 |
Update threshold for GH runner (#525)
_[One line description of your change]_ ### Motivation: Update threshold This allows the faster GitHub runners to pass the benchmark tests. ### Modifications: Updated threshold to a lower value ### Result: Passing test |
||
|
|
666b45a252 |
Adjust benchmark expectations (#523)
### Motivation: Benchmarks CI has been failing recently on Swift 6.3 and 6.4, for example: https://github.com/apple/swift-log/actions/runs/38083241726. The results are actually better than expected in the thresholds. ### Modifications: - Swift 6.3 MaxLogLevelNone.critical_log_with_critical_log_level_metadata_set.p90.json threshold reduced - Swift 6.4 MaxLogLevelWarning.notice_log_with_notice_log_level_attributed_generic.p90.json threshold reduced ### Result: CI should not fail anymore. |
||
|
|
4038b6a4f7 |
Fix metadata provider handling when multiplexing log events (#522)
Ensure metadata from the multiplex handler’s own provider reaches emitted logs. Fixes #521. ## Motivation `MultiplexLogHandler` accepts a metadata provider in its initializer, but `log(event:)` never invokes it. Provider values such as trace IDs are therefore missing from downstream logs. ## Modifications - Merge the multiplex provider’s metadata into the event before forwarding it. - Preserve explicit per-message metadata overrides. - Add regression tests covering one and two downstream handlers and metadata precedence. ## Result The supplied provider’s metadata is included in emitted logs. Regression tests fail before the fix and pass afterward. All 174 tests pass on macOS with Swift 6.4. Formatting and `git diff --check` also pass.1.16.1 |
||
|
|
109c380c23 |
Fix explicit log level when replacing a task-local logger's handler (#520)
Fixes #519. ## Motivation When both `logLevel` and `handler` are provided, `withLogger` sets the level on the current handler before replacing it. Since `Logger.logLevel` forwards to the handler, the replacement discards the requested level and uses its own instead. ## Modifications - Install the replacement handler before applying the explicit log level in both sync and async overloads. - Add regression tests for `.debug` and `.warning` in both overloads, covering filtering and scope isolation. ## Result The scoped logger filters messages at the requested level. Regression tests fail before the fix and pass afterward. All 172 tests pass on macOS with Swift 6.4. Formatting and `git diff --check` also pass.1.16.0 |
||
|
|
c29472f010 |
Bump minimal Swift tools version to 6.2 (#518)
The support window is 3 latest minor Swift versions. CI i already running for Swift 6.2, 6.3 and 6.4 only. Updating the Swift tools and the package to match this. |
||
|
|
bca880e799 |
Bump swiftlang/github-workflows/.github/workflows/soundness.yml from 0.0.13 to 0.0.15 (#502)
Bumps [swiftlang/github-workflows/.github/workflows/soundness.yml](https://github.com/swiftlang/github-workflows) from 0.0.13 to 0.0.15. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/swiftlang/github-workflows/releases">swiftlang/github-workflows/.github/workflows/soundness.yml's releases</a>.</em></p> <blockquote> <h2>0.0.15</h2> <h2>What's Changed</h2> <ul> <li>Add install cmake action by <a href="https://github.com/etcwilde"><code>@etcwilde</code></a> in <a href="https://redirect.github.com/swiftlang/github-workflows/pull/310">swiftlang/github-workflows#310</a></li> <li>Increase PR url download retry by <a href="https://github.com/bkhouri"><code>@bkhouri</code></a> in <a href="https://redirect.github.com/swiftlang/github-workflows/pull/311">swiftlang/github-workflows#311</a></li> <li>Make Windows CI fail when command fails to launch by <a href="https://github.com/snprajwal"><code>@snprajwal</code></a> in <a href="https://redirect.github.com/swiftlang/github-workflows/pull/307">swiftlang/github-workflows#307</a></li> <li>Adding Reusable CMake build workflow by <a href="https://github.com/etcwilde"><code>@etcwilde</code></a> in <a href="https://redirect.github.com/swiftlang/github-workflows/pull/313">swiftlang/github-workflows#313</a></li> </ul> <h2>New Contributors</h2> <ul> <li><a href="https://github.com/etcwilde"><code>@etcwilde</code></a> made their first contribution in <a href="https://redirect.github.com/swiftlang/github-workflows/pull/310">swiftlang/github-workflows#310</a></li> </ul> <p><strong>Full Changelog</strong>: <a href="https://github.com/swiftlang/github-workflows/compare/0.0.14...0.0.15">https://github.com/swiftlang/github-workflows/compare/0.0.14...0.0.15</a></p> <h2>0.0.14</h2> <h2>What's Changed</h2> <ul> <li>Group dependabot updates for GHA workflows by <a href="https://github.com/snprajwal"><code>@snprajwal</code></a> in <a href="https://redirect.github.com/swiftlang/github-workflows/pull/302">swiftlang/github-workflows#302</a></li> <li>Run linux pre-build commands as part of the API breakage step by <a href="https://github.com/josephnoir"><code>@josephnoir</code></a> in <a href="https://redirect.github.com/swiftlang/github-workflows/pull/304">swiftlang/github-workflows#304</a></li> <li>swift_package_test: Switch to using Swift version-based symlinks by <a href="https://github.com/lorentey"><code>@lorentey</code></a> in <a href="https://redirect.github.com/swiftlang/github-workflows/pull/309">swiftlang/github-workflows#309</a></li> </ul> <h2>New Contributors</h2> <ul> <li><a href="https://github.com/josephnoir"><code>@josephnoir</code></a> made their first contribution in <a href="https://redirect.github.com/swiftlang/github-workflows/pull/304">swiftlang/github-workflows#304</a></li> <li><a href="https://github.com/lorentey"><code>@lorentey</code></a> made their first contribution in <a href="https://redirect.github.com/swiftlang/github-workflows/pull/309">swiftlang/github-workflows#309</a></li> </ul> <p><strong>Full Changelog</strong>: <a href="https://github.com/swiftlang/github-workflows/compare/0.0.13...0.0.14">https://github.com/swiftlang/github-workflows/compare/0.0.13...0.0.14</a></p> </blockquote> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/swiftlang/github-workflows/commit/9a10bfdc569159a3463f1273fbd7ed5f97fbe598"><code>9a10bfd</code></a> Adding Reusable CMake build workflow (<a href="https://redirect.github.com/swiftlang/github-workflows/issues/313">#313</a>)</li> <li><a href="https://github.com/swiftlang/github-workflows/commit/baf2598563ae0cadfebf37e353f13bf3db3702b1"><code>baf2598</code></a> Fix Windows CI passing when a command fails to launch (<a href="https://redirect.github.com/swiftlang/github-workflows/issues/307">#307</a>)</li> <li><a href="https://github.com/swiftlang/github-workflows/commit/455afa1d1d36cb7e8884553ea5d808117f8786af"><code>455afa1</code></a> Increase PR url download retry (<a href="https://redirect.github.com/swiftlang/github-workflows/issues/311">#311</a>)</li> <li><a href="https://github.com/swiftlang/github-workflows/commit/f8c5dc13ff142addb79fb622d4a6e2802b26cf38"><code>f8c5dc1</code></a> Add install cmake action (<a href="https://redirect.github.com/swiftlang/github-workflows/issues/310">#310</a>)</li> <li><a href="https://github.com/swiftlang/github-workflows/commit/152252f6e4b45fa96d48f1cbefaa351a7389fc2c"><code>152252f</code></a> swift_package_test: Switch to using Swift version-based symlinks (<a href="https://redirect.github.com/swiftlang/github-workflows/issues/309">#309</a>)</li> <li><a href="https://github.com/swiftlang/github-workflows/commit/497d9ab8410e69981b3b2f28da24cf7bf4b8733d"><code>497d9ab</code></a> Inline pre-build command into API breakage check step (<a href="https://redirect.github.com/swiftlang/github-workflows/issues/304">#304</a>)</li> <li><a href="https://github.com/swiftlang/github-workflows/commit/6af5655d925c8ff204383ff0a22e9baea895c4c5"><code>6af5655</code></a> Group dependabot updates for GHA workflows (<a href="https://redirect.github.com/swiftlang/github-workflows/issues/302">#302</a>)</li> <li>See full diff in <a href="https://github.com/swiftlang/github-workflows/compare/0.0.13...0.0.15">compare view</a></li> </ul> </details> <br /> [](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) </details> Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> |
||
|
|
c581740960 |
Add Swift 6.4 and disable 6.1 in CI configuration (#517)
Add Swift 6.4 and disable 6.1 in CI configuration. |
||
|
|
9c9acde6dc |
Fix nested metadata values handling (#516)
Only quote leaf metadata values. ### Motivation: There are several issues with how nested `MetadataValue`s are handled: 1. For highly nested (10k+) metadata, `.description` and `==` operator hit stack overflow. This is probably not very realistic depth, but still. 2. For not so highly nested metadata (starting at about 20) `.description` and `==` operator get very computationally intensive because of re-escaping of the already escaped children. This makes the above stack overflow crash not reachable in practice. 3. This also results in simple structured metadata to be rendered something like `["[\"[\\\"[\\\\\\\"[\\\\\\\\\\\\\\\"leaf\\\\\\\\\\\\\\\"]\\\\\\\"]\\\"]\"]"]`. 4. Finally, even after solving the re-quoting and stack over flow on rendering, there is still an issue of [recursion in `.deinit`](https://github.com/swiftlang/swift/issues/58080), resulting in a _different_ stack overflow crash. This PR provides a fix for 2 and 3, leaving 1 and 4 out because there is no practical way of fixing it in this package, while the case is borderline unrealistic. ### Modifications: - Only quote left `String` and `StringRepresentable` values in `Logger.MetadataValue.description`. - Add benchmarks for metadata values description rendering. ### Result: 100 nested metadata values render cleanly. Resolves #515 ### Alternatives This is discussable if this fix is really necessary. Iterative approach, because of allocations, is slower than recursion. - Is it worth fixing the recursion, or a metadata depth check is enough? - Is it worth fixing the nested metadata formatting? |
||
|
|
cf3e828428 |
Remove invalid exclude statements from testTarget (#514)
I removed the stale exclude statements from `Package.swift` and `Package@swift-6.1.swift` ### Motivation: In #485, CMake build support was added, as part of it, |
||
|
|
3be27be290 |
Update stale package names and broken ordo-one/benchmark documentation links (#511)
I updated the `CONTRIBUTING.md` documentation to fix the outdated name for the benchmarking plugin. The instructions now reference the `benchmark` plugin instead of the previously outdated `package-benchmark` plugin, and associated links and descriptions have been updated accordingly. Previously these were leading to `404 Not Found` errors. No code changes were made in this PR. Fixes: #510 --------- Co-authored-by: Vladimir Kukushkin <kukushechkin@mac.com> |
||
|
|
9c6fb14227 |
Fix referencing WASILibc.stdout/stderr in Swift 6.5+ (#507)
### Motivation: Nightly CI on nightly-main toolchains started failing on August 11, when we started downloading swift-DEVELOPMENT-SNAPSHOT-2026-08-08 instead of swift-DEVELOPMENT-SNAPSHOT-2026-07-11. Appears to be fallout from https://github.com/swiftlang/swift/commit/73fee3394d3102847fef26c1bdea49a67061f043 improving the optionality and concurrency of stdout/stderr/stdin on the various platforms. ### Modifications: Adapted Swift Log code to handle both the existing and behavior, guarded by a `compiler(>=6.5)` Also enabled nightly-next, which tracks the pre-release 6.4 right now, but hasn't received this change. ### Result: Passing CI, hopefully :)1.15.1 |
||
|
|
53d00853e6 |
Route the SwiftLog 1.0 default log method to log(event:) (#503)
### Motivation: The two deprecated `LogHandler` defaults forward to each other: the source-carrying `log(level:message:metadata:source:file:function:line:)` default calls `log(event:)`, whose default calls the source-carrying method, and the SwiftLog 1.0 `log(level:message:metadata:file:function:line:)` default calls the source-carrying method. A handler that implements only `log(event:)`, as the protocol documentation asks, therefore recurses until the stack overflows whenever anything calls the 1.0 method on it. Handlers written against SwiftLog 1.0 that wrap another handler and forward through the 1.0 method reach this path. Differs from #248, where the handler implemented no log method at all. ### Modifications: The 1.0 default builds a `LogEvent` and calls `log(event:)` directly. The source is still the module derived from `file`, as before. Two tests in `CompatibilityTest`: the 1.0 method reaching an event-only handler (SIGSEGV at `main` before the change) and reaching a source-only handler. ### Result: A `LogHandler` implementing only `log(event:)` can be called through every deprecated entry point. No source-breaking change; both deprecated defaults remain. Verified on Linux with Swift 6.1.2: `swift test -Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable` (166 tests) and `swift-format lint --strict` on the changed files. Found by an automated audit loop (Claude); patch and description reviewed by me. --------- Co-authored-by: Vladimir Kukushkin <kukushechkin@apple.com> |
||
|
|
c5ece24786 |
Document that setting attributes on a collection value is a programmer error (#504)
### Motivation: `Logger.MetadataValue.attributes` documents the setter as a no-op for `.dictionary` and `.array`, but it calls `assertionFailure` there. Debug builds trap, release builds do the documented no-op. ### Modifications: Doc comment only. The assertion stays; the comment now says setting attributes on a collection value is a programmer error, that debug builds assert and release builds leave the value unchanged, and to set attributes on the leaf values instead. ### Result: The documentation matches the code. No behaviour change. Found by an automated audit loop (Claude); patch and description reviewed by me. |
||
|
|
172948a4b5 |
Disable simulator testing due to instability (#505)
### Motivation: Unblock nightly CI runs on main by disabling non-macOS Apple platform simulator testing due to instability. ### Modifications: Disabled that CI for now. We'll re-enable when we can make it pass reliably. ### Result: Bring nightly CI back to green. |
||
|
|
47a917767f |
Add CMake build instructions to README (#493)
Add CMake build instructions for macOS, Windows and Linux including requirements and installation steps. ### Motivation: Document how to build SwiftLog with CMake for projects that use mixed build systems and need integration outside of Swift Package Manager. ### Modifications: - Added a new “Building with CMake” section to `README.md` - Documented minimum requirements: - Swift 6.1+ - CMake 3.19+ - Ninja 1.10+ - Added macOS build examples for both Xcode and Ninja generators - Added Windows build instructions using Ninja - Added install instructions and notes about shared vs. static builds - Clarified that tests are not included in the CMake build and are still managed through Swift Package Manager ### Result: Users now have platform-specific guidance for building SwiftLog with CMake on macOS, Windows and Linux. Fixes #492 |
||
|
|
f054da4c19 |
Update benchmark thresholds values to match the CI (#497)
### Motivation: Swift 6.3 benchmarks have been failing for a while now ### Modifications: - Update 2 benchmark thresholds to match values for Swift 6.3. - Update thresholds files formatting to reduce noise in the output diff. ### Result: Benchmarks should not fail sporadically. |
||
|
|
3ffafb9722 |
Make ReadWriteLock.init internal (#496)
### Motivation: `public` init has no effect for an `internal` class. ### Modifications: Removed `public` from the `ReadWriteLock.init`. ### Result: `ReadWriteLock.init` is now `internal`, matching class visibility.1.15.0 |
||
|
|
7af2de138f |
Document how to construct log handlers that need more than a label (#490)
Document best practice for creating complex `LogHandlers`. ### Motivation: `LogHandler`s often need an expensive resource to write or export log events. This pattern should be documented. ### Modifications: Add "Constructing handlers that need more than a label" section to `ImplementingALogHandler.md` guide. ### Result: Closes #80. --------- Co-authored-by: Joseph Heck <j_heck@apple.com> |
||
|
|
e83726cb15 |
Add CMake support for Swift targets and test configurations (#485)
Add CMake build support to the project to enable toolchain integration and bootstrapping compatibility. ### Motivation: Currently, swift-log does not support building with CMake. This addition resolves issue #484, allowing swift-log to be resolved and compiled within CMake-based environments (like the repos swift-certificates and swift-argument-parser which aer mentioned in the issue). ### Modifications: 1. **Project Root Config:** Added [CMakeLists.txt](file:///Users/adityamitra/Developer/swift-log/CMakeLists.txt) configuring the CMake project with Swift 6 and C, alongside setting up compiler flags for MSVC runtime library on Windows. 2. **Helper Modules:** Added the `cmake/` folder: - `SwiftSupport.cmake`: dylib/module installations and triple detection helper. - `SwiftLogConfig.cmake.in`: package config export templates. 3. **Target CMake Configurations:** Created [Sources/Logging/CMakeLists.txt](file:///Users/adityamitra/Developer/swift-log/Sources/Logging/CMakeLists.txt) & [Sources/InMemoryLogging/CMakeLists.txt](file:///Users/adityamitra/Developer/swift-log/Sources/InMemoryLogging/CMakeLists.txt) to define the library targets. Included generator expressions pointing `INTERFACE_INCLUDE_DIRECTORIES` to target output directories for Xcode generator support. 4. **SwiftPM Exclusions:** Excluded the new CMake files from target targets inside [Package.swift](file:///Users/adityamitra/Developer/swift-log/Package.swift) and [Package@swift-6.1.swift](file:///Users/adityamitra/Developer/swift-log/Package@swift-6.1.swift) to keep SwiftPM targets warning-free. 5. **Compile Options Variable:** Consolidates compile options under a single global definition `SWIFT_LOG_COMMON_COMPILE_OPTIONS` in the root configuration, enabling Swift 6 compiler features (`ExistentialAny`, `MemberImportVisibility`, `InternalImportsByDefault`, `NonisolatedNonsendingByDefault`, and explicit Sendable checks) across all targets. 6. **CI Integration & Workflow:** Integrated CMake CI validation in `.github/workflows/pull_request.yml` using the shared workflow from `apple/swift-nio/.github/workflows/cmake_tests.yml@main` running in a `swift:6.1-jammy` container. This job compiles the core libraries and verifies the validity of the CMake files. 7. **License Header Compliance:** Cleaned up license headers across all CMake files ### Result: * **SwiftPM:** All 164 unit tests compile and pass successfully under `swift test` with no warnings. * **CMake:** Successfully compiles (`** BUILD SUCCEEDED **`) under Xcode generator (`cmake -B build -G Xcode && cmake --build build`). ### Issue Tracking: Fixes #484 --------- Co-authored-by: Vladimir Kukushkin <kukushechkin@apple.com> |
||
|
|
8056dbfb08 | Bump swiftlang/github-workflows/.github/workflows/soundness.yml from 0.0.12 to 0.0.13 (#486) | ||
|
|
1032aed8a5 |
Bump swiftlang/github-workflows/.github/workflows/soundness.yml from 0.0.11 to 0.0.12 (#480)
Bumps [swiftlang/github-workflows/.github/workflows/soundness.yml](https://github.com/swiftlang/github-workflows) from 0.0.11 to 0.0.12. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/swiftlang/github-workflows/releases">swiftlang/github-workflows/.github/workflows/soundness.yml's releases</a>.</em></p> <blockquote> <h2>0.0.12</h2> <h2>What's Changed</h2> <ul> <li>Bump gregsdennis/dependencies-action from 1.4.1 to 1.4.2 by <a href="https://github.com/dependabot"><code>@dependabot</code></a>[bot] in <a href="https://redirect.github.com/swiftlang/github-workflows/pull/266">swiftlang/github-workflows#266</a></li> <li>extract PR Dependency Check for github-workflows into its own file by <a href="https://github.com/justice-adams-apple"><code>@justice-adams-apple</code></a> in <a href="https://redirect.github.com/swiftlang/github-workflows/pull/270">swiftlang/github-workflows#270</a></li> <li>Remove workaround for bug triggered by Android environment variable by <a href="https://github.com/finagolfin"><code>@finagolfin</code></a> in <a href="https://redirect.github.com/swiftlang/github-workflows/pull/246">swiftlang/github-workflows#246</a></li> <li>Change default Android SDK build command by <a href="https://github.com/jakepetroules"><code>@jakepetroules</code></a> in <a href="https://redirect.github.com/swiftlang/github-workflows/pull/269">swiftlang/github-workflows#269</a></li> <li>[static sdk] build with sdk triple by <a href="https://github.com/justice-adams-apple"><code>@justice-adams-apple</code></a> in <a href="https://redirect.github.com/swiftlang/github-workflows/pull/274">swiftlang/github-workflows#274</a></li> <li>[freebsd] cd into the proper dir to run package test by <a href="https://github.com/justice-adams-apple"><code>@justice-adams-apple</code></a> in <a href="https://redirect.github.com/swiftlang/github-workflows/pull/275">swiftlang/github-workflows#275</a></li> <li>Update Wasm build command in workflow by <a href="https://github.com/jakepetroules"><code>@jakepetroules</code></a> in <a href="https://redirect.github.com/swiftlang/github-workflows/pull/272">swiftlang/github-workflows#272</a></li> <li>Android: Add support for .bundle files in emulator tests by <a href="https://github.com/jakepetroules"><code>@jakepetroules</code></a> in <a href="https://redirect.github.com/swiftlang/github-workflows/pull/276">swiftlang/github-workflows#276</a></li> <li>Update Swift nightly to 6.4.x in workflow file by <a href="https://github.com/shahmishal"><code>@shahmishal</code></a> in <a href="https://redirect.github.com/swiftlang/github-workflows/pull/278">swiftlang/github-workflows#278</a></li> <li>Parametrize swift format binary by <a href="https://github.com/rnro"><code>@rnro</code></a> in <a href="https://redirect.github.com/swiftlang/github-workflows/pull/285">swiftlang/github-workflows#285</a></li> <li>Extend ignore list in flake8 config by <a href="https://github.com/snprajwal"><code>@snprajwal</code></a> in <a href="https://redirect.github.com/swiftlang/github-workflows/pull/279">swiftlang/github-workflows#279</a></li> <li>Fix Android build for non-default NDKs with new swift-build build system, by updating ANDROID_NDK_ROOT too by <a href="https://github.com/finagolfin"><code>@finagolfin</code></a> in <a href="https://redirect.github.com/swiftlang/github-workflows/pull/280">swiftlang/github-workflows#280</a></li> <li>docs: add missing closing backtick in error message by <a href="https://github.com/Avicennasis"><code>@Avicennasis</code></a> in <a href="https://redirect.github.com/swiftlang/github-workflows/pull/286">swiftlang/github-workflows#286</a></li> <li>Add retry when retrieving PR information by <a href="https://github.com/bkhouri"><code>@bkhouri</code></a> in <a href="https://redirect.github.com/swiftlang/github-workflows/pull/284">swiftlang/github-workflows#284</a></li> <li>Docs: provide option to skip analysis in doc-check by <a href="https://github.com/bkhouri"><code>@bkhouri</code></a> in <a href="https://redirect.github.com/swiftlang/github-workflows/pull/282">swiftlang/github-workflows#282</a></li> <li>Add proposal validation workflow and documentation by <a href="https://github.com/dempseyatgithub"><code>@dempseyatgithub</code></a> in <a href="https://redirect.github.com/swiftlang/github-workflows/pull/288">swiftlang/github-workflows#288</a></li> <li>Update dock check syntax issue by <a href="https://github.com/bkhouri"><code>@bkhouri</code></a> in <a href="https://redirect.github.com/swiftlang/github-workflows/pull/290">swiftlang/github-workflows#290</a></li> <li>Update actions/checkout to v7 by <a href="https://github.com/shahmishal"><code>@shahmishal</code></a> in <a href="https://redirect.github.com/swiftlang/github-workflows/pull/294">swiftlang/github-workflows#294</a></li> <li>Update default Xcode versions in workflow to Xcode 27 Beta 2 by <a href="https://github.com/shahmishal"><code>@shahmishal</code></a> in <a href="https://redirect.github.com/swiftlang/github-workflows/pull/293">swiftlang/github-workflows#293</a></li> <li>Add GITHUB_TOKEN env variable for use by extraction tool by <a href="https://github.com/dempseyatgithub"><code>@dempseyatgithub</code></a> in <a href="https://redirect.github.com/swiftlang/github-workflows/pull/295">swiftlang/github-workflows#295</a></li> </ul> <h2>New Contributors</h2> <ul> <li><a href="https://github.com/dependabot"><code>@dependabot</code></a>[bot] made their first contribution in <a href="https://redirect.github.com/swiftlang/github-workflows/pull/266">swiftlang/github-workflows#266</a></li> <li><a href="https://github.com/snprajwal"><code>@snprajwal</code></a> made their first contribution in <a href="https://redirect.github.com/swiftlang/github-workflows/pull/279">swiftlang/github-workflows#279</a></li> <li><a href="https://github.com/Avicennasis"><code>@Avicennasis</code></a> made their first contribution in <a href="https://redirect.github.com/swiftlang/github-workflows/pull/286">swiftlang/github-workflows#286</a></li> <li><a href="https://github.com/dempseyatgithub"><code>@dempseyatgithub</code></a> made their first contribution in <a href="https://redirect.github.com/swiftlang/github-workflows/pull/288">swiftlang/github-workflows#288</a></li> </ul> <p><strong>Full Changelog</strong>: <a href="https://github.com/swiftlang/github-workflows/compare/0.0.11...0.0.12">https://github.com/swiftlang/github-workflows/compare/0.0.11...0.0.12</a></p> </blockquote> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/swiftlang/github-workflows/commit/07936268efedce0a6650c75a00150b820f53f384"><code>0793626</code></a> Add GITHUB_TOKEN env variable for use by extraction tool (<a href="https://redirect.github.com/swiftlang/github-workflows/issues/295">#295</a>)</li> <li><a href="https://github.com/swiftlang/github-workflows/commit/1ec62c90c3b8a07150ec8233eb4cb170aeee7eab"><code>1ec62c9</code></a> Update default Xcode versions in workflow to Xcode 27 Beta 2 (<a href="https://redirect.github.com/swiftlang/github-workflows/issues/293">#293</a>)</li> <li><a href="https://github.com/swiftlang/github-workflows/commit/fda56f671cbba58575549aedd1f07ff75a28949b"><code>fda56f6</code></a> Update actions/checkout to v7 (<a href="https://redirect.github.com/swiftlang/github-workflows/issues/294">#294</a>)</li> <li><a href="https://github.com/swiftlang/github-workflows/commit/60789377b41faf8c0f0aa6e42948b5fa3131a4d9"><code>6078937</code></a> Update dock check syntax issue (<a href="https://redirect.github.com/swiftlang/github-workflows/issues/290">#290</a>)</li> <li><a href="https://github.com/swiftlang/github-workflows/commit/d65527ae024104f80c3c9a204e2255ff6e6dbf24"><code>d65527a</code></a> Add proposal validation workflow and documentation (<a href="https://redirect.github.com/swiftlang/github-workflows/issues/288">#288</a>)</li> <li><a href="https://github.com/swiftlang/github-workflows/commit/b080ab5eaa2d71849e212ec6ffed6e2757791c3d"><code>b080ab5</code></a> Docs: provide option to skip analysis in doc-check (<a href="https://redirect.github.com/swiftlang/github-workflows/issues/282">#282</a>)</li> <li><a href="https://github.com/swiftlang/github-workflows/commit/9abcbf258bca0c8d2157b1bdad4193381f97a866"><code>9abcbf2</code></a> Add retry when retrieving PR information (<a href="https://redirect.github.com/swiftlang/github-workflows/issues/284">#284</a>)</li> <li><a href="https://github.com/swiftlang/github-workflows/commit/8a9e053779acdc244e72dc947fa17c620f671235"><code>8a9e053</code></a> docs: add missing closing backtick in error message (<a href="https://redirect.github.com/swiftlang/github-workflows/issues/286">#286</a>)</li> <li><a href="https://github.com/swiftlang/github-workflows/commit/0a4e35d4b3892988d1b6a24c1fb4281800e5a6d4"><code>0a4e35d</code></a> Fix Android build for non-default NDKs with new swift-build build system, by ...</li> <li><a href="https://github.com/swiftlang/github-workflows/commit/cad6f2b75ecfb5813ed8210678c12d307090d930"><code>cad6f2b</code></a> Extend ignore list in flake8 config (<a href="https://redirect.github.com/swiftlang/github-workflows/issues/279">#279</a>)</li> <li>Additional commits viewable in <a href="https://github.com/swiftlang/github-workflows/compare/0.0.11...0.0.12">compare view</a></li> </ul> </details> <br /> [](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) </details> Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> |
||
|
|
1895d78a91 |
Make StreamLogHandler initializers public (#477)
Make `StreamLogHandler` initializers public. ### Motivation: Closes https://github.com/apple/swift-log/issues/273 ### Modifications: Promote the two stream-accepting initializers from `internal` to `public`. Also as a result, their stream parameter is spelled out as `any TextOutputStream & Sendable` rather than the internal `_SendableTextOutputStream` typealias, which cannot appear in a public signature. ~The private stored property and the internal typealias are otherwise unchanged.~ The internal typealias has been completely removed as it was only used to store the stream, and the private stored property is updated to use the spelled-out type. Also updates the docc documentation accordingly. ### Result: Users would be able to construct a `StreamLogHandler` with their own `TextOutputStream` implementation, reusing the existing logic to format log messages and prettify metadata instead of reimplementing them. --------- Signed-off-by: subhramit <subhramit.bb@live.in> Co-authored-by: Vladimir Kukushkin <kukushechkin@apple.com> |
||
|
|
8a6b9eab84 |
Add testing logs best practice (#475)
Add a Best Practice guide on how to test logging. ### Motivation: There are 2 recommended ways of propagating logs in components, both are testable. But there is no any kind of documentation on how to do it. ### Modifications: Add a "Testing code that logs" Best Practice guide. ### Result: Logs testing is now documented. --------- Co-authored-by: Joseph Heck <j_heck@apple.com> |
||
|
|
c4e96785bf |
Add missing api refs (#478)
Expands on @kukushechkin #474 (add-missing API) and tacks in some additional work ### Motivation: resolve the DocC warnings ### Modifications: - resolves docc warnings for soundness checks - updates curation to drop the task-local logger updates into the correct areas - updates curation to collect the implemented proposals together ### Result: Hopefully no issues with soundness checks --------- Co-authored-by: Vladimir Kukushkin <kukushechkin@apple.com> |
||
|
|
54ec9e35cd |
Update implemented proposals status (#476)
Match proposals status in the docs and the implementation reality. |
||
|
|
e3b5d65fc9 |
Enable Xcode tests (#473)
Simulators seem to have stabilized in CI, we can enabled the tests. ### Motivation: `swift-log` is expected to be used on various platforms, we should run tests against them. ### Modifications: - Run tests on various tests in simulators in PRs and nightly. - Fix tests to actually compile there. ### Result: Tests are now running in simulators. Supersedes #431. |
||
|
|
a878e7f8f4 |
[SLG-0006]: task-local logger implementation (#459)
This proposal adds task-local logger storage so that metadata can accumulate across async call stacks without threading a `Logger` through every function signature. ### Motivation: Metadata propagation requires threading a logger through every layer. Every function on the path from request ingress to the bottom of the call stack has to accept, mutate, and forward a `Logger`. Libraries must choose between polluting their public API with a `logger:` parameter and losing all the caller's context. There is no third option today. ### Modifications: - New API surface for reading and modifying the `@TaskLocal` `Logger` instance added. - Best practices on how to correctly propagate logger into libraries updated with `Logger.current` API. ### Result: Users can now automatically propagate accumulated metadata into libraries without explicitly passing loggers through the API boundaries. --------- Co-authored-by: Franz Busch <privat@franz-busch.de>1.14.0 |
||
|
|
2c52ee25d2 |
Bump actions/checkout from 6 to 7 (#472)
Bumps [actions/checkout](https://github.com/actions/checkout) from 6 to 7. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/actions/checkout/releases">actions/checkout's releases</a>.</em></p> <blockquote> <h2>v7.0.0</h2> <h2>What's Changed</h2> <ul> <li>block checking out fork pr for pull_request_target and workflow_run by <a href="https://github.com/aiqiaoy"><code>@aiqiaoy</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/2454">actions/checkout#2454</a></li> <li>Bump actions/publish-immutable-action from 0.0.3 to 0.0.4 in the minor-actions-dependencies group across 1 directory by <a href="https://github.com/dependabot"><code>@dependabot</code></a>[bot] in <a href="https://redirect.github.com/actions/checkout/pull/2458">actions/checkout#2458</a></li> <li>Bump flatted from 3.3.1 to 3.4.2 by <a href="https://github.com/dependabot"><code>@dependabot</code></a>[bot] in <a href="https://redirect.github.com/actions/checkout/pull/2460">actions/checkout#2460</a></li> <li>Bump js-yaml from 4.1.0 to 4.2.0 by <a href="https://github.com/dependabot"><code>@dependabot</code></a>[bot] in <a href="https://redirect.github.com/actions/checkout/pull/2461">actions/checkout#2461</a></li> <li>Bump <code>@actions/core</code> and <code>@actions/tool-cache</code> and Remove uuid by <a href="https://github.com/dependabot"><code>@dependabot</code></a>[bot] in <a href="https://redirect.github.com/actions/checkout/pull/2459">actions/checkout#2459</a></li> <li>upgrade module to esm and update dependencies by <a href="https://github.com/aiqiaoy"><code>@aiqiaoy</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/2463">actions/checkout#2463</a></li> <li>Bump the minor-npm-dependencies group across 1 directory with 3 updates by <a href="https://github.com/dependabot"><code>@dependabot</code></a>[bot] in <a href="https://redirect.github.com/actions/checkout/pull/2462">actions/checkout#2462</a></li> <li>getting ready for checkout v7 release by <a href="https://github.com/aiqiaoy"><code>@aiqiaoy</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/2464">actions/checkout#2464</a></li> <li>update error wording by <a href="https://github.com/aiqiaoy"><code>@aiqiaoy</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/2467">actions/checkout#2467</a></li> </ul> <h2>New Contributors</h2> <ul> <li><a href="https://github.com/aiqiaoy"><code>@aiqiaoy</code></a> made their first contribution in <a href="https://redirect.github.com/actions/checkout/pull/2454">actions/checkout#2454</a></li> </ul> <p><strong>Full Changelog</strong>: <a href="https://github.com/actions/checkout/compare/v6.0.3...v7.0.0">https://github.com/actions/checkout/compare/v6.0.3...v7.0.0</a></p> <h2>v6.0.3</h2> <h2>What's Changed</h2> <ul> <li>Update changelog by <a href="https://github.com/ericsciple"><code>@ericsciple</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/2357">actions/checkout#2357</a></li> <li>fix: expand merge commit SHA regex and add SHA-256 test cases by <a href="https://github.com/yaananth"><code>@yaananth</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/2414">actions/checkout#2414</a></li> <li>Fix checkout init for SHA-256 repositories by <a href="https://github.com/yaananth"><code>@yaananth</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/2439">actions/checkout#2439</a></li> <li>Update changelog for v6.0.3 by <a href="https://github.com/yaananth"><code>@yaananth</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/2446">actions/checkout#2446</a></li> </ul> <h2>New Contributors</h2> <ul> <li><a href="https://github.com/yaananth"><code>@yaananth</code></a> made their first contribution in <a href="https://redirect.github.com/actions/checkout/pull/2414">actions/checkout#2414</a></li> </ul> <p><strong>Full Changelog</strong>: <a href="https://github.com/actions/checkout/compare/v6...v6.0.3">https://github.com/actions/checkout/compare/v6...v6.0.3</a></p> <h2>v6.0.2</h2> <h2>What's Changed</h2> <ul> <li>Add orchestration_id to git user-agent when ACTIONS_ORCHESTRATION_ID is set by <a href="https://github.com/TingluoHuang"><code>@TingluoHuang</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/2355">actions/checkout#2355</a></li> <li>Fix tag handling: preserve annotations and explicit fetch-tags by <a href="https://github.com/ericsciple"><code>@ericsciple</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/2356">actions/checkout#2356</a></li> </ul> <p><strong>Full Changelog</strong>: <a href="https://github.com/actions/checkout/compare/v6.0.1...v6.0.2">https://github.com/actions/checkout/compare/v6.0.1...v6.0.2</a></p> <h2>v6.0.1</h2> <h2>What's Changed</h2> <ul> <li>Update all references from v5 and v4 to v6 by <a href="https://github.com/ericsciple"><code>@ericsciple</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/2314">actions/checkout#2314</a></li> <li>Add worktree support for persist-credentials includeIf by <a href="https://github.com/ericsciple"><code>@ericsciple</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/2327">actions/checkout#2327</a></li> <li>Clarify v6 README by <a href="https://github.com/ericsciple"><code>@ericsciple</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/2328">actions/checkout#2328</a></li> </ul> <p><strong>Full Changelog</strong>: <a href="https://github.com/actions/checkout/compare/v6...v6.0.1">https://github.com/actions/checkout/compare/v6...v6.0.1</a></p> </blockquote> </details> <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/actions/checkout/blob/main/CHANGELOG.md">actions/checkout's changelog</a>.</em></p> <blockquote> <h1>Changelog</h1> <h2>v7.0.0</h2> <ul> <li>Block checking out fork PR for pull_request_target and workflow_run by <a href="https://github.com/aiqiaoy"><code>@aiqiaoy</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/2454">actions/checkout#2454</a></li> <li>Bump actions/publish-immutable-action from 0.0.3 to 0.0.4 in the minor-actions-dependencies group across 1 directory by <a href="https://github.com/dependabot"><code>@dependabot</code></a>[bot] in <a href="https://redirect.github.com/actions/checkout/pull/2458">actions/checkout#2458</a></li> <li>Bump flatted from 3.3.1 to 3.4.2 by <a href="https://github.com/dependabot"><code>@dependabot</code></a>[bot] in <a href="https://redirect.github.com/actions/checkout/pull/2460">actions/checkout#2460</a></li> <li>Bump js-yaml from 4.1.0 to 4.2.0 by <a href="https://github.com/dependabot"><code>@dependabot</code></a>[bot] in <a href="https://redirect.github.com/actions/checkout/pull/2461">actions/checkout#2461</a></li> <li>Bump <code>@actions/core</code> and <code>@actions/tool-cache</code> and Remove uuid by <a href="https://github.com/dependabot"><code>@dependabot</code></a>[bot] in <a href="https://redirect.github.com/actions/checkout/pull/2459">actions/checkout#2459</a></li> <li>upgrade module to esm and update dependencies by <a href="https://github.com/aiqiaoy"><code>@aiqiaoy</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/2463">actions/checkout#2463</a></li> <li>Bump the minor-npm-dependencies group across 1 directory with 3 updates by <a href="https://github.com/dependabot"><code>@dependabot</code></a>[bot] in <a href="https://redirect.github.com/actions/checkout/pull/2462">actions/checkout#2462</a></li> </ul> <h2>v6.0.3</h2> <ul> <li>Fix checkout init for SHA-256 repositories by <a href="https://github.com/yaananth"><code>@yaananth</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/2439">actions/checkout#2439</a></li> <li>fix: expand merge commit SHA regex and add SHA-256 test cases by <a href="https://github.com/yaananth"><code>@yaananth</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/2414">actions/checkout#2414</a></li> </ul> <h2>v6.0.2</h2> <ul> <li>Fix tag handling: preserve annotations and explicit fetch-tags by <a href="https://github.com/ericsciple"><code>@ericsciple</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/2356">actions/checkout#2356</a></li> </ul> <h2>v6.0.1</h2> <ul> <li>Add worktree support for persist-credentials includeIf by <a href="https://github.com/ericsciple"><code>@ericsciple</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/2327">actions/checkout#2327</a></li> </ul> <h2>v6.0.0</h2> <ul> <li>Persist creds to a separate file by <a href="https://github.com/ericsciple"><code>@ericsciple</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/2286">actions/checkout#2286</a></li> <li>Update README to include Node.js 24 support details and requirements by <a href="https://github.com/salmanmkc"><code>@salmanmkc</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/2248">actions/checkout#2248</a></li> </ul> <h2>v5.0.1</h2> <ul> <li>Port v6 cleanup to v5 by <a href="https://github.com/ericsciple"><code>@ericsciple</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/2301">actions/checkout#2301</a></li> </ul> <h2>v5.0.0</h2> <ul> <li>Update actions checkout to use node 24 by <a href="https://github.com/salmanmkc"><code>@salmanmkc</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/2226">actions/checkout#2226</a></li> </ul> <h2>v4.3.1</h2> <ul> <li>Port v6 cleanup to v4 by <a href="https://github.com/ericsciple"><code>@ericsciple</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/2305">actions/checkout#2305</a></li> </ul> <h2>v4.3.0</h2> <ul> <li>docs: update README.md by <a href="https://github.com/motss"><code>@motss</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/1971">actions/checkout#1971</a></li> <li>Add internal repos for checking out multiple repositories by <a href="https://github.com/mouismail"><code>@mouismail</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/1977">actions/checkout#1977</a></li> <li>Documentation update - add recommended permissions to Readme by <a href="https://github.com/benwells"><code>@benwells</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/2043">actions/checkout#2043</a></li> <li>Adjust positioning of user email note and permissions heading by <a href="https://github.com/joshmgross"><code>@joshmgross</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/2044">actions/checkout#2044</a></li> <li>Update README.md by <a href="https://github.com/nebuk89"><code>@nebuk89</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/2194">actions/checkout#2194</a></li> <li>Update CODEOWNERS for actions by <a href="https://github.com/TingluoHuang"><code>@TingluoHuang</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/2224">actions/checkout#2224</a></li> <li>Update package dependencies by <a href="https://github.com/salmanmkc"><code>@salmanmkc</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/2236">actions/checkout#2236</a></li> </ul> <h2>v4.2.2</h2> <ul> <li><code>url-helper.ts</code> now leverages well-known environment variables by <a href="https://github.com/jww3"><code>@jww3</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/1941">actions/checkout#1941</a></li> <li>Expand unit test coverage for <code>isGhes</code> by <a href="https://github.com/jww3"><code>@jww3</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/1946">actions/checkout#1946</a></li> </ul> <h2>v4.2.1</h2> <ul> <li>Check out other refs/* by commit if provided, fall back to ref by <a href="https://github.com/orhantoy"><code>@orhantoy</code></a> in <a href="https://redirect.github.com/actions/checkout/pull/1924">actions/checkout#1924</a></li> </ul> <!-- raw HTML omitted --> </blockquote> <p>... (truncated)</p> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/actions/checkout/commit/9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0"><code>9c091bb</code></a> update error wording (<a href="https://redirect.github.com/actions/checkout/issues/2467">#2467</a>)</li> <li><a href="https://github.com/actions/checkout/commit/1044a6dea927916f2c38ba5aeffbc0a847b1221a"><code>1044a6d</code></a> getting ready for checkout v7 release (<a href="https://redirect.github.com/actions/checkout/issues/2464">#2464</a>)</li> <li><a href="https://github.com/actions/checkout/commit/f0282184c7ce73ab54c7e4ab5a617122602e575f"><code>f028218</code></a> Bump the minor-npm-dependencies group across 1 directory with 3 updates (<a href="https://redirect.github.com/actions/checkout/issues/2462">#2462</a>)</li> <li><a href="https://github.com/actions/checkout/commit/d914b262ffc244530a203ab40decab34c3abf34d"><code>d914b26</code></a> upgrade module to esm and update dependencies (<a href="https://redirect.github.com/actions/checkout/issues/2463">#2463</a>)</li> <li><a href="https://github.com/actions/checkout/commit/537c7ef99cef6e5ddb5e7ff5d16d14510503801d"><code>537c7ef</code></a> Bump <code>@actions/core</code> and <code>@actions/tool-cache</code> and Remove uuid (<a href="https://redirect.github.com/actions/checkout/issues/2459">#2459</a>)</li> <li><a href="https://github.com/actions/checkout/commit/130a169078a413d3a5246a393625e8e742f387f6"><code>130a169</code></a> Bump js-yaml from 4.1.0 to 4.2.0 (<a href="https://redirect.github.com/actions/checkout/issues/2461">#2461</a>)</li> <li><a href="https://github.com/actions/checkout/commit/7d09575332117a40b46e5e020664df234cd416f3"><code>7d09575</code></a> Bump flatted from 3.3.1 to 3.4.2 (<a href="https://redirect.github.com/actions/checkout/issues/2460">#2460</a>)</li> <li><a href="https://github.com/actions/checkout/commit/0f9f3aa320cb53abeb534aeb54048075d9697a0e"><code>0f9f3aa</code></a> Bump actions/publish-immutable-action (<a href="https://redirect.github.com/actions/checkout/issues/2458">#2458</a>)</li> <li><a href="https://github.com/actions/checkout/commit/f9e715a95fcd1f9253f77dd28f11e88d2d6460c7"><code>f9e715a</code></a> block checking out fork pr for pull_request_target and workflow_run (<a href="https://redirect.github.com/actions/checkout/issues/2454">#2454</a>)</li> <li>See full diff in <a href="https://github.com/actions/checkout/compare/v6...v7">compare view</a></li> </ul> </details> <br /> [](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) </details> Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> |
||
|
|
ca61184698 |
[SLG-0006]: task-local logger proposal (#460)
This proposal adds task-local logger storage so that metadata can accumulate across async call stacks without threading a `Logger` through every function signature. ### Motivation: Metadata propagation requires threading a logger through every layer. Every function on the path from request ingress to the bottom of the call stack has to accept, mutate, and forward a `Logger`. Libraries must choose between polluting their public API with a `logger:` parameter and losing all the caller's context. There is no third option today. ### Modifications: SLG-0006 proposal is added. ### Result: Proposal is ready for review. |
||
|
|
92448c359f |
Add (default:) string interpolation overloads (#471)
Add [Default String Interpolation](https://github.com/swiftlang/swift-evolution/blob/main/proposals/0477-default-interpolation-values.md) overloads for `MetadataValue` to restore compatibility with `\(default:)` interpolation. ### Motivation: 1.13.0 introduced a breaking change to the default string interpolation compatibility. We do not want to revert the custom string interpolation, but can fix compatibility with the default string interpolation as much as possible. ### Modifications: Add `\(default:)` overloads to `MetadataValue.StringInterpolation`, similar to the once in `DefaultStringInterpolation`. ### Result: Compatibility with `logger.info("Log message", metadata: ["value": "\(value, default: "none")"])` is restored.1.13.2 |
||
|
|
2aed77ae5e |
Match DefaultStringInterpolation appendInterpolation overloads (#469)
Custom `MetadataValue.StringInterpolation` broke compatibility with `DefaultStringInterpolation`. Rearrange `appendInterpolation` overloads to match `DefaultStringInterpolation` to maintain backward compatibility. ### Motivation: Custom `MetadataValue.StringInterpolation` broke compatibility with `DefaultStringInterpolation`. Rearrange `appendInterpolation` overloads to match `DefaultStringInterpolation` to maintain backward compatibility. ### Modifications: `MetadataValue.StringInterpolation` `appendInterpolation` overloads changed. ### Result: Code relying on matching correct `DefaultStringInterpolation` `appendInterpolation` overload compiles.1.13.1 |
||
|
|
7dc6101ae4 |
[SLG-0004]: metadata value attributes implementation (#453)
Proposal discussion thread: https://forums.swift.org/t/proposal-slg-0004-metadata-value-attributes-revision-2/86488 Add an extensible per-value attribute mechanism for metadata. ### Motivation: Metadata values in `swift-log` are opaque strings by the time the `LogHandler` receives them. The call site often knows things about a value that the handler cannot infer — for example, whether the value should be redacted in different environments. ### Modifications: - SLG-0004 proposal is updated based on the feedback. - Added `AttributedStringCarrier: CustomStringConvertible`-based mechanism to `Logging`. - Added benchmarks and benchmark thresholds for the new attributed metadata. ### Result: `swift-log` provides an optional extensible mechanism for attaching attributes to metadata values. --------- Co-authored-by: Franz Busch <privat@franz-busch.de>1.13.0 |
||
|
|
a012e0ad8a |
Adopt multi-package macOS benchmarks workflow (#466)
### Motivation * The two-invocation pattern for `macos-benchmarks` and `macos-benchmarks-MaxLogLevelWarningBenchmarks-trait` allocates one self-hosted macOS runner per (Swift version x package), incurring duplicate runner-recycling cost. * The recent change on main adds a `benchmark_package_paths` input letting a single invocation run all packages serially on each runner. ### Modifications * Replace the two macOS benchmark jobs in `main.yml` and `pull_request.yml` with a single consolidated job that passes both packages via `benchmark_package_paths: '["Benchmarks/NoTraits", "Benchmarks/MaxLogLevelWarning"]'`. * Drop Swift 6.2 from the matrix; only Swift 6.3 is shared between the two packages (`MaxLogLevelWarning` has no `Thresholds/Xcode swift 6.2/`). ### Result * One macOS runner allocation per Swift version instead of one per (version x package). * `NoTraits` loses Swift 6.2 coverage1.12.1 |
||
|
|
1069d31898 |
Skip handler dispatch for setters under MaxLogLevelNone (#465)
Skip handler dispatch for setters under `MaxLogLevelNone`
### Motivation
* When `MaxLogLevelNone` is enabled every
`Logger.trace`/`debug`/.../`critical` method and `Logger.log(level:)`
compiles down to an empty body, so no log statement can ever observe
what the underlying `LogHandler` sees.
* Despite this, the `subscript(metadataKey:)` and `logLevel` setters
still went through the handler. Code like `logger[metadataKey:
"user-id"] = "\(id)"` would CoW the logger storage and call into the
handler even though nothing could read the metadata back out via a log
statement.
### Modifications
* Wrap the bodies of `Logger.subscript(metadataKey:) { set }` and
`Logger.logLevel { set }` in `#if !MaxLogLevelNone`, mirroring the
existing guards on the level-specific log methods.
* Note this behaviour in `DisableLogLevelsDuringCompilation.md` so
callers know reads still go through the handler but writes do not.
* Add a new benchmark which ensures that the operations don't allocate.
* Update some missed swift-tools-version bumps.
* Loosen p90 instruction threshold to 10%. The same source produces
results that swing by up to ~8% between back-to-back runs.
### Result
* `logger[metadataKey:] = ...` and `logger.logLevel = ...` compile to
empty bodies when `MaxLogLevelNone` is set, matching the
zero-runtime-overhead guarantee the trait already provides for log
emission.
* Resolves https://github.com/apple/swift-log/issues/462
|
||
|
|
3061a62b6d |
Shared workflows changed from Xcode XX.X to Xcode swift X.X (#461)
Benchmark thresholds should now be at a different path after switching to `MACOS_SWIFT_6_1_ENABLED` and `MACOS_SWIFT_6_2_ENABLED`. |
||
|
|
184c73762f |
Migrate macOS CI to Swift version inputs (#457)
### Motivation * The shared `macos_tests.yml` and `macos_benchmarks.yml` workflows support requesting Xcodes by Swift version with symlinks on the runners owning the mapping. This more directly expresses the library support window. * Older Xcodes (26.1 and below) are being removed from the runners. ### Modifications * Replace `macos_xcode_16_4_enabled` and `macos_xcode_26_1_enabled` with `macos_swift_6_1_enabled` and `macos_swift_6_2_enabled` in benchmark jobs. * Remove now-redundant explicit `xcode_*_enabled: false` and `swift_*_enabled: true` overrides from the `macos-tests` job in `main.yml` (these now match the workflow defaults). ### Result * macOS CI requests toolchains by Swift version, decoupling the workflows from specific Xcode release names. |
||
|
|
eca81998f5 |
[SLG-0004]: metadata value attributes proposal (revision 2) (#440)
> [!IMPORTANT] > This is a revision of SLG-0004 previously discussed [here](https://forums.swift.org/t/proposal-slg-0004-metadata-values-privacy-attribute/85249/15). Add an extensible per-value attribute mechanism for metadata. ### Motivation: Metadata values in `swift-log` are opaque strings by the time the `LogHandler` receives them. The call site often knows things about a value that the handler cannot infer — for example, whether the value should be redacted in different environments, or additional value type information. ### Modifications: - SLG-0004 proposal is updated based on the feedback in the first round of discussion. ### Result: Revised SLG-0004 proposal is ready for review. |
||
|
|
ac3646e5e0 |
Disable nightly 6.3 WASM builds (#454)
Disable nightly WASM builds because 6.3 images are no longer available. Enable back when 6.4 builds are available. |