@@ -5,63 +5,48 @@
55{-# LANGUAGE MultiWayIf #-}
66{-# LANGUAGE OverloadedStrings #-}
77{-# LANGUAGE PatternGuards #-}
8+{-# LANGUAGE QuasiQuotes #-}
89{-# LANGUAGE ScopedTypeVariables #-}
910{-# LANGUAGE TypeApplications #-}
10−module Obelisk.Command.Thunk
11− ( ThunkPtr (..)
12− , ThunkRev (..)
13− , ThunkSource (..)
14− , ThunkData (..)
15− , ReadThunkError (..)
16− , GitHubSource (..)
17− , getThunkGitBranch
18− , getLatestRev
19− , updateThunkToLatest
20− , createThunk
21− , createThunkWithLatest
22− , nixBuildAttrWithCache
23− , nixBuildThunkAttrWithCache
24− , unpackThunk
25− , packThunk
26− , readThunk
27− , updateThunk
28− , getThunkPtr
29− , getThunkPtr'
30− , parseGitUri
31− , uriThunkPtr
32− , setThunk
33− ) where
11+module Obelisk.Command.Thunk where
3412
3513import Control.Applicative
3614import Control.Exception (displayException, try)
37−import Control.Error.Safe
38−import qualified Control.Lens as Lens
39−import Control.Lens.Indexed hiding ((<.>))
15+import Control.Lens (ifor, ifor_, (.~))
4016import Control.Monad
41−import Control.Monad.Catch (handle)
17+import Control.Monad.Extra (findM)
18+import Control.Monad.Catch (MonadCatch, handle)
4219import Control.Monad.Except
4320import Data.Aeson ((.=))
4421import qualified Data.Aeson as Aeson
4522import Data.Aeson.Encode.Pretty
4623import qualified Data.Aeson.Types as Aeson
24+import Data.Bifunctor (first)
4725import qualified Data.ByteString.Lazy as LBS
26+import Data.Containers.ListUtils (nubOrd)
4827import Data.Default
4928import Data.Either.Combinators (fromRight', rightToMaybe)
29+import Data.Foldable (toList)
30+import Data.Function ((&))
31+import Data.Functor ((<&>))
5032import Data.Git.Ref (Ref)
5133import qualified Data.Git.Ref as Ref
5234import qualified Data.List as L
53−import Data.List.NonEmpty (NonEmpty (..))
35+import Data.List.NonEmpty (NonEmpty (..), nonEmpty)
5436import qualified Data.List.NonEmpty as NonEmpty
5537import Data.Map (Map)
5638import qualified Data.Map as Map
5739import Data.Maybe
5840import Data.Set (Set)
5941import qualified Data.Set as Set
42+import Data.String.Here.Interpolated (i)
43+import Data.String.Here.Uninterpolated (here)
6044import Data.Text (Text)
6145import qualified Data.Text as T
6246import Data.Text.Encoding
6347import qualified Data.Text.IO as T
6448import Data.Time.Clock.POSIX (posixSecondsToUTCTime)
49+import Data.Traversable (for)
6550import Data.Yaml (parseMaybe)
6651import GitHub
6752import GitHub.Data.Name
@@ -71,9 +56,8 @@ import System.Exit
7156import System.FilePath
7257import System.IO.Error
7358import System.IO.Temp
74−import System.Posix (getSymbolicLinkStatus, modificationTime)
75−import System.Process (proc)
76−import Text.URI
59+import System.PosixCompat.Files (getSymbolicLinkStatus, modificationTime)
60+import qualified Text.URI as URI
7761
7862import Obelisk.App (MonadObelisk)
7963import Obelisk.CliApp
@@ -81,11 +65,10 @@ import Obelisk.Command.Utils
8165
8266--TODO: Support symlinked thunk data
8367data ThunkData
84− = ThunkData_Packed ThunkPtr
68+ = ThunkData_Packed ThunkSpec ThunkPtr
8569 -- ^ Packed thunk
86− | ThunkData_Checkout (Maybe ThunkPtr)
70+ | ThunkData_Checkout
8771 -- ^ Checked out thunk that was unpacked from this pointer
88− deriving (Show, Eq, Ord)
8972
9073-- | A reference to the exact data that a thunk should translate into
9174data ThunkPtr = ThunkPtr
@@ -98,7 +81,7 @@ type NixSha256 = Text --TODO: Use a smart constructor and make this actually ver
9881
9982-- | A specific revision of data; it may be available from multiple sources
10083data ThunkRev = ThunkRev
101− { _thunkRev_commit :: Ref
84+ { _thunkRev_commit :: Ref Ref.SHA1
10285 , _thunkRev_nixSha256 :: NixSha256
10386 }
10487 deriving (Show, Eq, Ord)
@@ -111,41 +94,72 @@ data ThunkSource
11194 | ThunkSource_Git GitSource
11295 deriving (Show, Eq, Ord)
11396
97+thunkSourceToGitSource :: ThunkSource -> GitSource
98+thunkSourceToGitSource = \case
99+ ThunkSource_GitHub s -> forgetGithub False s
100+ ThunkSource_Git s -> s
101+
114102data GitHubSource = GitHubSource
115103 { _gitHubSource_owner :: Name Owner
116104 , _gitHubSource_repo :: Name Repo
117105 , _gitHubSource_branch :: Maybe (Name Branch)
106+ , _gitHubSource_private :: Bool
118107 }
119108 deriving (Show, Eq, Ord)
120109
110+newtype GitUri = GitUri { unGitUri :: URI.URI } deriving (Eq, Ord, Show)
111+
112+gitUriToText :: GitUri -> Text
113+gitUriToText (GitUri uri)
114+ | (T.toLower . URI.unRText <$> URI.uriScheme uri) == Just "file"
115+ , Just (_, path) <- URI.uriPath uri
116+ = "/" <> T.intercalate "/" (map URI.unRText $ NonEmpty.toList path)
117+ | otherwise = URI.render uri
118+
121119data GitSource = GitSource
122− { _gitSource_url :: URI
120+ { _gitSource_url :: GitUri
123121 , _gitSource_branch :: Maybe (Name Branch)
124122 , _gitSource_fetchSubmodules :: Bool
123+ , _gitSource_private :: Bool
125124 }
126125 deriving (Show, Eq, Ord)
127126
127+newtype ThunkConfig = ThunkConfig
128+ { _thunkConfig_private :: Maybe Bool
129+ } deriving Show
130+
131+data ThunkUpdateConfig = ThunkUpdateConfig
132+ { _thunkUpdateConfig_branch :: Maybe String
133+ , _thunkUpdateConfig_config :: ThunkConfig
134+ } deriving Show
135+
136+data ThunkPackConfig = ThunkPackConfig
137+ { _thunkPackConfig_force :: Bool
138+ , _thunkPackConfig_config :: ThunkConfig
139+ } deriving Show
140+
128141-- | Convert a GitHub source to a regular Git source. Assumes no submodules.
129142forgetGithub :: Bool -> GitHubSource -> GitSource
130143forgetGithub useSsh s = GitSource
131− { _gitSource_url = URI
132− { uriScheme = Just $ fromRight' $ mkScheme $ if useSsh then "ssh" else "https"
133− , uriAuthority = Right $ Authority
134− { 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
135148 <$ guard useSsh
136− , authHost = fromRight' $ mkHost "github.com"
137− , authPort = Nothing
149+ , URI.authHost = fromRight' $ URI.mkHost "github.com"
150+ , URI.authPort = Nothing
138151 }
139− , uriPath = Just ( False
140− , fromRight' . mkPathPiece <$>
152+ , URI.uriPath = Just ( False
153+ , fromRight' . URI.mkPathPiece <$>
141154 untagName (_gitHubSource_owner s)
142155 :| [ untagName (_gitHubSource_repo s) <> ".git" ]
143156 )
144− , uriQuery = []
145− , uriFragment = Nothing
157+ , URI.uriQuery = []
158+ , URI.uriFragment = Nothing
146159 }
147160 , _gitSource_branch = _gitHubSource_branch s
148161 , _gitSource_fetchSubmodules = False
162+ , _gitSource_private = _gitHubSource_private s
149163 }
150164
151165getThunkGitBranch :: ThunkPtr -> Maybe Text
@@ -153,26 +167,26 @@ getThunkGitBranch (ThunkPtr _ src) = fmap untagName $ case src of
153167 ThunkSource_GitHub s -> _gitHubSource_branch s
154168 ThunkSource_Git s -> _gitSource_branch s
155169
156−commitNameToRef :: Name Commit -> Ref
170+commitNameToRef :: Name Commit -> Ref Ref.SHA1
157171commitNameToRef (N c) = Ref.fromHex $ encodeUtf8 c
158172
159173-- TODO: Use spinner here.
160174getNixSha256ForUriUnpacked
161175 :: MonadObelisk m
162− => URI
176+ => GitUri
163177 -> m NixSha256
164178getNixSha256ForUriUnpacked uri =
165− 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
166180 [hash] <- fmap T.lines $ readProcessAndLogOutput (Debug, Debug) $
167− proc "nix-prefetch-url" ["--unpack" , "--type" , "sha256" , T.unpack $ render uri]
181+ proc nixPrefetchUrlPath ["--unpack", "--type", "sha256", T.unpack $ gitUriToText uri]
168182 pure hash
169183
170−nixPrefetchGit :: MonadObelisk m => URI -> Text -> Bool -> m NixSha256
184+nixPrefetchGit :: MonadObelisk m => GitUri -> Text -> Bool -> m NixSha256
171185nixPrefetchGit uri rev fetchSubmodules =
172− 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
173187 out <- readProcessAndLogStderr Debug $
174− proc "nix-prefetch-git" $ filter (/="")
175− [ "--url", T.unpack $ render uri
188+ proc nixPrefetchGitPath $ filter (/="")
189+ [ "--url", T.unpack $ gitUriToText uri
176190 , "--rev", T.unpack rev
177191 , if fetchSubmodules then "--fetch-submodules" else ""
178192 , "--quiet"
@@ -184,93 +198,117 @@ nixPrefetchGit uri rev fetchSubmodules =
184198
185199--TODO: Pretty print these
186200data ReadThunkError
187− = ReadThunkError_UnrecognizedFiles
188− | ReadThunkError_AmbiguousFiles
189− | ReadThunkError_UnrecognizedLoader Text
190− | ReadThunkError_UnparseablePtr LBS.ByteString
191− deriving (Show)
192−
193−-- | Read a thunk and validate that it is only a thunk, either packed or unpacked.
194−-- If the thunk is packed and additional data is present, fail.
195−readThunk :: MonadObelisk m => FilePath -> m (Either ReadThunkError ThunkData)
196−readThunk thunkDir = do
197− files <- liftIO $ listDirectory thunkDir
198− case ".git" `elem` files of
199− True -> fmap ThunkData_Checkout <$> do
200− let origThunkPath = thunkDir </> ".git" </> "obelisk" </> "orig-thunk"
201− liftIO $ doesDirectoryExist origThunkPath >>= \case
202− True -> fmap Just <$> readPackedThunk origThunkPath
203− False -> return $ return Nothing
204− False -> liftIO $ fmap ThunkData_Packed <$> readPackedThunk thunkDir
205−
206−data ThunkType = ThunkType
207− { _thunkType_loader :: FilePath
208− , _thunkType_json :: FilePath
209− , _thunkType_optional :: Set FilePath
210− , _thunkType_loaderVersions :: NonEmpty Text
211− , _thunkType_parser :: Aeson.Object -> Aeson.Parser ThunkPtr
201+ = ReadThunkError_UnrecognizedThunk
202+ | ReadThunkError_UnrecognizedPaths (NonEmpty FilePath)
203+ | ReadThunkError_MissingPaths (NonEmpty FilePath)
204+ | ReadThunkError_UnparseablePtr FilePath String
205+ | ReadThunkError_FileError IOError
206+ | ReadThunkError_FileDoesNotMatch FilePath Text
207+ | ReadThunkError_UnrecognizedState String
208+ | ReadThunkError_AmbiguousPackedState ThunkPtr ThunkPtr
209+ deriving (Show)
210+
211+unpackedDirName :: FilePath
212+unpackedDirName = "."
213+
214+attrCacheFileName :: FilePath
215+attrCacheFileName = ".attr-cache"
216+
217+-- | Specification for how a file in a thunk version works.
218+data ThunkFileSpec
219+ = ThunkFileSpec_Ptr (LBS.ByteString -> Either String ThunkPtr) -- ^ This file specifies 'ThunkPtr' data
220+ | ThunkFileSpec_FileMatches Text -- ^ This file must match the given content exactly
221+ | ThunkFileSpec_CheckoutIndicator -- ^ Existence of this directory indicates that the thunk is unpacked
222+ | ThunkFileSpec_AttrCache -- ^ This directory is an attribute cache
223+
224+-- | Specification for how a set of files in a thunk version work.
225+data ThunkSpec = ThunkSpec
226+ { _thunkSpec_name :: !Text
227+ , _thunkSpec_files :: !(Map FilePath ThunkFileSpec)
212228 }
213229
214−gitHubThunkType :: ThunkType
215−gitHubThunkType = ThunkType
216− { _thunkType_loader = "default.nix"
217− , _thunkType_json = "github.json"
218− , _thunkType_optional = Set.fromList [".attr-cache"]
219− , _thunkType_loaderVersions = gitHubStandaloneLoaders
220− , _thunkType_parser = parseThunkPtr $ \v ->
221− ThunkSource_GitHub <$> parseGitHubSource v <|> ThunkSource_Git <$> parseGitSource v
222− }
223−
224−gitThunkType :: ThunkType
225−gitThunkType = ThunkType
226− { _thunkType_loader = "default.nix"
227− , _thunkType_json = "git.json"
228− , _thunkType_optional = Set.fromList [".attr-cache"]
229− , _thunkType_loaderVersions = plainGitStandaloneLoaders
230− , _thunkType_parser = parseThunkPtr $ fmap ThunkSource_Git . parseGitSource
231− }
232−
233−thunkTypes :: [ThunkType]
234−thunkTypes = [gitThunkType, gitHubThunkType]
235−
236−findThunkType :: [ThunkType] -> FilePath -> IO (Either ReadThunkError ThunkType)
237−findThunkType types thunkDir = do
238− matches <- fmap catMaybes $ forM types $ \thunkType -> do
239− let
240− expectedContents = Set.fromList $ (thunkDir </>) <$>
241− [ _thunkType_loader thunkType
242− , _thunkType_json thunkType
243− ]
244− optionalContents = Set.map (thunkDir </>) (_thunkType_optional thunkType)
245−
246− -- Ensure that there aren't any other files in the thunk
247− -- NB: System.Directory.listDirectory returns the contents without the directory path
248− files <- liftIO $ Set.fromList . fmap (thunkDir </>) <$> listDirectory thunkDir
249− let unexpectedContents = files `Set.difference` (expectedContents `Set.union` optionalContents)
250− missingContents = expectedContents `Set.difference` files
251− pure $ if Set.null unexpectedContents && Set.null missingContents
252− then Just thunkType
253− else Nothing
254−
255− pure $ case matches of
256− [singleMatch] -> Right singleMatch
257− [] -> Left ReadThunkError_UnrecognizedFiles
258− _ -> 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}|]
259307
260308-- | Read a thunk and validate that it is exactly a packed thunk.
261309-- If additional data is present, fail.
262−readPackedThunk :: FilePath -> IO (Either ReadThunkError ThunkPtr)
263−readPackedThunk thunkDir = runExceptT $ do
264− thunkType <- ExceptT $ findThunkType thunkTypes thunkDir
265− -- Ensure that we recognize the thunk loader
266− loader <- liftIO $ T.readFile $ thunkDir </> _thunkType_loader thunkType
267− unless (loader `elem` _thunkType_loaderVersions thunkType) $ do
268− throwError $ ReadThunkError_UnrecognizedLoader loader
269−
270− txt <- liftIO $ LBS.readFile $ thunkDir </> _thunkType_json thunkType
271− case parseMaybe (_thunkType_parser thunkType) =<< Aeson.decode txt of
272− Nothing -> throwError $ ReadThunkError_UnparseablePtr txt
273− Just ptr -> return ptr
310+readThunk :: (MonadObelisk m) => FilePath -> m (Either ReadThunkError ThunkData)
311+readThunk = readThunkWith thunkSpecTypes
274312
275313parseThunkPtr :: (Aeson.Object -> Aeson.Parser ThunkSource) -> Aeson.Object -> Aeson.Parser ThunkPtr
276314parseThunkPtr parseSrc v = do
@@ -290,10 +328,12 @@ parseGitHubSource v = do
290328 owner <- v Aeson..: "owner"
291329 repo <- v Aeson..: "repo"
292330 branch <- v Aeson..:! "branch"
331+ private <- v Aeson..:? "private"
293332 pure $ GitHubSource
294333 { _gitHubSource_owner = owner
295334 , _gitHubSource_repo = repo
296335 , _gitHubSource_branch = branch
336+ , _gitHubSource_private = fromMaybe False private
297337 }
298338
299339parseGitSource :: Aeson.Object -> Aeson.Parser GitSource
@@ -301,25 +341,29 @@ parseGitSource v = do
301341 Just url <- parseGitUri <$> v Aeson..: "url"
302342 branch <- v Aeson..:! "branch"
303343 fetchSubmodules <- v Aeson..:! "fetchSubmodules"
344+ private <- v Aeson..:? "private"
304345 pure $ GitSource
305346 { _gitSource_url = url
306347 , _gitSource_branch = branch
307348 , _gitSource_fetchSubmodules = fromMaybe False fetchSubmodules
349+ , _gitSource_private = fromMaybe False private
308350 }
309351
310352overwriteThunk :: MonadObelisk m => FilePath -> ThunkPtr -> m ()
311353overwriteThunk target thunk = do
312354 -- Ensure that this directory is a valid thunk (i.e. so we aren't losing any data)
313− Right _ <- readThunk target
355+ readThunk target >>= \case
356+ Left e -> failWith [i|Invalid thunk at ${target}: ${e}|]
357+ Right _ -> pure ()
314358
315359 --TODO: Is there a safer way to do this overwriting?
316− liftIO $ removeDirectoryRecursive target
317− liftIO $ createThunk target thunk
360+ liftIO $ removePathForcibly target
361+ createThunk target $ Right thunk
318362
319−thunkPtrLoader :: ThunkPtr -> Text
320−thunkPtrLoader thunk = case _thunkPtr_source thunk of
321− ThunkSource_GitHub _ -> NonEmpty.head gitHubStandaloneLoaders
322− 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
323367
324368-- It's important that formatting be very consistent here, because
325369-- otherwise when people update thunks, their patches will be messy
@@ -331,13 +375,15 @@ encodeThunkPtrData (ThunkPtr rev src) = case src of
331375 , ("branch" .=) <$> _gitHubSource_branch s
332376 , Just $ "rev" .= Ref.toHexString (_thunkRev_commit rev)
333377 , Just $ "sha256" .= _thunkRev_nixSha256 rev
378+ , Just $ "private" .= _gitHubSource_private s
334379 ]
335380 ThunkSource_Git s -> encodePretty' plainGitCfg $ Aeson.object $ catMaybes
336− [ Just $ "url" .= render (_gitSource_url s)
381+ [ Just $ "url" .= gitUriToText (_gitSource_url s)
337382 , Just $ "rev" .= Ref.toHexString (_thunkRev_commit rev)
338383 , ("branch" .=) <$> _gitSource_branch s
339384 , Just $ "sha256" .= _thunkRev_nixSha256 rev
340385 , Just $ "fetchSubmodules" .= _gitSource_fetchSubmodules s
386+ , Just $ "private" .= _gitSource_private s
341387 ]
342388 where
343389 githubCfg = defConfig
@@ -358,62 +404,84 @@ encodeThunkPtrData (ThunkPtr rev src) = case src of
358404 [ "url"
359405 , "rev"
360406 , "sha256"
407+ , "private"
361408 , "fetchSubmodules"
362409 ] <> compare
363410 , confTrailingNewline = True
364411 }
365412
366−createThunk :: MonadIO m => FilePath -> ThunkPtr -> m ()
367−createThunk target thunk = liftIO $ do
368− createDirectoryIfMissing True (target </> ".attr-cache")
369− T.writeFile (target </> "default.nix") (thunkPtrLoader thunk)
370− let
371− jsonFileName = case _thunkPtr_source thunk of
372− ThunkSource_GitHub _ -> "github"
373− ThunkSource_Git _ -> "git"
374− 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
375428
376429createThunkWithLatest :: MonadObelisk m => FilePath -> ThunkSource -> m ()
377430createThunkWithLatest target s = do
378431 rev <- getLatestRev s
379− createThunk target $ ThunkPtr
432+ createThunk target $ Right $ ThunkPtr
380433 { _thunkPtr_source = s
381434 , _thunkPtr_rev = rev
382435 }
383436
384−updateThunkToLatest :: MonadObelisk m => FilePath -> Maybe String -> m ()
385−updateThunkToLatest target mBranch = withSpinner' ("Updating thunk " <> T.pack target <> " to latest") (pure $ const $ "Thunk " <> T.pack target <> " updated to latest") $
437+updateThunkToLatest :: MonadObelisk m => ThunkUpdateConfig -> FilePath -> m ()
438+updateThunkToLatest (ThunkUpdateConfig mBranch thunkConfig) target = spinner $ do
439+ checkThunkDirectory target
440+ -- check to see if thunk should be updated to a specific branch or just update it's current branch
386441 case mBranch of
387442 Nothing -> do
388443 (overwrite, ptr) <- readThunk target >>= \case
389− Left err -> failWith $ T.pack $ "thunk update: " <> show err
444+ Left err -> failWith [i|Thunk update: ${err}|]
390445 Right c -> case c of
391− ThunkData_Packed t -> return (target, t)
392− ThunkData_Checkout _ -> failWith "cannot update an unpacked thunk"
446+ ThunkData_Packed _ t -> return (target, t)
447+ ThunkData_Checkout -> failWith "cannot update an unpacked thunk"
393448 let src = _thunkPtr_source ptr
394449 rev <- getLatestRev src
395− overwriteThunk overwrite $ ThunkPtr
450+ overwriteThunk overwrite $ modifyThunkPtrByConfig thunkConfig $ ThunkPtr
396451 { _thunkPtr_source = src
397452 , _thunkPtr_rev = rev
398453 }
399− Just branch -> setThunk branch target
454+ Just branch -> readThunk target >>= \case
455+ Left err -> failWith [i|Thunk update: ${err}|]
456+ Right c -> case c of
457+ ThunkData_Packed _ t -> setThunk thunkConfig target (thunkSourceToGitSource $ _thunkPtr_source t) branch
458+ ThunkData_Checkout -> failWith [i|Thunk located at ${target} is unpacked. Use 'ob thunk pack' on the desired directory and then try 'ob thunk update' again.|]
459+ where
460+ spinner = withSpinner' ("Updating thunk " <> T.pack target <> " to latest") (pure $ const $ "Thunk " <> T.pack target <> " updated to latest")
461+
462+setThunk :: MonadObelisk m => ThunkConfig -> FilePath -> GitSource -> String -> m ()
463+setThunk thunkConfig target gs branch = do
464+ newThunkPtr <- uriThunkPtr (_gitSource_url gs) (_thunkConfig_private thunkConfig) (Just $ T.pack branch) Nothing
465+ overwriteThunk target newThunkPtr
466+ updateThunkToLatest (ThunkUpdateConfig Nothing thunkConfig) target
400467
401468-- | All recognized github standalone loaders, ordered from newest to oldest.
402469-- This tool will only ever produce the newest one when it writes a thunk.
403−gitHubStandaloneLoaders :: NonEmpty Text
404−gitHubStandaloneLoaders =
405− gitHubStandaloneLoaderV2 :|
406− [ gitHubStandaloneLoaderV3
407− , gitHubStandaloneLoaderV1
470+gitHubThunkSpecs :: NonEmpty ThunkSpec
471+gitHubThunkSpecs =
472+ gitHubThunkSpecV5 :|
473+ [ gitHubThunkSpecV4
474+ , gitHubThunkSpecV3
475+ , gitHubThunkSpecV2
476+ , gitHubThunkSpecV1
408477 ]
409478
410−gitHubStandaloneLoaderV1 :: Text
411−gitHubStandaloneLoaderV1 = T.unlines
412− [ "import ((import <nixpkgs> {}).fetchFromGitHub (builtins.fromJSON (builtins.readFile ./github.json)))"
413− ]
479+gitHubThunkSpecV1 :: ThunkSpec
480+gitHubThunkSpecV1 = legacyGitHubThunkSpec "github-v1"
481+ "import ((import <nixpkgs> {}).fetchFromGitHub (builtins.fromJSON (builtins.readFile ./github.json)))"
414482
415−gitHubStandaloneLoaderV2 :: Text
416−gitHubStandaloneLoaderV2 = T.unlines
483+gitHubThunkSpecV2 :: ThunkSpec
484+gitHubThunkSpecV2 = legacyGitHubThunkSpec "github-v2" $ T.unlines
417485 [ "# DO NOT HAND-EDIT THIS FILE" --TODO: Add something about how to get more info on Obelisk, etc.
418486 , "import ((import <nixpkgs> {}).fetchFromGitHub ("
419487 , " let json = builtins.fromJSON (builtins.readFile ./github.json);"
@@ -423,8 +491,8 @@ gitHubStandaloneLoaderV2 = T.unlines
423491 , "))"
424492 ]
425493
426−gitHubStandaloneLoaderV3 :: Text
427−gitHubStandaloneLoaderV3 = T.unlines
494+gitHubThunkSpecV3 :: ThunkSpec
495+gitHubThunkSpecV3 = legacyGitHubThunkSpec "github-v3" $ T.unlines
428496 [ "# DO NOT HAND-EDIT THIS FILE"
429497 , "let"
430498 , " fetch = { private ? false, ... }@args: if private && builtins.hasAttr \"fetchGit\" builtins"
@@ -443,22 +511,62 @@ gitHubStandaloneLoaderV3 = T.unlines
443511 , "in import (fetch (builtins.fromJSON (builtins.readFile ./github.json)))"
444512 ]
445513
446−plainGitStandaloneLoaders :: NonEmpty Text
447−plainGitStandaloneLoaders =
448− plainGitStandaloneLoaderV1 :|
449− [ 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)))"
450524 ]
451525
452−plainGitStandaloneLoaderV1 :: Text
453−plainGitStandaloneLoaderV1 = T.unlines
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
558+ ]
559+
560+gitThunkSpecV1 :: ThunkSpec
561+gitThunkSpecV1 = legacyGitThunkSpec "git-v1" $ T.unlines
454562 [ "# DO NOT HAND-EDIT THIS FILE"
455563 , "let fetchGit = {url, rev, ref ? null, branch ? null, sha256 ? null, fetchSubmodules ? null}:"
456564 , " assert !fetchSubmodules; (import <nixpkgs> {}).fetchgit { inherit url rev sha256; };"
457565 , "in import (fetchGit (builtins.fromJSON (builtins.readFile ./git.json)))"
458566 ]
459567
460−plainGitStandaloneLoaderV2 :: Text
461−plainGitStandaloneLoaderV2 = T.unlines
568+gitThunkSpecV2 :: ThunkSpec
569+gitThunkSpecV2 = legacyGitThunkSpec "git-v2" $ T.unlines
462570 [ "# DO NOT HAND-EDIT THIS FILE"
463571 , "let fetchGit = {url, rev, ref ? null, branch ? null, sha256 ? null, fetchSubmodules ? null}:"
464572 , " if builtins.hasAttr \"fetchGit\" builtins"
@@ -467,10 +575,87 @@ plainGitStandaloneLoaderV2 = T.unlines
467575 , "in import (fetchGit (builtins.fromJSON (builtins.readFile ./git.json)))"
468576 ]
469577
470−thunkFileNames :: [FilePath]
471−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+ ]
612+
613+legacyGitThunkSpec :: Text -> Text -> ThunkSpec
614+legacyGitThunkSpec name loader = ThunkSpec name $ Map.fromList
615+ [ ("default.nix", ThunkFileSpec_FileMatches $ T.strip loader)
616+ , ("git.json" , ThunkFileSpec_Ptr parseGitJsonBytes)
617+ , (attrCacheFileName, ThunkFileSpec_AttrCache)
618+ , (".git", ThunkFileSpec_CheckoutIndicator)
619+ ]
620+
621+gitThunkSpecV5 :: ThunkSpec
622+gitThunkSpecV5 = mkThunkSpec "git-v5" "git.json" parseGitJsonBytes [here|
623+# DO NOT HAND-EDIT THIS FILE
624+let fetch = {url, rev, branch ? null, sha256 ? null, fetchSubmodules ? false, private ? false, ...}:
625+ let realUrl = let firstChar = builtins.substring 0 1 url; in
626+ if firstChar == "/" then /. + url
627+ else if firstChar == "." then ./. + url
628+ else url;
629+ in if !fetchSubmodules && private then builtins.fetchGit {
630+ url = realUrl; inherit rev;
631+ ${if branch == null then null else "ref"} = branch;
632+ } else (import <nixpkgs> {}).fetchgit {
633+ url = realUrl; inherit rev sha256;
634+ };
635+ json = builtins.fromJSON (builtins.readFile ./git.json);
636+in fetch json
637+|]
638+
639+parseGitJsonBytes :: LBS.ByteString -> Either String ThunkPtr
640+parseGitJsonBytes = parseJsonObject $ parseThunkPtr $ fmap ThunkSource_Git . parseGitSource
641+
642+mkThunkSpec :: Text -> FilePath -> (LBS.ByteString -> Either String ThunkPtr) -> Text -> ThunkSpec
643+mkThunkSpec name jsonFileName parser srcNix = ThunkSpec name $ Map.fromList
644+ [ ("default.nix", ThunkFileSpec_FileMatches defaultNixViaSrc)
645+ , ("thunk.nix", ThunkFileSpec_FileMatches srcNix)
646+ , (jsonFileName, ThunkFileSpec_Ptr parser)
647+ , (attrCacheFileName, ThunkFileSpec_AttrCache)
648+ , (normalise $ unpackedDirName </> ".git", ThunkFileSpec_CheckoutIndicator)
649+ ]
650+ where
651+ defaultNixViaSrc = [here|
652+# DO NOT HAND-EDIT THIS FILE
653+import (import ./thunk.nix)
654+|]
655+
472656
473−--TODO: when checking something out, make a shallow clone
657+parseJsonObject :: (Aeson.Object -> Aeson.Parser a) -> LBS.ByteString -> Either String a
658+parseJsonObject p bytes = Aeson.parseEither p =<< Aeson.eitherDecode bytes
474659
475660-- | Checks a cache directory to see if there is a fresh symlink
476661-- to the result of building an attribute of a thunk.
@@ -478,44 +663,49 @@ thunkFileNames = ["default.nix", "github.json", "git.json"]
478663-- and the result is symlinked into the cache.
479664nixBuildThunkAttrWithCache
480665 :: MonadObelisk m
481− => FilePath
666+ => ThunkSpec
667+ -> FilePath
482668 -- ^ Path to directory containing Thunk
483669 -> String
484670 -- ^ Attribute to build
485− -> m FilePath
671+ -> m (Maybe FilePath)
486672 -- ^ Symlink to cached or built nix output
487673-- WARNING: If the thunk uses an impure reference such as '<nixpkgs>'
488674-- the caching mechanism will fail as it merely measures the modification
489675-- time of the cache link and the expression to build.
490−nixBuildThunkAttrWithCache thunkDir attr = do
491− --NB: Expects thunkDir to be normalised with no trailing path separator.
492− --This should be guaranteed by the command argument parser.
493− let cacheErrHandler e
494− | isDoesNotExistError e = return Nothing -- expected from a cache miss
495− | otherwise = putLog Error (T.pack $ displayException e) >> return Nothing
496− cacheDir = thunkDir </> ".attr-cache"
497− cachePath = cacheDir </> attr <.> "out"
676+nixBuildThunkAttrWithCache thunkSpec thunkDir attr = do
498677 latestChange <- liftIO $ do
499− createDirectoryIfMissing False cacheDir
500− let getModificationTimeMaybe = fmap rightToMaybe . try @IOError . getModificationTime
501− maximum . catMaybes <$> mapM (getModificationTimeMaybe . (thunkDir </>)) thunkFileNames
502− cacheHit <- handle cacheErrHandler $ do
503− cacheTime <- liftIO $ posixSecondsToUTCTime . realToFrac . modificationTime <$> getSymbolicLinkStatus cachePath
504− return $ if latestChange <= cacheTime
505− then Just cachePath
506− else Nothing
507− case cacheHit of
508− Just c -> return c
509− Nothing -> do
510− putLog Warning $ T.pack $ mconcat [thunkDir, ": ", attr, " not cached, building ..."]
511− _ <- nixCmd $ NixCmd_Build$ def
512− Lens.& nixBuildConfig_outLink Lens..~ OutLink_IndirectRoot cachePath
513− Lens.& nixCmdConfig_target Lens..~ Target
514− { _target_path = Just thunkDir
515− , _target_attr = Just attr
516− , _target_expr = Nothing
517− }
518− 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+ }
519709
520710-- | Build a nix attribute, and cache the result if possible
521711nixBuildAttrWithCache
@@ -526,13 +716,15 @@ nixBuildAttrWithCache
526716 -- ^ Attribute to build
527717 -> m FilePath
528718 -- ^ Symlink to cached or built nix output
529−nixBuildAttrWithCache exprPath attr = do
530− readThunk exprPath >>= \case
531− -- Only packed thunks are cached. in particular, checkouts are not
532− Right (ThunkData_Packed _) -> nixBuildThunkAttrWithCache exprPath attr
533− _ -> nixCmd $ NixCmd_Build $ def
534− Lens.& nixBuildConfig_outLink Lens..~ OutLink_None
535− 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
536728 { _target_path = Just exprPath
537729 , _target_attr = Just attr
538730 , _target_expr = Nothing
@@ -553,137 +745,153 @@ updateThunk p f = withSystemTempDirectory "obelisk-thunkptr-" $ \tmpDir -> do
553745 where
554746 copyThunkToTmp tmpDir thunkDir = readThunk thunkDir >>= \case
555747 Left err -> failWith $ "withThunkUnpacked: " <> T.pack (show err)
556− Right (ThunkData_Packed _) -> do
748+ Right ThunkData_Packed{} -> do
557749 let tmpThunk = tmpDir </> "thunk"
558750 callProcessAndLogOutput (Notice, Error) $
559− proc "cp" ["-r", "-T", thunkDir, tmpThunk]
751+ proc cp ["-r", "-T", thunkDir, tmpThunk]
560752 return tmpThunk
561− Right _ -> failWith $ "Thunk is not packed"
753+ Right _ -> failWith "Thunk is not packed"
562754 updateThunkFromTmp p' = do
563− _ <- packThunk' True p'
755+ _ <- packThunk' True (ThunkPackConfig False (ThunkConfig Nothing)) p'
564756 callProcessAndLogOutput (Notice, Error) $
565− proc "cp" ["-r", "-T", p', p]
757+ proc cp ["-r", "-T", p', p]
566758
567759finalMsg :: Bool -> (a -> Text) -> Maybe (a -> Text)
568760finalMsg noTrail s = if noTrail then Nothing else Just s
569761
570−unpackThunk :: MonadObelisk m => FilePath -> m ()
571−unpackThunk = unpackThunk' False
572−
573762-- | Check that we are not somewhere inside the thunk directory
574763checkThunkDirectory :: MonadObelisk m => FilePath -> m ()
575764checkThunkDirectory thunkDir = do
576765 currentDir <- liftIO getCurrentDirectory
577766 thunkDir' <- liftIO $ canonicalizePath thunkDir
578767 when (thunkDir' `L.isInfixOf` currentDir) $
579− failWith "Can't pack/unpack from within the thunk directory"
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
580778
581779unpackThunk' :: MonadObelisk m => Bool -> FilePath -> m ()
582−unpackThunk' noTrail thunkDir = checkThunkDirectory thunkDir >> readThunk thunkDir >>= \case
583− 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}|]
584782 --TODO: Overwrite option that rechecks out thunk; force option to do so even if working directory is dirty
585− Right (ThunkData_Checkout _) -> failWith "thunk unpack: thunk is already unpacked"
586− Right (ThunkData_Packed tptr) -> do
783+ Right ThunkData_Checkout -> failWith [i|Thunk at ${thunkDir} is already unpacked|]
784+ Right (ThunkData_Packed _ tptr) -> do
587785 let (thunkParent, thunkName) = splitFileName thunkDir
588− withTempDirectory thunkParent thunkName $ \tmpRepo -> do
589− let obGitDir = tmpRepo </> ".git" </> "obelisk"
590− s = case _thunkPtr_source tptr of
591− ThunkSource_GitHub s' -> forgetGithub False s'
592− 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
593792 withSpinner' ("Fetching thunk " <> T.pack thunkName)
594793 (finalMsg noTrail $ const $ "Fetched thunk " <> T.pack thunkName) $ do
595− let git = callProcessAndLogOutput (Notice, Notice) . gitProc tmpRepo
596− git $ [ "clone" ]
597− ++ ("--recursive" <$ guard (_gitSource_fetchSubmodules s))
598− ++ [ T.unpack $ render $ _gitSource_url s ]
599− ++ do branch <- maybeToList $ _gitSource_branch s
600− [ "--branch", T.unpack $ untagName branch ]
601− git ["reset", "--hard", Ref.toHexString $ _thunkRev_commit $ _thunkPtr_rev tptr]
602− when (_gitSource_fetchSubmodules s) $
603− git ["submodule", "update", "--recursive", "--init"]
604−
605− liftIO $ createDirectory obGitDir
606− callProcessAndLogOutput (Notice, Error) $
607− proc "cp" ["-r", "-T", thunkDir </> ".", obGitDir </> "orig-thunk"]
608− callProcessAndLogOutput (Notice, Error) $
609− proc "rm" ["-r", thunkDir]
610− callProcessAndLogOutput (Notice, Error) $
611− 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"]
612821
613−--TODO: add force mode to pack even if changes are present
614822--TODO: add a rollback mode to pack to the original thunk
615−packThunk :: MonadObelisk m => FilePath -> m ThunkPtr
823+packThunk :: MonadObelisk m => ThunkPackConfig -> FilePath -> m ThunkPtr
616824packThunk = packThunk' False
617825
618−packThunk' :: MonadObelisk m => Bool -> FilePath -> m ThunkPtr
619−packThunk' noTrail thunkDir = checkThunkDirectory thunkDir >> readThunk thunkDir >>= \case
620− Left err -> failWith $ T.pack $ "thunk pack: " <> show err
621− Right (ThunkData_Packed _) -> failWith "pack: thunk is already packed"
622− Right (ThunkData_Checkout _) -> do
623− withSpinner' ("Packing thunk " <> T.pack thunkDir)
624− (finalMsg noTrail $ const $ "Packed thunk " <> T.pack thunkDir) $ do
625− thunkPtr <- getThunkPtr thunkDir
626− callProcessAndLogOutput (Debug, Error) $ proc "rm" ["-rf", thunkDir]
627− 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
628837 pure thunkPtr
629838
630−-- set thunk to a desired branch
631−setThunk :: MonadObelisk m => String -> FilePath -> m ()
632−setThunk branch thunkDir = checkThunkDirectory thunkDir >> readThunk thunkDir >>= \case
633− Left err -> failWith $ T.pack $ "thunk set : " <> show err
634− Right (ThunkData_Packed thunkptr) -> do
635− let thunkSrc = _thunkPtr_source thunkptr
636− repository = case thunkSrc of
637− ThunkSource_Git gitSource -> T.unpack $ render $ _gitSource_url gitSource
638− ThunkSource_GitHub gitHubSource -> T.unpack $ render $ _gitSource_url $ forgetGithub True gitHubSource
639− -- check to see if branch exists before modifying directory
640− (exitCode, _) <- gitLsRemote repository Nothing $ Just branch
641− case exitCode of
642− ExitSuccess -> do
643− remoteResults <- readGitProcessNoRepo ["ls-remote", repository, branch]
644− uri <- mkURI $ T.pack repository
645− let eitherrev = headErr "rev for branch cannot be found" $ T.words remoteResults -- TODO: Don't use head
646− case eitherrev of
647− Left notFound -> failWith notFound
648− Right rev -> do
649− sha256 <- nixPrefetchGit uri rev False
650− let newThunkPtr = ThunkPtr
651− { _thunkPtr_source = case _thunkPtr_source thunkptr of
652− ThunkSource_Git gitSource -> ThunkSource_Git $ gitSource { _gitSource_branch = Just $ N $ T.pack branch }
653− ThunkSource_GitHub gitHubSource -> ThunkSource_GitHub $ gitHubSource { _gitHubSource_branch = Just $ N $ T.pack branch }
654− , _thunkPtr_rev = ThunkRev
655− { _thunkRev_commit = Ref.hash $ encodeUtf8 rev
656− , _thunkRev_nixSha256 = sha256
657− }
658− }
659− overwriteThunk thunkDir newThunkPtr
660− updateThunkToLatest thunkDir Nothing
661− ExitFailure errNum -> failWith $ T.pack $ if errNum == 2
662− then "Error: branch not found"
663− else ("Error Code: " <> show errNum <> "issue checking out the desired branch")
664− Right (ThunkData_Checkout _) -> failWith $ T.pack $ "thunk located at " <> (show thunkDir) <> " is unpacked. Use ob thunk pack on the desired directory and then try ob thunk update again."
665−
666−getThunkPtr :: MonadObelisk m => FilePath -> m ThunkPtr
667−getThunkPtr = getThunkPtr' True
668−
669−getThunkPtr' :: forall m. MonadObelisk m => Bool -> FilePath -> m ThunkPtr
670−getThunkPtr' checkClean thunkDir = do
671− 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
672869 "thunk pack: thunk checkout contains unsaved modifications"
673870
674871 -- Check whether there are any stashes
675− stashOutput <- readGitProcess thunkDir ["stash", "list"]
676− when checkClean $ case T.null stashOutput of
677− False -> do
872+ when checkClean $ do
873+ stashOutput <- readGitProcess thunkDir ["stash", "list"]
874+ unless (T.null stashOutput) $
678875 failWith $ T.unlines $
679876 [ "thunk pack: thunk checkout has stashes"
680877 , "git stash list:"
681878 ] ++ T.lines stashOutput
682− True -> return ()
879+
880+ -- Get current branch
881+ (mCurrentBranch, mCurrentCommit) <- do
882+ b <- listToMaybe . T.lines <$> readGitProcess thunkDir ["rev-parse", "--abbrev-ref", "HEAD"]
883+ c <- listToMaybe . T.lines <$> readGitProcess thunkDir ["rev-parse", "HEAD"]
884+ case b of
885+ (Just "HEAD") -> failWith $ T.unlines
886+ [ "thunk pack: You are in 'detached HEAD' state."
887+ , "If you want to pack at the current ref \
888+ \then please create a new branch with 'git checkout -b <new-branch-name>' and push this upstream."
889+ ]
890+ _ -> return (b, c)
683891
684892 -- Get information on all branches and their (optional) designated upstream
685893 -- correspondents
686− (headDump :: [Text]) <- T.lines <$> readGitProcess thunkDir
894+ headDump :: [Text] <- T.lines <$> readGitProcess thunkDir
687895 [ "for-each-ref"
688896 , "--format=%(refname:short) %(upstream:short) %(upstream:remotename)"
689897 , "refs/heads/"
@@ -729,7 +937,7 @@ getThunkPtr' checkClean thunkDir = do
729937 ]
730938
731939 -- loosely by https://stackoverflow.com/questions/7773939/show-git-ahead-and-behind-info-for-all-branches-including-remotes
732− stats <- iforM headUpstream $ \branch (upstream, _remote) -> do
940+ stats <- ifor headUpstream $ \branch (upstream, _remote) -> do
733941 (stat :: [Text]) <- T.lines <$> readGitProcess thunkDir
734942 [ "rev-list", "--left-right"
735943 , T.unpack branch <> "..." <> T.unpack upstream
@@ -746,20 +954,16 @@ getThunkPtr' checkClean thunkDir = do
746954 [ "thunk pack: Certain branches in the thunk have commits not yet pushed upstream:"
747955 , ""
748956 ] ++
749− (flip map (Map.toList nonGood) $ \(branch, (upstream, (ahead, behind))) -> mconcat
957+ flip map (Map.toList nonGood) (\(branch, (upstream, (ahead, behind))) -> mconcat
750958 [" ", branch, " ahead: ", T.pack (show ahead), " behind: ", T.pack (show behind), " remote branch ", upstream]) ++
751959 [ ""
752960 , "Please push these upstream and try again. (Or just fetch, if they are somehow \
753961 \pushed but this repo's remote tracking branches don't know it.)"
754962 ]
755963
756− -- We assume it's safe to pack the thunk at this point
757− putLog Informational $ "All changes safe in git remotes. OK to pack thunk."
758−
759− -- Get current branch ``
760− mCurrentBranch <- listToMaybe
761− <$> T.lines
762− <$> readGitProcess thunkDir ["rev-parse", "--abbrev-ref", "HEAD"]
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."
763967
764968 let remote = maybe "origin" snd $ flip Map.lookup headUpstream =<< mCurrentBranch
765969
@@ -772,14 +976,12 @@ getThunkPtr' checkClean thunkDir = do
772976 remoteUri <- case parseGitUri remoteUri' of
773977 Nothing -> failWith $ "Could not identify git remote: " <> remoteUri'
774978 Just uri -> pure uri
775− uriThunkPtr remoteUri mCurrentBranch
979+ uriThunkPtr remoteUri mPrivate mCurrentBranch mCurrentCommit
776980
777981-- | Get the latest revision available from the given source
778982getLatestRev :: MonadObelisk m => ThunkSource -> m ThunkRev
779983getLatestRev os = do
780− let gitS = case os of
781− ThunkSource_GitHub s -> forgetGithub False s
782− ThunkSource_Git s -> s
984+ let gitS = thunkSourceToGitSource os
783985 (_, commit) <- gitGetCommitBranch (_gitSource_url gitS) (untagName <$> _gitSource_branch gitS)
784986 case os of
785987 ThunkSource_GitHub s -> githubThunkRev s commit
@@ -791,16 +993,18 @@ getLatestRev os = do
791993-- performance. If that doesn't work (e.g. authentication issue), we fall back
792994-- on just doing things the normal way for git repos in general, and save it as
793995-- a regular git thunk.
794−uriThunkPtr :: MonadObelisk m => URI -> Maybe Text -> m ThunkPtr
795−uriThunkPtr uri mbranch = do
796− (_, commit) <- gitGetCommitBranch uri mbranch
797− (src, rev) <- case uriToThunkSource uri mbranch of
996+uriThunkPtr :: MonadObelisk m => GitUri -> Maybe Bool -> Maybe Text -> Maybe Text -> m ThunkPtr
997+uriThunkPtr uri mPrivate mbranch mcommit = do
998+ commit <- case mcommit of
999+ Nothing -> gitGetCommitBranch uri mbranch >>= return . snd
1000+ (Just c) -> return c
1001+ (src, rev) <- uriToThunkSource uri mPrivate mbranch >>= \case
7981002 ThunkSource_GitHub s -> do
7991003 rev <- runExceptT $ githubThunkRev s commit
8001004 case rev of
8011005 Right r -> pure (ThunkSource_GitHub s, r)
8021006 Left e -> do
803− putLog Warning $ "\
1007+ putLog Warning "\
8041008\Failed to fetch archive from GitHub. This is probably a private repo. \
8051009\Falling back on normal fetchgit. Original failure:"
8061010 errorToWarning e
@@ -817,34 +1021,66 @@ uriThunkPtr uri mbranch = do
8171021-- If the thunk is a GitHub thunk and fails, we do *not* fall back like with
8181022-- `uriThunkPtr`. Unlike a plain URL, a thunk src explicitly states which method
8191023-- should be employed, and so we respect that.
820−uriToThunkSource :: URI -> Maybe Text -> ThunkSource
821−uriToThunkSource u
822− | Right uriAuth <- uriAuthority u
823− , 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
8241028 , case scheme of
825− "ssh" -> uriAuth == Authority
826− { authUserInfo = Just $ UserInfo (fromRight' $ mkUsername "git") Nothing
827− , authHost = fromRight' $ mkHost "github.com"
828− , 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
8291033 }
8301034 s -> s `L.elem` [ "git", "https", "http" ] -- "http:" just redirects to "https:"
831− && unRText (authHost uriAuth) == "github.com"
832− , Just (_, owner :| [repoish]) <- uriPath u
833− = \mbranch -> ThunkSource_GitHub $ GitHubSource
834− { _gitHubSource_owner = N $ unRText owner
835− , _gitHubSource_repo = N $ let
836− repoish' = unRText repoish
837− in case T.stripSuffix ".git" repoish' of
838− Just repo -> repo
839− Nothing -> repoish'
840− , _gitHubSource_branch = N <$> mbranch
841− }
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+ }
8421047
843− | otherwise = \mbranch -> ThunkSource_Git $ GitSource
844− { _gitSource_url = u
845− , _gitSource_branch = N <$> mbranch
846− , _gitSource_fetchSubmodules = False -- TODO: How do we determine if this should be true?
847− }
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+ }
8481084
8491085-- Funny signature indicates no effects depend on the optional branch name.
8501086githubThunkRev
@@ -856,19 +1092,19 @@ githubThunkRev
8561092githubThunkRev s commit = do
8571093 owner <- forcePP $ _gitHubSource_owner s
8581094 repo <- forcePP $ _gitHubSource_repo s
859− revTarball <- mkPathPiece $ commit <> ".tar.gz"
860− let archiveUri = URI
861− { uriScheme = Just $ fromRight' $ mkScheme "https"
862− , uriAuthority = Right $ Authority
863− { authUserInfo = Nothing
864− , authHost = fromRight' $ mkHost "github.com"
865− , 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
8661102 }
867− , uriPath = Just ( False
868− , owner :| [ repo, fromRight' $ mkPathPiece "archive", revTarball ]
1103+ , URI.uriPath = Just ( False
1104+ , owner :| [ repo, fromRight' $ URI.mkPathPiece "archive", revTarball ]
8691105 )
870− , uriQuery = []
871− , uriFragment = Nothing
1106+ , URI.uriQuery = []
1107+ , URI.uriFragment = Nothing
8721108 }
8731109 hash <- getNixSha256ForUriUnpacked archiveUri
8741110 putLog Debug $ "Nix sha256 is " <> hash
@@ -877,8 +1113,8 @@ githubThunkRev s commit = do
8771113 , _thunkRev_nixSha256 = hash
8781114 }
8791115 where
880− forcePP :: Name entity -> m (RText 'PathPiece)
881− forcePP = mkPathPiece . untagName
1116+ forcePP :: Name entity -> m (URI.RText 'URI.PathPiece)
1117+ forcePP = URI.mkPathPiece . untagName
8821118
8831119gitThunkRev
8841120 :: MonadObelisk m
@@ -887,11 +1123,11 @@ gitThunkRev
8871123 -> m ThunkRev
8881124gitThunkRev s commit = do
8891125 let u = _gitSource_url s
890− protocols = ["https", "ssh", "git"]
891− Just scheme <- pure $ unRText <$> uriScheme u
1126+ protocols = ["file", "https", "ssh", "git"]
1127+ scheme = maybe "file" URI.unRText $ URI.uriScheme $ (\(GitUri x) -> x) u
8921128 unless (T.toLower scheme `elem` protocols) $
8931129 failWith $ "obelisk currently only supports "
894− <> T.intercalate ", " protocols <> " protocols for non-GitHub remotes"
1130+ <> T.intercalate ", " protocols <> " protocols for plain Git remotes"
8951131 hash <- nixPrefetchGit u commit $ _gitSource_fetchSubmodules s
8961132 putLog Informational $ "Nix sha256 is " <> hash
8971133 pure $ ThunkRev
@@ -904,11 +1140,12 @@ gitThunkRev s commit = do
9041140--
9051141-- If the branch name is passed in, it is returned exactly as-is. If it is not
9061142-- passed it, the default branch of the repo is used instead.
1143+
9071144gitGetCommitBranch
908− :: MonadObelisk m => URI -> Maybe Text -> m (Text, CommitId)
1145+ :: MonadObelisk m => GitUri -> Maybe Text -> m (Text, CommitId)
9091146gitGetCommitBranch uri mbranch = withExitFailMessage ("Failure for git remote " <> uriMsg) $ do
9101147 (_, bothMaps) <- gitLsRemote
911− (T.unpack $ render uri)
1148+ (T.unpack $ gitUriToText uri)
9121149 (GitRef_Branch <$> mbranch)
9131150 Nothing
9141151 branch <- case mbranch of
@@ -924,18 +1161,21 @@ gitGetCommitBranch uri mbranch = withExitFailMessage ("Failure for git remote "
9241161 pure (branch, commit)
9251162 where
9261163 rethrowE = either failWith pure
927− uriMsg = render uri
1164+ uriMsg = gitUriToText uri
1165+
1166+parseGitUri :: Text -> Maybe GitUri
1167+parseGitUri x = GitUri <$> (parseFileURI x <|> parseAbsoluteURI x <|> parseSshShorthand x)
9281168
929−parseGitUri :: Text -> Maybe URI
930−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
9311171
932−parseAbsoluteURI :: Text -> Maybe URI
1172+parseAbsoluteURI :: Text -> Maybe URI.URI
9331173parseAbsoluteURI uri = do
934− parsedUri <- mkURI uri
935− guard $ isPathAbsolute parsedUri
936− pure $ parsedUri
1174+ parsedUri <- URI.mkURI uri
1175+ guard $ URI.isPathAbsolute parsedUri
1176+ pure parsedUri
9371177
938−parseSshShorthand :: Text -> Maybe URI
1178+parseSshShorthand :: Text -> Maybe URI.URI
9391179parseSshShorthand uri = do
9401180 -- This is what git does to check that the remote
9411181 -- is not a local file path when parsing shorthand.
@@ -948,4 +1188,4 @@ parseSshShorthand uri = do
9481188 -- This check is used to disambiguate a filepath containing a colon from shorthand
9491189 guard $ isNothing (T.findIndex (=='/') authAndHostname)
9501190 && not (T.null colonAndPath)
951− mkURI properUri
1191+ URI.mkURI properUri