on master help sign in
static: Reload static asset derivations when they change
commit77cbb3a73e26ed5b90c545e30932796ffe5fb27c authorAli Abrar <aliabrar@gmail.com> dateFri 18 Dec 2020, 03:39 (6 years ago) parent93bf974
4 files changed+95−16
ChangeLog.md+2−1 lib/command/obelisk-command.cabal+3 lib/command/src/Obelisk/Command/Project.hs+73−8 lib/command/src/Obelisk/Command/Run.hs+17−7
ChangeLog.md+2−1
@@ -8,7 +8,8 @@ This project's release branch is `master`. This log is written from the perspect
88 * Migration: All uses of `static @"some/path"` become `$(static "some/path")`. Instead of requiring `TypeApplications` and `DataKinds`, modules calling `static` must now enable `TemplateHaskell`.
99 * Deprecation: Deprecate static asset modules generated via 'obelisk-asset-manifest-generate' in favor of modules generated via 'obelisk-asset-th-generate'. The new executable takes the same arguments as the old and should be a drop-in replacement. To preserve the old behavior, set `__deprecated.useObeliskAssetManifestGenerate = true;` in your obelisk project configuration.
1010 * Feature: Files added to the static directory while `ob run` is active no longer require `ob run` to be restarted
11−* When `staticFiles` is a derivation, as opposed to a regular directory, produce a symlink to the result of that derivation at `static.out` and have `ob run` serve static assets from that symlink. This makes is possible for the static asset derivation to be rebuilt and the new results served without restarting `ob run`.
11+* Feature: When `staticFiles` is a derivation, as opposed to a regular directory, produce a symlink to the result of that derivation at `static.out` and have `ob run` serve static assets from that symlink. This makes is possible for the static asset derivation to be rebuilt and the new results served without restarting `ob run`.
12+* Feature: Rebuild static asset derivations while `ob run` is active as long as the change to the derivation is within the project folder. `ob run` now displays a message ("Static assets rebuilt and symlinked to static.out") whenever static assets have been rebuilt and the new static assets are being served.
1213
1314## v0.9.1.0
1415
lib/command/obelisk-command.cabal+3
@@ -20,6 +20,7 @@ library
2020 , exceptions
2121 , extra
2222 , filepath
23+ , fsnotify
2324 , git
2425 , github
2526 , here
@@ -39,6 +40,8 @@ library
3940 , optparse-applicative
4041 , placeholders
4142 , process
43+ , reflex
44+ , reflex-fsnotify
4245 , shell-escape
4346 , temporary
4447 , terminal-size
lib/command/src/Obelisk/Command/Project.hs+73−8
@@ -1,6 +1,9 @@
11{-# LANGUAGE FlexibleContexts #-}
22{-# LANGUAGE LambdaCase #-}
33{-# LANGUAGE OverloadedStrings #-}
4+{-# LANGUAGE ScopedTypeVariables #-}
5+{-# LANGUAGE TupleSections #-}
6+
47module Obelisk.Command.Project
58 ( InitSource (..)
69 , findProjectObeliskCommand
@@ -17,12 +20,16 @@ module Obelisk.Command.Project
1720 , withProjectRoot
1821 , bashEscape
1922 , getHaskellManifestProjectPath
23+ , AssetSource(..)
24+ , describeImpureAssetSource
25+ , watchStaticFilesDerivation
2026 ) where
2127
2228import Control.Concurrent.MVar (MVar, newMVar, withMVarMasked)
23−import Control.Lens ((.~), (?~), (<&>))
29+import Control.Lens ((.~), (?~), (<&>), (^.), _3)
2430import Control.Monad
2531import Control.Monad.IO.Class (liftIO)
32+import Control.Monad.Log
2633import Control.Monad.State
2734import qualified Data.Aeson as Json
2835import qualified Data.ByteString.UTF8 as BSU
@@ -35,14 +42,19 @@ import Data.Text (Text)
3542import qualified Data.Text as T
3643import Data.Text.Encoding (decodeUtf8, encodeUtf8)
3744import Data.Traversable (for)
45+import Reflex
46+import Reflex.FSNotify
47+import Reflex.Host.Headless
3848import System.Directory
3949import System.Environment (lookupEnv)
4050import System.FilePath
51+import System.FSNotify (defaultConfig)
4152import System.IO.Temp
4253import System.IO.Unsafe (unsafePerformIO)
4354import System.PosixCompat.Files
4455import System.PosixCompat.Types
4556import System.PosixCompat.User
57+import qualified System.Process as Proc
4658import Text.ShellEscape (bash, bytes)
4759
4860import GitHub.Data.GitData (Branch)
@@ -335,7 +347,21 @@ nixShellWithHoogle root isPure shell' command = do
335347 \})).project.shells.${shell}"
336348 & nixShellConfig_common . nixCmdConfig_args .~ [ strArg "shell" shell' ]
337349
338−findProjectAssets :: MonadObelisk m => FilePath -> m Text
350+-- | Describes the provenance of static assets (i.e., are they the result of a derivation
351+-- that was built, or just a folder full of files.
352+data AssetSource = AssetSource_Derivation
353+ | AssetSource_Files
354+ deriving (Eq)
355+
356+-- | Some log messages to make it easier to tell where static files are coming from
357+describeImpureAssetSource :: AssetSource -> Text -> Text
358+describeImpureAssetSource src path = case src of
359+ AssetSource_Files -> "Assets impurely loaded from: " <> path
360+ AssetSource_Derivation -> "Assets derivation built and impurely loaded from: " <> path
361+
362+-- | Determine where the static files of a project are and whether they're plain files or a derivation.
363+-- If they are a derivation, that derivation will be built.
364+findProjectAssets :: MonadObelisk m => FilePath -> m (AssetSource, Text)
339365findProjectAssets root = do
340366 isDerivation <- readProcessAndLogStderr Debug $ setCwd (Just root) $
341367 proc nixExePath
@@ -349,14 +375,13 @@ findProjectAssets root = do
349375 if isDerivation == "1"
350376 then do
351377 _ <- readProcessAndLogStderr Debug $ setCwd (Just root) $
352− proc nixBuildExePath
353− [ "-o", "static.out"
354− , "-E", "(import ./. {}).passthru.staticFilesImpure"
355− ]
356− pure $ T.pack $ root </> "static.out"
357− else readProcessAndLogStderr Debug $ setCwd (Just root) $
378+ proc nixBuildExePath staticFilesDrvSymlinkArgs
379+
380+ pure (AssetSource_Derivation, T.pack $ root </> "static.out")
381+ else fmap (AssetSource_Files,) $ readProcessAndLogStderr Debug $ setCwd (Just root) $
358382 proc nixExePath ["eval", "-f", ".", "passthru.staticFilesImpure", "--raw"]
359383
384+-- | Get the nix store path to the generated static asset manifest module (e.g., "obelisk-generated-static")
360385getHaskellManifestProjectPath :: MonadObelisk m => FilePath -> m Text
361386getHaskellManifestProjectPath root = fmap T.strip $ readProcessAndLogStderr Debug $ setCwd (Just root) $
362387 proc nixBuildExePath
@@ -364,3 +389,43 @@ getHaskellManifestProjectPath root = fmap T.strip $ readProcessAndLogStderr Debu
364389 , "-E"
365390 , "(let a = import ./. {}; in a.passthru.processedStatic.haskellManifest)"
366391 ]
392+
393+staticFilesDrvSymlinkArgs :: [String]
394+staticFilesDrvSymlinkArgs =
395+ [ "-o", "static.out"
396+ , "-E", "(import ./. {}).passthru.staticFilesImpure"
397+ ]
398+
399+-- | Watch the project directory for file changes and check whether those file changes
400+-- cause changes in the static files nix derivation. If so, rebuild it.
401+watchStaticFilesDerivation
402+ :: MonadObelisk m
403+ => FilePath
404+ -> m ()
405+watchStaticFilesDerivation root = do
406+ cfg <- getCliConfig
407+ drv0 <- liftIO runShowDrv
408+ liftIO $ runHeadlessApp $ do
409+ pb <- getPostBuild
410+ checkForChanges <- watchDirectoryTree defaultConfig (root <$ pb) (const True)
411+ drv <- performEvent $ liftIO runShowDrv <$ checkForChanges
412+ drvs <- foldDyn (\new (_, old, _) -> (old, new, old /= new)) (drv0, drv0, False) drv
413+ out <- throttleBatchWithLag
414+ (\e -> performEvent $ ffor e $ \_ -> liftIO $ void runDrvBuild)
415+ (void $ ffilter (^._3) $ updated drvs)
416+ performEvent_ $ ffor out $ \_ ->
417+ runCli cfg $
418+ putLog Informational "Static assets rebuilt and symlinked to static.out"
419+ pure never
420+ where
421+ showDrv :: Proc.CreateProcess
422+ showDrv = (Proc.proc nixExePath
423+ [ "show-derivation"
424+ , "-f", "."
425+ , "passthru.staticFilesImpure"
426+ ]) { Proc.cwd = Just root }
427+ runShowDrv :: IO String
428+ runShowDrv = Proc.readCreateProcess showDrv ""
429+ runDrvBuild :: IO String
430+ runDrvBuild = Proc.readCreateProcess
431+ ((Proc.proc nixBuildExePath staticFilesDrvSymlinkArgs) { Proc.cwd = Just root }) ""
lib/command/src/Obelisk/Command/Run.hs+17−7
@@ -14,7 +14,8 @@ module Obelisk.Command.Run where
1414import Control.Arrow ((&&&))
1515import Control.Exception (Exception, bracket)
1616import Control.Lens (ifor, (.~), (&))
17−import Control.Monad (filterM)
17+import Control.Concurrent (forkIO)
18+import Control.Monad (filterM, void)
1819import Control.Monad.Except (runExceptT, throwError)
1920import Control.Monad.IO.Class (liftIO)
2021import Control.Monad.Reader (MonadIO)
@@ -63,21 +64,23 @@ import System.FilePath
6364import qualified System.Info
6465import System.IO.Temp (withSystemTempDirectory)
6566
66−import Obelisk.App (MonadObelisk)
67+import Obelisk.App (MonadObelisk, getObelisk, runObelisk)
6768import Obelisk.CliApp (
6869 Severity (..),
6970 failWith,
71+ getCliConfig,
7072 proc,
7173 putLog,
7274 readCreateProcessWithExitCode,
7375 readProcessAndLogStderr,
76+ runCli,
7477 runProcess_,
7578 setCwd,
7679 setDelegateCtlc,
7780 withSpinner,
7881 )
7982import Obelisk.Command.Nix
80−import Obelisk.Command.Project (nixShellWithoutPkgs, withProjectRoot, findProjectAssets, bashEscape, getHaskellManifestProjectPath)
83+import Obelisk.Command.Project
8184import Obelisk.Command.Thunk (attrCacheFileName)
8285import Obelisk.Command.Utils (findExePath, ghcidExePath)
8386
@@ -144,8 +147,8 @@ profile profileBasePattern rtsFlags = withProjectRoot "." $ \root -> do
144147 , _target_attr = Just "__unstable__.profiledObRun"
145148 , _target_expr = Nothing
146149 }
147− assets <- findProjectAssets root
148− putLog Debug $ "Assets impurely loaded from: " <> assets
150+ (assetType, assets) <- findProjectAssets root
151+ putLog Debug $ describeImpureAssetSource assetType assets
149152 time <- liftIO getCurrentTime
150153 let profileBaseName = formatTime defaultTimeLocale profileBasePattern time
151154 liftIO $ createDirectoryIfMissing True $ takeDirectory $ root </> profileBaseName
@@ -163,9 +166,16 @@ profile profileBasePattern rtsFlags = withProjectRoot "." $ \root -> do
163166run :: MonadObelisk m => FilePath -> PathTree Interpret -> m ()
164167run root interpretPaths = do
165168 pkgs <- getParsedLocalPkgs root interpretPaths
166− assets <- findProjectAssets root
169+ (assetType, assets) <- findProjectAssets root
167170 manifestPkg <- parsePackagesOrFail . (:[]) . T.unpack =<< getHaskellManifestProjectPath root
168− putLog Debug $ "Assets impurely loaded from: " <> assets
171+ putLog Debug $ describeImpureAssetSource assetType assets
172+ case assetType of
173+ AssetSource_Derivation -> do
174+ cliConfig <- getCliConfig
175+ ob <- getObelisk
176+ putLog Debug "Starting static file derivation watcher..."
177+ void $ liftIO $ forkIO $ runCli cliConfig $ runObelisk ob $ watchStaticFilesDerivation root
178+ _ -> pure ()
169179 ghciArgs <- getGhciSessionSettings (pkgs <> manifestPkg) root True
170180 freePort <- getFreePort
171181 withGhciScriptArgs pkgs $ \dotGhciArgs -> do