@@ -5,70 +5,81 @@
5{-# LANGUAGE MultiWayIf #-}
5{-# LANGUAGE MultiWayIf #-}
6{-# LANGUAGE OverloadedStrings #-}
6{-# LANGUAGE OverloadedStrings #-}
7{-# LANGUAGE PatternGuards #-}
7{-# LANGUAGE PatternGuards #-}
8−{-# LANGUAGE QuasiQuotes #-}
8+{-# LANGUAGE TemplateHaskell #-}
9−{-# LANGUAGE ScopedTypeVariables #-}
9+
10−{-# LANGUAGE TypeApplications #-}
11−module Obelisk.Command.Thunk where
10+module Obelisk.Command.Thunk
17+ , updateThunkToLatest
19+ , createThunkWithLatest
20+ , nixBuildAttrWithCache
21+ , nixBuildThunkAttrWithCache
13import Control.Applicative
28import Control.Applicative
14−import Control.Exception (displayException, try)
29+import Control.Exception (displayException, throwIO)
15−import Control.Lens (ifor, ifor_, (.~))
16import Control.Monad
30import Control.Monad
17−import Control.Monad.Extra (findM)
31+import Control.Monad.Catch (handle)
18−import Control.Monad.Catch (MonadCatch, handle)
19import Control.Monad.Except
32import Control.Monad.Except
20−import Data.Aeson ((.=))
33+import Data.Aeson (decode, (.=))
21import qualified Data.Aeson as Aeson
34import qualified Data.Aeson as Aeson
22import Data.Aeson.Encode.Pretty
35import Data.Aeson.Encode.Pretty
23−import qualified Data.Aeson.Types as Aeson
24−import Data.Bifunctor (first)
25import qualified Data.ByteString.Lazy as LBS
36import qualified Data.ByteString.Lazy as LBS
26−import Data.Containers.ListUtils (nubOrd)
27import Data.Default
37import Data.Default
28−import Data.Either.Combinators (fromRight', rightToMaybe)
38+import Data.Foldable
29−import Data.Foldable (toList)
30−import Data.Function ((&))
31−import Data.Functor ((<&>))
32import Data.Git.Ref (Ref)
39import Data.Git.Ref (Ref)
33import qualified Data.Git.Ref as Ref
40import qualified Data.Git.Ref as Ref
34import qualified Data.List as L
41import qualified Data.List as L
35−import Data.List.NonEmpty (NonEmpty (..), nonEmpty)
42+import Data.List.NonEmpty (NonEmpty (..))
36import qualified Data.List.NonEmpty as NonEmpty
43import qualified Data.List.NonEmpty as NonEmpty
38import qualified Data.Map as Map
44import qualified Data.Map as Map
39import Data.Maybe
45import Data.Maybe
40import Data.Set (Set)
47import Data.Set (Set)
41import qualified Data.Set as Set
48import qualified Data.Set as Set
42−import Data.String.Here.Interpolated (i)
43−import Data.String.Here.Uninterpolated (here)
44import Data.Text (Text)
49import Data.Text (Text)
45import qualified Data.Text as T
50import qualified Data.Text as T
46import Data.Text.Encoding
51import Data.Text.Encoding
47import qualified Data.Text.IO as T
52import qualified Data.Text.IO as T
48import Data.Time.Clock.POSIX (posixSecondsToUTCTime)
53import Data.Time.Clock.POSIX (posixSecondsToUTCTime)
49−import Data.Traversable (for)
50−import Data.Yaml (parseMaybe)
54+import Data.Yaml (parseMaybe, (.:))
55+import qualified Data.Yaml as Yaml
51import GitHub
56import GitHub
52import GitHub.Data.Name
57import GitHub.Data.Name
58+import GitHub.Endpoints.Repos.Contents (archiveForR)
53import Obelisk.Command.Nix
60import Obelisk.Command.Nix
54import System.Directory
61import System.Directory
55import System.Exit
62import System.Exit
56import System.FilePath
63import System.FilePath
57import System.IO.Error
65import System.IO.Error
58import System.IO.Temp
66import System.IO.Temp
59−import System.PosixCompat.Files (getSymbolicLinkStatus, modificationTime)
67+import System.Posix (getSymbolicLinkStatus, modificationTime)
60−import qualified Text.URI as URI
68+import System.Process (StdStream (CreatePipe), callProcess, createProcess, proc, readProcess, std_err,
69+ std_out, waitForProcess)
71+import Development.Placeholders
62import Obelisk.App (MonadObelisk)
72import Obelisk.App (MonadObelisk)
63−import Obelisk.CliApp
73+import Obelisk.CLI (Severity (..), callProcessAndLogOutput, failWith, putLog, withSpinner)
64−import Obelisk.Command.Utils
74+import Obelisk.Command.Utils (checkGitCleanStatus, cp, procWithPackages)
66--TODO: Support symlinked thunk data
76--TODO: Support symlinked thunk data
67data ThunkData
77data ThunkData
68− = ThunkData_Packed ThunkSpec ThunkPtr
78+ = ThunkData_Packed ThunkPtr
69 -- ^ Packed thunk
79 -- ^ Packed thunk
70− | ThunkData_Checkout
80+ | ThunkData_Checkout (Maybe ThunkPtr)
71 -- ^ Checked out thunk that was unpacked from this pointer
81 -- ^ Checked out thunk that was unpacked from this pointer
82+ deriving (Show, Eq, Ord)
73-- | A reference to the exact data that a thunk should translate into
84-- | A reference to the exact data that a thunk should translate into
74data ThunkPtr = ThunkPtr
85data ThunkPtr = ThunkPtr
@@ -81,7 +92,7 @@ type NixSha256 = Text --TODO: Use a smart constructor and make this actually ver
82-- | A specific revision of data; it may be available from multiple sources
93-- | A specific revision of data; it may be available from multiple sources
83data ThunkRev = ThunkRev
94data ThunkRev = ThunkRev
84− { _thunkRev_commit :: Ref Ref.SHA1
95+ { _thunkRev_commit :: Ref
85 , _thunkRev_nixSha256 :: NixSha256
96 , _thunkRev_nixSha256 :: NixSha256
87 deriving (Show, Eq, Ord)
98 deriving (Show, Eq, Ord)
@@ -94,11 +105,6 @@ data ThunkSource
94 | ThunkSource_Git GitSource
105 | ThunkSource_Git GitSource
95 deriving (Show, Eq, Ord)
106 deriving (Show, Eq, Ord)
97−thunkSourceToGitSource :: ThunkSource -> GitSource
98−thunkSourceToGitSource = \case
99− ThunkSource_GitHub s -> forgetGithub False s
100− ThunkSource_Git s -> s
102data GitHubSource = GitHubSource
108data GitHubSource = GitHubSource
103 { _gitHubSource_owner :: Name Owner
109 { _gitHubSource_owner :: Name Owner
104 , _gitHubSource_repo :: Name Repo
110 , _gitHubSource_repo :: Name Repo
@@ -107,263 +113,158 @@ data GitHubSource = GitHubSource
108 deriving (Show, Eq, Ord)
114 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
119data GitSource = GitSource
116data GitSource = GitSource
120− { _gitSource_url :: GitUri
117+ { _gitSource_url :: URI
118+ --TODO: Is it ok to use the types from the GitHub api bindings?
121 , _gitSource_branch :: Maybe (Name Branch)
119 , _gitSource_branch :: Maybe (Name Branch)
122 , _gitSource_fetchSubmodules :: Bool
120 , _gitSource_fetchSubmodules :: Bool
123− , _gitSource_private :: Bool
125 deriving (Show, Eq, Ord)
122 deriving (Show, Eq, Ord)
127−newtype ThunkConfig = ThunkConfig
128− { _thunkConfig_private :: Maybe Bool
131−data ThunkUpdateConfig = ThunkUpdateConfig
132− { _thunkUpdateConfig_branch :: Maybe String
133− , _thunkUpdateConfig_config :: ThunkConfig
136−data ThunkPackConfig = ThunkPackConfig
137− { _thunkPackConfig_force :: Bool
138− , _thunkPackConfig_config :: ThunkConfig
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
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
160− , _gitSource_branch = _gitHubSource_branch s
161− , _gitSource_fetchSubmodules = False
162− , _gitSource_private = _gitHubSource_private s
165−getThunkGitBranch :: ThunkPtr -> Maybe Text
166−getThunkGitBranch (ThunkPtr _ src) = fmap untagName $ case src of
167− ThunkSource_GitHub s -> _gitHubSource_branch s
168− ThunkSource_Git s -> _gitSource_branch s
170−commitNameToRef :: Name Commit -> Ref Ref.SHA1
124+commitNameToRef :: Name Commit -> Ref
171commitNameToRef (N c) = Ref.fromHex $ encodeUtf8 c
125commitNameToRef (N c) = Ref.fromHex $ encodeUtf8 c
173-- TODO: Use spinner here.
127-- TODO: Use spinner here.
174−getNixSha256ForUriUnpacked
128+getNixSha256ForUriUnpacked :: URI -> IO NixSha256
178−getNixSha256ForUriUnpacked uri =
129+getNixSha256ForUriUnpacked uri = do
179− withExitFailMessage ("nix-prefetch-url: Failed to determine sha256 hash of URL " <> gitUriToText uri) $ do
130+ --TODO: Make this package depend on nix-prefetch-url properly
180− [hash] <- fmap T.lines $ readProcessAndLogOutput (Debug, Debug) $
181− proc nixPrefetchUrlPath ["--unpack", "--type", "sha256", T.unpack $ gitUriToText uri]
131+ let cmd = proc "nix-prefetch-url" ["--unpack" , "--type" , "sha256" , show uri]
182− pure hash
132+ (_, Just out, Just err, p) <- createProcess cmd
183−
133+ { std_out = CreatePipe
184−nixPrefetchGit :: MonadObelisk m => GitUri -> Text -> Bool -> m NixSha256
134+ , std_err = CreatePipe
185−nixPrefetchGit uri rev fetchSubmodules =
135+ }
186− withExitFailMessage ("nix-prefetch-git: Failed to determine sha256 hash of Git repo " <> gitUriToText uri <> " at " <> rev) $ do
136+ --TODO: Deal with errors here; usually they're HTTP errors
187− out <- readProcessAndLogStderr Debug $
137+ waitForProcess p >>= \case
188− proc nixPrefetchGitPath $ filter (/="")
138+ ExitSuccess -> return ()
189− [ "--url", T.unpack $ gitUriToText uri
139+ _ -> do
190− , "--rev", T.unpack rev
140+ hPutStrLn stdout =<< hGetContents out
191− , if fetchSubmodules then "--fetch-submodules" else ""
141+ hPutStrLn stderr =<< hGetContents err
192− , "--quiet"
142+ --TODO: actual error
193− ]
143+ fail "nix-prefetch-url"
144+ T.strip <$> T.hGetContents out
195− case parseMaybe (Aeson..: "sha256") =<< Aeson.decodeStrict (encodeUtf8 out) of
146+-- | Get the latest revision available from the given source
196− Nothing -> failWith $ "nix-prefetch-git: unrecognized output " <> out
147+getLatestRev :: ThunkSource -> IO ThunkRev
197− Just x -> pure x
148+getLatestRev = \case
149+ ThunkSource_GitHub s -> do
150+ auth <- getHubAuth "github.com"
151+ commitsResult <- executeRequestMaybe auth $ commitsWithOptionsForR
152+ (_gitHubSource_owner s)
153+ (_gitHubSource_repo s)
155+ $ case _gitHubSource_branch s of
157+ Just b -> [CommitQuerySha $ untagName b]
158+ commitInfos <- either throwIO return commitsResult
159+ commitInfo : _ <- return $ toList commitInfos
160+ let commit = commitSha commitInfo
161+ Right archiveUri <- executeRequestMaybe auth $ archiveForR (_gitHubSource_owner s) (_gitHubSource_repo s) ArchiveFormatTarball $ Just $ untagName commit
162+ nixSha256 <- getNixSha256ForUriUnpacked archiveUri
164+ { _thunkRev_commit = commitNameToRef commit
165+ , _thunkRev_nixSha256 = nixSha256
167+ ThunkSource_Git _s -> do
199--TODO: Pretty print these
170--TODO: Pretty print these
200data ReadThunkError
171data ReadThunkError
201− = ReadThunkError_UnrecognizedThunk
172+ = ReadThunkError_WrongContents (Set String) (Set String)
202− | ReadThunkError_UnrecognizedPaths (NonEmpty FilePath)
173+ | ReadThunkError_UnrecognizedLoader Text
203− | ReadThunkError_MissingPaths (NonEmpty FilePath)
174+ | ReadThunkError_UnparseablePtr LBS.ByteString
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)
175+ deriving (Show)
211−unpackedDirName :: FilePath
177+-- | Read a thunk and validate that it is only a thunk, either packed or unpacked.
212−unpackedDirName = "."
178+-- If the thunk is packed and additional data is present, fail.
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
298− => NonEmpty (NonEmpty ThunkSpec) -> FilePath -> m (Either ReadThunkError ThunkData)
179+readThunk :: MonadObelisk m => FilePath -> m (Either ReadThunkError ThunkData)
299−readThunkWith specTypes dir = do
180+readThunk thunkDir = do
300− dirFiles <- Set.fromList <$> liftIO (listDirectory dir)
181+ files <- liftIO $ listDirectory thunkDir
301− let specs = concatMap toList $ toList $ NonEmpty.transpose specTypes -- Interleave spec types so we try each one in a "fair" ordering
182+ case ".git" `elem` files of
302− flip fix specs $ \loop -> \case
183+ True -> fmap ThunkData_Checkout <$> do
303− [] -> pure $ Left ReadThunkError_UnrecognizedThunk
184+ let origThunkPath = thunkDir </> ".git" </> "obelisk" </> "orig-thunk"
304− spec:rest -> runExceptT (matchThunkSpecToDir spec dir dirFiles) >>= \case
185+ liftIO $ doesDirectoryExist origThunkPath >>= \case
305− Left e -> putLog Debug [i|Thunk specification ${_thunkSpec_name spec} did not match ${dir}: ${e}|] *> loop rest
186+ True -> fmap Just <$> readPackedThunk origThunkPath
306− x@(Right _) -> x <$ putLog Debug [i|Thunk specification ${_thunkSpec_name spec} matched ${dir}|]
187+ False -> return $ return Nothing
188+ False -> liftIO $ fmap ThunkData_Packed <$> readPackedThunk thunkDir
308-- | Read a thunk and validate that it is exactly a packed thunk.
190-- | Read a thunk and validate that it is exactly a packed thunk.
309-- If additional data is present, fail.
191-- If additional data is present, fail.
310−readThunk :: (MonadObelisk m) => FilePath -> m (Either ReadThunkError ThunkData)
192+readPackedThunk :: FilePath -> IO (Either ReadThunkError ThunkPtr)
311−readThunk = readThunkWith thunkSpecTypes
193+readPackedThunk thunkDir = runExceptT $ do
312−
194+ let thunkLoader = thunkDir </> "default.nix"
313−parseThunkPtr :: (Aeson.Object -> Aeson.Parser ThunkSource) -> Aeson.Object -> Aeson.Parser ThunkPtr
195+ githubJson = thunkDir </> "github.json"
314−parseThunkPtr parseSrc v = do
196+ attrCache = thunkDir </> ".attr-cache"
315− rev <- v Aeson..: "rev"
197+ expectedContents = Set.fromList $
316− sha256 <- v Aeson..: "sha256"
198+ [ githubJson
317− src <- parseSrc v
199+ , thunkLoader
318− pure $ ThunkPtr
200+ ]
319− { _thunkPtr_rev = ThunkRev
201+ optionalContents = Set.fromList $
320− { _thunkRev_commit = Ref.fromHexString rev
202+ [ attrCache
321− , _thunkRev_nixSha256 = sha256
203+ ]
323− , _thunkPtr_source = src
326−parseGitHubSource :: Aeson.Object -> Aeson.Parser GitHubSource
327−parseGitHubSource v = do
328− owner <- v Aeson..: "owner"
329− repo <- v Aeson..: "repo"
330− branch <- v Aeson..:! "branch"
331− private <- v Aeson..:? "private"
333− { _gitHubSource_owner = owner
334− , _gitHubSource_repo = repo
335− , _gitHubSource_branch = branch
336− , _gitHubSource_private = fromMaybe False private
339−parseGitSource :: Aeson.Object -> Aeson.Parser GitSource
205+ -- Ensure that there aren't any other files in the thunk
340−parseGitSource v = do
206+ -- NB: System.Directory.listDirectory returns the contents without the directory path
341− Just url <- parseGitUri <$> v Aeson..: "url"
207+ files <- liftIO $ Set.fromList . fmap (thunkDir </>) <$> listDirectory thunkDir
342− branch <- v Aeson..:! "branch"
208+ let unexpectedContents = files `Set.difference` (expectedContents `Set.union` optionalContents)
343− fetchSubmodules <- v Aeson..:! "fetchSubmodules"
209+ missingContents = expectedContents `Set.difference` files
344− private <- v Aeson..:? "private"
210+ unless (Set.null unexpectedContents && Set.null missingContents) $ do
345− pure $ GitSource
211+ throwError $ ReadThunkError_WrongContents unexpectedContents missingContents
346− { _gitSource_url = url
212+
347− , _gitSource_branch = branch
213+ -- Ensure that we recognize the thunk loader
348− , _gitSource_fetchSubmodules = fromMaybe False fetchSubmodules
214+ loader <- liftIO $ T.readFile thunkLoader
349− , _gitSource_private = fromMaybe False private
215+ unless (loader `elem` gitHubStandaloneLoaders) $ do
350− }
216+ throwError $ ReadThunkError_UnrecognizedLoader loader
218+ txt <- liftIO $ LBS.readFile githubJson
219+ let parseThunk v = do
220+ rev <- v Aeson..: "rev"
221+ sha256 <- v Aeson..: "sha256"
222+ src <- parseGitHubSource v
223+ <|> parseGitSource v
225+ { _thunkPtr_rev = ThunkRev
226+ { _thunkRev_commit = Ref.fromHexString rev
227+ , _thunkRev_nixSha256 = sha256
229+ , _thunkPtr_source = src
231+ parseGitHubSource v = do
232+ owner <- v Aeson..: "owner"
233+ repo <- v Aeson..: "repo"
234+ branch <- v Aeson..:! "branch"
235+ mPrivate <- v Aeson..:! "private"
236+ return $ ThunkSource_GitHub $ GitHubSource
237+ { _gitHubSource_owner = owner
238+ , _gitHubSource_repo = repo
239+ , _gitHubSource_branch = branch
240+ , _gitHubSource_private = fromMaybe False mPrivate
242+ parseGitSource v = do
243+ Just url <- parseURI <$> v Aeson..: "url"
244+ branch <- v Aeson..:! "branch"
245+ fetchSubmodules <- v Aeson..: "fetchSubmodules"
246+ return $ ThunkSource_Git $ GitSource
247+ { _gitSource_url = url
248+ , _gitSource_branch = branch
249+ , _gitSource_fetchSubmodules = fetchSubmodules
251+ case parseMaybe parseThunk =<< decode txt of
252+ Nothing -> throwError $ ReadThunkError_UnparseablePtr txt
253+ Just ptr -> return ptr
352overwriteThunk :: MonadObelisk m => FilePath -> ThunkPtr -> m ()
255overwriteThunk :: MonadObelisk m => FilePath -> ThunkPtr -> m ()
353overwriteThunk target thunk = do
256overwriteThunk target thunk = do
354 -- Ensure that this directory is a valid thunk (i.e. so we aren't losing any data)
257 -- Ensure that this directory is a valid thunk (i.e. so we aren't losing any data)
355− readThunk target >>= \case
258+ Right _ <- readThunk target
356− Left e -> failWith [i|Invalid thunk at ${target}: ${e}|]
359 --TODO: Is there a safer way to do this overwriting?
260 --TODO: Is there a safer way to do this overwriting?
360− liftIO $ removePathForcibly target
261+ liftIO $ removeDirectoryRecursive target
361− createThunk target $ Right thunk
262+ liftIO $ createThunk target thunk
363−thunkPtrToSpec :: ThunkPtr -> ThunkSpec
264+thunkPtrLoader :: ThunkPtr -> Text
364−thunkPtrToSpec thunk = case _thunkPtr_source thunk of
265+thunkPtrLoader thunk = case _thunkPtr_source thunk of
365− ThunkSource_GitHub _ -> NonEmpty.head gitHubThunkSpecs
266+ ThunkSource_GitHub _ -> NonEmpty.head gitHubStandaloneLoaders
366− ThunkSource_Git _ -> NonEmpty.head gitThunkSpecs
267+ ThunkSource_Git _ -> NonEmpty.head plainGitStandaloneLoaders
368-- It's important that formatting be very consistent here, because
269-- It's important that formatting be very consistent here, because
369-- otherwise when people update thunks, their patches will be messy
270-- otherwise when people update thunks, their patches will be messy
@@ -372,18 +273,21 @@ encodeThunkPtrData (ThunkPtr rev src) = case src of
372 ThunkSource_GitHub s -> encodePretty' githubCfg $ Aeson.object $ catMaybes
273 ThunkSource_GitHub s -> encodePretty' githubCfg $ Aeson.object $ catMaybes
373 [ Just $ "owner" .= _gitHubSource_owner s
274 [ Just $ "owner" .= _gitHubSource_owner s
374 , Just $ "repo" .= _gitHubSource_repo s
275 , Just $ "repo" .= _gitHubSource_repo s
375− , ("branch" .=) <$> _gitHubSource_branch s
276+ , case _gitHubSource_branch s of
277+ Just b -> Just $ "branch" .= b
279+ , if _gitHubSource_private s
280+ then Just $ "private" .= True
376 , Just $ "rev" .= Ref.toHexString (_thunkRev_commit rev)
282 , Just $ "rev" .= Ref.toHexString (_thunkRev_commit rev)
377 , Just $ "sha256" .= _thunkRev_nixSha256 rev
283 , Just $ "sha256" .= _thunkRev_nixSha256 rev
378− , Just $ "private" .= _gitHubSource_private s
380 ThunkSource_Git s -> encodePretty' plainGitCfg $ Aeson.object $ catMaybes
285 ThunkSource_Git s -> encodePretty' plainGitCfg $ Aeson.object $ catMaybes
381− [ Just $ "url" .= gitUriToText (_gitSource_url s)
286+ --TODO: Is this safe? read/show is jank for `URI`
287+ [ Just $ "url" .= show (_gitSource_url s)
382 , Just $ "rev" .= Ref.toHexString (_thunkRev_commit rev)
288 , Just $ "rev" .= Ref.toHexString (_thunkRev_commit rev)
383− , ("branch" .=) <$> _gitSource_branch s
384 , Just $ "sha256" .= _thunkRev_nixSha256 rev
289 , Just $ "sha256" .= _thunkRev_nixSha256 rev
385 , Just $ "fetchSubmodules" .= _gitSource_fetchSubmodules s
290 , Just $ "fetchSubmodules" .= _gitSource_fetchSubmodules s
386− , Just $ "private" .= _gitSource_private s
389 githubCfg = defConfig
293 githubCfg = defConfig
@@ -404,84 +308,54 @@ encodeThunkPtrData (ThunkPtr rev src) = case src of
406 , "sha256"
310 , "sha256"
408 , "fetchSubmodules"
311 , "fetchSubmodules"
409 ] <> compare
312 ] <> compare
410 , confTrailingNewline = True
313 , confTrailingNewline = True
413−createThunk :: MonadObelisk m => FilePath -> Either ThunkSpec ThunkPtr -> m ()
316+createThunk :: FilePath -> ThunkPtr -> IO ()
414−createThunk target ptrInfo =
317+createThunk target thunk = do
415− ifor_ (_thunkSpec_files spec) $ \path -> \case
318+ createDirectoryIfMissing True (target </> ".attr-cache")
416− ThunkFileSpec_FileMatches content -> withReadyPath path $ \p -> liftIO $ T.writeFile p content
319+ T.writeFile (target </> "default.nix") (thunkPtrLoader thunk)
417− ThunkFileSpec_Ptr _ -> case ptrInfo of
320+ LBS.writeFile (target </> "github.json") (encodeThunkPtrData thunk)
418− Left _ -> pure () -- We can't write the ptr without it
419− Right ptr -> withReadyPath path $ \p -> liftIO $ LBS.writeFile p (encodeThunkPtrData ptr)
422− spec = either id thunkPtrToSpec ptrInfo
423− withReadyPath path f = do
424− let fullPath = target </> path
425− putLog Debug $ "Writing thunk file " <> T.pack fullPath
426− liftIO $ createDirectoryIfMissing True $ takeDirectory fullPath
429−createThunkWithLatest :: MonadObelisk m => FilePath -> ThunkSource -> m ()
322+createThunkWithLatest :: FilePath -> ThunkSource -> IO ()
430createThunkWithLatest target s = do
323createThunkWithLatest target s = do
431 rev <- getLatestRev s
324 rev <- getLatestRev s
432− createThunk target $ Right $ ThunkPtr
325+ createThunk target $ ThunkPtr
433 { _thunkPtr_source = s
326 { _thunkPtr_source = s
434 , _thunkPtr_rev = rev
327 , _thunkPtr_rev = rev
437−updateThunkToLatest :: MonadObelisk m => ThunkUpdateConfig -> FilePath -> m ()
330+updateThunkToLatest :: MonadObelisk m => FilePath -> m ()
438−updateThunkToLatest (ThunkUpdateConfig mBranch thunkConfig) target = spinner $ do
331+updateThunkToLatest target = do
439− checkThunkDirectory target
332+ (overwrite, ptr) <- readThunk target >>= \case
440− -- check to see if thunk should be updated to a specific branch or just update it's current branch
333+ Left err -> failWith $ T.pack $ "thunk update: " <> show err
441− case mBranch of
334+ Right c -> case c of
442− Nothing -> do
335+ ThunkData_Packed t -> return (target, t)
443− (overwrite, ptr) <- readThunk target >>= \case
336+ ThunkData_Checkout _ -> failWith "cannot update an unpacked thunk"
444− Left err -> failWith [i|Thunk update: ${err}|]
337+ let src = _thunkPtr_source ptr
445− Right c -> case c of
338+ rev <- liftIO $ getLatestRev src
446− ThunkData_Packed _ t -> return (target, t)
339+ overwriteThunk overwrite $ ThunkPtr
447− ThunkData_Checkout -> failWith "cannot update an unpacked thunk"
340+ { _thunkPtr_source = src
448− let src = _thunkPtr_source ptr
341+ , _thunkPtr_rev = rev
449− rev <- getLatestRev src
342+ }
450− overwriteThunk overwrite $ modifyThunkPtrByConfig thunkConfig $ ThunkPtr
451− { _thunkPtr_source = src
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
468-- | All recognized github standalone loaders, ordered from newest to oldest.
344-- | All recognized github standalone loaders, ordered from newest to oldest.
469-- This tool will only ever produce the newest one when it writes a thunk.
345-- This tool will only ever produce the newest one when it writes a thunk.
470−gitHubThunkSpecs :: NonEmpty ThunkSpec
346+gitHubStandaloneLoaders :: NonEmpty Text
471−gitHubThunkSpecs =
347+gitHubStandaloneLoaders =
472− gitHubThunkSpecV5 :|
348+ gitHubStandaloneLoaderV2 :|
473− [ gitHubThunkSpecV4
349+ [ gitHubStandaloneLoaderV1
479−gitHubThunkSpecV1 :: ThunkSpec
352+gitHubStandaloneLoaderV1 :: Text
480−gitHubThunkSpecV1 = legacyGitHubThunkSpec "github-v1"
353+gitHubStandaloneLoaderV1 = T.unlines
481− "import ((import <nixpkgs> {}).fetchFromGitHub (builtins.fromJSON (builtins.readFile ./github.json)))"
354+ [ "import ((import <nixpkgs> {}).fetchFromGitHub (builtins.fromJSON (builtins.readFile ./github.json)))"
483−gitHubThunkSpecV2 :: ThunkSpec
357+gitHubStandaloneLoaderV2 :: Text
484−gitHubThunkSpecV2 = legacyGitHubThunkSpec "github-v2" $ T.unlines
358+gitHubStandaloneLoaderV2 = T.unlines
485 [ "# DO NOT HAND-EDIT THIS FILE" --TODO: Add something about how to get more info on Obelisk, etc.
359 [ "# DO NOT HAND-EDIT THIS FILE" --TODO: Add something about how to get more info on Obelisk, etc.
486 , "import ((import <nixpkgs> {}).fetchFromGitHub ("
360 , "import ((import <nixpkgs> {}).fetchFromGitHub ("
487 , " let json = builtins.fromJSON (builtins.readFile ./github.json);"
361 , " let json = builtins.fromJSON (builtins.readFile ./github.json);"
@@ -491,171 +365,32 @@ gitHubThunkSpecV2 = legacyGitHubThunkSpec "github-v2" $ T.unlines
494−gitHubThunkSpecV3 :: ThunkSpec
368+plainGitStandaloneLoaders :: NonEmpty Text
495−gitHubThunkSpecV3 = legacyGitHubThunkSpec "github-v3" $ T.unlines
369+plainGitStandaloneLoaders =
496− [ "# DO NOT HAND-EDIT THIS FILE"
370+ plainGitStandaloneLoaderV1 :|
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)))"
514−gitHubThunkSpecV4 :: ThunkSpec
374+plainGitStandaloneLoaderV1 :: Text
515−gitHubThunkSpecV4 = legacyGitHubThunkSpec "github-v4" $ T.unlines
375+plainGitStandaloneLoaderV1 = T.unlines
516− [ "# DO NOT HAND-EDIT THIS FILE"
376+ [ $notImplemented
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)))"
526−legacyGitHubThunkSpec :: Text -> Text -> ThunkSpec
379+-- | Look for authentication info from the 'hub' command
527−legacyGitHubThunkSpec name loader = ThunkSpec name $ Map.fromList
380+getHubAuth
528− [ ("default.nix", ThunkFileSpec_FileMatches $ T.strip loader)
381+ :: Text -- ^ Domain name
529− , ("github.json" , ThunkFileSpec_Ptr parseGitHubJsonBytes)
382+ -> IO (Maybe Auth)
530− , (attrCacheFileName, ThunkFileSpec_AttrCache)
383+getHubAuth domain = do
531− , (".git", ThunkFileSpec_CheckoutIndicator)
384+ hubConfig <- getXdgDirectory XdgConfig "hub"
532− ]
385+ Yaml.decodeFile hubConfig >>= \case
533−
386+ Nothing -> return Nothing
534−gitHubThunkSpecV5 :: ThunkSpec
387+ Just v -> return $ flip parseMaybe v $ \v' -> do
535−gitHubThunkSpecV5 = mkThunkSpec "github-v5" "github.json" parseGitHubJsonBytes [here|
388+ Yaml.Array domainConfigs <- v' .: domain --TODO: Determine what multiple domainConfigs means
536−# DO NOT HAND-EDIT THIS FILE
389+ [Yaml.Object domainConfig] <- return $ toList domainConfigs
537−let fetch = { private ? false, fetchSubmodules ? false, owner, repo, rev, sha256, ... }:
390+ token <- domainConfig .: "oauth_token"
538− if !fetchSubmodules && !private then builtins.fetchTarball {
391+ return $ OAuth $ encodeUtf8 token
539− url = "https://github.com/${owner}/${repo}/archive/${rev}.tar.gz"; inherit sha256;
392+
540− } else (import <nixpkgs> {}).fetchFromGitHub {
393+--TODO: when checking something out, make a shallow clone
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
660-- | Checks a cache directory to see if there is a fresh symlink
395-- | Checks a cache directory to see if there is a fresh symlink
661-- to the result of building an attribute of a thunk.
396-- to the result of building an attribute of a thunk.
@@ -663,49 +398,42 @@ parseJsonObject p bytes = Aeson.parseEither p =<< Aeson.eitherDecode bytes
663-- and the result is symlinked into the cache.
398-- and the result is symlinked into the cache.
664nixBuildThunkAttrWithCache
399nixBuildThunkAttrWithCache
665 :: MonadObelisk m
400 :: MonadObelisk m
666− => ThunkSpec
401+ => FilePath
668 -- ^ Path to directory containing Thunk
402 -- ^ Path to directory containing Thunk
669 -> String
403 -> String
670 -- ^ Attribute to build
404 -- ^ Attribute to build
671− -> m (Maybe FilePath)
405+ -> m FilePath
672 -- ^ Symlink to cached or built nix output
406 -- ^ Symlink to cached or built nix output
673-- WARNING: If the thunk uses an impure reference such as '<nixpkgs>'
407-- WARNING: If the thunk uses an impure reference such as '<nixpkgs>'
674-- the caching mechanism will fail as it merely measures the modification
408-- the caching mechanism will fail as it merely measures the modification
675-- time of the cache link and the expression to build.
409-- time of the cache link and the expression to build.
676−nixBuildThunkAttrWithCache thunkSpec thunkDir attr = do
410+nixBuildThunkAttrWithCache thunkDir attr = do
677− latestChange <- liftIO $ do
411+ --NB: Expects thunkDir to be normalised with no trailing path separator.
678− let
412+ --This should be guaranteed by the command argument parser.
679− getModificationTimeMaybe = fmap rightToMaybe . try @IOError . getModificationTime
413+ let cacheErrHandler e
680− thunkFileNames = Map.keys $ _thunkSpec_files thunkSpec
414+ | isDoesNotExistError e = return Nothing -- expected from a cache miss
681− maximum . catMaybes <$> traverse (getModificationTimeMaybe . (thunkDir </>)) thunkFileNames
415+ | otherwise = putLog Error (T.pack $ displayException e) >> return Nothing
682−
416+ cacheDir = thunkDir </> ".attr-cache"
683− let cachePaths' = nonEmpty $ Map.keys $ Map.filter (\case ThunkFileSpec_AttrCache -> True; _ -> False) $
417+ cachePath = cacheDir </> attr <.> "out"
684− _thunkSpec_files thunkSpec
418+ liftIO $ createDirectoryIfMissing False cacheDir
685− for cachePaths' $ \cachePaths ->
419+ latestChange <- liftIO $ maximum <$> mapM (getModificationTime . (thunkDir </>)) ["default.nix", "github.json"]
686− fmap NonEmpty.head $ for cachePaths $ \cacheDir -> do
420+ cacheHit <- handle cacheErrHandler $ do
687− let
421+ cacheTime <- liftIO $ posixSecondsToUTCTime . realToFrac . modificationTime <$> getSymbolicLinkStatus cachePath
688− cachePath = thunkDir </> cacheDir </> attr <.> "out"
422+ return $ if latestChange <= cacheTime
689− cacheErrHandler e
423+ then Just cachePath
690− | isDoesNotExistError e = pure Nothing -- expected from a cache miss
424+ else Nothing
691− | otherwise = Nothing <$ putLog Error (T.pack $ displayException e)
425+ case cacheHit of
692− cacheHit <- handle cacheErrHandler $ do
426+ Just c -> return c
693− cacheTime <- liftIO $ posixSecondsToUTCTime . realToFrac . modificationTime <$> getSymbolicLinkStatus cachePath
427+ Nothing -> do
694− pure $ if latestChange <= cacheTime
428+ putLog Warning $ T.pack $ mconcat [thunkDir, ": ", attr, " not cached, building ..."]
695− then Just cachePath
429+ _ <- nixBuild $ def
696− else Nothing
430+ { _nixBuildConfig_target = Target
697− case cacheHit of
431+ { _target_path = thunkDir
698− Just c -> pure c
432+ , _target_attr = Just attr
700− putLog Warning $ T.pack $ mconcat [thunkDir, ": ", attr, " not cached, building ..."]
434+ , _nixBuildConfig_outLink = OutLink_IndirectRoot cachePath
701− liftIO $ createDirectoryIfMissing True (takeDirectory cachePath)
435+ }
702− (cachePath <$) $ nixCmd $ NixCmd_Build $ def
436+ return cachePath
703− & nixBuildConfig_outLink .~ OutLink_IndirectRoot cachePath
704− & nixCmdConfig_target .~ Target
705− { _target_path = Just thunkDir
706− , _target_attr = Just attr
707− , _target_expr = Nothing
710-- | Build a nix attribute, and cache the result if possible
438-- | Build a nix attribute, and cache the result if possible
711nixBuildAttrWithCache
439nixBuildAttrWithCache
@@ -716,476 +444,212 @@ nixBuildAttrWithCache
716 -- ^ Attribute to build
444 -- ^ Attribute to build
717 -> m FilePath
445 -> m FilePath
718 -- ^ Symlink to cached or built nix output
446 -- ^ Symlink to cached or built nix output
719−nixBuildAttrWithCache exprPath attr = readThunk exprPath >>= \case
447+nixBuildAttrWithCache exprPath attr = do
720− -- Only packed thunks are cached. In particular, checkouts are not.
448+ readThunk exprPath >>= \case
721− Right (ThunkData_Packed spec _) ->
449+ -- Only packed thunks are cached. in particular, checkouts are not
722− maybe build pure =<< nixBuildThunkAttrWithCache spec exprPath attr
450+ Right (ThunkData_Packed _) -> nixBuildThunkAttrWithCache exprPath attr
723− _ -> build
451+ _ -> nixBuild $ def
724− where
452+ { _nixBuildConfig_target = Target
725− build = nixCmd $ NixCmd_Build $ def
453+ { _target_path = exprPath
726− & nixBuildConfig_outLink .~ OutLink_None
727− & nixCmdConfig_target .~ Target
728− { _target_path = Just exprPath
729 , _target_attr = Just attr
454 , _target_attr = Just attr
730− , _target_expr = Nothing
456+ , _nixBuildConfig_outLink = OutLink_None
733−-- | Safely update thunk using a custom action
459+unpackThunk
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'
746− copyThunkToTmp tmpDir thunkDir = readThunk thunkDir >>= \case
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}|]
782− --TODO: Overwrite option that rechecks out thunk; force option to do so even if working directory is dirty
783− Right ThunkData_Checkout -> failWith [i|Thunk at ${thunkDir} is already unpacked|]
784− Right (ThunkData_Packed _ tptr) -> do
785− let (thunkParent, thunkName) = splitFileName thunkDir
786− withTempDirectory thunkParent thunkName $ \tmpThunk -> do
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
797− let normalizeMore = dropTrailingPathSeparator . normalise
798− when (normalizeMore unpackedPath /= normalizeMore tmpThunk) $ -- Only write meta data if the checkout is not inplace
799− createThunk tmpThunk $ Left newSpec
802− removePathForcibly thunkDir
803− renameDirectory tmpThunk thunkDir
805−gitCloneForThunkUnpack
806 :: MonadObelisk m
460 :: MonadObelisk m
807− => GitSource -- ^ Git source to use
461+ => FilePath
808− -> Ref hash -- ^ Commit hash to reset to
809− -> FilePath -- ^ Directory to clone into
811−gitCloneForThunkUnpack gitSrc commit dir = do
463+unpackThunk thunkDir = readThunk thunkDir >>= \case
812− let git = callProcessAndLogOutput (Notice, Notice) . gitProc dir
464+ Left err -> failWith $ "thunk unpack: " <> (T.pack $ show err)
813− git $ [ "clone" ]
465+ --TODO: Overwrite option that rechecks out thunk; force option to do so even if working directory is dirty
814− ++ ["--recursive" | _gitSource_fetchSubmodules gitSrc]
466+ Right (ThunkData_Checkout _) -> failWith "thunk unpack: thunk is already unpacked"
815− ++ [ T.unpack $ gitUriToText $ _gitSource_url gitSrc ]
467+ Right (ThunkData_Packed tptr) -> case _thunkPtr_source tptr of
816− ++ do branch <- maybeToList $ _gitSource_branch gitSrc
468+ ThunkSource_GitHub s | (thunkParent, thunkName) <- splitFileName thunkDir -> withTempDirectory thunkParent thunkName $ \tmpRepo -> do
817− [ "--branch", T.unpack $ untagName branch ]
469+ mauth <- liftIO $ getHubAuth "github.com"
818− git ["reset", "--hard", Ref.toHexString commit]
470+ repoResult <- liftIO $ executeRequestMaybe mauth $ repositoryR (_gitHubSource_owner s) (_gitHubSource_repo s)
819− when (_gitSource_fetchSubmodules gitSrc) $
471+ githubURI <- liftIO $ either throwIO (return . repoSshUrl) repoResult >>= \case
820− git ["submodule", "update", "--recursive", "--init"]
472+ Nothing -> fail "Cannot determine clone URI for thunk source"
821−
473+ Just c -> return $ T.unpack $ getUrl c
474+ withSpinner ("Retrieving thunk " <> T.pack thunkName <> " from GitHub") $ do
475+ callProcessAndLogOutput (Notice, Notice) $
476+ proc "hub" ["clone", "-n", githubURI, tmpRepo]
477+ let obGitDir = tmpRepo </> ".git" </> "obelisk"
478+ --If this directory already exists then something is weird and we should fail
479+ liftIO $ createDirectory obGitDir
480+ callProcessAndLogOutput (Notice, Error) $
481+ cp ["-r", "-T", thunkDir </> ".", obGitDir </> "orig-thunk"]
482+ withSpinner ("Preparing thunk in " <> T.pack thunkDir) $ do
484+ putLog Notice $ "Checking out " <> T.pack (show $ maybe "" untagName $ _gitHubSource_branch s)
485+ callProcessAndLogOutput (Notice, Notice) $
489+ , maybe [] (\n -> ["-B", T.unpack (untagName n)]) (_gitHubSource_branch s)
490+ , pure $ Ref.toHexString $ _thunkRev_commit $ _thunkPtr_rev tptr
492+ -- Set upstream branch
493+ forM_ (_gitHubSource_branch s) $ \branch ->
494+ callProcessAndLogOutput (Notice, Error) $
495+ proc "hub" ["-C", tmpRepo, "branch", "-u", "origin/" <> T.unpack (untagName branch)]
496+ callProcessAndLogOutput (Notice, Error) $
497+ proc "rm" ["-r", thunkDir]
498+ callProcessAndLogOutput (Notice, Error) $
499+ procWithPackages ["coreutils"] "mv"
504+ ThunkSource_Git _s -> do
507+--TODO: add force mode to pack even if changes are present
822--TODO: add a rollback mode to pack to the original thunk
508--TODO: add a rollback mode to pack to the original thunk
823−packThunk :: MonadObelisk m => ThunkPackConfig -> FilePath -> m ThunkPtr
509+packThunk
824−packThunk = packThunk' False
510+ :: MonadObelisk m
826−packThunk' :: MonadObelisk m => Bool -> ThunkPackConfig -> FilePath -> m ThunkPtr
512+ -> String
827−packThunk' noTrail (ThunkPackConfig force thunkConfig) thunkDir = checkThunkDirectory thunkDir *> readThunk thunkDir >>= \case
513+ -> m ()
828− Right ThunkData_Packed{} -> failWith [i|Thunk at ${thunkDir} is is already packed|]
514+packThunk thunkDir upstream = readThunk thunkDir >>= \case
829− _ -> withSpinner'
515+ Left err -> failWith $ T.pack $ "thunk pack: " <> show err
830− ("Packing thunk " <> T.pack thunkDir)
516+ Right (ThunkData_Packed _) -> failWith "pack: thunk is already packed"
831− (finalMsg noTrail $ const $ "Packed thunk " <> T.pack thunkDir) $
517+ Right (ThunkData_Checkout _) -> do
832− do
518+ thunkPtr <- getThunkPtr thunkDir upstream
833− let checkClean = if force then CheckClean_NoCheck else CheckClean_FullCheck
519+ liftIO $ callProcess "rm"
834− thunkPtr <- modifyThunkPtrByConfig thunkConfig <$> getThunkPtr checkClean thunkDir (_thunkConfig_private thunkConfig)
520+ [ "-rf"
835− liftIO $ removePathForcibly thunkDir
521+ , 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."
892− -- Get information on all branches and their (optional) designated upstream
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
945− let ahead = length $ [ () | Just ('<', _) <- T.uncons <$> stat ]
946− behind = length $ [ () | Just ('>', _) <- T.uncons <$> stat ]
947− pure (upstream, (ahead, behind))
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
953− when (not $ Map.null nonGood) $ failWith $ T.unlines $
954− [ "thunk pack: Certain branches in the thunk have commits not yet pushed upstream:"
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]) ++
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.)"
963−
523+ withSpinner ("Packing thunk " <> T.pack thunkDir) $
964− when checkClean $ do
524+ liftIO $ createThunk thunkDir thunkPtr
965− -- We assume it's safe to pack the thunk at this point
525+
966− putLog Informational "All changes safe in git remotes. OK to pack thunk."
526+getThunkPtr :: MonadObelisk m => FilePath -> String -> m ThunkPtr
967−
527+getThunkPtr thunkDir upstream = do
968− let remote = maybe "origin" snd $ flip Map.lookup headUpstream =<< mCurrentBranch
528+ liftIO (checkGitCleanStatus thunkDir) >>= \case
970− [remoteUri'] <- fmap T.lines $ readGitProcess thunkDir
530+ statusDebug <- liftIO $ fmap (T.strip . T.pack) $ readProcess "hub"
971− [ "config"
531+ [ "-C", thunkDir, "status", "--ignored" ] ""
972− , "--get"
532+ putLog Warning "cannot proceed with unsaved working copy (git status):"
973− , "remote." <> T.unpack remote <> ".url"
533+ putLog Notice statusDebug
974− ]
534+ failWith "thunk pack: thunk checkout contains unsaved modifications"
975−
535+ True -> return ()
976− remoteUri <- case parseGitUri remoteUri' of
536+
977− Nothing -> failWith $ "Could not identify git remote: " <> remoteUri'
537+ -- Check whether there are any stashes
978− Just uri -> pure uri
538+ stashOutput <- liftIO $ fmap T.pack $ readProcess "hub" [ "-C", thunkDir, "stash", "list" ] ""
979− uriThunkPtr remoteUri mPrivate mCurrentBranch mCurrentCommit
539+ case T.null stashOutput of
981−-- | Get the latest revision available from the given source
541+ failWith $ T.unlines $
982−getLatestRev :: MonadObelisk m => ThunkSource -> m ThunkRev
542+ [ "thunk pack: thunk checkout has stashes"
983−getLatestRev os = do
543+ , "git stash list:"
984− let gitS = thunkSourceToGitSource os
544+ ] ++ T.lines stashOutput
985− (_, commit) <- gitGetCommitBranch (_gitSource_url gitS) (untagName <$> _gitSource_branch gitS)
545+ True -> return ()
987− ThunkSource_GitHub s -> githubThunkRev s commit
547+ --Check whether all local heads are pushed
988− ThunkSource_Git s -> gitThunkRev s commit
548+ repoHeads <- liftIO $ lines <$> readProcess "hub"
989−
549+ [ "-C", thunkDir
990−-- | Convert a URI to a thunk
550+ , "for-each-ref", "--format=%(refname:short)", "refs/heads/"
992−-- If the URL is a github URL, we try to just download an archive for
552+ remotes <- liftIO $ lines <$> readProcess "hub" [ "-C", thunkDir, "remote" ] ""
993−-- performance. If that doesn't work (e.g. authentication issue), we fall back
553+ --Check that the upstream specified actually exists
994−-- on just doing things the normal way for git repos in general, and save it as
554+ case L.find (== upstream) remotes of
995−-- a regular git thunk.
555+ Nothing -> failWith $ T.pack $ "thunk pack: upstream " <> upstream <> " does not exist. Available upstreams are " <> L.intercalate ", " remotes
996−uriThunkPtr :: MonadObelisk m => GitUri -> Maybe Bool -> Maybe Text -> Maybe Text -> m ThunkPtr
556+ Just _ -> return ()
997−uriThunkPtr uri mPrivate mbranch mcommit = do
557+ -- iterate over cartesian product
998− commit <- case mcommit of
558+ forM_ repoHeads $ \hd -> do
999− Nothing -> gitGetCommitBranch uri mbranch >>= return . snd
559+ [localRev] <- liftIO $ lines <$> readProcess "hub" [ "-C", thunkDir, "rev-parse", hd ] ""
1000− (Just c) -> return c
560+ forM_ remotes $ \rm -> do
1001− (src, rev) <- uriToThunkSource uri mPrivate mbranch >>= \case
561+ --TODO: The error you get if a branch isn't pushed anywhere could be made more user friendly
1002− ThunkSource_GitHub s -> do
562+ [remoteMergeRev] <- liftIO $ lines <$> readProcess "hub"
1003− rev <- runExceptT $ githubThunkRev s commit
563+ [ "-C", thunkDir
1004− case rev of
564+ , "merge-base"
1005− Right r -> pure (ThunkSource_GitHub s, r)
565+ , localRev
1006− Left e -> do
566+ , "remotes/" <> rm <> "/" <> hd
1007− putLog Warning "\
567+ ] ""
1008−\Failed to fetch archive from GitHub. This is probably a private repo. \
568+ case remoteMergeRev == localRev of
1009−\Falling back on normal fetchgit. Original failure:"
569+ False -> failWith $ T.pack $ mconcat [ "thunk unpack: branch ", hd, " has not been pushed to ", rm ]
1010− errorToWarning e
570+ True -> return ()
1011− let s' = forgetGithub True s
571+
1012− (,) (ThunkSource_Git s') <$> gitThunkRev s' commit
572+ --We assume it's safe to pack the thunk at this point
1013− ThunkSource_Git s -> (,) (ThunkSource_Git s) <$> gitThunkRev s commit
573+ [remoteUri'] <- liftIO $ lines <$> readProcess "hub"
1014− pure $ ThunkPtr
574+ [ "-C", thunkDir
1015− { _thunkPtr_rev = rev
575+ , "config", "--get", "remote." <> upstream <> ".url"
1016− , _thunkPtr_source = src
576+ ] ""
1018−
578+ let uriParseFailure = "Could not identify git remote: " <> remoteUri'
1019−-- | N.B. Cannot infer all fields.
579+ mRemoteUri = parseURIReference remoteUri'
1020−--
580+ <|> parseSshShorthand remoteUri'
1021−-- If the thunk is a GitHub thunk and fails, we do *not* fall back like with
581+ case mRemoteUri of
1022−-- `uriThunkPtr`. Unlike a plain URL, a thunk src explicitly states which method
582+ Nothing -> failWith $ T.pack uriParseFailure
1023−-- should be employed, and so we respect that.
583+ Just remoteUri -> liftIO $ do
1024−uriToThunkSource :: MonadObelisk m => GitUri -> Maybe Bool -> Maybe Text -> m ThunkSource
584+ refs <- fmap (refsToTuples . words) . lines <$> readProcess "hub"
1025−uriToThunkSource (GitUri u) mPrivate
585+ [ "-C"
1026− | Right uriAuth <- URI.uriAuthority u
586+ , thunkDir
1027− , Just scheme <- URI.unRText <$> URI.uriScheme u
587+ , "show-ref"
1028− , case scheme of
588+ , "--head" ] ""
1029− "ssh" -> uriAuth == URI.Authority
589+ -- safe because exactly one hash is associated with HEAD
1030− { URI.authUserInfo = Just $ URI.UserInfo (fromRight' $ URI.mkUsername "git") Nothing
590+ let Just currentHead = fst <$> L.find ((== "HEAD") . snd) refs
1031− , URI.authHost = fromRight' $ URI.mkHost "github.com"
591+ remoteHeads = Map.fromList $ catMaybes $ fmap
1032− , URI.authPort = Nothing
592+ (\(x,y) -> (,) x <$> L.stripPrefix ("refs/remotes/" <> upstream <> "/") y)
594+ localHeads = Map.fromList $ catMaybes $ fmap
595+ (\(x,y) -> (,) x <$> L.stripPrefix "refs/heads/" y)
597+ currentUpstreamBranch = Map.lookup currentHead remoteHeads
598+ <|> Map.lookup currentHead localHeads
600+ | isGithubThunk remoteUri -> githubThunkPtr remoteUri currentHead currentUpstreamBranch
601+ | otherwise -> gitThunkPtr remoteUri currentHead currentUpstreamBranch
603+ refsToTuples [x, y] = (x, y)
604+ refsToTuples x = error $ "thunk pack: cannot parse ref " <> show x
606+ | Just uriAuth <- uriAuthority u
607+ = case uriScheme u of
608+ "ssh:" -> uriAuth == URIAuth "git@" "github.com" ""
609+ s -> s `L.elem` [ "git:", "https:", "http:" ] -- "http:" just redirects to "https:"
610+ && uriRegName uriAuth == "github.com"
612+ githubThunkPtr u commit' branch' = do
613+ ["/", owner', repo'] <- return $ splitDirectories (uriPath u)
614+ let owner = N (T.pack owner')
615+ repo = N (T.pack (dropExtension repo'))
616+ commit = N (T.pack commit')
617+ branch = N . T.pack <$> branch'
618+ mauth <- getHubAuth "github.com"
619+ repoResult <- executeRequestMaybe mauth $ repositoryR owner repo
620+ repoIsPrivate <- either throwIO (return . repoPrivate) repoResult
621+ archiveResult <- executeRequestMaybe mauth $
622+ archiveForR owner repo ArchiveFormatTarball (Just (untagName commit))
623+ archiveUri <- either throwIO return archiveResult
624+ hash <- getNixSha256ForUriUnpacked archiveUri
626+ { _thunkPtr_rev = ThunkRev
627+ { _thunkRev_commit = commitNameToRef commit
628+ , _thunkRev_nixSha256 = hash
1034− s -> s `L.elem` [ "git", "https", "http" ] -- "http:" just redirects to "https:"
630+ , _thunkPtr_source = ThunkSource_GitHub $ GitHubSource
1035− && URI.unRText (URI.authHost uriAuth) == "github.com"
631+ { _gitHubSource_owner = owner
1036− , Just (_, owner :| [repoish]) <- URI.uriPath u
632+ , _gitHubSource_repo = repo
1037− = \mbranch -> do
633+ , _gitHubSource_branch = branch
1038− isPrivate <- getIsPrivate
634+ , _gitHubSource_private = repoIsPrivate
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
1084−
637+ gitThunkPtr u _commit' _branch' = do
1085−-- Funny signature indicates no effects depend on the optional branch name.
638+ case uriScheme u of
1086−githubThunkRev
639+ "https:" -> return ()
1087− :: forall m
640+ "git:" -> return ()
1088− . MonadObelisk m
641+ _ -> fail "thunk pack: obelisk currently only supports https and git protocols for non-GitHub remotes"
1089− => GitHubSource
642+ $notImplemented
1090− -> Text
643+ parseSshShorthand uri' = do
1091− -> m ThunkRev
644+ -- This is what git does to check that the remote
1092−githubThunkRev s commit = do
645+ -- is not a local file path when parsing shorthand.
1093− owner <- forcePP $ _gitHubSource_owner s
646+ -- Last referenced from here:
1094− repo <- forcePP $ _gitHubSource_repo s
647+ -- https://github.com/git/git/blob/95ec6b1b3393eb6e26da40c565520a8db9796e9f/connect.c#L712
1095− revTarball <- URI.mkPathPiece $ commit <> ".tar.gz"
648+ let uri = T.pack uri'
1096− let archiveUri = GitUri $ URI.URI
649+ (authAndHostname, colonAndPath) = T.break (== ':') uri
1097− { URI.uriScheme = Just $ fromRight' $ URI.mkScheme "https"
650+ properUri = "ssh://" <> authAndHostname <> "/" <> T.drop 1 colonAndPath
1098− , URI.uriAuthority = Right $ URI.Authority
651+ -- Shorthand is valid iff a colon is present and it occurs before the first slash
1099− { URI.authUserInfo = Nothing
652+ -- This check is used to disambiguate a filepath containing a colon from shorthand
1100− , URI.authHost = fromRight' $ URI.mkHost "github.com"
653+ guard $ isNothing (T.findIndex (=='/') authAndHostname)
1101− , URI.authPort = Nothing
654+ && not (T.null colonAndPath)
1102− }
655+ parseURI $ T.unpack properUri
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