@@ -5,74 +5,59 @@
55{-# LANGUAGE MultiWayIf #-}
66{-# LANGUAGE OverloadedStrings #-}
77{-# LANGUAGE PatternGuards #-}
8+{-# LANGUAGE QuasiQuotes #-}
89{-# LANGUAGE ScopedTypeVariables #-}
910{-# LANGUAGE TypeApplications #-}
10−module Obelisk.Command.Thunk
11− ( GitHubSource (..)
12− , ReadThunkError (..)
13− , ThunkConfig (..)
14− , ThunkData (..)
15− , ThunkPackConfig (..)
16− , ThunkPtr (..)
17− , ThunkRev (..)
18− , ThunkSource (..)
19− , ThunkUpdateConfig (..)
20− , getThunkGitBranch
21− , getLatestRev
22− , updateThunkToLatest
23− , createThunk
24− , createThunkWithLatest
25− , nixBuildAttrWithCache
26− , nixBuildThunkAttrWithCache
27− , unpackThunk
28− , packThunk
29− , readThunk
30− , updateThunk
31− , getThunkPtr
32− , parseGitUri
33− , uriThunkPtr
34− ) where
11+module Obelisk.Command.Thunk where
3512
3613import Control.Applicative
3714import Control.Exception (displayException, try)
38−import qualified Control.Lens as Lens
39−import Control.Lens.Indexed hiding ((<.>))
15+import Control.Lens (ifor, ifor_, (.~))
4016import Control.Monad
41−import Control.Monad.Catch (handle)
17+import Control.Monad.Extra (findM)
18+import Control.Monad.Catch (MonadCatch, handle)
4219import Control.Monad.Except
4320import Data.Aeson ((.=))
4421import qualified Data.Aeson as Aeson
4522import Data.Aeson.Encode.Pretty
4623import qualified Data.Aeson.Types as Aeson
24+import Data.Bifunctor (first)
4725import qualified Data.ByteString.Lazy as LBS
26+import Data.Containers.ListUtils (nubOrd)
4827import Data.Default
4928import Data.Either.Combinators (fromRight', rightToMaybe)
29+import Data.Foldable (toList)
30+import Data.Function ((&))
31+import Data.Functor ((<&>))
5032import Data.Git.Ref (Ref)
5133import qualified Data.Git.Ref as Ref
5234import qualified Data.List as L
53−import Data.List.NonEmpty (NonEmpty (..))
35+import Data.List.NonEmpty (NonEmpty (..), nonEmpty)
5436import qualified Data.List.NonEmpty as NonEmpty
5537import Data.Map (Map)
5638import qualified Data.Map as Map
5739import Data.Maybe
5840import Data.Set (Set)
5941import qualified Data.Set as Set
42+import Data.String.Here.Interpolated (i)
43+import Data.String.Here.Uninterpolated (here)
6044import Data.Text (Text)
6145import qualified Data.Text as T
6246import Data.Text.Encoding
6347import qualified Data.Text.IO as T
6448import Data.Time.Clock.POSIX (posixSecondsToUTCTime)
49+import Data.Traversable (for)
6550import Data.Yaml (parseMaybe)
6651import GitHub
6752import GitHub.Data.Name
6853import Obelisk.Command.Nix
6954import System.Directory
55+import System.Exit
7056import System.FilePath
7157import System.IO.Error
7258import System.IO.Temp
73−import System.Posix (getSymbolicLinkStatus, modificationTime)
74−import System.Process (proc)
75−import Text.URI
59+import System.PosixCompat.Files (getSymbolicLinkStatus, modificationTime)
60+import qualified Text.URI as URI
7661
7762import Obelisk.App (MonadObelisk)
7863import Obelisk.CliApp
@@ -80,11 +65,10 @@ import Obelisk.Command.Utils
8065
8166--TODO: Support symlinked thunk data
8267data ThunkData
83− = ThunkData_Packed ThunkPtr
68+ = ThunkData_Packed ThunkSpec ThunkPtr
8469 -- ^ Packed thunk
85− | ThunkData_Checkout (Maybe ThunkPtr)
70+ | ThunkData_Checkout
8671 -- ^ Checked out thunk that was unpacked from this pointer
87− deriving (Show, Eq, Ord)
8872
8973-- | A reference to the exact data that a thunk should translate into
9074data ThunkPtr = ThunkPtr
@@ -110,6 +94,11 @@ data ThunkSource
11094 | ThunkSource_Git GitSource
11195 deriving (Show, Eq, Ord)
11296
97+thunkSourceToGitSource :: ThunkSource -> GitSource
98+thunkSourceToGitSource = \case
99+ ThunkSource_GitHub s -> forgetGithub False s
100+ ThunkSource_Git s -> s
101+
113102data GitHubSource = GitHubSource
114103 { _gitHubSource_owner :: Name Owner
115104 , _gitHubSource_repo :: Name Repo
@@ -118,8 +107,17 @@ data GitHubSource = GitHubSource
118107 }
119108 deriving (Show, Eq, Ord)
120109
110+newtype GitUri = GitUri { unGitUri :: URI.URI } deriving (Eq, Ord, Show)
111+
112+gitUriToText :: GitUri -> Text
113+gitUriToText (GitUri uri)
114+ | (T.toLower . URI.unRText <$> URI.uriScheme uri) == Just "file"
115+ , Just (_, path) <- URI.uriPath uri
116+ = "/" <> T.intercalate "/" (map URI.unRText $ NonEmpty.toList path)
117+ | otherwise = URI.render uri
118+
121119data GitSource = GitSource
122− { _gitSource_url :: URI
120+ { _gitSource_url :: GitUri
123121 , _gitSource_branch :: Maybe (Name Branch)
124122 , _gitSource_fetchSubmodules :: Bool
125123 , _gitSource_private :: Bool
@@ -143,21 +141,21 @@ data ThunkPackConfig = ThunkPackConfig
143141-- | Convert a GitHub source to a regular Git source. Assumes no submodules.
144142forgetGithub :: Bool -> GitHubSource -> GitSource
145143forgetGithub useSsh s = GitSource
146− { _gitSource_url = URI
147− { uriScheme = Just $ fromRight' $ mkScheme $ if useSsh then "ssh" else "https"
148− , uriAuthority = Right $ Authority
149− { authUserInfo = UserInfo (fromRight' $ mkUsername "git") Nothing
144+ { _gitSource_url = GitUri $ URI.URI
145+ { URI.uriScheme = Just $ fromRight' $ URI.mkScheme $ if useSsh then "ssh" else "https"
146+ , URI.uriAuthority = Right $ URI.Authority
147+ { URI.authUserInfo = URI.UserInfo (fromRight' $ URI.mkUsername "git") Nothing
150148 <$ guard useSsh
151− , authHost = fromRight' $ mkHost "github.com"
152− , authPort = Nothing
149+ , URI.authHost = fromRight' $ URI.mkHost "github.com"
150+ , URI.authPort = Nothing
153151 }
154− , uriPath = Just ( False
155− , fromRight' . mkPathPiece <$>
152+ , URI.uriPath = Just ( False
153+ , fromRight' . URI.mkPathPiece <$>
156154 untagName (_gitHubSource_owner s)
157155 :| [ untagName (_gitHubSource_repo s) <> ".git" ]
158156 )
159− , uriQuery = []
160− , uriFragment = Nothing
157+ , URI.uriQuery = []
158+ , URI.uriFragment = Nothing
161159 }
162160 , _gitSource_branch = _gitHubSource_branch s
163161 , _gitSource_fetchSubmodules = False
@@ -175,20 +173,20 @@ commitNameToRef (N c) = Ref.fromHex $ encodeUtf8 c
175173-- TODO: Use spinner here.
176174getNixSha256ForUriUnpacked
177175 :: MonadObelisk m
178− => URI
176+ => GitUri
179177 -> m NixSha256
180178getNixSha256ForUriUnpacked uri =
181− withExitFailMessage ("nix-prefetch-url: Failed to determine sha256 hash of URL " <> render uri) $ do
179+ withExitFailMessage ("nix-prefetch-url: Failed to determine sha256 hash of URL " <> gitUriToText uri) $ do
182180 [hash] <- fmap T.lines $ readProcessAndLogOutput (Debug, Debug) $
183− proc "nix-prefetch-url" ["--unpack" , "--type" , "sha256" , T.unpack $ render uri]
181+ proc nixPrefetchUrlPath ["--unpack", "--type", "sha256", T.unpack $ gitUriToText uri]
184182 pure hash
185183
186−nixPrefetchGit :: MonadObelisk m => URI -> Text -> Bool -> m NixSha256
184+nixPrefetchGit :: MonadObelisk m => GitUri -> Text -> Bool -> m NixSha256
187185nixPrefetchGit uri rev fetchSubmodules =
188− withExitFailMessage ("nix-prefetch-git: Failed to determine sha256 hash of Git repo " <> render uri <> " at " <> rev) $ do
186+ withExitFailMessage ("nix-prefetch-git: Failed to determine sha256 hash of Git repo " <> gitUriToText uri <> " at " <> rev) $ do
189187 out <- readProcessAndLogStderr Debug $
190− proc "nix-prefetch-git" $ filter (/="")
191− [ "--url", T.unpack $ render uri
188+ proc nixPrefetchGitPath $ filter (/="")
189+ [ "--url", T.unpack $ gitUriToText uri
192190 , "--rev", T.unpack rev
193191 , if fetchSubmodules then "--fetch-submodules" else ""
194192 , "--quiet"
@@ -200,93 +198,117 @@ nixPrefetchGit uri rev fetchSubmodules =
200198
201199--TODO: Pretty print these
202200data ReadThunkError
203− = ReadThunkError_UnrecognizedFiles
204− | ReadThunkError_AmbiguousFiles
205− | ReadThunkError_UnrecognizedLoader Text
206− | ReadThunkError_UnparseablePtr LBS.ByteString
207− deriving (Show)
208−
209−-- | Read a thunk and validate that it is only a thunk, either packed or unpacked.
210−-- If the thunk is packed and additional data is present, fail.
211−readThunk :: MonadObelisk m => FilePath -> m (Either ReadThunkError ThunkData)
212−readThunk thunkDir = do
213− files <- liftIO $ listDirectory thunkDir
214− case ".git" `elem` files of
215− True -> fmap ThunkData_Checkout <$> do
216− let origThunkPath = thunkDir </> ".git" </> "obelisk" </> "orig-thunk"
217− liftIO $ doesDirectoryExist origThunkPath >>= \case
218− True -> fmap Just <$> readPackedThunk origThunkPath
219− False -> return $ return Nothing
220− False -> liftIO $ fmap ThunkData_Packed <$> readPackedThunk thunkDir
221−
222−data ThunkType = ThunkType
223− { _thunkType_loader :: FilePath
224− , _thunkType_json :: FilePath
225− , _thunkType_optional :: Set FilePath
226− , _thunkType_loaderVersions :: NonEmpty Text
227− , _thunkType_parser :: Aeson.Object -> Aeson.Parser ThunkPtr
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)
228228 }
229229
230−gitHubThunkType :: ThunkType
231−gitHubThunkType = ThunkType
232− { _thunkType_loader = "default.nix"
233− , _thunkType_json = "github.json"
234− , _thunkType_optional = Set.fromList [".attr-cache"]
235− , _thunkType_loaderVersions = gitHubStandaloneLoaders
236− , _thunkType_parser = parseThunkPtr $ \v ->
237− ThunkSource_GitHub <$> parseGitHubSource v <|> ThunkSource_Git <$> parseGitSource v
238− }
239−
240−gitThunkType :: ThunkType
241−gitThunkType = ThunkType
242− { _thunkType_loader = "default.nix"
243− , _thunkType_json = "git.json"
244− , _thunkType_optional = Set.fromList [".attr-cache"]
245− , _thunkType_loaderVersions = plainGitStandaloneLoaders
246− , _thunkType_parser = parseThunkPtr $ fmap ThunkSource_Git . parseGitSource
247− }
248−
249−thunkTypes :: [ThunkType]
250−thunkTypes = [gitThunkType, gitHubThunkType]
251−
252−findThunkType :: [ThunkType] -> FilePath -> IO (Either ReadThunkError ThunkType)
253−findThunkType types thunkDir = do
254− matches <- fmap catMaybes $ forM types $ \thunkType -> do
255− let
256− expectedContents = Set.fromList $ (thunkDir </>) <$>
257− [ _thunkType_loader thunkType
258− , _thunkType_json thunkType
259− ]
260− optionalContents = Set.map (thunkDir </>) (_thunkType_optional thunkType)
261−
262− -- Ensure that there aren't any other files in the thunk
263− -- NB: System.Directory.listDirectory returns the contents without the directory path
264− files <- liftIO $ Set.fromList . fmap (thunkDir </>) <$> listDirectory thunkDir
265− let unexpectedContents = files `Set.difference` (expectedContents `Set.union` optionalContents)
266− missingContents = expectedContents `Set.difference` files
267− pure $ if Set.null unexpectedContents && Set.null missingContents
268− then Just thunkType
269− else Nothing
270−
271− pure $ case matches of
272− [singleMatch] -> Right singleMatch
273− [] -> Left ReadThunkError_UnrecognizedFiles
274− _ -> Left ReadThunkError_AmbiguousFiles
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}|]
275307
276308-- | Read a thunk and validate that it is exactly a packed thunk.
277309-- If additional data is present, fail.
278−readPackedThunk :: FilePath -> IO (Either ReadThunkError ThunkPtr)
279−readPackedThunk thunkDir = runExceptT $ do
280− thunkType <- ExceptT $ findThunkType thunkTypes thunkDir
281− -- Ensure that we recognize the thunk loader
282− loader <- liftIO $ T.readFile $ thunkDir </> _thunkType_loader thunkType
283− unless (loader `elem` _thunkType_loaderVersions thunkType) $ do
284− throwError $ ReadThunkError_UnrecognizedLoader loader
285−
286− txt <- liftIO $ LBS.readFile $ thunkDir </> _thunkType_json thunkType
287− case parseMaybe (_thunkType_parser thunkType) =<< Aeson.decode txt of
288− Nothing -> throwError $ ReadThunkError_UnparseablePtr txt
289− Just ptr -> return ptr
310+readThunk :: (MonadObelisk m) => FilePath -> m (Either ReadThunkError ThunkData)
311+readThunk = readThunkWith thunkSpecTypes
290312
291313parseThunkPtr :: (Aeson.Object -> Aeson.Parser ThunkSource) -> Aeson.Object -> Aeson.Parser ThunkPtr
292314parseThunkPtr parseSrc v = do
@@ -330,16 +352,18 @@ parseGitSource v = do
330352overwriteThunk :: MonadObelisk m => FilePath -> ThunkPtr -> m ()
331353overwriteThunk target thunk = do
332354 -- Ensure that this directory is a valid thunk (i.e. so we aren't losing any data)
333− Right _ <- readThunk target
355+ readThunk target >>= \case
356+ Left e -> failWith [i|Invalid thunk at ${target}: ${e}|]
357+ Right _ -> pure ()
334358
335359 --TODO: Is there a safer way to do this overwriting?
336− liftIO $ removeDirectoryRecursive target
337− liftIO $ createThunk target thunk
360+ liftIO $ removePathForcibly target
361+ createThunk target $ Right thunk
338362
339−thunkPtrLoader :: ThunkPtr -> Text
340−thunkPtrLoader thunk = case _thunkPtr_source thunk of
341− ThunkSource_GitHub _ -> NonEmpty.head gitHubStandaloneLoaders
342− ThunkSource_Git _ -> NonEmpty.head plainGitStandaloneLoaders
363+thunkPtrToSpec :: ThunkPtr -> ThunkSpec
364+thunkPtrToSpec thunk = case _thunkPtr_source thunk of
365+ ThunkSource_GitHub _ -> NonEmpty.head gitHubThunkSpecs
366+ ThunkSource_Git _ -> NonEmpty.head gitThunkSpecs
343367
344368-- It's important that formatting be very consistent here, because
345369-- otherwise when people update thunks, their patches will be messy
@@ -354,7 +378,7 @@ encodeThunkPtrData (ThunkPtr rev src) = case src of
354378 , Just $ "private" .= _gitHubSource_private s
355379 ]
356380 ThunkSource_Git s -> encodePretty' plainGitCfg $ Aeson.object $ catMaybes
357− [ Just $ "url" .= render (_gitSource_url s)
381+ [ Just $ "url" .= gitUriToText (_gitSource_url s)
358382 , Just $ "rev" .= Ref.toHexString (_thunkRev_commit rev)
359383 , ("branch" .=) <$> _gitSource_branch s
360384 , Just $ "sha256" .= _thunkRev_nixSha256 rev
@@ -386,35 +410,41 @@ encodeThunkPtrData (ThunkPtr rev src) = case src of
386410 , confTrailingNewline = True
387411 }
388412
389−createThunk :: MonadIO m => FilePath -> ThunkPtr -> m ()
390−createThunk target thunk = liftIO $ do
391− createDirectoryIfMissing True (target </> ".attr-cache")
392− T.writeFile (target </> "default.nix") (thunkPtrLoader thunk)
393− let
394− jsonFileName = case _thunkPtr_source thunk of
395− ThunkSource_GitHub _ -> "github"
396− ThunkSource_Git _ -> "git"
397− LBS.writeFile (target </> jsonFileName <.> "json") (encodeThunkPtrData thunk)
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
398428
399429createThunkWithLatest :: MonadObelisk m => FilePath -> ThunkSource -> m ()
400430createThunkWithLatest target s = do
401431 rev <- getLatestRev s
402− createThunk target $ ThunkPtr
432+ createThunk target $ Right $ ThunkPtr
403433 { _thunkPtr_source = s
404434 , _thunkPtr_rev = rev
405435 }
406436
407437updateThunkToLatest :: MonadObelisk m => ThunkUpdateConfig -> FilePath -> m ()
408−updateThunkToLatest (ThunkUpdateConfig mBranch thunkConfig) target = withSpinner' ("Updating thunk " <> T.pack target <> " to latest") (pure $ const $ "Thunk " <> T.pack target <> " updated to latest") $ do
409− checkThunkDirectory "ob thunk update directory cannot be '.'" target
438+updateThunkToLatest (ThunkUpdateConfig mBranch thunkConfig) target = spinner $ do
439+ checkThunkDirectory target
410440 -- check to see if thunk should be updated to a specific branch or just update it's current branch
411441 case mBranch of
412442 Nothing -> do
413443 (overwrite, ptr) <- readThunk target >>= \case
414− Left err -> failWith $ T.pack $ "thunk update: " <> show err
444+ Left err -> failWith [i|Thunk update: ${err}|]
415445 Right c -> case c of
416− ThunkData_Packed t -> return (target, t)
417− ThunkData_Checkout _ -> failWith "cannot update an unpacked thunk"
446+ ThunkData_Packed _ t -> return (target, t)
447+ ThunkData_Checkout -> failWith "cannot update an unpacked thunk"
418448 let src = _thunkPtr_source ptr
419449 rev <- getLatestRev src
420450 overwriteThunk overwrite $ modifyThunkPtrByConfig thunkConfig $ ThunkPtr
@@ -422,38 +452,36 @@ updateThunkToLatest (ThunkUpdateConfig mBranch thunkConfig) target = withSpinner
422452 , _thunkPtr_rev = rev
423453 }
424454 Just branch -> readThunk target >>= \case
425− Left err -> failWith $ T.pack $ "thunk update: " <> show err
455+ Left err -> failWith [i|Thunk update: ${err}|]
426456 Right c -> case c of
427− ThunkData_Packed t -> case _thunkPtr_source t of
428− ThunkSource_Git tsg -> setThunk thunkConfig target tsg branch
429− ThunkSource_GitHub tsgh -> do
430− let tsg = forgetGithub False tsgh
431− setThunk thunkConfig target tsg branch
432− 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."
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")
433461
434462setThunk :: MonadObelisk m => ThunkConfig -> FilePath -> GitSource -> String -> m ()
435463setThunk thunkConfig target gs branch = do
436− newThunkPtr <- uriThunkPtr (_gitSource_url gs) (Just $ T.pack branch) Nothing
464+ newThunkPtr <- uriThunkPtr (_gitSource_url gs) (_thunkConfig_private thunkConfig) (Just $ T.pack branch) Nothing
437465 overwriteThunk target newThunkPtr
438466 updateThunkToLatest (ThunkUpdateConfig Nothing thunkConfig) target
439467
440468-- | All recognized github standalone loaders, ordered from newest to oldest.
441469-- This tool will only ever produce the newest one when it writes a thunk.
442−gitHubStandaloneLoaders :: NonEmpty Text
443−gitHubStandaloneLoaders =
444− gitHubStandaloneLoaderV4 :|
445− [ gitHubStandaloneLoaderV3
446− , gitHubStandaloneLoaderV2
447− , gitHubStandaloneLoaderV1
470+gitHubThunkSpecs :: NonEmpty ThunkSpec
471+gitHubThunkSpecs =
472+ gitHubThunkSpecV5 :|
473+ [ gitHubThunkSpecV4
474+ , gitHubThunkSpecV3
475+ , gitHubThunkSpecV2
476+ , gitHubThunkSpecV1
448477 ]
449478
450−gitHubStandaloneLoaderV1 :: Text
451−gitHubStandaloneLoaderV1 = T.unlines
452− [ "import ((import <nixpkgs> {}).fetchFromGitHub (builtins.fromJSON (builtins.readFile ./github.json)))"
453− ]
479+gitHubThunkSpecV1 :: ThunkSpec
480+gitHubThunkSpecV1 = legacyGitHubThunkSpec "github-v1"
481+ "import ((import <nixpkgs> {}).fetchFromGitHub (builtins.fromJSON (builtins.readFile ./github.json)))"
454482
455−gitHubStandaloneLoaderV2 :: Text
456−gitHubStandaloneLoaderV2 = T.unlines
483+gitHubThunkSpecV2 :: ThunkSpec
484+gitHubThunkSpecV2 = legacyGitHubThunkSpec "github-v2" $ T.unlines
457485 [ "# DO NOT HAND-EDIT THIS FILE" --TODO: Add something about how to get more info on Obelisk, etc.
458486 , "import ((import <nixpkgs> {}).fetchFromGitHub ("
459487 , " let json = builtins.fromJSON (builtins.readFile ./github.json);"
@@ -463,8 +491,8 @@ gitHubStandaloneLoaderV2 = T.unlines
463491 , "))"
464492 ]
465493
466−gitHubStandaloneLoaderV3 :: Text
467−gitHubStandaloneLoaderV3 = T.unlines
494+gitHubThunkSpecV3 :: ThunkSpec
495+gitHubThunkSpecV3 = legacyGitHubThunkSpec "github-v3" $ T.unlines
468496 [ "# DO NOT HAND-EDIT THIS FILE"
469497 , "let"
470498 , " fetch = { private ? false, ... }@args: if private && builtins.hasAttr \"fetchGit\" builtins"
@@ -483,8 +511,8 @@ gitHubStandaloneLoaderV3 = T.unlines
483511 , "in import (fetch (builtins.fromJSON (builtins.readFile ./github.json)))"
484512 ]
485513
486−gitHubStandaloneLoaderV4 :: Text
487−gitHubStandaloneLoaderV4 = T.unlines
514+gitHubThunkSpecV4 :: ThunkSpec
515+gitHubThunkSpecV4 = legacyGitHubThunkSpec "github-v4" $ T.unlines
488516 [ "# DO NOT HAND-EDIT THIS FILE"
489517 , "let fetch = { private ? false, fetchSubmodules ? false, owner, repo, rev, sha256, ... }:"
490518 , " if !fetchSubmodules && !private then builtins.fetchTarball {"
@@ -495,23 +523,50 @@ gitHubStandaloneLoaderV4 = T.unlines
495523 , "in import (fetch (builtins.fromJSON (builtins.readFile ./github.json)))"
496524 ]
497525
498−plainGitStandaloneLoaders :: NonEmpty Text
499−plainGitStandaloneLoaders =
500− plainGitStandaloneLoaderV3 :|
501− [ plainGitStandaloneLoaderV1
502− , plainGitStandaloneLoaderV2
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
503558 ]
504559
505−plainGitStandaloneLoaderV1 :: Text
506−plainGitStandaloneLoaderV1 = T.unlines
560+gitThunkSpecV1 :: ThunkSpec
561+gitThunkSpecV1 = legacyGitThunkSpec "git-v1" $ T.unlines
507562 [ "# DO NOT HAND-EDIT THIS FILE"
508563 , "let fetchGit = {url, rev, ref ? null, branch ? null, sha256 ? null, fetchSubmodules ? null}:"
509564 , " assert !fetchSubmodules; (import <nixpkgs> {}).fetchgit { inherit url rev sha256; };"
510565 , "in import (fetchGit (builtins.fromJSON (builtins.readFile ./git.json)))"
511566 ]
512567
513−plainGitStandaloneLoaderV2 :: Text
514−plainGitStandaloneLoaderV2 = T.unlines
568+gitThunkSpecV2 :: ThunkSpec
569+gitThunkSpecV2 = legacyGitThunkSpec "git-v2" $ T.unlines
515570 [ "# DO NOT HAND-EDIT THIS FILE"
516571 , "let fetchGit = {url, rev, ref ? null, branch ? null, sha256 ? null, fetchSubmodules ? null}:"
517572 , " if builtins.hasAttr \"fetchGit\" builtins"
@@ -520,8 +575,10 @@ plainGitStandaloneLoaderV2 = T.unlines
520575 , "in import (fetchGit (builtins.fromJSON (builtins.readFile ./git.json)))"
521576 ]
522577
523−plainGitStandaloneLoaderV3 :: Text
524−plainGitStandaloneLoaderV3 = T.unlines
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
525582 [ "# DO NOT HAND-EDIT THIS FILE"
526583 , "let fetch = {url, rev, ref ? null, sha256 ? null, fetchSubmodules ? false, private ? false, ...}:"
527584 , " let realUrl = let firstChar = builtins.substring 0 1 url; in"
@@ -536,10 +593,69 @@ plainGitStandaloneLoaderV3 = T.unlines
536593 , "in import (fetch (builtins.fromJSON (builtins.readFile ./git.json)))"
537594 ]
538595
539−thunkFileNames :: [FilePath]
540−thunkFileNames = ["default.nix", "github.json", "git.json"]
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+ ]
541612
542−--TODO: when checking something out, make a shallow clone
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+
656+
657+parseJsonObject :: (Aeson.Object -> Aeson.Parser a) -> LBS.ByteString -> Either String a
658+parseJsonObject p bytes = Aeson.parseEither p =<< Aeson.eitherDecode bytes
543659
544660-- | Checks a cache directory to see if there is a fresh symlink
545661-- to the result of building an attribute of a thunk.
@@ -547,44 +663,49 @@ thunkFileNames = ["default.nix", "github.json", "git.json"]
547663-- and the result is symlinked into the cache.
548664nixBuildThunkAttrWithCache
549665 :: MonadObelisk m
550− => FilePath
666+ => ThunkSpec
667+ -> FilePath
551668 -- ^ Path to directory containing Thunk
552669 -> String
553670 -- ^ Attribute to build
554− -> m FilePath
671+ -> m (Maybe FilePath)
555672 -- ^ Symlink to cached or built nix output
556673-- WARNING: If the thunk uses an impure reference such as '<nixpkgs>'
557674-- the caching mechanism will fail as it merely measures the modification
558675-- time of the cache link and the expression to build.
559−nixBuildThunkAttrWithCache thunkDir attr = do
560− --NB: Expects thunkDir to be normalised with no trailing path separator.
561− --This should be guaranteed by the command argument parser.
562− let cacheErrHandler e
563− | isDoesNotExistError e = return Nothing -- expected from a cache miss
564− | otherwise = putLog Error (T.pack $ displayException e) >> return Nothing
565− cacheDir = thunkDir </> ".attr-cache"
566− cachePath = cacheDir </> attr <.> "out"
676+nixBuildThunkAttrWithCache thunkSpec thunkDir attr = do
567677 latestChange <- liftIO $ do
568− createDirectoryIfMissing False cacheDir
569− let getModificationTimeMaybe = fmap rightToMaybe . try @IOError . getModificationTime
570− maximum . catMaybes <$> mapM (getModificationTimeMaybe . (thunkDir </>)) thunkFileNames
571− cacheHit <- handle cacheErrHandler $ do
572− cacheTime <- liftIO $ posixSecondsToUTCTime . realToFrac . modificationTime <$> getSymbolicLinkStatus cachePath
573− return $ if latestChange <= cacheTime
574− then Just cachePath
575− else Nothing
576− case cacheHit of
577− Just c -> return c
578− Nothing -> do
579− putLog Warning $ T.pack $ mconcat [thunkDir, ": ", attr, " not cached, building ..."]
580− _ <- nixCmd $ NixCmd_Build $ def
581− Lens.& nixBuildConfig_outLink Lens..~ OutLink_IndirectRoot cachePath
582− Lens.& nixCmdConfig_target Lens..~ Target
583− { _target_path = Just thunkDir
584− , _target_attr = Just attr
585− , _target_expr = Nothing
586− }
587− return cachePath
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+ }
588709
589710-- | Build a nix attribute, and cache the result if possible
590711nixBuildAttrWithCache
@@ -595,13 +716,15 @@ nixBuildAttrWithCache
595716 -- ^ Attribute to build
596717 -> m FilePath
597718 -- ^ Symlink to cached or built nix output
598−nixBuildAttrWithCache exprPath attr = do
599− readThunk exprPath >>= \case
600− -- Only packed thunks are cached. in particular, checkouts are not
601− Right (ThunkData_Packed _) -> nixBuildThunkAttrWithCache exprPath attr
602− _ -> nixCmd $ NixCmd_Build $ def
603− Lens.& nixBuildConfig_outLink Lens..~ OutLink_None
604− Lens.& nixCmdConfig_target Lens..~ Target
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
605728 { _target_path = Just exprPath
606729 , _target_attr = Just attr
607730 , _target_expr = Nothing
@@ -622,76 +745,95 @@ updateThunk p f = withSystemTempDirectory "obelisk-thunkptr-" $ \tmpDir -> do
622745 where
623746 copyThunkToTmp tmpDir thunkDir = readThunk thunkDir >>= \case
624747 Left err -> failWith $ "withThunkUnpacked: " <> T.pack (show err)
625− Right (ThunkData_Packed _) -> do
748+ Right ThunkData_Packed{} -> do
626749 let tmpThunk = tmpDir </> "thunk"
627750 callProcessAndLogOutput (Notice, Error) $
628− proc "cp" ["-r", "-T", thunkDir, tmpThunk]
751+ proc cp ["-r", "-T", thunkDir, tmpThunk]
629752 return tmpThunk
630753 Right _ -> failWith "Thunk is not packed"
631754 updateThunkFromTmp p' = do
632755 _ <- packThunk' True (ThunkPackConfig False (ThunkConfig Nothing)) p'
633756 callProcessAndLogOutput (Notice, Error) $
634− proc "cp" ["-r", "-T", p', p]
757+ proc cp ["-r", "-T", p', p]
635758
636759finalMsg :: Bool -> (a -> Text) -> Maybe (a -> Text)
637760finalMsg noTrail s = if noTrail then Nothing else Just s
638761
639−unpackThunk :: MonadObelisk m => FilePath -> m ()
640−unpackThunk = unpackThunk' False
641−
642762-- | Check that we are not somewhere inside the thunk directory
643−checkThunkDirectory :: MonadObelisk m => Text -> FilePath -> m ()
644−checkThunkDirectory msg thunkDir = do
763+checkThunkDirectory :: MonadObelisk m => FilePath -> m ()
764+checkThunkDirectory thunkDir = do
645765 currentDir <- liftIO getCurrentDirectory
646766 thunkDir' <- liftIO $ canonicalizePath thunkDir
647− when (thunkDir' `L.isInfixOf` currentDir) $ failWith msg
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
648778
649779unpackThunk' :: MonadObelisk m => Bool -> FilePath -> m ()
650−unpackThunk' noTrail thunkDir = checkThunkDirectory "Can't pack/unpack from within the thunk directory" thunkDir >> readThunk thunkDir >>= \case
651− Left err -> failWith $ "thunk unpack: " <> T.pack (show err)
780+unpackThunk' noTrail thunkDir = checkThunkDirectory thunkDir *> readThunk thunkDir >>= \case
781+ Left err -> failWith [i|Invalid thunk at ${thunkDir}: ${err}|]
652782 --TODO: Overwrite option that rechecks out thunk; force option to do so even if working directory is dirty
653− Right (ThunkData_Checkout _) -> failWith "thunk unpack: thunk is already unpacked"
654− Right (ThunkData_Packed tptr) -> do
783+ Right ThunkData_Checkout -> failWith [i|Thunk at ${thunkDir} is already unpacked|]
784+ Right (ThunkData_Packed _ tptr) -> do
655785 let (thunkParent, thunkName) = splitFileName thunkDir
656− withTempDirectory thunkParent thunkName $ \tmpRepo -> do
657− let obGitDir = tmpRepo </> ".git" </> "obelisk"
658− s = case _thunkPtr_source tptr of
659− ThunkSource_GitHub s' -> forgetGithub False s'
660− ThunkSource_Git s' -> s'
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
661792 withSpinner' ("Fetching thunk " <> T.pack thunkName)
662793 (finalMsg noTrail $ const $ "Fetched thunk " <> T.pack thunkName) $ do
663− let git = callProcessAndLogOutput (Notice, Notice) . gitProc tmpRepo
664− git $ [ "clone" ]
665− ++ ("--recursive" <$ guard (_gitSource_fetchSubmodules s))
666− ++ [ T.unpack $ render $ _gitSource_url s ]
667− ++ do branch <- maybeToList $ _gitSource_branch s
668− [ "--branch", T.unpack $ untagName branch ]
669− git ["reset", "--hard", Ref.toHexString $ _thunkRev_commit $ _thunkPtr_rev tptr]
670− when (_gitSource_fetchSubmodules s) $
671− git ["submodule", "update", "--recursive", "--init"]
672−
673− liftIO $ createDirectory obGitDir
674− callProcessAndLogOutput (Notice, Error) $
675− proc "cp" ["-r", "-T", thunkDir </> ".", obGitDir </> "orig-thunk"]
676− callProcessAndLogOutput (Notice, Error) $
677− proc "rm" ["-r", thunkDir]
678− callProcessAndLogOutput (Notice, Error) $
679− proc "mv" ["-T", tmpRepo, thunkDir]
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"]
680821
681822--TODO: add a rollback mode to pack to the original thunk
682823packThunk :: MonadObelisk m => ThunkPackConfig -> FilePath -> m ThunkPtr
683824packThunk = packThunk' False
684825
685826packThunk' :: MonadObelisk m => Bool -> ThunkPackConfig -> FilePath -> m ThunkPtr
686−packThunk' noTrail (ThunkPackConfig force thunkConfig) thunkDir = checkThunkDirectory "Can't pack/unpack from within the thunk directory" thunkDir >> readThunk thunkDir >>= \case
687− Left err -> failWith $ T.pack $ "thunk pack: " <> show err
688− Right (ThunkData_Packed _) -> failWith "pack: thunk is already packed"
689− Right (ThunkData_Checkout _) -> do
690− withSpinner' ("Packing thunk " <> T.pack thunkDir)
691− (finalMsg noTrail $ const $ "Packed thunk " <> T.pack thunkDir) $ do
692− thunkPtr <- modifyThunkPtrByConfig thunkConfig <$> getThunkPtr (not force) thunkDir
693− callProcessAndLogOutput (Debug, Error) $ proc "rm" ["-rf", thunkDir]
694− liftIO $ createThunk thunkDir 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
695837 pure thunkPtr
696838
697839modifyThunkPtrByConfig :: ThunkConfig -> ThunkPtr -> ThunkPtr
@@ -702,31 +844,45 @@ modifyThunkPtrByConfig (ThunkConfig markPrivate') ptr = case markPrivate' of
702844 ThunkSource_GitHub s -> ThunkSource_GitHub $ s { _gitHubSource_private = markPrivate }
703845 }
704846
705−getThunkPtr :: forall m. MonadObelisk m => Bool -> FilePath -> m ThunkPtr
706−getThunkPtr checkClean thunkDir = do
707− when checkClean $ ensureCleanGitRepo thunkDir True
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
708869 "thunk pack: thunk checkout contains unsaved modifications"
709870
710871 -- Check whether there are any stashes
711− stashOutput <- readGitProcess thunkDir ["stash", "list"]
712− when checkClean $ case T.null stashOutput of
713− False -> do
872+ when checkClean $ do
873+ stashOutput <- readGitProcess thunkDir ["stash", "list"]
874+ unless (T.null stashOutput) $
714875 failWith $ T.unlines $
715876 [ "thunk pack: thunk checkout has stashes"
716877 , "git stash list:"
717878 ] ++ T.lines stashOutput
718− True -> return ()
719879
720− -- Get current branch ``
880+ -- Get current branch
721881 (mCurrentBranch, mCurrentCommit) <- do
722− b <- listToMaybe
723− <$> T.lines
724− <$> readGitProcess thunkDir ["rev-parse", "--abbrev-ref", "HEAD"]
725− c <- listToMaybe
726− <$> T.lines
727− <$> readGitProcess thunkDir ["rev-parse", "HEAD"]
882+ b <- listToMaybe . T.lines <$> readGitProcess thunkDir ["rev-parse", "--abbrev-ref", "HEAD"]
883+ c <- listToMaybe . T.lines <$> readGitProcess thunkDir ["rev-parse", "HEAD"]
728884 case b of
729− (Just "HEAD") -> failWith $ T.unlines $
885+ (Just "HEAD") -> failWith $ T.unlines
730886 [ "thunk pack: You are in 'detached HEAD' state."
731887 , "If you want to pack at the current ref \
732888 \then please create a new branch with 'git checkout -b <new-branch-name>' and push this upstream."
@@ -735,7 +891,7 @@ getThunkPtr checkClean thunkDir = do
735891
736892 -- Get information on all branches and their (optional) designated upstream
737893 -- correspondents
738− (headDump :: [Text]) <- T.lines <$> readGitProcess thunkDir
894+ headDump :: [Text] <- T.lines <$> readGitProcess thunkDir
739895 [ "for-each-ref"
740896 , "--format=%(refname:short) %(upstream:short) %(upstream:remotename)"
741897 , "refs/heads/"
@@ -781,7 +937,7 @@ getThunkPtr checkClean thunkDir = do
781937 ]
782938
783939 -- loosely by https://stackoverflow.com/questions/7773939/show-git-ahead-and-behind-info-for-all-branches-including-remotes
784− stats <- iforM headUpstream $ \branch (upstream, _remote) -> do
940+ stats <- ifor headUpstream $ \branch (upstream, _remote) -> do
785941 (stat :: [Text]) <- T.lines <$> readGitProcess thunkDir
786942 [ "rev-list", "--left-right"
787943 , T.unpack branch <> "..." <> T.unpack upstream
@@ -805,8 +961,9 @@ getThunkPtr checkClean thunkDir = do
805961 \pushed but this repo's remote tracking branches don't know it.)"
806962 ]
807963
808− -- We assume it's safe to pack the thunk at this point
809− putLog Informational "All changes safe in git remotes. OK to pack thunk."
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."
810967
811968 let remote = maybe "origin" snd $ flip Map.lookup headUpstream =<< mCurrentBranch
812969
@@ -819,14 +976,12 @@ getThunkPtr checkClean thunkDir = do
819976 remoteUri <- case parseGitUri remoteUri' of
820977 Nothing -> failWith $ "Could not identify git remote: " <> remoteUri'
821978 Just uri -> pure uri
822− uriThunkPtr remoteUri mCurrentBranch mCurrentCommit
979+ uriThunkPtr remoteUri mPrivate mCurrentBranch mCurrentCommit
823980
824981-- | Get the latest revision available from the given source
825982getLatestRev :: MonadObelisk m => ThunkSource -> m ThunkRev
826983getLatestRev os = do
827− let gitS = case os of
828− ThunkSource_GitHub s -> forgetGithub False s
829− ThunkSource_Git s -> s
984+ let gitS = thunkSourceToGitSource os
830985 (_, commit) <- gitGetCommitBranch (_gitSource_url gitS) (untagName <$> _gitSource_branch gitS)
831986 case os of
832987 ThunkSource_GitHub s -> githubThunkRev s commit
@@ -838,12 +993,12 @@ getLatestRev os = do
838993-- performance. If that doesn't work (e.g. authentication issue), we fall back
839994-- on just doing things the normal way for git repos in general, and save it as
840995-- a regular git thunk.
841−uriThunkPtr :: MonadObelisk m => URI -> Maybe Text -> Maybe Text -> m ThunkPtr
842−uriThunkPtr uri mbranch mcommit = do
996+uriThunkPtr :: MonadObelisk m => GitUri -> Maybe Bool -> Maybe Text -> Maybe Text -> m ThunkPtr
997+uriThunkPtr uri mPrivate mbranch mcommit = do
843998 commit <- case mcommit of
844999 Nothing -> gitGetCommitBranch uri mbranch >>= return . snd
8451000 (Just c) -> return c
846− (src, rev) <- case uriToThunkSource uri mbranch of
1001+ (src, rev) <- uriToThunkSource uri mPrivate mbranch >>= \case
8471002 ThunkSource_GitHub s -> do
8481003 rev <- runExceptT $ githubThunkRev s commit
8491004 case rev of
@@ -866,34 +1021,66 @@ uriThunkPtr uri mbranch mcommit = do
8661021-- If the thunk is a GitHub thunk and fails, we do *not* fall back like with
8671022-- `uriThunkPtr`. Unlike a plain URL, a thunk src explicitly states which method
8681023-- should be employed, and so we respect that.
869−uriToThunkSource :: URI -> Maybe Text -> ThunkSource
870−uriToThunkSource u
871− | Right uriAuth <- uriAuthority u
872− , Just scheme <- unRText <$> uriScheme u
1024+uriToThunkSource :: MonadObelisk m => GitUri -> Maybe Bool -> Maybe Text -> m ThunkSource
1025+uriToThunkSource (GitUri u) mPrivate
1026+ | Right uriAuth <- URI.uriAuthority u
1027+ , Just scheme <- URI.unRText <$> URI.uriScheme u
8731028 , case scheme of
874− "ssh" -> uriAuth == Authority
875− { authUserInfo = Just $ UserInfo (fromRight' $ mkUsername "git") Nothing
876− , authHost = fromRight' $ mkHost "github.com"
877− , authPort = Nothing
1029+ "ssh" -> uriAuth == URI.Authority
1030+ { URI.authUserInfo = Just $ URI.UserInfo (fromRight' $ URI.mkUsername "git") Nothing
1031+ , URI.authHost = fromRight' $ URI.mkHost "github.com"
1032+ , URI.authPort = Nothing
8781033 }
8791034 s -> s `L.elem` [ "git", "https", "http" ] -- "http:" just redirects to "https:"
880− && unRText (authHost uriAuth) == "github.com"
881− , Just (_, owner :| [repoish]) <- uriPath u
882− = \mbranch -> ThunkSource_GitHub $ GitHubSource
883− { _gitHubSource_owner = N $ unRText owner
884− , _gitHubSource_repo = N $ let
885− repoish' = unRText repoish
886− in fromMaybe repoish' $ T.stripSuffix ".git" repoish'
887− , _gitHubSource_branch = N <$> mbranch
888− , _gitHubSource_private = False -- TODO: Can we try something to infer this?
889− }
1035+ && URI.unRText (URI.authHost uriAuth) == "github.com"
1036+ , 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+ }
8901047
891− | otherwise = \mbranch -> ThunkSource_Git $ GitSource
892− { _gitSource_url = u
893− , _gitSource_branch = N <$> mbranch
894− , _gitSource_fetchSubmodules = False -- TODO: How do we determine if this should be true?
895− , _gitSource_private = False -- TODO: Can we try something to infer this?
896− }
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+ }
8971084
8981085-- Funny signature indicates no effects depend on the optional branch name.
8991086githubThunkRev
@@ -905,19 +1092,19 @@ githubThunkRev
9051092githubThunkRev s commit = do
9061093 owner <- forcePP $ _gitHubSource_owner s
9071094 repo <- forcePP $ _gitHubSource_repo s
908− revTarball <- mkPathPiece $ commit <> ".tar.gz"
909− let archiveUri = URI
910− { uriScheme = Just $ fromRight' $ mkScheme "https"
911− , uriAuthority = Right $ Authority
912− { authUserInfo = Nothing
913− , authHost = fromRight' $ mkHost "github.com"
914− , authPort = Nothing
1095+ revTarball <- URI.mkPathPiece $ commit <> ".tar.gz"
1096+ let archiveUri = GitUri $ URI.URI
1097+ { URI.uriScheme = Just $ fromRight' $ URI.mkScheme "https"
1098+ , URI.uriAuthority = Right $ URI.Authority
1099+ { URI.authUserInfo = Nothing
1100+ , URI.authHost = fromRight' $ URI.mkHost "github.com"
1101+ , URI.authPort = Nothing
9151102 }
916− , uriPath = Just ( False
917− , owner :| [ repo, fromRight' $ mkPathPiece "archive", revTarball ]
1103+ , URI.uriPath = Just ( False
1104+ , owner :| [ repo, fromRight' $ URI.mkPathPiece "archive", revTarball ]
9181105 )
919− , uriQuery = []
920− , uriFragment = Nothing
1106+ , URI.uriQuery = []
1107+ , URI.uriFragment = Nothing
9211108 }
9221109 hash <- getNixSha256ForUriUnpacked archiveUri
9231110 putLog Debug $ "Nix sha256 is " <> hash
@@ -926,8 +1113,8 @@ githubThunkRev s commit = do
9261113 , _thunkRev_nixSha256 = hash
9271114 }
9281115 where
929− forcePP :: Name entity -> m (RText 'PathPiece)
930− forcePP = mkPathPiece . untagName
1116+ forcePP :: Name entity -> m (URI.RText 'URI.PathPiece)
1117+ forcePP = URI.mkPathPiece . untagName
9311118
9321119gitThunkRev
9331120 :: MonadObelisk m
@@ -936,11 +1123,11 @@ gitThunkRev
9361123 -> m ThunkRev
9371124gitThunkRev s commit = do
9381125 let u = _gitSource_url s
939− protocols = ["https", "ssh", "git"]
940− Just scheme <- pure $ unRText <$> uriScheme u
1126+ protocols = ["file", "https", "ssh", "git"]
1127+ scheme = maybe "file" URI.unRText $ URI.uriScheme $ (\(GitUri x) -> x) u
9411128 unless (T.toLower scheme `elem` protocols) $
9421129 failWith $ "obelisk currently only supports "
943− <> T.intercalate ", " protocols <> " protocols for non-GitHub remotes"
1130+ <> T.intercalate ", " protocols <> " protocols for plain Git remotes"
9441131 hash <- nixPrefetchGit u commit $ _gitSource_fetchSubmodules s
9451132 putLog Informational $ "Nix sha256 is " <> hash
9461133 pure $ ThunkRev
@@ -953,11 +1140,12 @@ gitThunkRev s commit = do
9531140--
9541141-- If the branch name is passed in, it is returned exactly as-is. If it is not
9551142-- passed it, the default branch of the repo is used instead.
1143+
9561144gitGetCommitBranch
957− :: MonadObelisk m => URI -> Maybe Text -> m (Text, CommitId)
1145+ :: MonadObelisk m => GitUri -> Maybe Text -> m (Text, CommitId)
9581146gitGetCommitBranch uri mbranch = withExitFailMessage ("Failure for git remote " <> uriMsg) $ do
9591147 (_, bothMaps) <- gitLsRemote
960− (T.unpack $ render uri)
1148+ (T.unpack $ gitUriToText uri)
9611149 (GitRef_Branch <$> mbranch)
9621150 Nothing
9631151 branch <- case mbranch of
@@ -973,18 +1161,21 @@ gitGetCommitBranch uri mbranch = withExitFailMessage ("Failure for git remote "
9731161 pure (branch, commit)
9741162 where
9751163 rethrowE = either failWith pure
976− uriMsg = render uri
1164+ uriMsg = gitUriToText uri
1165+
1166+parseGitUri :: Text -> Maybe GitUri
1167+parseGitUri x = GitUri <$> (parseFileURI x <|> parseAbsoluteURI x <|> parseSshShorthand x)
9771168
978−parseGitUri :: Text -> Maybe URI
979−parseGitUri x = parseAbsoluteURI x <|> parseSshShorthand x
1169+parseFileURI :: Text -> Maybe URI.URI
1170+parseFileURI uri = if "/" `T.isPrefixOf` uri then parseAbsoluteURI ("file://" <> uri) else Nothing
9801171
981−parseAbsoluteURI :: Text -> Maybe URI
1172+parseAbsoluteURI :: Text -> Maybe URI.URI
9821173parseAbsoluteURI uri = do
983− parsedUri <- mkURI uri
984− guard $ isPathAbsolute parsedUri
1174+ parsedUri <- URI.mkURI uri
1175+ guard $ URI.isPathAbsolute parsedUri
9851176 pure parsedUri
9861177
987−parseSshShorthand :: Text -> Maybe URI
1178+parseSshShorthand :: Text -> Maybe URI.URI
9881179parseSshShorthand uri = do
9891180 -- This is what git does to check that the remote
9901181 -- is not a local file path when parsing shorthand.
@@ -997,4 +1188,4 @@ parseSshShorthand uri = do
9971188 -- This check is used to disambiguate a filepath containing a colon from shorthand
9981189 guard $ isNothing (T.findIndex (=='/') authAndHostname)
9991190 && not (T.null colonAndPath)
1000− mkURI properUri
1191+ URI.mkURI properUri