@@ -1,81 +1,74 @@
1{-# LANGUAGE DataKinds #-}
1{-# LANGUAGE DataKinds #-}
2+{-# LANGUAGE FlexibleContexts #-}
2{-# LANGUAGE LambdaCase #-}
3{-# LANGUAGE LambdaCase #-}
4+{-# LANGUAGE MultiParamTypeClasses #-}
3{-# LANGUAGE MultiWayIf #-}
5{-# LANGUAGE MultiWayIf #-}
4{-# LANGUAGE OverloadedStrings #-}
6{-# LANGUAGE OverloadedStrings #-}
5{-# LANGUAGE PatternGuards #-}
7{-# LANGUAGE PatternGuards #-}
6−{-# LANGUAGE TemplateHaskell #-}
8+{-# LANGUAGE QuasiQuotes #-}
7−
9+{-# LANGUAGE ScopedTypeVariables #-}
10+{-# LANGUAGE TypeApplications #-}
8−module Obelisk.Command.Thunk
11+module Obelisk.Command.Thunk where
15− , updateThunkToLatest
17− , createThunkWithLatest
18− , nixBuildAttrWithCache
19− , nixBuildThunkAttrWithCache
26import Control.Applicative
13import Control.Applicative
27−import Control.Exception
14+import Control.Exception (displayException, try)
15+import Control.Lens (ifor, ifor_, (.~))
28import Control.Monad
16import Control.Monad
17+import Control.Monad.Extra (findM)
18+import Control.Monad.Catch (MonadCatch, handle)
29import Control.Monad.Except
19import Control.Monad.Except
30−import Data.Aeson as Aeson
20+import Data.Aeson ((.=))
21+import qualified Data.Aeson as Aeson
31import Data.Aeson.Encode.Pretty
22import Data.Aeson.Encode.Pretty
23+import qualified Data.Aeson.Types as Aeson
24+import Data.Bifunctor (first)
32import qualified Data.ByteString.Lazy as LBS
25import qualified Data.ByteString.Lazy as LBS
26+import Data.Containers.ListUtils (nubOrd)
33import Data.Default
27import Data.Default
34−import Data.Foldable
28+import Data.Either.Combinators (fromRight', rightToMaybe)
29+import Data.Foldable (toList)
30+import Data.Function ((&))
31+import Data.Functor ((<&>))
35import Data.Git.Ref (Ref)
32import Data.Git.Ref (Ref)
36import qualified Data.Git.Ref as Ref
33import qualified Data.Git.Ref as Ref
37import qualified Data.List as L
34import qualified Data.List as L
38−import Data.List.NonEmpty (NonEmpty (..))
35+import Data.List.NonEmpty (NonEmpty (..), nonEmpty)
39import qualified Data.List.NonEmpty as NonEmpty
36import qualified Data.List.NonEmpty as NonEmpty
40import qualified Data.Map as Map
38import qualified Data.Map as Map
41import Data.Maybe
39import Data.Maybe
43import Data.Set (Set)
40import Data.Set (Set)
44import qualified Data.Set as Set
41import qualified Data.Set as Set
42+import Data.String.Here.Interpolated (i)
43+import Data.String.Here.Uninterpolated (here)
45import Data.Text (Text)
44import Data.Text (Text)
46import qualified Data.Text as T
45import qualified Data.Text as T
47import Data.Text.Encoding
46import Data.Text.Encoding
48import qualified Data.Text.IO as T
47import qualified Data.Text.IO as T
49import Data.Time.Clock.POSIX (posixSecondsToUTCTime)
48import Data.Time.Clock.POSIX (posixSecondsToUTCTime)
50−import Data.Yaml (parseMaybe, (.:))
49+import Data.Traversable (for)
51−import qualified Data.Yaml as Yaml
50+import Data.Yaml (parseMaybe)
52import GitHub
51import GitHub
53import GitHub.Data.Name
52import GitHub.Data.Name
54−import GitHub.Endpoints.Repos.Contents (archiveForR)
56import Obelisk.Command.Nix
53import Obelisk.Command.Nix
57import System.Directory
54import System.Directory
58import System.Exit
55import System.Exit
59import System.FilePath
56import System.FilePath
61import System.IO.Error
57import System.IO.Error
62import System.IO.Temp
58import System.IO.Temp
63−import System.Posix (getSymbolicLinkStatus, modificationTime)
59+import System.PosixCompat.Files (getSymbolicLinkStatus, modificationTime)
64−import System.Process (StdStream (CreatePipe), callProcess, createProcess, proc, readProcess, std_err,
60+import qualified Text.URI as URI
65− std_out, waitForProcess)
67−import Development.Placeholders
62+import Obelisk.App (MonadObelisk)
68import Obelisk.Command.Utils
64import Obelisk.Command.Utils
70−import Obelisk.Command.CLI (failWith, putError, putWarning, withSpinner)
72--TODO: Support symlinked thunk data
66--TODO: Support symlinked thunk data
73data ThunkData
67data ThunkData
74− = ThunkData_Packed ThunkPtr
68+ = ThunkData_Packed ThunkSpec ThunkPtr
75 -- ^ Packed thunk
69 -- ^ Packed thunk
76− | ThunkData_Checkout (Maybe ThunkPtr)
70+ | ThunkData_Checkout
77 -- ^ Checked out thunk that was unpacked from this pointer
71 -- ^ Checked out thunk that was unpacked from this pointer
78− deriving (Show, Eq, Ord)
80-- | A reference to the exact data that a thunk should translate into
73-- | A reference to the exact data that a thunk should translate into
81data ThunkPtr = ThunkPtr
74data ThunkPtr = ThunkPtr
@@ -88,7 +81,7 @@ type NixSha256 = Text --TODO: Use a smart constructor and make this actually ver
89-- | A specific revision of data; it may be available from multiple sources
82-- | A specific revision of data; it may be available from multiple sources
90data ThunkRev = ThunkRev
83data ThunkRev = ThunkRev
91− { _thunkRev_commit :: Ref
84+ { _thunkRev_commit :: Ref Ref.SHA1
92 , _thunkRev_nixSha256 :: NixSha256
85 , _thunkRev_nixSha256 :: NixSha256
94 deriving (Show, Eq, Ord)
87 deriving (Show, Eq, Ord)
@@ -101,6 +94,11 @@ data ThunkSource
101 | ThunkSource_Git GitSource
94 | ThunkSource_Git GitSource
102 deriving (Show, Eq, Ord)
95 deriving (Show, Eq, Ord)
97+thunkSourceToGitSource :: ThunkSource -> GitSource
98+thunkSourceToGitSource = \case
99+ ThunkSource_GitHub s -> forgetGithub False s
100+ ThunkSource_Git s -> s
104data GitHubSource = GitHubSource
102data GitHubSource = GitHubSource
105 { _gitHubSource_owner :: Name Owner
103 { _gitHubSource_owner :: Name Owner
106 , _gitHubSource_repo :: Name Repo
104 , _gitHubSource_repo :: Name Repo
@@ -109,157 +107,263 @@ data GitHubSource = GitHubSource
110 deriving (Show, Eq, Ord)
108 deriving (Show, Eq, Ord)
110+newtype GitUri = GitUri { unGitUri :: URI.URI } deriving (Eq, Ord, Show)
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
112data GitSource = GitSource
119data GitSource = GitSource
113− { _gitSource_url :: URI
120+ { _gitSource_url :: GitUri
114− --TODO: Is it ok to use the types from the GitHub api bindings?
115 , _gitSource_branch :: Maybe (Name Branch)
121 , _gitSource_branch :: Maybe (Name Branch)
116 , _gitSource_fetchSubmodules :: Bool
122 , _gitSource_fetchSubmodules :: Bool
123+ , _gitSource_private :: Bool
118 deriving (Show, Eq, Ord)
125 deriving (Show, Eq, Ord)
120−commitNameToRef :: Name Commit -> Ref
127+newtype ThunkConfig = ThunkConfig
121−commitNameToRef (N c) = Ref.fromHex $ encodeUtf8 c
128+ { _thunkConfig_private :: Maybe Bool
131+data ThunkUpdateConfig = ThunkUpdateConfig
132+ { _thunkUpdateConfig_branch :: Maybe String
133+ , _thunkUpdateConfig_config :: ThunkConfig
123−getNixSha256ForUriUnpacked :: URI -> IO NixSha256
136+data ThunkPackConfig = ThunkPackConfig
124−getNixSha256ForUriUnpacked uri = do
137+ { _thunkPackConfig_force :: Bool
125− --TODO: Make this package depend on nix-prefetch-url properly
138+ , _thunkPackConfig_config :: ThunkConfig
126− let cmd = proc "nix-prefetch-url" ["--unpack" , "--type" , "sha256" , show uri]
139+ } deriving Show
127− (_, Just out, Just err, p) <- createProcess cmd
140+
128− { std_out = CreatePipe
141+-- | Convert a GitHub source to a regular Git source. Assumes no submodules.
129− , std_err = CreatePipe
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
149+ , URI.authHost = fromRight' $ URI.mkHost "github.com"
150+ , URI.authPort = Nothing
152+ , URI.uriPath = Just ( False
153+ , fromRight' . URI.mkPathPiece <$>
154+ untagName (_gitHubSource_owner s)
155+ :| [ untagName (_gitHubSource_repo s) <> ".git" ]
158+ , URI.uriFragment = Nothing
131− --TODO: Deal with errors here; usually they're HTTP errors
160+ , _gitSource_branch = _gitHubSource_branch s
132− waitForProcess p >>= \case
161+ , _gitSource_fetchSubmodules = False
133− ExitSuccess -> return ()
162+ , _gitSource_private = _gitHubSource_private s
135− hPutStrLn stdout =<< hGetContents out
136− hPutStrLn stderr =<< hGetContents err
137− --TODO: actual error
138− failWith $ "nix-prefetch-url"
139− T.strip <$> T.hGetContents out
141−-- | Get the latest revision available from the given source
165+getThunkGitBranch :: ThunkPtr -> Maybe Text
142−getLatestRev :: ThunkSource -> IO ThunkRev
166+getThunkGitBranch (ThunkPtr _ src) = fmap untagName $ case src of
144− ThunkSource_GitHub s -> do
167+ ThunkSource_GitHub s -> _gitHubSource_branch s
145− auth <- getHubAuth "github.com"
168+ ThunkSource_Git s -> _gitSource_branch s
146− commitsResult <- executeRequestMaybe auth $ commitsWithOptionsForR
169+
147− (_gitHubSource_owner s)
170+commitNameToRef :: Name Commit -> Ref Ref.SHA1
148− (_gitHubSource_repo s)
171+commitNameToRef (N c) = Ref.fromHex $ encodeUtf8 c
149− (FetchAtLeast 1)
172+
150− $ case _gitHubSource_branch s of
173+-- TODO: Use spinner here.
151− Nothing -> []
174+getNixSha256ForUriUnpacked
152− Just b -> [CommitQuerySha $ untagName b]
175+ :: MonadObelisk m
153− commitInfos <- either throwIO return commitsResult
176+ => GitUri
154− commitInfo : _ <- return $ toList commitInfos
177+ -> m NixSha256
155− let commit = commitSha commitInfo
178+getNixSha256ForUriUnpacked uri =
156− Right archiveUri <- executeRequestMaybe auth $ archiveForR (_gitHubSource_owner s) (_gitHubSource_repo s) ArchiveFormatTarball $ Just $ untagName commit
179+ withExitFailMessage ("nix-prefetch-url: Failed to determine sha256 hash of URL " <> gitUriToText uri) $ do
157− nixSha256 <- getNixSha256ForUriUnpacked archiveUri
180+ [hash] <- fmap T.lines $ readProcessAndLogOutput (Debug, Debug) $
158− return $ ThunkRev
181+ proc nixPrefetchUrlPath ["--unpack", "--type", "sha256", T.unpack $ gitUriToText uri]
159− { _thunkRev_commit = commitNameToRef commit
182+ pure hash
160− , _thunkRev_nixSha256 = nixSha256
183+
161− }
184+nixPrefetchGit :: MonadObelisk m => GitUri -> Text -> Bool -> m NixSha256
162− ThunkSource_Git _s -> do
185+nixPrefetchGit uri rev fetchSubmodules =
163− $notImplemented
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
190+ , "--rev", T.unpack rev
191+ , if fetchSubmodules then "--fetch-submodules" else ""
195+ case parseMaybe (Aeson..: "sha256") =<< Aeson.decodeStrict (encodeUtf8 out) of
196+ Nothing -> failWith $ "nix-prefetch-git: unrecognized output " <> out
165--TODO: Pretty print these
199--TODO: Pretty print these
166data ReadThunkError
200data ReadThunkError
167− = ReadThunkError_WrongContents (Set String) (Set String)
201+ = ReadThunkError_UnrecognizedThunk
168− | ReadThunkError_UnrecognizedLoader Text
202+ | ReadThunkError_UnrecognizedPaths (NonEmpty FilePath)
169− | ReadThunkError_UnparseablePtr LBS.ByteString
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
170− deriving (Show)
209+ deriving (Show)
172−-- | Read a thunk and validate that it is only a thunk, either packed or unpacked.
211+unpackedDirName :: FilePath
173−-- If the thunk is packed and additional data is present, fail.
212+unpackedDirName = "."
214+attrCacheFileName :: FilePath
215+attrCacheFileName = ".attr-cache"
217+-- | Specification for how a file in a thunk version works.
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
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)
230+thunkSpecTypes :: NonEmpty (NonEmpty ThunkSpec)
231+thunkSpecTypes = gitThunkSpecs :| [gitHubThunkSpecs]
233+-- | Attempts to match a 'ThunkSpec' to a given directory.
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
240+matchThunkSpecToDir thunkSpec dir dirFiles = do
241+ case nonEmpty (toList $ dirFiles `Set.difference` expectedPaths) of
242+ Just fs -> throwError $ ReadThunkError_UnrecognizedPaths $ (dir </>) <$> fs
244+ case nonEmpty (toList $ requiredPaths `Set.difference` dirFiles) of
245+ Just fs -> throwError $ ReadThunkError_MissingPaths $ (dir </>) <$> fs
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
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
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
267+ case nonEmpty datas of
268+ Nothing -> throwError ReadThunkError_UnrecognizedThunk
269+ Just xs -> fold1WithM xs $ \a b -> either throwError pure (mergeThunkData a b)
271+ rootPathsOnly = Set.fromList . mapMaybe takeRootDir . Map.keys
272+ takeRootDir = fmap NonEmpty.head . nonEmpty . splitPath
274+ expectedPaths = rootPathsOnly $ _thunkSpec_files thunkSpec
276+ requiredPaths = rootPathsOnly $ Map.filter isRequiredFileSpec $ _thunkSpec_files thunkSpec
277+ isRequiredFileSpec = \case
278+ ThunkFileSpec_FileMatches _ -> True
281+ dirMayExist expectedPath = liftIO (doesFileExist (dir </> expectedPath)) >>= \case
282+ True -> throwError $ ReadThunkError_UnrecognizedPaths $ expectedPath :| []
285+ -- Combine 'ThunkData' from different files, preferring "Checkout" over "Packed"
286+ mergeThunkData ThunkData_Checkout ThunkData_Checkout = Right ThunkData_Checkout
287+ mergeThunkData ThunkData_Checkout ThunkData_Packed{} = Left bothPackedAndUnpacked
288+ mergeThunkData ThunkData_Packed{} ThunkData_Checkout = Left bothPackedAndUnpacked
289+ mergeThunkData a@(ThunkData_Packed _ ptrA) (ThunkData_Packed _ ptrB) =
290+ if ptrA == ptrB then Right a else Left $ ReadThunkError_AmbiguousPackedState ptrA ptrB
292+ bothPackedAndUnpacked = ReadThunkError_UnrecognizedState "Both packed data and checkout present"
294+ fold1WithM (x :| xs) f = foldM f x xs
174−readThunk :: FilePath -> IO (Either ReadThunkError ThunkData)
298+ => NonEmpty (NonEmpty ThunkSpec) -> FilePath -> m (Either ReadThunkError ThunkData)
175−readThunk thunkDir = do
299+readThunkWith specTypes dir = do
176− files <- listDirectory thunkDir
300+ dirFiles <- Set.fromList <$> liftIO (listDirectory dir)
177− case ".git" `elem` files of
301+ let specs = concatMap toList $ toList $ NonEmpty.transpose specTypes -- Interleave spec types so we try each one in a "fair" ordering
178− True -> fmap ThunkData_Checkout <$> do
302+ flip fix specs $ \loop -> \case
179− let origThunkPath = thunkDir </> ".git" </> "obelisk" </> "orig-thunk"
303+ [] -> pure $ Left ReadThunkError_UnrecognizedThunk
180− doesDirectoryExist origThunkPath >>= \case
304+ spec:rest -> runExceptT (matchThunkSpecToDir spec dir dirFiles) >>= \case
181− True -> fmap Just <$> readPackedThunk origThunkPath
305+ Left e -> putLog Debug [i|Thunk specification ${_thunkSpec_name spec} did not match ${dir}: ${e}|] *> loop rest
182− False -> return $ return Nothing
306+ x@(Right _) -> x <$ putLog Debug [i|Thunk specification ${_thunkSpec_name spec} matched ${dir}|]
183− False -> fmap ThunkData_Packed <$> readPackedThunk thunkDir
185-- | Read a thunk and validate that it is exactly a packed thunk.
308-- | Read a thunk and validate that it is exactly a packed thunk.
186-- If additional data is present, fail.
309-- If additional data is present, fail.
187−readPackedThunk :: FilePath -> IO (Either ReadThunkError ThunkPtr)
310+readThunk :: (MonadObelisk m) => FilePath -> m (Either ReadThunkError ThunkData)
188−readPackedThunk thunkDir = runExceptT $ do
311+readThunk = readThunkWith thunkSpecTypes
189− let thunkLoader = thunkDir </> "default.nix"
190− githubJson = thunkDir </> "github.json"
191− attrCache = thunkDir </> ".attr-cache"
192− expectedContents = Set.fromList $
196− optionalContents = Set.fromList $
200− -- Ensure that there aren't any other files in the thunk
313+parseThunkPtr :: (Aeson.Object -> Aeson.Parser ThunkSource) -> Aeson.Object -> Aeson.Parser ThunkPtr
201− -- NB: System.Directory.listDirectory returns the contents without the directory path
314+parseThunkPtr parseSrc v = do
202− files <- liftIO $ Set.fromList . fmap (thunkDir </>) <$> listDirectory thunkDir
203− let unexpectedContents = files `Set.difference` (expectedContents `Set.union` optionalContents)
204− missingContents = expectedContents `Set.difference` files
205− unless (Set.null unexpectedContents && Set.null missingContents) $ do
206− throwError $ ReadThunkError_WrongContents unexpectedContents missingContents
208− -- Ensure that we recognize the thunk loader
209− loader <- liftIO $ T.readFile thunkLoader
210− unless (loader `elem` gitHubStandaloneLoaders) $ do
211− throwError $ ReadThunkError_UnrecognizedLoader loader
213− txt <- liftIO $ LBS.readFile githubJson
214− let parseThunk v = do
215− rev <- v Aeson..: "rev"
315+ rev <- v Aeson..: "rev"
216− sha256 <- v Aeson..: "sha256"
316+ sha256 <- v Aeson..: "sha256"
217− src <- parseGitHubSource v
317+ src <- parseSrc v
218− <|> parseGitSource v
219− return $ ThunkPtr
318+ pure $ ThunkPtr
220− { _thunkPtr_rev = ThunkRev
319+ { _thunkPtr_rev = ThunkRev
221− { _thunkRev_commit = Ref.fromHexString rev
320+ { _thunkRev_commit = Ref.fromHexString rev
222− , _thunkRev_nixSha256 = sha256
321+ , _thunkRev_nixSha256 = sha256
224− , _thunkPtr_source = src
323+ , _thunkPtr_source = src
226− parseGitHubSource v = do
326+parseGitHubSource :: Aeson.Object -> Aeson.Parser GitHubSource
327+parseGitHubSource v = do
227− owner <- v Aeson..: "owner"
328+ owner <- v Aeson..: "owner"
228− repo <- v Aeson..: "repo"
329+ repo <- v Aeson..: "repo"
229− branch <- v Aeson..:! "branch"
330+ branch <- v Aeson..:! "branch"
230− mPrivate <- v Aeson..:! "private"
331+ private <- v Aeson..:? "private"
231− return $ ThunkSource_GitHub $ GitHubSource
332+ pure $ GitHubSource
232− { _gitHubSource_owner = owner
333+ { _gitHubSource_owner = owner
233− , _gitHubSource_repo = repo
334+ , _gitHubSource_repo = repo
234− , _gitHubSource_branch = branch
335+ , _gitHubSource_branch = branch
235− , _gitHubSource_private = fromMaybe False mPrivate
336+ , _gitHubSource_private = fromMaybe False private
237− parseGitSource v = do
238− Just url <- parseURI <$> v Aeson..: "url"
239− branch <- v Aeson..:! "branch"
240− fetchSubmodules <- v Aeson..: "fetchSubmodules"
241− return $ ThunkSource_Git $ GitSource
242− { _gitSource_url = url
243− , _gitSource_branch = branch
244− , _gitSource_fetchSubmodules = fetchSubmodules
246− case parseMaybe parseThunk =<< decode txt of
247− Nothing -> throwError $ ReadThunkError_UnparseablePtr txt
248− Just ptr -> return ptr
339+parseGitSource :: Aeson.Object -> Aeson.Parser GitSource
340+parseGitSource v = do
341+ Just url <- parseGitUri <$> v Aeson..: "url"
342+ branch <- v Aeson..:! "branch"
343+ fetchSubmodules <- v Aeson..:! "fetchSubmodules"
344+ private <- v Aeson..:? "private"
346+ { _gitSource_url = url
347+ , _gitSource_branch = branch
348+ , _gitSource_fetchSubmodules = fromMaybe False fetchSubmodules
349+ , _gitSource_private = fromMaybe False private
250−overwriteThunk :: FilePath -> ThunkPtr -> IO ()
352+overwriteThunk :: MonadObelisk m => FilePath -> ThunkPtr -> m ()
251overwriteThunk target thunk = do
353overwriteThunk target thunk = do
252 -- Ensure that this directory is a valid thunk (i.e. so we aren't losing any data)
354 -- Ensure that this directory is a valid thunk (i.e. so we aren't losing any data)
253− Right _ <- readThunk target
355+ readThunk target >>= \case
356+ Left e -> failWith [i|Invalid thunk at ${target}: ${e}|]
255 --TODO: Is there a safer way to do this overwriting?
359 --TODO: Is there a safer way to do this overwriting?
256− removeDirectoryRecursive target
360+ liftIO $ removePathForcibly target
257− createThunk target thunk
361+ createThunk target $ Right thunk
259−thunkPtrLoader :: ThunkPtr -> Text
363+thunkPtrToSpec :: ThunkPtr -> ThunkSpec
260−thunkPtrLoader thunk = case _thunkPtr_source thunk of
364+thunkPtrToSpec thunk = case _thunkPtr_source thunk of
261− ThunkSource_GitHub _ -> NonEmpty.head gitHubStandaloneLoaders
365+ ThunkSource_GitHub _ -> NonEmpty.head gitHubThunkSpecs
262− ThunkSource_Git _ -> NonEmpty.head plainGitStandaloneLoaders
366+ ThunkSource_Git _ -> NonEmpty.head gitThunkSpecs
264-- It's important that formatting be very consistent here, because
368-- It's important that formatting be very consistent here, because
265-- otherwise when people update thunks, their patches will be messy
369-- otherwise when people update thunks, their patches will be messy
@@ -268,21 +372,18 @@ encodeThunkPtrData (ThunkPtr rev src) = case src of
268 ThunkSource_GitHub s -> encodePretty' githubCfg $ Aeson.object $ catMaybes
372 ThunkSource_GitHub s -> encodePretty' githubCfg $ Aeson.object $ catMaybes
269 [ Just $ "owner" .= _gitHubSource_owner s
373 [ Just $ "owner" .= _gitHubSource_owner s
270 , Just $ "repo" .= _gitHubSource_repo s
374 , Just $ "repo" .= _gitHubSource_repo s
271− , case _gitHubSource_branch s of
375+ , ("branch" .=) <$> _gitHubSource_branch s
272− Just b -> Just $ "branch" .= b
274− , if _gitHubSource_private s
275− then Just $ "private" .= True
277 , Just $ "rev" .= Ref.toHexString (_thunkRev_commit rev)
376 , Just $ "rev" .= Ref.toHexString (_thunkRev_commit rev)
278 , Just $ "sha256" .= _thunkRev_nixSha256 rev
377 , Just $ "sha256" .= _thunkRev_nixSha256 rev
378+ , Just $ "private" .= _gitHubSource_private s
280 ThunkSource_Git s -> encodePretty' plainGitCfg $ Aeson.object $ catMaybes
380 ThunkSource_Git s -> encodePretty' plainGitCfg $ Aeson.object $ catMaybes
281− --TODO: Is this safe? read/show is jank for `URI`
282− [ Just $ "url" .= show (_gitSource_url s)
381+ [ Just $ "url" .= gitUriToText (_gitSource_url s)
283 , Just $ "rev" .= Ref.toHexString (_thunkRev_commit rev)
382 , Just $ "rev" .= Ref.toHexString (_thunkRev_commit rev)
383+ , ("branch" .=) <$> _gitSource_branch s
284 , Just $ "sha256" .= _thunkRev_nixSha256 rev
384 , Just $ "sha256" .= _thunkRev_nixSha256 rev
285 , Just $ "fetchSubmodules" .= _gitSource_fetchSubmodules s
385 , Just $ "fetchSubmodules" .= _gitSource_fetchSubmodules s
386+ , Just $ "private" .= _gitSource_private s
288 githubCfg = defConfig
389 githubCfg = defConfig
@@ -303,54 +404,84 @@ encodeThunkPtrData (ThunkPtr rev src) = case src of
305 , "sha256"
406 , "sha256"
306 , "fetchSubmodules"
408 , "fetchSubmodules"
307 ] <> compare
409 ] <> compare
308 , confTrailingNewline = True
410 , confTrailingNewline = True
311−createThunk :: FilePath -> ThunkPtr -> IO ()
413+createThunk :: MonadObelisk m => FilePath -> Either ThunkSpec ThunkPtr -> m ()
312−createThunk target thunk = do
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)
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
313− createDirectoryIfMissing True (target </> ".attr-cache")
426+ liftIO $ createDirectoryIfMissing True $ takeDirectory fullPath
314− T.writeFile (target </> "default.nix") (thunkPtrLoader thunk)
427+ f fullPath
315− LBS.writeFile (target </> "github.json") (encodeThunkPtrData thunk)
317−createThunkWithLatest :: FilePath -> ThunkSource -> IO ()
429+createThunkWithLatest :: MonadObelisk m => FilePath -> ThunkSource -> m ()
318createThunkWithLatest target s = do
430createThunkWithLatest target s = do
319 rev <- getLatestRev s
431 rev <- getLatestRev s
320− createThunk target $ ThunkPtr
432+ createThunk target $ Right $ ThunkPtr
321 { _thunkPtr_source = s
433 { _thunkPtr_source = s
322 , _thunkPtr_rev = rev
434 , _thunkPtr_rev = rev
325−updateThunkToLatest :: FilePath -> IO ()
437+updateThunkToLatest :: MonadObelisk m => ThunkUpdateConfig -> FilePath -> m ()
326−updateThunkToLatest target = do
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
327− (overwrite, ptr) <- readThunk target >>= \case
443+ (overwrite, ptr) <- readThunk target >>= \case
328− Left err -> failWith $ T.pack $ "thunk update: " <> show err
444+ Left err -> failWith [i|Thunk update: ${err}|]
329− Right c -> case c of
445+ Right c -> case c of
330− ThunkData_Packed t -> return (target, t)
446+ ThunkData_Packed _ t -> return (target, t)
331− ThunkData_Checkout _ -> failWith "cannot update an unpacked thunk"
447+ ThunkData_Checkout -> failWith "cannot update an unpacked thunk"
332− let src = _thunkPtr_source ptr
448+ let src = _thunkPtr_source ptr
333− rev <- getLatestRev src
449+ rev <- getLatestRev src
334− overwriteThunk overwrite $ ThunkPtr
450+ overwriteThunk overwrite $ modifyThunkPtrByConfig thunkConfig $ ThunkPtr
335− { _thunkPtr_source = src
451+ { _thunkPtr_source = src
336− , _thunkPtr_rev = rev
452+ , _thunkPtr_rev = rev
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.|]
460+ spinner = withSpinner' ("Updating thunk " <> T.pack target <> " to latest") (pure $ const $ "Thunk " <> T.pack target <> " updated to latest")
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
339-- | All recognized github standalone loaders, ordered from newest to oldest.
468-- | All recognized github standalone loaders, ordered from newest to oldest.
340-- This tool will only ever produce the newest one when it writes a thunk.
469-- This tool will only ever produce the newest one when it writes a thunk.
341−gitHubStandaloneLoaders :: NonEmpty Text
470+gitHubThunkSpecs :: NonEmpty ThunkSpec
342−gitHubStandaloneLoaders =
471+gitHubThunkSpecs =
343− gitHubStandaloneLoaderV2 :|
472+ gitHubThunkSpecV5 :|
344− [ gitHubStandaloneLoaderV1
473+ [ gitHubThunkSpecV4
347−gitHubStandaloneLoaderV1 :: Text
479+gitHubThunkSpecV1 :: ThunkSpec
348−gitHubStandaloneLoaderV1 = T.unlines
480+gitHubThunkSpecV1 = legacyGitHubThunkSpec "github-v1"
349− [ "import ((import <nixpkgs> {}).fetchFromGitHub (builtins.fromJSON (builtins.readFile ./github.json)))"
481+ "import ((import <nixpkgs> {}).fetchFromGitHub (builtins.fromJSON (builtins.readFile ./github.json)))"
352−gitHubStandaloneLoaderV2 :: Text
483+gitHubThunkSpecV2 :: ThunkSpec
353−gitHubStandaloneLoaderV2 = T.unlines
484+gitHubThunkSpecV2 = legacyGitHubThunkSpec "github-v2" $ T.unlines
354 [ "# DO NOT HAND-EDIT THIS FILE" --TODO: Add something about how to get more info on Obelisk, etc.
485 [ "# DO NOT HAND-EDIT THIS FILE" --TODO: Add something about how to get more info on Obelisk, etc.
355 , "import ((import <nixpkgs> {}).fetchFromGitHub ("
486 , "import ((import <nixpkgs> {}).fetchFromGitHub ("
356 , " let json = builtins.fromJSON (builtins.readFile ./github.json);"
487 , " let json = builtins.fromJSON (builtins.readFile ./github.json);"
@@ -360,289 +491,701 @@ gitHubStandaloneLoaderV2 = T.unlines
363−plainGitStandaloneLoaders :: NonEmpty Text
494+gitHubThunkSpecV3 :: ThunkSpec
364−plainGitStandaloneLoaders =
495+gitHubThunkSpecV3 = legacyGitHubThunkSpec "github-v3" $ T.unlines
365− plainGitStandaloneLoaderV1 :|
496+ [ "# DO NOT HAND-EDIT THIS FILE"
498+ , " fetch = { private ? false, ... }@args: if private && builtins.hasAttr \"fetchGit\" builtins"
499+ , " then fetchFromGitHubPrivate args"
500+ , " else (import <nixpkgs> {}).fetchFromGitHub (builtins.removeAttrs args [\"branch\"]);"
501+ , " fetchFromGitHubPrivate ="
502+ , " { owner, repo, rev, branch ? null, name ? null, sha256 ? null, private ? false"
503+ , " , fetchSubmodules ? false, githubBase ? \"github.com\", ..."
504+ , " }: assert !fetchSubmodules;"
505+ , " builtins.fetchGit ({"
506+ , " url = \"ssh://git@${githubBase}/${owner}/${repo}.git\";"
509+ , " // (if branch == null then {} else { ref = branch; })"
510+ , " // (if name == null then {} else { inherit name; }));"
511+ , "in import (fetch (builtins.fromJSON (builtins.readFile ./github.json)))"
369−plainGitStandaloneLoaderV1 :: Text
514+gitHubThunkSpecV4 :: ThunkSpec
370−plainGitStandaloneLoaderV1 = T.unlines
515+gitHubThunkSpecV4 = legacyGitHubThunkSpec "github-v4" $ T.unlines
371− [ $notImplemented
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;"
523+ , "in import (fetch (builtins.fromJSON (builtins.readFile ./github.json)))"
374−-- | Look for authentication info from the 'hub' command
526+legacyGitHubThunkSpec :: Text -> Text -> ThunkSpec
375−getHubAuth
527+legacyGitHubThunkSpec name loader = ThunkSpec name $ Map.fromList
376− :: Text -- ^ Domain name
528+ [ ("default.nix", ThunkFileSpec_FileMatches $ T.strip loader)
377− -> IO (Maybe Auth)
529+ , ("github.json" , ThunkFileSpec_Ptr parseGitHubJsonBytes)
378−getHubAuth domain = do
530+ , (attrCacheFileName, ThunkFileSpec_AttrCache)
379− hubConfig <- getXdgDirectory XdgConfig "hub"
531+ , (".git", ThunkFileSpec_CheckoutIndicator)
380− Yaml.decodeFile hubConfig >>= \case
532+ ]
381− Nothing -> return Nothing
533+
382− Just v -> return $ flip parseMaybe v $ \v' -> do
534+gitHubThunkSpecV5 :: ThunkSpec
383− Yaml.Array domainConfigs <- v' .: domain --TODO: Determine what multiple domainConfigs means
535+gitHubThunkSpecV5 = mkThunkSpec "github-v5" "github.json" parseGitHubJsonBytes [here|
384− [Yaml.Object domainConfig] <- return $ toList domainConfigs
536+# DO NOT HAND-EDIT THIS FILE
385− token <- domainConfig .: "oauth_token"
537+let fetch = { private ? false, fetchSubmodules ? false, owner, repo, rev, sha256, ... }:
386− return $ OAuth $ encodeUtf8 token
538+ if !fetchSubmodules && !private then builtins.fetchTarball {
387−
539+ url = "https://github.com/${owner}/${repo}/archive/${rev}.tar.gz"; inherit sha256;
388−--TODO: when checking something out, make a shallow clone
540+ } else (import <nixpkgs> {}).fetchFromGitHub {
541+ inherit owner repo rev sha256 fetchSubmodules private;
543+ json = builtins.fromJSON (builtins.readFile ./github.json);
547+parseGitHubJsonBytes :: LBS.ByteString -> Either String ThunkPtr
548+parseGitHubJsonBytes = parseJsonObject $ parseThunkPtr $ \v ->
549+ ThunkSource_GitHub <$> parseGitHubSource v <|> ThunkSource_Git <$> parseGitSource v
551+gitThunkSpecs :: NonEmpty ThunkSpec
560+gitThunkSpecV1 :: ThunkSpec
561+gitThunkSpecV1 = legacyGitThunkSpec "git-v1" $ T.unlines
562+ [ "# DO NOT HAND-EDIT THIS FILE"
563+ , "let fetchGit = {url, rev, ref ? null, branch ? null, sha256 ? null, fetchSubmodules ? null}:"
564+ , " assert !fetchSubmodules; (import <nixpkgs> {}).fetchgit { inherit url rev sha256; };"
565+ , "in import (fetchGit (builtins.fromJSON (builtins.readFile ./git.json)))"
568+gitThunkSpecV2 :: ThunkSpec
569+gitThunkSpecV2 = legacyGitThunkSpec "git-v2" $ T.unlines
570+ [ "# DO NOT HAND-EDIT THIS FILE"
571+ , "let fetchGit = {url, rev, ref ? null, branch ? null, sha256 ? null, fetchSubmodules ? null}:"
572+ , " if builtins.hasAttr \"fetchGit\" builtins"
573+ , " then builtins.fetchGit ({ inherit url rev; } // (if branch == null then {} else { ref = branch; }))"
574+ , " else abort \"Plain Git repositories are only supported on nix 2.0 or higher.\";"
575+ , "in import (fetchGit (builtins.fromJSON (builtins.readFile ./git.json)))"
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"
588+ , " in if !fetchSubmodules && private then builtins.fetchGit {"
589+ , " url = realUrl; inherit rev;"
590+ , " } else (import <nixpkgs> {}).fetchgit {"
591+ , " url = realUrl; inherit rev sha256;"
593+ , "in import (fetch (builtins.fromJSON (builtins.readFile ./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"
604+ , " in if !fetchSubmodules && private then builtins.fetchGit {"
605+ , " url = realUrl; inherit rev;"
606+ , " ${if branch == null then null else \"ref\"} = branch;"
607+ , " } else (import <nixpkgs> {}).fetchgit {"
608+ , " url = realUrl; inherit rev sha256;"
610+ , "in import (fetch (builtins.fromJSON (builtins.readFile ./git.json)))"
613+legacyGitThunkSpec :: Text -> Text -> ThunkSpec
614+legacyGitThunkSpec name loader = ThunkSpec name $ Map.fromList
615+ [ ("default.nix", ThunkFileSpec_FileMatches $ T.strip loader)
616+ , ("git.json" , ThunkFileSpec_Ptr parseGitJsonBytes)
617+ , (attrCacheFileName, ThunkFileSpec_AttrCache)
618+ , (".git", ThunkFileSpec_CheckoutIndicator)
621+gitThunkSpecV5 :: ThunkSpec
622+gitThunkSpecV5 = mkThunkSpec "git-v5" "git.json" parseGitJsonBytes [here|
623+# DO NOT HAND-EDIT THIS FILE
624+let fetch = {url, rev, branch ? null, sha256 ? null, fetchSubmodules ? false, private ? false, ...}:
625+ let realUrl = let firstChar = builtins.substring 0 1 url; in
626+ if firstChar == "/" then /. + url
627+ else if firstChar == "." then ./. + url
629+ in if !fetchSubmodules && private then builtins.fetchGit {
630+ url = realUrl; inherit rev;
631+ ${if branch == null then null else "ref"} = branch;
632+ } else (import <nixpkgs> {}).fetchgit {
633+ url = realUrl; inherit rev sha256;
635+ json = builtins.fromJSON (builtins.readFile ./git.json);
639+parseGitJsonBytes :: LBS.ByteString -> Either String ThunkPtr
640+parseGitJsonBytes = parseJsonObject $ parseThunkPtr $ fmap ThunkSource_Git . parseGitSource
642+mkThunkSpec :: Text -> FilePath -> (LBS.ByteString -> Either String ThunkPtr) -> Text -> ThunkSpec
643+mkThunkSpec name jsonFileName parser srcNix = ThunkSpec name $ Map.fromList
644+ [ ("default.nix", ThunkFileSpec_FileMatches defaultNixViaSrc)
645+ , ("thunk.nix", ThunkFileSpec_FileMatches srcNix)
646+ , (jsonFileName, ThunkFileSpec_Ptr parser)
647+ , (attrCacheFileName, ThunkFileSpec_AttrCache)
648+ , (normalise $ unpackedDirName </> ".git", ThunkFileSpec_CheckoutIndicator)
651+ defaultNixViaSrc = [here|
652+# DO NOT HAND-EDIT THIS FILE
653+import (import ./thunk.nix)
657+parseJsonObject :: (Aeson.Object -> Aeson.Parser a) -> LBS.ByteString -> Either String a
658+parseJsonObject p bytes = Aeson.parseEither p =<< Aeson.eitherDecode bytes
390-- | Checks a cache directory to see if there is a fresh symlink
660-- | Checks a cache directory to see if there is a fresh symlink
391-- to the result of building an attribute of a thunk.
661-- to the result of building an attribute of a thunk.
392-- If no cache hit is found, nix-build is called to build the attribute
662-- If no cache hit is found, nix-build is called to build the attribute
393-- and the result is symlinked into the cache.
663-- and the result is symlinked into the cache.
394−nixBuildThunkAttrWithCache :: FilePath
664+nixBuildThunkAttrWithCache
395− -- ^ Path to directory containing Thunk
668+ -- ^ Path to directory containing Thunk
396− -> String
669+ -> String
397− -- ^ Attribute to build
670+ -- ^ Attribute to build
398− -> IO FilePath
671+ -> m (Maybe FilePath)
399− -- ^ Symlink to cached or built nix output
672+ -- ^ Symlink to cached or built nix output
400-- WARNING: If the thunk uses an impure reference such as '<nixpkgs>'
673-- WARNING: If the thunk uses an impure reference such as '<nixpkgs>'
401-- the caching mechanism will fail as it merely measures the modification
674-- the caching mechanism will fail as it merely measures the modification
402-- time of the cache link and the expression to build.
675-- time of the cache link and the expression to build.
403−nixBuildThunkAttrWithCache thunkDir attr = do
676+nixBuildThunkAttrWithCache thunkSpec thunkDir attr = do
404− --NB: Expects thunkDir to be normalised with no trailing path separator.
677+ latestChange <- liftIO $ do
405− --This should be guaranteed by the command argument parser.
678+ let
679+ getModificationTimeMaybe = fmap rightToMaybe . try @IOError . getModificationTime
680+ thunkFileNames = Map.keys $ _thunkSpec_files thunkSpec
681+ maximum . catMaybes <$> traverse (getModificationTimeMaybe . (thunkDir </>)) thunkFileNames
683+ let cachePaths' = nonEmpty $ Map.keys $ Map.filter (\case ThunkFileSpec_AttrCache -> True; _ -> False) $
684+ _thunkSpec_files thunkSpec
685+ for cachePaths' $ \cachePaths ->
686+ fmap NonEmpty.head $ for cachePaths $ \cacheDir -> do
688+ cachePath = thunkDir </> cacheDir </> attr <.> "out"
406− let cacheErrHandler e
689+ cacheErrHandler e
407− | isDoesNotExistError e = return Nothing -- expected from a cache miss
690+ | isDoesNotExistError e = pure Nothing -- expected from a cache miss
408− | otherwise = putError (T.pack $ displayException e) >> return Nothing
691+ | otherwise = Nothing <$ putLog Error (T.pack $ displayException e)
409− cacheDir = thunkDir </> ".attr-cache"
410− cachePath = cacheDir </> attr <.> "out"
411− createDirectoryIfMissing False cacheDir
412− latestChange <- maximum <$> mapM (getModificationTime . (thunkDir </>)) ["default.nix", "github.json"]
413− cacheHit <- handle cacheErrHandler $ do
692+ cacheHit <- handle cacheErrHandler $ do
414− cacheTime <- posixSecondsToUTCTime . realToFrac . modificationTime <$> getSymbolicLinkStatus cachePath
693+ cacheTime <- liftIO $ posixSecondsToUTCTime . realToFrac . modificationTime <$> getSymbolicLinkStatus cachePath
415− return $ if latestChange <= cacheTime
694+ pure $ if latestChange <= cacheTime
416− then Just cachePath
695+ then Just cachePath
417− else Nothing
696+ else Nothing
418− case cacheHit of
697+ case cacheHit of
419− Just c -> return c
698+ Just c -> pure c
420− Nothing -> do
699+ Nothing -> do
421− putWarning $ T.pack $ mconcat [thunkDir, ": ", attr, " not cached, building ..."]
700+ putLog Warning $ T.pack $ mconcat [thunkDir, ": ", attr, " not cached, building ..."]
422− _ <- nixBuild $ def
701+ liftIO $ createDirectoryIfMissing True (takeDirectory cachePath)
423− { _nixBuildConfig_target = Target
702+ (cachePath <$) $ nixCmd $ NixCmd_Build $ def
703+ & nixBuildConfig_outLink .~ OutLink_IndirectRoot cachePath
704+ & nixCmdConfig_target .~ Target
424− { _target_path = thunkDir
705+ { _target_path = Just thunkDir
425− , _target_attr = Just attr
706+ , _target_attr = Just attr
426− }
707+ , _target_expr = Nothing
427− , _nixBuildConfig_outLink = OutLink_IndirectRoot cachePath
431-- | Build a nix attribute, and cache the result if possible
710-- | Build a nix attribute, and cache the result if possible
432−nixBuildAttrWithCache :: FilePath
711+nixBuildAttrWithCache
433− -- ^ Path to directory containing Thunk
714+ -- ^ Path to directory containing Thunk
434− -> String
715+ -> String
435− -- ^ Attribute to build
716+ -- ^ Attribute to build
436− -> IO FilePath
717+ -> m FilePath
437− -- ^ Symlink to cached or built nix output
718+ -- ^ Symlink to cached or built nix output
438−nixBuildAttrWithCache exprPath attr = do
719+nixBuildAttrWithCache exprPath attr = readThunk exprPath >>= \case
439− readThunk exprPath >>= \case
440− -- Only packed thunks are cached. in particular, checkouts are not
720+ -- Only packed thunks are cached. In particular, checkouts are not.
721+ Right (ThunkData_Packed spec _) ->
441− Right (ThunkData_Packed _) -> nixBuildThunkAttrWithCache exprPath attr
722+ maybe build pure =<< nixBuildThunkAttrWithCache spec exprPath attr
442− _ -> nixBuild $ def
723+ _ -> build
443− { _nixBuildConfig_target = Target
724+ where
725+ build = nixCmd $ NixCmd_Build $ def
726+ & nixBuildConfig_outLink .~ OutLink_None
727+ & nixCmdConfig_target .~ Target
444− { _target_path = exprPath
728+ { _target_path = Just exprPath
445 , _target_attr = Just attr
729 , _target_attr = Just attr
730+ , _target_expr = Nothing
447− , _nixBuildConfig_outLink = OutLink_None
450−unpackThunk :: FilePath
733+-- | Safely update thunk using a custom action
735+-- A temporary working space is used to do any update. When the custom
736+-- action successfully completes, the resulting (packed) thunk is copied
737+-- back to the original location.
738+updateThunk :: MonadObelisk m => FilePath -> (FilePath -> m a) -> m a
739+updateThunk p f = withSystemTempDirectory "obelisk-thunkptr-" $ \tmpDir -> do
740+ p' <- copyThunkToTmp tmpDir p
741+ unpackThunk' True p'
743+ updateThunkFromTmp p'
452−unpackThunk thunkDir = readThunk thunkDir >>= \case
746+ copyThunkToTmp tmpDir thunkDir = readThunk thunkDir >>= \case
453− Left err -> failWith $ "thunk unpack: " <> (T.pack $ show err)
747+ Left err -> failWith $ "withThunkUnpacked: " <> T.pack (show err)
748+ Right ThunkData_Packed{} -> do
749+ let tmpThunk = tmpDir </> "thunk"
750+ callProcessAndLogOutput (Notice, Error) $
751+ proc cp ["-r", "-T", thunkDir, tmpThunk]
753+ Right _ -> failWith "Thunk is not packed"
754+ updateThunkFromTmp p' = do
755+ _ <- packThunk' True (ThunkPackConfig False (ThunkConfig Nothing)) p'
756+ callProcessAndLogOutput (Notice, Error) $
757+ proc cp ["-r", "-T", p', p]
759+finalMsg :: Bool -> (a -> Text) -> Maybe (a -> Text)
760+finalMsg noTrail s = if noTrail then Nothing else Just s
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}|]
770+ -- Don't let thunk commands work when directly given an unpacked repo
771+ when (takeFileName thunkDir == unpackedDirName) $
772+ readThunk (takeDirectory thunkDir) >>= \case
773+ Right _ -> failWith [i|Refusing to perform thunk operation on ${thunkDir} because it is a thunk's unpacked source|]
776+unpackThunk :: MonadObelisk m => FilePath -> m ()
777+unpackThunk = unpackThunk' False
779+unpackThunk' :: MonadObelisk m => Bool -> FilePath -> m ()
780+unpackThunk' noTrail thunkDir = checkThunkDirectory thunkDir *> readThunk thunkDir >>= \case
781+ Left err -> failWith [i|Invalid thunk at ${thunkDir}: ${err}|]
454 --TODO: Overwrite option that rechecks out thunk; force option to do so even if working directory is dirty
782 --TODO: Overwrite option that rechecks out thunk; force option to do so even if working directory is dirty
455− Right (ThunkData_Checkout _) -> failWith "thunk unpack: thunk is already unpacked"
783+ Right ThunkData_Checkout -> failWith [i|Thunk at ${thunkDir} is already unpacked|]
456− Right (ThunkData_Packed tptr) -> case _thunkPtr_source tptr of
784+ Right (ThunkData_Packed _ tptr) -> do
457− ThunkSource_GitHub s | (thunkParent, thunkName) <- splitFileName thunkDir -> withTempDirectory thunkParent thunkName $ \tmpRepo -> do
785+ let (thunkParent, thunkName) = splitFileName thunkDir
458− mauth <- getHubAuth "github.com"
786+ withTempDirectory thunkParent thunkName $ \tmpThunk -> do
459− repoResult <- executeRequestMaybe mauth $ repositoryR (_gitHubSource_owner s) (_gitHubSource_repo s)
787+ let
460− githubURI <- either throwIO (return . repoSshUrl) repoResult >>= \case
788+ gitSrc = thunkSourceToGitSource $ _thunkPtr_source tptr
461− Nothing -> failWith "Cannot determine clone URI for thunk source"
789+ newSpec = case _thunkPtr_source tptr of
462− Just c -> return $ T.unpack $ getUrl c
790+ ThunkSource_GitHub _ -> NonEmpty.head gitHubThunkSpecs
463− withSpinner "Cloning from GitHub ..." (Just $ "Cloned " <> githubURI) $ do
791+ ThunkSource_Git _ -> NonEmpty.head gitThunkSpecs
464− callProcess "hub" --TODO: Depend on hub explicitly
792+ withSpinner' ("Fetching thunk " <> T.pack thunkName)
465− [ "clone"
793+ (finalMsg noTrail $ const $ "Fetched thunk " <> T.pack thunkName) $ do
466− , "-n"
794+ let unpackedPath = tmpThunk </> unpackedDirName
467− , githubURI
795+ gitCloneForThunkUnpack gitSrc (_thunkRev_commit $ _thunkPtr_rev tptr) unpackedPath
469− ]
797+ let normalizeMore = dropTrailingPathSeparator . normalise
470− let obGitDir = tmpRepo </> ".git" </> "obelisk"
798+ when (normalizeMore unpackedPath /= normalizeMore tmpThunk) $ -- Only write meta data if the checkout is not inplace
471− --If this directory already exists then something is weird and we should fail
799+ createThunk tmpThunk $ Left newSpec
472− createDirectory obGitDir
800+
473− withSpinner "Copying thunk ..." Nothing $ do
801+ liftIO $ do
474− cp
802+ removePathForcibly thunkDir
475− [ "-r"
803+ renameDirectory tmpThunk thunkDir
477− , thunkDir </> "."
805+gitCloneForThunkUnpack
478− , obGitDir </> "orig-thunk"
806+ :: MonadObelisk m
479− ]
807+ => GitSource -- ^ Git source to use
480− let checkoutOptions = concat
808+ -> Ref hash -- ^ Commit hash to reset to
481− [ ["-C", tmpRepo]
809+ -> FilePath -- ^ Directory to clone into
482− , pure "checkout"
810+ -> m ()
483− , maybe [] (\n -> ["-B", T.unpack (untagName n)]) (_gitHubSource_branch s)
811+gitCloneForThunkUnpack gitSrc commit dir = do
484− , pure $ Ref.toHexString $ _thunkRev_commit $ _thunkPtr_rev tptr
812+ let git = callProcessAndLogOutput (Notice, Notice) . gitProc dir
485− ]
813+ git $ [ "clone" ]
486− callProcess "hub" checkoutOptions
814+ ++ ["--recursive" | _gitSource_fetchSubmodules gitSrc]
487− callProcess "rm"
815+ ++ [ T.unpack $ gitUriToText $ _gitSource_url gitSrc ]
488− [ "-r"
816+ ++ do branch <- maybeToList $ _gitSource_branch gitSrc
489− , thunkDir
817+ [ "--branch", T.unpack $ untagName branch ]
818+ git ["reset", "--hard", Ref.toHexString commit]
819+ when (_gitSource_fetchSubmodules gitSrc) $
820+ git ["submodule", "update", "--recursive", "--init"]
822+--TODO: add a rollback mode to pack to the original thunk
823+packThunk :: MonadObelisk m => ThunkPackConfig -> FilePath -> m ThunkPtr
824+packThunk = packThunk' False
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|]
830+ ("Packing thunk " <> T.pack thunkDir)
831+ (finalMsg noTrail $ const $ "Packed thunk " <> T.pack thunkDir) $
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
839+modifyThunkPtrByConfig :: ThunkConfig -> ThunkPtr -> ThunkPtr
840+modifyThunkPtrByConfig (ThunkConfig markPrivate') ptr = case markPrivate' of
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 }
848+ = CheckClean_FullCheck
849+ -- ^ Check that the repo is clean, including .gitignored files
850+ | CheckClean_NotIgnored
851+ -- ^ Check that the repo is clean, not including .gitignored files
852+ | CheckClean_NoCheck
853+ -- ^ Don't check that the repo is clean
855+getThunkPtr :: forall m. MonadObelisk m => CheckClean -> FilePath -> Maybe Bool -> m ThunkPtr
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
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"
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"
878+ ] ++ T.lines stashOutput
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"]
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."
491− callProcessNixShell ["coreutils"] "mv"
890+ _ -> return (b, c)
493− , tmpRepo
892+ -- Get information on all branches and their (optional) designated upstream
494− , thunkDir
893+ -- correspondents
894+ headDump :: [Text] <- T.lines <$> readGitProcess thunkDir
896+ , "--format=%(refname:short) %(upstream:short) %(upstream:remotename)"
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
905+ [u, r] -> pure $ Just (u, r)
906+ (_:_) -> failWith "git for-each-ref invalid output"
907+ pure (branch, mUpstream)
909+ putLog Debug $ "branches: " <> T.pack (show headInfo)
911+ let errorMap :: Map Text ()
912+ headUpstream :: Map Text (Text, Text)
913+ (errorMap, headUpstream) = flip Map.mapEither headInfo $ \case
917+ putLog Debug $ "branches with upstream branch set: " <> T.pack (show headUpstream)
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:"
927+ , T.unwords untrackedBranches
929+ , "To fix this, you probably want to do:"
932+ ((\branch -> "git push -u origin " <> branch) <$> untrackedBranches) ++
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."
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
496− return ()
945+ let ahead = length $ [ () | Just ('<', _) <- T.uncons <$> stat ]
497− ThunkSource_Git _s -> do
946+ behind = length $ [ () | Just ('>', _) <- T.uncons <$> stat ]
498− $notImplemented
947+ pure (upstream, (ahead, behind))
500−--TODO: add force mode to pack even if changes are present
949+ -- Those branches which have commits ahead of, i.e. not on, the upstream
501−--TODO: add a rollback mode to pack to the original thunk
950+ -- branch. Purely being behind is fine.
502−packThunk :: FilePath
951+ let nonGood = Map.filter ((/= 0) . fst . snd) stats
504− -> IO ()
953+ when (not $ Map.null nonGood) $ failWith $ T.unlines $
505−packThunk thunkDir upstream = readThunk thunkDir >>= \case
954+ [ "thunk pack: Certain branches in the thunk have commits not yet pushed upstream:"
506− Left err -> failWith $ T.pack $ "thunk pack: " <> show err
955+ , ""
507− Right (ThunkData_Packed _) -> failWith "pack: thunk is already packed"
956+ ] ++
508− Right (ThunkData_Checkout _) -> do
957+ flip map (Map.toList nonGood) (\(branch, (upstream, (ahead, behind))) -> mconcat
509− thunkPtr <- getThunkPtr thunkDir upstream
958+ [" ", branch, " ahead: ", T.pack (show ahead), " behind: ", T.pack (show behind), " remote branch ", upstream]) ++
510− callProcess "rm"
959+ [ ""
511− [ "-rf"
960+ , "Please push these upstream and try again. (Or just fetch, if they are somehow \
512− , thunkDir
961+ \pushed but this repo's remote tracking branches don't know it.)"
514− createThunk thunkDir thunkPtr
963+
515− return ()
964+ when checkClean $ do
516−
965+ -- We assume it's safe to pack the thunk at this point
517−getThunkPtr :: FilePath -> String -> IO ThunkPtr
966+ putLog Informational "All changes safe in git remotes. OK to pack thunk."
518−getThunkPtr thunkDir upstream = do
967+
519− checkGitCleanStatus thunkDir >>= \case
968+ let remote = maybe "origin" snd $ flip Map.lookup headUpstream =<< mCurrentBranch
521− statusDebug <- readProcess "hub"
970+ [remoteUri'] <- fmap T.lines $ readGitProcess thunkDir
522− [ "-C", thunkDir, "status", "--ignored" ] ""
971+ [ "config"
523− failWith $ T.pack $ unlines $
972+ , "--get"
524− [ "thunk pack: thunk checkout contains unsaved modifications"
973+ , "remote." <> T.unpack remote <> ".url"
525− , "git status:"
974+ ]
526− ] ++ lines statusDebug
975+
527− True -> return ()
976+ remoteUri <- case parseGitUri remoteUri' of
528−
977+ Nothing -> failWith $ "Could not identify git remote: " <> remoteUri'
529− -- Check whether there are any stashes
978+ Just uri -> pure uri
530− stashOutput <- readProcess "hub" [ "-C", thunkDir, "stash", "list" ] ""
979+ uriThunkPtr remoteUri mPrivate mCurrentBranch mCurrentCommit
531− case null stashOutput of
980+
532− False -> do
981+-- | Get the latest revision available from the given source
533− failWith $ T.pack $ unlines $
982+getLatestRev :: MonadObelisk m => ThunkSource -> m ThunkRev
534− [ "thunk pack: thunk checkout has stashes"
983+getLatestRev os = do
535− , "git stash list:"
984+ let gitS = thunkSourceToGitSource os
536− ] ++ lines stashOutput
985+ (_, commit) <- gitGetCommitBranch (_gitSource_url gitS) (untagName <$> _gitSource_branch gitS)
537− True -> return ()
986+ case os of
538−
987+ ThunkSource_GitHub s -> githubThunkRev s commit
539− --Check whether all local heads are pushed
988+ ThunkSource_Git s -> gitThunkRev s commit
540− repoHeads <- lines <$> readProcess "hub"
989+
541− [ "-C", thunkDir
990+-- | Convert a URI to a thunk
542− , "for-each-ref", "--format=%(refname:short)", "refs/heads/"
991+--
543− ] ""
992+-- If the URL is a github URL, we try to just download an archive for
544− remotes <- lines <$> readProcess "hub" [ "-C", thunkDir, "remote" ] ""
993+-- performance. If that doesn't work (e.g. authentication issue), we fall back
545− --Check that the upstream specified actually exists
994+-- on just doing things the normal way for git repos in general, and save it as
546− case L.find (== upstream) remotes of
995+-- a regular git thunk.
547− Nothing -> failWith $ T.pack $ "thunk pack: upstream " <> upstream <> " does not exist"
996+uriThunkPtr :: MonadObelisk m => GitUri -> Maybe Bool -> Maybe Text -> Maybe Text -> m ThunkPtr
548− Just _ -> return ()
997+uriThunkPtr uri mPrivate mbranch mcommit = do
549− -- iterate over cartesian product
998+ commit <- case mcommit of
550− forM_ repoHeads $ \hd -> do
999+ Nothing -> gitGetCommitBranch uri mbranch >>= return . snd
551− [localRev] <- lines <$> readProcess "hub" [ "-C", thunkDir, "rev-parse", hd ] ""
1000+ (Just c) -> return c
552− forM_ remotes $ \rm -> do
1001+ (src, rev) <- uriToThunkSource uri mPrivate mbranch >>= \case
553− --TODO: The error you get if a branch isn't pushed anywhere could be made more user friendly
1002+ ThunkSource_GitHub s -> do
554− [remoteMergeRev] <- lines <$> readProcess "hub"
1003+ rev <- runExceptT $ githubThunkRev s commit
555− [ "-C", thunkDir
1004+ case rev of
556− , "merge-base"
1005+ Right r -> pure (ThunkSource_GitHub s, r)
557− , localRev
1006+ Left e -> do
558− , "remotes/" <> rm <> "/" <> hd
1007+ putLog Warning "\
559− ] ""
1008+\Failed to fetch archive from GitHub. This is probably a private repo. \
560− case remoteMergeRev == localRev of
1009+\Falling back on normal fetchgit. Original failure:"
561− False -> failWith $ T.pack $ mconcat [ "thunk unpack: branch ", hd, " has not been pushed to ", rm ]
1010+ errorToWarning e
562− True -> return ()
1011+ let s' = forgetGithub True s
563−
1012+ (,) (ThunkSource_Git s') <$> gitThunkRev s' commit
564− --We assume it's safe to pack the thunk at this point
1013+ ThunkSource_Git s -> (,) (ThunkSource_Git s) <$> gitThunkRev s commit
565− [remoteUri'] <- lines <$> readProcess "hub"
1014+ pure $ ThunkPtr
566− [ "-C", thunkDir
1015+ { _thunkPtr_rev = rev
567− , "config", "--get", "remote." <> upstream <> ".url"
1016+ , _thunkPtr_source = src
570− let uriParseFailure = "Could not identify git remote: " <> remoteUri'
1019+-- | N.B. Cannot infer all fields.
571− mRemoteUri = parseURIReference remoteUri'
1020+--
572− <|> parseSshShorthand remoteUri'
1021+-- If the thunk is a GitHub thunk and fails, we do *not* fall back like with
573− thunkPtr <- case mRemoteUri of
1022+-- `uriThunkPtr`. Unlike a plain URL, a thunk src explicitly states which method
574− Nothing -> failWith $ T.pack uriParseFailure
1023+-- should be employed, and so we respect that.
575− Just remoteUri -> do
1024+uriToThunkSource :: MonadObelisk m => GitUri -> Maybe Bool -> Maybe Text -> m ThunkSource
576− refs <- fmap (refsToTuples . words) . lines <$> readProcess "hub"
1025+uriToThunkSource (GitUri u) mPrivate
577− [ "-C"
1026+ | Right uriAuth <- URI.uriAuthority u
578− , thunkDir
1027+ , Just scheme <- URI.unRText <$> URI.uriScheme u
579− , "show-ref"
1028+ , case scheme of
580− , "--head" ] ""
1029+ "ssh" -> uriAuth == URI.Authority
581− -- safe because exactly one hash is associated with HEAD
1030+ { URI.authUserInfo = Just $ URI.UserInfo (fromRight' $ URI.mkUsername "git") Nothing
582− let Just currentHead = fst <$> L.find ((== "HEAD") . snd) refs
1031+ , URI.authHost = fromRight' $ URI.mkHost "github.com"
583− remoteHeads = Map.fromList $ catMaybes $ fmap
1032+ , URI.authPort = Nothing
584− (\(x,y) -> (,) x <$> L.stripPrefix ("refs/remotes/" <> upstream <> "/") y)
586− localHeads = Map.fromList $ catMaybes $ fmap
587− (\(x,y) -> (,) x <$> L.stripPrefix "refs/heads/" y)
589− currentUpstreamBranch = Map.lookup currentHead remoteHeads
590− <|> Map.lookup currentHead localHeads
592− | isGithubThunk remoteUri -> githubThunkPtr remoteUri currentHead currentUpstreamBranch
593− | otherwise -> gitThunkPtr remoteUri currentHead currentUpstreamBranch
596− refsToTuples [x, y] = (x, y)
597− refsToTuples x = error $ "thunk pack: cannot parse ref " <> show x
599− | Just uriAuth <- uriAuthority u
600− = case uriScheme u of
601− "ssh:" -> uriAuth == URIAuth "git@" "github.com" ""
602− s -> s `L.elem` [ "git:", "https:", "http:" ] -- "http:" just redirects to "https:"
603− && uriRegName uriAuth == "github.com"
605− githubThunkPtr u commit' branch' = do
606− ["/", owner', repo'] <- return $ splitDirectories (uriPath u)
607− let owner = N (T.pack owner')
608− repo = N (T.pack (dropExtension repo'))
609− commit = N (T.pack commit')
610− branch = N . T.pack <$> branch'
611− mauth <- getHubAuth "github.com"
612− repoResult <- executeRequestMaybe mauth $ repositoryR owner repo
613− repoIsPrivate <- either throwIO (return . repoPrivate) repoResult
614− archiveResult <- executeRequestMaybe mauth $
615− archiveForR owner repo ArchiveFormatTarball (Just (untagName commit))
616− archiveUri <- either throwIO return archiveResult
617− hash <- getNixSha256ForUriUnpacked archiveUri
619− { _thunkPtr_rev = ThunkRev
620− { _thunkRev_commit = commitNameToRef commit
621− , _thunkRev_nixSha256 = hash
623− , _thunkPtr_source = ThunkSource_GitHub $ GitHubSource
1034+ s -> s `L.elem` [ "git", "https", "http" ] -- "http:" just redirects to "https:"
624− { _gitHubSource_owner = owner
1035+ && URI.unRText (URI.authHost uriAuth) == "github.com"
625− , _gitHubSource_repo = repo
1036+ , Just (_, owner :| [repoish]) <- URI.uriPath u
626− , _gitHubSource_branch = branch
1037+ = \mbranch -> do
627− , _gitHubSource_private = repoIsPrivate
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
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
1057+ getIsPrivate = maybe (guessGitRepoIsPrivate $ GitUri u) pure mPrivate
1059+guessGitRepoIsPrivate :: MonadObelisk m => GitUri -> m Bool
1060+guessGitRepoIsPrivate uri = flip fix urisToTry $ \loop -> \case
1062+ uriAttempt:xs -> do
1063+ result <- readCreateProcessWithExitCode $
1070+ , T.unpack $ gitUriToText uriAttempt
1073+ (ExitSuccess, _, _) -> pure False -- Must be a public repo
1076+ urisToTry = nubOrd $
1077+ -- Include the original URI if it isn't using SSH because SSH will certainly fail.
1078+ [uri | fmap URI.unRText (URI.uriScheme (unGitUri uri)) /= Just "ssh"] <>
1079+ [changeScheme "https" uri, changeScheme "http" uri]
1080+ changeScheme scheme (GitUri u) = GitUri $ u
1081+ { URI.uriScheme = URI.mkScheme scheme
1082+ , URI.uriAuthority = (\x -> x { URI.authUserInfo = Nothing }) <$> URI.uriAuthority u
630− gitThunkPtr u _commit' _branch' = do
1084+
631− case uriScheme u of
1085+-- Funny signature indicates no effects depend on the optional branch name.
632− "https:" -> return ()
1086+githubThunkRev
633− "git:" -> return ()
1087+ :: forall m
634− _ -> failWith "thunk pack: obelisk currently only supports https and git protocols for non-GitHub remotes"
1088+ . MonadObelisk m
635− $notImplemented
1089+ => GitHubSource
636− parseSshShorthand uri' = do
1090+ -> Text
637− -- This is what git does to check that the remote
1091+ -> m ThunkRev
638− -- is not a local file path when parsing shorthand.
1092+githubThunkRev s commit = do
639− -- Last referenced from here:
1093+ owner <- forcePP $ _gitHubSource_owner s
640− -- https://github.com/git/git/blob/95ec6b1b3393eb6e26da40c565520a8db9796e9f/connect.c#L712
1094+ repo <- forcePP $ _gitHubSource_repo s
641− let uri = T.pack uri'
1095+ revTarball <- URI.mkPathPiece $ commit <> ".tar.gz"
642− (authAndHostname, colonAndPath) = T.break (== ':') uri
1096+ let archiveUri = GitUri $ URI.URI
643− properUri = "ssh://" <> authAndHostname <> "/" <> T.drop 1 colonAndPath
1097+ { URI.uriScheme = Just $ fromRight' $ URI.mkScheme "https"
644− -- Shorthand is valid iff a colon is present and it occurs before the first slash
1098+ , URI.uriAuthority = Right $ URI.Authority
645− -- This check is used to disambiguate a filepath containing a colon from shorthand
1099+ { URI.authUserInfo = Nothing
646− guard $ isNothing (T.findIndex (=='/') authAndHostname)
1100+ , URI.authHost = fromRight' $ URI.mkHost "github.com"
647− && not (T.null colonAndPath)
1101+ , URI.authPort = Nothing
648− parseURI $ T.unpack properUri
1102+ }
1103+ , URI.uriPath = Just ( False
1104+ , owner :| [ repo, fromRight' $ URI.mkPathPiece "archive", revTarball ]
1106+ , URI.uriQuery = []
1107+ , URI.uriFragment = Nothing
1109+ hash <- getNixSha256ForUriUnpacked archiveUri
1110+ putLog Debug $ "Nix sha256 is " <> hash
1112+ { _thunkRev_commit = commitNameToRef $ N commit
1113+ , _thunkRev_nixSha256 = hash
1116+ forcePP :: Name entity -> m (URI.RText 'URI.PathPiece)
1117+ forcePP = URI.mkPathPiece . untagName
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
1134+ { _thunkRev_commit = commitNameToRef (N commit)
1135+ , _thunkRev_nixSha256 = hash
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.
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.
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)
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
1157+ commit <- rethrowE $ gitLookupCommitForRef bothMaps (GitRef_Branch branch)
1158+ putLog Informational $ "Latest commit in branch " <> branch
1159+ <> " from remote repo " <> uriMsg
1160+ <> " is " <> commit
1161+ pure (branch, commit)
1163+ rethrowE = either failWith pure
1164+ uriMsg = gitUriToText uri
1166+parseGitUri :: Text -> Maybe GitUri
1167+parseGitUri x = GitUri <$> (parseFileURI x <|> parseAbsoluteURI x <|> parseSshShorthand x)
1169+parseFileURI :: Text -> Maybe URI.URI
1170+parseFileURI uri = if "/" `T.isPrefixOf` uri then parseAbsoluteURI ("file://" <> uri) else Nothing
1172+parseAbsoluteURI :: Text -> Maybe URI.URI
1173+parseAbsoluteURI uri = do
1174+ parsedUri <- URI.mkURI uri
1175+ guard $ URI.isPathAbsolute parsedUri
1178+parseSshShorthand :: Text -> Maybe URI.URI
1179+parseSshShorthand uri = do
1180+ -- This is what git does to check that the remote
1181+ -- is not a local file path when parsing shorthand.
1182+ -- Last referenced from here:
1183+ -- https://github.com/git/git/blob/95ec6b1b3393eb6e26da40c565520a8db9796e9f/connect.c#L712
1185+ (authAndHostname, colonAndPath) = T.break (== ':') uri
1186+ properUri = "ssh://" <> authAndHostname <> "/" <> T.drop 1 colonAndPath
1187+ -- Shorthand is valid iff a colon is present and it occurs before the first slash
1188+ -- This check is used to disambiguate a filepath containing a colon from shorthand
1189+ guard $ isNothing (T.findIndex (=='/') authAndHostname)
1190+ && not (T.null colonAndPath)
1191+ URI.mkURI properUri