@@ -5,48 +5,65 @@
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
@@ -56,7 +73,7 @@ import System.Exit
56import System.FilePath
73import System.FilePath
57import System.IO.Error
74import System.IO.Error
58import System.IO.Temp
75import System.IO.Temp
59−import System.PosixCompat.Files (getSymbolicLinkStatus, modificationTime)
76+import System.Posix (getSymbolicLinkStatus, modificationTime)
60import qualified Text.URI as URI
77import qualified Text.URI as URI
62import Obelisk.App (MonadObelisk)
79import Obelisk.App (MonadObelisk)
@@ -65,10 +82,11 @@ import Obelisk.Command.Utils
66--TODO: Support symlinked thunk data
83--TODO: Support symlinked thunk data
67data ThunkData
84data ThunkData
68− = ThunkData_Packed ThunkSpec ThunkPtr
85+ = ThunkData_Packed ThunkPtr
69 -- ^ Packed thunk
86 -- ^ Packed thunk
70− | ThunkData_Checkout
87+ | ThunkData_Checkout (Maybe ThunkPtr)
71 -- ^ Checked out thunk that was unpacked from this pointer
88 -- ^ Checked out thunk that was unpacked from this pointer
89+ deriving (Show, Eq, Ord)
73-- | A reference to the exact data that a thunk should translate into
91-- | A reference to the exact data that a thunk should translate into
74data ThunkPtr = ThunkPtr
92data ThunkPtr = ThunkPtr
@@ -94,11 +112,6 @@ data ThunkSource
94 | ThunkSource_Git GitSource
112 | ThunkSource_Git GitSource
95 deriving (Show, Eq, Ord)
113 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
115data GitHubSource = GitHubSource
103 { _gitHubSource_owner :: Name Owner
116 { _gitHubSource_owner :: Name Owner
104 , _gitHubSource_repo :: Name Repo
117 , _gitHubSource_repo :: Name Repo
@@ -107,7 +120,7 @@ data GitHubSource = GitHubSource
108 deriving (Show, Eq, Ord)
121 deriving (Show, Eq, Ord)
110−newtype GitUri = GitUri { unGitUri :: URI.URI } deriving (Eq, Ord, Show)
123+newtype GitUri = GitUri URI.URI deriving (Eq, Ord, Show)
112gitUriToText :: GitUri -> Text
125gitUriToText :: GitUri -> Text
113gitUriToText (GitUri uri)
126gitUriToText (GitUri uri)
@@ -178,14 +191,14 @@ getNixSha256ForUriUnpacked
178getNixSha256ForUriUnpacked uri =
191getNixSha256ForUriUnpacked uri =
179 withExitFailMessage ("nix-prefetch-url: Failed to determine sha256 hash of URL " <> gitUriToText uri) $ do
192 withExitFailMessage ("nix-prefetch-url: Failed to determine sha256 hash of URL " <> gitUriToText uri) $ do
180 [hash] <- fmap T.lines $ readProcessAndLogOutput (Debug, Debug) $
193 [hash] <- fmap T.lines $ readProcessAndLogOutput (Debug, Debug) $
181− proc nixPrefetchUrlPath ["--unpack", "--type", "sha256", T.unpack $ gitUriToText uri]
194+ proc "nix-prefetch-url" ["--unpack", "--type", "sha256", T.unpack $ gitUriToText uri]
182 pure hash
195 pure hash
184nixPrefetchGit :: MonadObelisk m => GitUri -> Text -> Bool -> m NixSha256
197nixPrefetchGit :: MonadObelisk m => GitUri -> Text -> Bool -> m NixSha256
185nixPrefetchGit uri rev fetchSubmodules =
198nixPrefetchGit uri rev fetchSubmodules =
186 withExitFailMessage ("nix-prefetch-git: Failed to determine sha256 hash of Git repo " <> gitUriToText uri <> " at " <> rev) $ do
199 withExitFailMessage ("nix-prefetch-git: Failed to determine sha256 hash of Git repo " <> gitUriToText uri <> " at " <> rev) $ do
187 out <- readProcessAndLogStderr Debug $
200 out <- readProcessAndLogStderr Debug $
188− proc nixPrefetchGitPath $ filter (/="")
201+ proc "nix-prefetch-git" $ filter (/="")
189 [ "--url", T.unpack $ gitUriToText uri
202 [ "--url", T.unpack $ gitUriToText uri
190 , "--rev", T.unpack rev
203 , "--rev", T.unpack rev
191 , if fetchSubmodules then "--fetch-submodules" else ""
204 , if fetchSubmodules then "--fetch-submodules" else ""
@@ -198,117 +211,93 @@ nixPrefetchGit uri rev fetchSubmodules =
199--TODO: Pretty print these
212--TODO: Pretty print these
200data ReadThunkError
213data ReadThunkError
201− = ReadThunkError_UnrecognizedThunk
214+ = ReadThunkError_UnrecognizedFiles
202− | ReadThunkError_UnrecognizedPaths (NonEmpty FilePath)
215+ | ReadThunkError_AmbiguousFiles
203− | ReadThunkError_MissingPaths (NonEmpty FilePath)
216+ | ReadThunkError_UnrecognizedLoader Text
204− | ReadThunkError_UnparseablePtr FilePath String
217+ | 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)
218+ deriving (Show)
211−unpackedDirName :: FilePath
220+-- | Read a thunk and validate that it is only a thunk, either packed or unpacked.
212−unpackedDirName = "."
221+-- If the thunk is packed and additional data is present, fail.
213−
222+readThunk :: MonadObelisk m => FilePath -> m (Either ReadThunkError ThunkData)
214−attrCacheFileName :: FilePath
223+readThunk thunkDir = do
215−attrCacheFileName = ".attr-cache"
224+ files <- liftIO $ listDirectory thunkDir
216−
225+ case ".git" `elem` files of
217−-- | Specification for how a file in a thunk version works.
226+ True -> fmap ThunkData_Checkout <$> do
218−data ThunkFileSpec
227+ let origThunkPath = thunkDir </> ".git" </> "obelisk" </> "orig-thunk"
219− = ThunkFileSpec_Ptr (LBS.ByteString -> Either String ThunkPtr) -- ^ This file specifies 'ThunkPtr' data
228+ liftIO $ doesDirectoryExist origThunkPath >>= \case
220− | ThunkFileSpec_FileMatches Text -- ^ This file must match the given content exactly
229+ True -> fmap Just <$> readPackedThunk origThunkPath
221− | ThunkFileSpec_CheckoutIndicator -- ^ Existence of this directory indicates that the thunk is unpacked
230+ False -> return $ return Nothing
222− | ThunkFileSpec_AttrCache -- ^ This directory is an attribute cache
231+ False -> liftIO $ fmap ThunkData_Packed <$> readPackedThunk thunkDir
224−-- | Specification for how a set of files in a thunk version work.
233+data ThunkType = ThunkType
225−data ThunkSpec = ThunkSpec
234+ { _thunkType_loader :: FilePath
226− { _thunkSpec_name :: !Text
235+ , _thunkType_json :: FilePath
227− , _thunkSpec_files :: !(Map FilePath ThunkFileSpec)
236+ , _thunkType_optional :: Set FilePath
237+ , _thunkType_loaderVersions :: NonEmpty Text
238+ , _thunkType_parser :: Aeson.Object -> Aeson.Parser ThunkPtr
230−thunkSpecTypes :: NonEmpty (NonEmpty ThunkSpec)
241+gitHubThunkType :: ThunkType
231−thunkSpecTypes = gitThunkSpecs :| [gitHubThunkSpecs]
242+gitHubThunkType = ThunkType
232−
243+ { _thunkType_loader = "default.nix"
233−-- | Attempts to match a 'ThunkSpec' to a given directory.
244+ , _thunkType_json = "github.json"
234−matchThunkSpecToDir
245+ , _thunkType_optional = Set.fromList [".attr-cache"]
235− :: (MonadError ReadThunkError m, MonadIO m, MonadCatch m)
246+ , _thunkType_loaderVersions = gitHubStandaloneLoaders
236− => ThunkSpec -- ^ 'ThunkSpec' to match against the given files/directory
247+ , _thunkType_parser = parseThunkPtr $ \v ->
237− -> FilePath -- ^ Path to directory
248+ ThunkSource_GitHub <$> parseGitHubSource v <|> ThunkSource_Git <$> parseGitSource v
238− -> Set FilePath -- ^ Set of file paths relative to the given directory
249+ }
240−matchThunkSpecToDir thunkSpec dir dirFiles = do
251+gitThunkType :: ThunkType
241− case nonEmpty (toList $ dirFiles `Set.difference` expectedPaths) of
252+gitThunkType = ThunkType
242− Just fs -> throwError $ ReadThunkError_UnrecognizedPaths $ (dir </>) <$> fs
253+ { _thunkType_loader = "default.nix"
243− Nothing -> pure ()
254+ , _thunkType_json = "git.json"
244− case nonEmpty (toList $ requiredPaths `Set.difference` dirFiles) of
255+ , _thunkType_optional = Set.fromList [".attr-cache"]
245− Just fs -> throwError $ ReadThunkError_MissingPaths $ (dir </>) <$> fs
256+ , _thunkType_loaderVersions = plainGitStandaloneLoaders
246− Nothing -> pure ()
257+ , _thunkType_parser = parseThunkPtr $ fmap ThunkSource_Git . parseGitSource
247− datas <- fmap toList $ flip Map.traverseMaybeWithKey (_thunkSpec_files thunkSpec) $ \expectedPath -> \case
258+ }
248− ThunkFileSpec_AttrCache -> Nothing <$ dirMayExist expectedPath
259+
249− ThunkFileSpec_CheckoutIndicator -> liftIO (doesDirectoryExist (dir </> expectedPath)) <&> \case
260+thunkTypes :: [ThunkType]
250− False -> Nothing
261+thunkTypes = [gitThunkType, gitHubThunkType]
251− True -> Just ThunkData_Checkout
262+
252− ThunkFileSpec_FileMatches expectedContents -> handle (\(e :: IOError) -> throwError $ ReadThunkError_FileError e) $ do
263+findThunkType :: [ThunkType] -> FilePath -> IO (Either ReadThunkError ThunkType)
253− actualContents <- liftIO (T.readFile $ dir </> expectedPath)
264+findThunkType types thunkDir = do
254− case T.strip expectedContents == T.strip actualContents of
265+ matches <- fmap catMaybes $ forM types $ \thunkType -> do
255− True -> pure Nothing
266+ let
256− False -> throwError $ ReadThunkError_FileDoesNotMatch (dir </> expectedPath) expectedContents
267+ expectedContents = Set.fromList $ (thunkDir </>) <$>
257− ThunkFileSpec_Ptr parser -> handle (\(e :: IOError) -> throwError $ ReadThunkError_FileError e) $ do
268+ [ _thunkType_loader thunkType
258− let path = dir </> expectedPath
269+ , _thunkType_json thunkType
259− liftIO (doesFileExist path) >>= \case
270+ ]
260− False -> pure Nothing
271+ optionalContents = Set.map (thunkDir </>) (_thunkType_optional thunkType)
262− actualContents <- liftIO $ LBS.readFile path
273+ -- Ensure that there aren't any other files in the thunk
263− case parser actualContents of
274+ -- NB: System.Directory.listDirectory returns the contents without the directory path
264− Right v -> pure $ Just (ThunkData_Packed thunkSpec v)
275+ files <- liftIO $ Set.fromList . fmap (thunkDir </>) <$> listDirectory thunkDir
265− Left e -> throwError $ ReadThunkError_UnparseablePtr (dir </> expectedPath) e
276+ let unexpectedContents = files `Set.difference` (expectedContents `Set.union` optionalContents)
266−
277+ missingContents = expectedContents `Set.difference` files
267− case nonEmpty datas of
278+ pure $ if Set.null unexpectedContents && Set.null missingContents
268− Nothing -> throwError ReadThunkError_UnrecognizedThunk
279+ then Just thunkType
269− Just xs -> fold1WithM xs $ \a b -> either throwError pure (mergeThunkData a b)
280+ else Nothing
271− rootPathsOnly = Set.fromList . mapMaybe takeRootDir . Map.keys
282+ pure $ case matches of
272− takeRootDir = fmap NonEmpty.head . nonEmpty . splitPath
283+ [singleMatch] -> Right singleMatch
273−
284+ [] -> Left ReadThunkError_UnrecognizedFiles
274− expectedPaths = rootPathsOnly $ _thunkSpec_files thunkSpec
285+ _ -> 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.
287-- | Read a thunk and validate that it is exactly a packed thunk.
309-- If additional data is present, fail.
288-- If additional data is present, fail.
310−readThunk :: (MonadObelisk m) => FilePath -> m (Either ReadThunkError ThunkData)
289+readPackedThunk :: FilePath -> IO (Either ReadThunkError ThunkPtr)
311−readThunk = readThunkWith thunkSpecTypes
290+readPackedThunk thunkDir = runExceptT $ do
291+ thunkType <- ExceptT $ findThunkType thunkTypes thunkDir
292+ -- Ensure that we recognize the thunk loader
293+ loader <- liftIO $ T.readFile $ thunkDir </> _thunkType_loader thunkType
294+ unless (loader `elem` _thunkType_loaderVersions thunkType) $ do
295+ throwError $ ReadThunkError_UnrecognizedLoader loader
297+ txt <- liftIO $ LBS.readFile $ thunkDir </> _thunkType_json thunkType
298+ case parseMaybe (_thunkType_parser thunkType) =<< Aeson.decode txt of
299+ Nothing -> throwError $ ReadThunkError_UnparseablePtr txt
300+ Just ptr -> return ptr
313parseThunkPtr :: (Aeson.Object -> Aeson.Parser ThunkSource) -> Aeson.Object -> Aeson.Parser ThunkPtr
302parseThunkPtr :: (Aeson.Object -> Aeson.Parser ThunkSource) -> Aeson.Object -> Aeson.Parser ThunkPtr
314parseThunkPtr parseSrc v = do
303parseThunkPtr parseSrc v = do
@@ -352,18 +341,16 @@ parseGitSource v = do
352overwriteThunk :: MonadObelisk m => FilePath -> ThunkPtr -> m ()
341overwriteThunk :: MonadObelisk m => FilePath -> ThunkPtr -> m ()
353overwriteThunk target thunk = do
342overwriteThunk target thunk = do
354 -- Ensure that this directory is a valid thunk (i.e. so we aren't losing any data)
343 -- Ensure that this directory is a valid thunk (i.e. so we aren't losing any data)
355− readThunk target >>= \case
344+ Right _ <- readThunk target
356− Left e -> failWith [i|Invalid thunk at ${target}: ${e}|]
359 --TODO: Is there a safer way to do this overwriting?
346 --TODO: Is there a safer way to do this overwriting?
360− liftIO $ removePathForcibly target
347+ liftIO $ removeDirectoryRecursive target
361− createThunk target $ Right thunk
348+ liftIO $ createThunk target thunk
363−thunkPtrToSpec :: ThunkPtr -> ThunkSpec
350+thunkPtrLoader :: ThunkPtr -> Text
364−thunkPtrToSpec thunk = case _thunkPtr_source thunk of
351+thunkPtrLoader thunk = case _thunkPtr_source thunk of
365− ThunkSource_GitHub _ -> NonEmpty.head gitHubThunkSpecs
352+ ThunkSource_GitHub _ -> NonEmpty.head gitHubStandaloneLoaders
366− ThunkSource_Git _ -> NonEmpty.head gitThunkSpecs
353+ ThunkSource_Git _ -> NonEmpty.head plainGitStandaloneLoaders
368-- It's important that formatting be very consistent here, because
355-- It's important that formatting be very consistent here, because
369-- otherwise when people update thunks, their patches will be messy
356-- otherwise when people update thunks, their patches will be messy
@@ -410,41 +397,35 @@ encodeThunkPtrData (ThunkPtr rev src) = case src of
410 , confTrailingNewline = True
397 , confTrailingNewline = True
413−createThunk :: MonadObelisk m => FilePath -> Either ThunkSpec ThunkPtr -> m ()
400+createThunk :: MonadIO m => FilePath -> ThunkPtr -> m ()
414−createThunk target ptrInfo =
401+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
402+ createDirectoryIfMissing True (target </> ".attr-cache")
427− f fullPath
403+ T.writeFile (target </> "default.nix") (thunkPtrLoader thunk)
405+ jsonFileName = case _thunkPtr_source thunk of
406+ ThunkSource_GitHub _ -> "github"
407+ ThunkSource_Git _ -> "git"
408+ LBS.writeFile (target </> jsonFileName <.> "json") (encodeThunkPtrData thunk)
429createThunkWithLatest :: MonadObelisk m => FilePath -> ThunkSource -> m ()
410createThunkWithLatest :: MonadObelisk m => FilePath -> ThunkSource -> m ()
430createThunkWithLatest target s = do
411createThunkWithLatest target s = do
431 rev <- getLatestRev s
412 rev <- getLatestRev s
432− createThunk target $ Right $ ThunkPtr
413+ createThunk target $ ThunkPtr
433 { _thunkPtr_source = s
414 { _thunkPtr_source = s
434 , _thunkPtr_rev = rev
415 , _thunkPtr_rev = rev
437updateThunkToLatest :: MonadObelisk m => ThunkUpdateConfig -> FilePath -> m ()
418updateThunkToLatest :: MonadObelisk m => ThunkUpdateConfig -> FilePath -> m ()
438−updateThunkToLatest (ThunkUpdateConfig mBranch thunkConfig) target = spinner $ do
419+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
420+ 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
421 -- check to see if thunk should be updated to a specific branch or just update it's current branch
441 case mBranch of
422 case mBranch of
442 Nothing -> do
423 Nothing -> do
443 (overwrite, ptr) <- readThunk target >>= \case
424 (overwrite, ptr) <- readThunk target >>= \case
444− Left err -> failWith [i|Thunk update: ${err}|]
425+ Left err -> failWith $ T.pack $ "thunk update: " <> show err
445 Right c -> case c of
426 Right c -> case c of
446− ThunkData_Packed _ t -> return (target, t)
427+ ThunkData_Packed t -> return (target, t)
447− ThunkData_Checkout -> failWith "cannot update an unpacked thunk"
428+ ThunkData_Checkout _ -> failWith "cannot update an unpacked thunk"
448 let src = _thunkPtr_source ptr
429 let src = _thunkPtr_source ptr
449 rev <- getLatestRev src
430 rev <- getLatestRev src
450 overwriteThunk overwrite $ modifyThunkPtrByConfig thunkConfig $ ThunkPtr
431 overwriteThunk overwrite $ modifyThunkPtrByConfig thunkConfig $ ThunkPtr
@@ -452,36 +433,38 @@ updateThunkToLatest (ThunkUpdateConfig mBranch thunkConfig) target = spinner $ d
452 , _thunkPtr_rev = rev
433 , _thunkPtr_rev = rev
454 Just branch -> readThunk target >>= \case
435 Just branch -> readThunk target >>= \case
455− Left err -> failWith [i|Thunk update: ${err}|]
436+ Left err -> failWith $ T.pack $ "thunk update: " <> show err
456 Right c -> case c of
437 Right c -> case c of
457− ThunkData_Packed _ t -> setThunk thunkConfig target (thunkSourceToGitSource $ _thunkPtr_source t) branch
438+ ThunkData_Packed t -> case _thunkPtr_source t of
439+ ThunkSource_Git tsg -> setThunk thunkConfig target tsg branch
440+ ThunkSource_GitHub tsgh -> do
441+ let tsg = forgetGithub False tsgh
442+ 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.|]
443+ 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 ()
445setThunk :: MonadObelisk m => ThunkConfig -> FilePath -> GitSource -> String -> m ()
463setThunk thunkConfig target gs branch = do
446setThunk thunkConfig target gs branch = do
464− newThunkPtr <- uriThunkPtr (_gitSource_url gs) (_thunkConfig_private thunkConfig) (Just $ T.pack branch) Nothing
447+ newThunkPtr <- uriThunkPtr (_gitSource_url gs) (Just $ T.pack branch) Nothing
465 overwriteThunk target newThunkPtr
448 overwriteThunk target newThunkPtr
466 updateThunkToLatest (ThunkUpdateConfig Nothing thunkConfig) target
449 updateThunkToLatest (ThunkUpdateConfig Nothing thunkConfig) target
468-- | All recognized github standalone loaders, ordered from newest to oldest.
451-- | 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.
452-- This tool will only ever produce the newest one when it writes a thunk.
470−gitHubThunkSpecs :: NonEmpty ThunkSpec
453+gitHubStandaloneLoaders :: NonEmpty Text
471−gitHubThunkSpecs =
454+gitHubStandaloneLoaders =
472− gitHubThunkSpecV5 :|
455+ gitHubStandaloneLoaderV4 :|
473− [ gitHubThunkSpecV4
456+ [ gitHubStandaloneLoaderV3
474− , gitHubThunkSpecV3
457+ , gitHubStandaloneLoaderV2
475− , gitHubThunkSpecV2
458+ , gitHubStandaloneLoaderV1
479−gitHubThunkSpecV1 :: ThunkSpec
461+gitHubStandaloneLoaderV1 :: Text
480−gitHubThunkSpecV1 = legacyGitHubThunkSpec "github-v1"
462+gitHubStandaloneLoaderV1 = T.unlines
481− "import ((import <nixpkgs> {}).fetchFromGitHub (builtins.fromJSON (builtins.readFile ./github.json)))"
463+ [ "import ((import <nixpkgs> {}).fetchFromGitHub (builtins.fromJSON (builtins.readFile ./github.json)))"
483−gitHubThunkSpecV2 :: ThunkSpec
466+gitHubStandaloneLoaderV2 :: Text
484−gitHubThunkSpecV2 = legacyGitHubThunkSpec "github-v2" $ T.unlines
467+gitHubStandaloneLoaderV2 = T.unlines
485 [ "# DO NOT HAND-EDIT THIS FILE" --TODO: Add something about how to get more info on Obelisk, etc.
468 [ "# DO NOT HAND-EDIT THIS FILE" --TODO: Add something about how to get more info on Obelisk, etc.
486 , "import ((import <nixpkgs> {}).fetchFromGitHub ("
469 , "import ((import <nixpkgs> {}).fetchFromGitHub ("
487 , " let json = builtins.fromJSON (builtins.readFile ./github.json);"
470 , " let json = builtins.fromJSON (builtins.readFile ./github.json);"
@@ -491,8 +474,8 @@ gitHubThunkSpecV2 = legacyGitHubThunkSpec "github-v2" $ T.unlines
494−gitHubThunkSpecV3 :: ThunkSpec
477+gitHubStandaloneLoaderV3 :: Text
495−gitHubThunkSpecV3 = legacyGitHubThunkSpec "github-v3" $ T.unlines
478+gitHubStandaloneLoaderV3 = T.unlines
496 [ "# DO NOT HAND-EDIT THIS FILE"
479 [ "# DO NOT HAND-EDIT THIS FILE"
498 , " fetch = { private ? false, ... }@args: if private && builtins.hasAttr \"fetchGit\" builtins"
481 , " fetch = { private ? false, ... }@args: if private && builtins.hasAttr \"fetchGit\" builtins"
@@ -511,8 +494,8 @@ gitHubThunkSpecV3 = legacyGitHubThunkSpec "github-v3" $ T.unlines
511 , "in import (fetch (builtins.fromJSON (builtins.readFile ./github.json)))"
494 , "in import (fetch (builtins.fromJSON (builtins.readFile ./github.json)))"
514−gitHubThunkSpecV4 :: ThunkSpec
497+gitHubStandaloneLoaderV4 :: Text
515−gitHubThunkSpecV4 = legacyGitHubThunkSpec "github-v4" $ T.unlines
498+gitHubStandaloneLoaderV4 = T.unlines
516 [ "# DO NOT HAND-EDIT THIS FILE"
499 [ "# DO NOT HAND-EDIT THIS FILE"
517 , "let fetch = { private ? false, fetchSubmodules ? false, owner, repo, rev, sha256, ... }:"
500 , "let fetch = { private ? false, fetchSubmodules ? false, owner, repo, rev, sha256, ... }:"
518 , " if !fetchSubmodules && !private then builtins.fetchTarball {"
501 , " if !fetchSubmodules && !private then builtins.fetchTarball {"
@@ -523,50 +506,23 @@ gitHubThunkSpecV4 = legacyGitHubThunkSpec "github-v4" $ T.unlines
523 , "in import (fetch (builtins.fromJSON (builtins.readFile ./github.json)))"
506 , "in import (fetch (builtins.fromJSON (builtins.readFile ./github.json)))"
526−legacyGitHubThunkSpec :: Text -> Text -> ThunkSpec
509+plainGitStandaloneLoaders :: NonEmpty Text
527−legacyGitHubThunkSpec name loader = ThunkSpec name $ Map.fromList
510+plainGitStandaloneLoaders =
528− [ ("default.nix", ThunkFileSpec_FileMatches $ T.strip loader)
511+ plainGitStandaloneLoaderV3 :|
529− , ("github.json" , ThunkFileSpec_Ptr parseGitHubJsonBytes)
512+ [ plainGitStandaloneLoaderV1
530− , (attrCacheFileName, ThunkFileSpec_AttrCache)
513+ , 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
516+plainGitStandaloneLoaderV1 :: Text
561−gitThunkSpecV1 = legacyGitThunkSpec "git-v1" $ T.unlines
517+plainGitStandaloneLoaderV1 = T.unlines
562 [ "# DO NOT HAND-EDIT THIS FILE"
518 [ "# DO NOT HAND-EDIT THIS FILE"
563 , "let fetchGit = {url, rev, ref ? null, branch ? null, sha256 ? null, fetchSubmodules ? null}:"
519 , "let fetchGit = {url, rev, ref ? null, branch ? null, sha256 ? null, fetchSubmodules ? null}:"
564 , " assert !fetchSubmodules; (import <nixpkgs> {}).fetchgit { inherit url rev sha256; };"
520 , " assert !fetchSubmodules; (import <nixpkgs> {}).fetchgit { inherit url rev sha256; };"
565 , "in import (fetchGit (builtins.fromJSON (builtins.readFile ./git.json)))"
521 , "in import (fetchGit (builtins.fromJSON (builtins.readFile ./git.json)))"
568−gitThunkSpecV2 :: ThunkSpec
524+plainGitStandaloneLoaderV2 :: Text
569−gitThunkSpecV2 = legacyGitThunkSpec "git-v2" $ T.unlines
525+plainGitStandaloneLoaderV2 = T.unlines
570 [ "# DO NOT HAND-EDIT THIS FILE"
526 [ "# DO NOT HAND-EDIT THIS FILE"
571 , "let fetchGit = {url, rev, ref ? null, branch ? null, sha256 ? null, fetchSubmodules ? null}:"
527 , "let fetchGit = {url, rev, ref ? null, branch ? null, sha256 ? null, fetchSubmodules ? null}:"
572 , " if builtins.hasAttr \"fetchGit\" builtins"
528 , " if builtins.hasAttr \"fetchGit\" builtins"
@@ -575,10 +531,8 @@ gitThunkSpecV2 = legacyGitThunkSpec "git-v2" $ T.unlines
575 , "in import (fetchGit (builtins.fromJSON (builtins.readFile ./git.json)))"
531 , "in import (fetchGit (builtins.fromJSON (builtins.readFile ./git.json)))"
578−-- This loader has a bug because @builtins.fetchGit@ is not given a @ref@
534+plainGitStandaloneLoaderV3 :: Text
579−-- and will fail to find commits without this because it does shallow clones.
535+plainGitStandaloneLoaderV3 = T.unlines
580−gitThunkSpecV3 :: ThunkSpec
581−gitThunkSpecV3 = legacyGitThunkSpec "git-v3" $ T.unlines
582 [ "# DO NOT HAND-EDIT THIS FILE"
536 [ "# DO NOT HAND-EDIT THIS FILE"
583 , "let fetch = {url, rev, ref ? null, sha256 ? null, fetchSubmodules ? false, private ? false, ...}:"
537 , "let fetch = {url, rev, ref ? null, sha256 ? null, fetchSubmodules ? false, private ? false, ...}:"
584 , " let realUrl = let firstChar = builtins.substring 0 1 url; in"
538 , " let realUrl = let firstChar = builtins.substring 0 1 url; in"
@@ -593,69 +547,10 @@ gitThunkSpecV3 = legacyGitThunkSpec "git-v3" $ T.unlines
593 , "in import (fetch (builtins.fromJSON (builtins.readFile ./git.json)))"
547 , "in import (fetch (builtins.fromJSON (builtins.readFile ./git.json)))"
596−gitThunkSpecV4 :: ThunkSpec
550+thunkFileNames :: [FilePath]
597−gitThunkSpecV4 = legacyGitThunkSpec "git-v4" $ T.unlines
551+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
553+--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
555-- | Checks a cache directory to see if there is a fresh symlink
661-- to the result of building an attribute of a thunk.
556-- to the result of building an attribute of a thunk.
@@ -663,49 +558,44 @@ parseJsonObject p bytes = Aeson.parseEither p =<< Aeson.eitherDecode bytes
663-- and the result is symlinked into the cache.
558-- and the result is symlinked into the cache.
664nixBuildThunkAttrWithCache
559nixBuildThunkAttrWithCache
665 :: MonadObelisk m
560 :: MonadObelisk m
667− -> FilePath
561+ => FilePath
668 -- ^ Path to directory containing Thunk
562 -- ^ Path to directory containing Thunk
669 -> String
563 -> String
670 -- ^ Attribute to build
564 -- ^ Attribute to build
671− -> m (Maybe FilePath)
565+ -> m FilePath
672 -- ^ Symlink to cached or built nix output
566 -- ^ Symlink to cached or built nix output
673-- WARNING: If the thunk uses an impure reference such as '<nixpkgs>'
567-- WARNING: If the thunk uses an impure reference such as '<nixpkgs>'
674-- the caching mechanism will fail as it merely measures the modification
568-- the caching mechanism will fail as it merely measures the modification
675-- time of the cache link and the expression to build.
569-- time of the cache link and the expression to build.
676−nixBuildThunkAttrWithCache thunkSpec thunkDir attr = do
570+nixBuildThunkAttrWithCache thunkDir attr = do
571+ --NB: Expects thunkDir to be normalised with no trailing path separator.
572+ --This should be guaranteed by the command argument parser.
573+ let cacheErrHandler e
574+ | isDoesNotExistError e = return Nothing -- expected from a cache miss
575+ | otherwise = putLog Error (T.pack $ displayException e) >> return Nothing
576+ cacheDir = thunkDir </> ".attr-cache"
577+ cachePath = cacheDir </> attr <.> "out"
677 latestChange <- liftIO $ do
578 latestChange <- liftIO $ do
678− let
579+ createDirectoryIfMissing False cacheDir
679− getModificationTimeMaybe = fmap rightToMaybe . try @IOError . getModificationTime
580+ let getModificationTimeMaybe = fmap rightToMaybe . try @IOError . getModificationTime
680− thunkFileNames = Map.keys $ _thunkSpec_files thunkSpec
681− maximum . catMaybes <$> traverse (getModificationTimeMaybe . (thunkDir </>)) thunkFileNames
581+ 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
582+ cacheHit <- handle cacheErrHandler $ do
693− cacheTime <- liftIO $ posixSecondsToUTCTime . realToFrac . modificationTime <$> getSymbolicLinkStatus cachePath
583+ cacheTime <- liftIO $ posixSecondsToUTCTime . realToFrac . modificationTime <$> getSymbolicLinkStatus cachePath
694− pure $ if latestChange <= cacheTime
584+ return $ if latestChange <= cacheTime
695− then Just cachePath
585+ then Just cachePath
696− else Nothing
586+ else Nothing
697− case cacheHit of
587+ case cacheHit of
698− Just c -> pure c
588+ Just c -> return c
699− Nothing -> do
589+ Nothing -> do
700− putLog Warning $ T.pack $ mconcat [thunkDir, ": ", attr, " not cached, building ..."]
590+ putLog Warning $ T.pack $ mconcat [thunkDir, ": ", attr, " not cached, building ..."]
701− liftIO $ createDirectoryIfMissing True (takeDirectory cachePath)
702− (cachePath <$) $ nixCmd $ NixCmd_Build $ def
591+ _ <- nixCmd $ NixCmd_Build $ def
703− & nixBuildConfig_outLink .~ OutLink_IndirectRoot cachePath
592+ Lens.& nixBuildConfig_outLink Lens..~ OutLink_IndirectRoot cachePath
704− & nixCmdConfig_target .~ Target
593+ Lens.& nixCmdConfig_target Lens..~ Target
705− { _target_path = Just thunkDir
594+ { _target_path = Just thunkDir
706− , _target_attr = Just attr
595+ , _target_attr = Just attr
707− , _target_expr = Nothing
596+ , _target_expr = Nothing
710-- | Build a nix attribute, and cache the result if possible
600-- | Build a nix attribute, and cache the result if possible
711nixBuildAttrWithCache
601nixBuildAttrWithCache
@@ -716,15 +606,13 @@ nixBuildAttrWithCache
716 -- ^ Attribute to build
606 -- ^ Attribute to build
717 -> m FilePath
607 -> m FilePath
718 -- ^ Symlink to cached or built nix output
608 -- ^ Symlink to cached or built nix output
719−nixBuildAttrWithCache exprPath attr = readThunk exprPath >>= \case
609+nixBuildAttrWithCache exprPath attr = do
610+ readThunk exprPath >>= \case
720− -- Only packed thunks are cached. In particular, checkouts are not.
611+ -- Only packed thunks are cached. in particular, checkouts are not
721− Right (ThunkData_Packed spec _) ->
722− maybe build pure =<< nixBuildThunkAttrWithCache spec exprPath attr
612+ Right (ThunkData_Packed _) -> nixBuildThunkAttrWithCache exprPath attr
725− build = nixCmd $ NixCmd_Build $ def
613+ _ -> nixCmd $ NixCmd_Build $ def
726− & nixBuildConfig_outLink .~ OutLink_None
614+ Lens.& nixBuildConfig_outLink Lens..~ OutLink_None
727− & nixCmdConfig_target .~ Target
615+ Lens.& nixCmdConfig_target Lens..~ Target
728 { _target_path = Just exprPath
616 { _target_path = Just exprPath
729 , _target_attr = Just attr
617 , _target_attr = Just attr
730 , _target_expr = Nothing
618 , _target_expr = Nothing
@@ -745,7 +633,7 @@ updateThunk p f = withSystemTempDirectory "obelisk-thunkptr-" $ \tmpDir -> do
746 copyThunkToTmp tmpDir thunkDir = readThunk thunkDir >>= \case
634 copyThunkToTmp tmpDir thunkDir = readThunk thunkDir >>= \case
747 Left err -> failWith $ "withThunkUnpacked: " <> T.pack (show err)
635 Left err -> failWith $ "withThunkUnpacked: " <> T.pack (show err)
748− Right ThunkData_Packed{} -> do
636+ Right (ThunkData_Packed _) -> do
749 let tmpThunk = tmpDir </> "thunk"
637 let tmpThunk = tmpDir </> "thunk"
750 callProcessAndLogOutput (Notice, Error) $
638 callProcessAndLogOutput (Notice, Error) $
751 proc cp ["-r", "-T", thunkDir, tmpThunk]
639 proc cp ["-r", "-T", thunkDir, tmpThunk]
@@ -759,81 +647,62 @@ updateThunk p f = withSystemTempDirectory "obelisk-thunkptr-" $ \tmpDir -> do
759finalMsg :: Bool -> (a -> Text) -> Maybe (a -> Text)
647finalMsg :: Bool -> (a -> Text) -> Maybe (a -> Text)
760finalMsg noTrail s = if noTrail then Nothing else Just s
648finalMsg noTrail s = if noTrail then Nothing else Just s
650+unpackThunk :: MonadObelisk m => FilePath -> m ()
651+unpackThunk = unpackThunk' False
762-- | Check that we are not somewhere inside the thunk directory
653-- | Check that we are not somewhere inside the thunk directory
763−checkThunkDirectory :: MonadObelisk m => FilePath -> m ()
654+checkThunkDirectory :: MonadObelisk m => Text -> FilePath -> m ()
764−checkThunkDirectory thunkDir = do
655+checkThunkDirectory msg thunkDir = do
765 currentDir <- liftIO getCurrentDirectory
656 currentDir <- liftIO getCurrentDirectory
766 thunkDir' <- liftIO $ canonicalizePath thunkDir
657 thunkDir' <- liftIO $ canonicalizePath thunkDir
767− when (thunkDir' `L.isInfixOf` currentDir) $
658+ 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 ()
660unpackThunk' :: MonadObelisk m => Bool -> FilePath -> m ()
780−unpackThunk' noTrail thunkDir = checkThunkDirectory thunkDir *> readThunk thunkDir >>= \case
661+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}|]
662+ 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
663 --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|]
664+ Right (ThunkData_Checkout _) -> failWith "thunk unpack: thunk is already unpacked"
784− Right (ThunkData_Packed _ tptr) -> do
665+ Right (ThunkData_Packed tptr) -> do
785 let (thunkParent, thunkName) = splitFileName thunkDir
666 let (thunkParent, thunkName) = splitFileName thunkDir
786− withTempDirectory thunkParent thunkName $ \tmpThunk -> do
667+ withTempDirectory thunkParent thunkName $ \tmpRepo -> do
787− let
668+ let obGitDir = tmpRepo </> ".git" </> "obelisk"
788− gitSrc = thunkSourceToGitSource $ _thunkPtr_source tptr
789− newSpec = case _thunkPtr_source tptr of
669+ s = case _thunkPtr_source tptr of
790− ThunkSource_GitHub _ -> NonEmpty.head gitHubThunkSpecs
670+ ThunkSource_GitHub s' -> forgetGithub False s'
791− ThunkSource_Git _ -> NonEmpty.head gitThunkSpecs
671+ ThunkSource_Git s' -> s'
792 withSpinner' ("Fetching thunk " <> T.pack thunkName)
672 withSpinner' ("Fetching thunk " <> T.pack thunkName)
793 (finalMsg noTrail $ const $ "Fetched thunk " <> T.pack thunkName) $ do
673 (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
674+ let git = callProcessAndLogOutput (Notice, Notice) . gitProc tmpRepo
813− git $ [ "clone" ]
675+ git $ [ "clone" ]
814− ++ ["--recursive" | _gitSource_fetchSubmodules gitSrc]
676+ ++ ("--recursive" <$ guard (_gitSource_fetchSubmodules s))
815− ++ [ T.unpack $ gitUriToText $ _gitSource_url gitSrc ]
677+ ++ [ T.unpack $ gitUriToText $ _gitSource_url s ]
816− ++ do branch <- maybeToList $ _gitSource_branch gitSrc
678+ ++ do branch <- maybeToList $ _gitSource_branch s
817− [ "--branch", T.unpack $ untagName branch ]
679+ [ "--branch", T.unpack $ untagName branch ]
818− git ["reset", "--hard", Ref.toHexString commit]
680+ git ["reset", "--hard", Ref.toHexString $ _thunkRev_commit $ _thunkPtr_rev tptr]
819− when (_gitSource_fetchSubmodules gitSrc) $
681+ when (_gitSource_fetchSubmodules s) $
820− git ["submodule", "update", "--recursive", "--init"]
682+ git ["submodule", "update", "--recursive", "--init"]
684+ liftIO $ createDirectory obGitDir
685+ callProcessAndLogOutput (Notice, Error) $
686+ proc cp ["-r", "-T", thunkDir </> ".", obGitDir </> "orig-thunk"]
687+ callProcessAndLogOutput (Notice, Error) $
688+ proc "rm" ["-r", thunkDir]
689+ callProcessAndLogOutput (Notice, Error) $
690+ proc "mv" ["-T", tmpRepo, thunkDir]
822--TODO: add a rollback mode to pack to the original thunk
692--TODO: add a rollback mode to pack to the original thunk
823packThunk :: MonadObelisk m => ThunkPackConfig -> FilePath -> m ThunkPtr
693packThunk :: MonadObelisk m => ThunkPackConfig -> FilePath -> m ThunkPtr
824packThunk = packThunk' False
694packThunk = packThunk' False
826packThunk' :: MonadObelisk m => Bool -> ThunkPackConfig -> FilePath -> m ThunkPtr
696packThunk' :: MonadObelisk m => Bool -> ThunkPackConfig -> FilePath -> m ThunkPtr
827−packThunk' noTrail (ThunkPackConfig force thunkConfig) thunkDir = checkThunkDirectory thunkDir *> readThunk thunkDir >>= \case
697+packThunk' noTrail (ThunkPackConfig force thunkConfig) thunkDir = checkThunkDirectory "Can't pack/unpack from within the thunk directory" thunkDir >> readThunk thunkDir >>= \case
698+ Left err -> failWith $ T.pack $ "thunk pack: " <> show err
828− Right ThunkData_Packed{} -> failWith [i|Thunk at ${thunkDir} is is already packed|]
699+ Right (ThunkData_Packed _) -> failWith "pack: thunk is already packed"
829− _ -> withSpinner'
700+ Right (ThunkData_Checkout _) -> do
830− ("Packing thunk " <> T.pack thunkDir)
701+ withSpinner' ("Packing thunk " <> T.pack thunkDir)
831− (finalMsg noTrail $ const $ "Packed thunk " <> T.pack thunkDir) $
702+ (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)
703+ thunkPtr <- modifyThunkPtrByConfig thunkConfig <$> getThunkPtr (not force) thunkDir
835− liftIO $ removePathForcibly thunkDir
704+ callProcessAndLogOutput (Debug, Error) $ proc "rm" ["-rf", thunkDir]
836− createThunk thunkDir $ Right thunkPtr
705+ liftIO $ createThunk thunkDir thunkPtr
837 pure thunkPtr
706 pure thunkPtr
839modifyThunkPtrByConfig :: ThunkConfig -> ThunkPtr -> ThunkPtr
708modifyThunkPtrByConfig :: ThunkConfig -> ThunkPtr -> ThunkPtr
@@ -844,43 +713,29 @@ modifyThunkPtrByConfig (ThunkConfig markPrivate') ptr = case markPrivate' of
844 ThunkSource_GitHub s -> ThunkSource_GitHub $ s { _gitHubSource_private = markPrivate }
713 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
716+getThunkPtr :: forall m. MonadObelisk m => Bool -> FilePath -> m ThunkPtr
856−getThunkPtr gitCheckClean dir mPrivate = do
717+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
718+ when checkClean $ ensureCleanGitRepo thunkDir True
869 "thunk pack: thunk checkout contains unsaved modifications"
719 "thunk pack: thunk checkout contains unsaved modifications"
871 -- Check whether there are any stashes
721 -- Check whether there are any stashes
872− when checkClean $ do
873− stashOutput <- readGitProcess thunkDir ["stash", "list"]
722+ stashOutput <- readGitProcess thunkDir ["stash", "list"]
874− unless (T.null stashOutput) $
723+ when checkClean $ case T.null stashOutput of
875 failWith $ T.unlines $
725 failWith $ T.unlines $
876 [ "thunk pack: thunk checkout has stashes"
726 [ "thunk pack: thunk checkout has stashes"
877 , "git stash list:"
727 , "git stash list:"
878 ] ++ T.lines stashOutput
728 ] ++ T.lines stashOutput
880− -- Get current branch
731+ -- Get current branch ``
881 (mCurrentBranch, mCurrentCommit) <- do
732 (mCurrentBranch, mCurrentCommit) <- do
882− b <- listToMaybe . T.lines <$> readGitProcess thunkDir ["rev-parse", "--abbrev-ref", "HEAD"]
735+ <$> readGitProcess thunkDir ["rev-parse", "--abbrev-ref", "HEAD"]
883− c <- listToMaybe . T.lines <$> readGitProcess thunkDir ["rev-parse", "HEAD"]
738+ <$> readGitProcess thunkDir ["rev-parse", "HEAD"]
884 case b of
739 case b of
885 (Just "HEAD") -> failWith $ T.unlines
740 (Just "HEAD") -> failWith $ T.unlines
886 [ "thunk pack: You are in 'detached HEAD' state."
741 [ "thunk pack: You are in 'detached HEAD' state."
@@ -891,7 +746,7 @@ getThunkPtr gitCheckClean dir mPrivate = do
892 -- Get information on all branches and their (optional) designated upstream
747 -- Get information on all branches and their (optional) designated upstream
893 -- correspondents
748 -- correspondents
894− headDump :: [Text] <- T.lines <$> readGitProcess thunkDir
749+ (headDump :: [Text]) <- T.lines <$> readGitProcess thunkDir
895 [ "for-each-ref"
750 [ "for-each-ref"
896 , "--format=%(refname:short) %(upstream:short) %(upstream:remotename)"
751 , "--format=%(refname:short) %(upstream:short) %(upstream:remotename)"
897 , "refs/heads/"
752 , "refs/heads/"
@@ -937,7 +792,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
794 -- 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
795+ stats <- iforM headUpstream $ \branch (upstream, _remote) -> do
941 (stat :: [Text]) <- T.lines <$> readGitProcess thunkDir
796 (stat :: [Text]) <- T.lines <$> readGitProcess thunkDir
942 [ "rev-list", "--left-right"
797 [ "rev-list", "--left-right"
943 , T.unpack branch <> "..." <> T.unpack upstream
798 , T.unpack branch <> "..." <> T.unpack upstream
@@ -961,9 +816,8 @@ getThunkPtr gitCheckClean dir mPrivate = do
961 \pushed but this repo's remote tracking branches don't know it.)"
816 \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
819+ -- 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."
820+ putLog Informational "All changes safe in git remotes. OK to pack thunk."
968 let remote = maybe "origin" snd $ flip Map.lookup headUpstream =<< mCurrentBranch
822 let remote = maybe "origin" snd $ flip Map.lookup headUpstream =<< mCurrentBranch
@@ -976,12 +830,14 @@ getThunkPtr gitCheckClean dir mPrivate = do
976 remoteUri <- case parseGitUri remoteUri' of
830 remoteUri <- case parseGitUri remoteUri' of
977 Nothing -> failWith $ "Could not identify git remote: " <> remoteUri'
831 Nothing -> failWith $ "Could not identify git remote: " <> remoteUri'
978 Just uri -> pure uri
832 Just uri -> pure uri
979− uriThunkPtr remoteUri mPrivate mCurrentBranch mCurrentCommit
833+ uriThunkPtr remoteUri mCurrentBranch mCurrentCommit
981-- | Get the latest revision available from the given source
835-- | Get the latest revision available from the given source
982getLatestRev :: MonadObelisk m => ThunkSource -> m ThunkRev
836getLatestRev :: MonadObelisk m => ThunkSource -> m ThunkRev
983getLatestRev os = do
837getLatestRev os = do
984− let gitS = thunkSourceToGitSource os
838+ let gitS = case os of
839+ ThunkSource_GitHub s -> forgetGithub False s
840+ ThunkSource_Git s -> s
985 (_, commit) <- gitGetCommitBranch (_gitSource_url gitS) (untagName <$> _gitSource_branch gitS)
841 (_, commit) <- gitGetCommitBranch (_gitSource_url gitS) (untagName <$> _gitSource_branch gitS)
986 case os of
842 case os of
987 ThunkSource_GitHub s -> githubThunkRev s commit
843 ThunkSource_GitHub s -> githubThunkRev s commit
@@ -993,12 +849,12 @@ getLatestRev os = do
993-- performance. If that doesn't work (e.g. authentication issue), we fall back
849-- 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
850-- on just doing things the normal way for git repos in general, and save it as
995-- a regular git thunk.
851-- a regular git thunk.
996−uriThunkPtr :: MonadObelisk m => GitUri -> Maybe Bool -> Maybe Text -> Maybe Text -> m ThunkPtr
852+uriThunkPtr :: MonadObelisk m => GitUri -> Maybe Text -> Maybe Text -> m ThunkPtr
997−uriThunkPtr uri mPrivate mbranch mcommit = do
853+uriThunkPtr uri mbranch mcommit = do
998 commit <- case mcommit of
854 commit <- case mcommit of
999− Nothing -> gitGetCommitBranch uri mbranch >>= return . snd
855+ Nothing -> gitGetCommitBranch uri mbranch >>= return . snd -- return . (\(_, y, _)->y) --perhaps do io here instead of making uriToTHunkSource effectful ?
1000 (Just c) -> return c
856 (Just c) -> return c
1001− (src, rev) <- uriToThunkSource uri mPrivate mbranch >>= \case
857+ (src, rev) <- uriToThunkSource uri mbranch >>= \case
1002 ThunkSource_GitHub s -> do
858 ThunkSource_GitHub s -> do
1003 rev <- runExceptT $ githubThunkRev s commit
859 rev <- runExceptT $ githubThunkRev s commit
1004 case rev of
860 case rev of
@@ -1021,8 +877,8 @@ uriThunkPtr uri mPrivate mbranch mcommit = do
1021-- If the thunk is a GitHub thunk and fails, we do *not* fall back like with
877-- 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
878-- `uriThunkPtr`. Unlike a plain URL, a thunk src explicitly states which method
1023-- should be employed, and so we respect that.
879-- should be employed, and so we respect that.
1024−uriToThunkSource :: MonadObelisk m => GitUri -> Maybe Bool -> Maybe Text -> m ThunkSource
880+uriToThunkSource :: MonadObelisk m => GitUri -> Maybe Text -> m ThunkSource
1025−uriToThunkSource (GitUri u) mPrivate
881+uriToThunkSource (GitUri u)
1026 | Right uriAuth <- URI.uriAuthority u
882 | Right uriAuth <- URI.uriAuthority u
1027 , Just scheme <- URI.unRText <$> URI.uriScheme u
883 , Just scheme <- URI.unRText <$> URI.uriScheme u
1028 , case scheme of
884 , case scheme of
@@ -1034,53 +890,40 @@ uriToThunkSource (GitUri u) mPrivate
1034 s -> s `L.elem` [ "git", "https", "http" ] -- "http:" just redirects to "https:"
890 s -> s `L.elem` [ "git", "https", "http" ] -- "http:" just redirects to "https:"
1035 && URI.unRText (URI.authHost uriAuth) == "github.com"
891 && URI.unRText (URI.authHost uriAuth) == "github.com"
1036 , Just (_, owner :| [repoish]) <- URI.uriPath u
892 , Just (_, owner :| [repoish]) <- URI.uriPath u
1037− = \mbranch -> do
893+ = \mbranch ->
1038− isPrivate <- getIsPrivate
894+ do
895+ unAuthenticatedExitCode <-
896+ fmap (\(x, _, _)->x)
897+ . readCreateProcessWithExitCode
898+ . isolateGitProc . gitProcNoRepo $
903+ { URI.uriScheme=URI.mkScheme "https"
904+ , URI.uriAuthority=Left True}]
1039− pure $ ThunkSource_GitHub $ GitHubSource
905+ pure . ThunkSource_GitHub $ GitHubSource
1040 { _gitHubSource_owner = N $ URI.unRText owner
906 { _gitHubSource_owner = N $ URI.unRText owner
1041 , _gitHubSource_repo = N $ let
907 , _gitHubSource_repo = N $ let
1042 repoish' = URI.unRText repoish
908 repoish' = URI.unRText repoish
1043 in fromMaybe repoish' $ T.stripSuffix ".git" repoish'
909 in fromMaybe repoish' $ T.stripSuffix ".git" repoish'
1044 , _gitHubSource_branch = N <$> mbranch
910 , _gitHubSource_branch = N <$> mbranch
1045− , _gitHubSource_private = isPrivate
911+ , _gitHubSource_private = unAuthenticatedExitCode /= ExitSuccess
1048− | otherwise = \mbranch -> do
914+ | otherwise = \mbranch ->
1049− isPrivate <- getIsPrivate
915+ do
916+ unAuthenticatedExitCode <-
917+ fmap (\(x, _, _)->x)
918+ . readCreateProcessWithExitCode
919+ . isolateGitProc . gitProcNoRepo $
920+ ["ls-remote", "--exit-code", "--symref", show u]
1050− pure $ ThunkSource_Git $ GitSource
921+ pure . ThunkSource_Git $ GitSource
1051 { _gitSource_url = GitUri u
922 { _gitSource_url = GitUri u
1052 , _gitSource_branch = N <$> mbranch
923 , _gitSource_branch = N <$> mbranch
1053 , _gitSource_fetchSubmodules = False -- TODO: How do we determine if this should be true?
924 , _gitSource_fetchSubmodules = False -- TODO: How do we determine if this should be true?
1054− , _gitSource_private = isPrivate
925+ , _gitSource_private = unAuthenticatedExitCode /= ExitSuccess
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.
928-- Funny signature indicates no effects depend on the optional branch name.
1086githubThunkRev
929githubThunkRev