@@ -5,86 +5,70 @@
55{-# LANGUAGE MultiWayIf #-}
66{-# LANGUAGE OverloadedStrings #-}
77{-# LANGUAGE PatternGuards #-}
8+{-# LANGUAGE QuasiQuotes #-}
89{-# LANGUAGE ScopedTypeVariables #-}
910{-# LANGUAGE TypeApplications #-}
10−module Obelisk.Command.Thunk
11− ( ThunkPtr (..)
12− , ThunkRev (..)
13− , ThunkSource (..)
14− , ThunkData (..)
15− , ReadThunkError (..)
16− , GitHubSource (..)
17− , getThunkGitBranch
18− , getLatestRev
19− , updateThunkToLatest
20− , createThunk
21− , createThunkWithLatest
22− , nixBuildAttrWithCache
23− , nixBuildThunkAttrWithCache
24− , unpackThunk
25− , packThunk
26− , readThunk
27− , updateThunk
28− , getThunkPtr
29− , getThunkPtr'
30− , parseGitUri
31− , uriThunkPtr
32− ) where
11+module Obelisk.Command.Thunk where
3312
3413import Control.Applicative
35−import Control.Exception (displayException, throwIO, try)
14+import Control.Exception (displayException, try)
15+import Control.Lens (ifor, ifor_, (.~))
3616import Control.Monad
37−import Control.Monad.Catch (handle)
17+import Control.Monad.Extra (findM)
18+import Control.Monad.Catch (MonadCatch, handle)
3819import Control.Monad.Except
3920import Data.Aeson ((.=))
4021import qualified Data.Aeson as Aeson
4122import Data.Aeson.Encode.Pretty
4223import qualified Data.Aeson.Types as Aeson
43−import Data.Bifunctor
24+import Data.Bifunctor (first)
4425import qualified Data.ByteString.Lazy as LBS
26+import Data.Containers.ListUtils (nubOrd)
4527import Data.Default
46−import Data.Either.Combinators (rightToMaybe)
47−import Data.Foldable
28+import Data.Either.Combinators (fromRight', rightToMaybe)
29+import Data.Foldable (toList)
30+import Data.Function ((&))
31+import Data.Functor ((<&>))
4832import Data.Git.Ref (Ref)
4933import qualified Data.Git.Ref as Ref
5034import qualified Data.List as L
51−import Data.List.NonEmpty (NonEmpty (..))
35+import Data.List.NonEmpty (NonEmpty (..), nonEmpty)
5236import qualified Data.List.NonEmpty as NonEmpty
37+import Data.Map (Map)
5338import qualified Data.Map as Map
5439import Data.Maybe
5540import Data.Set (Set)
5641import qualified Data.Set as Set
42+import Data.String.Here.Interpolated (i)
43+import Data.String.Here.Uninterpolated (here)
5744import Data.Text (Text)
5845import qualified Data.Text as T
5946import Data.Text.Encoding
6047import qualified Data.Text.IO as T
6148import Data.Time.Clock.POSIX (posixSecondsToUTCTime)
62−import Data.Yaml (parseMaybe, (.:))
63−import qualified Data.Yaml as Yaml
49+import Data.Traversable (for)
50+import Data.Yaml (parseMaybe)
6451import GitHub
6552import GitHub.Data.Name
66−import GitHub.Endpoints.Repos.Contents (archiveForR)
67−import Network.URI
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)
59+import System.PosixCompat.Files (getSymbolicLinkStatus, modificationTime)
60+import qualified Text.URI as URI
7561
7662import Obelisk.App (MonadObelisk)
7763import Obelisk.CliApp
78−import Obelisk.Command.Nix (withNixRemoteCheck)
7964import 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
@@ -97,7 +81,7 @@ type NixSha256 = Text --TODO: Use a smart constructor and make this actually ver
9781
9882-- | A specific revision of data; it may be available from multiple sources
9983data ThunkRev = ThunkRev
100− { _thunkRev_commit :: Ref
84+ { _thunkRev_commit :: Ref Ref.SHA1
10185 , _thunkRev_nixSha256 :: NixSha256
10286 }
10387 deriving (Show, Eq, Ord)
@@ -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,37 +107,86 @@ 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
123− , _gitSource_branch :: Name Branch
120+ { _gitSource_url :: GitUri
121+ , _gitSource_branch :: Maybe (Name Branch)
124122 , _gitSource_fetchSubmodules :: Bool
123+ , _gitSource_private :: Bool
125124 }
126125 deriving (Show, Eq, Ord)
127126
127+newtype ThunkConfig = ThunkConfig
128+ { _thunkConfig_private :: Maybe Bool
129+ } deriving Show
130+
131+data ThunkUpdateConfig = ThunkUpdateConfig
132+ { _thunkUpdateConfig_branch :: Maybe String
133+ , _thunkUpdateConfig_config :: ThunkConfig
134+ } deriving Show
135+
136+data ThunkPackConfig = ThunkPackConfig
137+ { _thunkPackConfig_force :: Bool
138+ , _thunkPackConfig_config :: ThunkConfig
139+ } deriving Show
140+
141+-- | Convert a GitHub source to a regular Git source. Assumes no submodules.
142+forgetGithub :: Bool -> GitHubSource -> GitSource
143+forgetGithub useSsh s = GitSource
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
148+ <$ guard useSsh
149+ , URI.authHost = fromRight' $ URI.mkHost "github.com"
150+ , URI.authPort = Nothing
151+ }
152+ , URI.uriPath = Just ( False
153+ , fromRight' . URI.mkPathPiece <$>
154+ untagName (_gitHubSource_owner s)
155+ :| [ untagName (_gitHubSource_repo s) <> ".git" ]
156+ )
157+ , URI.uriQuery = []
158+ , URI.uriFragment = Nothing
159+ }
160+ , _gitSource_branch = _gitHubSource_branch s
161+ , _gitSource_fetchSubmodules = False
162+ , _gitSource_private = _gitHubSource_private s
163+ }
164+
128165getThunkGitBranch :: ThunkPtr -> Maybe Text
129166getThunkGitBranch (ThunkPtr _ src) = fmap untagName $ case src of
130167 ThunkSource_GitHub s -> _gitHubSource_branch s
131− ThunkSource_Git s -> Just $ _gitSource_branch s
168+ ThunkSource_Git s -> _gitSource_branch s
132169
133−commitNameToRef :: Name Commit -> Ref
170+commitNameToRef :: Name Commit -> Ref Ref.SHA1
134171commitNameToRef (N c) = Ref.fromHex $ encodeUtf8 c
135172
136173-- TODO: Use spinner here.
137174getNixSha256ForUriUnpacked
138175 :: MonadObelisk m
139− => URI
176+ => GitUri
140177 -> m NixSha256
141178getNixSha256ForUriUnpacked uri =
142− withExitFailMessage ("nix-prefetch-url: Failed to determine sha256 hash of URL " <> T.pack (show uri)) $ do
143− withNixRemoteCheck $ readProcessAndLogStderr Debug $
144− proc "nix-prefetch-url" ["--unpack" , "--type" , "sha256" , show uri]
179+ withExitFailMessage ("nix-prefetch-url: Failed to determine sha256 hash of URL " <> gitUriToText uri) $ do
180+ [hash] <- fmap T.lines $ readProcessAndLogOutput (Debug, Debug) $
181+ proc nixPrefetchUrlPath ["--unpack", "--type", "sha256", T.unpack $ gitUriToText uri]
182+ pure hash
145183
146−nixPrefetchGit :: MonadObelisk m => URI -> Text -> Bool -> m NixSha256
184+nixPrefetchGit :: MonadObelisk m => GitUri -> Text -> Bool -> m NixSha256
147185nixPrefetchGit uri rev fetchSubmodules =
148− withExitFailMessage ("nix-prefetch-git: Failed to determine sha256 hash of Git repo " <> T.pack (show uri) <> " at " <> rev) $ do
149− out <- withNixRemoteCheck $ readProcessAndLogStderr Debug $
150− proc "nix-prefetch-git" $ filter (/="")
151− [ "--url", show uri
186+ withExitFailMessage ("nix-prefetch-git: Failed to determine sha256 hash of Git repo " <> gitUriToText uri <> " at " <> rev) $ do
187+ out <- readProcessAndLogStderr Debug $
188+ proc nixPrefetchGitPath $ filter (/="")
189+ [ "--url", T.unpack $ gitUriToText uri
152190 , "--rev", T.unpack rev
153191 , if fetchSubmodules then "--fetch-submodules" else ""
154192 , "--quiet"
@@ -158,145 +196,119 @@ nixPrefetchGit uri rev fetchSubmodules =
158196 Nothing -> failWith $ "nix-prefetch-git: unrecognized output " <> out
159197 Just x -> pure x
160198
161−getLatestGitRev :: MonadObelisk m => GitSource -> m ThunkRev
162−getLatestGitRev s = withSystemTempDirectory "git-clone" $ \tmpDir -> do
163− withExitFailMessage ("Unable to determine latest git revision for branch " <> branch) $ do
164− let git = readProcessAndLogStderr Debug . gitProc tmpDir
165− out <- liftA2 (<>)
166− (git ["clone", "--no-checkout", show $ _gitSource_url s]) -- Might be able to use --bare here instead to go faster.
167− (git ["log", T.unpack branch, "--max-count=1", "--format=%H"])
168−
169− case T.strip <$> safeLast (T.lines out) of
170− Nothing -> failWith $ "Unable to parse git log: " <> out
171− Just rev -> do
172− putLog Debug $ "Latest commit in " <> branch <> " is " <> rev
173− sha <- nixPrefetchGit (_gitSource_url s) rev (_gitSource_fetchSubmodules s)
174− putLog Debug $ "Nix sha256 is " <> sha
175− pure $ ThunkRev
176− { _thunkRev_commit = Ref.fromHexString $ T.unpack rev
177− , _thunkRev_nixSha256 = sha
178− }
179− where
180− remote :: Text = "origin"
181− branch :: Text = remote <> "/" <> untagName (_gitSource_branch s)
182−
183− safeLast [] = Nothing
184− safeLast xs = Just $ last xs
185−
186−-- | Get the latest revision available from the given source
187−getLatestRev :: MonadObelisk m => ThunkSource -> m ThunkRev
188−getLatestRev = \case
189− ThunkSource_GitHub s -> do
190− auth <- liftIO $ getHubAuth "github.com"
191− commitsResult <- liftIO $ executeRequestMaybe auth $ commitsWithOptionsForR
192− (_gitHubSource_owner s)
193− (_gitHubSource_repo s)
194− (FetchAtLeast 1)
195− $ case _gitHubSource_branch s of
196− Nothing -> []
197− Just b -> [CommitQuerySha $ untagName b]
198− commitInfos <- either (liftIO . throwIO) return commitsResult
199− commitInfo : _ <- return $ toList commitInfos
200− let commit = commitSha commitInfo
201− putLog Debug $ "Latest commit is " <> untagName commit
202− Right archiveUri <- liftIO $ executeRequestMaybe auth $ archiveForR (_gitHubSource_owner s) (_gitHubSource_repo s) ArchiveFormatTarball $ Just $ untagName commit
203− nixSha256 <- getNixSha256ForUriUnpacked archiveUri
204− putLog Debug $ "Nix sha256 is " <> nixSha256
205− return $ ThunkRev
206− { _thunkRev_commit = commitNameToRef commit
207− , _thunkRev_nixSha256 = nixSha256
208− }
209− ThunkSource_Git s -> getLatestGitRev s
210−
211199--TODO: Pretty print these
212200data ReadThunkError
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
238− }
239−
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
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)
248228 }
249229
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
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}|]
285307
286308-- | Read a thunk and validate that it is exactly a packed thunk.
287309-- If additional data is present, fail.
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
310+readThunk :: (MonadObelisk m) => FilePath -> m (Either ReadThunkError ThunkData)
311+readThunk = readThunkWith thunkSpecTypes
300312
301313parseThunkPtr :: (Aeson.Object -> Aeson.Parser ThunkSource) -> Aeson.Object -> Aeson.Parser ThunkPtr
302314parseThunkPtr parseSrc v = do
@@ -316,38 +328,42 @@ parseGitHubSource v = do
316328 owner <- v Aeson..: "owner"
317329 repo <- v Aeson..: "repo"
318330 branch <- v Aeson..:! "branch"
319− mPrivate <- v Aeson..:! "private"
331+ private <- v Aeson..:? "private"
320332 pure $ GitHubSource
321333 { _gitHubSource_owner = owner
322334 , _gitHubSource_repo = repo
323335 , _gitHubSource_branch = branch
324− , _gitHubSource_private = fromMaybe False mPrivate
336+ , _gitHubSource_private = fromMaybe False private
325337 }
326338
327339parseGitSource :: Aeson.Object -> Aeson.Parser GitSource
328340parseGitSource v = do
329341 Just url <- parseGitUri <$> v Aeson..: "url"
330− branch <- v Aeson..: "branch"
342+ branch <- v Aeson..:! "branch"
331343 fetchSubmodules <- v Aeson..:! "fetchSubmodules"
344+ private <- v Aeson..:? "private"
332345 pure $ GitSource
333346 { _gitSource_url = url
334347 , _gitSource_branch = branch
335348 , _gitSource_fetchSubmodules = fromMaybe False fetchSubmodules
349+ , _gitSource_private = fromMaybe False private
336350 }
337351
338352overwriteThunk :: MonadObelisk m => FilePath -> ThunkPtr -> m ()
339353overwriteThunk target thunk = do
340354 -- Ensure that this directory is a valid thunk (i.e. so we aren't losing any data)
341− Right _ <- readThunk target
355+ readThunk target >>= \case
356+ Left e -> failWith [i|Invalid thunk at ${target}: ${e}|]
357+ Right _ -> pure ()
342358
343359 --TODO: Is there a safer way to do this overwriting?
344− liftIO $ removeDirectoryRecursive target
345− liftIO $ createThunk target thunk
360+ liftIO $ removePathForcibly target
361+ createThunk target $ Right thunk
346362
347−thunkPtrLoader :: ThunkPtr -> Text
348−thunkPtrLoader thunk = case _thunkPtr_source thunk of
349− ThunkSource_GitHub _ -> NonEmpty.head gitHubStandaloneLoaders
350− 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
351367
352368-- It's important that formatting be very consistent here, because
353369-- otherwise when people update thunks, their patches will be messy
@@ -356,22 +372,18 @@ encodeThunkPtrData (ThunkPtr rev src) = case src of
356372 ThunkSource_GitHub s -> encodePretty' githubCfg $ Aeson.object $ catMaybes
357373 [ Just $ "owner" .= _gitHubSource_owner s
358374 , Just $ "repo" .= _gitHubSource_repo s
359− , case _gitHubSource_branch s of
360− Just b -> Just $ "branch" .= b
361− Nothing -> Nothing
362− , if _gitHubSource_private s
363− then Just $ "private" .= True
364− else Nothing
375+ , ("branch" .=) <$> _gitHubSource_branch s
365376 , Just $ "rev" .= Ref.toHexString (_thunkRev_commit rev)
366377 , Just $ "sha256" .= _thunkRev_nixSha256 rev
378+ , Just $ "private" .= _gitHubSource_private s
367379 ]
368380 ThunkSource_Git s -> encodePretty' plainGitCfg $ Aeson.object $ catMaybes
369− --TODO: Is this safe? read/show is jank for `URI`
370− [ Just $ "url" .= show (_gitSource_url s)
381+ [ Just $ "url" .= gitUriToText (_gitSource_url s)
371382 , Just $ "rev" .= Ref.toHexString (_thunkRev_commit rev)
372− , Just $ "branch" .= _gitSource_branch s
383+ , ("branch" .=) <$> _gitSource_branch s
373384 , Just $ "sha256" .= _thunkRev_nixSha256 rev
374385 , Just $ "fetchSubmodules" .= _gitSource_fetchSubmodules s
386+ , Just $ "private" .= _gitSource_private s
375387 ]
376388 where
377389 githubCfg = defConfig
@@ -392,59 +404,84 @@ encodeThunkPtrData (ThunkPtr rev src) = case src of
392404 [ "url"
393405 , "rev"
394406 , "sha256"
407+ , "private"
395408 , "fetchSubmodules"
396409 ] <> compare
397410 , confTrailingNewline = True
398411 }
399412
400−createThunk :: MonadIO m => FilePath -> ThunkPtr -> m ()
401−createThunk target thunk = liftIO $ do
402− createDirectoryIfMissing True (target </> ".attr-cache")
403− T.writeFile (target </> "default.nix") (thunkPtrLoader thunk)
404− let
405− jsonFileName = case _thunkPtr_source thunk of
406− ThunkSource_GitHub _ -> "github"
407− ThunkSource_Git _ -> "git"
408− 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
409428
410429createThunkWithLatest :: MonadObelisk m => FilePath -> ThunkSource -> m ()
411430createThunkWithLatest target s = do
412431 rev <- getLatestRev s
413− createThunk target $ ThunkPtr
432+ createThunk target $ Right $ ThunkPtr
414433 { _thunkPtr_source = s
415434 , _thunkPtr_rev = rev
416435 }
417436
418−updateThunkToLatest :: MonadObelisk m => FilePath -> m ()
419−updateThunkToLatest target = withSpinner' ("Updating thunk " <> T.pack target <> " to latest") (pure $ const $ "Thunk " <> T.pack target <> " updated to latest") $ do
420− (overwrite, ptr) <- readThunk target >>= \case
421− Left err -> failWith $ T.pack $ "thunk update: " <> show err
422− Right c -> case c of
423− ThunkData_Packed t -> return (target, t)
424− ThunkData_Checkout _ -> failWith "cannot update an unpacked thunk"
425− let src = _thunkPtr_source ptr
426− rev <- getLatestRev src
427− overwriteThunk overwrite $ ThunkPtr
428− { _thunkPtr_source = src
429− , _thunkPtr_rev = rev
430− }
437+updateThunkToLatest :: MonadObelisk m => ThunkUpdateConfig -> FilePath -> m ()
438+updateThunkToLatest (ThunkUpdateConfig mBranch thunkConfig) target = spinner $ do
439+ checkThunkDirectory target
440+ -- check to see if thunk should be updated to a specific branch or just update it's current branch
441+ case mBranch of
442+ Nothing -> do
443+ (overwrite, ptr) <- readThunk target >>= \case
444+ Left err -> failWith [i|Thunk update: ${err}|]
445+ Right c -> case c of
446+ ThunkData_Packed _ t -> return (target, t)
447+ ThunkData_Checkout -> failWith "cannot update an unpacked thunk"
448+ let src = _thunkPtr_source ptr
449+ rev <- getLatestRev src
450+ overwriteThunk overwrite $ modifyThunkPtrByConfig thunkConfig $ ThunkPtr
451+ { _thunkPtr_source = src
452+ , _thunkPtr_rev = rev
453+ }
454+ Just branch -> readThunk target >>= \case
455+ Left err -> failWith [i|Thunk update: ${err}|]
456+ 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")
461+
462+setThunk :: MonadObelisk m => ThunkConfig -> FilePath -> GitSource -> String -> m ()
463+setThunk thunkConfig target gs branch = do
464+ newThunkPtr <- uriThunkPtr (_gitSource_url gs) (_thunkConfig_private thunkConfig) (Just $ T.pack branch) Nothing
465+ overwriteThunk target newThunkPtr
466+ updateThunkToLatest (ThunkUpdateConfig Nothing thunkConfig) target
431467
432468-- | All recognized github standalone loaders, ordered from newest to oldest.
433469-- This tool will only ever produce the newest one when it writes a thunk.
434−gitHubStandaloneLoaders :: NonEmpty Text
435−gitHubStandaloneLoaders =
436− gitHubStandaloneLoaderV2 :|
437− [ gitHubStandaloneLoaderV3
438− , gitHubStandaloneLoaderV1
470+gitHubThunkSpecs :: NonEmpty ThunkSpec
471+gitHubThunkSpecs =
472+ gitHubThunkSpecV5 :|
473+ [ gitHubThunkSpecV4
474+ , gitHubThunkSpecV3
475+ , gitHubThunkSpecV2
476+ , gitHubThunkSpecV1
439477 ]
440478
441−gitHubStandaloneLoaderV1 :: Text
442−gitHubStandaloneLoaderV1 = T.unlines
443− [ "import ((import <nixpkgs> {}).fetchFromGitHub (builtins.fromJSON (builtins.readFile ./github.json)))"
444− ]
479+gitHubThunkSpecV1 :: ThunkSpec
480+gitHubThunkSpecV1 = legacyGitHubThunkSpec "github-v1"
481+ "import ((import <nixpkgs> {}).fetchFromGitHub (builtins.fromJSON (builtins.readFile ./github.json)))"
445482
446−gitHubStandaloneLoaderV2 :: Text
447−gitHubStandaloneLoaderV2 = T.unlines
483+gitHubThunkSpecV2 :: ThunkSpec
484+gitHubThunkSpecV2 = legacyGitHubThunkSpec "github-v2" $ T.unlines
448485 [ "# DO NOT HAND-EDIT THIS FILE" --TODO: Add something about how to get more info on Obelisk, etc.
449486 , "import ((import <nixpkgs> {}).fetchFromGitHub ("
450487 , " let json = builtins.fromJSON (builtins.readFile ./github.json);"
@@ -454,8 +491,8 @@ gitHubStandaloneLoaderV2 = T.unlines
454491 , "))"
455492 ]
456493
457−gitHubStandaloneLoaderV3 :: Text
458−gitHubStandaloneLoaderV3 = T.unlines
494+gitHubThunkSpecV3 :: ThunkSpec
495+gitHubThunkSpecV3 = legacyGitHubThunkSpec "github-v3" $ T.unlines
459496 [ "# DO NOT HAND-EDIT THIS FILE"
460497 , "let"
461498 , " fetch = { private ? false, ... }@args: if private && builtins.hasAttr \"fetchGit\" builtins"
@@ -474,22 +511,62 @@ gitHubStandaloneLoaderV3 = T.unlines
474511 , "in import (fetch (builtins.fromJSON (builtins.readFile ./github.json)))"
475512 ]
476513
477−plainGitStandaloneLoaders :: NonEmpty Text
478−plainGitStandaloneLoaders =
479− plainGitStandaloneLoaderV1 :|
480− [ plainGitStandaloneLoaderV2
514+gitHubThunkSpecV4 :: ThunkSpec
515+gitHubThunkSpecV4 = legacyGitHubThunkSpec "github-v4" $ T.unlines
516+ [ "# DO NOT HAND-EDIT THIS FILE"
517+ , "let fetch = { private ? false, fetchSubmodules ? false, owner, repo, rev, sha256, ... }:"
518+ , " if !fetchSubmodules && !private then builtins.fetchTarball {"
519+ , " url = \"https://github.com/${owner}/${repo}/archive/${rev}.tar.gz\"; inherit sha256;"
520+ , " } else (import <nixpkgs> {}).fetchFromGitHub {"
521+ , " inherit owner repo rev sha256 fetchSubmodules private;"
522+ , " };"
523+ , "in import (fetch (builtins.fromJSON (builtins.readFile ./github.json)))"
524+ ]
525+
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
481558 ]
482559
483−plainGitStandaloneLoaderV1 :: Text
484−plainGitStandaloneLoaderV1 = T.unlines
560+gitThunkSpecV1 :: ThunkSpec
561+gitThunkSpecV1 = legacyGitThunkSpec "git-v1" $ T.unlines
485562 [ "# DO NOT HAND-EDIT THIS FILE"
486563 , "let fetchGit = {url, rev, ref ? null, branch ? null, sha256 ? null, fetchSubmodules ? null}:"
487564 , " assert !fetchSubmodules; (import <nixpkgs> {}).fetchgit { inherit url rev sha256; };"
488565 , "in import (fetchGit (builtins.fromJSON (builtins.readFile ./git.json)))"
489566 ]
490567
491−plainGitStandaloneLoaderV2 :: Text
492−plainGitStandaloneLoaderV2 = T.unlines
568+gitThunkSpecV2 :: ThunkSpec
569+gitThunkSpecV2 = legacyGitThunkSpec "git-v2" $ T.unlines
493570 [ "# DO NOT HAND-EDIT THIS FILE"
494571 , "let fetchGit = {url, rev, ref ? null, branch ? null, sha256 ? null, fetchSubmodules ? null}:"
495572 , " if builtins.hasAttr \"fetchGit\" builtins"
@@ -498,24 +575,87 @@ plainGitStandaloneLoaderV2 = T.unlines
498575 , "in import (fetchGit (builtins.fromJSON (builtins.readFile ./git.json)))"
499576 ]
500577
501−thunkFileNames :: [FilePath]
502−thunkFileNames = ["default.nix", "github.json", "git.json"]
503−
504−-- | Look for authentication info from the 'hub' command
505−getHubAuth
506− :: Text -- ^ Domain name
507− -> IO (Maybe Auth)
508−getHubAuth domain = do
509− hubConfig <- getXdgDirectory XdgConfig "hub"
510− Yaml.decodeFileEither hubConfig >>= \case
511− Left _ -> return Nothing
512− Right v -> return $ flip parseMaybe v $ \v' -> do
513− Yaml.Array domainConfigs <- v' .: domain --TODO: Determine what multiple domainConfigs means
514− [Yaml.Object domainConfig] <- return $ toList domainConfigs
515− token <- domainConfig .: "oauth_token"
516− return $ OAuth $ encodeUtf8 token
517−
518−--TODO: when checking something out, make a shallow clone
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
582+ [ "# DO NOT HAND-EDIT THIS FILE"
583+ , "let fetch = {url, rev, ref ? null, sha256 ? null, fetchSubmodules ? false, private ? false, ...}:"
584+ , " let realUrl = let firstChar = builtins.substring 0 1 url; in"
585+ , " if firstChar == \"/\" then /. + url"
586+ , " else if firstChar == \".\" then ./. + url"
587+ , " else url;"
588+ , " in if !fetchSubmodules && private then builtins.fetchGit {"
589+ , " url = realUrl; inherit rev;"
590+ , " } else (import <nixpkgs> {}).fetchgit {"
591+ , " url = realUrl; inherit rev sha256;"
592+ , " };"
593+ , "in import (fetch (builtins.fromJSON (builtins.readFile ./git.json)))"
594+ ]
595+
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+
656+
657+parseJsonObject :: (Aeson.Object -> Aeson.Parser a) -> LBS.ByteString -> Either String a
658+parseJsonObject p bytes = Aeson.parseEither p =<< Aeson.eitherDecode bytes
519659
520660-- | Checks a cache directory to see if there is a fresh symlink
521661-- to the result of building an attribute of a thunk.
@@ -523,44 +663,49 @@ getHubAuth domain = do
523663-- and the result is symlinked into the cache.
524664nixBuildThunkAttrWithCache
525665 :: MonadObelisk m
526− => FilePath
666+ => ThunkSpec
667+ -> FilePath
527668 -- ^ Path to directory containing Thunk
528669 -> String
529670 -- ^ Attribute to build
530− -> m FilePath
671+ -> m (Maybe FilePath)
531672 -- ^ Symlink to cached or built nix output
532673-- WARNING: If the thunk uses an impure reference such as '<nixpkgs>'
533674-- the caching mechanism will fail as it merely measures the modification
534675-- time of the cache link and the expression to build.
535−nixBuildThunkAttrWithCache thunkDir attr = do
536− --NB: Expects thunkDir to be normalised with no trailing path separator.
537− --This should be guaranteed by the command argument parser.
538− let cacheErrHandler e
539− | isDoesNotExistError e = return Nothing -- expected from a cache miss
540− | otherwise = putLog Error (T.pack $ displayException e) >> return Nothing
541− cacheDir = thunkDir </> ".attr-cache"
542− cachePath = cacheDir </> attr <.> "out"
676+nixBuildThunkAttrWithCache thunkSpec thunkDir attr = do
543677 latestChange <- liftIO $ do
544− createDirectoryIfMissing False cacheDir
545− let getModificationTimeMaybe = fmap rightToMaybe . try @IOError . getModificationTime
546− maximum . catMaybes <$> mapM (getModificationTimeMaybe . (thunkDir </>)) thunkFileNames
547− cacheHit <- handle cacheErrHandler $ do
548− cacheTime <- liftIO $ posixSecondsToUTCTime . realToFrac . modificationTime <$> getSymbolicLinkStatus cachePath
549− return $ if latestChange <= cacheTime
550− then Just cachePath
551− else Nothing
552− case cacheHit of
553− Just c -> return c
554− Nothing -> do
555− putLog Warning $ T.pack $ mconcat [thunkDir, ": ", attr, " not cached, building ..."]
556− _ <- nixBuild $ def
557− { _nixBuildConfig_target = Target
558− { _target_path = thunkDir
559− , _target_attr = Just attr
560− }
561− , _nixBuildConfig_outLink = OutLink_IndirectRoot cachePath
562− }
563− 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+ }
564709
565710-- | Build a nix attribute, and cache the result if possible
566711nixBuildAttrWithCache
@@ -571,17 +716,19 @@ nixBuildAttrWithCache
571716 -- ^ Attribute to build
572717 -> m FilePath
573718 -- ^ Symlink to cached or built nix output
574−nixBuildAttrWithCache exprPath attr = do
575− readThunk exprPath >>= \case
576− -- Only packed thunks are cached. in particular, checkouts are not
577− Right (ThunkData_Packed _) -> nixBuildThunkAttrWithCache exprPath attr
578− _ -> nixBuild $ def
579− { _nixBuildConfig_target = Target
580− { _target_path = exprPath
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
728+ { _target_path = Just exprPath
581729 , _target_attr = Just attr
730+ , _target_expr = Nothing
582731 }
583− , _nixBuildConfig_outLink = OutLink_None
584− }
585732
586733-- | Safely update thunk using a custom action
587734--
@@ -593,243 +740,442 @@ updateThunk p f = withSystemTempDirectory "obelisk-thunkptr-" $ \tmpDir -> do
593740 p' <- copyThunkToTmp tmpDir p
594741 unpackThunk' True p'
595742 result <- f p'
596− updateThunkFromTmp p' "origin" -- TODO: stop hardcoding remote
743+ updateThunkFromTmp p'
597744 return result
598745 where
599746 copyThunkToTmp tmpDir thunkDir = readThunk thunkDir >>= \case
600747 Left err -> failWith $ "withThunkUnpacked: " <> T.pack (show err)
601− Right (ThunkData_Packed _) -> do
748+ Right ThunkData_Packed{} -> do
602749 let tmpThunk = tmpDir </> "thunk"
603750 callProcessAndLogOutput (Notice, Error) $
604− proc "cp" ["-r", "-T", thunkDir, tmpThunk]
751+ proc cp ["-r", "-T", thunkDir, tmpThunk]
605752 return tmpThunk
606− Right _ -> failWith $ "Thunk is not packed"
607− updateThunkFromTmp p' remote = do
608− packThunk' True p' remote
753+ Right _ -> failWith "Thunk is not packed"
754+ updateThunkFromTmp p' = do
755+ _ <- packThunk' True (ThunkPackConfig False (ThunkConfig Nothing)) p'
609756 callProcessAndLogOutput (Notice, Error) $
610− proc "cp" ["-r", "-T", p', p]
757+ proc cp ["-r", "-T", p', p]
611758
612759finalMsg :: Bool -> (a -> Text) -> Maybe (a -> Text)
613760finalMsg noTrail s = if noTrail then Nothing else Just s
614761
762+-- | Check that we are not somewhere inside the thunk directory
763+checkThunkDirectory :: MonadObelisk m => FilePath -> m ()
764+checkThunkDirectory thunkDir = do
765+ currentDir <- liftIO getCurrentDirectory
766+ 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+
615776unpackThunk :: MonadObelisk m => FilePath -> m ()
616777unpackThunk = unpackThunk' False
617778
618779unpackThunk' :: MonadObelisk m => Bool -> FilePath -> m ()
619−unpackThunk' noTrail thunkDir = readThunk thunkDir >>= \case
620− 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}|]
621782 --TODO: Overwrite option that rechecks out thunk; force option to do so even if working directory is dirty
622− Right (ThunkData_Checkout _) -> failWith "thunk unpack: thunk is already unpacked"
623− Right (ThunkData_Packed tptr) -> do
783+ Right ThunkData_Checkout -> failWith [i|Thunk at ${thunkDir} is already unpacked|]
784+ Right (ThunkData_Packed _ tptr) -> do
624785 let (thunkParent, thunkName) = splitFileName thunkDir
625− withTempDirectory thunkParent thunkName $ \tmpRepo -> do
626− let obGitDir = tmpRepo </> ".git" </> "obelisk"
627− case _thunkPtr_source tptr of
628− ThunkSource_GitHub s -> do
629− mauth <- liftIO $ getHubAuth "github.com"
630− repoResult <- liftIO $ executeRequestMaybe mauth $ repositoryR (_gitHubSource_owner s) (_gitHubSource_repo s)
631− githubURI <- either (liftIO . throwIO) (return . repoSshUrl) repoResult >>= \case
632− Nothing -> failWith "Cannot determine clone URI for thunk source"
633− Just c -> return $ T.unpack $ getUrl c
634−
635− withSpinner' ("Fetching thunk " <> T.pack thunkDir)
636− ( finalMsg noTrail $ const $ "Fetched thunk " <> T.pack thunkDir) $ do
637− callProcessAndLogOutput (Debug, Debug) $
638− proc "hub" ["clone", "-n", githubURI, tmpRepo]
639− --If this directory already exists then something is weird and we should fail
640− liftIO $ createDirectory obGitDir
641− callProcessAndLogOutput (Debug, Error) $
642− proc "cp" ["-r", "-T", thunkDir </> ".", obGitDir </> "orig-thunk"]
643−
644− -- Checkout
645− putLog Debug $ "Checking out " <> T.pack (show $ maybe "" untagName $ _gitHubSource_branch s)
646− callProcessAndLogOutput (Debug, Debug) $
647− proc "hub" $ concat
648− [ ["-C", tmpRepo]
649− , pure "checkout"
650− , maybe [] (\n -> ["-B", T.unpack (untagName n)]) (_gitHubSource_branch s)
651− , pure $ Ref.toHexString $ _thunkRev_commit $ _thunkPtr_rev tptr
652− ]
653− -- Set upstream branch
654− forM_ (_gitHubSource_branch s) $ \branch ->
655− callProcessAndLogOutput (Debug, Error) $
656− proc "hub" ["-C", tmpRepo, "branch", "-u", "origin/" <> T.unpack (untagName branch)]
657− callProcessAndLogOutput (Notice, Error) $ proc "rm" ["-r", thunkDir]
658− callProcessAndLogOutput (Notice, Error) $ proc "mv" ["-T", tmpRepo, thunkDir]
659−
660− ThunkSource_Git s -> do
661− withSpinner' ("Fetching thunk " <> T.pack thunkName)
662− (finalMsg noTrail $ const $ "Fetched thunk " <> T.pack thunkName) $ do
663− let git = callProcessAndLogOutput (Notice, Notice) . gitProc tmpRepo
664− git ["clone", if _gitSource_fetchSubmodules s then "--recursive" else "", show (_gitSource_url s)]
665− git ["reset", "--hard", Ref.toHexString $ _thunkRev_commit $ _thunkPtr_rev tptr]
666− when (_gitSource_fetchSubmodules s) $
667− git ["submodule", "update", "--recursive", "--init"]
668− git ["branch", "-u", "origin/" <> T.unpack (untagName $ _gitSource_branch s)]
669−
670− liftIO $ createDirectory obGitDir
671− callProcessAndLogOutput (Notice, Error) $
672− proc "cp" ["-r", "-T", thunkDir </> ".", obGitDir </> "orig-thunk"]
673− callProcessAndLogOutput (Notice, Error) $
674− proc "rm" ["-r", thunkDir]
675− callProcessAndLogOutput (Notice, Error) $
676− proc "mv" ["-T", tmpRepo, thunkDir]
677−
678−--TODO: add force mode to pack even if changes are present
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
792+ withSpinner' ("Fetching thunk " <> T.pack thunkName)
793+ (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"]
821+
679822--TODO: add a rollback mode to pack to the original thunk
680−packThunk :: MonadObelisk m => FilePath -> Text -> m ()
823+packThunk :: MonadObelisk m => ThunkPackConfig -> FilePath -> m ThunkPtr
681824packThunk = packThunk' False
682825
683−packThunk' :: MonadObelisk m => Bool -> FilePath -> Text -> m ()
684−packThunk' noTrail thunkDir upstream = readThunk thunkDir >>= \case
685− Left err -> failWith $ T.pack $ "thunk pack: " <> show err
686− Right (ThunkData_Packed _) -> failWith "pack: thunk is already packed"
687− Right (ThunkData_Checkout _) -> do
688− withSpinner' ("Packing thunk " <> T.pack thunkDir)
689− (finalMsg noTrail $ const $ "Packed thunk " <> T.pack thunkDir) $ do
690− thunkPtr <- getThunkPtr thunkDir upstream
691− callProcessAndLogOutput (Debug, Error) $ proc "rm" ["-rf", thunkDir]
692− liftIO $ createThunk thunkDir thunkPtr
693−
694−getThunkPtr :: MonadObelisk m => FilePath -> Text -> m ThunkPtr
695−getThunkPtr = getThunkPtr' True
696−
697−getThunkPtr' :: MonadObelisk m => Bool -> FilePath -> Text -> m ThunkPtr
698−getThunkPtr' checkClean thunkDir upstream = do
699− when checkClean $ ensureCleanGitRepo thunkDir True $
700− "thunk pack: thunk checkout contains unsaved modifications"
701−
702− -- Check whether there are any stashes
703− stashOutput <- readGitProcess thunkDir ["stash", "list"]
704− when checkClean $ case T.null stashOutput of
705− False -> do
706− failWith $ T.unlines $
707− [ "thunk pack: thunk checkout has stashes"
708− , "git stash list:"
709− ] ++ T.lines stashOutput
710− True -> return ()
711−
712− --Check whether all local heads are pushed
713− repoHeads <- T.lines <$> readGitProcess thunkDir ["for-each-ref", "--format=%(refname:short)", "refs/heads/"]
714− remotes <- T.lines <$> readGitProcess thunkDir ["remote"]
715− --Check that the upstream specified actually exists
716− case L.find (== upstream) remotes of
717− Nothing -> failWith $ "thunk pack: upstream " <> upstream <> " does not exist. Available upstreams are " <> T.intercalate ", " remotes
718− Just _ -> return ()
719− -- iterate over cartesian product
720− when checkClean $ forM_ repoHeads $ \hd -> do
721− [localRev] <- T.lines <$> readGitProcess thunkDir ["rev-parse", T.unpack hd]
722− forM_ remotes $ \rm -> do
723− --TODO: The error you get if a branch isn't pushed anywhere could be made more user friendly
724− [remoteMergeRev] <- fmap T.lines $ readGitProcess thunkDir
725− ["merge-base", T.unpack localRev, "remotes/" <> T.unpack rm <> "/" <> T.unpack hd]
726− case remoteMergeRev == localRev of
727− False -> failWith $ mconcat [ "thunk unpack: branch ", hd, " has not been pushed to ", rm ]
728− True -> return ()
729−
730− --We assume it's safe to pack the thunk at this point
731− [remoteUri'] <- fmap T.lines $ readGitProcess thunkDir ["config", "--get", "remote." <> T.unpack upstream <> ".url"]
732−
733− let uriParseFailure = "Could not identify git remote: " <> remoteUri'
734− mRemoteUri = parseGitUri remoteUri'
735− case mRemoteUri of
736− Nothing -> failWith uriParseFailure
737− Just remoteUri -> do
738− refs <- fmap (map (refsToTuples . T.words) . T.lines) $ readGitProcess thunkDir ["show-ref", "--head"]
739− -- safe because exactly one hash is associated with HEAD
740− let Just currentHead = fst <$> L.find ((== "HEAD") . snd) refs
741− remoteHeads = Map.fromList $ catMaybes $ fmap
742− (\(x,y) -> (,) x <$> T.stripPrefix ("refs/remotes/" <> upstream <> "/") y)
743− refs
744− localHeads = Map.fromList $ catMaybes $ fmap
745− (\(x,y) -> (,) x <$> T.stripPrefix "refs/heads/" y)
746− refs
747− mCurrentUpstreamBranch = Map.lookup currentHead remoteHeads
748− <|> Map.lookup currentHead localHeads
749− if isGithubThunk remoteUri
750− then githubThunkPtr remoteUri currentHead mCurrentUpstreamBranch
751− else do
752− currentUpstreamBranch <- case mCurrentUpstreamBranch of
753− Just b -> pure b
754− Nothing -> failWith "Need explicit branch for git remote"
755− gitThunkPtr remoteUri currentHead currentUpstreamBranch
756− where
757− refsToTuples [x, y] = (x, y)
758− refsToTuples x = error $ "thunk pack: cannot parse ref " <> show x
759−
760−isGithubThunk :: URI -> Bool
761−isGithubThunk u
762− | Just uriAuth <- uriAuthority u
763− = case uriScheme u of
764− "ssh:" -> uriAuth == URIAuth "git@" "github.com" ""
765− s -> s `L.elem` [ "git:", "https:", "http:" ] -- "http:" just redirects to "https:"
766− && uriRegName uriAuth == "github.com"
767− | otherwise = False
768−
769−githubThunkPtr :: MonadObelisk m => URI -> Text -> Maybe Text -> m ThunkPtr
770−githubThunkPtr u commit' branch' = do
771− ["/", owner', repo'] <- return $ splitDirectories (uriPath u)
772− let owner = N (T.pack owner')
773− repo = N (T.pack (dropExtension repo'))
774− commit = N commit'
775− branch = N <$> branch'
776− mauth <- liftIO $ getHubAuth "github.com"
777− repoResult <- liftIO $ executeRequestMaybe mauth $ repositoryR owner repo
778− repoIsPrivate <- either (liftIO . throwIO) (return . repoPrivate) repoResult
779− archiveResult <- liftIO $ executeRequestMaybe mauth $
780− archiveForR owner repo ArchiveFormatTarball (Just (untagName commit))
781− archiveUri <- either (liftIO . throwIO) return archiveResult
782− hash <- getNixSha256ForUriUnpacked archiveUri
783− return $ ThunkPtr
784− { _thunkPtr_rev = ThunkRev
785− { _thunkRev_commit = commitNameToRef commit
786− , _thunkRev_nixSha256 = hash
787− }
788− , _thunkPtr_source = ThunkSource_GitHub $ GitHubSource
789− { _gitHubSource_owner = owner
790− , _gitHubSource_repo = repo
791− , _gitHubSource_branch = branch
792− , _gitHubSource_private = repoIsPrivate
793− }
826+packThunk' :: 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
837+ pure thunkPtr
838+
839+modifyThunkPtrByConfig :: ThunkConfig -> ThunkPtr -> ThunkPtr
840+modifyThunkPtrByConfig (ThunkConfig markPrivate') ptr = case markPrivate' of
841+ Nothing -> ptr
842+ Just markPrivate -> ptr { _thunkPtr_source = case _thunkPtr_source ptr of
843+ ThunkSource_Git s -> ThunkSource_Git $ s { _gitSource_private = markPrivate }
844+ ThunkSource_GitHub s -> ThunkSource_GitHub $ s { _gitHubSource_private = markPrivate }
794845 }
795846
796−gitThunkPtr :: MonadObelisk m => URI -> Text -> Text -> m ThunkPtr
797−gitThunkPtr u commit branch = do
798− let protocols = ["https:", "ssh:", "git:"]
799− unless (T.toLower (T.pack $ uriScheme u) `elem` protocols) $
800− failWith $ "thunk pack: obelisk currently only supports "
801− <> T.intercalate ", " protocols <> " protocols for non-GitHub remotes"
802− hash <- nixPrefetchGit u commit False
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
869+ "thunk pack: thunk checkout contains unsaved modifications"
870+
871+ -- Check whether there are any stashes
872+ when checkClean $ do
873+ stashOutput <- readGitProcess thunkDir ["stash", "list"]
874+ unless (T.null stashOutput) $
875+ failWith $ T.unlines $
876+ [ "thunk pack: thunk checkout has stashes"
877+ , "git stash list:"
878+ ] ++ T.lines stashOutput
879+
880+ -- Get current branch
881+ (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"]
884+ case b of
885+ (Just "HEAD") -> failWith $ T.unlines
886+ [ "thunk pack: You are in 'detached HEAD' state."
887+ , "If you want to pack at the current ref \
888+ \then please create a new branch with 'git checkout -b <new-branch-name>' and push this upstream."
889+ ]
890+ _ -> return (b, c)
891+
892+ -- Get information on all branches and their (optional) designated upstream
893+ -- correspondents
894+ headDump :: [Text] <- T.lines <$> readGitProcess thunkDir
895+ [ "for-each-ref"
896+ , "--format=%(refname:short) %(upstream:short) %(upstream:remotename)"
897+ , "refs/heads/"
898+ ]
899+
900+ (headInfo :: Map Text (Maybe (Text, Text)))
901+ <- fmap Map.fromList $ forM headDump $ \line -> do
902+ (branch : restOfLine) <- pure $ T.words line
903+ mUpstream <- case restOfLine of
904+ [] -> pure Nothing
905+ [u, r] -> pure $ Just (u, r)
906+ (_:_) -> failWith "git for-each-ref invalid output"
907+ pure (branch, mUpstream)
908+
909+ putLog Debug $ "branches: " <> T.pack (show headInfo)
910+
911+ let errorMap :: Map Text ()
912+ headUpstream :: Map Text (Text, Text)
913+ (errorMap, headUpstream) = flip Map.mapEither headInfo $ \case
914+ Nothing -> Left ()
915+ Just b -> Right b
916+
917+ putLog Debug $ "branches with upstream branch set: " <> T.pack (show headUpstream)
918+
919+ -- Check that every branch has a remote equivalent
920+ when checkClean $ do
921+ let untrackedBranches = Map.keys errorMap
922+ when (not $ L.null untrackedBranches) $ failWith $ T.unlines $
923+ [ "thunk pack: Certain branches in the thunk have no upstream branch \
924+ \set. This means we don't know to check whether all your work is \
925+ \saved. The offending branches are:"
926+ , ""
927+ , T.unwords untrackedBranches
928+ , ""
929+ , "To fix this, you probably want to do:"
930+ , ""
931+ ] ++
932+ ((\branch -> "git push -u origin " <> branch) <$> untrackedBranches) ++
933+ [ ""
934+ , "These will push the branches to the default remote under the same \
935+ \name, and (thanks to the `-u`) remember that choice so you don't \
936+ \get this error again."
937+ ]
938+
939+ -- 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
941+ (stat :: [Text]) <- T.lines <$> readGitProcess thunkDir
942+ [ "rev-list", "--left-right"
943+ , T.unpack branch <> "..." <> T.unpack upstream
944+ ]
945+ let ahead = length $ [ () | Just ('<', _) <- T.uncons <$> stat ]
946+ behind = length $ [ () | Just ('>', _) <- T.uncons <$> stat ]
947+ pure (upstream, (ahead, behind))
948+
949+ -- Those branches which have commits ahead of, i.e. not on, the upstream
950+ -- branch. Purely being behind is fine.
951+ let nonGood = Map.filter ((/= 0) . fst . snd) stats
952+
953+ when (not $ Map.null nonGood) $ failWith $ T.unlines $
954+ [ "thunk pack: Certain branches in the thunk have commits not yet pushed upstream:"
955+ , ""
956+ ] ++
957+ flip map (Map.toList nonGood) (\(branch, (upstream, (ahead, behind))) -> mconcat
958+ [" ", branch, " ahead: ", T.pack (show ahead), " behind: ", T.pack (show behind), " remote branch ", upstream]) ++
959+ [ ""
960+ , "Please push these upstream and try again. (Or just fetch, if they are somehow \
961+ \pushed but this repo's remote tracking branches don't know it.)"
962+ ]
963+
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."
967+
968+ let remote = maybe "origin" snd $ flip Map.lookup headUpstream =<< mCurrentBranch
969+
970+ [remoteUri'] <- fmap T.lines $ readGitProcess thunkDir
971+ [ "config"
972+ , "--get"
973+ , "remote." <> T.unpack remote <> ".url"
974+ ]
975+
976+ remoteUri <- case parseGitUri remoteUri' of
977+ Nothing -> failWith $ "Could not identify git remote: " <> remoteUri'
978+ Just uri -> pure uri
979+ uriThunkPtr remoteUri mPrivate mCurrentBranch mCurrentCommit
980+
981+-- | Get the latest revision available from the given source
982+getLatestRev :: MonadObelisk m => ThunkSource -> m ThunkRev
983+getLatestRev os = do
984+ let gitS = thunkSourceToGitSource os
985+ (_, commit) <- gitGetCommitBranch (_gitSource_url gitS) (untagName <$> _gitSource_branch gitS)
986+ case os of
987+ ThunkSource_GitHub s -> githubThunkRev s commit
988+ ThunkSource_Git s -> gitThunkRev s commit
989+
990+-- | Convert a URI to a thunk
991+--
992+-- If the URL is a github URL, we try to just download an archive for
993+-- performance. If that doesn't work (e.g. authentication issue), we fall back
994+-- on just doing things the normal way for git repos in general, and save it as
995+-- a regular git thunk.
996+uriThunkPtr :: MonadObelisk m => GitUri -> Maybe Bool -> Maybe Text -> Maybe Text -> m ThunkPtr
997+uriThunkPtr uri mPrivate mbranch mcommit = do
998+ commit <- case mcommit of
999+ Nothing -> gitGetCommitBranch uri mbranch >>= return . snd
1000+ (Just c) -> return c
1001+ (src, rev) <- uriToThunkSource uri mPrivate mbranch >>= \case
1002+ ThunkSource_GitHub s -> do
1003+ rev <- runExceptT $ githubThunkRev s commit
1004+ case rev of
1005+ Right r -> pure (ThunkSource_GitHub s, r)
1006+ Left e -> do
1007+ putLog Warning "\
1008+\Failed to fetch archive from GitHub. This is probably a private repo. \
1009+\Falling back on normal fetchgit. Original failure:"
1010+ errorToWarning e
1011+ let s' = forgetGithub True s
1012+ (,) (ThunkSource_Git s') <$> gitThunkRev s' commit
1013+ ThunkSource_Git s -> (,) (ThunkSource_Git s) <$> gitThunkRev s commit
8031014 pure $ ThunkPtr
804− { _thunkPtr_rev = ThunkRev
805− { _thunkRev_commit = commitNameToRef (N commit)
806− , _thunkRev_nixSha256 = hash
807− }
808− , _thunkPtr_source = ThunkSource_Git $ GitSource
809− { _gitSource_url = u
810− , _gitSource_branch = N branch
811− , _gitSource_fetchSubmodules = False -- TODO: How do we determine if this should be true?
1015+ { _thunkPtr_rev = rev
1016+ , _thunkPtr_source = src
1017+ }
1018+
1019+-- | N.B. Cannot infer all fields.
1020+--
1021+-- If the thunk is a GitHub thunk and fails, we do *not* fall back like with
1022+-- `uriThunkPtr`. Unlike a plain URL, a thunk src explicitly states which method
1023+-- should be employed, and so we respect that.
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
1028+ , case scheme of
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
1033+ }
1034+ s -> s `L.elem` [ "git", "https", "http" ] -- "http:" just redirects to "https:"
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+ }
1047+
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
8121083 }
1084+
1085+-- Funny signature indicates no effects depend on the optional branch name.
1086+githubThunkRev
1087+ :: forall m
1088+ . MonadObelisk m
1089+ => GitHubSource
1090+ -> Text
1091+ -> m ThunkRev
1092+githubThunkRev s commit = do
1093+ owner <- forcePP $ _gitHubSource_owner s
1094+ repo <- forcePP $ _gitHubSource_repo s
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
1102+ }
1103+ , URI.uriPath = Just ( False
1104+ , owner :| [ repo, fromRight' $ URI.mkPathPiece "archive", revTarball ]
1105+ )
1106+ , URI.uriQuery = []
1107+ , URI.uriFragment = Nothing
8131108 }
1109+ hash <- getNixSha256ForUriUnpacked archiveUri
1110+ putLog Debug $ "Nix sha256 is " <> hash
1111+ return $ ThunkRev
1112+ { _thunkRev_commit = commitNameToRef $ N commit
1113+ , _thunkRev_nixSha256 = hash
1114+ }
1115+ where
1116+ forcePP :: Name entity -> m (URI.RText 'URI.PathPiece)
1117+ forcePP = URI.mkPathPiece . untagName
8141118
815−uriThunkPtr :: MonadObelisk m => URI -> Maybe Text -> m ThunkPtr
816−uriThunkPtr uri mbranch = do
817− bothMaps <- rethrowE =<< liftIO (gitLsRemote (show uri) (GitRef_Branch <$> mbranch))
818− branch <- rethrowE $ first (("In repo from " <> T.pack (show uri) <> ": ") <>) $
819− case mbranch of
820− Nothing -> gitLookupDefaultBranch bothMaps
821− Just b -> pure b
1119+gitThunkRev
1120+ :: MonadObelisk m
1121+ => GitSource
1122+ -> Text
1123+ -> m ThunkRev
1124+gitThunkRev s commit = do
1125+ let u = _gitSource_url s
1126+ protocols = ["file", "https", "ssh", "git"]
1127+ scheme = maybe "file" URI.unRText $ URI.uriScheme $ (\(GitUri x) -> x) u
1128+ unless (T.toLower scheme `elem` protocols) $
1129+ failWith $ "obelisk currently only supports "
1130+ <> T.intercalate ", " protocols <> " protocols for plain Git remotes"
1131+ hash <- nixPrefetchGit u commit $ _gitSource_fetchSubmodules s
1132+ putLog Informational $ "Nix sha256 is " <> hash
1133+ pure $ ThunkRev
1134+ { _thunkRev_commit = commitNameToRef (N commit)
1135+ , _thunkRev_nixSha256 = hash
1136+ }
1137+
1138+-- | Given the URI to a git remote, and an optional branch name, return the name
1139+-- of the branch along with the hash of the commit at tip of that branch.
1140+--
1141+-- If the branch name is passed in, it is returned exactly as-is. If it is not
1142+-- passed it, the default branch of the repo is used instead.
1143+
1144+gitGetCommitBranch
1145+ :: MonadObelisk m => GitUri -> Maybe Text -> m (Text, CommitId)
1146+gitGetCommitBranch uri mbranch = withExitFailMessage ("Failure for git remote " <> uriMsg) $ do
1147+ (_, bothMaps) <- gitLsRemote
1148+ (T.unpack $ gitUriToText uri)
1149+ (GitRef_Branch <$> mbranch)
1150+ Nothing
1151+ branch <- case mbranch of
1152+ Nothing -> withExitFailMessage "Failed to find default branch" $ do
1153+ b <- rethrowE $ gitLookupDefaultBranch bothMaps
1154+ putLog Debug $ "Default branch for remote repo " <> uriMsg <> " is " <> b
1155+ pure b
1156+ Just b -> pure b
8221157 commit <- rethrowE $ gitLookupCommitForRef bothMaps (GitRef_Branch branch)
823− if isGithubThunk uri
824− then githubThunkPtr uri commit mbranch
825− else gitThunkPtr uri commit branch
1158+ putLog Informational $ "Latest commit in branch " <> branch
1159+ <> " from remote repo " <> uriMsg
1160+ <> " is " <> commit
1161+ pure (branch, commit)
8261162 where
8271163 rethrowE = either failWith pure
1164+ uriMsg = gitUriToText uri
1165+
1166+parseGitUri :: Text -> Maybe GitUri
1167+parseGitUri x = GitUri <$> (parseFileURI x <|> parseAbsoluteURI x <|> parseSshShorthand x)
1168+
1169+parseFileURI :: Text -> Maybe URI.URI
1170+parseFileURI uri = if "/" `T.isPrefixOf` uri then parseAbsoluteURI ("file://" <> uri) else Nothing
8281171
829−parseGitUri :: Text -> Maybe URI
830−parseGitUri x = parseURIReference (T.unpack x) <|> parseSshShorthand x
1172+parseAbsoluteURI :: Text -> Maybe URI.URI
1173+parseAbsoluteURI uri = do
1174+ parsedUri <- URI.mkURI uri
1175+ guard $ URI.isPathAbsolute parsedUri
1176+ pure parsedUri
8311177
832−parseSshShorthand :: Text -> Maybe URI
1178+parseSshShorthand :: Text -> Maybe URI.URI
8331179parseSshShorthand uri = do
8341180 -- This is what git does to check that the remote
8351181 -- is not a local file path when parsing shorthand.
@@ -842,4 +1188,4 @@ parseSshShorthand uri = do
8421188 -- This check is used to disambiguate a filepath containing a colon from shorthand
8431189 guard $ isNothing (T.findIndex (=='/') authAndHostname)
8441190 && not (T.null colonAndPath)
845− parseURI $ T.unpack properUri
1191+ URI.mkURI properUri