Simplify getGlobalCacheDir, change Windows default

CHANGELOG.md

@@ -17,6 +17,7 @@ Bugfixes:
 - Do not compile files twice when using `--watch` and Vim (#346)
 - fix Dhall syntax error in packages.dhall template
 - Use `git clone` instead of `git fetch` when fetching a package (#373)
+- Fixes Windows global cache location; now uses `LocalAppData` as default (#384, #380)
 
 ## [0.9.0] - 2019-07-30
 

package.yaml

@@ -67,7 +67,7 @@ library:
  - fsnotify
  - Glob
  - stm
- - directory
+ - directory >= 1.3.4.0
  - mtl
  - exceptions
  - unliftio

src/Spago/GlobalCache.hs

@@ -9,11 +9,10 @@ import qualified Data.ByteString as BS
 import qualified Data.Map.Strict as Map
 import qualified Data.Text as Text
 import qualified Network.HTTP.Simple as Http
-import qualified System.Environment
 import qualified System.FilePath as FilePath
 import qualified Turtle
+import UnliftIO.Directory (XdgDirectory(XdgCache), getXdgDirectory)
 
-import qualified Spago.Messages as Messages
 import Spago.Types
 
 
@@ -139,43 +138,14 @@ getMetadata cacheFlag = do
 
 
 -- | Directory in which spago will put its global cache
--- Code from: https://github.com/dhall-lang/dhall-haskell/blob/d8f2787745bb9567a4542973f15e807323de4a1a/dhall/src/Dhall/Import.hs#L578
---
--- In order we try to get:
--- - the folder pointed by `$XDG_CACHE_HOME`
--- - the folder pointed by `$HOME/.cache`
--- - the project-local `.cache`
+-- `getXdgDirectory XdgCache` tries to find the folder pointed by 
+-- `$XDG_CACHE_HOME`, otherwise it uses:
+-- - (on Linux/MacOS) the folder pointed by `$HOME/.cache`, or
+-- - (on Windows) the folder pointed by `LocalAppData`
 getGlobalCacheDir :: Spago m => m FilePath.FilePath
 getGlobalCacheDir = do
  echoDebug "Running `getGlobalCacheDir`"
- cacheDir <- alternative₀ <|> alternative₁ <|> alternative₂ <|> alternative₃ <|> err
- pure $ cacheDir </> "spago"
- where
- err = die Messages.cannotGetGlobalCacheDir
-
- alternative₀ = do
- maybeXDGCacheHome <- do
- liftIO (System.Environment.lookupEnv "XDG_CACHE_HOME")
-
- case maybeXDGCacheHome of
- Just xdgCacheHome -> return xdgCacheHome
- Nothing -> empty
-
- alternative₁ = do
- maybeHomeDirectory <- liftIO (System.Environment.lookupEnv "HOME")
-
- case maybeHomeDirectory of
- Just homeDirectory -> return (homeDirectory </> ".cache")
- Nothing -> empty
-
- alternative₂ = do
- maybeWindowsHomeDirectory <- liftIO (System.Environment.lookupEnv "HomePath")
-
- case maybeWindowsHomeDirectory of
- Just homeDirectory -> return (homeDirectory </> ".cache")
- Nothing -> empty
-
- alternative₃ = pure ".spago-global-cache"
+ getXdgDirectory XdgCache "spago" <|> pure ".spago-global-cache"
 
 
 -- | Fetch the tarball at `archiveUrl` and unpack it into `destination`

src/Spago/Messages.hs

@@ -68,16 +68,6 @@ cannotFindPackagesButItsFine = makeMessage
  [ "WARNING: did not find a " <> surroundQuote "packages.dhall" <> " in your current location, skipping compiler version check"
  ]
 
-cannotGetGlobalCacheDir :: Text
-cannotGetGlobalCacheDir = makeMessage
- [ "ERROR: Spago was not able to get a directory for the global cache. To fix this there are some things you could do:"
- , ""
- , "- Set either the `HOME` or `XDG_CACHE_HOME` environment variable. Depending on your OS you'll have to type a different thing in your terminal to do it:"
- , " On Windows: set XDG_CACHE_DIR=\"C:\\tmp\\spago\""
- , " On Linux/Mac: export XDG_CACHE_HOME='/tmp/spago'"
- , ""
- , "- Disable the global cache entirely, by passing to Spago `--global-cache skip`"
- ]
 
 foundExistingProject :: Text -> Text
 foundExistingProject pathText = makeMessage

stack.yaml

@@ -20,5 +20,6 @@ extra-deps:
 - th-lift-0.8.0.1@sha256:cceb81b12c0580e02a7a3898b6d60cca5e1be080741f69ddde4f12210d8ba7ca,1960
 - th-lift-instances-0.1.13@sha256:2852e468511805cb25d9e3923c9e91647d008ab4a764ec0921e5e40ff8a8e874,2625
 - semver-range-0.2.8
+- directory-1.3.4.0@sha256:500019f04494324d1df16cf83eefeb3f809b2b20b32a32ccd755ee0439c18bfd
 nix:
  packages: [zlib]