Randomize test-ghc-env to avoid conflicts between parallel jobs
#5757
Conversation
This file contains hidden or 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
Since the build temporary directory is shared between jobs, we can't use the same file name for the `test-ghc-env` for all of them. Fixes commercialhaskell#5024
zyla
changed the title
test-ghc-env to avoid conflicts between parallel jobs
ulidtko
reviewed
Jun 7, 2022
src/Stack/Build/Execute.hs
Outdated
Comment on lines
1929
to
1936
| -- see e.g. https://github.com/doctest/issues/119 | ||
| -- also we set HASKELL_DIST_DIR to a package dist directory so | ||
| -- doctest will be able to load modules autogenerated by Cabal | ||
| ghcEnvRandomId <- liftIO (randomIO :: IO Int) | ||
| let setEnv f pc = modifyEnvVars pc $ \envVars -> | ||
| Map.insert "HASKELL_DIST_DIR" (T.pack $ toFilePath buildDir) $ | ||
| Map.insert "GHC_ENVIRONMENT" (T.pack f) envVars | ||
| fp = toFilePath $ eeTempDir ee </> testGhcEnvRelFile | ||
| fp = toFilePath (eeTempDir ee </> testGhcEnvRelFile) <> show ghcEnvRandomId |
Contributor
There was a problem hiding this comment.
The ghcEnvRandomId line interjects the preceding multiline comment explaining env variables and the next line, let setEnv ... — to which that comment is relevant. Please move somewhere else.
Perhaps like this?
-- see e.g. https://github.com/doctest/issues/119
-- also we set HASKELL_DIST_DIR to a package dist directory so
-- doctest will be able to load modules autogenerated by Cabal
let setEnv f pc = modifyEnvVars pc $ \envVars ->
Map.insert "HASKELL_DIST_DIR" (T.pack $ toFilePath buildDir) $
Map.insert "GHC_ENVIRONMENT" (T.pack f) envVars
+ ghcEnvRandomId <- liftIO (randomIO :: IO Int)
- fp = toFilePath $ eeTempDir ee </> testGhcEnvRelFile
+ let fp = toFilePath (eeTempDir ee </> testGhcEnvRelFile) <> show ghcEnvRandomIdFurther, it's not so hard to stay within typed Path, just import addExtension:
- ghcEnvRandomId <- liftIO (randomIO :: IO Int)
- let fp = toFilePath $ eeTempDir ee </> testGhcEnvRelFile
+ randomSuffix <- ("-"<>) . show <$> liftIO (randomIO :: IO Int)
+ fp <- toFilePath <$> addExtension randomSuffix (eeTempDir ee </> testGhcEnvRelFile)
Also adds a comment to explain the purpose of the random suffix
Member
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Since the build temporary directory is shared between parallel jobs, we can't use
the same file name for the
test-ghc-envfor all of them. This PR uses a random name for each parallel job to avoid conflicts.Fixes #5024