Set LC_ALL to UTF-8 encoding for builds (commercialhaskell#793)

borsboom · borsboom · commit 9787aed68818 · 2015-08-21T07:19:36.000-07:00
diff --git a/ChangeLog.md b/ChangeLog.md
@@ -1,6 +1,7 @@
 ## Unreleased changes
 
 * Added the `--docker-env` argument, to set environment variables in Docker container.
+* Set `LC_ALL` to UTF-8 encoding for builds to avoid "commitBuffer: invalid argument" errors from GHC [#793](https://github.com/commercialhaskell/stack/issues/793)
 
 ## 0.1.3.1
 
diff --git a/src/Stack/Build/Execute.hs b/src/Stack/Build/Execute.hs
@@ -388,6 +388,7 @@ executePlan menv bopts baseConfigOpts locals sourceMap installedMap plan = do
                     { esIncludeLocals = True
                     , esIncludeGhcPackagePath = True
                     , esStackExe = True
+                    , esLocaleUtf8 = False
                     }
     forM_ (boptsExec bopts) $ \(cmd, args) -> do
         $logProcessRun cmd args
@@ -642,6 +643,7 @@ withSingleContext ActionContext {..} ExecuteEnv {..} task@Task {..} msuffix inne
             { esIncludeLocals = taskLocation task == Local
             , esIncludeGhcPackagePath = False
             , esStackExe = False
+            , esLocaleUtf8 = True
             }
         getRunhaskellPath <- runOnce $ liftIO $ join $ findExecutable menv "runhaskell"
         getGhcjsPath <- runOnce $ liftIO $ join $ findExecutable menv "ghcjs"
@@ -941,6 +943,7 @@ singleTest topts lptb ac ee task installedMap =
                     { esIncludeLocals = taskLocation task == Local
                     , esIncludeGhcPackagePath = True
                     , esStackExe = True
+                    , esLocaleUtf8 = False
                     }
                 if exists
                     then do
diff --git a/src/Stack/Exec.hs b/src/Stack/Exec.hs
@@ -31,6 +31,7 @@ defaultEnvSettings = EnvSettings
     { esIncludeLocals = True
     , esIncludeGhcPackagePath = True
     , esStackExe = True
+    , esLocaleUtf8 = False
     }
 
 -- | Environment settings which do not embellish the environment
@@ -39,6 +40,7 @@ plainEnvSettings = EnvSettings
     { esIncludeLocals = False
     , esIncludeGhcPackagePath = False
     , esStackExe = False
+    , esLocaleUtf8 = False
     }
 
 -- | Execute a process within the Stack configured environment.
diff --git a/src/Stack/Options.hs b/src/Stack/Options.hs
@@ -465,6 +465,7 @@ execOptsParser mcmd =
                 "stack-exe"
                 "setting the STACK_EXE environment variable to the path for the stack executable"
                 idm
+        <*> pure False
 
     eoPackagesParser :: Parser [String]
     eoPackagesParser = many (strOption (long "package" <> help "Additional packages that must be installed"))
diff --git a/src/Stack/Setup.hs b/src/Stack/Setup.hs
@@ -216,6 +216,10 @@ setupEnv mResolveMissingGHC = do
                                 then Map.insert "STACK_EXE" (T.pack executablePath)
                                 else id)
 
+                        $ (if esLocaleUtf8 es
+                                then Map.insert "LC_ALL" "C.UTF-8"
+                                else id)
+
                         -- For reasoning and duplication, see: https://github.com/fpco/stack/issues/70
                         $ Map.insert "HASKELL_PACKAGE_SANDBOX" (T.pack $ toFilePathNoTrailingSlash deps)
                         $ Map.insert "HASKELL_PACKAGE_SANDBOXES"
diff --git a/src/Stack/Types/Config.hs b/src/Stack/Types/Config.hs
@@ -190,6 +190,8 @@ data EnvSettings = EnvSettings
     -- ^ include the GHC_PACKAGE_PATH variable
     , esStackExe :: !Bool
     -- ^ set the STACK_EXE variable to the current executable name
+    , esLocaleUtf8 :: !Bool
+    -- ^ set the locale to C.UTF-8
     }
     deriving (Show, Eq, Ord)
 
@@ -872,6 +874,7 @@ getMinimalEnvOverride = do
                     { esIncludeLocals = False
                     , esIncludeGhcPackagePath = False
                     , esStackExe = False
+                    , esLocaleUtf8 = False
                     }
 
 getWhichCompiler :: (MonadReader env m, HasEnvConfig env) => m WhichCompiler

Original file line number	Diff line number	Diff line change
`@@ -31,6 +31,7 @@ defaultEnvSettings = EnvSettings`
`31`	`31`	`{ esIncludeLocals = True`
`32`	`32`	`, esIncludeGhcPackagePath = True`
`33`	`33`	`, esStackExe = True`
	`34`	`+ , esLocaleUtf8 = False`
`34`	`35`	`}`
`35`	`36`
`36`	`37`	`-- \| Environment settings which do not embellish the environment`
`@@ -39,6 +40,7 @@ plainEnvSettings = EnvSettings`
`39`	`40`	`{ esIncludeLocals = False`
`40`	`41`	`, esIncludeGhcPackagePath = False`
`41`	`42`	`, esStackExe = False`
	`43`	`+ , esLocaleUtf8 = False`
`42`	`44`	`}`
`43`	`45`
`44`	`46`	`-- \| Execute a process within the Stack configured environment.`
Original file line number	Diff line number	Diff line change
`@@ -190,6 +190,8 @@ data EnvSettings = EnvSettings`
`190`	`190`	`-- ^ include the GHC_PACKAGE_PATH variable`
`191`	`191`	`, esStackExe :: !Bool`
`192`	`192`	`-- ^ set the STACK_EXE variable to the current executable name`
	`193`	`+ , esLocaleUtf8 :: !Bool`
	`194`	`+ -- ^ set the locale to C.UTF-8`
`193`	`195`	`}`
`194`	`196`	`deriving (Show, Eq, Ord)`
`195`	`197`
`@@ -872,6 +874,7 @@ getMinimalEnvOverride = do`
`872`	`874`	`{ esIncludeLocals = False`
`873`	`875`	`, esIncludeGhcPackagePath = False`
`874`	`876`	`, esStackExe = False`
	`877`	`+ , esLocaleUtf8 = False`
`875`	`878`	`}`
`876`	`879`
`877`	`880`	`getWhichCompiler :: (MonadReader env m, HasEnvConfig env) => m WhichCompiler`