@@ -5,58 +5,74 @@
5{-# LANGUAGE MultiWayIf #-}
5{-# LANGUAGE MultiWayIf #-}
6{-# LANGUAGE OverloadedStrings #-}
6{-# LANGUAGE OverloadedStrings #-}
7{-# LANGUAGE PatternGuards #-}
7{-# LANGUAGE PatternGuards #-}
8−{-# LANGUAGE QuasiQuotes #-}
9{-# LANGUAGE ScopedTypeVariables #-}
8{-# LANGUAGE ScopedTypeVariables #-}
10{-# LANGUAGE TypeApplications #-}
9{-# LANGUAGE TypeApplications #-}
11−module Obelisk.Command.Thunk where
10+module Obelisk.Command.Thunk
13+ , ReadThunkError (..)
16+ , ThunkPackConfig (..)
20+ , ThunkUpdateConfig (..)
22+ , createThunkWithLatest
27+ , nixBuildAttrWithCache
28+ , nixBuildThunkAttrWithCache
34+ , updateThunkToLatest
13import Control.Applicative
38import Control.Applicative
14import Control.Exception (displayException, try)
39import Control.Exception (displayException, try)
15−import Control.Lens (ifor, ifor_, (.~))
40+import qualified Control.Lens as Lens
41+import Control.Lens.Indexed hiding ((<.>))
16import Control.Monad
42import Control.Monad
17−import Control.Monad.Extra (findM)
43+import Control.Monad.Catch (handle)
18−import Control.Monad.Catch (MonadCatch, handle)
19import Control.Monad.Except
44import Control.Monad.Except
20import Data.Aeson ((.=))
45import Data.Aeson ((.=))
21import qualified Data.Aeson as Aeson
46import qualified Data.Aeson as Aeson
22import Data.Aeson.Encode.Pretty
47import Data.Aeson.Encode.Pretty
23import qualified Data.Aeson.Types as Aeson
48import qualified Data.Aeson.Types as Aeson
24−import Data.Bifunctor (first)
25import qualified Data.ByteString.Lazy as LBS
49import qualified Data.ByteString.Lazy as LBS
26−import Data.Containers.ListUtils (nubOrd)
27import Data.Default
50import Data.Default
28import Data.Either.Combinators (fromRight', rightToMaybe)
51import Data.Either.Combinators (fromRight', rightToMaybe)
29−import Data.Foldable (toList)
30−import Data.Function ((&))
31−import Data.Functor ((<&>))
32import Data.Git.Ref (Ref)
52import Data.Git.Ref (Ref)
33import qualified Data.Git.Ref as Ref
53import qualified Data.Git.Ref as Ref
34import qualified Data.List as L
54import qualified Data.List as L
35−import Data.List.NonEmpty (NonEmpty (..), nonEmpty)
55+import Data.List.NonEmpty (NonEmpty (..))
36import qualified Data.List.NonEmpty as NonEmpty
56import qualified Data.List.NonEmpty as NonEmpty
37import Data.Map (Map)
57import Data.Map (Map)
38import qualified Data.Map as Map
58import qualified Data.Map as Map
39import Data.Maybe
59import Data.Maybe
40import Data.Set (Set)
60import Data.Set (Set)
41import qualified Data.Set as Set
61import qualified Data.Set as Set
42−import Data.String.Here.Interpolated (i)
43−import Data.String.Here.Uninterpolated (here)
44import Data.Text (Text)
62import Data.Text (Text)
45import qualified Data.Text as T
63import qualified Data.Text as T
46import Data.Text.Encoding
64import Data.Text.Encoding
47import qualified Data.Text.IO as T
65import qualified Data.Text.IO as T
48import Data.Time.Clock.POSIX (posixSecondsToUTCTime)
66import Data.Time.Clock.POSIX (posixSecondsToUTCTime)
49−import Data.Traversable (for)
50import Data.Yaml (parseMaybe)
67import Data.Yaml (parseMaybe)
51import GitHub
68import GitHub
52import GitHub.Data.Name
69import GitHub.Data.Name
53import Obelisk.Command.Nix
70import Obelisk.Command.Nix
54import System.Directory
71import System.Directory
56import System.FilePath
72import System.FilePath
57import System.IO.Error
73import System.IO.Error
58import System.IO.Temp
74import System.IO.Temp
59−import System.PosixCompat.Files (getSymbolicLinkStatus, modificationTime)
75+import System.Posix (getSymbolicLinkStatus, modificationTime)
60import qualified Text.URI as URI
76import qualified Text.URI as URI
62import Obelisk.App (MonadObelisk)
78import Obelisk.App (MonadObelisk)
@@ -65,10 +81,11 @@ import Obelisk.Command.Utils
66--TODO: Support symlinked thunk data
82--TODO: Support symlinked thunk data
67data ThunkData
83data ThunkData
68− = ThunkData_Packed ThunkSpec ThunkPtr
84+ = ThunkData_Packed ThunkPtr
69 -- ^ Packed thunk
85 -- ^ Packed thunk
70− | ThunkData_Checkout
86+ | ThunkData_Checkout (Maybe ThunkPtr)
71 -- ^ Checked out thunk that was unpacked from this pointer
87 -- ^ Checked out thunk that was unpacked from this pointer
88+ deriving (Show, Eq, Ord)
73-- | A reference to the exact data that a thunk should translate into
90-- | A reference to the exact data that a thunk should translate into
74data ThunkPtr = ThunkPtr
91data ThunkPtr = ThunkPtr
@@ -94,11 +111,6 @@ data ThunkSource
94 | ThunkSource_Git GitSource
111 | ThunkSource_Git GitSource
95 deriving (Show, Eq, Ord)
112 deriving (Show, Eq, Ord)
97−thunkSourceToGitSource :: ThunkSource -> GitSource
98−thunkSourceToGitSource = \case
99− ThunkSource_GitHub s -> forgetGithub False s
100− ThunkSource_Git s -> s
102data GitHubSource = GitHubSource
114data GitHubSource = GitHubSource
103 { _gitHubSource_owner :: Name Owner
115 { _gitHubSource_owner :: Name Owner
104 , _gitHubSource_repo :: Name Repo
116 , _gitHubSource_repo :: Name Repo
@@ -107,7 +119,7 @@ data GitHubSource = GitHubSource
108 deriving (Show, Eq, Ord)
120 deriving (Show, Eq, Ord)
110−newtype GitUri = GitUri { unGitUri :: URI.URI } deriving (Eq, Ord, Show)
122+newtype GitUri = GitUri URI.URI deriving (Eq, Ord, Show)
112gitUriToText :: GitUri -> Text
124gitUriToText :: GitUri -> Text
113gitUriToText (GitUri uri)
125gitUriToText (GitUri uri)
@@ -178,14 +190,14 @@ getNixSha256ForUriUnpacked
178getNixSha256ForUriUnpacked uri =
190getNixSha256ForUriUnpacked uri =
179 withExitFailMessage ("nix-prefetch-url: Failed to determine sha256 hash of URL " <> gitUriToText uri) $ do
191 withExitFailMessage ("nix-prefetch-url: Failed to determine sha256 hash of URL " <> gitUriToText uri) $ do
180 [hash] <- fmap T.lines $ readProcessAndLogOutput (Debug, Debug) $
192 [hash] <- fmap T.lines $ readProcessAndLogOutput (Debug, Debug) $
181− proc nixPrefetchUrlPath ["--unpack", "--type", "sha256", T.unpack $ gitUriToText uri]
193+ proc "nix-prefetch-url" ["--unpack", "--type", "sha256", T.unpack $ gitUriToText uri]
182 pure hash
194 pure hash
184nixPrefetchGit :: MonadObelisk m => GitUri -> Text -> Bool -> m NixSha256
196nixPrefetchGit :: MonadObelisk m => GitUri -> Text -> Bool -> m NixSha256
185nixPrefetchGit uri rev fetchSubmodules =
197nixPrefetchGit uri rev fetchSubmodules =
186 withExitFailMessage ("nix-prefetch-git: Failed to determine sha256 hash of Git repo " <> gitUriToText uri <> " at " <> rev) $ do
198 withExitFailMessage ("nix-prefetch-git: Failed to determine sha256 hash of Git repo " <> gitUriToText uri <> " at " <> rev) $ do
187 out <- readProcessAndLogStderr Debug $
199 out <- readProcessAndLogStderr Debug $
188− proc nixPrefetchGitPath $ filter (/="")
200+ proc "nix-prefetch-git" $ filter (/="")
189 [ "--url", T.unpack $ gitUriToText uri
201 [ "--url", T.unpack $ gitUriToText uri
190 , "--rev", T.unpack rev
202 , "--rev", T.unpack rev
191 , if fetchSubmodules then "--fetch-submodules" else ""
203 , if fetchSubmodules then "--fetch-submodules" else ""
@@ -198,117 +210,93 @@ nixPrefetchGit uri rev fetchSubmodules =
199--TODO: Pretty print these
211--TODO: Pretty print these
200data ReadThunkError
212data ReadThunkError
201− = ReadThunkError_UnrecognizedThunk
213+ = ReadThunkError_UnrecognizedFiles
202− | ReadThunkError_UnrecognizedPaths (NonEmpty FilePath)
214+ | ReadThunkError_AmbiguousFiles
203− | ReadThunkError_MissingPaths (NonEmpty FilePath)
215+ | ReadThunkError_UnrecognizedLoader Text
204− | ReadThunkError_UnparseablePtr FilePath String
216+ | ReadThunkError_UnparseablePtr LBS.ByteString
205− | ReadThunkError_FileError IOError
206− | ReadThunkError_FileDoesNotMatch FilePath Text
207− | ReadThunkError_UnrecognizedState String
208− | ReadThunkError_AmbiguousPackedState ThunkPtr ThunkPtr
209− deriving (Show)
217+ deriving (Show)
211−unpackedDirName :: FilePath
219+-- | Read a thunk and validate that it is only a thunk, either packed or unpacked.
212−unpackedDirName = "."
220+-- If the thunk is packed and additional data is present, fail.
213−
221+readThunk :: MonadObelisk m => FilePath -> m (Either ReadThunkError ThunkData)
214−attrCacheFileName :: FilePath
222+readThunk thunkDir = do
215−attrCacheFileName = ".attr-cache"
223+ files <- liftIO $ listDirectory thunkDir
216−
224+ case ".git" `elem` files of
217−-- | Specification for how a file in a thunk version works.
225+ True -> fmap ThunkData_Checkout <$> do
218−data ThunkFileSpec
226+ let origThunkPath = thunkDir </> ".git" </> "obelisk" </> "orig-thunk"
219− = ThunkFileSpec_Ptr (LBS.ByteString -> Either String ThunkPtr) -- ^ This file specifies 'ThunkPtr' data
227+ liftIO $ doesDirectoryExist origThunkPath >>= \case
220− | ThunkFileSpec_FileMatches Text -- ^ This file must match the given content exactly
228+ True -> fmap Just <$> readPackedThunk origThunkPath
221− | ThunkFileSpec_CheckoutIndicator -- ^ Existence of this directory indicates that the thunk is unpacked
229+ False -> return $ return Nothing
222− | ThunkFileSpec_AttrCache -- ^ This directory is an attribute cache
230+ False -> liftIO $ fmap ThunkData_Packed <$> readPackedThunk thunkDir
224−-- | Specification for how a set of files in a thunk version work.
232+data ThunkType = ThunkType
225−data ThunkSpec = ThunkSpec
233+ { _thunkType_loader :: FilePath
226− { _thunkSpec_name :: !Text
234+ , _thunkType_json :: FilePath
227− , _thunkSpec_files :: !(Map FilePath ThunkFileSpec)
235+ , _thunkType_optional :: Set FilePath
236+ , _thunkType_loaderVersions :: NonEmpty Text
237+ , _thunkType_parser :: Aeson.Object -> Aeson.Parser ThunkPtr
230−thunkSpecTypes :: NonEmpty (NonEmpty ThunkSpec)
240+gitHubThunkType :: ThunkType
231−thunkSpecTypes = gitThunkSpecs :| [gitHubThunkSpecs]
241+gitHubThunkType = ThunkType
232−
242+ { _thunkType_loader = "default.nix"
233−-- | Attempts to match a 'ThunkSpec' to a given directory.
243+ , _thunkType_json = "github.json"
234−matchThunkSpecToDir
244+ , _thunkType_optional = Set.fromList [".attr-cache"]
235− :: (MonadError ReadThunkError m, MonadIO m, MonadCatch m)
245+ , _thunkType_loaderVersions = gitHubStandaloneLoaders
236− => ThunkSpec -- ^ 'ThunkSpec' to match against the given files/directory
246+ , _thunkType_parser = parseThunkPtr $ \v ->
237− -> FilePath -- ^ Path to directory
247+ ThunkSource_GitHub <$> parseGitHubSource v <|> ThunkSource_Git <$> parseGitSource v
238− -> Set FilePath -- ^ Set of file paths relative to the given directory
248+ }
240−matchThunkSpecToDir thunkSpec dir dirFiles = do
250+gitThunkType :: ThunkType
241− case nonEmpty (toList $ dirFiles `Set.difference` expectedPaths) of
251+gitThunkType = ThunkType
242− Just fs -> throwError $ ReadThunkError_UnrecognizedPaths $ (dir </>) <$> fs
252+ { _thunkType_loader = "default.nix"
243− Nothing -> pure ()
253+ , _thunkType_json = "git.json"
244− case nonEmpty (toList $ requiredPaths `Set.difference` dirFiles) of
254+ , _thunkType_optional = Set.fromList [".attr-cache"]
245− Just fs -> throwError $ ReadThunkError_MissingPaths $ (dir </>) <$> fs
255+ , _thunkType_loaderVersions = plainGitStandaloneLoaders
246− Nothing -> pure ()
256+ , _thunkType_parser = parseThunkPtr $ fmap ThunkSource_Git . parseGitSource
247− datas <- fmap toList $ flip Map.traverseMaybeWithKey (_thunkSpec_files thunkSpec) $ \expectedPath -> \case
257+ }
248− ThunkFileSpec_AttrCache -> Nothing <$ dirMayExist expectedPath
258+
249− ThunkFileSpec_CheckoutIndicator -> liftIO (doesDirectoryExist (dir </> expectedPath)) <&> \case
259+thunkTypes :: [ThunkType]
250− False -> Nothing
260+thunkTypes = [gitThunkType, gitHubThunkType]
251− True -> Just ThunkData_Checkout
261+
252− ThunkFileSpec_FileMatches expectedContents -> handle (\(e :: IOError) -> throwError $ ReadThunkError_FileError e) $ do
262+findThunkType :: [ThunkType] -> FilePath -> IO (Either ReadThunkError ThunkType)
253− actualContents <- liftIO (T.readFile $ dir </> expectedPath)
263+findThunkType types thunkDir = do
254− case T.strip expectedContents == T.strip actualContents of
264+ matches <- fmap catMaybes $ forM types $ \thunkType -> do
255− True -> pure Nothing
265+ let
256− False -> throwError $ ReadThunkError_FileDoesNotMatch (dir </> expectedPath) expectedContents
266+ expectedContents = Set.fromList $ (thunkDir </>) <$>
257− ThunkFileSpec_Ptr parser -> handle (\(e :: IOError) -> throwError $ ReadThunkError_FileError e) $ do
267+ [ _thunkType_loader thunkType
258− let path = dir </> expectedPath
268+ , _thunkType_json thunkType
259− liftIO (doesFileExist path) >>= \case
269+ ]
260− False -> pure Nothing
270+ optionalContents = Set.map (thunkDir </>) (_thunkType_optional thunkType)
262− actualContents <- liftIO $ LBS.readFile path
272+ -- Ensure that there aren't any other files in the thunk
263− case parser actualContents of
273+ -- NB: System.Directory.listDirectory returns the contents without the directory path
264− Right v -> pure $ Just (ThunkData_Packed thunkSpec v)
274+ files <- liftIO $ Set.fromList . fmap (thunkDir </>) <$> listDirectory thunkDir
265− Left e -> throwError $ ReadThunkError_UnparseablePtr (dir </> expectedPath) e
275+ let unexpectedContents = files `Set.difference` (expectedContents `Set.union` optionalContents)
266−
276+ missingContents = expectedContents `Set.difference` files
267− case nonEmpty datas of
277+ pure $ if Set.null unexpectedContents && Set.null missingContents
268− Nothing -> throwError ReadThunkError_UnrecognizedThunk
278+ then Just thunkType
269− Just xs -> fold1WithM xs $ \a b -> either throwError pure (mergeThunkData a b)
279+ else Nothing
271− rootPathsOnly = Set.fromList . mapMaybe takeRootDir . Map.keys
281+ pure $ case matches of
272− takeRootDir = fmap NonEmpty.head . nonEmpty . splitPath
282+ [singleMatch] -> Right singleMatch
273−
283+ [] -> Left ReadThunkError_UnrecognizedFiles
274− expectedPaths = rootPathsOnly $ _thunkSpec_files thunkSpec
284+ _ -> Left ReadThunkError_AmbiguousFiles
276− requiredPaths = rootPathsOnly $ Map.filter isRequiredFileSpec $ _thunkSpec_files thunkSpec
277− isRequiredFileSpec = \case
278− ThunkFileSpec_FileMatches _ -> True
281− dirMayExist expectedPath = liftIO (doesFileExist (dir </> expectedPath)) >>= \case
282− True -> throwError $ ReadThunkError_UnrecognizedPaths $ expectedPath :| []
285− -- Combine 'ThunkData' from different files, preferring "Checkout" over "Packed"
286− mergeThunkData ThunkData_Checkout ThunkData_Checkout = Right ThunkData_Checkout
287− mergeThunkData ThunkData_Checkout ThunkData_Packed{} = Left bothPackedAndUnpacked
288− mergeThunkData ThunkData_Packed{} ThunkData_Checkout = Left bothPackedAndUnpacked
289− mergeThunkData a@(ThunkData_Packed _ ptrA) (ThunkData_Packed _ ptrB) =
290− if ptrA == ptrB then Right a else Left $ ReadThunkError_AmbiguousPackedState ptrA ptrB
292− bothPackedAndUnpacked = ReadThunkError_UnrecognizedState "Both packed data and checkout present"
294− fold1WithM (x :| xs) f = foldM f x xs
298− => NonEmpty (NonEmpty ThunkSpec) -> FilePath -> m (Either ReadThunkError ThunkData)
299−readThunkWith specTypes dir = do
300− dirFiles <- Set.fromList <$> liftIO (listDirectory dir)
301− let specs = concatMap toList $ toList $ NonEmpty.transpose specTypes -- Interleave spec types so we try each one in a "fair" ordering
302− flip fix specs $ \loop -> \case
303− [] -> pure $ Left ReadThunkError_UnrecognizedThunk
304− spec:rest -> runExceptT (matchThunkSpecToDir spec dir dirFiles) >>= \case
305− Left e -> putLog Debug [i|Thunk specification ${_thunkSpec_name spec} did not match ${dir}: ${e}|] *> loop rest
306− x@(Right _) -> x <$ putLog Debug [i|Thunk specification ${_thunkSpec_name spec} matched ${dir}|]
308-- | Read a thunk and validate that it is exactly a packed thunk.
286-- | Read a thunk and validate that it is exactly a packed thunk.
309-- If additional data is present, fail.
287-- If additional data is present, fail.
310−readThunk :: (MonadObelisk m) => FilePath -> m (Either ReadThunkError ThunkData)
288+readPackedThunk :: FilePath -> IO (Either ReadThunkError ThunkPtr)
311−readThunk = readThunkWith thunkSpecTypes
289+readPackedThunk thunkDir = runExceptT $ do
290+ thunkType <- ExceptT $ findThunkType thunkTypes thunkDir
291+ -- Ensure that we recognize the thunk loader
292+ loader <- liftIO $ T.readFile $ thunkDir </> _thunkType_loader thunkType
293+ unless (loader `elem` _thunkType_loaderVersions thunkType) $ do
294+ throwError $ ReadThunkError_UnrecognizedLoader loader
296+ txt <- liftIO $ LBS.readFile $ thunkDir </> _thunkType_json thunkType
297+ case parseMaybe (_thunkType_parser thunkType) =<< Aeson.decode txt of
298+ Nothing -> throwError $ ReadThunkError_UnparseablePtr txt
299+ Just ptr -> return ptr
313parseThunkPtr :: (Aeson.Object -> Aeson.Parser ThunkSource) -> Aeson.Object -> Aeson.Parser ThunkPtr
301parseThunkPtr :: (Aeson.Object -> Aeson.Parser ThunkSource) -> Aeson.Object -> Aeson.Parser ThunkPtr
314parseThunkPtr parseSrc v = do
302parseThunkPtr parseSrc v = do
@@ -352,18 +340,16 @@ parseGitSource v = do
352overwriteThunk :: MonadObelisk m => FilePath -> ThunkPtr -> m ()
340overwriteThunk :: MonadObelisk m => FilePath -> ThunkPtr -> m ()
353overwriteThunk target thunk = do
341overwriteThunk target thunk = do
354 -- Ensure that this directory is a valid thunk (i.e. so we aren't losing any data)
342 -- Ensure that this directory is a valid thunk (i.e. so we aren't losing any data)
355− readThunk target >>= \case
343+ Right _ <- readThunk target
356− Left e -> failWith [i|Invalid thunk at ${target}: ${e}|]
359 --TODO: Is there a safer way to do this overwriting?
345 --TODO: Is there a safer way to do this overwriting?
360− liftIO $ removePathForcibly target
346+ liftIO $ removeDirectoryRecursive target
361− createThunk target $ Right thunk
347+ liftIO $ createThunk target thunk
363−thunkPtrToSpec :: ThunkPtr -> ThunkSpec
349+thunkPtrLoader :: ThunkPtr -> Text
364−thunkPtrToSpec thunk = case _thunkPtr_source thunk of
350+thunkPtrLoader thunk = case _thunkPtr_source thunk of
365− ThunkSource_GitHub _ -> NonEmpty.head gitHubThunkSpecs
351+ ThunkSource_GitHub _ -> NonEmpty.head gitHubStandaloneLoaders
366− ThunkSource_Git _ -> NonEmpty.head gitThunkSpecs
352+ ThunkSource_Git _ -> NonEmpty.head plainGitStandaloneLoaders
368-- It's important that formatting be very consistent here, because
354-- It's important that formatting be very consistent here, because
369-- otherwise when people update thunks, their patches will be messy
355-- otherwise when people update thunks, their patches will be messy
@@ -410,41 +396,35 @@ encodeThunkPtrData (ThunkPtr rev src) = case src of
410 , confTrailingNewline = True
396 , confTrailingNewline = True
413−createThunk :: MonadObelisk m => FilePath -> Either ThunkSpec ThunkPtr -> m ()
399+createThunk :: MonadIO m => FilePath -> ThunkPtr -> m ()
414−createThunk target ptrInfo =
400+createThunk target thunk = liftIO $ do
415− ifor_ (_thunkSpec_files spec) $ \path -> \case
416− ThunkFileSpec_FileMatches content -> withReadyPath path $ \p -> liftIO $ T.writeFile p content
417− ThunkFileSpec_Ptr _ -> case ptrInfo of
418− Left _ -> pure () -- We can't write the ptr without it
419− Right ptr -> withReadyPath path $ \p -> liftIO $ LBS.writeFile p (encodeThunkPtrData ptr)
422− spec = either id thunkPtrToSpec ptrInfo
423− withReadyPath path f = do
424− let fullPath = target </> path
425− putLog Debug $ "Writing thunk file " <> T.pack fullPath
426− liftIO $ createDirectoryIfMissing True $ takeDirectory fullPath
401+ createDirectoryIfMissing True (target </> ".attr-cache")
427− f fullPath
402+ T.writeFile (target </> "default.nix") (thunkPtrLoader thunk)
404+ jsonFileName = case _thunkPtr_source thunk of
405+ ThunkSource_GitHub _ -> "github"
406+ ThunkSource_Git _ -> "git"
407+ LBS.writeFile (target </> jsonFileName <.> "json") (encodeThunkPtrData thunk)
429createThunkWithLatest :: MonadObelisk m => FilePath -> ThunkSource -> m ()
409createThunkWithLatest :: MonadObelisk m => FilePath -> ThunkSource -> m ()
430createThunkWithLatest target s = do
410createThunkWithLatest target s = do
431 rev <- getLatestRev s
411 rev <- getLatestRev s
432− createThunk target $ Right $ ThunkPtr
412+ createThunk target $ ThunkPtr
433 { _thunkPtr_source = s
413 { _thunkPtr_source = s
434 , _thunkPtr_rev = rev
414 , _thunkPtr_rev = rev
437updateThunkToLatest :: MonadObelisk m => ThunkUpdateConfig -> FilePath -> m ()
417updateThunkToLatest :: MonadObelisk m => ThunkUpdateConfig -> FilePath -> m ()
438−updateThunkToLatest (ThunkUpdateConfig mBranch thunkConfig) target = spinner $ do
418+updateThunkToLatest (ThunkUpdateConfig mBranch thunkConfig) target = withSpinner' ("Updating thunk " <> T.pack target <> " to latest") (pure $ const $ "Thunk " <> T.pack target <> " updated to latest") $ do
439− checkThunkDirectory target
419+ checkThunkDirectory "ob thunk update directory cannot be '.'" target
440 -- check to see if thunk should be updated to a specific branch or just update it's current branch
420 -- check to see if thunk should be updated to a specific branch or just update it's current branch
441 case mBranch of
421 case mBranch of
442 Nothing -> do
422 Nothing -> do
443 (overwrite, ptr) <- readThunk target >>= \case
423 (overwrite, ptr) <- readThunk target >>= \case
444− Left err -> failWith [i|Thunk update: ${err}|]
424+ Left err -> failWith $ T.pack $ "thunk update: " <> show err
445 Right c -> case c of
425 Right c -> case c of
446− ThunkData_Packed _ t -> return (target, t)
426+ ThunkData_Packed t -> return (target, t)
447− ThunkData_Checkout -> failWith "cannot update an unpacked thunk"
427+ ThunkData_Checkout _ -> failWith "cannot update an unpacked thunk"
448 let src = _thunkPtr_source ptr
428 let src = _thunkPtr_source ptr
449 rev <- getLatestRev src
429 rev <- getLatestRev src
450 overwriteThunk overwrite $ modifyThunkPtrByConfig thunkConfig $ ThunkPtr
430 overwriteThunk overwrite $ modifyThunkPtrByConfig thunkConfig $ ThunkPtr
@@ -452,36 +432,38 @@ updateThunkToLatest (ThunkUpdateConfig mBranch thunkConfig) target = spinner $ d
452 , _thunkPtr_rev = rev
432 , _thunkPtr_rev = rev
454 Just branch -> readThunk target >>= \case
434 Just branch -> readThunk target >>= \case
455− Left err -> failWith [i|Thunk update: ${err}|]
435+ Left err -> failWith $ T.pack $ "thunk update: " <> show err
456 Right c -> case c of
436 Right c -> case c of
457− ThunkData_Packed _ t -> setThunk thunkConfig target (thunkSourceToGitSource $ _thunkPtr_source t) branch
437+ ThunkData_Packed t -> case _thunkPtr_source t of
438+ ThunkSource_Git tsg -> setThunk thunkConfig target tsg branch
439+ ThunkSource_GitHub tsgh -> do
440+ let tsg = forgetGithub False tsgh
441+ setThunk thunkConfig target tsg branch
458− ThunkData_Checkout -> failWith [i|Thunk located at ${target} is unpacked. Use 'ob thunk pack' on the desired directory and then try 'ob thunk update' again.|]
442+ ThunkData_Checkout _ -> failWith $ T.pack $ "thunk located at " <> show target <> " is unpacked. Use ob thunk pack on the desired directory and then try ob thunk update again."
460− spinner = withSpinner' ("Updating thunk " <> T.pack target <> " to latest") (pure $ const $ "Thunk " <> T.pack target <> " updated to latest")
462setThunk :: MonadObelisk m => ThunkConfig -> FilePath -> GitSource -> String -> m ()
444setThunk :: MonadObelisk m => ThunkConfig -> FilePath -> GitSource -> String -> m ()
463setThunk thunkConfig target gs branch = do
445setThunk thunkConfig target gs branch = do
464− newThunkPtr <- uriThunkPtr (_gitSource_url gs) (_thunkConfig_private thunkConfig) (Just $ T.pack branch) Nothing
446+ newThunkPtr <- uriThunkPtr (_gitSource_url gs) (Just $ T.pack branch) Nothing
465 overwriteThunk target newThunkPtr
447 overwriteThunk target newThunkPtr
466 updateThunkToLatest (ThunkUpdateConfig Nothing thunkConfig) target
448 updateThunkToLatest (ThunkUpdateConfig Nothing thunkConfig) target
468-- | All recognized github standalone loaders, ordered from newest to oldest.
450-- | All recognized github standalone loaders, ordered from newest to oldest.
469-- This tool will only ever produce the newest one when it writes a thunk.
451-- This tool will only ever produce the newest one when it writes a thunk.
470−gitHubThunkSpecs :: NonEmpty ThunkSpec
452+gitHubStandaloneLoaders :: NonEmpty Text
471−gitHubThunkSpecs =
453+gitHubStandaloneLoaders =
472− gitHubThunkSpecV5 :|
454+ gitHubStandaloneLoaderV4 :|
473− [ gitHubThunkSpecV4
455+ [ gitHubStandaloneLoaderV3
474− , gitHubThunkSpecV3
456+ , gitHubStandaloneLoaderV2
475− , gitHubThunkSpecV2
457+ , gitHubStandaloneLoaderV1
479−gitHubThunkSpecV1 :: ThunkSpec
460+gitHubStandaloneLoaderV1 :: Text
480−gitHubThunkSpecV1 = legacyGitHubThunkSpec "github-v1"
461+gitHubStandaloneLoaderV1 = T.unlines
481− "import ((import <nixpkgs> {}).fetchFromGitHub (builtins.fromJSON (builtins.readFile ./github.json)))"
462+ [ "import ((import <nixpkgs> {}).fetchFromGitHub (builtins.fromJSON (builtins.readFile ./github.json)))"
483−gitHubThunkSpecV2 :: ThunkSpec
465+gitHubStandaloneLoaderV2 :: Text
484−gitHubThunkSpecV2 = legacyGitHubThunkSpec "github-v2" $ T.unlines
466+gitHubStandaloneLoaderV2 = T.unlines
485 [ "# DO NOT HAND-EDIT THIS FILE" --TODO: Add something about how to get more info on Obelisk, etc.
467 [ "# DO NOT HAND-EDIT THIS FILE" --TODO: Add something about how to get more info on Obelisk, etc.
486 , "import ((import <nixpkgs> {}).fetchFromGitHub ("
468 , "import ((import <nixpkgs> {}).fetchFromGitHub ("
487 , " let json = builtins.fromJSON (builtins.readFile ./github.json);"
469 , " let json = builtins.fromJSON (builtins.readFile ./github.json);"
@@ -491,8 +473,8 @@ gitHubThunkSpecV2 = legacyGitHubThunkSpec "github-v2" $ T.unlines
494−gitHubThunkSpecV3 :: ThunkSpec
476+gitHubStandaloneLoaderV3 :: Text
495−gitHubThunkSpecV3 = legacyGitHubThunkSpec "github-v3" $ T.unlines
477+gitHubStandaloneLoaderV3 = T.unlines
496 [ "# DO NOT HAND-EDIT THIS FILE"
478 [ "# DO NOT HAND-EDIT THIS FILE"
498 , " fetch = { private ? false, ... }@args: if private && builtins.hasAttr \"fetchGit\" builtins"
480 , " fetch = { private ? false, ... }@args: if private && builtins.hasAttr \"fetchGit\" builtins"
@@ -511,8 +493,8 @@ gitHubThunkSpecV3 = legacyGitHubThunkSpec "github-v3" $ T.unlines
511 , "in import (fetch (builtins.fromJSON (builtins.readFile ./github.json)))"
493 , "in import (fetch (builtins.fromJSON (builtins.readFile ./github.json)))"
514−gitHubThunkSpecV4 :: ThunkSpec
496+gitHubStandaloneLoaderV4 :: Text
515−gitHubThunkSpecV4 = legacyGitHubThunkSpec "github-v4" $ T.unlines
497+gitHubStandaloneLoaderV4 = T.unlines
516 [ "# DO NOT HAND-EDIT THIS FILE"
498 [ "# DO NOT HAND-EDIT THIS FILE"
517 , "let fetch = { private ? false, fetchSubmodules ? false, owner, repo, rev, sha256, ... }:"
499 , "let fetch = { private ? false, fetchSubmodules ? false, owner, repo, rev, sha256, ... }:"
518 , " if !fetchSubmodules && !private then builtins.fetchTarball {"
500 , " if !fetchSubmodules && !private then builtins.fetchTarball {"
@@ -523,50 +505,23 @@ gitHubThunkSpecV4 = legacyGitHubThunkSpec "github-v4" $ T.unlines
523 , "in import (fetch (builtins.fromJSON (builtins.readFile ./github.json)))"
505 , "in import (fetch (builtins.fromJSON (builtins.readFile ./github.json)))"
526−legacyGitHubThunkSpec :: Text -> Text -> ThunkSpec
508+plainGitStandaloneLoaders :: NonEmpty Text
527−legacyGitHubThunkSpec name loader = ThunkSpec name $ Map.fromList
509+plainGitStandaloneLoaders =
528− [ ("default.nix", ThunkFileSpec_FileMatches $ T.strip loader)
510+ plainGitStandaloneLoaderV3 :|
529− , ("github.json" , ThunkFileSpec_Ptr parseGitHubJsonBytes)
511+ [ plainGitStandaloneLoaderV1
530− , (attrCacheFileName, ThunkFileSpec_AttrCache)
512+ , plainGitStandaloneLoaderV2
531− , (".git", ThunkFileSpec_CheckoutIndicator)
534−gitHubThunkSpecV5 :: ThunkSpec
535−gitHubThunkSpecV5 = mkThunkSpec "github-v5" "github.json" parseGitHubJsonBytes [here|
536−# DO NOT HAND-EDIT THIS FILE
537−let fetch = { private ? false, fetchSubmodules ? false, owner, repo, rev, sha256, ... }:
538− if !fetchSubmodules && !private then builtins.fetchTarball {
539− url = "https://github.com/${owner}/${repo}/archive/${rev}.tar.gz"; inherit sha256;
540− } else (import <nixpkgs> {}).fetchFromGitHub {
541− inherit owner repo rev sha256 fetchSubmodules private;
543− json = builtins.fromJSON (builtins.readFile ./github.json);
547−parseGitHubJsonBytes :: LBS.ByteString -> Either String ThunkPtr
548−parseGitHubJsonBytes = parseJsonObject $ parseThunkPtr $ \v ->
549− ThunkSource_GitHub <$> parseGitHubSource v <|> ThunkSource_Git <$> parseGitSource v
551−gitThunkSpecs :: NonEmpty ThunkSpec
560−gitThunkSpecV1 :: ThunkSpec
515+plainGitStandaloneLoaderV1 :: Text
561−gitThunkSpecV1 = legacyGitThunkSpec "git-v1" $ T.unlines
516+plainGitStandaloneLoaderV1 = T.unlines
562 [ "# DO NOT HAND-EDIT THIS FILE"
517 [ "# DO NOT HAND-EDIT THIS FILE"
563 , "let fetchGit = {url, rev, ref ? null, branch ? null, sha256 ? null, fetchSubmodules ? null}:"
518 , "let fetchGit = {url, rev, ref ? null, branch ? null, sha256 ? null, fetchSubmodules ? null}:"
564 , " assert !fetchSubmodules; (import <nixpkgs> {}).fetchgit { inherit url rev sha256; };"
519 , " assert !fetchSubmodules; (import <nixpkgs> {}).fetchgit { inherit url rev sha256; };"
565 , "in import (fetchGit (builtins.fromJSON (builtins.readFile ./git.json)))"
520 , "in import (fetchGit (builtins.fromJSON (builtins.readFile ./git.json)))"
568−gitThunkSpecV2 :: ThunkSpec
523+plainGitStandaloneLoaderV2 :: Text
569−gitThunkSpecV2 = legacyGitThunkSpec "git-v2" $ T.unlines
524+plainGitStandaloneLoaderV2 = T.unlines
570 [ "# DO NOT HAND-EDIT THIS FILE"
525 [ "# DO NOT HAND-EDIT THIS FILE"
571 , "let fetchGit = {url, rev, ref ? null, branch ? null, sha256 ? null, fetchSubmodules ? null}:"
526 , "let fetchGit = {url, rev, ref ? null, branch ? null, sha256 ? null, fetchSubmodules ? null}:"
572 , " if builtins.hasAttr \"fetchGit\" builtins"
527 , " if builtins.hasAttr \"fetchGit\" builtins"
@@ -575,10 +530,8 @@ gitThunkSpecV2 = legacyGitThunkSpec "git-v2" $ T.unlines
575 , "in import (fetchGit (builtins.fromJSON (builtins.readFile ./git.json)))"
530 , "in import (fetchGit (builtins.fromJSON (builtins.readFile ./git.json)))"
578−-- This loader has a bug because @builtins.fetchGit@ is not given a @ref@
533+plainGitStandaloneLoaderV3 :: Text
579−-- and will fail to find commits without this because it does shallow clones.
534+plainGitStandaloneLoaderV3 = T.unlines
580−gitThunkSpecV3 :: ThunkSpec
581−gitThunkSpecV3 = legacyGitThunkSpec "git-v3" $ T.unlines
582 [ "# DO NOT HAND-EDIT THIS FILE"
535 [ "# DO NOT HAND-EDIT THIS FILE"
583 , "let fetch = {url, rev, ref ? null, sha256 ? null, fetchSubmodules ? false, private ? false, ...}:"
536 , "let fetch = {url, rev, ref ? null, sha256 ? null, fetchSubmodules ? false, private ? false, ...}:"
584 , " let realUrl = let firstChar = builtins.substring 0 1 url; in"
537 , " let realUrl = let firstChar = builtins.substring 0 1 url; in"
@@ -593,69 +546,10 @@ gitThunkSpecV3 = legacyGitThunkSpec "git-v3" $ T.unlines
593 , "in import (fetch (builtins.fromJSON (builtins.readFile ./git.json)))"
546 , "in import (fetch (builtins.fromJSON (builtins.readFile ./git.json)))"
596−gitThunkSpecV4 :: ThunkSpec
549+thunkFileNames :: [FilePath]
597−gitThunkSpecV4 = legacyGitThunkSpec "git-v4" $ T.unlines
550+thunkFileNames = ["default.nix", "github.json", "git.json"]
598− [ "# DO NOT HAND-EDIT THIS FILE"
599− , "let fetch = {url, rev, branch ? null, sha256 ? null, fetchSubmodules ? false, private ? false, ...}:"
600− , " let realUrl = let firstChar = builtins.substring 0 1 url; in"
601− , " if firstChar == \"/\" then /. + url"
602− , " else if firstChar == \".\" then ./. + url"
604− , " in if !fetchSubmodules && private then builtins.fetchGit {"
605− , " url = realUrl; inherit rev;"
606− , " ${if branch == null then null else \"ref\"} = branch;"
607− , " } else (import <nixpkgs> {}).fetchgit {"
608− , " url = realUrl; inherit rev sha256;"
610− , "in import (fetch (builtins.fromJSON (builtins.readFile ./git.json)))"
613−legacyGitThunkSpec :: Text -> Text -> ThunkSpec
614−legacyGitThunkSpec name loader = ThunkSpec name $ Map.fromList
615− [ ("default.nix", ThunkFileSpec_FileMatches $ T.strip loader)
616− , ("git.json" , ThunkFileSpec_Ptr parseGitJsonBytes)
617− , (attrCacheFileName, ThunkFileSpec_AttrCache)
618− , (".git", ThunkFileSpec_CheckoutIndicator)
621−gitThunkSpecV5 :: ThunkSpec
622−gitThunkSpecV5 = mkThunkSpec "git-v5" "git.json" parseGitJsonBytes [here|
623−# DO NOT HAND-EDIT THIS FILE
624−let fetch = {url, rev, branch ? null, sha256 ? null, fetchSubmodules ? false, private ? false, ...}:
625− let realUrl = let firstChar = builtins.substring 0 1 url; in
626− if firstChar == "/" then /. + url
627− else if firstChar == "." then ./. + url
629− in if !fetchSubmodules && private then builtins.fetchGit {
630− url = realUrl; inherit rev;
631− ${if branch == null then null else "ref"} = branch;
632− } else (import <nixpkgs> {}).fetchgit {
633− url = realUrl; inherit rev sha256;
635− json = builtins.fromJSON (builtins.readFile ./git.json);
639−parseGitJsonBytes :: LBS.ByteString -> Either String ThunkPtr
640−parseGitJsonBytes = parseJsonObject $ parseThunkPtr $ fmap ThunkSource_Git . parseGitSource
642−mkThunkSpec :: Text -> FilePath -> (LBS.ByteString -> Either String ThunkPtr) -> Text -> ThunkSpec
643−mkThunkSpec name jsonFileName parser srcNix = ThunkSpec name $ Map.fromList
644− [ ("default.nix", ThunkFileSpec_FileMatches defaultNixViaSrc)
645− , ("thunk.nix", ThunkFileSpec_FileMatches srcNix)
646− , (jsonFileName, ThunkFileSpec_Ptr parser)
647− , (attrCacheFileName, ThunkFileSpec_AttrCache)
648− , (normalise $ unpackedDirName </> ".git", ThunkFileSpec_CheckoutIndicator)
651− defaultNixViaSrc = [here|
652−# DO NOT HAND-EDIT THIS FILE
653−import (import ./thunk.nix)
657−parseJsonObject :: (Aeson.Object -> Aeson.Parser a) -> LBS.ByteString -> Either String a
552+--TODO: when checking something out, make a shallow clone
658−parseJsonObject p bytes = Aeson.parseEither p =<< Aeson.eitherDecode bytes
660-- | Checks a cache directory to see if there is a fresh symlink
554-- | Checks a cache directory to see if there is a fresh symlink
661-- to the result of building an attribute of a thunk.
555-- to the result of building an attribute of a thunk.
@@ -663,49 +557,44 @@ parseJsonObject p bytes = Aeson.parseEither p =<< Aeson.eitherDecode bytes
663-- and the result is symlinked into the cache.
557-- and the result is symlinked into the cache.
664nixBuildThunkAttrWithCache
558nixBuildThunkAttrWithCache
665 :: MonadObelisk m
559 :: MonadObelisk m
667− -> FilePath
560+ => FilePath
668 -- ^ Path to directory containing Thunk
561 -- ^ Path to directory containing Thunk
669 -> String
562 -> String
670 -- ^ Attribute to build
563 -- ^ Attribute to build
671− -> m (Maybe FilePath)
564+ -> m FilePath
672 -- ^ Symlink to cached or built nix output
565 -- ^ Symlink to cached or built nix output
673-- WARNING: If the thunk uses an impure reference such as '<nixpkgs>'
566-- WARNING: If the thunk uses an impure reference such as '<nixpkgs>'
674-- the caching mechanism will fail as it merely measures the modification
567-- the caching mechanism will fail as it merely measures the modification
675-- time of the cache link and the expression to build.
568-- time of the cache link and the expression to build.
676−nixBuildThunkAttrWithCache thunkSpec thunkDir attr = do
569+nixBuildThunkAttrWithCache thunkDir attr = do
570+ --NB: Expects thunkDir to be normalised with no trailing path separator.
571+ --This should be guaranteed by the command argument parser.
572+ let cacheErrHandler e
573+ | isDoesNotExistError e = return Nothing -- expected from a cache miss
574+ | otherwise = putLog Error (T.pack $ displayException e) >> return Nothing
575+ cacheDir = thunkDir </> ".attr-cache"
576+ cachePath = cacheDir </> attr <.> "out"
677 latestChange <- liftIO $ do
577 latestChange <- liftIO $ do
678− let
578+ createDirectoryIfMissing False cacheDir
679− getModificationTimeMaybe = fmap rightToMaybe . try @IOError . getModificationTime
579+ let getModificationTimeMaybe = fmap rightToMaybe . try @IOError . getModificationTime
680− thunkFileNames = Map.keys $ _thunkSpec_files thunkSpec
681− maximum . catMaybes <$> traverse (getModificationTimeMaybe . (thunkDir </>)) thunkFileNames
580+ maximum . catMaybes <$> mapM (getModificationTimeMaybe . (thunkDir </>)) thunkFileNames
683− let cachePaths' = nonEmpty $ Map.keys $ Map.filter (\case ThunkFileSpec_AttrCache -> True; _ -> False) $
684− _thunkSpec_files thunkSpec
685− for cachePaths' $ \cachePaths ->
686− fmap NonEmpty.head $ for cachePaths $ \cacheDir -> do
688− cachePath = thunkDir </> cacheDir </> attr <.> "out"
690− | isDoesNotExistError e = pure Nothing -- expected from a cache miss
691− | otherwise = Nothing <$ putLog Error (T.pack $ displayException e)
692− cacheHit <- handle cacheErrHandler $ do
581+ cacheHit <- handle cacheErrHandler $ do
693− cacheTime <- liftIO $ posixSecondsToUTCTime . realToFrac . modificationTime <$> getSymbolicLinkStatus cachePath
582+ cacheTime <- liftIO $ posixSecondsToUTCTime . realToFrac . modificationTime <$> getSymbolicLinkStatus cachePath
694− pure $ if latestChange <= cacheTime
583+ return $ if latestChange <= cacheTime
695− then Just cachePath
584+ then Just cachePath
696− else Nothing
585+ else Nothing
697− case cacheHit of
586+ case cacheHit of
698− Just c -> pure c
587+ Just c -> return c
699− Nothing -> do
588+ Nothing -> do
700− putLog Warning $ T.pack $ mconcat [thunkDir, ": ", attr, " not cached, building ..."]
589+ putLog Warning $ T.pack $ mconcat [thunkDir, ": ", attr, " not cached, building ..."]
701− liftIO $ createDirectoryIfMissing True (takeDirectory cachePath)
702− (cachePath <$) $ nixCmd $ NixCmd_Build $ def
590+ _ <- nixCmd $ NixCmd_Build $ def
703− & nixBuildConfig_outLink .~ OutLink_IndirectRoot cachePath
591+ Lens.& nixBuildConfig_outLink Lens..~ OutLink_IndirectRoot cachePath
704− & nixCmdConfig_target .~ Target
592+ Lens.& nixCmdConfig_target Lens..~ Target
705− { _target_path = Just thunkDir
593+ { _target_path = Just thunkDir
706− , _target_attr = Just attr
594+ , _target_attr = Just attr
707− , _target_expr = Nothing
595+ , _target_expr = Nothing
710-- | Build a nix attribute, and cache the result if possible
599-- | Build a nix attribute, and cache the result if possible
711nixBuildAttrWithCache
600nixBuildAttrWithCache
@@ -716,15 +605,13 @@ nixBuildAttrWithCache
716 -- ^ Attribute to build
605 -- ^ Attribute to build
717 -> m FilePath
606 -> m FilePath
718 -- ^ Symlink to cached or built nix output
607 -- ^ Symlink to cached or built nix output
719−nixBuildAttrWithCache exprPath attr = readThunk exprPath >>= \case
608+nixBuildAttrWithCache exprPath attr = do
609+ readThunk exprPath >>= \case
720− -- Only packed thunks are cached. In particular, checkouts are not.
610+ -- Only packed thunks are cached. in particular, checkouts are not
721− Right (ThunkData_Packed spec _) ->
722− maybe build pure =<< nixBuildThunkAttrWithCache spec exprPath attr
611+ Right (ThunkData_Packed _) -> nixBuildThunkAttrWithCache exprPath attr
725− build = nixCmd $ NixCmd_Build $ def
612+ _ -> nixCmd $ NixCmd_Build $ def
726− & nixBuildConfig_outLink .~ OutLink_None
613+ Lens.& nixBuildConfig_outLink Lens..~ OutLink_None
727− & nixCmdConfig_target .~ Target
614+ Lens.& nixCmdConfig_target Lens..~ Target
728 { _target_path = Just exprPath
615 { _target_path = Just exprPath
729 , _target_attr = Just attr
616 , _target_attr = Just attr
730 , _target_expr = Nothing
617 , _target_expr = Nothing
@@ -745,7 +632,7 @@ updateThunk p f = withSystemTempDirectory "obelisk-thunkptr-" $ \tmpDir -> do
746 copyThunkToTmp tmpDir thunkDir = readThunk thunkDir >>= \case
633 copyThunkToTmp tmpDir thunkDir = readThunk thunkDir >>= \case
747 Left err -> failWith $ "withThunkUnpacked: " <> T.pack (show err)
634 Left err -> failWith $ "withThunkUnpacked: " <> T.pack (show err)
748− Right ThunkData_Packed{} -> do
635+ Right (ThunkData_Packed _) -> do
749 let tmpThunk = tmpDir </> "thunk"
636 let tmpThunk = tmpDir </> "thunk"
750 callProcessAndLogOutput (Notice, Error) $
637 callProcessAndLogOutput (Notice, Error) $
751 proc cp ["-r", "-T", thunkDir, tmpThunk]
638 proc cp ["-r", "-T", thunkDir, tmpThunk]
@@ -759,81 +646,62 @@ updateThunk p f = withSystemTempDirectory "obelisk-thunkptr-" $ \tmpDir -> do
759finalMsg :: Bool -> (a -> Text) -> Maybe (a -> Text)
646finalMsg :: Bool -> (a -> Text) -> Maybe (a -> Text)
760finalMsg noTrail s = if noTrail then Nothing else Just s
647finalMsg noTrail s = if noTrail then Nothing else Just s
649+unpackThunk :: MonadObelisk m => FilePath -> m ()
650+unpackThunk = unpackThunk' False
762-- | Check that we are not somewhere inside the thunk directory
652-- | Check that we are not somewhere inside the thunk directory
763−checkThunkDirectory :: MonadObelisk m => FilePath -> m ()
653+checkThunkDirectory :: MonadObelisk m => Text -> FilePath -> m ()
764−checkThunkDirectory thunkDir = do
654+checkThunkDirectory msg thunkDir = do
765 currentDir <- liftIO getCurrentDirectory
655 currentDir <- liftIO getCurrentDirectory
766 thunkDir' <- liftIO $ canonicalizePath thunkDir
656 thunkDir' <- liftIO $ canonicalizePath thunkDir
767− when (thunkDir' `L.isInfixOf` currentDir) $
657+ when (thunkDir' `L.isInfixOf` currentDir) $ failWith msg
768− failWith [i|Can't perform thunk operations from within the thunk directory: ${thunkDir}|]
770− -- Don't let thunk commands work when directly given an unpacked repo
771− when (takeFileName thunkDir == unpackedDirName) $
772− readThunk (takeDirectory thunkDir) >>= \case
773− Right _ -> failWith [i|Refusing to perform thunk operation on ${thunkDir} because it is a thunk's unpacked source|]
776−unpackThunk :: MonadObelisk m => FilePath -> m ()
777−unpackThunk = unpackThunk' False
779unpackThunk' :: MonadObelisk m => Bool -> FilePath -> m ()
659unpackThunk' :: MonadObelisk m => Bool -> FilePath -> m ()
780−unpackThunk' noTrail thunkDir = checkThunkDirectory thunkDir *> readThunk thunkDir >>= \case
660+unpackThunk' noTrail thunkDir = checkThunkDirectory "Can't pack/unpack from within the thunk directory" thunkDir >> readThunk thunkDir >>= \case
781− Left err -> failWith [i|Invalid thunk at ${thunkDir}: ${err}|]
661+ Left err -> failWith $ "thunk unpack: " <> T.pack (show err)
782 --TODO: Overwrite option that rechecks out thunk; force option to do so even if working directory is dirty
662 --TODO: Overwrite option that rechecks out thunk; force option to do so even if working directory is dirty
783− Right ThunkData_Checkout -> failWith [i|Thunk at ${thunkDir} is already unpacked|]
663+ Right (ThunkData_Checkout _) -> failWith "thunk unpack: thunk is already unpacked"
784− Right (ThunkData_Packed _ tptr) -> do
664+ Right (ThunkData_Packed tptr) -> do
785 let (thunkParent, thunkName) = splitFileName thunkDir
665 let (thunkParent, thunkName) = splitFileName thunkDir
786− withTempDirectory thunkParent thunkName $ \tmpThunk -> do
666+ withTempDirectory thunkParent thunkName $ \tmpRepo -> do
787− let
667+ let obGitDir = tmpRepo </> ".git" </> "obelisk"
788− gitSrc = thunkSourceToGitSource $ _thunkPtr_source tptr
789− newSpec = case _thunkPtr_source tptr of
668+ s = case _thunkPtr_source tptr of
790− ThunkSource_GitHub _ -> NonEmpty.head gitHubThunkSpecs
669+ ThunkSource_GitHub s' -> forgetGithub False s'
791− ThunkSource_Git _ -> NonEmpty.head gitThunkSpecs
670+ ThunkSource_Git s' -> s'
792 withSpinner' ("Fetching thunk " <> T.pack thunkName)
671 withSpinner' ("Fetching thunk " <> T.pack thunkName)
793 (finalMsg noTrail $ const $ "Fetched thunk " <> T.pack thunkName) $ do
672 (finalMsg noTrail $ const $ "Fetched thunk " <> T.pack thunkName) $ do
794− let unpackedPath = tmpThunk </> unpackedDirName
795− gitCloneForThunkUnpack gitSrc (_thunkRev_commit $ _thunkPtr_rev tptr) unpackedPath
797− let normalizeMore = dropTrailingPathSeparator . normalise
798− when (normalizeMore unpackedPath /= normalizeMore tmpThunk) $ -- Only write meta data if the checkout is not inplace
799− createThunk tmpThunk $ Left newSpec
802− removePathForcibly thunkDir
803− renameDirectory tmpThunk thunkDir
805−gitCloneForThunkUnpack
807− => GitSource -- ^ Git source to use
808− -> Ref hash -- ^ Commit hash to reset to
809− -> FilePath -- ^ Directory to clone into
811−gitCloneForThunkUnpack gitSrc commit dir = do
812− let git = callProcessAndLogOutput (Notice, Notice) . gitProc dir
673+ let git = callProcessAndLogOutput (Notice, Notice) . gitProc tmpRepo
813− git $ [ "clone" ]
674+ git $ [ "clone" ]
814− ++ ["--recursive" | _gitSource_fetchSubmodules gitSrc]
675+ ++ ("--recursive" <$ guard (_gitSource_fetchSubmodules s))
815− ++ [ T.unpack $ gitUriToText $ _gitSource_url gitSrc ]
676+ ++ [ T.unpack $ gitUriToText $ _gitSource_url s ]
816− ++ do branch <- maybeToList $ _gitSource_branch gitSrc
677+ ++ do branch <- maybeToList $ _gitSource_branch s
817− [ "--branch", T.unpack $ untagName branch ]
678+ [ "--branch", T.unpack $ untagName branch ]
818− git ["reset", "--hard", Ref.toHexString commit]
679+ git ["reset", "--hard", Ref.toHexString $ _thunkRev_commit $ _thunkPtr_rev tptr]
819− when (_gitSource_fetchSubmodules gitSrc) $
680+ when (_gitSource_fetchSubmodules s) $
820− git ["submodule", "update", "--recursive", "--init"]
681+ git ["submodule", "update", "--recursive", "--init"]
683+ liftIO $ createDirectory obGitDir
684+ callProcessAndLogOutput (Notice, Error) $
685+ proc cp ["-r", "-T", thunkDir </> ".", obGitDir </> "orig-thunk"]
686+ callProcessAndLogOutput (Notice, Error) $
687+ proc "rm" ["-r", thunkDir]
688+ callProcessAndLogOutput (Notice, Error) $
689+ proc "mv" ["-T", tmpRepo, thunkDir]
822--TODO: add a rollback mode to pack to the original thunk
691--TODO: add a rollback mode to pack to the original thunk
823packThunk :: MonadObelisk m => ThunkPackConfig -> FilePath -> m ThunkPtr
692packThunk :: MonadObelisk m => ThunkPackConfig -> FilePath -> m ThunkPtr
824packThunk = packThunk' False
693packThunk = packThunk' False
826packThunk' :: MonadObelisk m => Bool -> ThunkPackConfig -> FilePath -> m ThunkPtr
695packThunk' :: MonadObelisk m => Bool -> ThunkPackConfig -> FilePath -> m ThunkPtr
827−packThunk' noTrail (ThunkPackConfig force thunkConfig) thunkDir = checkThunkDirectory thunkDir *> readThunk thunkDir >>= \case
696+packThunk' noTrail (ThunkPackConfig force thunkConfig) thunkDir = checkThunkDirectory "Can't pack/unpack from within the thunk directory" thunkDir >> readThunk thunkDir >>= \case
697+ Left err -> failWith $ T.pack $ "thunk pack: " <> show err
828− Right ThunkData_Packed{} -> failWith [i|Thunk at ${thunkDir} is is already packed|]
698+ Right (ThunkData_Packed _) -> failWith "pack: thunk is already packed"
829− _ -> withSpinner'
699+ Right (ThunkData_Checkout _) -> do
830− ("Packing thunk " <> T.pack thunkDir)
700+ withSpinner' ("Packing thunk " <> T.pack thunkDir)
831− (finalMsg noTrail $ const $ "Packed thunk " <> T.pack thunkDir) $
701+ (finalMsg noTrail $ const $ "Packed thunk " <> T.pack thunkDir) $ do
833− let checkClean = if force then CheckClean_NoCheck else CheckClean_FullCheck
834− thunkPtr <- modifyThunkPtrByConfig thunkConfig <$> getThunkPtr checkClean thunkDir (_thunkConfig_private thunkConfig)
702+ thunkPtr <- modifyThunkPtrByConfig thunkConfig <$> getThunkPtr (not force) thunkDir
835− liftIO $ removePathForcibly thunkDir
703+ callProcessAndLogOutput (Debug, Error) $ proc "rm" ["-rf", thunkDir]
836− createThunk thunkDir $ Right thunkPtr
704+ liftIO $ createThunk thunkDir thunkPtr
837 pure thunkPtr
705 pure thunkPtr
839modifyThunkPtrByConfig :: ThunkConfig -> ThunkPtr -> ThunkPtr
707modifyThunkPtrByConfig :: ThunkConfig -> ThunkPtr -> ThunkPtr
@@ -844,43 +712,29 @@ modifyThunkPtrByConfig (ThunkConfig markPrivate') ptr = case markPrivate' of
844 ThunkSource_GitHub s -> ThunkSource_GitHub $ s { _gitHubSource_private = markPrivate }
712 ThunkSource_GitHub s -> ThunkSource_GitHub $ s { _gitHubSource_private = markPrivate }
848− = CheckClean_FullCheck
849− -- ^ Check that the repo is clean, including .gitignored files
850− | CheckClean_NotIgnored
851− -- ^ Check that the repo is clean, not including .gitignored files
852− | CheckClean_NoCheck
853− -- ^ Don't check that the repo is clean
855−getThunkPtr :: forall m. MonadObelisk m => CheckClean -> FilePath -> Maybe Bool -> m ThunkPtr
715+getThunkPtr :: forall m. MonadObelisk m => Bool -> FilePath -> m ThunkPtr
856−getThunkPtr gitCheckClean dir mPrivate = do
716+getThunkPtr checkClean thunkDir = do
857− let repoLocations = nubOrd $ map (first normalise)
858− [(".git", "."), (unpackedDirName </> ".git", unpackedDirName)]
859− repoLocation' <- liftIO $ flip findM repoLocations $ doesDirectoryExist . (dir </>) . fst
860− thunkDir <- case repoLocation' of
861− Nothing -> failWith [i|Can't find an unpacked thunk in ${dir}|]
862− Just (_, path) -> pure $ normalise $ dir </> path
864− let (checkClean, checkIgnored) = case gitCheckClean of
865− CheckClean_FullCheck -> (True, True)
866− CheckClean_NotIgnored -> (True, False)
867− CheckClean_NoCheck -> (False, False)
868− when checkClean $ ensureCleanGitRepo thunkDir checkIgnored
717+ when checkClean $ ensureCleanGitRepo thunkDir True
869 "thunk pack: thunk checkout contains unsaved modifications"
718 "thunk pack: thunk checkout contains unsaved modifications"
871 -- Check whether there are any stashes
720 -- Check whether there are any stashes
872− when checkClean $ do
873− stashOutput <- readGitProcess thunkDir ["stash", "list"]
721+ stashOutput <- readGitProcess thunkDir ["stash", "list"]
874− unless (T.null stashOutput) $
722+ when checkClean $ case T.null stashOutput of
875 failWith $ T.unlines $
724 failWith $ T.unlines $
876 [ "thunk pack: thunk checkout has stashes"
725 [ "thunk pack: thunk checkout has stashes"
877 , "git stash list:"
726 , "git stash list:"
878 ] ++ T.lines stashOutput
727 ] ++ T.lines stashOutput
880− -- Get current branch
730+ -- Get current branch ``
881 (mCurrentBranch, mCurrentCommit) <- do
731 (mCurrentBranch, mCurrentCommit) <- do
882− b <- listToMaybe . T.lines <$> readGitProcess thunkDir ["rev-parse", "--abbrev-ref", "HEAD"]
734+ <$> readGitProcess thunkDir ["rev-parse", "--abbrev-ref", "HEAD"]
883− c <- listToMaybe . T.lines <$> readGitProcess thunkDir ["rev-parse", "HEAD"]
737+ <$> readGitProcess thunkDir ["rev-parse", "HEAD"]
884 case b of
738 case b of
885 (Just "HEAD") -> failWith $ T.unlines
739 (Just "HEAD") -> failWith $ T.unlines
886 [ "thunk pack: You are in 'detached HEAD' state."
740 [ "thunk pack: You are in 'detached HEAD' state."
@@ -891,7 +745,7 @@ getThunkPtr gitCheckClean dir mPrivate = do
892 -- Get information on all branches and their (optional) designated upstream
746 -- Get information on all branches and their (optional) designated upstream
893 -- correspondents
747 -- correspondents
894− headDump :: [Text] <- T.lines <$> readGitProcess thunkDir
748+ (headDump :: [Text]) <- T.lines <$> readGitProcess thunkDir
895 [ "for-each-ref"
749 [ "for-each-ref"
896 , "--format=%(refname:short) %(upstream:short) %(upstream:remotename)"
750 , "--format=%(refname:short) %(upstream:short) %(upstream:remotename)"
897 , "refs/heads/"
751 , "refs/heads/"
@@ -937,7 +791,7 @@ getThunkPtr gitCheckClean dir mPrivate = do
939 -- loosely by https://stackoverflow.com/questions/7773939/show-git-ahead-and-behind-info-for-all-branches-including-remotes
793 -- loosely by https://stackoverflow.com/questions/7773939/show-git-ahead-and-behind-info-for-all-branches-including-remotes
940− stats <- ifor headUpstream $ \branch (upstream, _remote) -> do
794+ stats <- iforM headUpstream $ \branch (upstream, _remote) -> do
941 (stat :: [Text]) <- T.lines <$> readGitProcess thunkDir
795 (stat :: [Text]) <- T.lines <$> readGitProcess thunkDir
942 [ "rev-list", "--left-right"
796 [ "rev-list", "--left-right"
943 , T.unpack branch <> "..." <> T.unpack upstream
797 , T.unpack branch <> "..." <> T.unpack upstream
@@ -961,9 +815,8 @@ getThunkPtr gitCheckClean dir mPrivate = do
961 \pushed but this repo's remote tracking branches don't know it.)"
815 \pushed but this repo's remote tracking branches don't know it.)"
964− when checkClean $ do
965− -- We assume it's safe to pack the thunk at this point
818+ -- We assume it's safe to pack the thunk at this point
966− putLog Informational "All changes safe in git remotes. OK to pack thunk."
819+ putLog Informational "All changes safe in git remotes. OK to pack thunk."
968 let remote = maybe "origin" snd $ flip Map.lookup headUpstream =<< mCurrentBranch
821 let remote = maybe "origin" snd $ flip Map.lookup headUpstream =<< mCurrentBranch
@@ -976,12 +829,14 @@ getThunkPtr gitCheckClean dir mPrivate = do
976 remoteUri <- case parseGitUri remoteUri' of
829 remoteUri <- case parseGitUri remoteUri' of
977 Nothing -> failWith $ "Could not identify git remote: " <> remoteUri'
830 Nothing -> failWith $ "Could not identify git remote: " <> remoteUri'
978 Just uri -> pure uri
831 Just uri -> pure uri
979− uriThunkPtr remoteUri mPrivate mCurrentBranch mCurrentCommit
832+ uriThunkPtr remoteUri mCurrentBranch mCurrentCommit
981-- | Get the latest revision available from the given source
834-- | Get the latest revision available from the given source
982getLatestRev :: MonadObelisk m => ThunkSource -> m ThunkRev
835getLatestRev :: MonadObelisk m => ThunkSource -> m ThunkRev
983getLatestRev os = do
836getLatestRev os = do
984− let gitS = thunkSourceToGitSource os
837+ let gitS = case os of
838+ ThunkSource_GitHub s -> forgetGithub False s
839+ ThunkSource_Git s -> s
985 (_, commit) <- gitGetCommitBranch (_gitSource_url gitS) (untagName <$> _gitSource_branch gitS)
840 (_, commit) <- gitGetCommitBranch (_gitSource_url gitS) (untagName <$> _gitSource_branch gitS)
986 case os of
841 case os of
987 ThunkSource_GitHub s -> githubThunkRev s commit
842 ThunkSource_GitHub s -> githubThunkRev s commit
@@ -993,12 +848,12 @@ getLatestRev os = do
993-- performance. If that doesn't work (e.g. authentication issue), we fall back
848-- performance. If that doesn't work (e.g. authentication issue), we fall back
994-- on just doing things the normal way for git repos in general, and save it as
849-- on just doing things the normal way for git repos in general, and save it as
995-- a regular git thunk.
850-- a regular git thunk.
996−uriThunkPtr :: MonadObelisk m => GitUri -> Maybe Bool -> Maybe Text -> Maybe Text -> m ThunkPtr
851+uriThunkPtr :: MonadObelisk m => GitUri -> Maybe Text -> Maybe Text -> m ThunkPtr
997−uriThunkPtr uri mPrivate mbranch mcommit = do
852+uriThunkPtr uri mbranch mcommit = do
998 commit <- case mcommit of
853 commit <- case mcommit of
999 Nothing -> gitGetCommitBranch uri mbranch >>= return . snd
854 Nothing -> gitGetCommitBranch uri mbranch >>= return . snd
1000 (Just c) -> return c
855 (Just c) -> return c
1001− (src, rev) <- uriToThunkSource uri mPrivate mbranch >>= \case
856+ (src, rev) <- case uriToThunkSource uri mbranch of
1002 ThunkSource_GitHub s -> do
857 ThunkSource_GitHub s -> do
1003 rev <- runExceptT $ githubThunkRev s commit
858 rev <- runExceptT $ githubThunkRev s commit
1004 case rev of
859 case rev of
@@ -1021,8 +876,8 @@ uriThunkPtr uri mPrivate mbranch mcommit = do
1021-- If the thunk is a GitHub thunk and fails, we do *not* fall back like with
876-- If the thunk is a GitHub thunk and fails, we do *not* fall back like with
1022-- `uriThunkPtr`. Unlike a plain URL, a thunk src explicitly states which method
877-- `uriThunkPtr`. Unlike a plain URL, a thunk src explicitly states which method
1023-- should be employed, and so we respect that.
878-- should be employed, and so we respect that.
1024−uriToThunkSource :: MonadObelisk m => GitUri -> Maybe Bool -> Maybe Text -> m ThunkSource
879+uriToThunkSource :: GitUri -> Maybe Text -> ThunkSource
1025−uriToThunkSource (GitUri u) mPrivate
880+uriToThunkSource (GitUri u)
1026 | Right uriAuth <- URI.uriAuthority u
881 | Right uriAuth <- URI.uriAuthority u
1027 , Just scheme <- URI.unRText <$> URI.uriScheme u
882 , Just scheme <- URI.unRText <$> URI.uriScheme u
1028 , case scheme of
883 , case scheme of
@@ -1034,53 +889,21 @@ uriToThunkSource (GitUri u) mPrivate
1034 s -> s `L.elem` [ "git", "https", "http" ] -- "http:" just redirects to "https:"
889 s -> s `L.elem` [ "git", "https", "http" ] -- "http:" just redirects to "https:"
1035 && URI.unRText (URI.authHost uriAuth) == "github.com"
890 && URI.unRText (URI.authHost uriAuth) == "github.com"
1036 , Just (_, owner :| [repoish]) <- URI.uriPath u
891 , Just (_, owner :| [repoish]) <- URI.uriPath u
1038− isPrivate <- getIsPrivate
1039− pure $ ThunkSource_GitHub $ GitHubSource
892+ = \mbranch -> ThunkSource_GitHub $ GitHubSource
1040− { _gitHubSource_owner = N $ URI.unRText owner
893+ { _gitHubSource_owner = N $ URI.unRText owner
1041− , _gitHubSource_repo = N $ let
894+ , _gitHubSource_repo = N $ let
1042− repoish' = URI.unRText repoish
895+ repoish' = URI.unRText repoish
1043− in fromMaybe repoish' $ T.stripSuffix ".git" repoish'
896+ in fromMaybe repoish' $ T.stripSuffix ".git" repoish'
1044− , _gitHubSource_branch = N <$> mbranch
897+ , _gitHubSource_branch = N <$> mbranch
1045− , _gitHubSource_private = isPrivate
898+ , _gitHubSource_private = False -- TODO: Can we try something to infer this?
1048− | otherwise = \mbranch -> do
1049− isPrivate <- getIsPrivate
1050− pure $ ThunkSource_Git $ GitSource
901+ | otherwise = \mbranch -> ThunkSource_Git $ GitSource
1051− { _gitSource_url = GitUri u
902+ { _gitSource_url = GitUri u
1052− , _gitSource_branch = N <$> mbranch
903+ , _gitSource_branch = N <$> mbranch
1053− , _gitSource_fetchSubmodules = False -- TODO: How do we determine if this should be true?
904+ , _gitSource_fetchSubmodules = False -- TODO: How do we determine if this should be true?
1054− , _gitSource_private = isPrivate
905+ , _gitSource_private = False -- TODO: Can we try something to infer this?
1057− getIsPrivate = maybe (guessGitRepoIsPrivate $ GitUri u) pure mPrivate
1059−guessGitRepoIsPrivate :: MonadObelisk m => GitUri -> m Bool
1060−guessGitRepoIsPrivate uri = flip fix urisToTry $ \loop -> \case
1062− uriAttempt:xs -> do
1063− result <- readCreateProcessWithExitCode $
1070− , T.unpack $ gitUriToText uriAttempt
1073− (ExitSuccess, _, _) -> pure False -- Must be a public repo
1076− urisToTry = nubOrd $
1077− -- Include the original URI if it isn't using SSH because SSH will certainly fail.
1078− [uri | fmap URI.unRText (URI.uriScheme (unGitUri uri)) /= Just "ssh"] <>
1079− [changeScheme "https" uri, changeScheme "http" uri]
1080− changeScheme scheme (GitUri u) = GitUri $ u
1081− { URI.uriScheme = URI.mkScheme scheme
1082− , URI.uriAuthority = (\x -> x { URI.authUserInfo = Nothing }) <$> URI.uriAuthority u
1085-- Funny signature indicates no effects depend on the optional branch name.
908-- Funny signature indicates no effects depend on the optional branch name.
1086githubThunkRev
909githubThunkRev
@@ -1140,7 +963,6 @@ gitThunkRev s commit = do
1141-- If the branch name is passed in, it is returned exactly as-is. If it is not
964-- If the branch name is passed in, it is returned exactly as-is. If it is not
1142-- passed it, the default branch of the repo is used instead.
965-- passed it, the default branch of the repo is used instead.
1144gitGetCommitBranch
966gitGetCommitBranch
1145 :: MonadObelisk m => GitUri -> Maybe Text -> m (Text, CommitId)
967 :: MonadObelisk m => GitUri -> Maybe Text -> m (Text, CommitId)
1146gitGetCommitBranch uri mbranch = withExitFailMessage ("Failure for git remote " <> uriMsg) $ do
968gitGetCommitBranch uri mbranch = withExitFailMessage ("Failure for git remote " <> uriMsg) $ do