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

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
 

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

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.

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"))

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"

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