Windows: Use `SHGetKnownFolderPath` to compute `LocalAppData` #5201

ShikiSuen · 2025-04-17T05:21:11Z

This PR targets the main branch.

On Windows, it's not guaranteed that USERPROFILE is equivalent to %SYSTEMDRIVE%\Users\%USERNAME%. It is therefore possible that UserDefaults tries to write to a non-existent location, in which case it will never work. When this happens, all writes silently no-op.
This PR uses the Shell API SHGetKnownFolderPath to programmatically get the location of %LOCALAPPDATA% instead of manually building the path.

ShikiSuen · 2025-04-18T08:27:20Z

cc @compnerd Could you please take a look at this PR to see whether there are anything else to fix?

ShikiSuen · 2025-04-21T14:38:39Z

Could anyone please review this?

compnerd

Sorry about the delay. This looks good to me!

compnerd · 2025-06-02T15:32:29Z

@swift-ci please test

compnerd · 2025-06-02T19:35:22Z

11:32:19  /home/build-user/build/buildbot_linux/none-swift_package_sandbox_linux-x86_64/tests/test-foundation-package/Output/test-foundation-networking-static-stdlib.test.tmp/test-foundation-networking | /home/build-user/build/buildbot_linux/llvm-linux-x86_64/bin/FileCheck /home/build-user/swift-integration-tests/test-foundation-package/test-foundation-networking-static-stdlib.test
11:32:19  # executed command: /home/build-user/build/buildbot_linux/none-swift_package_sandbox_linux-x86_64/tests/test-foundation-package/Output/test-foundation-networking-static-stdlib.test.tmp/test-foundation-networking
11:32:19  # .---command stderr------------
11:32:19  # | generic witness table at 0x55f2db72de98 contains out-of-bounds requirement descriptor 0x11
11:32:19  # `-----------------------------
11:32:19  # error: command failed with exit status: -6

This seems unlikely to be related ... @slavapestov any idea what this might be about?

compnerd · 2025-06-05T18:37:06Z

@swift-ci please test

ShikiSuen · 2025-07-18T06:00:16Z

Could anyone please take a look at this PR to see what is going on?

ShikiSuen · 2025-11-27T15:19:37Z

Swift 6.2 is released for months and this PR is till gets ignored.
cc @compnerd for attention.

compnerd · 2025-12-01T18:04:04Z

@swift-ci please test

compnerd · 2025-12-01T18:05:06Z

@ShikiSuen I think that we just need to get this through the CI systems, but this should be good to go otherwise. Please create a new PR with the same changes for the release/6.3 branch

brianmichel · 2025-12-01T18:09:50Z

Oh @ShikiSuen we'd love to use this! Thank you for the fix, can't wait to see it in 6.3!

compnerd · 2025-12-01T23:24:14Z

@swift-ci please test Windows platform

ShikiSuen · 2025-12-02T03:12:11Z

@ShikiSuen I think that we just need to get this through the CI systems, but this should be good to go otherwise. Please create a new PR with the same changes for the release/6.3 branch

I've modified this PR targeting release/6.3 branch now.

Oh @ShikiSuen we'd love to use this! Thank you for the fix, can't wait to see it in 6.3!

I've modified this PR targeting release/6.3 branch now.

compnerd · 2025-12-02T03:29:52Z

@ShikiSuen no, that won't work - this must go to main first. We want a cherry-pick for 6.3

compnerd · 2025-12-02T03:49:42Z

@swift-ci please test

ShikiSuen · 2025-12-02T03:51:02Z

@compnerd The current PR (5201) is now rebased using and targeting the main branch.

(PR 5295 I pushed just now is targeting the 6.0.3 branch.)

compnerd · 2025-12-02T03:55:20Z

@swift-ci please test

compnerd · 2025-12-02T14:14:35Z

@swift-ci please test Windows platform

compnerd · 2025-12-02T14:15:07Z

@ShikiSuen this might require more work - it seems that the tests are failing due to an abnormal termination with this change.

ShikiSuen · 2025-12-02T15:30:36Z

@compnerd I saw the test on WinNT is still running:
https://ci-external.swift.org/job/swift-corelibs-foundation-PR-windows/800/consoleFull

I searched keyword CFKnownLocations. throughout the current log stream and didn't find anything failed.

compnerd · 2025-12-02T15:33:13Z

@compnerd I saw the test on WinNT is still running: https://ci-external.swift.org/job/swift-corelibs-foundation-PR-windows/800/consoleFull

I searched keyword CFKnownLocations. throughout the current log stream and didn't find anything failed.

I re-triggered the tests, so the link is gone. The search result is not important - the fact that the test process terminated abnormally is. That means that there is an invalid memory access or assertion being triggered now.

ShikiSuen · 2025-12-02T16:24:22Z

@compnerd I need to know which assertion in which file fails the unit tests.
Any crash report will help.

P.S.: I'm not familiar with Win32 development. However, I personally suggest that CI for PRs should do A/B tests consecutively to identify whether a CI failure really is caused by the contents of the PR. Also, if it fail, it'd better to be a repeatable failure. Still, to my experience, network dependencies, if have, can fail CI unit tests reandomly.

compnerd · 2025-12-02T16:36:59Z

Unfortunately, SPM doesn't always report that. You would need to try to see if you can reproduce the issue locally.

ShikiSuen · 2025-12-03T05:00:04Z

@compnerd Are unit test cases in CI run sequencially or in parallel?

Let me note some intelligence collected from the failed checks:

Test Case 'TestNSLocale.test_staticProperties' started at 2025-12-02 19:11:18.892

Error: Error: swift exited with code 1.
Invocation:
  swift test --scratch-path T:\x86_64-unknown-windows-msvc\FoundationTests --package-path C:\Users\swift-ci\jenkins\workspace\swift-corelibs-foundation-PR-windows\swift-corelibs-foundation -c debug -debug-info-format none --multiroot-data-file C:\Users\swift-ci\jenkins\workspace\swift-corelibs-foundation-PR-windows\swift\utils\build_swift\resources\SwiftPM-Unified-Build.xcworkspace --test-product swift-corelibs-foundationPackageTests
Call stack:
  at Invoke-Program, C:\Users\swift-ci\jenkins\workspace\swift-corelibs-foundation-PR-windows\swift\utils\build.ps1: line 1075
  at <ScriptBlock>, C:\Users\swift-ci\jenkins\workspace\swift-corelibs-foundation-PR-windows\swift\utils\build.ps1: line 2055
  at Invoke-IsolatingEnvVars, C:\Users\swift-ci\jenkins\workspace\swift-corelibs-foundation-PR-windows\swift\utils\build.ps1: line 1094
  at Build-SPMProject, C:\Users\swift-ci\jenkins\workspace\swift-corelibs-foundation-PR-windows\swift\utils\build.ps1: line 2020
  at <ScriptBlock>, C:\Users\swift-ci\jenkins\workspace\swift-corelibs-foundation-PR-windows\swift\utils\build.ps1: line 3186
  at Invoke-IsolatingEnvVars, C:\Users\swift-ci\jenkins\workspace\swift-corelibs-foundation-PR-windows\swift\utils\build.ps1: line 1094
  at Test-Foundation, C:\Users\swift-ci\jenkins\workspace\swift-corelibs-foundation-PR-windows\swift\utils\build.ps1: line 3178
  at <ScriptBlock>, C:\Users\swift-ci\jenkins\workspace\swift-corelibs-foundation-PR-windows\swift\utils\build.ps1: line 855
  at Record-OperationTime, C:\Users\swift-ci\jenkins\workspace\swift-corelibs-foundation-PR-windows\swift\utils\build.ps1: line 671
  at Invoke-BuildStep, C:\Users\swift-ci\jenkins\workspace\swift-corelibs-foundation-PR-windows\swift\utils\build.ps1: line 854
  at <ScriptBlock>, C:\Users\swift-ci\jenkins\workspace\swift-corelibs-foundation-PR-windows\swift\utils\build.ps1: line 4510

    at Invoke-Program, C:\Users\swift-ci\jenkins\workspace\swift-corelibs-foundation-PR-windows\swift\utils\build.ps1: line 1079
    at <ScriptBlock>, C:\Users\swift-ci\jenkins\workspace\swift-corelibs-foundation-PR-windows\swift\utils\build.ps1: line 2055
    at Invoke-IsolatingEnvVars, C:\Users\swift-ci\jenkins\workspace\swift-corelibs-foundation-PR-windows\swift\utils\build.ps1: line 1094
    at Build-SPMProject, C:\Users\swift-ci\jenkins\workspace\swift-corelibs-foundation-PR-windows\swift\utils\build.ps1: line 2020
    at <ScriptBlock>, C:\Users\swift-ci\jenkins\workspace\swift-corelibs-foundation-PR-windows\swift\utils\build.ps1: line 3186
    at Invoke-IsolatingEnvVars, C:\Users\swift-ci\jenkins\workspace\swift-corelibs-foundation-PR-windows\swift\utils\build.ps1: line 1094
    at Test-Foundation, C:\Users\swift-ci\jenkins\workspace\swift-corelibs-foundation-PR-windows\swift\utils\build.ps1: line 3178
    at <ScriptBlock>, C:\Users\swift-ci\jenkins\workspace\swift-corelibs-foundation-PR-windows\swift\utils\build.ps1: line 855
    at Record-OperationTime, C:\Users\swift-ci\jenkins\workspace\swift-corelibs-foundation-PR-windows\swift\utils\build.ps1: line 671
    at Invoke-BuildStep, C:\Users\swift-ci\jenkins\workspace\swift-corelibs-foundation-PR-windows\swift\utils\build.ps1: line 854
    at <ScriptBlock>, C:\Users\swift-ci\jenkins\workspace\swift-corelibs-foundation-PR-windows\swift\utils\build.ps1: line 4510
  From System.Management.Automation.RuntimeException: Error: swift exited with code 1.
  Invocation:
    swift test --scratch-path T:\x86_64-unknown-windows-msvc\FoundationTests --package-path C:\Users\swift-ci\jenkins\workspace\swift-corelibs-foundation-PR-windows\swift-corelibs-foundation -c debug -debug-info-format none --multiroot-data-file C:\Users\swift-ci\jenkins\workspace\swift-corelibs-foundation-PR-windows\swift\utils\build_swift\resources\SwiftPM-Unified-Build.xcworkspace --test-product swift-corelibs-foundationPackageTests
  Call stack:
    at Invoke-Program, C:\Users\swift-ci\jenkins\workspace\swift-corelibs-foundation-PR-windows\swift\utils\build.ps1: line 1075
    at <ScriptBlock>, C:\Users\swift-ci\jenkins\workspace\swift-corelibs-foundation-PR-windows\swift\utils\build.ps1: line 2055
    at Invoke-IsolatingEnvVars, C:\Users\swift-ci\jenkins\workspace\swift-corelibs-foundation-PR-windows\swift\utils\build.ps1: line 1094
    at Build-SPMProject, C:\Users\swift-ci\jenkins\workspace\swift-corelibs-foundation-PR-windows\swift\utils\build.ps1: line 2020
    at <ScriptBlock>, C:\Users\swift-ci\jenkins\workspace\swift-corelibs-foundation-PR-windows\swift\utils\build.ps1: line 3186
    at Invoke-IsolatingEnvVars, C:\Users\swift-ci\jenkins\workspace\swift-corelibs-foundation-PR-windows\swift\utils\build.ps1: line 1094
    at Test-Foundation, C:\Users\swift-ci\jenkins\workspace\swift-corelibs-foundation-PR-windows\swift\utils\build.ps1: line 3178
    at <ScriptBlock>, C:\Users\swift-ci\jenkins\workspace\swift-corelibs-foundation-PR-windows\swift\utils\build.ps1: line 855
    at Record-OperationTime, C:\Users\swift-ci\jenkins\workspace\swift-corelibs-foundation-PR-windows\swift\utils\build.ps1: line 671
    at Invoke-BuildStep, C:\Users\swift-ci\jenkins\workspace\swift-corelibs-foundation-PR-windows\swift\utils\build.ps1: line 854
    at <ScriptBlock>, C:\Users\swift-ci\jenkins\workspace\swift-corelibs-foundation-PR-windows\swift\utils\build.ps1: line 4510

ShikiSuen · 2025-12-03T05:51:16Z

@compnerd By the way: This PR at this moment added #include <shlobj_core.h> to CFKnownLocations.c. Should there be any extra work to do with this? I guess this might be the prime cause why the CI fails.

ShikiSuen · 2025-12-03T05:59:09Z

@swift-ci Please test Windows platform.

compnerd · 2025-12-03T13:38:00Z

@swift-ci please test windows platform

compnerd · 2025-12-03T21:14:41Z

@swift-ci please test Windows platform

ShikiSuen mentioned this pull request Apr 17, 2025

Use SHGetKnownFolderPath to get path to localappdata for current user #4998

Closed

compnerd approved these changes Jun 2, 2025

View reviewed changes

compnerd changed the title ~~[Continued] Use SHGetKnownFolderPath to get path to localappdata for current user~~ Windows: Use SHGetKnownFolderPath to compute LocalAppData Dec 1, 2025

ShikiSuen changed the base branch from main to release/6.3 December 2, 2025 03:11

ShikiSuen force-pushed the SHGetKnownFolderPath-Continued branch from 4750898 to e71d604 Compare December 2, 2025 03:44

ShikiSuen changed the base branch from release/6.3 to main December 2, 2025 03:47

stevenbrix and others added 3 commits December 2, 2025 11:50

use shgetknownfolderpath instead of hand building the path

7ad5e99

WINNT // Patch a fallthrough from _kCFKnownLocationUserCurrent.

59f3712

chore: comment against the previous commit.

56a4e3f

ShikiSuen force-pushed the SHGetKnownFolderPath-Continued branch from e71d604 to 56a4e3f Compare December 2, 2025 03:50

ShikiSuen changed the title ~~Windows: Use SHGetKnownFolderPath to compute LocalAppData~~ Windows: Use SHGetKnownFolderPath to compute LocalAppData. (targeting main). Dec 2, 2025

compnerd changed the title ~~Windows: Use SHGetKnownFolderPath to compute LocalAppData. (targeting main).~~ Windows: Use SHGetKnownFolderPath to compute LocalAppData Dec 2, 2025

CFKnownLocations // Release username when should.

970da0e

Windows: Use SHGetKnownFolderPath to compute LocalAppData #5201

Are you sure you want to change the base?

Windows: Use SHGetKnownFolderPath to compute LocalAppData #5201

Uh oh!

Conversation

ShikiSuen commented Apr 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ShikiSuen commented Apr 18, 2025

Uh oh!

ShikiSuen commented Apr 21, 2025

Uh oh!

compnerd left a comment

Choose a reason for hiding this comment

Uh oh!

compnerd commented Jun 2, 2025

Uh oh!

compnerd commented Jun 2, 2025

Uh oh!

compnerd commented Jun 5, 2025

Uh oh!

ShikiSuen commented Jul 18, 2025

Uh oh!

ShikiSuen commented Nov 27, 2025

Uh oh!

compnerd commented Dec 1, 2025

Uh oh!

compnerd commented Dec 1, 2025

Uh oh!

brianmichel commented Dec 1, 2025

Uh oh!

compnerd commented Dec 1, 2025

Uh oh!

ShikiSuen commented Dec 2, 2025

Uh oh!

compnerd commented Dec 2, 2025

Uh oh!

compnerd commented Dec 2, 2025

Uh oh!

ShikiSuen commented Dec 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

compnerd commented Dec 2, 2025

Uh oh!

compnerd commented Dec 2, 2025

Uh oh!

compnerd commented Dec 2, 2025

Uh oh!

ShikiSuen commented Dec 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

compnerd commented Dec 2, 2025

Uh oh!

ShikiSuen commented Dec 2, 2025

Uh oh!

compnerd commented Dec 2, 2025

Uh oh!

ShikiSuen commented Dec 3, 2025

Uh oh!

ShikiSuen commented Dec 3, 2025

Uh oh!

ShikiSuen commented Dec 3, 2025

Uh oh!

compnerd commented Dec 3, 2025

Uh oh!

compnerd commented Dec 3, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Windows: Use `SHGetKnownFolderPath` to compute `LocalAppData` #5201

Windows: Use `SHGetKnownFolderPath` to compute `LocalAppData` #5201

ShikiSuen commented Apr 17, 2025 •

edited

Loading

ShikiSuen commented Dec 2, 2025 •

edited

Loading

ShikiSuen commented Dec 2, 2025 •

edited

Loading