@@ -5,58 +5,74 @@
55{-# LANGUAGE MultiWayIf #-}
66{-# LANGUAGE OverloadedStrings #-}
77{-# LANGUAGE PatternGuards #-}
8−{-# LANGUAGE QuasiQuotes #-}
98{-# LANGUAGE ScopedTypeVariables #-}
109{-# LANGUAGE TypeApplications #-}
11−module Obelisk.Command.Thunk where
10+module Obelisk.Command.Thunk
11+ ( GitHubSource (..)
12+ , GitUri (..)
13+ , ReadThunkError (..)
14+ , ThunkConfig (..)
15+ , ThunkData (..)
16+ , ThunkPackConfig (..)
17+ , ThunkPtr (..)
18+ , ThunkRev (..)
19+ , ThunkSource (..)
20+ , ThunkUpdateConfig (..)
21+ , createThunk
22+ , createThunkWithLatest
23+ , getLatestRev
24+ , getThunkGitBranch
25+ , getThunkPtr
26+ , gitUriToText
27+ , nixBuildAttrWithCache
28+ , nixBuildThunkAttrWithCache
29+ , packThunk
30+ , parseGitUri
31+ , readThunk
32+ , unpackThunk
33+ , updateThunk
34+ , updateThunkToLatest
35+ , uriThunkPtr
36+ ) where
1237
1338import Control.Applicative
1439import Control.Exception (displayException, try)
15−import Control.Lens (ifor, ifor_, (.~))
40+import qualified Control.Lens as Lens
41+import Control.Lens.Indexed hiding ((<.>))
1642import Control.Monad
17−import Control.Monad.Extra (findM)
18−import Control.Monad.Catch (MonadCatch, handle)
43+import Control.Monad.Catch (handle)
1944import Control.Monad.Except
2045import Data.Aeson ((.=))
2146import qualified Data.Aeson as Aeson
2247import Data.Aeson.Encode.Pretty
2348import qualified Data.Aeson.Types as Aeson
24−import Data.Bifunctor (first)
2549import qualified Data.ByteString.Lazy as LBS
26−import Data.Containers.ListUtils (nubOrd)
2750import Data.Default
2851import Data.Either.Combinators (fromRight', rightToMaybe)
29−import Data.Foldable (toList)
30−import Data.Function ((&))
31−import Data.Functor ((<&>))
3252import Data.Git.Ref (Ref)
3353import qualified Data.Git.Ref as Ref
3454import qualified Data.List as L
35−import Data.List.NonEmpty (NonEmpty (..), nonEmpty)
55+import Data.List.NonEmpty (NonEmpty (..))
3656import qualified Data.List.NonEmpty as NonEmpty
3757import Data.Map (Map)
3858import qualified Data.Map as Map
3959import Data.Maybe
4060import Data.Set (Set)
4161import qualified Data.Set as Set
42−import Data.String.Here.Interpolated (i)
43−import Data.String.Here.Uninterpolated (here)
4462import Data.Text (Text)
4563import qualified Data.Text as T
4664import Data.Text.Encoding
4765import qualified Data.Text.IO as T
4866import Data.Time.Clock.POSIX (posixSecondsToUTCTime)
49−import Data.Traversable (for)
5067import Data.Yaml (parseMaybe)
5168import GitHub
5269import GitHub.Data.Name
5370import Obelisk.Command.Nix
5471import System.Directory
55−import System.Exit
5672import System.FilePath
5773import System.IO.Error
5874import System.IO.Temp
59−import System.PosixCompat.Files (getSymbolicLinkStatus, modificationTime)
75+import System.Posix (getSymbolicLinkStatus, modificationTime)
6076import qualified Text.URI as URI
6177
6278import Obelisk.App (MonadObelisk)
@@ -65,10 +81,11 @@ import Obelisk.Command.Utils
6581
6682--TODO: Support symlinked thunk data
6783data ThunkData
68− = ThunkData_Packed ThunkSpec ThunkPtr
84+ = ThunkData_Packed ThunkPtr
6985 -- ^ Packed thunk
70− | ThunkData_Checkout
86+ | ThunkData_Checkout (Maybe ThunkPtr)
7187 -- ^ Checked out thunk that was unpacked from this pointer
88+ deriving (Show, Eq, Ord)
7289
7390-- | A reference to the exact data that a thunk should translate into
7491data ThunkPtr = ThunkPtr
@@ -94,11 +111,6 @@ data ThunkSource
94111 | ThunkSource_Git GitSource
95112 deriving (Show, Eq, Ord)
96113
97−thunkSourceToGitSource :: ThunkSource -> GitSource
98−thunkSourceToGitSource = \case
99− ThunkSource_GitHub s -> forgetGithub False s
100− ThunkSource_Git s -> s
101−
102114data GitHubSource = GitHubSource
103115 { _gitHubSource_owner :: Name Owner
104116 , _gitHubSource_repo :: Name Repo
@@ -107,7 +119,7 @@ data GitHubSource = GitHubSource
107119 }
108120 deriving (Show, Eq, Ord)
109121
110−newtype GitUri = GitUri { unGitUri :: URI.URI } deriving (Eq, Ord, Show)
122+newtype GitUri = GitUri URI.URI deriving (Eq, Ord, Show)
111123
112124gitUriToText :: GitUri -> Text
113125gitUriToText (GitUri uri)
@@ -178,14 +190,14 @@ getNixSha256ForUriUnpacked
178190getNixSha256ForUriUnpacked uri =
179191 withExitFailMessage ("nix-prefetch-url: Failed to determine sha256 hash of URL " <> gitUriToText uri) $ do
180192 [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]
182194 pure hash
183195
184196nixPrefetchGit :: MonadObelisk m => GitUri -> Text -> Bool -> m NixSha256
185197nixPrefetchGit uri rev fetchSubmodules =
186198 withExitFailMessage ("nix-prefetch-git: Failed to determine sha256 hash of Git repo " <> gitUriToText uri <> " at " <> rev) $ do
187199 out <- readProcessAndLogStderr Debug $
188− proc nixPrefetchGitPath $ filter (/="")
200+ proc "nix-prefetch-git" $ filter (/="")
189201 [ "--url", T.unpack $ gitUriToText uri
190202 , "--rev", T.unpack rev
191203 , if fetchSubmodules then "--fetch-submodules" else ""
@@ -198,117 +210,93 @@ nixPrefetchGit uri rev fetchSubmodules =
198210
199211--TODO: Pretty print these
200212data ReadThunkError
201− = ReadThunkError_UnrecognizedThunk
202− | ReadThunkError_UnrecognizedPaths (NonEmpty FilePath)
203− | ReadThunkError_MissingPaths (NonEmpty FilePath)
204− | ReadThunkError_UnparseablePtr FilePath String
205− | ReadThunkError_FileError IOError
206− | ReadThunkError_FileDoesNotMatch FilePath Text
207− | ReadThunkError_UnrecognizedState String
208− | ReadThunkError_AmbiguousPackedState ThunkPtr ThunkPtr
209− deriving (Show)
210−
211−unpackedDirName :: FilePath
212−unpackedDirName = "."
213−
214−attrCacheFileName :: FilePath
215−attrCacheFileName = ".attr-cache"
216−
217−-- | Specification for how a file in a thunk version works.
218−data ThunkFileSpec
219− = ThunkFileSpec_Ptr (LBS.ByteString -> Either String ThunkPtr) -- ^ This file specifies 'ThunkPtr' data
220− | ThunkFileSpec_FileMatches Text -- ^ This file must match the given content exactly
221− | ThunkFileSpec_CheckoutIndicator -- ^ Existence of this directory indicates that the thunk is unpacked
222− | ThunkFileSpec_AttrCache -- ^ This directory is an attribute cache
223−
224−-- | Specification for how a set of files in a thunk version work.
225−data ThunkSpec = ThunkSpec
226− { _thunkSpec_name :: !Text
227− , _thunkSpec_files :: !(Map FilePath ThunkFileSpec)
213+ = ReadThunkError_UnrecognizedFiles
214+ | ReadThunkError_AmbiguousFiles
215+ | ReadThunkError_UnrecognizedLoader Text
216+ | ReadThunkError_UnparseablePtr LBS.ByteString
217+ deriving (Show)
218+
219+-- | Read a thunk and validate that it is only a thunk, either packed or unpacked.
220+-- If the thunk is packed and additional data is present, fail.
221+readThunk :: MonadObelisk m => FilePath -> m (Either ReadThunkError ThunkData)
222+readThunk thunkDir = do
223+ files <- liftIO $ listDirectory thunkDir
224+ case ".git" `elem` files of
225+ True -> fmap ThunkData_Checkout <$> do
226+ let origThunkPath = thunkDir </> ".git" </> "obelisk" </> "orig-thunk"
227+ liftIO $ doesDirectoryExist origThunkPath >>= \case
228+ True -> fmap Just <$> readPackedThunk origThunkPath
229+ False -> return $ return Nothing
230+ False -> liftIO $ fmap ThunkData_Packed <$> readPackedThunk thunkDir
231+
232+data ThunkType = ThunkType
233+ { _thunkType_loader :: FilePath
234+ , _thunkType_json :: FilePath
235+ , _thunkType_optional :: Set FilePath
236+ , _thunkType_loaderVersions :: NonEmpty Text
237+ , _thunkType_parser :: Aeson.Object -> Aeson.Parser ThunkPtr
228238 }
229239
230−thunkSpecTypes :: NonEmpty (NonEmpty ThunkSpec)
231−thunkSpecTypes = gitThunkSpecs :| [gitHubThunkSpecs]
232−
233−-- | Attempts to match a 'ThunkSpec' to a given directory.
234−matchThunkSpecToDir
235− :: (MonadError ReadThunkError m, MonadIO m, MonadCatch m)
236− => ThunkSpec -- ^ 'ThunkSpec' to match against the given files/directory
237− -> FilePath -- ^ Path to directory
238− -> Set FilePath -- ^ Set of file paths relative to the given directory
239− -> m ThunkData
240−matchThunkSpecToDir thunkSpec dir dirFiles = do
241− case nonEmpty (toList $ dirFiles `Set.difference` expectedPaths) of
242− Just fs -> throwError $ ReadThunkError_UnrecognizedPaths $ (dir </>) <$> fs
243− Nothing -> pure ()
244− case nonEmpty (toList $ requiredPaths `Set.difference` dirFiles) of
245− Just fs -> throwError $ ReadThunkError_MissingPaths $ (dir </>) <$> fs
246− Nothing -> pure ()
247− datas <- fmap toList $ flip Map.traverseMaybeWithKey (_thunkSpec_files thunkSpec) $ \expectedPath -> \case
248− ThunkFileSpec_AttrCache -> Nothing <$ dirMayExist expectedPath
249− ThunkFileSpec_CheckoutIndicator -> liftIO (doesDirectoryExist (dir </> expectedPath)) <&> \case
250− False -> Nothing
251− True -> Just ThunkData_Checkout
252− ThunkFileSpec_FileMatches expectedContents -> handle (\(e :: IOError) -> throwError $ ReadThunkError_FileError e) $ do
253− actualContents <- liftIO (T.readFile $ dir </> expectedPath)
254− case T.strip expectedContents == T.strip actualContents of
255− True -> pure Nothing
256− False -> throwError $ ReadThunkError_FileDoesNotMatch (dir </> expectedPath) expectedContents
257− ThunkFileSpec_Ptr parser -> handle (\(e :: IOError) -> throwError $ ReadThunkError_FileError e) $ do
258− let path = dir </> expectedPath
259− liftIO (doesFileExist path) >>= \case
260− False -> pure Nothing
261− True -> do
262− actualContents <- liftIO $ LBS.readFile path
263− case parser actualContents of
264− Right v -> pure $ Just (ThunkData_Packed thunkSpec v)
265− Left e -> throwError $ ReadThunkError_UnparseablePtr (dir </> expectedPath) e
266−
267− case nonEmpty datas of
268− Nothing -> throwError ReadThunkError_UnrecognizedThunk
269− Just xs -> fold1WithM xs $ \a b -> either throwError pure (mergeThunkData a b)
270− where
271− rootPathsOnly = Set.fromList . mapMaybe takeRootDir . Map.keys
272− takeRootDir = fmap NonEmpty.head . nonEmpty . splitPath
273−
274− expectedPaths = rootPathsOnly $ _thunkSpec_files thunkSpec
275−
276− requiredPaths = rootPathsOnly $ Map.filter isRequiredFileSpec $ _thunkSpec_files thunkSpec
277− isRequiredFileSpec = \case
278− ThunkFileSpec_FileMatches _ -> True
279− _ -> False
280−
281− dirMayExist expectedPath = liftIO (doesFileExist (dir </> expectedPath)) >>= \case
282− True -> throwError $ ReadThunkError_UnrecognizedPaths $ expectedPath :| []
283− False -> pure ()
284−
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
291−
292− bothPackedAndUnpacked = ReadThunkError_UnrecognizedState "Both packed data and checkout present"
293−
294− fold1WithM (x :| xs) f = foldM f x xs
295−
296−readThunkWith
297− :: (MonadObelisk m)
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}|]
240+gitHubThunkType :: ThunkType
241+gitHubThunkType = ThunkType
242+ { _thunkType_loader = "default.nix"
243+ , _thunkType_json = "github.json"
244+ , _thunkType_optional = Set.fromList [".attr-cache"]
245+ , _thunkType_loaderVersions = gitHubStandaloneLoaders
246+ , _thunkType_parser = parseThunkPtr $ \v ->
247+ ThunkSource_GitHub <$> parseGitHubSource v <|> ThunkSource_Git <$> parseGitSource v
248+ }
249+
250+gitThunkType :: ThunkType
251+gitThunkType = ThunkType
252+ { _thunkType_loader = "default.nix"
253+ , _thunkType_json = "git.json"
254+ , _thunkType_optional = Set.fromList [".attr-cache"]
255+ , _thunkType_loaderVersions = plainGitStandaloneLoaders
256+ , _thunkType_parser = parseThunkPtr $ fmap ThunkSource_Git . parseGitSource
257+ }
258+
259+thunkTypes :: [ThunkType]
260+thunkTypes = [gitThunkType, gitHubThunkType]
261+
262+findThunkType :: [ThunkType] -> FilePath -> IO (Either ReadThunkError ThunkType)
263+findThunkType types thunkDir = do
264+ matches <- fmap catMaybes $ forM types $ \thunkType -> do
265+ let
266+ expectedContents = Set.fromList $ (thunkDir </>) <$>
267+ [ _thunkType_loader thunkType
268+ , _thunkType_json thunkType
269+ ]
270+ optionalContents = Set.map (thunkDir </>) (_thunkType_optional thunkType)
271+
272+ -- Ensure that there aren't any other files in the thunk
273+ -- NB: System.Directory.listDirectory returns the contents without the directory path
274+ files <- liftIO $ Set.fromList . fmap (thunkDir </>) <$> listDirectory thunkDir
275+ let unexpectedContents = files `Set.difference` (expectedContents `Set.union` optionalContents)
276+ missingContents = expectedContents `Set.difference` files
277+ pure $ if Set.null unexpectedContents && Set.null missingContents
278+ then Just thunkType
279+ else Nothing
280+
281+ pure $ case matches of
282+ [singleMatch] -> Right singleMatch
283+ [] -> Left ReadThunkError_UnrecognizedFiles
284+ _ -> Left ReadThunkError_AmbiguousFiles
307285
308286-- | Read a thunk and validate that it is exactly a packed thunk.
309287-- If additional data is present, fail.
310−readThunk :: (MonadObelisk m) => FilePath -> m (Either ReadThunkError ThunkData)
311−readThunk = readThunkWith thunkSpecTypes
288+readPackedThunk :: FilePath -> IO (Either ReadThunkError ThunkPtr)
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
295+
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
312300
313301parseThunkPtr :: (Aeson.Object -> Aeson.Parser ThunkSource) -> Aeson.Object -> Aeson.Parser ThunkPtr
314302parseThunkPtr parseSrc v = do
@@ -352,18 +340,16 @@ parseGitSource v = do
352340overwriteThunk :: MonadObelisk m => FilePath -> ThunkPtr -> m ()
353341overwriteThunk target thunk = do
354342 -- Ensure that this directory is a valid thunk (i.e. so we aren't losing any data)
355− readThunk target >>= \case
356− Left e -> failWith [i|Invalid thunk at ${target}: ${e}|]
357− Right _ -> pure ()
343+ Right _ <- readThunk target
358344
359345 --TODO: Is there a safer way to do this overwriting?
360− liftIO $ removePathForcibly target
361− createThunk target $ Right thunk
346+ liftIO $ removeDirectoryRecursive target
347+ liftIO $ createThunk target thunk
362348
363−thunkPtrToSpec :: ThunkPtr -> ThunkSpec
364−thunkPtrToSpec thunk = case _thunkPtr_source thunk of
365− ThunkSource_GitHub _ -> NonEmpty.head gitHubThunkSpecs
366− ThunkSource_Git _ -> NonEmpty.head gitThunkSpecs
349+thunkPtrLoader :: ThunkPtr -> Text
350+thunkPtrLoader thunk = case _thunkPtr_source thunk of
351+ ThunkSource_GitHub _ -> NonEmpty.head gitHubStandaloneLoaders
352+ ThunkSource_Git _ -> NonEmpty.head plainGitStandaloneLoaders
367353
368354-- It's important that formatting be very consistent here, because
369355-- otherwise when people update thunks, their patches will be messy
@@ -410,41 +396,35 @@ encodeThunkPtrData (ThunkPtr rev src) = case src of
410396 , confTrailingNewline = True
411397 }
412398
413−createThunk :: MonadObelisk m => FilePath -> Either ThunkSpec ThunkPtr -> m ()
414−createThunk target ptrInfo =
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)
420− _ -> pure ()
421− where
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
427− f fullPath
399+createThunk :: MonadIO m => FilePath -> ThunkPtr -> m ()
400+createThunk target thunk = liftIO $ do
401+ createDirectoryIfMissing True (target </> ".attr-cache")
402+ T.writeFile (target </> "default.nix") (thunkPtrLoader thunk)
403+ let
404+ jsonFileName = case _thunkPtr_source thunk of
405+ ThunkSource_GitHub _ -> "github"
406+ ThunkSource_Git _ -> "git"
407+ LBS.writeFile (target </> jsonFileName <.> "json") (encodeThunkPtrData thunk)
428408
429409createThunkWithLatest :: MonadObelisk m => FilePath -> ThunkSource -> m ()
430410createThunkWithLatest target s = do
431411 rev <- getLatestRev s
432− createThunk target $ Right $ ThunkPtr
412+ createThunk target $ ThunkPtr
433413 { _thunkPtr_source = s
434414 , _thunkPtr_rev = rev
435415 }
436416
437417updateThunkToLatest :: MonadObelisk m => ThunkUpdateConfig -> FilePath -> m ()
438−updateThunkToLatest (ThunkUpdateConfig mBranch thunkConfig) target = spinner $ do
439− checkThunkDirectory target
418+updateThunkToLatest (ThunkUpdateConfig mBranch thunkConfig) target = withSpinner' ("Updating thunk " <> T.pack target <> " to latest") (pure $ const $ "Thunk " <> T.pack target <> " updated to latest") $ do
419+ checkThunkDirectory "ob thunk update directory cannot be '.'" target
440420 -- check to see if thunk should be updated to a specific branch or just update it's current branch
441421 case mBranch of
442422 Nothing -> do
443423 (overwrite, ptr) <- readThunk target >>= \case
444− Left err -> failWith [i|Thunk update: ${err}|]
424+ Left err -> failWith $ T.pack $ "thunk update: " <> show err
445425 Right c -> case c of
446− ThunkData_Packed _ t -> return (target, t)
447− ThunkData_Checkout -> failWith "cannot update an unpacked thunk"
426+ ThunkData_Packed t -> return (target, t)
427+ ThunkData_Checkout _ -> failWith "cannot update an unpacked thunk"
448428 let src = _thunkPtr_source ptr
449429 rev <- getLatestRev src
450430 overwriteThunk overwrite $ modifyThunkPtrByConfig thunkConfig $ ThunkPtr
@@ -452,36 +432,38 @@ updateThunkToLatest (ThunkUpdateConfig mBranch thunkConfig) target = spinner $ d
452432 , _thunkPtr_rev = rev
453433 }
454434 Just branch -> readThunk target >>= \case
455− Left err -> failWith [i|Thunk update: ${err}|]
435+ Left err -> failWith $ T.pack $ "thunk update: " <> show err
456436 Right c -> case c of
457− ThunkData_Packed _ t -> setThunk thunkConfig target (thunkSourceToGitSource $ _thunkPtr_source t) 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.|]
459− where
460− spinner = withSpinner' ("Updating thunk " <> T.pack target <> " to latest") (pure $ const $ "Thunk " <> T.pack target <> " updated to latest")
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
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."
461443
462444setThunk :: MonadObelisk m => ThunkConfig -> FilePath -> GitSource -> String -> m ()
463445setThunk 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
465447 overwriteThunk target newThunkPtr
466448 updateThunkToLatest (ThunkUpdateConfig Nothing thunkConfig) target
467449
468450-- | All recognized github standalone loaders, ordered from newest to oldest.
469451-- This tool will only ever produce the newest one when it writes a thunk.
470−gitHubThunkSpecs :: NonEmpty ThunkSpec
471−gitHubThunkSpecs =
472− gitHubThunkSpecV5 :|
473− [ gitHubThunkSpecV4
474− , gitHubThunkSpecV3
475− , gitHubThunkSpecV2
476− , gitHubThunkSpecV1
452+gitHubStandaloneLoaders :: NonEmpty Text
453+gitHubStandaloneLoaders =
454+ gitHubStandaloneLoaderV4 :|
455+ [ gitHubStandaloneLoaderV3
456+ , gitHubStandaloneLoaderV2
457+ , gitHubStandaloneLoaderV1
477458 ]
478459
479−gitHubThunkSpecV1 :: ThunkSpec
480−gitHubThunkSpecV1 = legacyGitHubThunkSpec "github-v1"
481− "import ((import <nixpkgs> {}).fetchFromGitHub (builtins.fromJSON (builtins.readFile ./github.json)))"
460+gitHubStandaloneLoaderV1 :: Text
461+gitHubStandaloneLoaderV1 = T.unlines
462+ [ "import ((import <nixpkgs> {}).fetchFromGitHub (builtins.fromJSON (builtins.readFile ./github.json)))"
463+ ]
482464
483−gitHubThunkSpecV2 :: ThunkSpec
484−gitHubThunkSpecV2 = legacyGitHubThunkSpec "github-v2" $ T.unlines
465+gitHubStandaloneLoaderV2 :: Text
466+gitHubStandaloneLoaderV2 = T.unlines
485467 [ "# DO NOT HAND-EDIT THIS FILE" --TODO: Add something about how to get more info on Obelisk, etc.
486468 , "import ((import <nixpkgs> {}).fetchFromGitHub ("
487469 , " let json = builtins.fromJSON (builtins.readFile ./github.json);"
@@ -491,8 +473,8 @@ gitHubThunkSpecV2 = legacyGitHubThunkSpec "github-v2" $ T.unlines
491473 , "))"
492474 ]
493475
494−gitHubThunkSpecV3 :: ThunkSpec
495−gitHubThunkSpecV3 = legacyGitHubThunkSpec "github-v3" $ T.unlines
476+gitHubStandaloneLoaderV3 :: Text
477+gitHubStandaloneLoaderV3 = T.unlines
496478 [ "# DO NOT HAND-EDIT THIS FILE"
497479 , "let"
498480 , " fetch = { private ? false, ... }@args: if private && builtins.hasAttr \"fetchGit\" builtins"
@@ -511,8 +493,8 @@ gitHubThunkSpecV3 = legacyGitHubThunkSpec "github-v3" $ T.unlines
511493 , "in import (fetch (builtins.fromJSON (builtins.readFile ./github.json)))"
512494 ]
513495
514−gitHubThunkSpecV4 :: ThunkSpec
515−gitHubThunkSpecV4 = legacyGitHubThunkSpec "github-v4" $ T.unlines
496+gitHubStandaloneLoaderV4 :: Text
497+gitHubStandaloneLoaderV4 = T.unlines
516498 [ "# DO NOT HAND-EDIT THIS FILE"
517499 , "let fetch = { private ? false, fetchSubmodules ? false, owner, repo, rev, sha256, ... }:"
518500 , " if !fetchSubmodules && !private then builtins.fetchTarball {"
@@ -523,50 +505,23 @@ gitHubThunkSpecV4 = legacyGitHubThunkSpec "github-v4" $ T.unlines
523505 , "in import (fetch (builtins.fromJSON (builtins.readFile ./github.json)))"
524506 ]
525507
526−legacyGitHubThunkSpec :: Text -> Text -> ThunkSpec
527−legacyGitHubThunkSpec name loader = ThunkSpec name $ Map.fromList
528− [ ("default.nix", ThunkFileSpec_FileMatches $ T.strip loader)
529− , ("github.json" , ThunkFileSpec_Ptr parseGitHubJsonBytes)
530− , (attrCacheFileName, ThunkFileSpec_AttrCache)
531− , (".git", ThunkFileSpec_CheckoutIndicator)
532− ]
533−
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;
542− };
543− json = builtins.fromJSON (builtins.readFile ./github.json);
544−in fetch json
545−|]
546−
547−parseGitHubJsonBytes :: LBS.ByteString -> Either String ThunkPtr
548−parseGitHubJsonBytes = parseJsonObject $ parseThunkPtr $ \v ->
549− ThunkSource_GitHub <$> parseGitHubSource v <|> ThunkSource_Git <$> parseGitSource v
550−
551−gitThunkSpecs :: NonEmpty ThunkSpec
552−gitThunkSpecs =
553− gitThunkSpecV5 :|
554− [ gitThunkSpecV4
555− , gitThunkSpecV3
556− , gitThunkSpecV2
557− , gitThunkSpecV1
508+plainGitStandaloneLoaders :: NonEmpty Text
509+plainGitStandaloneLoaders =
510+ plainGitStandaloneLoaderV3 :|
511+ [ plainGitStandaloneLoaderV1
512+ , plainGitStandaloneLoaderV2
558513 ]
559514
560−gitThunkSpecV1 :: ThunkSpec
561−gitThunkSpecV1 = legacyGitThunkSpec "git-v1" $ T.unlines
515+plainGitStandaloneLoaderV1 :: Text
516+plainGitStandaloneLoaderV1 = T.unlines
562517 [ "# DO NOT HAND-EDIT THIS FILE"
563518 , "let fetchGit = {url, rev, ref ? null, branch ? null, sha256 ? null, fetchSubmodules ? null}:"
564519 , " assert !fetchSubmodules; (import <nixpkgs> {}).fetchgit { inherit url rev sha256; };"
565520 , "in import (fetchGit (builtins.fromJSON (builtins.readFile ./git.json)))"
566521 ]
567522
568−gitThunkSpecV2 :: ThunkSpec
569−gitThunkSpecV2 = legacyGitThunkSpec "git-v2" $ T.unlines
523+plainGitStandaloneLoaderV2 :: Text
524+plainGitStandaloneLoaderV2 = T.unlines
570525 [ "# DO NOT HAND-EDIT THIS FILE"
571526 , "let fetchGit = {url, rev, ref ? null, branch ? null, sha256 ? null, fetchSubmodules ? null}:"
572527 , " if builtins.hasAttr \"fetchGit\" builtins"
@@ -575,10 +530,8 @@ gitThunkSpecV2 = legacyGitThunkSpec "git-v2" $ T.unlines
575530 , "in import (fetchGit (builtins.fromJSON (builtins.readFile ./git.json)))"
576531 ]
577532
578−-- This loader has a bug because @builtins.fetchGit@ is not given a @ref@
579−-- and will fail to find commits without this because it does shallow clones.
580−gitThunkSpecV3 :: ThunkSpec
581−gitThunkSpecV3 = legacyGitThunkSpec "git-v3" $ T.unlines
533+plainGitStandaloneLoaderV3 :: Text
534+plainGitStandaloneLoaderV3 = T.unlines
582535 [ "# DO NOT HAND-EDIT THIS FILE"
583536 , "let fetch = {url, rev, ref ? null, sha256 ? null, fetchSubmodules ? false, private ? false, ...}:"
584537 , " let realUrl = let firstChar = builtins.substring 0 1 url; in"
@@ -593,69 +546,10 @@ gitThunkSpecV3 = legacyGitThunkSpec "git-v3" $ T.unlines
593546 , "in import (fetch (builtins.fromJSON (builtins.readFile ./git.json)))"
594547 ]
595548
596−gitThunkSpecV4 :: ThunkSpec
597−gitThunkSpecV4 = legacyGitThunkSpec "git-v4" $ T.unlines
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"
603− , " else 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;"
609− , " };"
610− , "in import (fetch (builtins.fromJSON (builtins.readFile ./git.json)))"
611− ]
612−
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)
619− ]
620−
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
628− else 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;
634− };
635− json = builtins.fromJSON (builtins.readFile ./git.json);
636−in fetch json
637−|]
638−
639−parseGitJsonBytes :: LBS.ByteString -> Either String ThunkPtr
640−parseGitJsonBytes = parseJsonObject $ parseThunkPtr $ fmap ThunkSource_Git . parseGitSource
641−
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)
649− ]
650− where
651− defaultNixViaSrc = [here|
652−# DO NOT HAND-EDIT THIS FILE
653−import (import ./thunk.nix)
654−|]
655−
549+thunkFileNames :: [FilePath]
550+thunkFileNames = ["default.nix", "github.json", "git.json"]
656551
657−parseJsonObject :: (Aeson.Object -> Aeson.Parser a) -> LBS.ByteString -> Either String a
658−parseJsonObject p bytes = Aeson.parseEither p =<< Aeson.eitherDecode bytes
552+--TODO: when checking something out, make a shallow clone
659553
660554-- | Checks a cache directory to see if there is a fresh symlink
661555-- to the result of building an attribute of a thunk.
@@ -663,49 +557,44 @@ parseJsonObject p bytes = Aeson.parseEither p =<< Aeson.eitherDecode bytes
663557-- and the result is symlinked into the cache.
664558nixBuildThunkAttrWithCache
665559 :: MonadObelisk m
666− => ThunkSpec
667− -> FilePath
560+ => FilePath
668561 -- ^ Path to directory containing Thunk
669562 -> String
670563 -- ^ Attribute to build
671− -> m (Maybe FilePath)
564+ -> m FilePath
672565 -- ^ Symlink to cached or built nix output
673566-- WARNING: If the thunk uses an impure reference such as '<nixpkgs>'
674567-- the caching mechanism will fail as it merely measures the modification
675568-- 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"
677577 latestChange <- liftIO $ do
678− let
679− getModificationTimeMaybe = fmap rightToMaybe . try @IOError . getModificationTime
680− thunkFileNames = Map.keys $ _thunkSpec_files thunkSpec
681− maximum . catMaybes <$> traverse (getModificationTimeMaybe . (thunkDir </>)) thunkFileNames
682−
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
687− let
688− cachePath = thunkDir </> cacheDir </> attr <.> "out"
689− cacheErrHandler e
690− | isDoesNotExistError e = pure Nothing -- expected from a cache miss
691− | otherwise = Nothing <$ putLog Error (T.pack $ displayException e)
692− cacheHit <- handle cacheErrHandler $ do
693− cacheTime <- liftIO $ posixSecondsToUTCTime . realToFrac . modificationTime <$> getSymbolicLinkStatus cachePath
694− pure $ if latestChange <= cacheTime
695− then Just cachePath
696− else Nothing
697− case cacheHit of
698− Just c -> pure c
699− Nothing -> do
700− putLog Warning $ T.pack $ mconcat [thunkDir, ": ", attr, " not cached, building ..."]
701− liftIO $ createDirectoryIfMissing True (takeDirectory cachePath)
702− (cachePath <$) $ nixCmd $ NixCmd_Build $ def
703− & nixBuildConfig_outLink .~ OutLink_IndirectRoot cachePath
704− & nixCmdConfig_target .~ Target
705− { _target_path = Just thunkDir
706− , _target_attr = Just attr
707− , _target_expr = Nothing
708− }
578+ createDirectoryIfMissing False cacheDir
579+ let getModificationTimeMaybe = fmap rightToMaybe . try @IOError . getModificationTime
580+ maximum . catMaybes <$> mapM (getModificationTimeMaybe . (thunkDir </>)) thunkFileNames
581+ cacheHit <- handle cacheErrHandler $ do
582+ cacheTime <- liftIO $ posixSecondsToUTCTime . realToFrac . modificationTime <$> getSymbolicLinkStatus cachePath
583+ return $ if latestChange <= cacheTime
584+ then Just cachePath
585+ else Nothing
586+ case cacheHit of
587+ Just c -> return c
588+ Nothing -> do
589+ putLog Warning $ T.pack $ mconcat [thunkDir, ": ", attr, " not cached, building ..."]
590+ _ <- nixCmd $ NixCmd_Build $ def
591+ Lens.& nixBuildConfig_outLink Lens..~ OutLink_IndirectRoot cachePath
592+ Lens.& nixCmdConfig_target Lens..~ Target
593+ { _target_path = Just thunkDir
594+ , _target_attr = Just attr
595+ , _target_expr = Nothing
596+ }
597+ return cachePath
709598
710599-- | Build a nix attribute, and cache the result if possible
711600nixBuildAttrWithCache
@@ -716,15 +605,13 @@ nixBuildAttrWithCache
716605 -- ^ Attribute to build
717606 -> m FilePath
718607 -- ^ Symlink to cached or built nix output
719−nixBuildAttrWithCache exprPath attr = readThunk exprPath >>= \case
720− -- Only packed thunks are cached. In particular, checkouts are not.
721− Right (ThunkData_Packed spec _) ->
722− maybe build pure =<< nixBuildThunkAttrWithCache spec exprPath attr
723− _ -> build
724− where
725− build = nixCmd $ NixCmd_Build $ def
726− & nixBuildConfig_outLink .~ OutLink_None
727− & nixCmdConfig_target .~ Target
608+nixBuildAttrWithCache exprPath attr = do
609+ readThunk exprPath >>= \case
610+ -- Only packed thunks are cached. in particular, checkouts are not
611+ Right (ThunkData_Packed _) -> nixBuildThunkAttrWithCache exprPath attr
612+ _ -> nixCmd $ NixCmd_Build $ def
613+ Lens.& nixBuildConfig_outLink Lens..~ OutLink_None
614+ Lens.& nixCmdConfig_target Lens..~ Target
728615 { _target_path = Just exprPath
729616 , _target_attr = Just attr
730617 , _target_expr = Nothing
@@ -745,7 +632,7 @@ updateThunk p f = withSystemTempDirectory "obelisk-thunkptr-" $ \tmpDir -> do
745632 where
746633 copyThunkToTmp tmpDir thunkDir = readThunk thunkDir >>= \case
747634 Left err -> failWith $ "withThunkUnpacked: " <> T.pack (show err)
748− Right ThunkData_Packed{} -> do
635+ Right (ThunkData_Packed _) -> do
749636 let tmpThunk = tmpDir </> "thunk"
750637 callProcessAndLogOutput (Notice, Error) $
751638 proc cp ["-r", "-T", thunkDir, tmpThunk]
@@ -759,81 +646,62 @@ updateThunk p f = withSystemTempDirectory "obelisk-thunkptr-" $ \tmpDir -> do
759646finalMsg :: Bool -> (a -> Text) -> Maybe (a -> Text)
760647finalMsg noTrail s = if noTrail then Nothing else Just s
761648
649+unpackThunk :: MonadObelisk m => FilePath -> m ()
650+unpackThunk = unpackThunk' False
651+
762652-- | Check that we are not somewhere inside the thunk directory
763−checkThunkDirectory :: MonadObelisk m => FilePath -> m ()
764−checkThunkDirectory thunkDir = do
653+checkThunkDirectory :: MonadObelisk m => Text -> FilePath -> m ()
654+checkThunkDirectory msg thunkDir = do
765655 currentDir <- liftIO getCurrentDirectory
766656 thunkDir' <- liftIO $ canonicalizePath thunkDir
767− when (thunkDir' `L.isInfixOf` currentDir) $
768− failWith [i|Can't perform thunk operations from within the thunk directory: ${thunkDir}|]
769−
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|]
774− Left _ -> pure ()
775−
776−unpackThunk :: MonadObelisk m => FilePath -> m ()
777−unpackThunk = unpackThunk' False
657+ when (thunkDir' `L.isInfixOf` currentDir) $ failWith msg
778658
779659unpackThunk' :: MonadObelisk m => Bool -> FilePath -> m ()
780−unpackThunk' noTrail thunkDir = checkThunkDirectory thunkDir *> readThunk thunkDir >>= \case
781− Left err -> failWith [i|Invalid thunk at ${thunkDir}: ${err}|]
660+unpackThunk' noTrail thunkDir = checkThunkDirectory "Can't pack/unpack from within the thunk directory" thunkDir >> readThunk thunkDir >>= \case
661+ Left err -> failWith $ "thunk unpack: " <> T.pack (show err)
782662 --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|]
784− Right (ThunkData_Packed _ tptr) -> do
663+ Right (ThunkData_Checkout _) -> failWith "thunk unpack: thunk is already unpacked"
664+ Right (ThunkData_Packed tptr) -> do
785665 let (thunkParent, thunkName) = splitFileName thunkDir
786− withTempDirectory thunkParent thunkName $ \tmpThunk -> do
787− let
788− gitSrc = thunkSourceToGitSource $ _thunkPtr_source tptr
789− newSpec = case _thunkPtr_source tptr of
790− ThunkSource_GitHub _ -> NonEmpty.head gitHubThunkSpecs
791− ThunkSource_Git _ -> NonEmpty.head gitThunkSpecs
666+ withTempDirectory thunkParent thunkName $ \tmpRepo -> do
667+ let obGitDir = tmpRepo </> ".git" </> "obelisk"
668+ s = case _thunkPtr_source tptr of
669+ ThunkSource_GitHub s' -> forgetGithub False s'
670+ ThunkSource_Git s' -> s'
792671 withSpinner' ("Fetching thunk " <> T.pack thunkName)
793672 (finalMsg noTrail $ const $ "Fetched thunk " <> T.pack thunkName) $ do
794− let unpackedPath = tmpThunk </> unpackedDirName
795− gitCloneForThunkUnpack gitSrc (_thunkRev_commit $ _thunkPtr_rev tptr) unpackedPath
796−
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
800−
801− liftIO $ do
802− removePathForcibly thunkDir
803− renameDirectory tmpThunk thunkDir
804−
805−gitCloneForThunkUnpack
806− :: MonadObelisk m
807− => GitSource -- ^ Git source to use
808− -> Ref hash -- ^ Commit hash to reset to
809− -> FilePath -- ^ Directory to clone into
810− -> m ()
811−gitCloneForThunkUnpack gitSrc commit dir = do
812− let git = callProcessAndLogOutput (Notice, Notice) . gitProc dir
813− git $ [ "clone" ]
814− ++ ["--recursive" | _gitSource_fetchSubmodules gitSrc]
815− ++ [ T.unpack $ gitUriToText $ _gitSource_url gitSrc ]
816− ++ do branch <- maybeToList $ _gitSource_branch gitSrc
817− [ "--branch", T.unpack $ untagName branch ]
818− git ["reset", "--hard", Ref.toHexString commit]
819− when (_gitSource_fetchSubmodules gitSrc) $
820− git ["submodule", "update", "--recursive", "--init"]
673+ let git = callProcessAndLogOutput (Notice, Notice) . gitProc tmpRepo
674+ git $ [ "clone" ]
675+ ++ ("--recursive" <$ guard (_gitSource_fetchSubmodules s))
676+ ++ [ T.unpack $ gitUriToText $ _gitSource_url s ]
677+ ++ do branch <- maybeToList $ _gitSource_branch s
678+ [ "--branch", T.unpack $ untagName branch ]
679+ git ["reset", "--hard", Ref.toHexString $ _thunkRev_commit $ _thunkPtr_rev tptr]
680+ when (_gitSource_fetchSubmodules s) $
681+ git ["submodule", "update", "--recursive", "--init"]
682+
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]
821690
822691--TODO: add a rollback mode to pack to the original thunk
823692packThunk :: MonadObelisk m => ThunkPackConfig -> FilePath -> m ThunkPtr
824693packThunk = packThunk' False
825694
826695packThunk' :: MonadObelisk m => Bool -> ThunkPackConfig -> FilePath -> m ThunkPtr
827−packThunk' noTrail (ThunkPackConfig force thunkConfig) thunkDir = checkThunkDirectory thunkDir *> readThunk thunkDir >>= \case
828− Right ThunkData_Packed{} -> failWith [i|Thunk at ${thunkDir} is is already packed|]
829− _ -> withSpinner'
830− ("Packing thunk " <> T.pack thunkDir)
831− (finalMsg noTrail $ const $ "Packed thunk " <> T.pack thunkDir) $
832− do
833− let checkClean = if force then CheckClean_NoCheck else CheckClean_FullCheck
834− thunkPtr <- modifyThunkPtrByConfig thunkConfig <$> getThunkPtr checkClean thunkDir (_thunkConfig_private thunkConfig)
835− liftIO $ removePathForcibly thunkDir
836− createThunk thunkDir $ Right thunkPtr
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
698+ Right (ThunkData_Packed _) -> failWith "pack: thunk is already packed"
699+ Right (ThunkData_Checkout _) -> do
700+ withSpinner' ("Packing thunk " <> T.pack thunkDir)
701+ (finalMsg noTrail $ const $ "Packed thunk " <> T.pack thunkDir) $ do
702+ thunkPtr <- modifyThunkPtrByConfig thunkConfig <$> getThunkPtr (not force) thunkDir
703+ callProcessAndLogOutput (Debug, Error) $ proc "rm" ["-rf", thunkDir]
704+ liftIO $ createThunk thunkDir thunkPtr
837705 pure thunkPtr
838706
839707modifyThunkPtrByConfig :: ThunkConfig -> ThunkPtr -> ThunkPtr
@@ -844,43 +712,29 @@ modifyThunkPtrByConfig (ThunkConfig markPrivate') ptr = case markPrivate' of
844712 ThunkSource_GitHub s -> ThunkSource_GitHub $ s { _gitHubSource_private = markPrivate }
845713 }
846714
847−data CheckClean
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
854−
855−getThunkPtr :: forall m. MonadObelisk m => CheckClean -> FilePath -> Maybe Bool -> m ThunkPtr
856−getThunkPtr gitCheckClean dir mPrivate = 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
863−
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
715+getThunkPtr :: forall m. MonadObelisk m => Bool -> FilePath -> m ThunkPtr
716+getThunkPtr checkClean thunkDir = do
717+ when checkClean $ ensureCleanGitRepo thunkDir True
869718 "thunk pack: thunk checkout contains unsaved modifications"
870719
871720 -- Check whether there are any stashes
872− when checkClean $ do
873− stashOutput <- readGitProcess thunkDir ["stash", "list"]
874− unless (T.null stashOutput) $
721+ stashOutput <- readGitProcess thunkDir ["stash", "list"]
722+ when checkClean $ case T.null stashOutput of
723+ False -> do
875724 failWith $ T.unlines $
876725 [ "thunk pack: thunk checkout has stashes"
877726 , "git stash list:"
878727 ] ++ T.lines stashOutput
728+ True -> return ()
879729
880− -- Get current branch
730+ -- Get current branch ``
881731 (mCurrentBranch, mCurrentCommit) <- do
882− b <- listToMaybe . T.lines <$> readGitProcess thunkDir ["rev-parse", "--abbrev-ref", "HEAD"]
883− c <- listToMaybe . T.lines <$> readGitProcess thunkDir ["rev-parse", "HEAD"]
732+ b <- listToMaybe
733+ <$> T.lines
734+ <$> readGitProcess thunkDir ["rev-parse", "--abbrev-ref", "HEAD"]
735+ c <- listToMaybe
736+ <$> T.lines
737+ <$> readGitProcess thunkDir ["rev-parse", "HEAD"]
884738 case b of
885739 (Just "HEAD") -> failWith $ T.unlines
886740 [ "thunk pack: You are in 'detached HEAD' state."
@@ -891,7 +745,7 @@ getThunkPtr gitCheckClean dir mPrivate = do
891745
892746 -- Get information on all branches and their (optional) designated upstream
893747 -- correspondents
894− headDump :: [Text] <- T.lines <$> readGitProcess thunkDir
748+ (headDump :: [Text]) <- T.lines <$> readGitProcess thunkDir
895749 [ "for-each-ref"
896750 , "--format=%(refname:short) %(upstream:short) %(upstream:remotename)"
897751 , "refs/heads/"
@@ -937,7 +791,7 @@ getThunkPtr gitCheckClean dir mPrivate = do
937791 ]
938792
939793 -- 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
941795 (stat :: [Text]) <- T.lines <$> readGitProcess thunkDir
942796 [ "rev-list", "--left-right"
943797 , T.unpack branch <> "..." <> T.unpack upstream
@@ -961,9 +815,8 @@ getThunkPtr gitCheckClean dir mPrivate = do
961815 \pushed but this repo's remote tracking branches don't know it.)"
962816 ]
963817
964− when checkClean $ do
965− -- 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."
818+ -- We assume it's safe to pack the thunk at this point
819+ putLog Informational "All changes safe in git remotes. OK to pack thunk."
967820
968821 let remote = maybe "origin" snd $ flip Map.lookup headUpstream =<< mCurrentBranch
969822
@@ -976,12 +829,14 @@ getThunkPtr gitCheckClean dir mPrivate = do
976829 remoteUri <- case parseGitUri remoteUri' of
977830 Nothing -> failWith $ "Could not identify git remote: " <> remoteUri'
978831 Just uri -> pure uri
979− uriThunkPtr remoteUri mPrivate mCurrentBranch mCurrentCommit
832+ uriThunkPtr remoteUri mCurrentBranch mCurrentCommit
980833
981834-- | Get the latest revision available from the given source
982835getLatestRev :: MonadObelisk m => ThunkSource -> m ThunkRev
983836getLatestRev 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
985840 (_, commit) <- gitGetCommitBranch (_gitSource_url gitS) (untagName <$> _gitSource_branch gitS)
986841 case os of
987842 ThunkSource_GitHub s -> githubThunkRev s commit
@@ -993,12 +848,12 @@ getLatestRev os = do
993848-- performance. If that doesn't work (e.g. authentication issue), we fall back
994849-- on just doing things the normal way for git repos in general, and save it as
995850-- a regular git thunk.
996−uriThunkPtr :: MonadObelisk m => GitUri -> Maybe Bool -> Maybe Text -> Maybe Text -> m ThunkPtr
997−uriThunkPtr uri mPrivate mbranch mcommit = do
851+uriThunkPtr :: MonadObelisk m => GitUri -> Maybe Text -> Maybe Text -> m ThunkPtr
852+uriThunkPtr uri mbranch mcommit = do
998853 commit <- case mcommit of
999854 Nothing -> gitGetCommitBranch uri mbranch >>= return . snd
1000855 (Just c) -> return c
1001− (src, rev) <- uriToThunkSource uri mPrivate mbranch >>= \case
856+ (src, rev) <- case uriToThunkSource uri mbranch of
1002857 ThunkSource_GitHub s -> do
1003858 rev <- runExceptT $ githubThunkRev s commit
1004859 case rev of
@@ -1021,8 +876,8 @@ uriThunkPtr uri mPrivate mbranch mcommit = do
1021876-- If the thunk is a GitHub thunk and fails, we do *not* fall back like with
1022877-- `uriThunkPtr`. Unlike a plain URL, a thunk src explicitly states which method
1023878-- should be employed, and so we respect that.
1024−uriToThunkSource :: MonadObelisk m => GitUri -> Maybe Bool -> Maybe Text -> m ThunkSource
1025−uriToThunkSource (GitUri u) mPrivate
879+uriToThunkSource :: GitUri -> Maybe Text -> ThunkSource
880+uriToThunkSource (GitUri u)
1026881 | Right uriAuth <- URI.uriAuthority u
1027882 , Just scheme <- URI.unRText <$> URI.uriScheme u
1028883 , case scheme of
@@ -1034,53 +889,21 @@ uriToThunkSource (GitUri u) mPrivate
1034889 s -> s `L.elem` [ "git", "https", "http" ] -- "http:" just redirects to "https:"
1035890 && URI.unRText (URI.authHost uriAuth) == "github.com"
1036891 , Just (_, owner :| [repoish]) <- URI.uriPath u
1037− = \mbranch -> do
1038− isPrivate <- getIsPrivate
1039− pure $ ThunkSource_GitHub $ GitHubSource
1040− { _gitHubSource_owner = N $ URI.unRText owner
1041− , _gitHubSource_repo = N $ let
1042− repoish' = URI.unRText repoish
1043− in fromMaybe repoish' $ T.stripSuffix ".git" repoish'
1044− , _gitHubSource_branch = N <$> mbranch
1045− , _gitHubSource_private = isPrivate
1046− }
892+ = \mbranch -> ThunkSource_GitHub $ GitHubSource
893+ { _gitHubSource_owner = N $ URI.unRText owner
894+ , _gitHubSource_repo = N $ let
895+ repoish' = URI.unRText repoish
896+ in fromMaybe repoish' $ T.stripSuffix ".git" repoish'
897+ , _gitHubSource_branch = N <$> mbranch
898+ , _gitHubSource_private = False -- TODO: Can we try something to infer this?
899+ }
1047900
1048− | otherwise = \mbranch -> do
1049− isPrivate <- getIsPrivate
1050− pure $ ThunkSource_Git $ GitSource
1051− { _gitSource_url = GitUri u
1052− , _gitSource_branch = N <$> mbranch
1053− , _gitSource_fetchSubmodules = False -- TODO: How do we determine if this should be true?
1054− , _gitSource_private = isPrivate
1055− }
1056− where
1057− getIsPrivate = maybe (guessGitRepoIsPrivate $ GitUri u) pure mPrivate
1058−
1059−guessGitRepoIsPrivate :: MonadObelisk m => GitUri -> m Bool
1060−guessGitRepoIsPrivate uri = flip fix urisToTry $ \loop -> \case
1061− [] -> pure True
1062− uriAttempt:xs -> do
1063− result <- readCreateProcessWithExitCode $
1064− isolateGitProc $
1065− gitProcNoRepo
1066− [ "ls-remote"
1067− , "--quiet"
1068− , "--exit-code"
1069− , "--symref"
1070− , T.unpack $ gitUriToText uriAttempt
1071− ]
1072− case result of
1073− (ExitSuccess, _, _) -> pure False -- Must be a public repo
1074− _ -> loop xs
1075− where
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
1083− }
901+ | otherwise = \mbranch -> ThunkSource_Git $ GitSource
902+ { _gitSource_url = GitUri u
903+ , _gitSource_branch = N <$> mbranch
904+ , _gitSource_fetchSubmodules = False -- TODO: How do we determine if this should be true?
905+ , _gitSource_private = False -- TODO: Can we try something to infer this?
906+ }
1084907
1085908-- Funny signature indicates no effects depend on the optional branch name.
1086909githubThunkRev
@@ -1140,7 +963,6 @@ gitThunkRev s commit = do
1140963--
1141964-- If the branch name is passed in, it is returned exactly as-is. If it is not
1142965-- passed it, the default branch of the repo is used instead.
1143−
1144966gitGetCommitBranch
1145967 :: MonadObelisk m => GitUri -> Maybe Text -> m (Text, CommitId)
1146968gitGetCommitBranch uri mbranch = withExitFailMessage ("Failure for git remote " <> uriMsg) $ do