Skip to content

Use Environment.SpecialFolder.UserProfile, not SpecialFolder.Personal. #16017

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
rolfbjarne merged 2 commits into from
Sep 23, 2022
Merged

Use Environment.SpecialFolder.UserProfile, not SpecialFolder.Personal. #16017

rolfbjarne merged 2 commits into from
Sep 23, 2022

Conversation

@rolfbjarne
Copy link
Member

@rolfbjarne rolfbjarne commented Sep 19, 2022 •
edited
Loading

Context: dotnet/runtime#68610
Context: dotnet/android-tools@0be567a9

In Mono and .NET prior to .NET 8, the
System.Environment.SpecialFolder.Personal enum value would refer to
$HOME on Unix platforms.

This will be changing in .NET 8, such that
Environment.SpecialFolder.Personal will instead refer to
$XDG_DOCUMENTS_DIR (if set) or $HOME/Documents. This is for "semantic
compatibility" with .NET on Windows.

Replace usage of Environment.SpecialFolder.Personal with
Environment.SpecialFolder.UserProfile, so that our code continues to work as
expected under .NET 8.

@rolfbjarne
Use Environment.SpecialFolder.UserProfile, not SpecialFolder.Personal.
defc6be 
Context: dotnet/runtime#68610
Context: dotnet/android-tools@0be567a9

In Mono and .NET prior to .NET 8, the
[`System.Environment.SpecialFolder`][0]`.Personal` enum value would refer to
`$HOME` on Unix platforms.

This will be changing in .NET 8, such that
`Environment.SpecialFolder.Personal` will instead refer to
`$XDG_DOCUMENTS_DIR` (if set) or `$HOME/Documents`.  This is for "semantic
compatibility" with .NET on Windows.

Replace usage of `Environment.SpecialFolder.Personal` with
`Environment.SpecialFolder.UserProfile`, so that our code continues to work as
expected under .NET 8.

[0]: https://docs.microsoft.com/en-us/dotnet/api/system.environment.specialfolder?view=net-6.0

Requesting a pull to xamarin:main from rolfbjarne:no-more-personal-special-folder

Write a message for this pull request. The first block
of text is the title and the rest is the description.
@rolfbjarne rolfbjarne added the not-notes-worthy Ignore for release notes label Sep 19, 2022
@vs-mobiletools-engineering-service2

This comment has been minimized.

Sign in to view
@vs-mobiletools-engineering-service2

This comment has been minimized.

Sign in to view
@vs-mobiletools-engineering-service2

This comment has been minimized.

Sign in to view
@vs-mobiletools-engineering-service2

This comment has been minimized.

Sign in to view
@vs-mobiletools-engineering-service2

This comment has been minimized.

Sign in to view
eerhardt
eerhardt approved these changes Sep 19, 2022
View reviewed changes
Copy link
Member

@eerhardt eerhardt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks for fixing this up!

Note that Environment.SpecialFolder.MyDocuments is the same underlying enum value as Environment.SpecialFolder.Personal. It would be good to audit all the calls to MyDocuments and ensure they actually meant a "Documents" folder, and not the UserProfile as well.

Also note, the .NET 8 change doesn't affect iOS/tvOS/etc. It only affects macOS and Linux.

@vs-mobiletools-engineering-service2
Copy link
Collaborator

vs-mobiletools-engineering-service2 commented Sep 20, 2022

📚 [PR Build] Artifacts 📚

Packages generated

View packages

Pipeline on Agent XAMBOT-1106.Monterey'
Hash: f6ceb366793e808dd0ea9ddc71ded3ff224c2757 [PR build]

@vs-mobiletools-engineering-service2
Copy link
Collaborator

vs-mobiletools-engineering-service2 commented Sep 20, 2022

💻 [PR Build] Tests on macOS Mac Catalina (10.15) passed 💻

✅ All tests on macOS Mac Catalina (10.15) passed.

Pipeline on Agent
Hash: f6ceb366793e808dd0ea9ddc71ded3ff224c2757 [PR build]

@vs-mobiletools-engineering-service2
Copy link
Collaborator

vs-mobiletools-engineering-service2 commented Sep 20, 2022

💻 [PR Build] Tests on macOS M1 - Mac Big Sur (11.5) passed 💻

✅ All tests on macOS M1 - Mac Big Sur (11.5) passed.

Pipeline on Agent
Hash: f6ceb366793e808dd0ea9ddc71ded3ff224c2757 [PR build]

@vs-mobiletools-engineering-service2
Copy link
Collaborator

vs-mobiletools-engineering-service2 commented Sep 20, 2022

✅ API diff for current PR / commit

Legacy Xamarin (No breaking changes)
  • iOS (no change detected)
  • tvOS (no change detected)
  • watchOS (no change detected)
  • macOS (no change detected)
NET (empty diffs)
  • iOS: (empty diff detected)
  • tvOS: (empty diff detected)
  • MacCatalyst: (empty diff detected)
  • macOS: (empty diff detected)

✅ API diff vs stable

Legacy Xamarin (No breaking changes)
.NET (No breaking changes)
Legacy Xamarin (stable) vs .NET

✅ Generator diff

Generator diff is empty

Pipeline on Agent
Hash: f6ceb366793e808dd0ea9ddc71ded3ff224c2757 [PR build]

@vs-mobiletools-engineering-service2
Copy link
Collaborator

vs-mobiletools-engineering-service2 commented Sep 20, 2022

🔥 [CI Build] Test results 🔥

Test results

❌ Tests failed on VSTS: simulator tests

0 tests crashed, 1 tests failed, 222 tests passed.

Failures

❌ msbuild tests

1 tests failed, 1 tests passed.
Details
  • MSBuild tests/Integration: Failed (Execution failed with exit code 1)

Html Report (VSDrops) Download

Successes

✅ bcl: All 69 tests passed. Html Report (VSDrops) Download
✅ cecil: All 1 tests passed. Html Report (VSDrops) Download
✅ dotnettests: All 1 tests passed. Html Report (VSDrops) Download
✅ fsharp: All 7 tests passed. Html Report (VSDrops) Download
✅ framework: All 8 tests passed. Html Report (VSDrops) Download
✅ generator: All 2 tests passed. Html Report (VSDrops) Download
✅ interdependent_binding_projects: All 7 tests passed. Html Report (VSDrops) Download
✅ install_source: All 1 tests passed. Html Report (VSDrops) Download
✅ introspection: All 8 tests passed. Html Report (VSDrops) Download
✅ linker: All 65 tests passed. Html Report (VSDrops) Download
✅ mac_binding_project: All 1 tests passed. Html Report (VSDrops) Download
✅ mmp: All 2 tests passed. Html Report (VSDrops) Download
✅ mononative: All 12 tests passed. Html Report (VSDrops) Download
✅ monotouch: All 23 tests passed. Html Report (VSDrops) Download
✅ mtouch: All 1 tests passed. Html Report (VSDrops) Download
✅ xammac: All 3 tests passed. Html Report (VSDrops) Download
✅ xcframework: All 8 tests passed. Html Report (VSDrops) Download
✅ xtro: All 2 tests passed. Html Report (VSDrops) Download

Pipeline on Agent
Hash: [PR build]

@rolfbjarne
Copy link
Member Author

rolfbjarne commented Sep 21, 2022

Test failure is unrelated (https://github.com/xamarin/maccore/issues/2620).

@rolfbjarne rolfbjarne merged commit b82b168 into dotnet:main Sep 23, 2022
@rolfbjarne rolfbjarne deleted the no-more-personal-special-folder branch September 23, 2022 14:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@dalexsoto dalexsoto dalexsoto approved these changes

@emaf emaf emaf approved these changes

@mauroa mauroa Awaiting requested review from mauroa mauroa is a code owner

+3 more reviewers

@mandel-macaque mandel-macaque mandel-macaque approved these changes

@chamons chamons chamons approved these changes

@eerhardt eerhardt eerhardt approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

not-notes-worthy Ignore for release notes

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@rolfbjarne @vs-mobiletools-engineering-service2 @dalexsoto @mandel-macaque @emaf @chamons @eerhardt