Package plugins don't work on Windows if the PATH environment variable isn't accessed with the right case #8126
+3
−7
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jakepetroules
requested review from
bnbarham,
MaxDesiatov,
francescomikulis,
xedin,
dschaefer2,
shawnhyam,
bripeticca,
plemarquand and
owenv
as code owners
|
@swift-ci please smoke test |
rauhul
reviewed
Nov 19, 2024
…e isn't accessed with the right case
Builds of packages using package plugins may fail on Windows with the following error:
```
error: plugin process ended by an uncaught signal: 309 <command: C:\foo\.build\plugins\cache\myplugin.exe>, <output:
>
```
309 translates to 0x135, which maps to 0xc0000135 aka STATUS_DLL_NOT_FOUND.
This is due to the following code in DefaultPluginScriptRunner.swift:
```swift
#if os(Windows)
let pluginLibraryPath = self.toolchain.swiftPMLibrariesLocation.pluginLibraryPath.pathString
var env = ProcessInfo.processInfo.environment
if let Path = env["Path"] {
env["Path"] = "\(pluginLibraryPath);\(Path)"
} else {
env["Path"] = pluginLibraryPath
}
process.environment = env
#endif
```
Environment variable names are case-insensitive on Windows. On a real Windows host, it tends to be spelled "Path". In a Windows Container (Docker), it tends to be spelled "PATH".
The code will end up clearing out the other paths from the PATH environment variable in the else case because Path != PATH.
We need to access the path here in a case-insensitive manner -- use the existing Environment abstraction for this, which handles Windows case sensitivity concerns.
Closes #8125
jakepetroules
force-pushed
the
plugins-path
branch
from
5ad260a
to
fe1a671
Compare
MaxDesiatov
approved these changes
Nov 19, 2024
bkhouri
suggested changes
Nov 19, 2024
| env["Path"] = pluginLibraryPath | ||
| } | ||
| process.environment = env | ||
| var env = Environment.current |
There was a problem hiding this comment.
Suggestion: Since the issue was not caught by a test, possibly because we don't execute tests against windows yet, would it be possible to check if a test already exists, and if not, please add one to ensure we don't regress - once the tests are enabled.
cmcgee1024
approved these changes
Nov 19, 2024
compnerd
approved these changes
Nov 20, 2024
| process.environment = env | ||
| var env = Environment.current | ||
| env.prependPath(key: .path, value: pluginLibraryPath) | ||
| process.environment = .init(env) |
There was a problem hiding this comment.
There was a new type introduced (I think in TSC?) to deal with the case (in)sensitivity of the environment. However, I do like this approach - it is simpler for this case.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Builds of packages using package plugins may fail on Windows with the following error:
309 translates to 0x135, which maps to 0xc0000135 aka STATUS_DLL_NOT_FOUND.
This is due to the following code in DefaultPluginScriptRunner.swift:
Environment variable names are case-insensitive on Windows. On a real Windows host, it tends to be spelled "Path". In a Windows Container (Docker), it tends to be spelled "PATH".
The code will end up clearing out the other paths from the PATH environment variable in the else case because Path != PATH.
We need to access the path here in a case-insensitive manner -- use the existing Environment abstraction for this, which handles Windows case sensitivity concerns.
Closes #8125
[One line description of your change]
Motivation:
[Explain here the context, and why you're making that change. What is the problem you're trying to solve.]
Modifications:
[Describe the modifications you've done.]
Result:
[After your change, what will change.]