Stop mutating environment variables during registration
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Idoneità per principianti
- 64/100
- Tipo di issue
- Refactoring
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Tranquilla
- Stack tecnologico
- csharp
- Ambito
- build-system
Direzione di ricerca
Inizia da ApplyDotNetSdkEnvironmentVariables e dalle relative chiamate nei percorsi di registrazione di .NET, quindi esamina la suite di test esistente di MSBuildLocator. Aggiungi una copertura isolata per processo con le tre variabili assenti, registra un SDK, valuta un progetto in stile SDK e verifica i percorsi derivati. Il lavoro è completo quando la registrazione non riscrive più le variabili d’ambiente gestite dal chiamante e gli scenari di regressione hanno esito positivo.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
On .NET, registration currently calls ApplyDotNetSdkEnvironmentVariables, which sets process-wide environment variables:
MSBUILD_EXE_PATH=<sdk>\MSBuild.dll
MSBuildExtensionsPath=<sdk>
MSBuildSDKsPath=<sdk>\Sdks
This was added to mimic the environment established by dotnet msbuild, but it appears unnecessary. MSBuild can derive its toolset, extensions path, and SDKs path from the loaded MSBuild assemblies.
Proposal: remove ApplyDotNetSdkEnvironmentVariables and stop setting or unsetting these variables during registration. Environment variables supplied by the caller should remain caller-owned.
Copilot analysis of the situation:
Why
MSBuild's
BuildEnvironmentHelperalready has self-location logic:
MSBUILD_EXE_PATHis an explicit override, but when absent MSBuild locates its installation from the loaded assembly and adjacentMSBuild.dll/apphost.MSBuildExtensionsPathdefaults to the detected MSBuild tools directory for a standalone toolset.MSBuildSDKsPathdefaults to<detected MSBuild tools directory>\Sdks.Mutating these variables is process-global and can affect unrelated code and child processes. In particular, a child
dotnetinvocation may select another SDK throughglobal.jsonwhile inheriting paths pinned to the SDK registered in its parent.Experiments
An isolated probe was run in a fresh process for each scenario. It:
- Registered a specific SDK directory before touching any MSBuild API.
- Removed
MSBUILD_EXE_PATH,MSBuildExtensionsPath, andMSBuildSDKsPathbefore MSBuild initialized.- Created and evaluated a minimal SDK-style project.
- Checked the evaluated toolset properties.
- Restored and built the project and verified its output.
- Repeated the build through two parallel out-of-process worker nodes.
Tested SDKs:
SDK MSBuild Project TFM Result 2.1.300 15.7 netcoreapp2.1Passed 8.0.423 17.x net8.0Passed 9.0.316 17.x net9.0Passed 10.0.302 18.x net10.0Passed 10.0.400 preview 18.x net10.0Passed In every case MSBuild derived the selected installation correctly. For SDK 2.1.300, for example:
MSBuildExtensionsPath=<extracted SDK>\sdk\2.1.300 MSBuildSDKsPath=<extracted SDK>\sdk\2.1.300\Sdks MSBuildToolsPath=<extracted SDK>\sdk\2.1.300 MSBuildToolsVersion=15.0Restore, build, output verification, and the parallel-node build all succeeded. The current MSBuildLocator test suite also passed after replacing the environment setup during the experiment.
The SDK 2.1.300 probe used the official Windows x64 archive. The harness itself ran on .NET 8 while loading MSBuild 15.7 from that SDK; it did not cover a .NET Core 2.1-hosted process or Linux.
Compatibility considerations
- Existing ambient values currently get overwritten. With this proposal they would be preserved and would continue to act as explicit MSBuild overrides. That is more conventional, but it is a behavior change for callers with stale or incorrect inherited values.
- Native AOT and unusual bundled hosts can require an explicit toolset path when
Assembly.Locationis unavailable. MSBuildLocator currently relies on runtime assembly loading and does not support the normal Native AOT model, but this should be confirmed before removal.- The oldest supported SDK should also be exercised under its native runtime and on Unix in CI if practical.
Proposed change
- Remove
ApplyDotNetSdkEnvironmentVariablesand its calls from .NET registration paths.- Add process-isolated regression coverage that registers an SDK with all three variables absent, evaluates an SDK-style project, and verifies the derived paths.
- Document that MSBuild-related environment overrides are owned by the host/caller and are not rewritten by MSBuildLocator.
- Lingua principale
- C#
- Stelle
- 262
- Fork
- 91
- Merge medio
- 11g 22h
- PR unite (30g)
- 3
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di microsoft/MSBuildLocator
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 52/100
microsoft/MSBuildLocator#390 · 1 reazione ·
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 45/100
microsoft/MSBuildLocator#380 ·
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 48/100
microsoft/MSBuildLocator#377 ·
-
Difficoltà 5/5 Più di una settimana Idoneità per principianti 30/100
microsoft/MSBuildLocator#371 · 1 commento ·
-
microsoft/MSBuildLocator#368 · 2 commenti · 4 reazioni · 1 assegnatario ·
Tutte le issue di microsoft/MSBuildLocator
Issue simili
-
effort:S P3 refactor
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
nightscout/nocturne#1532 ·
-
core dependencies
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 80/100
-
documentation
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
-
C#/.NET Roslyn LSP Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
-
Suspicious code fragments Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
DotNetNext/SqlSugar#1458 ·