Return to ~/.elm for ELM_HOME and start namespacing package artifact caches instead for built-with-elm-first-so-missing-wire compilation issue

Author: supermario

.gitignore

@@ -13,3 +13,7 @@ travis.log
 extra/node_modules
 extra/.cache
 .stack-work
+
+# @TESTS
+elm-home
+

builder/src/Elm/Details.hs

@@ -390,6 +390,7 @@ verifyDep (Env key _ _ cache manager _ _) depsMVar solution pkg details@(Solver.
         then
           do  Reporting.report key Reporting.DCached
               maybeCache <- File.readBinary (Stuff.package cache pkg vsn </> "artifacts.dat")
+                              & Lamdera.alternativeImplementation (File.readBinary (Stuff.package cache pkg vsn </> "artifacts.x.dat"))
               case maybeCache of
                 Nothing ->
                   build key cache depsMVar pkg details fingerprint Set.empty
@@ -484,6 +485,7 @@ build key cache depsMVar pkg (Solver.Details vsn _) f fs =
                                 Just results ->
                                   let
                                     path = Stuff.package cache pkg vsn </> "artifacts.dat"
+                                             & Lamdera.alternativeImplementation (Stuff.package cache pkg vsn </> "artifacts.x.dat")
                                     ifaces = gatherInterfaces exposedDict results
                                     objects = gatherObjects results
                                     artifacts = Artifacts ifaces objects

builder/src/Stuff.hs

@@ -46,16 +46,19 @@ stuff root =
 details :: FilePath -> FilePath
 details root =
   stuff root </> "d.dat"
+    & Lamdera.alternativeImplementation (stuff root </> "d.x.dat")
 
 
 interfaces :: FilePath -> FilePath
 interfaces root =
   stuff root </> "i.dat"
+    & Lamdera.alternativeImplementation (stuff root </> "i.x.dat")
 
 
 objects :: FilePath -> FilePath
 objects root =
   stuff root </> "o.dat"
+    & Lamdera.alternativeImplementation (stuff root </> "o.x.dat")
 
 
 prepublishDir :: FilePath -> FilePath
@@ -180,4 +183,4 @@ getElmHome =
       case maybeCustomHome of
         Just customHome -> return customHome
         Nothing -> Dir.getAppUserDataDirectory "elm"
-          & Lamdera.alternativeImplementation (Dir.getAppUserDataDirectory "lamdera")
+          -- & Lamdera.alternativeImplementation (Dir.getAppUserDataDirectory "lamdera")

elm.cabal

@@ -299,6 +299,7 @@ Executable lamdera
         -- Testing:
         EasyTest
         Test
+        Test.Caching
         Test.Check
         Test.Helpers
         Test.Lamdera

ext-common/Ext/Common.hs

@@ -221,6 +221,10 @@ atomicPutStrLn :: String -> IO ()
 atomicPutStrLn str =
   withMVar printLock (\_ -> hPutStr stdout (str <> "\n") >> hFlush stdout)
 
+atomicPutStrLn_ :: Text -> IO ()
+atomicPutStrLn_ text =
+  atomicPutStrLn $ T.unpack text
+
 atomicPutStrLnDebug :: String -> IO ()
 atomicPutStrLnDebug s = do
   onlyWhen (isDebug_) $ atomicPutStrLn s
@@ -380,23 +384,29 @@ bashq command =
 c_ :: String -> [String] -> String -> IO String
 c_ bin args input = do
   atomicPutStrLnDebug $ "🤖  " <> bin <> " " <> show args <> " " <> input
-  (exit, stdout, stderr) <- System.Process.readProcessWithExitCode bin args input
+  (exit, stdOut, stdErr) <- System.Process.readProcessWithExitCode bin args input
   res <-
-    if Prelude.length stderr > 0
-      then pure stderr
-      else pure stdout
-  atomicPutStrLnDebug $ "└── " <> res
-  pure res
+    if Prelude.length stdErr > 0
+      then pure stdErr
+      else pure stdOut
+  -- This doesn't quite work for debugging because bash will honour the sequence codes of the output
+  -- which gives us confusing results. I.e. Elm compilation clears the buffer during operation
+  -- onlyWhen (Prelude.length stdErr > 0) $ atomicPutStrLnDebug $ "└── stdErr: " <> stdErr
+  -- onlyWhen (Prelude.length stdOut > 0) $ atomicPutStrLnDebug $ "└── stdOut: " <> stdOut
+  -- This doesn't happen with the show instance as it escapes sequences inside the string
+  atomicPutStrLnDebug $ "└── " <> show (exit, stdOut, stdErr)
+  pure $ show (exit, stdOut, stdErr)
+
 
 cq_ :: String -> [String] -> String -> IO String
 cq_ bin args input = do
   atomicPutStrLnDebug $ "🤖  " <> bin <> " " <> show args <> " " <> input
-  (exit, stdout, stderr) <- System.Process.readProcessWithExitCode bin args input
+  (exit, stdOut, stdErr) <- System.Process.readProcessWithExitCode bin args input
   res <-
-    if Prelude.length stderr > 0
-      then pure stderr
-      else pure stdout
-  pure res
+    if Prelude.length stdErr > 0
+      then pure stdErr
+      else pure stdOut
+  pure $ show (exit, stdOut, stdErr)
 
 
 requireBinary :: String -> IO FilePath

extra/Lamdera.hs

@@ -211,14 +211,17 @@ debug str =
 debugT text =
   liftIO $ debug_ (T.unpack text)
 
+alternativeImplementation :: a -> a -> a
 alternativeImplementation fn ignored =
   fn
 
+alternativeImplementationWhen :: Bool -> a -> a -> a
 alternativeImplementationWhen cond fn original =
   if cond
     then fn
     else original
 
+alternativeImplementationPassthrough :: (a -> b) -> a -> b
 alternativeImplementationPassthrough fn original =
   fn original
 

extra/Lamdera/CLI/Reset.hs

@@ -55,8 +55,9 @@ run () () = do
         then do
           progress $ "Removing artifacts in " <> elmHome
           let packageDir = elmHome </> Lamdera.Version.elm </> "packages"
-          onlyWhen_ (doesDirectoryExist packageDir) $
+          onlyWhen_ (doesDirectoryExist packageDir) $ do
             c $ "find " <> packageDir <> " | grep artifacts.dat | xargs rm"
+            c $ "find " <> packageDir <> " | grep artifacts.x.dat | xargs rm"
 
         else do
           nukeDir elmHome

test/Test.hs

@@ -14,6 +14,7 @@ import EasyTest
 import Lamdera
 import qualified Test.Snapshot
 import qualified Test.Lamdera
+import qualified Test.Caching
 import qualified Test.Check
 import qualified Test.Wire
 import qualified Test.Ext.ElmPages.Check

test/Test/Caching.hs

@@ -0,0 +1,72 @@
+{-# LANGUAGE OverloadedStrings #-}
+{-# LANGUAGE BangPatterns #-}
+{-# LANGUAGE QuasiQuotes #-}
+
+module Test.Caching where
+
+import EasyTest
+import NeatInterpolation
+
+import Test.Helpers
+import Lamdera hiding ((&))
+import Ext.Common
+
+import Lamdera.Compile
+
+
+all = EasyTest.run suite
+
+suite :: Test ()
+suite = tests $
+  let
+    project = "./test/scenario-empty-elm-init"
+
+    bashInScenario c = bash $ "cd " ++ project ++ " && " ++ c
+  in
+  [ scope "a package compiled with Elm first will gracefully recompile with Lamdera" $ do
+      io $ do
+        rmdir $ project ++ "/elm-home"
+        setEnv "ELM_HOME" $ project ++ "/elm-home"
+        -- @TODO remove this?
+        setEnv "LDEBUG" "1"
+
+      elmCompilation <- io $ do
+        rmdir $ project ++ "/elm-stuff"
+        writeUtf8 (project ++ "/src/Main.elm") [text|
+            module Main exposing (main)
+
+            import Html
+
+
+            main =
+                Html.text "hello!"
+        |]
+        bashInScenario "ELM_HOME=./elm-home ~/.local/bin/elm-0.19.1-official make src/Main.elm --output=/dev/null"
+
+      expect $ elmCompilation & stringContains "Success!"
+
+      lamderaCompilation <- io $ do
+        rmdir $ project ++ "/elm-stuff"
+        writeUtf8 (project ++ "/src/Main.elm") [text|
+            module Main exposing (main)
+
+            import Html
+
+
+            main =
+                Html.text "hello!"
+
+
+            will_fail_on_elm_caches =
+                Html.w2_encode_Html
+        |]
+
+        withDebug $ captureProcessOutput $ Lamdera.Compile.makeDev project ["src/Main.elm"]
+
+      io $ atomicPutStrLn_ lamderaCompilation
+      expect $ lamderaCompilation & textContains "Success!"
+
+      io $ bashInScenario "git checkout src/Main.elm"
+
+      pure ()
+  ]

test/Test/Helpers.hs

@@ -85,3 +85,8 @@ catchOutputStdErr action = do
   pr <- EasyTest.io $ captureProcessResult action
   -- @TODO improve this to actually pull out values
   pure $ T.decodeUtf8 $ Test.Main.prStderr pr
+
+
+captureProcessOutput action = do
+    pr <- captureProcessResult action
+    hindent pr