@@ -5,71 +5,59 @@
55{-# LANGUAGE MultiWayIf #-}
66{-# LANGUAGE OverloadedStrings #-}
77{-# LANGUAGE PatternGuards #-}
8+{-# LANGUAGE QuasiQuotes #-}
89{-# LANGUAGE ScopedTypeVariables #-}
910{-# LANGUAGE TypeApplications #-}
10−module Obelisk.Command.Thunk
11− ( ThunkPtr (..)
12− , ThunkRev (..)
13− , ThunkSource (..)
14− , ThunkData (..)
15− , ReadThunkError (..)
16− , GitHubSource (..)
17− , getThunkGitBranch
18− , getLatestRev
19− , updateThunkToLatest
20− , createThunk
21− , createThunkWithLatest
22− , nixBuildAttrWithCache
23− , nixBuildThunkAttrWithCache
24− , unpackThunk
25− , packThunk
26− , readThunk
27− , updateThunk
28− , getThunkPtr
29− , parseGitUri
30− , uriThunkPtr
31− ) where
11+module Obelisk.Command.Thunk where
3212
3313import Control.Applicative
3414import Control.Exception (displayException, try)
35−import qualified Control.Lens as Lens
36−import Control.Lens.Indexed hiding ((<.>))
15+import Control.Lens (ifor, ifor_, (.~))
3716import Control.Monad
38−import Control.Monad.Catch (handle)
17+import Control.Monad.Extra (findM)
18+import Control.Monad.Catch (MonadCatch, handle)
3919import Control.Monad.Except
4020import Data.Aeson ((.=))
4121import qualified Data.Aeson as Aeson
4222import Data.Aeson.Encode.Pretty
4323import qualified Data.Aeson.Types as Aeson
24+import Data.Bifunctor (first)
4425import qualified Data.ByteString.Lazy as LBS
26+import Data.Containers.ListUtils (nubOrd)
4527import Data.Default
4628import Data.Either.Combinators (fromRight', rightToMaybe)
29+import Data.Foldable (toList)
30+import Data.Function ((&))
31+import Data.Functor ((<&>))
4732import Data.Git.Ref (Ref)
4833import qualified Data.Git.Ref as Ref
4934import qualified Data.List as L
50−import Data.List.NonEmpty (NonEmpty (..))
35+import Data.List.NonEmpty (NonEmpty (..), nonEmpty)
5136import qualified Data.List.NonEmpty as NonEmpty
5237import Data.Map (Map)
5338import qualified Data.Map as Map
5439import Data.Maybe
5540import Data.Set (Set)
5641import qualified Data.Set as Set
42+import Data.String.Here.Interpolated (i)
43+import Data.String.Here.Uninterpolated (here)
5744import Data.Text (Text)
5845import qualified Data.Text as T
5946import Data.Text.Encoding
6047import qualified Data.Text.IO as T
6148import Data.Time.Clock.POSIX (posixSecondsToUTCTime)
49+import Data.Traversable (for)
6250import Data.Yaml (parseMaybe)
6351import GitHub
6452import GitHub.Data.Name
6553import Obelisk.Command.Nix
6654import System.Directory
55+import System.Exit
6756import System.FilePath
6857import System.IO.Error
6958import System.IO.Temp
70−import System.Posix (getSymbolicLinkStatus, modificationTime)
71−import System.Process (proc)
72−import Text.URI
59+import System.PosixCompat.Files (getSymbolicLinkStatus, modificationTime)
60+import qualified Text.URI as URI
7361
7462import Obelisk.App (MonadObelisk)
7563import Obelisk.CliApp
@@ -77,11 +65,10 @@ import Obelisk.Command.Utils
7765
7866--TODO: Support symlinked thunk data
7967data ThunkData
80− = ThunkData_Packed ThunkPtr
68+ = ThunkData_Packed ThunkSpec ThunkPtr
8169 -- ^ Packed thunk
82− | ThunkData_Checkout (Maybe ThunkPtr)
70+ | ThunkData_Checkout
8371 -- ^ Checked out thunk that was unpacked from this pointer
84− deriving (Show, Eq, Ord)
8572
8673-- | A reference to the exact data that a thunk should translate into
8774data ThunkPtr = ThunkPtr
@@ -107,41 +94,72 @@ data ThunkSource
10794 | ThunkSource_Git GitSource
10895 deriving (Show, Eq, Ord)
10996
97+thunkSourceToGitSource :: ThunkSource -> GitSource
98+thunkSourceToGitSource = \case
99+ ThunkSource_GitHub s -> forgetGithub False s
100+ ThunkSource_Git s -> s
101+
110102data GitHubSource = GitHubSource
111103 { _gitHubSource_owner :: Name Owner
112104 , _gitHubSource_repo :: Name Repo
113105 , _gitHubSource_branch :: Maybe (Name Branch)
106+ , _gitHubSource_private :: Bool
114107 }
115108 deriving (Show, Eq, Ord)
116109
110+newtype GitUri = GitUri { unGitUri :: URI.URI } deriving (Eq, Ord, Show)
111+
112+gitUriToText :: GitUri -> Text
113+gitUriToText (GitUri uri)
114+ | (T.toLower . URI.unRText <$> URI.uriScheme uri) == Just "file"
115+ , Just (_, path) <- URI.uriPath uri
116+ = "/" <> T.intercalate "/" (map URI.unRText $ NonEmpty.toList path)
117+ | otherwise = URI.render uri
118+
117119data GitSource = GitSource
118− { _gitSource_url :: URI
120+ { _gitSource_url :: GitUri
119121 , _gitSource_branch :: Maybe (Name Branch)
120122 , _gitSource_fetchSubmodules :: Bool
123+ , _gitSource_private :: Bool
121124 }
122125 deriving (Show, Eq, Ord)
123126
127+newtype ThunkConfig = ThunkConfig
128+ { _thunkConfig_private :: Maybe Bool
129+ } deriving Show
130+
131+data ThunkUpdateConfig = ThunkUpdateConfig
132+ { _thunkUpdateConfig_branch :: Maybe String
133+ , _thunkUpdateConfig_config :: ThunkConfig
134+ } deriving Show
135+
136+data ThunkPackConfig = ThunkPackConfig
137+ { _thunkPackConfig_force :: Bool
138+ , _thunkPackConfig_config :: ThunkConfig
139+ } deriving Show
140+
124141-- | Convert a GitHub source to a regular Git source. Assumes no submodules.
125142forgetGithub :: Bool -> GitHubSource -> GitSource
126143forgetGithub useSsh s = GitSource
127− { _gitSource_url = URI
128− { uriScheme = Just $ fromRight' $ mkScheme $ if useSsh then "ssh" else "https"
129− , uriAuthority = Right $ Authority
130− { authUserInfo = UserInfo (fromRight' $ mkUsername "git") Nothing
144+ { _gitSource_url = GitUri $ URI.URI
145+ { URI.uriScheme = Just $ fromRight' $ URI.mkScheme $ if useSsh then "ssh" else "https"
146+ , URI.uriAuthority = Right $ URI.Authority
147+ { URI.authUserInfo = URI.UserInfo (fromRight' $ URI.mkUsername "git") Nothing
131148 <$ guard useSsh
132− , authHost = fromRight' $ mkHost "github.com"
133− , authPort = Nothing
149+ , URI.authHost = fromRight' $ URI.mkHost "github.com"
150+ , URI.authPort = Nothing
134151 }
135− , uriPath = Just ( False
136− , fromRight' . mkPathPiece <$>
152+ , URI.uriPath = Just ( False
153+ , fromRight' . URI.mkPathPiece <$>
137154 untagName (_gitHubSource_owner s)
138155 :| [ untagName (_gitHubSource_repo s) <> ".git" ]
139156 )
140− , uriQuery = []
141− , uriFragment = Nothing
157+ , URI.uriQuery = []
158+ , URI.uriFragment = Nothing
142159 }
143160 , _gitSource_branch = _gitHubSource_branch s
144161 , _gitSource_fetchSubmodules = False
162+ , _gitSource_private = _gitHubSource_private s
145163 }
146164
147165getThunkGitBranch :: ThunkPtr -> Maybe Text
@@ -155,20 +173,20 @@ commitNameToRef (N c) = Ref.fromHex $ encodeUtf8 c
155173-- TODO: Use spinner here.
156174getNixSha256ForUriUnpacked
157175 :: MonadObelisk m
158− => URI
176+ => GitUri
159177 -> m NixSha256
160178getNixSha256ForUriUnpacked uri =
161− withExitFailMessage ("nix-prefetch-url: Failed to determine sha256 hash of URL " <> render uri) $ do
179+ withExitFailMessage ("nix-prefetch-url: Failed to determine sha256 hash of URL " <> gitUriToText uri) $ do
162180 [hash] <- fmap T.lines $ readProcessAndLogOutput (Debug, Debug) $
163− proc "nix-prefetch-url" ["--unpack" , "--type" , "sha256" , T.unpack $ render uri]
181+ proc nixPrefetchUrlPath ["--unpack", "--type", "sha256", T.unpack $ gitUriToText uri]
164182 pure hash
165183
166−nixPrefetchGit :: MonadObelisk m => URI -> Text -> Bool -> m NixSha256
184+nixPrefetchGit :: MonadObelisk m => GitUri -> Text -> Bool -> m NixSha256
167185nixPrefetchGit uri rev fetchSubmodules =
168− withExitFailMessage ("nix-prefetch-git: Failed to determine sha256 hash of Git repo " <> render uri <> " at " <> rev) $ do
186+ withExitFailMessage ("nix-prefetch-git: Failed to determine sha256 hash of Git repo " <> gitUriToText uri <> " at " <> rev) $ do
169187 out <- readProcessAndLogStderr Debug $
170− proc "nix-prefetch-git" $ filter (/="")
171− [ "--url", T.unpack $ render uri
188+ proc nixPrefetchGitPath $ filter (/="")
189+ [ "--url", T.unpack $ gitUriToText uri
172190 , "--rev", T.unpack rev
173191 , if fetchSubmodules then "--fetch-submodules" else ""
174192 , "--quiet"
@@ -180,93 +198,117 @@ nixPrefetchGit uri rev fetchSubmodules =
180198
181199--TODO: Pretty print these
182200data ReadThunkError
183− = ReadThunkError_UnrecognizedFiles
184− | ReadThunkError_AmbiguousFiles
185− | ReadThunkError_UnrecognizedLoader Text
186− | ReadThunkError_UnparseablePtr LBS.ByteString
187− deriving (Show)
188−
189−-- | Read a thunk and validate that it is only a thunk, either packed or unpacked.
190−-- If the thunk is packed and additional data is present, fail.
191−readThunk :: MonadObelisk m => FilePath -> m (Either ReadThunkError ThunkData)
192−readThunk thunkDir = do
193− files <- liftIO $ listDirectory thunkDir
194− case ".git" `elem` files of
195− True -> fmap ThunkData_Checkout <$> do
196− let origThunkPath = thunkDir </> ".git" </> "obelisk" </> "orig-thunk"
197− liftIO $ doesDirectoryExist origThunkPath >>= \case
198− True -> fmap Just <$> readPackedThunk origThunkPath
199− False -> return $ return Nothing
200− False -> liftIO $ fmap ThunkData_Packed <$> readPackedThunk thunkDir
201−
202−data ThunkType = ThunkType
203− { _thunkType_loader :: FilePath
204− , _thunkType_json :: FilePath
205− , _thunkType_optional :: Set FilePath
206− , _thunkType_loaderVersions :: NonEmpty Text
207− , _thunkType_parser :: Aeson.Object -> Aeson.Parser ThunkPtr
208− }
209−
210−gitHubThunkType :: ThunkType
211−gitHubThunkType = ThunkType
212− { _thunkType_loader = "default.nix"
213− , _thunkType_json = "github.json"
214− , _thunkType_optional = Set.fromList [".attr-cache"]
215− , _thunkType_loaderVersions = gitHubStandaloneLoaders
216− , _thunkType_parser = parseThunkPtr $ \v ->
217− ThunkSource_GitHub <$> parseGitHubSource v <|> ThunkSource_Git <$> parseGitSource v
201+ = ReadThunkError_UnrecognizedThunk
202+ | ReadThunkError_UnrecognizedPaths (NonEmpty FilePath)
203+ | ReadThunkError_MissingPaths (NonEmpty FilePath)
204+ | ReadThunkError_UnparseablePtr FilePath String
205+ | ReadThunkError_FileError IOError
206+ | ReadThunkError_FileDoesNotMatch FilePath Text
207+ | ReadThunkError_UnrecognizedState String
208+ | ReadThunkError_AmbiguousPackedState ThunkPtr ThunkPtr
209+ deriving (Show)
210+
211+unpackedDirName :: FilePath
212+unpackedDirName = "."
213+
214+attrCacheFileName :: FilePath
215+attrCacheFileName = ".attr-cache"
216+
217+-- | Specification for how a file in a thunk version works.
218+data ThunkFileSpec
219+ = ThunkFileSpec_Ptr (LBS.ByteString -> Either String ThunkPtr) -- ^ This file specifies 'ThunkPtr' data
220+ | ThunkFileSpec_FileMatches Text -- ^ This file must match the given content exactly
221+ | ThunkFileSpec_CheckoutIndicator -- ^ Existence of this directory indicates that the thunk is unpacked
222+ | ThunkFileSpec_AttrCache -- ^ This directory is an attribute cache
223+
224+-- | Specification for how a set of files in a thunk version work.
225+data ThunkSpec = ThunkSpec
226+ { _thunkSpec_name :: !Text
227+ , _thunkSpec_files :: !(Map FilePath ThunkFileSpec)
218228 }
219229
220−gitThunkType :: ThunkType
221−gitThunkType = ThunkType
222− { _thunkType_loader = "default.nix"
223− , _thunkType_json = "git.json"
224− , _thunkType_optional = Set.fromList [".attr-cache"]
225− , _thunkType_loaderVersions = plainGitStandaloneLoaders
226− , _thunkType_parser = parseThunkPtr $ fmap ThunkSource_Git . parseGitSource
227− }
228−
229−thunkTypes :: [ThunkType]
230−thunkTypes = [gitThunkType, gitHubThunkType]
231−
232−findThunkType :: [ThunkType] -> FilePath -> IO (Either ReadThunkError ThunkType)
233−findThunkType types thunkDir = do
234− matches <- fmap catMaybes $ forM types $ \thunkType -> do
235− let
236− expectedContents = Set.fromList $ (thunkDir </>) <$>
237− [ _thunkType_loader thunkType
238− , _thunkType_json thunkType
239− ]
240− optionalContents = Set.map (thunkDir </>) (_thunkType_optional thunkType)
241−
242− -- Ensure that there aren't any other files in the thunk
243− -- NB: System.Directory.listDirectory returns the contents without the directory path
244− files <- liftIO $ Set.fromList . fmap (thunkDir </>) <$> listDirectory thunkDir
245− let unexpectedContents = files `Set.difference` (expectedContents `Set.union` optionalContents)
246− missingContents = expectedContents `Set.difference` files
247− pure $ if Set.null unexpectedContents && Set.null missingContents
248− then Just thunkType
249− else Nothing
250−
251− pure $ case matches of
252− [singleMatch] -> Right singleMatch
253− [] -> Left ReadThunkError_UnrecognizedFiles
254− _ -> Left ReadThunkError_AmbiguousFiles
230+thunkSpecTypes :: NonEmpty (NonEmpty ThunkSpec)
231+thunkSpecTypes = gitThunkSpecs :| [gitHubThunkSpecs]
232+
233+-- | Attempts to match a 'ThunkSpec' to a given directory.
234+matchThunkSpecToDir
235+ :: (MonadError ReadThunkError m, MonadIO m, MonadCatch m)
236+ => ThunkSpec -- ^ 'ThunkSpec' to match against the given files/directory
237+ -> FilePath -- ^ Path to directory
238+ -> Set FilePath -- ^ Set of file paths relative to the given directory
239+ -> m ThunkData
240+matchThunkSpecToDir thunkSpec dir dirFiles = do
241+ case nonEmpty (toList $ dirFiles `Set.difference` expectedPaths) of
242+ Just fs -> throwError $ ReadThunkError_UnrecognizedPaths $ (dir </>) <$> fs
243+ Nothing -> pure ()
244+ case nonEmpty (toList $ requiredPaths `Set.difference` dirFiles) of
245+ Just fs -> throwError $ ReadThunkError_MissingPaths $ (dir </>) <$> fs
246+ Nothing -> pure ()
247+ datas <- fmap toList $ flip Map.traverseMaybeWithKey (_thunkSpec_files thunkSpec) $ \expectedPath -> \case
248+ ThunkFileSpec_AttrCache -> Nothing <$ dirMayExist expectedPath
249+ ThunkFileSpec_CheckoutIndicator -> liftIO (doesDirectoryExist (dir </> expectedPath)) <&> \case
250+ False -> Nothing
251+ True -> Just ThunkData_Checkout
252+ ThunkFileSpec_FileMatches expectedContents -> handle (\(e :: IOError) -> throwError $ ReadThunkError_FileError e) $ do
253+ actualContents <- liftIO (T.readFile $ dir </> expectedPath)
254+ case T.strip expectedContents == T.strip actualContents of
255+ True -> pure Nothing
256+ False -> throwError $ ReadThunkError_FileDoesNotMatch (dir </> expectedPath) expectedContents
257+ ThunkFileSpec_Ptr parser -> handle (\(e :: IOError) -> throwError $ ReadThunkError_FileError e) $ do
258+ let path = dir </> expectedPath
259+ liftIO (doesFileExist path) >>= \case
260+ False -> pure Nothing
261+ True -> do
262+ actualContents <- liftIO $ LBS.readFile path
263+ case parser actualContents of
264+ Right v -> pure $ Just (ThunkData_Packed thunkSpec v)
265+ Left e -> throwError $ ReadThunkError_UnparseablePtr (dir </> expectedPath) e
266+
267+ case nonEmpty datas of
268+ Nothing -> throwError ReadThunkError_UnrecognizedThunk
269+ Just xs -> fold1WithM xs $ \a b -> either throwError pure (mergeThunkData a b)
270+ where
271+ rootPathsOnly = Set.fromList . mapMaybe takeRootDir . Map.keys
272+ takeRootDir = fmap NonEmpty.head . nonEmpty . splitPath
273+
274+ expectedPaths = rootPathsOnly $ _thunkSpec_files thunkSpec
275+
276+ requiredPaths = rootPathsOnly $ Map.filter isRequiredFileSpec $ _thunkSpec_files thunkSpec
277+ isRequiredFileSpec = \case
278+ ThunkFileSpec_FileMatches _ -> True
279+ _ -> False
280+
281+ dirMayExist expectedPath = liftIO (doesFileExist (dir </> expectedPath)) >>= \case
282+ True -> throwError $ ReadThunkError_UnrecognizedPaths $ expectedPath :| []
283+ False -> pure ()
284+
285+ -- Combine 'ThunkData' from different files, preferring "Checkout" over "Packed"
286+ mergeThunkData ThunkData_Checkout ThunkData_Checkout = Right ThunkData_Checkout
287+ mergeThunkData ThunkData_Checkout ThunkData_Packed{} = Left bothPackedAndUnpacked
288+ mergeThunkData ThunkData_Packed{} ThunkData_Checkout = Left bothPackedAndUnpacked
289+ mergeThunkData a@(ThunkData_Packed _ ptrA) (ThunkData_Packed _ ptrB) =
290+ if ptrA == ptrB then Right a else Left $ ReadThunkError_AmbiguousPackedState ptrA ptrB
291+
292+ bothPackedAndUnpacked = ReadThunkError_UnrecognizedState "Both packed data and checkout present"
293+
294+ fold1WithM (x :| xs) f = foldM f x xs
295+
296+readThunkWith
297+ :: (MonadObelisk m)
298+ => NonEmpty (NonEmpty ThunkSpec) -> FilePath -> m (Either ReadThunkError ThunkData)
299+readThunkWith specTypes dir = do
300+ dirFiles <- Set.fromList <$> liftIO (listDirectory dir)
301+ let specs = concatMap toList $ toList $ NonEmpty.transpose specTypes -- Interleave spec types so we try each one in a "fair" ordering
302+ flip fix specs $ \loop -> \case
303+ [] -> pure $ Left ReadThunkError_UnrecognizedThunk
304+ spec:rest -> runExceptT (matchThunkSpecToDir spec dir dirFiles) >>= \case
305+ Left e -> putLog Debug [i|Thunk specification ${_thunkSpec_name spec} did not match ${dir}: ${e}|] *> loop rest
306+ x@(Right _) -> x <$ putLog Debug [i|Thunk specification ${_thunkSpec_name spec} matched ${dir}|]
255307
256308-- | Read a thunk and validate that it is exactly a packed thunk.
257309-- If additional data is present, fail.
258−readPackedThunk :: FilePath -> IO (Either ReadThunkError ThunkPtr)
259−readPackedThunk thunkDir = runExceptT $ do
260− thunkType <- ExceptT $ findThunkType thunkTypes thunkDir
261− -- Ensure that we recognize the thunk loader
262− loader <- liftIO $ T.readFile $ thunkDir </> _thunkType_loader thunkType
263− unless (loader `elem` _thunkType_loaderVersions thunkType) $ do
264− throwError $ ReadThunkError_UnrecognizedLoader loader
265−
266− txt <- liftIO $ LBS.readFile $ thunkDir </> _thunkType_json thunkType
267− case parseMaybe (_thunkType_parser thunkType) =<< Aeson.decode txt of
268− Nothing -> throwError $ ReadThunkError_UnparseablePtr txt
269− Just ptr -> return ptr
310+readThunk :: (MonadObelisk m) => FilePath -> m (Either ReadThunkError ThunkData)
311+readThunk = readThunkWith thunkSpecTypes
270312
271313parseThunkPtr :: (Aeson.Object -> Aeson.Parser ThunkSource) -> Aeson.Object -> Aeson.Parser ThunkPtr
272314parseThunkPtr parseSrc v = do
@@ -286,10 +328,12 @@ parseGitHubSource v = do
286328 owner <- v Aeson..: "owner"
287329 repo <- v Aeson..: "repo"
288330 branch <- v Aeson..:! "branch"
331+ private <- v Aeson..:? "private"
289332 pure $ GitHubSource
290333 { _gitHubSource_owner = owner
291334 , _gitHubSource_repo = repo
292335 , _gitHubSource_branch = branch
336+ , _gitHubSource_private = fromMaybe False private
293337 }
294338
295339parseGitSource :: Aeson.Object -> Aeson.Parser GitSource
@@ -297,25 +341,29 @@ parseGitSource v = do
297341 Just url <- parseGitUri <$> v Aeson..: "url"
298342 branch <- v Aeson..:! "branch"
299343 fetchSubmodules <- v Aeson..:! "fetchSubmodules"
344+ private <- v Aeson..:? "private"
300345 pure $ GitSource
301346 { _gitSource_url = url
302347 , _gitSource_branch = branch
303348 , _gitSource_fetchSubmodules = fromMaybe False fetchSubmodules
349+ , _gitSource_private = fromMaybe False private
304350 }
305351
306352overwriteThunk :: MonadObelisk m => FilePath -> ThunkPtr -> m ()
307353overwriteThunk target thunk = do
308354 -- Ensure that this directory is a valid thunk (i.e. so we aren't losing any data)
309− Right _ <- readThunk target
355+ readThunk target >>= \case
356+ Left e -> failWith [i|Invalid thunk at ${target}: ${e}|]
357+ Right _ -> pure ()
310358
311359 --TODO: Is there a safer way to do this overwriting?
312− liftIO $ removeDirectoryRecursive target
313− liftIO $ createThunk target thunk
360+ liftIO $ removePathForcibly target
361+ createThunk target $ Right thunk
314362
315−thunkPtrLoader :: ThunkPtr -> Text
316−thunkPtrLoader thunk = case _thunkPtr_source thunk of
317− ThunkSource_GitHub _ -> NonEmpty.head gitHubStandaloneLoaders
318− ThunkSource_Git _ -> NonEmpty.head plainGitStandaloneLoaders
363+thunkPtrToSpec :: ThunkPtr -> ThunkSpec
364+thunkPtrToSpec thunk = case _thunkPtr_source thunk of
365+ ThunkSource_GitHub _ -> NonEmpty.head gitHubThunkSpecs
366+ ThunkSource_Git _ -> NonEmpty.head gitThunkSpecs
319367
320368-- It's important that formatting be very consistent here, because
321369-- otherwise when people update thunks, their patches will be messy
@@ -327,13 +375,15 @@ encodeThunkPtrData (ThunkPtr rev src) = case src of
327375 , ("branch" .=) <$> _gitHubSource_branch s
328376 , Just $ "rev" .= Ref.toHexString (_thunkRev_commit rev)
329377 , Just $ "sha256" .= _thunkRev_nixSha256 rev
378+ , Just $ "private" .= _gitHubSource_private s
330379 ]
331380 ThunkSource_Git s -> encodePretty' plainGitCfg $ Aeson.object $ catMaybes
332− [ Just $ "url" .= render (_gitSource_url s)
381+ [ Just $ "url" .= gitUriToText (_gitSource_url s)
333382 , Just $ "rev" .= Ref.toHexString (_thunkRev_commit rev)
334383 , ("branch" .=) <$> _gitSource_branch s
335384 , Just $ "sha256" .= _thunkRev_nixSha256 rev
336385 , Just $ "fetchSubmodules" .= _gitSource_fetchSubmodules s
386+ , Just $ "private" .= _gitSource_private s
337387 ]
338388 where
339389 githubCfg = defConfig
@@ -354,78 +404,84 @@ encodeThunkPtrData (ThunkPtr rev src) = case src of
354404 [ "url"
355405 , "rev"
356406 , "sha256"
407+ , "private"
357408 , "fetchSubmodules"
358409 ] <> compare
359410 , confTrailingNewline = True
360411 }
361412
362−createThunk :: MonadIO m => FilePath -> ThunkPtr -> m ()
363−createThunk target thunk = liftIO $ do
364− createDirectoryIfMissing True (target </> ".attr-cache")
365− T.writeFile (target </> "default.nix") (thunkPtrLoader thunk)
366− let
367− jsonFileName = case _thunkPtr_source thunk of
368− ThunkSource_GitHub _ -> "github"
369− ThunkSource_Git _ -> "git"
370− LBS.writeFile (target </> jsonFileName <.> "json") (encodeThunkPtrData thunk)
413+createThunk :: MonadObelisk m => FilePath -> Either ThunkSpec ThunkPtr -> m ()
414+createThunk target ptrInfo =
415+ ifor_ (_thunkSpec_files spec) $ \path -> \case
416+ ThunkFileSpec_FileMatches content -> withReadyPath path $ \p -> liftIO $ T.writeFile p content
417+ ThunkFileSpec_Ptr _ -> case ptrInfo of
418+ Left _ -> pure () -- We can't write the ptr without it
419+ Right ptr -> withReadyPath path $ \p -> liftIO $ LBS.writeFile p (encodeThunkPtrData ptr)
420+ _ -> pure ()
421+ where
422+ spec = either id thunkPtrToSpec ptrInfo
423+ withReadyPath path f = do
424+ let fullPath = target </> path
425+ putLog Debug $ "Writing thunk file " <> T.pack fullPath
426+ liftIO $ createDirectoryIfMissing True $ takeDirectory fullPath
427+ f fullPath
371428
372429createThunkWithLatest :: MonadObelisk m => FilePath -> ThunkSource -> m ()
373430createThunkWithLatest target s = do
374431 rev <- getLatestRev s
375− createThunk target $ ThunkPtr
432+ createThunk target $ Right $ ThunkPtr
376433 { _thunkPtr_source = s
377434 , _thunkPtr_rev = rev
378435 }
379436
380−updateThunkToLatest :: MonadObelisk m => FilePath -> Maybe String -> m ()
381−updateThunkToLatest target mBranch = withSpinner' ("Updating thunk " <> T.pack target <> " to latest") (pure $ const $ "Thunk " <> T.pack target <> " updated to latest") $ do
382− checkThunkDirectory "ob thunk update directory cannot be '.'" target
437+updateThunkToLatest :: MonadObelisk m => ThunkUpdateConfig -> FilePath -> m ()
438+updateThunkToLatest (ThunkUpdateConfig mBranch thunkConfig) target = spinner $ do
439+ checkThunkDirectory target
383440 -- check to see if thunk should be updated to a specific branch or just update it's current branch
384441 case mBranch of
385442 Nothing -> do
386443 (overwrite, ptr) <- readThunk target >>= \case
387− Left err -> failWith $ T.pack $ "thunk update: " <> show err
444+ Left err -> failWith [i|Thunk update: ${err}|]
388445 Right c -> case c of
389− ThunkData_Packed t -> return (target, t)
390− ThunkData_Checkout _ -> failWith "cannot update an unpacked thunk"
446+ ThunkData_Packed _ t -> return (target, t)
447+ ThunkData_Checkout -> failWith "cannot update an unpacked thunk"
391448 let src = _thunkPtr_source ptr
392449 rev <- getLatestRev src
393− overwriteThunk overwrite $ ThunkPtr
450+ overwriteThunk overwrite $ modifyThunkPtrByConfig thunkConfig $ ThunkPtr
394451 { _thunkPtr_source = src
395452 , _thunkPtr_rev = rev
396453 }
397454 Just branch -> readThunk target >>= \case
398− Left err -> failWith $ T.pack $ "thunk update: " <> show err
455+ Left err -> failWith [i|Thunk update: ${err}|]
399456 Right c -> case c of
400− ThunkData_Packed t -> case _thunkPtr_source t of
401− ThunkSource_Git tsg -> setThunk target tsg branch
402− ThunkSource_GitHub tsgh -> do
403− let tsg = forgetGithub False tsgh
404− setThunk target tsg branch
405− ThunkData_Checkout _ -> failWith $ T.pack $ "thunk located at " <> (show target) <> " is unpacked. Use ob thunk pack on the desired directory and then try ob thunk update again."
406−
407−setThunk :: MonadObelisk m => FilePath -> GitSource -> String -> m ()
408−setThunk target gs branch = do
409− newThunkPtr <- uriThunkPtr (_gitSource_url gs) (Just $ T.pack branch) Nothing
457+ ThunkData_Packed _ t -> setThunk thunkConfig target (thunkSourceToGitSource $ _thunkPtr_source t) branch
458+ ThunkData_Checkout -> failWith [i|Thunk located at ${target} is unpacked. Use 'ob thunk pack' on the desired directory and then try 'ob thunk update' again.|]
459+ where
460+ spinner = withSpinner' ("Updating thunk " <> T.pack target <> " to latest") (pure $ const $ "Thunk " <> T.pack target <> " updated to latest")
461+
462+setThunk :: MonadObelisk m => ThunkConfig -> FilePath -> GitSource -> String -> m ()
463+setThunk thunkConfig target gs branch = do
464+ newThunkPtr <- uriThunkPtr (_gitSource_url gs) (_thunkConfig_private thunkConfig) (Just $ T.pack branch) Nothing
410465 overwriteThunk target newThunkPtr
411− updateThunkToLatest target Nothing
466+ updateThunkToLatest (ThunkUpdateConfig Nothing thunkConfig) target
412467
413468-- | All recognized github standalone loaders, ordered from newest to oldest.
414469-- This tool will only ever produce the newest one when it writes a thunk.
415−gitHubStandaloneLoaders :: NonEmpty Text
416−gitHubStandaloneLoaders =
417− gitHubStandaloneLoaderV2 :|
418− [ gitHubStandaloneLoaderV3
419− , gitHubStandaloneLoaderV1
470+gitHubThunkSpecs :: NonEmpty ThunkSpec
471+gitHubThunkSpecs =
472+ gitHubThunkSpecV5 :|
473+ [ gitHubThunkSpecV4
474+ , gitHubThunkSpecV3
475+ , gitHubThunkSpecV2
476+ , gitHubThunkSpecV1
420477 ]
421478
422−gitHubStandaloneLoaderV1 :: Text
423−gitHubStandaloneLoaderV1 = T.unlines
424− [ "import ((import <nixpkgs> {}).fetchFromGitHub (builtins.fromJSON (builtins.readFile ./github.json)))"
425− ]
479+gitHubThunkSpecV1 :: ThunkSpec
480+gitHubThunkSpecV1 = legacyGitHubThunkSpec "github-v1"
481+ "import ((import <nixpkgs> {}).fetchFromGitHub (builtins.fromJSON (builtins.readFile ./github.json)))"
426482
427−gitHubStandaloneLoaderV2 :: Text
428−gitHubStandaloneLoaderV2 = T.unlines
483+gitHubThunkSpecV2 :: ThunkSpec
484+gitHubThunkSpecV2 = legacyGitHubThunkSpec "github-v2" $ T.unlines
429485 [ "# DO NOT HAND-EDIT THIS FILE" --TODO: Add something about how to get more info on Obelisk, etc.
430486 , "import ((import <nixpkgs> {}).fetchFromGitHub ("
431487 , " let json = builtins.fromJSON (builtins.readFile ./github.json);"
@@ -435,8 +491,8 @@ gitHubStandaloneLoaderV2 = T.unlines
435491 , "))"
436492 ]
437493
438−gitHubStandaloneLoaderV3 :: Text
439−gitHubStandaloneLoaderV3 = T.unlines
494+gitHubThunkSpecV3 :: ThunkSpec
495+gitHubThunkSpecV3 = legacyGitHubThunkSpec "github-v3" $ T.unlines
440496 [ "# DO NOT HAND-EDIT THIS FILE"
441497 , "let"
442498 , " fetch = { private ? false, ... }@args: if private && builtins.hasAttr \"fetchGit\" builtins"
@@ -455,22 +511,62 @@ gitHubStandaloneLoaderV3 = T.unlines
455511 , "in import (fetch (builtins.fromJSON (builtins.readFile ./github.json)))"
456512 ]
457513
458−plainGitStandaloneLoaders :: NonEmpty Text
459−plainGitStandaloneLoaders =
460− plainGitStandaloneLoaderV1 :|
461− [ plainGitStandaloneLoaderV2
514+gitHubThunkSpecV4 :: ThunkSpec
515+gitHubThunkSpecV4 = legacyGitHubThunkSpec "github-v4" $ T.unlines
516+ [ "# DO NOT HAND-EDIT THIS FILE"
517+ , "let fetch = { private ? false, fetchSubmodules ? false, owner, repo, rev, sha256, ... }:"
518+ , " if !fetchSubmodules && !private then builtins.fetchTarball {"
519+ , " url = \"https://github.com/${owner}/${repo}/archive/${rev}.tar.gz\"; inherit sha256;"
520+ , " } else (import <nixpkgs> {}).fetchFromGitHub {"
521+ , " inherit owner repo rev sha256 fetchSubmodules private;"
522+ , " };"
523+ , "in import (fetch (builtins.fromJSON (builtins.readFile ./github.json)))"
524+ ]
525+
526+legacyGitHubThunkSpec :: Text -> Text -> ThunkSpec
527+legacyGitHubThunkSpec name loader = ThunkSpec name $ Map.fromList
528+ [ ("default.nix", ThunkFileSpec_FileMatches $ T.strip loader)
529+ , ("github.json" , ThunkFileSpec_Ptr parseGitHubJsonBytes)
530+ , (attrCacheFileName, ThunkFileSpec_AttrCache)
531+ , (".git", ThunkFileSpec_CheckoutIndicator)
532+ ]
533+
534+gitHubThunkSpecV5 :: ThunkSpec
535+gitHubThunkSpecV5 = mkThunkSpec "github-v5" "github.json" parseGitHubJsonBytes [here|
536+# DO NOT HAND-EDIT THIS FILE
537+let fetch = { private ? false, fetchSubmodules ? false, owner, repo, rev, sha256, ... }:
538+ if !fetchSubmodules && !private then builtins.fetchTarball {
539+ url = "https://github.com/${owner}/${repo}/archive/${rev}.tar.gz"; inherit sha256;
540+ } else (import <nixpkgs> {}).fetchFromGitHub {
541+ inherit owner repo rev sha256 fetchSubmodules private;
542+ };
543+ json = builtins.fromJSON (builtins.readFile ./github.json);
544+in fetch json
545+|]
546+
547+parseGitHubJsonBytes :: LBS.ByteString -> Either String ThunkPtr
548+parseGitHubJsonBytes = parseJsonObject $ parseThunkPtr $ \v ->
549+ ThunkSource_GitHub <$> parseGitHubSource v <|> ThunkSource_Git <$> parseGitSource v
550+
551+gitThunkSpecs :: NonEmpty ThunkSpec
552+gitThunkSpecs =
553+ gitThunkSpecV5 :|
554+ [ gitThunkSpecV4
555+ , gitThunkSpecV3
556+ , gitThunkSpecV2
557+ , gitThunkSpecV1
462558 ]
463559
464−plainGitStandaloneLoaderV1 :: Text
465−plainGitStandaloneLoaderV1 = T.unlines
560+gitThunkSpecV1 :: ThunkSpec
561+gitThunkSpecV1 = legacyGitThunkSpec "git-v1" $ T.unlines
466562 [ "# DO NOT HAND-EDIT THIS FILE"
467563 , "let fetchGit = {url, rev, ref ? null, branch ? null, sha256 ? null, fetchSubmodules ? null}:"
468564 , " assert !fetchSubmodules; (import <nixpkgs> {}).fetchgit { inherit url rev sha256; };"
469565 , "in import (fetchGit (builtins.fromJSON (builtins.readFile ./git.json)))"
470566 ]
471567
472−plainGitStandaloneLoaderV2 :: Text
473−plainGitStandaloneLoaderV2 = T.unlines
568+gitThunkSpecV2 :: ThunkSpec
569+gitThunkSpecV2 = legacyGitThunkSpec "git-v2" $ T.unlines
474570 [ "# DO NOT HAND-EDIT THIS FILE"
475571 , "let fetchGit = {url, rev, ref ? null, branch ? null, sha256 ? null, fetchSubmodules ? null}:"
476572 , " if builtins.hasAttr \"fetchGit\" builtins"
@@ -479,10 +575,87 @@ plainGitStandaloneLoaderV2 = T.unlines
479575 , "in import (fetchGit (builtins.fromJSON (builtins.readFile ./git.json)))"
480576 ]
481577
482−thunkFileNames :: [FilePath]
483−thunkFileNames = ["default.nix", "github.json", "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"
587+ , " else url;"
588+ , " in if !fetchSubmodules && private then builtins.fetchGit {"
589+ , " url = realUrl; inherit rev;"
590+ , " } else (import <nixpkgs> {}).fetchgit {"
591+ , " url = realUrl; inherit rev sha256;"
592+ , " };"
593+ , "in import (fetch (builtins.fromJSON (builtins.readFile ./git.json)))"
594+ ]
595+
596+gitThunkSpecV4 :: ThunkSpec
597+gitThunkSpecV4 = legacyGitThunkSpec "git-v4" $ T.unlines
598+ [ "# DO NOT HAND-EDIT THIS FILE"
599+ , "let fetch = {url, rev, branch ? null, sha256 ? null, fetchSubmodules ? false, private ? false, ...}:"
600+ , " let realUrl = let firstChar = builtins.substring 0 1 url; in"
601+ , " if firstChar == \"/\" then /. + url"
602+ , " else if firstChar == \".\" then ./. + url"
603+ , " else url;"
604+ , " in if !fetchSubmodules && private then builtins.fetchGit {"
605+ , " url = realUrl; inherit rev;"
606+ , " ${if branch == null then null else \"ref\"} = branch;"
607+ , " } else (import <nixpkgs> {}).fetchgit {"
608+ , " url = realUrl; inherit rev sha256;"
609+ , " };"
610+ , "in import (fetch (builtins.fromJSON (builtins.readFile ./git.json)))"
611+ ]
484612
485−--TODO: when checking something out, make a shallow clone
613+legacyGitThunkSpec :: Text -> Text -> ThunkSpec
614+legacyGitThunkSpec name loader = ThunkSpec name $ Map.fromList
615+ [ ("default.nix", ThunkFileSpec_FileMatches $ T.strip loader)
616+ , ("git.json" , ThunkFileSpec_Ptr parseGitJsonBytes)
617+ , (attrCacheFileName, ThunkFileSpec_AttrCache)
618+ , (".git", ThunkFileSpec_CheckoutIndicator)
619+ ]
620+
621+gitThunkSpecV5 :: ThunkSpec
622+gitThunkSpecV5 = mkThunkSpec "git-v5" "git.json" parseGitJsonBytes [here|
623+# DO NOT HAND-EDIT THIS FILE
624+let fetch = {url, rev, branch ? null, sha256 ? null, fetchSubmodules ? false, private ? false, ...}:
625+ let realUrl = let firstChar = builtins.substring 0 1 url; in
626+ if firstChar == "/" then /. + url
627+ else if firstChar == "." then ./. + url
628+ else url;
629+ in if !fetchSubmodules && private then builtins.fetchGit {
630+ url = realUrl; inherit rev;
631+ ${if branch == null then null else "ref"} = branch;
632+ } else (import <nixpkgs> {}).fetchgit {
633+ url = realUrl; inherit rev sha256;
634+ };
635+ json = builtins.fromJSON (builtins.readFile ./git.json);
636+in fetch json
637+|]
638+
639+parseGitJsonBytes :: LBS.ByteString -> Either String ThunkPtr
640+parseGitJsonBytes = parseJsonObject $ parseThunkPtr $ fmap ThunkSource_Git . parseGitSource
641+
642+mkThunkSpec :: Text -> FilePath -> (LBS.ByteString -> Either String ThunkPtr) -> Text -> ThunkSpec
643+mkThunkSpec name jsonFileName parser srcNix = ThunkSpec name $ Map.fromList
644+ [ ("default.nix", ThunkFileSpec_FileMatches defaultNixViaSrc)
645+ , ("thunk.nix", ThunkFileSpec_FileMatches srcNix)
646+ , (jsonFileName, ThunkFileSpec_Ptr parser)
647+ , (attrCacheFileName, ThunkFileSpec_AttrCache)
648+ , (normalise $ unpackedDirName </> ".git", ThunkFileSpec_CheckoutIndicator)
649+ ]
650+ where
651+ defaultNixViaSrc = [here|
652+# DO NOT HAND-EDIT THIS FILE
653+import (import ./thunk.nix)
654+|]
655+
656+
657+parseJsonObject :: (Aeson.Object -> Aeson.Parser a) -> LBS.ByteString -> Either String a
658+parseJsonObject p bytes = Aeson.parseEither p =<< Aeson.eitherDecode bytes
486659
487660-- | Checks a cache directory to see if there is a fresh symlink
488661-- to the result of building an attribute of a thunk.
@@ -490,44 +663,49 @@ thunkFileNames = ["default.nix", "github.json", "git.json"]
490663-- and the result is symlinked into the cache.
491664nixBuildThunkAttrWithCache
492665 :: MonadObelisk m
493− => FilePath
666+ => ThunkSpec
667+ -> FilePath
494668 -- ^ Path to directory containing Thunk
495669 -> String
496670 -- ^ Attribute to build
497− -> m FilePath
671+ -> m (Maybe FilePath)
498672 -- ^ Symlink to cached or built nix output
499673-- WARNING: If the thunk uses an impure reference such as '<nixpkgs>'
500674-- the caching mechanism will fail as it merely measures the modification
501675-- time of the cache link and the expression to build.
502−nixBuildThunkAttrWithCache thunkDir attr = do
503− --NB: Expects thunkDir to be normalised with no trailing path separator.
504− --This should be guaranteed by the command argument parser.
505− let cacheErrHandler e
506− | isDoesNotExistError e = return Nothing -- expected from a cache miss
507− | otherwise = putLog Error (T.pack $ displayException e) >> return Nothing
508− cacheDir = thunkDir </> ".attr-cache"
509− cachePath = cacheDir </> attr <.> "out"
676+nixBuildThunkAttrWithCache thunkSpec thunkDir attr = do
510677 latestChange <- liftIO $ do
511− createDirectoryIfMissing False cacheDir
512− let getModificationTimeMaybe = fmap rightToMaybe . try @IOError . getModificationTime
513− maximum . catMaybes <$> mapM (getModificationTimeMaybe . (thunkDir </>)) thunkFileNames
514− cacheHit <- handle cacheErrHandler $ do
515− cacheTime <- liftIO $ posixSecondsToUTCTime . realToFrac . modificationTime <$> getSymbolicLinkStatus cachePath
516− return $ if latestChange <= cacheTime
517− then Just cachePath
518− else Nothing
519− case cacheHit of
520− Just c -> return c
521− Nothing -> do
522− putLog Warning $ T.pack $ mconcat [thunkDir, ": ", attr, " not cached, building ..."]
523− _ <- nixCmd $ NixCmd_Build$ def
524− Lens.& nixBuildConfig_outLink Lens..~ OutLink_IndirectRoot cachePath
525− Lens.& nixCmdConfig_target Lens..~ Target
526− { _target_path = Just thunkDir
527− , _target_attr = Just attr
528− , _target_expr = Nothing
529− }
530− return cachePath
678+ let
679+ getModificationTimeMaybe = fmap rightToMaybe . try @IOError . getModificationTime
680+ thunkFileNames = Map.keys $ _thunkSpec_files thunkSpec
681+ maximum . catMaybes <$> traverse (getModificationTimeMaybe . (thunkDir </>)) thunkFileNames
682+
683+ let cachePaths' = nonEmpty $ Map.keys $ Map.filter (\case ThunkFileSpec_AttrCache -> True; _ -> False) $
684+ _thunkSpec_files thunkSpec
685+ for cachePaths' $ \cachePaths ->
686+ fmap NonEmpty.head $ for cachePaths $ \cacheDir -> do
687+ let
688+ cachePath = thunkDir </> cacheDir </> attr <.> "out"
689+ cacheErrHandler e
690+ | isDoesNotExistError e = pure Nothing -- expected from a cache miss
691+ | otherwise = Nothing <$ putLog Error (T.pack $ displayException e)
692+ cacheHit <- handle cacheErrHandler $ do
693+ cacheTime <- liftIO $ posixSecondsToUTCTime . realToFrac . modificationTime <$> getSymbolicLinkStatus cachePath
694+ pure $ if latestChange <= cacheTime
695+ then Just cachePath
696+ else Nothing
697+ case cacheHit of
698+ Just c -> pure c
699+ Nothing -> do
700+ putLog Warning $ T.pack $ mconcat [thunkDir, ": ", attr, " not cached, building ..."]
701+ liftIO $ createDirectoryIfMissing True (takeDirectory cachePath)
702+ (cachePath <$) $ nixCmd $ NixCmd_Build $ def
703+ & nixBuildConfig_outLink .~ OutLink_IndirectRoot cachePath
704+ & nixCmdConfig_target .~ Target
705+ { _target_path = Just thunkDir
706+ , _target_attr = Just attr
707+ , _target_expr = Nothing
708+ }
531709
532710-- | Build a nix attribute, and cache the result if possible
533711nixBuildAttrWithCache
@@ -538,13 +716,15 @@ nixBuildAttrWithCache
538716 -- ^ Attribute to build
539717 -> m FilePath
540718 -- ^ Symlink to cached or built nix output
541−nixBuildAttrWithCache exprPath attr = do
542− readThunk exprPath >>= \case
543− -- Only packed thunks are cached. in particular, checkouts are not
544− Right (ThunkData_Packed _) -> nixBuildThunkAttrWithCache exprPath attr
545− _ -> nixCmd $ NixCmd_Build $ def
546− Lens.& nixBuildConfig_outLink Lens..~ OutLink_None
547− Lens.& nixCmdConfig_target Lens..~ Target
719+nixBuildAttrWithCache exprPath attr = readThunk exprPath >>= \case
720+ -- Only packed thunks are cached. In particular, checkouts are not.
721+ Right (ThunkData_Packed spec _) ->
722+ maybe build pure =<< nixBuildThunkAttrWithCache spec exprPath attr
723+ _ -> build
724+ where
725+ build = nixCmd $ NixCmd_Build $ def
726+ & nixBuildConfig_outLink .~ OutLink_None
727+ & nixCmdConfig_target .~ Target
548728 { _target_path = Just exprPath
549729 , _target_attr = Just attr
550730 , _target_expr = Nothing
@@ -565,103 +745,144 @@ updateThunk p f = withSystemTempDirectory "obelisk-thunkptr-" $ \tmpDir -> do
565745 where
566746 copyThunkToTmp tmpDir thunkDir = readThunk thunkDir >>= \case
567747 Left err -> failWith $ "withThunkUnpacked: " <> T.pack (show err)
568− Right (ThunkData_Packed _) -> do
748+ Right ThunkData_Packed{} -> do
569749 let tmpThunk = tmpDir </> "thunk"
570750 callProcessAndLogOutput (Notice, Error) $
571− proc "cp" ["-r", "-T", thunkDir, tmpThunk]
751+ proc cp ["-r", "-T", thunkDir, tmpThunk]
572752 return tmpThunk
573− Right _ -> failWith $ "Thunk is not packed"
753+ Right _ -> failWith "Thunk is not packed"
574754 updateThunkFromTmp p' = do
575− _ <- packThunk' True False p'
755+ _ <- packThunk' True (ThunkPackConfig False (ThunkConfig Nothing)) p'
576756 callProcessAndLogOutput (Notice, Error) $
577− proc "cp" ["-r", "-T", p', p]
757+ proc cp ["-r", "-T", p', p]
578758
579759finalMsg :: Bool -> (a -> Text) -> Maybe (a -> Text)
580760finalMsg noTrail s = if noTrail then Nothing else Just s
581761
582−unpackThunk :: MonadObelisk m => FilePath -> m ()
583−unpackThunk = unpackThunk' False
584−
585762-- | Check that we are not somewhere inside the thunk directory
586−checkThunkDirectory :: MonadObelisk m => Text -> FilePath -> m ()
587−checkThunkDirectory msg thunkDir = do
763+checkThunkDirectory :: MonadObelisk m => FilePath -> m ()
764+checkThunkDirectory thunkDir = do
588765 currentDir <- liftIO getCurrentDirectory
589766 thunkDir' <- liftIO $ canonicalizePath thunkDir
590− when (thunkDir' `L.isInfixOf` currentDir) $ failWith msg
767+ when (thunkDir' `L.isInfixOf` currentDir) $
768+ failWith [i|Can't perform thunk operations from within the thunk directory: ${thunkDir}|]
769+
770+ -- Don't let thunk commands work when directly given an unpacked repo
771+ when (takeFileName thunkDir == unpackedDirName) $
772+ readThunk (takeDirectory thunkDir) >>= \case
773+ Right _ -> failWith [i|Refusing to perform thunk operation on ${thunkDir} because it is a thunk's unpacked source|]
774+ Left _ -> pure ()
775+
776+unpackThunk :: MonadObelisk m => FilePath -> m ()
777+unpackThunk = unpackThunk' False
591778
592779unpackThunk' :: MonadObelisk m => Bool -> FilePath -> m ()
593−unpackThunk' noTrail thunkDir = checkThunkDirectory "Can't pack/unpack from within the thunk directory" thunkDir >> readThunk thunkDir >>= \case
594− Left err -> failWith $ "thunk unpack: " <> T.pack (show err)
780+unpackThunk' noTrail thunkDir = checkThunkDirectory thunkDir *> readThunk thunkDir >>= \case
781+ Left err -> failWith [i|Invalid thunk at ${thunkDir}: ${err}|]
595782 --TODO: Overwrite option that rechecks out thunk; force option to do so even if working directory is dirty
596− Right (ThunkData_Checkout _) -> failWith "thunk unpack: thunk is already unpacked"
597− Right (ThunkData_Packed tptr) -> do
783+ Right ThunkData_Checkout -> failWith [i|Thunk at ${thunkDir} is already unpacked|]
784+ Right (ThunkData_Packed _ tptr) -> do
598785 let (thunkParent, thunkName) = splitFileName thunkDir
599− withTempDirectory thunkParent thunkName $ \tmpRepo -> do
600− let obGitDir = tmpRepo </> ".git" </> "obelisk"
601− s = case _thunkPtr_source tptr of
602− ThunkSource_GitHub s' -> forgetGithub False s'
603− ThunkSource_Git s' -> s'
786+ withTempDirectory thunkParent thunkName $ \tmpThunk -> do
787+ let
788+ gitSrc = thunkSourceToGitSource $ _thunkPtr_source tptr
789+ newSpec = case _thunkPtr_source tptr of
790+ ThunkSource_GitHub _ -> NonEmpty.head gitHubThunkSpecs
791+ ThunkSource_Git _ -> NonEmpty.head gitThunkSpecs
604792 withSpinner' ("Fetching thunk " <> T.pack thunkName)
605793 (finalMsg noTrail $ const $ "Fetched thunk " <> T.pack thunkName) $ do
606− let git = callProcessAndLogOutput (Notice, Notice) . gitProc tmpRepo
607− git $ [ "clone" ]
608− ++ ("--recursive" <$ guard (_gitSource_fetchSubmodules s))
609− ++ [ T.unpack $ render $ _gitSource_url s ]
610− ++ do branch <- maybeToList $ _gitSource_branch s
611− [ "--branch", T.unpack $ untagName branch ]
612− git ["reset", "--hard", Ref.toHexString $ _thunkRev_commit $ _thunkPtr_rev tptr]
613− when (_gitSource_fetchSubmodules s) $
614− git ["submodule", "update", "--recursive", "--init"]
615−
616− liftIO $ createDirectory obGitDir
617− callProcessAndLogOutput (Notice, Error) $
618− proc "cp" ["-r", "-T", thunkDir </> ".", obGitDir </> "orig-thunk"]
619− callProcessAndLogOutput (Notice, Error) $
620− proc "rm" ["-r", thunkDir]
621− callProcessAndLogOutput (Notice, Error) $
622− proc "mv" ["-T", tmpRepo, thunkDir]
794+ let unpackedPath = tmpThunk </> unpackedDirName
795+ gitCloneForThunkUnpack gitSrc (_thunkRev_commit $ _thunkPtr_rev tptr) unpackedPath
796+
797+ let normalizeMore = dropTrailingPathSeparator . normalise
798+ when (normalizeMore unpackedPath /= normalizeMore tmpThunk) $ -- Only write meta data if the checkout is not inplace
799+ createThunk tmpThunk $ Left newSpec
800+
801+ liftIO $ do
802+ removePathForcibly thunkDir
803+ renameDirectory tmpThunk thunkDir
804+
805+gitCloneForThunkUnpack
806+ :: MonadObelisk m
807+ => GitSource -- ^ Git source to use
808+ -> Ref hash -- ^ Commit hash to reset to
809+ -> FilePath -- ^ Directory to clone into
810+ -> m ()
811+gitCloneForThunkUnpack gitSrc commit dir = do
812+ let git = callProcessAndLogOutput (Notice, Notice) . gitProc dir
813+ git $ [ "clone" ]
814+ ++ ["--recursive" | _gitSource_fetchSubmodules gitSrc]
815+ ++ [ T.unpack $ gitUriToText $ _gitSource_url gitSrc ]
816+ ++ do branch <- maybeToList $ _gitSource_branch gitSrc
817+ [ "--branch", T.unpack $ untagName branch ]
818+ git ["reset", "--hard", Ref.toHexString commit]
819+ when (_gitSource_fetchSubmodules gitSrc) $
820+ git ["submodule", "update", "--recursive", "--init"]
623821
624822--TODO: add a rollback mode to pack to the original thunk
625−packThunk :: MonadObelisk m => Bool -> FilePath -> m ThunkPtr
823+packThunk :: MonadObelisk m => ThunkPackConfig -> FilePath -> m ThunkPtr
626824packThunk = packThunk' False
627825
628−packThunk' :: MonadObelisk m => Bool -> Bool -> FilePath -> m ThunkPtr
629−packThunk' noTrail force thunkDir = checkThunkDirectory "Can't pack/unpack from within the thunk directory" thunkDir >> readThunk thunkDir >>= \case
630− Left err -> failWith $ T.pack $ "thunk pack: " <> show err
631− Right (ThunkData_Packed _) -> failWith "pack: thunk is already packed"
632− Right (ThunkData_Checkout _) -> do
633− withSpinner' ("Packing thunk " <> T.pack thunkDir)
634− (finalMsg noTrail $ const $ "Packed thunk " <> T.pack thunkDir) $ do
635− thunkPtr <- getThunkPtr (not force) thunkDir
636− callProcessAndLogOutput (Debug, Error) $ proc "rm" ["-rf", thunkDir]
637− liftIO $ createThunk thunkDir thunkPtr
826+packThunk' :: MonadObelisk m => Bool -> ThunkPackConfig -> FilePath -> m ThunkPtr
827+packThunk' noTrail (ThunkPackConfig force thunkConfig) thunkDir = checkThunkDirectory thunkDir *> readThunk thunkDir >>= \case
828+ Right ThunkData_Packed{} -> failWith [i|Thunk at ${thunkDir} is is already packed|]
829+ _ -> withSpinner'
830+ ("Packing thunk " <> T.pack thunkDir)
831+ (finalMsg noTrail $ const $ "Packed thunk " <> T.pack thunkDir) $
832+ do
833+ let checkClean = if force then CheckClean_NoCheck else CheckClean_FullCheck
834+ thunkPtr <- modifyThunkPtrByConfig thunkConfig <$> getThunkPtr checkClean thunkDir (_thunkConfig_private thunkConfig)
835+ liftIO $ removePathForcibly thunkDir
836+ createThunk thunkDir $ Right thunkPtr
638837 pure thunkPtr
639838
640−getThunkPtr :: forall m. MonadObelisk m => Bool -> FilePath -> m ThunkPtr
641−getThunkPtr checkClean thunkDir = do
642− when checkClean $ ensureCleanGitRepo thunkDir True $
839+modifyThunkPtrByConfig :: ThunkConfig -> ThunkPtr -> ThunkPtr
840+modifyThunkPtrByConfig (ThunkConfig markPrivate') ptr = case markPrivate' of
841+ Nothing -> ptr
842+ Just markPrivate -> ptr { _thunkPtr_source = case _thunkPtr_source ptr of
843+ ThunkSource_Git s -> ThunkSource_Git $ s { _gitSource_private = markPrivate }
844+ ThunkSource_GitHub s -> ThunkSource_GitHub $ s { _gitHubSource_private = markPrivate }
845+ }
846+
847+data CheckClean
848+ = CheckClean_FullCheck
849+ -- ^ Check that the repo is clean, including .gitignored files
850+ | CheckClean_NotIgnored
851+ -- ^ Check that the repo is clean, not including .gitignored files
852+ | CheckClean_NoCheck
853+ -- ^ Don't check that the repo is clean
854+
855+getThunkPtr :: forall m. MonadObelisk m => CheckClean -> FilePath -> Maybe Bool -> m ThunkPtr
856+getThunkPtr gitCheckClean dir mPrivate = do
857+ let repoLocations = nubOrd $ map (first normalise)
858+ [(".git", "."), (unpackedDirName </> ".git", unpackedDirName)]
859+ repoLocation' <- liftIO $ flip findM repoLocations $ doesDirectoryExist . (dir </>) . fst
860+ thunkDir <- case repoLocation' of
861+ Nothing -> failWith [i|Can't find an unpacked thunk in ${dir}|]
862+ Just (_, path) -> pure $ normalise $ dir </> path
863+
864+ let (checkClean, checkIgnored) = case gitCheckClean of
865+ CheckClean_FullCheck -> (True, True)
866+ CheckClean_NotIgnored -> (True, False)
867+ CheckClean_NoCheck -> (False, False)
868+ when checkClean $ ensureCleanGitRepo thunkDir checkIgnored
643869 "thunk pack: thunk checkout contains unsaved modifications"
644870
645871 -- Check whether there are any stashes
646− stashOutput <- readGitProcess thunkDir ["stash", "list"]
647− when checkClean $ case T.null stashOutput of
648− False -> do
872+ when checkClean $ do
873+ stashOutput <- readGitProcess thunkDir ["stash", "list"]
874+ unless (T.null stashOutput) $
649875 failWith $ T.unlines $
650876 [ "thunk pack: thunk checkout has stashes"
651877 , "git stash list:"
652878 ] ++ T.lines stashOutput
653− True -> return ()
654879
655− -- Get current branch ``
880+ -- Get current branch
656881 (mCurrentBranch, mCurrentCommit) <- do
657− b <- listToMaybe
658− <$> T.lines
659− <$> readGitProcess thunkDir ["rev-parse", "--abbrev-ref", "HEAD"]
660− c <- listToMaybe
661− <$> T.lines
662− <$> readGitProcess thunkDir ["rev-parse", "HEAD"]
882+ b <- listToMaybe . T.lines <$> readGitProcess thunkDir ["rev-parse", "--abbrev-ref", "HEAD"]
883+ c <- listToMaybe . T.lines <$> readGitProcess thunkDir ["rev-parse", "HEAD"]
663884 case b of
664− (Just "HEAD") -> failWith $ T.unlines $
885+ (Just "HEAD") -> failWith $ T.unlines
665886 [ "thunk pack: You are in 'detached HEAD' state."
666887 , "If you want to pack at the current ref \
667888 \then please create a new branch with 'git checkout -b <new-branch-name>' and push this upstream."
@@ -670,7 +891,7 @@ getThunkPtr checkClean thunkDir = do
670891
671892 -- Get information on all branches and their (optional) designated upstream
672893 -- correspondents
673− (headDump :: [Text]) <- T.lines <$> readGitProcess thunkDir
894+ headDump :: [Text] <- T.lines <$> readGitProcess thunkDir
674895 [ "for-each-ref"
675896 , "--format=%(refname:short) %(upstream:short) %(upstream:remotename)"
676897 , "refs/heads/"
@@ -716,7 +937,7 @@ getThunkPtr checkClean thunkDir = do
716937 ]
717938
718939 -- loosely by https://stackoverflow.com/questions/7773939/show-git-ahead-and-behind-info-for-all-branches-including-remotes
719− stats <- iforM headUpstream $ \branch (upstream, _remote) -> do
940+ stats <- ifor headUpstream $ \branch (upstream, _remote) -> do
720941 (stat :: [Text]) <- T.lines <$> readGitProcess thunkDir
721942 [ "rev-list", "--left-right"
722943 , T.unpack branch <> "..." <> T.unpack upstream
@@ -733,15 +954,16 @@ getThunkPtr checkClean thunkDir = do
733954 [ "thunk pack: Certain branches in the thunk have commits not yet pushed upstream:"
734955 , ""
735956 ] ++
736− (flip map (Map.toList nonGood) $ \(branch, (upstream, (ahead, behind))) -> mconcat
957+ flip map (Map.toList nonGood) (\(branch, (upstream, (ahead, behind))) -> mconcat
737958 [" ", branch, " ahead: ", T.pack (show ahead), " behind: ", T.pack (show behind), " remote branch ", upstream]) ++
738959 [ ""
739960 , "Please push these upstream and try again. (Or just fetch, if they are somehow \
740961 \pushed but this repo's remote tracking branches don't know it.)"
741962 ]
742963
743− -- We assume it's safe to pack the thunk at this point
744− putLog Informational $ "All changes safe in git remotes. OK to pack thunk."
964+ when checkClean $ do
965+ -- We assume it's safe to pack the thunk at this point
966+ putLog Informational "All changes safe in git remotes. OK to pack thunk."
745967
746968 let remote = maybe "origin" snd $ flip Map.lookup headUpstream =<< mCurrentBranch
747969
@@ -754,14 +976,12 @@ getThunkPtr checkClean thunkDir = do
754976 remoteUri <- case parseGitUri remoteUri' of
755977 Nothing -> failWith $ "Could not identify git remote: " <> remoteUri'
756978 Just uri -> pure uri
757− uriThunkPtr remoteUri mCurrentBranch mCurrentCommit
979+ uriThunkPtr remoteUri mPrivate mCurrentBranch mCurrentCommit
758980
759981-- | Get the latest revision available from the given source
760982getLatestRev :: MonadObelisk m => ThunkSource -> m ThunkRev
761983getLatestRev os = do
762− let gitS = case os of
763− ThunkSource_GitHub s -> forgetGithub False s
764− ThunkSource_Git s -> s
984+ let gitS = thunkSourceToGitSource os
765985 (_, commit) <- gitGetCommitBranch (_gitSource_url gitS) (untagName <$> _gitSource_branch gitS)
766986 case os of
767987 ThunkSource_GitHub s -> githubThunkRev s commit
@@ -773,18 +993,18 @@ getLatestRev os = do
773993-- performance. If that doesn't work (e.g. authentication issue), we fall back
774994-- on just doing things the normal way for git repos in general, and save it as
775995-- a regular git thunk.
776−uriThunkPtr :: MonadObelisk m => URI -> Maybe Text -> Maybe Text -> m ThunkPtr
777−uriThunkPtr uri mbranch mcommit = do
996+uriThunkPtr :: MonadObelisk m => GitUri -> Maybe Bool -> Maybe Text -> Maybe Text -> m ThunkPtr
997+uriThunkPtr uri mPrivate mbranch mcommit = do
778998 commit <- case mcommit of
779999 Nothing -> gitGetCommitBranch uri mbranch >>= return . snd
7801000 (Just c) -> return c
781− (src, rev) <- case uriToThunkSource uri mbranch of
1001+ (src, rev) <- uriToThunkSource uri mPrivate mbranch >>= \case
7821002 ThunkSource_GitHub s -> do
7831003 rev <- runExceptT $ githubThunkRev s commit
7841004 case rev of
7851005 Right r -> pure (ThunkSource_GitHub s, r)
7861006 Left e -> do
787− putLog Warning $ "\
1007+ putLog Warning "\
7881008\Failed to fetch archive from GitHub. This is probably a private repo. \
7891009\Falling back on normal fetchgit. Original failure:"
7901010 errorToWarning e
@@ -801,34 +1021,66 @@ uriThunkPtr uri mbranch mcommit = do
8011021-- If the thunk is a GitHub thunk and fails, we do *not* fall back like with
8021022-- `uriThunkPtr`. Unlike a plain URL, a thunk src explicitly states which method
8031023-- should be employed, and so we respect that.
804−uriToThunkSource :: URI -> Maybe Text -> ThunkSource
805−uriToThunkSource u
806− | Right uriAuth <- uriAuthority u
807− , Just scheme <- unRText <$> uriScheme u
1024+uriToThunkSource :: MonadObelisk m => GitUri -> Maybe Bool -> Maybe Text -> m ThunkSource
1025+uriToThunkSource (GitUri u) mPrivate
1026+ | Right uriAuth <- URI.uriAuthority u
1027+ , Just scheme <- URI.unRText <$> URI.uriScheme u
8081028 , case scheme of
809− "ssh" -> uriAuth == Authority
810− { authUserInfo = Just $ UserInfo (fromRight' $ mkUsername "git") Nothing
811− , authHost = fromRight' $ mkHost "github.com"
812− , authPort = Nothing
1029+ "ssh" -> uriAuth == URI.Authority
1030+ { URI.authUserInfo = Just $ URI.UserInfo (fromRight' $ URI.mkUsername "git") Nothing
1031+ , URI.authHost = fromRight' $ URI.mkHost "github.com"
1032+ , URI.authPort = Nothing
8131033 }
8141034 s -> s `L.elem` [ "git", "https", "http" ] -- "http:" just redirects to "https:"
815− && unRText (authHost uriAuth) == "github.com"
816− , Just (_, owner :| [repoish]) <- uriPath u
817− = \mbranch -> ThunkSource_GitHub $ GitHubSource
818− { _gitHubSource_owner = N $ unRText owner
819− , _gitHubSource_repo = N $ let
820− repoish' = unRText repoish
821− in case T.stripSuffix ".git" repoish' of
822− Just repo -> repo
823− Nothing -> repoish'
824− , _gitHubSource_branch = N <$> mbranch
825− }
1035+ && URI.unRText (URI.authHost uriAuth) == "github.com"
1036+ , Just (_, owner :| [repoish]) <- URI.uriPath u
1037+ = \mbranch -> do
1038+ isPrivate <- getIsPrivate
1039+ pure $ ThunkSource_GitHub $ GitHubSource
1040+ { _gitHubSource_owner = N $ URI.unRText owner
1041+ , _gitHubSource_repo = N $ let
1042+ repoish' = URI.unRText repoish
1043+ in fromMaybe repoish' $ T.stripSuffix ".git" repoish'
1044+ , _gitHubSource_branch = N <$> mbranch
1045+ , _gitHubSource_private = isPrivate
1046+ }
8261047
827− | otherwise = \mbranch -> ThunkSource_Git $ GitSource
828− { _gitSource_url = u
829− , _gitSource_branch = N <$> mbranch
830− , _gitSource_fetchSubmodules = False -- TODO: How do we determine if this should be true?
831− }
1048+ | otherwise = \mbranch -> do
1049+ isPrivate <- getIsPrivate
1050+ pure $ ThunkSource_Git $ GitSource
1051+ { _gitSource_url = GitUri u
1052+ , _gitSource_branch = N <$> mbranch
1053+ , _gitSource_fetchSubmodules = False -- TODO: How do we determine if this should be true?
1054+ , _gitSource_private = isPrivate
1055+ }
1056+ where
1057+ getIsPrivate = maybe (guessGitRepoIsPrivate $ GitUri u) pure mPrivate
1058+
1059+guessGitRepoIsPrivate :: MonadObelisk m => GitUri -> m Bool
1060+guessGitRepoIsPrivate uri = flip fix urisToTry $ \loop -> \case
1061+ [] -> pure True
1062+ uriAttempt:xs -> do
1063+ result <- readCreateProcessWithExitCode $
1064+ isolateGitProc $
1065+ gitProcNoRepo
1066+ [ "ls-remote"
1067+ , "--quiet"
1068+ , "--exit-code"
1069+ , "--symref"
1070+ , T.unpack $ gitUriToText uriAttempt
1071+ ]
1072+ case result of
1073+ (ExitSuccess, _, _) -> pure False -- Must be a public repo
1074+ _ -> loop xs
1075+ where
1076+ urisToTry = nubOrd $
1077+ -- Include the original URI if it isn't using SSH because SSH will certainly fail.
1078+ [uri | fmap URI.unRText (URI.uriScheme (unGitUri uri)) /= Just "ssh"] <>
1079+ [changeScheme "https" uri, changeScheme "http" uri]
1080+ changeScheme scheme (GitUri u) = GitUri $ u
1081+ { URI.uriScheme = URI.mkScheme scheme
1082+ , URI.uriAuthority = (\x -> x { URI.authUserInfo = Nothing }) <$> URI.uriAuthority u
1083+ }
8321084
8331085-- Funny signature indicates no effects depend on the optional branch name.
8341086githubThunkRev
@@ -840,19 +1092,19 @@ githubThunkRev
8401092githubThunkRev s commit = do
8411093 owner <- forcePP $ _gitHubSource_owner s
8421094 repo <- forcePP $ _gitHubSource_repo s
843− revTarball <- mkPathPiece $ commit <> ".tar.gz"
844− let archiveUri = URI
845− { uriScheme = Just $ fromRight' $ mkScheme "https"
846− , uriAuthority = Right $ Authority
847− { authUserInfo = Nothing
848− , authHost = fromRight' $ mkHost "github.com"
849− , authPort = Nothing
1095+ revTarball <- URI.mkPathPiece $ commit <> ".tar.gz"
1096+ let archiveUri = GitUri $ URI.URI
1097+ { URI.uriScheme = Just $ fromRight' $ URI.mkScheme "https"
1098+ , URI.uriAuthority = Right $ URI.Authority
1099+ { URI.authUserInfo = Nothing
1100+ , URI.authHost = fromRight' $ URI.mkHost "github.com"
1101+ , URI.authPort = Nothing
8501102 }
851− , uriPath = Just ( False
852− , owner :| [ repo, fromRight' $ mkPathPiece "archive", revTarball ]
1103+ , URI.uriPath = Just ( False
1104+ , owner :| [ repo, fromRight' $ URI.mkPathPiece "archive", revTarball ]
8531105 )
854− , uriQuery = []
855− , uriFragment = Nothing
1106+ , URI.uriQuery = []
1107+ , URI.uriFragment = Nothing
8561108 }
8571109 hash <- getNixSha256ForUriUnpacked archiveUri
8581110 putLog Debug $ "Nix sha256 is " <> hash
@@ -861,8 +1113,8 @@ githubThunkRev s commit = do
8611113 , _thunkRev_nixSha256 = hash
8621114 }
8631115 where
864− forcePP :: Name entity -> m (RText 'PathPiece)
865− forcePP = mkPathPiece . untagName
1116+ forcePP :: Name entity -> m (URI.RText 'URI.PathPiece)
1117+ forcePP = URI.mkPathPiece . untagName
8661118
8671119gitThunkRev
8681120 :: MonadObelisk m
@@ -871,11 +1123,11 @@ gitThunkRev
8711123 -> m ThunkRev
8721124gitThunkRev s commit = do
8731125 let u = _gitSource_url s
874− protocols = ["https", "ssh", "git"]
875− Just scheme <- pure $ unRText <$> uriScheme u
1126+ protocols = ["file", "https", "ssh", "git"]
1127+ scheme = maybe "file" URI.unRText $ URI.uriScheme $ (\(GitUri x) -> x) u
8761128 unless (T.toLower scheme `elem` protocols) $
8771129 failWith $ "obelisk currently only supports "
878− <> T.intercalate ", " protocols <> " protocols for non-GitHub remotes"
1130+ <> T.intercalate ", " protocols <> " protocols for plain Git remotes"
8791131 hash <- nixPrefetchGit u commit $ _gitSource_fetchSubmodules s
8801132 putLog Informational $ "Nix sha256 is " <> hash
8811133 pure $ ThunkRev
@@ -888,11 +1140,12 @@ gitThunkRev s commit = do
8881140--
8891141-- If the branch name is passed in, it is returned exactly as-is. If it is not
8901142-- passed it, the default branch of the repo is used instead.
1143+
8911144gitGetCommitBranch
892− :: MonadObelisk m => URI -> Maybe Text -> m (Text, CommitId)
1145+ :: MonadObelisk m => GitUri -> Maybe Text -> m (Text, CommitId)
8931146gitGetCommitBranch uri mbranch = withExitFailMessage ("Failure for git remote " <> uriMsg) $ do
8941147 (_, bothMaps) <- gitLsRemote
895− (T.unpack $ render uri)
1148+ (T.unpack $ gitUriToText uri)
8961149 (GitRef_Branch <$> mbranch)
8971150 Nothing
8981151 branch <- case mbranch of
@@ -908,18 +1161,21 @@ gitGetCommitBranch uri mbranch = withExitFailMessage ("Failure for git remote "
9081161 pure (branch, commit)
9091162 where
9101163 rethrowE = either failWith pure
911− uriMsg = render uri
1164+ uriMsg = gitUriToText uri
1165+
1166+parseGitUri :: Text -> Maybe GitUri
1167+parseGitUri x = GitUri <$> (parseFileURI x <|> parseAbsoluteURI x <|> parseSshShorthand x)
9121168
913−parseGitUri :: Text -> Maybe URI
914−parseGitUri x = parseAbsoluteURI x <|> parseSshShorthand x
1169+parseFileURI :: Text -> Maybe URI.URI
1170+parseFileURI uri = if "/" `T.isPrefixOf` uri then parseAbsoluteURI ("file://" <> uri) else Nothing
9151171
916−parseAbsoluteURI :: Text -> Maybe URI
1172+parseAbsoluteURI :: Text -> Maybe URI.URI
9171173parseAbsoluteURI uri = do
918− parsedUri <- mkURI uri
919− guard $ isPathAbsolute parsedUri
920− pure $ parsedUri
1174+ parsedUri <- URI.mkURI uri
1175+ guard $ URI.isPathAbsolute parsedUri
1176+ pure parsedUri
9211177
922−parseSshShorthand :: Text -> Maybe URI
1178+parseSshShorthand :: Text -> Maybe URI.URI
9231179parseSshShorthand uri = do
9241180 -- This is what git does to check that the remote
9251181 -- is not a local file path when parsing shorthand.
@@ -932,4 +1188,4 @@ parseSshShorthand uri = do
9321188 -- This check is used to disambiguate a filepath containing a colon from shorthand
9331189 guard $ isNothing (T.findIndex (=='/') authAndHostname)
9341190 && not (T.null colonAndPath)
935− mkURI properUri
1191+ URI.mkURI properUri