@@ -5,59 +5,71 @@
5{-# LANGUAGE MultiWayIf #-}
5{-# LANGUAGE MultiWayIf #-}
6{-# LANGUAGE OverloadedStrings #-}
6{-# LANGUAGE OverloadedStrings #-}
7{-# LANGUAGE PatternGuards #-}
7{-# LANGUAGE PatternGuards #-}
8−{-# LANGUAGE QuasiQuotes #-}
9{-# LANGUAGE ScopedTypeVariables #-}
8{-# LANGUAGE ScopedTypeVariables #-}
10{-# LANGUAGE TypeApplications #-}
9{-# LANGUAGE TypeApplications #-}
11−module Obelisk.Command.Thunk where
10+module Obelisk.Command.Thunk
15+ , ReadThunkError (..)
19+ , updateThunkToLatest
21+ , createThunkWithLatest
22+ , nixBuildAttrWithCache
23+ , nixBuildThunkAttrWithCache
13import Control.Applicative
34import Control.Applicative
14import Control.Exception (displayException, try)
35import Control.Exception (displayException, try)
15−import Control.Lens (ifor, ifor_, (.~))
36+import Control.Lens.Indexed hiding ((<.>))
16import Control.Monad
37import Control.Monad
17−import Control.Monad.Extra (findM)
38+import Control.Monad.Catch (handle)
18−import Control.Monad.Catch (MonadCatch, handle)
19import Control.Monad.Except
39import Control.Monad.Except
20import Data.Aeson ((.=))
40import Data.Aeson ((.=))
21import qualified Data.Aeson as Aeson
41import qualified Data.Aeson as Aeson
22import Data.Aeson.Encode.Pretty
42import Data.Aeson.Encode.Pretty
23import qualified Data.Aeson.Types as Aeson
43import qualified Data.Aeson.Types as Aeson
24−import Data.Bifunctor (first)
25import qualified Data.ByteString.Lazy as LBS
44import qualified Data.ByteString.Lazy as LBS
26−import Data.Containers.ListUtils (nubOrd)
27import Data.Default
45import Data.Default
28import Data.Either.Combinators (fromRight', rightToMaybe)
46import Data.Either.Combinators (fromRight', rightToMaybe)
29−import Data.Foldable (toList)
30−import Data.Function ((&))
31−import Data.Functor ((<&>))
32import Data.Git.Ref (Ref)
47import Data.Git.Ref (Ref)
33import qualified Data.Git.Ref as Ref
48import qualified Data.Git.Ref as Ref
34import qualified Data.List as L
49import qualified Data.List as L
35−import Data.List.NonEmpty (NonEmpty (..), nonEmpty)
50+import Data.List.NonEmpty (NonEmpty (..))
36import qualified Data.List.NonEmpty as NonEmpty
51import qualified Data.List.NonEmpty as NonEmpty
37import Data.Map (Map)
52import Data.Map (Map)
38import qualified Data.Map as Map
53import qualified Data.Map as Map
39import Data.Maybe
54import Data.Maybe
40import Data.Set (Set)
55import Data.Set (Set)
41import qualified Data.Set as Set
56import qualified Data.Set as Set
42−import Data.String.Here.Interpolated (i)
43−import Data.String.Here.Uninterpolated (here)
44import Data.Text (Text)
57import Data.Text (Text)
45import qualified Data.Text as T
58import qualified Data.Text as T
46import Data.Text.Encoding
59import Data.Text.Encoding
47import qualified Data.Text.IO as T
60import qualified Data.Text.IO as T
48import Data.Time.Clock.POSIX (posixSecondsToUTCTime)
61import Data.Time.Clock.POSIX (posixSecondsToUTCTime)
49−import Data.Traversable (for)
50import Data.Yaml (parseMaybe)
62import Data.Yaml (parseMaybe)
51import GitHub
63import GitHub
52import GitHub.Data.Name
64import GitHub.Data.Name
53import Obelisk.Command.Nix
65import Obelisk.Command.Nix
54import System.Directory
66import System.Directory
56import System.FilePath
67import System.FilePath
57import System.IO.Error
68import System.IO.Error
58import System.IO.Temp
69import System.IO.Temp
59−import System.PosixCompat.Files (getSymbolicLinkStatus, modificationTime)
70+import System.Posix (getSymbolicLinkStatus, modificationTime)
60−import qualified Text.URI as URI
71+import System.Process (proc)
62import Obelisk.App (MonadObelisk)
74import Obelisk.App (MonadObelisk)
63import Obelisk.CliApp
75import Obelisk.CliApp
@@ -65,10 +77,11 @@ import Obelisk.Command.Utils
66--TODO: Support symlinked thunk data
78--TODO: Support symlinked thunk data
67data ThunkData
79data ThunkData
68− = ThunkData_Packed ThunkSpec ThunkPtr
80+ = ThunkData_Packed ThunkPtr
69 -- ^ Packed thunk
81 -- ^ Packed thunk
70− | ThunkData_Checkout
82+ | ThunkData_Checkout (Maybe ThunkPtr)
71 -- ^ Checked out thunk that was unpacked from this pointer
83 -- ^ Checked out thunk that was unpacked from this pointer
84+ deriving (Show, Eq, Ord)
73-- | A reference to the exact data that a thunk should translate into
86-- | A reference to the exact data that a thunk should translate into
74data ThunkPtr = ThunkPtr
87data ThunkPtr = ThunkPtr
@@ -81,7 +94,7 @@ type NixSha256 = Text --TODO: Use a smart constructor and make this actually ver
82-- | A specific revision of data; it may be available from multiple sources
95-- | A specific revision of data; it may be available from multiple sources
83data ThunkRev = ThunkRev
96data ThunkRev = ThunkRev
84− { _thunkRev_commit :: Ref Ref.SHA1
97+ { _thunkRev_commit :: Ref
85 , _thunkRev_nixSha256 :: NixSha256
98 , _thunkRev_nixSha256 :: NixSha256
87 deriving (Show, Eq, Ord)
100 deriving (Show, Eq, Ord)
@@ -94,72 +107,41 @@ data ThunkSource
94 | ThunkSource_Git GitSource
107 | ThunkSource_Git GitSource
95 deriving (Show, Eq, Ord)
108 deriving (Show, Eq, Ord)
97−thunkSourceToGitSource :: ThunkSource -> GitSource
98−thunkSourceToGitSource = \case
99− ThunkSource_GitHub s -> forgetGithub False s
100− ThunkSource_Git s -> s
102data GitHubSource = GitHubSource
110data GitHubSource = GitHubSource
103 { _gitHubSource_owner :: Name Owner
111 { _gitHubSource_owner :: Name Owner
104 , _gitHubSource_repo :: Name Repo
112 , _gitHubSource_repo :: Name Repo
105 , _gitHubSource_branch :: Maybe (Name Branch)
113 , _gitHubSource_branch :: Maybe (Name Branch)
106− , _gitHubSource_private :: Bool
108 deriving (Show, Eq, Ord)
115 deriving (Show, Eq, Ord)
110−newtype GitUri = GitUri { unGitUri :: URI.URI } deriving (Eq, Ord, Show)
112−gitUriToText :: GitUri -> Text
113−gitUriToText (GitUri uri)
114− | (T.toLower . URI.unRText <$> URI.uriScheme uri) == Just "file"
115− , Just (_, path) <- URI.uriPath uri
116− = "/" <> T.intercalate "/" (map URI.unRText $ NonEmpty.toList path)
117− | otherwise = URI.render uri
119data GitSource = GitSource
117data GitSource = GitSource
120− { _gitSource_url :: GitUri
118+ { _gitSource_url :: URI
121 , _gitSource_branch :: Maybe (Name Branch)
119 , _gitSource_branch :: Maybe (Name Branch)
122 , _gitSource_fetchSubmodules :: Bool
120 , _gitSource_fetchSubmodules :: Bool
123− , _gitSource_private :: Bool
125 deriving (Show, Eq, Ord)
122 deriving (Show, Eq, Ord)
127−newtype ThunkConfig = ThunkConfig
128− { _thunkConfig_private :: Maybe Bool
131−data ThunkUpdateConfig = ThunkUpdateConfig
132− { _thunkUpdateConfig_branch :: Maybe String
133− , _thunkUpdateConfig_config :: ThunkConfig
136−data ThunkPackConfig = ThunkPackConfig
137− { _thunkPackConfig_force :: Bool
138− , _thunkPackConfig_config :: ThunkConfig
141-- | Convert a GitHub source to a regular Git source. Assumes no submodules.
124-- | Convert a GitHub source to a regular Git source. Assumes no submodules.
142forgetGithub :: Bool -> GitHubSource -> GitSource
125forgetGithub :: Bool -> GitHubSource -> GitSource
143forgetGithub useSsh s = GitSource
126forgetGithub useSsh s = GitSource
144− { _gitSource_url = GitUri $ URI.URI
127+ { _gitSource_url = URI
145− { URI.uriScheme = Just $ fromRight' $ URI.mkScheme $ if useSsh then "ssh" else "https"
128+ { uriScheme = Just $ fromRight' $ mkScheme $ if useSsh then "ssh" else "https"
146− , URI.uriAuthority = Right $ URI.Authority
129+ , uriAuthority = Right $ Authority
147− { URI.authUserInfo = URI.UserInfo (fromRight' $ URI.mkUsername "git") Nothing
130+ { authUserInfo = UserInfo (fromRight' $ mkUsername "git") Nothing
148 <$ guard useSsh
131 <$ guard useSsh
149− , URI.authHost = fromRight' $ URI.mkHost "github.com"
132+ , authHost = fromRight' $ mkHost "github.com"
150− , URI.authPort = Nothing
133+ , authPort = Nothing
152− , URI.uriPath = Just ( False
135+ , uriPath = Just ( False
153− , fromRight' . URI.mkPathPiece <$>
136+ , fromRight' . mkPathPiece <$>
154 untagName (_gitHubSource_owner s)
137 untagName (_gitHubSource_owner s)
155 :| [ untagName (_gitHubSource_repo s) <> ".git" ]
138 :| [ untagName (_gitHubSource_repo s) <> ".git" ]
157− , URI.uriQuery = []
140+ , uriQuery = []
158− , URI.uriFragment = Nothing
141+ , uriFragment = Nothing
160 , _gitSource_branch = _gitHubSource_branch s
143 , _gitSource_branch = _gitHubSource_branch s
161 , _gitSource_fetchSubmodules = False
144 , _gitSource_fetchSubmodules = False
162− , _gitSource_private = _gitHubSource_private s
165getThunkGitBranch :: ThunkPtr -> Maybe Text
147getThunkGitBranch :: ThunkPtr -> Maybe Text
@@ -167,26 +149,26 @@ getThunkGitBranch (ThunkPtr _ src) = fmap untagName $ case src of
167 ThunkSource_GitHub s -> _gitHubSource_branch s
149 ThunkSource_GitHub s -> _gitHubSource_branch s
168 ThunkSource_Git s -> _gitSource_branch s
150 ThunkSource_Git s -> _gitSource_branch s
170−commitNameToRef :: Name Commit -> Ref Ref.SHA1
152+commitNameToRef :: Name Commit -> Ref
171commitNameToRef (N c) = Ref.fromHex $ encodeUtf8 c
153commitNameToRef (N c) = Ref.fromHex $ encodeUtf8 c
173-- TODO: Use spinner here.
155-- TODO: Use spinner here.
174getNixSha256ForUriUnpacked
156getNixSha256ForUriUnpacked
175 :: MonadObelisk m
157 :: MonadObelisk m
176− => GitUri
158+ => URI
177 -> m NixSha256
159 -> m NixSha256
178getNixSha256ForUriUnpacked uri =
160getNixSha256ForUriUnpacked uri =
179− withExitFailMessage ("nix-prefetch-url: Failed to determine sha256 hash of URL " <> gitUriToText uri) $ do
161+ withExitFailMessage ("nix-prefetch-url: Failed to determine sha256 hash of URL " <> render uri) $ do
180 [hash] <- fmap T.lines $ readProcessAndLogOutput (Debug, Debug) $
162 [hash] <- fmap T.lines $ readProcessAndLogOutput (Debug, Debug) $
181− proc nixPrefetchUrlPath ["--unpack", "--type", "sha256", T.unpack $ gitUriToText uri]
163+ proc "nix-prefetch-url" ["--unpack" , "--type" , "sha256" , T.unpack $ render uri]
182 pure hash
164 pure hash
184−nixPrefetchGit :: MonadObelisk m => GitUri -> Text -> Bool -> m NixSha256
166+nixPrefetchGit :: MonadObelisk m => URI -> Text -> Bool -> m NixSha256
185nixPrefetchGit uri rev fetchSubmodules =
167nixPrefetchGit uri rev fetchSubmodules =
186− withExitFailMessage ("nix-prefetch-git: Failed to determine sha256 hash of Git repo " <> gitUriToText uri <> " at " <> rev) $ do
168+ withExitFailMessage ("nix-prefetch-git: Failed to determine sha256 hash of Git repo " <> render uri <> " at " <> rev) $ do
187 out <- readProcessAndLogStderr Debug $
169 out <- readProcessAndLogStderr Debug $
188− proc nixPrefetchGitPath $ filter (/="")
170+ proc "nix-prefetch-git" $ filter (/="")
189− [ "--url", T.unpack $ gitUriToText uri
171+ [ "--url", T.unpack $ render uri
190 , "--rev", T.unpack rev
172 , "--rev", T.unpack rev
191 , if fetchSubmodules then "--fetch-submodules" else ""
173 , if fetchSubmodules then "--fetch-submodules" else ""
192 , "--quiet"
174 , "--quiet"
@@ -198,117 +180,93 @@ nixPrefetchGit uri rev fetchSubmodules =
199--TODO: Pretty print these
181--TODO: Pretty print these
200data ReadThunkError
182data ReadThunkError
201− = ReadThunkError_UnrecognizedThunk
183+ = ReadThunkError_UnrecognizedFiles
202− | ReadThunkError_UnrecognizedPaths (NonEmpty FilePath)
184+ | ReadThunkError_AmbiguousFiles
203− | ReadThunkError_MissingPaths (NonEmpty FilePath)
185+ | ReadThunkError_UnrecognizedLoader Text
204− | ReadThunkError_UnparseablePtr FilePath String
186+ | ReadThunkError_UnparseablePtr LBS.ByteString
205− | ReadThunkError_FileError IOError
187+ deriving (Show)
206− | ReadThunkError_FileDoesNotMatch FilePath Text
188+
207− | ReadThunkError_UnrecognizedState String
189+-- | Read a thunk and validate that it is only a thunk, either packed or unpacked.
208− | ReadThunkError_AmbiguousPackedState ThunkPtr ThunkPtr
190+-- If the thunk is packed and additional data is present, fail.
209− deriving (Show)
191+readThunk :: MonadObelisk m => FilePath -> m (Either ReadThunkError ThunkData)
210−
192+readThunk thunkDir = do
211−unpackedDirName :: FilePath
193+ files <- liftIO $ listDirectory thunkDir
212−unpackedDirName = "."
194+ case ".git" `elem` files of
213−
195+ True -> fmap ThunkData_Checkout <$> do
214−attrCacheFileName :: FilePath
196+ let origThunkPath = thunkDir </> ".git" </> "obelisk" </> "orig-thunk"
215−attrCacheFileName = ".attr-cache"
197+ liftIO $ doesDirectoryExist origThunkPath >>= \case
216−
198+ True -> fmap Just <$> readPackedThunk origThunkPath
217−-- | Specification for how a file in a thunk version works.
199+ False -> return $ return Nothing
218−data ThunkFileSpec
200+ False -> liftIO $ fmap ThunkData_Packed <$> readPackedThunk thunkDir
219− = ThunkFileSpec_Ptr (LBS.ByteString -> Either String ThunkPtr) -- ^ This file specifies 'ThunkPtr' data
201+
220− | ThunkFileSpec_FileMatches Text -- ^ This file must match the given content exactly
202+data ThunkType = ThunkType
221− | ThunkFileSpec_CheckoutIndicator -- ^ Existence of this directory indicates that the thunk is unpacked
203+ { _thunkType_loader :: FilePath
222− | ThunkFileSpec_AttrCache -- ^ This directory is an attribute cache
204+ , _thunkType_json :: FilePath
223−
205+ , _thunkType_optional :: Set FilePath
224−-- | Specification for how a set of files in a thunk version work.
206+ , _thunkType_loaderVersions :: NonEmpty Text
225−data ThunkSpec = ThunkSpec
207+ , _thunkType_parser :: Aeson.Object -> Aeson.Parser ThunkPtr
226− { _thunkSpec_name :: !Text
227− , _thunkSpec_files :: !(Map FilePath ThunkFileSpec)
230−thunkSpecTypes :: NonEmpty (NonEmpty ThunkSpec)
210+gitHubThunkType :: ThunkType
231−thunkSpecTypes = gitThunkSpecs :| [gitHubThunkSpecs]
211+gitHubThunkType = ThunkType
232−
212+ { _thunkType_loader = "default.nix"
233−-- | Attempts to match a 'ThunkSpec' to a given directory.
213+ , _thunkType_json = "github.json"
234−matchThunkSpecToDir
214+ , _thunkType_optional = Set.fromList [".attr-cache"]
235− :: (MonadError ReadThunkError m, MonadIO m, MonadCatch m)
215+ , _thunkType_loaderVersions = gitHubStandaloneLoaders
236− => ThunkSpec -- ^ 'ThunkSpec' to match against the given files/directory
216+ , _thunkType_parser = parseThunkPtr $ \v ->
237− -> FilePath -- ^ Path to directory
217+ ThunkSource_GitHub <$> parseGitHubSource v <|> ThunkSource_Git <$> parseGitSource v
238− -> Set FilePath -- ^ Set of file paths relative to the given directory
218+ }
240−matchThunkSpecToDir thunkSpec dir dirFiles = do
220+gitThunkType :: ThunkType
241− case nonEmpty (toList $ dirFiles `Set.difference` expectedPaths) of
221+gitThunkType = ThunkType
242− Just fs -> throwError $ ReadThunkError_UnrecognizedPaths $ (dir </>) <$> fs
222+ { _thunkType_loader = "default.nix"
243− Nothing -> pure ()
223+ , _thunkType_json = "git.json"
244− case nonEmpty (toList $ requiredPaths `Set.difference` dirFiles) of
224+ , _thunkType_optional = Set.fromList [".attr-cache"]
245− Just fs -> throwError $ ReadThunkError_MissingPaths $ (dir </>) <$> fs
225+ , _thunkType_loaderVersions = plainGitStandaloneLoaders
246− Nothing -> pure ()
226+ , _thunkType_parser = parseThunkPtr $ fmap ThunkSource_Git . parseGitSource
247− datas <- fmap toList $ flip Map.traverseMaybeWithKey (_thunkSpec_files thunkSpec) $ \expectedPath -> \case
227+ }
248− ThunkFileSpec_AttrCache -> Nothing <$ dirMayExist expectedPath
228+
249− ThunkFileSpec_CheckoutIndicator -> liftIO (doesDirectoryExist (dir </> expectedPath)) <&> \case
229+thunkTypes :: [ThunkType]
250− False -> Nothing
230+thunkTypes = [gitThunkType, gitHubThunkType]
251− True -> Just ThunkData_Checkout
231+
252− ThunkFileSpec_FileMatches expectedContents -> handle (\(e :: IOError) -> throwError $ ReadThunkError_FileError e) $ do
232+findThunkType :: [ThunkType] -> FilePath -> IO (Either ReadThunkError ThunkType)
253− actualContents <- liftIO (T.readFile $ dir </> expectedPath)
233+findThunkType types thunkDir = do
254− case T.strip expectedContents == T.strip actualContents of
234+ matches <- fmap catMaybes $ forM types $ \thunkType -> do
255− True -> pure Nothing
235+ let
256− False -> throwError $ ReadThunkError_FileDoesNotMatch (dir </> expectedPath) expectedContents
236+ expectedContents = Set.fromList $ (thunkDir </>) <$>
257− ThunkFileSpec_Ptr parser -> handle (\(e :: IOError) -> throwError $ ReadThunkError_FileError e) $ do
237+ [ _thunkType_loader thunkType
258− let path = dir </> expectedPath
238+ , _thunkType_json thunkType
259− liftIO (doesFileExist path) >>= \case
239+ ]
260− False -> pure Nothing
240+ optionalContents = Set.map (thunkDir </>) (_thunkType_optional thunkType)
262− actualContents <- liftIO $ LBS.readFile path
242+ -- Ensure that there aren't any other files in the thunk
263− case parser actualContents of
243+ -- NB: System.Directory.listDirectory returns the contents without the directory path
264− Right v -> pure $ Just (ThunkData_Packed thunkSpec v)
244+ files <- liftIO $ Set.fromList . fmap (thunkDir </>) <$> listDirectory thunkDir
265− Left e -> throwError $ ReadThunkError_UnparseablePtr (dir </> expectedPath) e
245+ let unexpectedContents = files `Set.difference` (expectedContents `Set.union` optionalContents)
266−
246+ missingContents = expectedContents `Set.difference` files
267− case nonEmpty datas of
247+ pure $ if Set.null unexpectedContents && Set.null missingContents
268− Nothing -> throwError ReadThunkError_UnrecognizedThunk
248+ then Just thunkType
269− Just xs -> fold1WithM xs $ \a b -> either throwError pure (mergeThunkData a b)
249+ else Nothing
271− rootPathsOnly = Set.fromList . mapMaybe takeRootDir . Map.keys
251+ pure $ case matches of
272− takeRootDir = fmap NonEmpty.head . nonEmpty . splitPath
252+ [singleMatch] -> Right singleMatch
273−
253+ [] -> Left ReadThunkError_UnrecognizedFiles
274− expectedPaths = rootPathsOnly $ _thunkSpec_files thunkSpec
254+ _ -> Left ReadThunkError_AmbiguousFiles
276− requiredPaths = rootPathsOnly $ Map.filter isRequiredFileSpec $ _thunkSpec_files thunkSpec
277− isRequiredFileSpec = \case
278− ThunkFileSpec_FileMatches _ -> True
281− dirMayExist expectedPath = liftIO (doesFileExist (dir </> expectedPath)) >>= \case
282− True -> throwError $ ReadThunkError_UnrecognizedPaths $ expectedPath :| []
285− -- Combine 'ThunkData' from different files, preferring "Checkout" over "Packed"
286− mergeThunkData ThunkData_Checkout ThunkData_Checkout = Right ThunkData_Checkout
287− mergeThunkData ThunkData_Checkout ThunkData_Packed{} = Left bothPackedAndUnpacked
288− mergeThunkData ThunkData_Packed{} ThunkData_Checkout = Left bothPackedAndUnpacked
289− mergeThunkData a@(ThunkData_Packed _ ptrA) (ThunkData_Packed _ ptrB) =
290− if ptrA == ptrB then Right a else Left $ ReadThunkError_AmbiguousPackedState ptrA ptrB
292− bothPackedAndUnpacked = ReadThunkError_UnrecognizedState "Both packed data and checkout present"
294− fold1WithM (x :| xs) f = foldM f x xs
298− => NonEmpty (NonEmpty ThunkSpec) -> FilePath -> m (Either ReadThunkError ThunkData)
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}|]
308-- | Read a thunk and validate that it is exactly a packed thunk.
256-- | Read a thunk and validate that it is exactly a packed thunk.
309-- If additional data is present, fail.
257-- If additional data is present, fail.
310−readThunk :: (MonadObelisk m) => FilePath -> m (Either ReadThunkError ThunkData)
258+readPackedThunk :: FilePath -> IO (Either ReadThunkError ThunkPtr)
311−readThunk = readThunkWith thunkSpecTypes
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
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
313parseThunkPtr :: (Aeson.Object -> Aeson.Parser ThunkSource) -> Aeson.Object -> Aeson.Parser ThunkPtr
271parseThunkPtr :: (Aeson.Object -> Aeson.Parser ThunkSource) -> Aeson.Object -> Aeson.Parser ThunkPtr
314parseThunkPtr parseSrc v = do
272parseThunkPtr parseSrc v = do
@@ -328,12 +286,10 @@ parseGitHubSource v = do
328 owner <- v Aeson..: "owner"
286 owner <- v Aeson..: "owner"
329 repo <- v Aeson..: "repo"
287 repo <- v Aeson..: "repo"
330 branch <- v Aeson..:! "branch"
288 branch <- v Aeson..:! "branch"
331− private <- v Aeson..:? "private"
332 pure $ GitHubSource
289 pure $ GitHubSource
333 { _gitHubSource_owner = owner
290 { _gitHubSource_owner = owner
334 , _gitHubSource_repo = repo
291 , _gitHubSource_repo = repo
335 , _gitHubSource_branch = branch
292 , _gitHubSource_branch = branch
336− , _gitHubSource_private = fromMaybe False private
339parseGitSource :: Aeson.Object -> Aeson.Parser GitSource
295parseGitSource :: Aeson.Object -> Aeson.Parser GitSource
@@ -341,29 +297,25 @@ parseGitSource v = do
341 Just url <- parseGitUri <$> v Aeson..: "url"
297 Just url <- parseGitUri <$> v Aeson..: "url"
342 branch <- v Aeson..:! "branch"
298 branch <- v Aeson..:! "branch"
343 fetchSubmodules <- v Aeson..:! "fetchSubmodules"
299 fetchSubmodules <- v Aeson..:! "fetchSubmodules"
344− private <- v Aeson..:? "private"
345 pure $ GitSource
300 pure $ GitSource
346 { _gitSource_url = url
301 { _gitSource_url = url
347 , _gitSource_branch = branch
302 , _gitSource_branch = branch
348 , _gitSource_fetchSubmodules = fromMaybe False fetchSubmodules
303 , _gitSource_fetchSubmodules = fromMaybe False fetchSubmodules
349− , _gitSource_private = fromMaybe False private
352overwriteThunk :: MonadObelisk m => FilePath -> ThunkPtr -> m ()
306overwriteThunk :: MonadObelisk m => FilePath -> ThunkPtr -> m ()
353overwriteThunk target thunk = do
307overwriteThunk target thunk = do
354 -- Ensure that this directory is a valid thunk (i.e. so we aren't losing any data)
308 -- Ensure that this directory is a valid thunk (i.e. so we aren't losing any data)
355− readThunk target >>= \case
309+ Right _ <- readThunk target
356− Left e -> failWith [i|Invalid thunk at ${target}: ${e}|]
359 --TODO: Is there a safer way to do this overwriting?
311 --TODO: Is there a safer way to do this overwriting?
360− liftIO $ removePathForcibly target
312+ liftIO $ removeDirectoryRecursive target
361− createThunk target $ Right thunk
313+ liftIO $ createThunk target thunk
363−thunkPtrToSpec :: ThunkPtr -> ThunkSpec
315+thunkPtrLoader :: ThunkPtr -> Text
364−thunkPtrToSpec thunk = case _thunkPtr_source thunk of
316+thunkPtrLoader thunk = case _thunkPtr_source thunk of
365− ThunkSource_GitHub _ -> NonEmpty.head gitHubThunkSpecs
317+ ThunkSource_GitHub _ -> NonEmpty.head gitHubStandaloneLoaders
366− ThunkSource_Git _ -> NonEmpty.head gitThunkSpecs
318+ ThunkSource_Git _ -> NonEmpty.head plainGitStandaloneLoaders
368-- It's important that formatting be very consistent here, because
320-- It's important that formatting be very consistent here, because
369-- otherwise when people update thunks, their patches will be messy
321-- otherwise when people update thunks, their patches will be messy
@@ -375,15 +327,13 @@ encodeThunkPtrData (ThunkPtr rev src) = case src of
375 , ("branch" .=) <$> _gitHubSource_branch s
327 , ("branch" .=) <$> _gitHubSource_branch s
376 , Just $ "rev" .= Ref.toHexString (_thunkRev_commit rev)
328 , Just $ "rev" .= Ref.toHexString (_thunkRev_commit rev)
377 , Just $ "sha256" .= _thunkRev_nixSha256 rev
329 , Just $ "sha256" .= _thunkRev_nixSha256 rev
378− , Just $ "private" .= _gitHubSource_private s
380 ThunkSource_Git s -> encodePretty' plainGitCfg $ Aeson.object $ catMaybes
331 ThunkSource_Git s -> encodePretty' plainGitCfg $ Aeson.object $ catMaybes
381− [ Just $ "url" .= gitUriToText (_gitSource_url s)
332+ [ Just $ "url" .= render (_gitSource_url s)
382 , Just $ "rev" .= Ref.toHexString (_thunkRev_commit rev)
333 , Just $ "rev" .= Ref.toHexString (_thunkRev_commit rev)
383 , ("branch" .=) <$> _gitSource_branch s
334 , ("branch" .=) <$> _gitSource_branch s
384 , Just $ "sha256" .= _thunkRev_nixSha256 rev
335 , Just $ "sha256" .= _thunkRev_nixSha256 rev
385 , Just $ "fetchSubmodules" .= _gitSource_fetchSubmodules s
336 , Just $ "fetchSubmodules" .= _gitSource_fetchSubmodules s
386− , Just $ "private" .= _gitSource_private s
389 githubCfg = defConfig
339 githubCfg = defConfig
@@ -404,84 +354,59 @@ encodeThunkPtrData (ThunkPtr rev src) = case src of
406 , "sha256"
356 , "sha256"
408 , "fetchSubmodules"
357 , "fetchSubmodules"
409 ] <> compare
358 ] <> compare
410 , confTrailingNewline = True
359 , confTrailingNewline = True
413−createThunk :: MonadObelisk m => FilePath -> Either ThunkSpec ThunkPtr -> m ()
362+createThunk :: MonadIO m => FilePath -> ThunkPtr -> m ()
414−createThunk target ptrInfo =
363+createThunk target thunk = liftIO $ do
415− ifor_ (_thunkSpec_files spec) $ \path -> \case
364+ createDirectoryIfMissing True (target </> ".attr-cache")
416− ThunkFileSpec_FileMatches content -> withReadyPath path $ \p -> liftIO $ T.writeFile p content
365+ T.writeFile (target </> "default.nix") (thunkPtrLoader thunk)
417− ThunkFileSpec_Ptr _ -> case ptrInfo of
366+ let
418− Left _ -> pure () -- We can't write the ptr without it
367+ jsonFileName = case _thunkPtr_source thunk of
419− Right ptr -> withReadyPath path $ \p -> liftIO $ LBS.writeFile p (encodeThunkPtrData ptr)
368+ ThunkSource_GitHub _ -> "github"
420− _ -> pure ()
369+ ThunkSource_Git _ -> "git"
421− where
370+ LBS.writeFile (target </> jsonFileName <.> "json") (encodeThunkPtrData thunk)
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
429createThunkWithLatest :: MonadObelisk m => FilePath -> ThunkSource -> m ()
372createThunkWithLatest :: MonadObelisk m => FilePath -> ThunkSource -> m ()
430createThunkWithLatest target s = do
373createThunkWithLatest target s = do
431 rev <- getLatestRev s
374 rev <- getLatestRev s
432− createThunk target $ Right $ ThunkPtr
375+ createThunk target $ ThunkPtr
433 { _thunkPtr_source = s
376 { _thunkPtr_source = s
434 , _thunkPtr_rev = rev
377 , _thunkPtr_rev = rev
437−updateThunkToLatest :: MonadObelisk m => ThunkUpdateConfig -> FilePath -> m ()
380+updateThunkToLatest :: MonadObelisk m => FilePath -> m ()
438−updateThunkToLatest (ThunkUpdateConfig mBranch thunkConfig) target = spinner $ do
381+updateThunkToLatest target = withSpinner' ("Updating thunk " <> T.pack target <> " to latest") (pure $ const $ "Thunk " <> T.pack target <> " updated to latest") $ do
439− checkThunkDirectory target
382+ (overwrite, ptr) <- readThunk target >>= \case
440− -- check to see if thunk should be updated to a specific branch or just update it's current branch
383+ Left err -> failWith $ T.pack $ "thunk update: " <> show err
441− case mBranch of
384+ Right c -> case c of
442− Nothing -> do
385+ ThunkData_Packed t -> return (target, t)
443− (overwrite, ptr) <- readThunk target >>= \case
386+ ThunkData_Checkout _ -> failWith "cannot update an unpacked thunk"
444− Left err -> failWith [i|Thunk update: ${err}|]
387+ let src = _thunkPtr_source ptr
445− Right c -> case c of
388+ rev <- getLatestRev src
446− ThunkData_Packed _ t -> return (target, t)
389+ overwriteThunk overwrite $ ThunkPtr
447− ThunkData_Checkout -> failWith "cannot update an unpacked thunk"
390+ { _thunkPtr_source = src
448− let src = _thunkPtr_source ptr
391+ , _thunkPtr_rev = rev
449− rev <- getLatestRev src
392+ }
450− overwriteThunk overwrite $ modifyThunkPtrByConfig thunkConfig $ ThunkPtr
451− { _thunkPtr_source = src
452− , _thunkPtr_rev = rev
454− Just branch -> readThunk target >>= \case
455− Left err -> failWith [i|Thunk update: ${err}|]
456− Right c -> case c of
457− ThunkData_Packed _ t -> setThunk thunkConfig target (thunkSourceToGitSource $ _thunkPtr_source t) branch
458− ThunkData_Checkout -> failWith [i|Thunk located at ${target} is unpacked. Use 'ob thunk pack' on the desired directory and then try 'ob thunk update' again.|]
460− spinner = withSpinner' ("Updating thunk " <> T.pack target <> " to latest") (pure $ const $ "Thunk " <> T.pack target <> " updated to latest")
462−setThunk :: MonadObelisk m => ThunkConfig -> FilePath -> GitSource -> String -> m ()
463−setThunk thunkConfig target gs branch = do
464− newThunkPtr <- uriThunkPtr (_gitSource_url gs) (_thunkConfig_private thunkConfig) (Just $ T.pack branch) Nothing
465− overwriteThunk target newThunkPtr
466− updateThunkToLatest (ThunkUpdateConfig Nothing thunkConfig) target
468-- | All recognized github standalone loaders, ordered from newest to oldest.
394-- | All recognized github standalone loaders, ordered from newest to oldest.
469-- This tool will only ever produce the newest one when it writes a thunk.
395-- This tool will only ever produce the newest one when it writes a thunk.
470−gitHubThunkSpecs :: NonEmpty ThunkSpec
396+gitHubStandaloneLoaders :: NonEmpty Text
471−gitHubThunkSpecs =
397+gitHubStandaloneLoaders =
472− gitHubThunkSpecV5 :|
398+ gitHubStandaloneLoaderV2 :|
473− [ gitHubThunkSpecV4
399+ [ gitHubStandaloneLoaderV3
474− , gitHubThunkSpecV3
400+ , gitHubStandaloneLoaderV1
479−gitHubThunkSpecV1 :: ThunkSpec
403+gitHubStandaloneLoaderV1 :: Text
480−gitHubThunkSpecV1 = legacyGitHubThunkSpec "github-v1"
404+gitHubStandaloneLoaderV1 = T.unlines
481− "import ((import <nixpkgs> {}).fetchFromGitHub (builtins.fromJSON (builtins.readFile ./github.json)))"
405+ [ "import ((import <nixpkgs> {}).fetchFromGitHub (builtins.fromJSON (builtins.readFile ./github.json)))"
483−gitHubThunkSpecV2 :: ThunkSpec
408+gitHubStandaloneLoaderV2 :: Text
484−gitHubThunkSpecV2 = legacyGitHubThunkSpec "github-v2" $ T.unlines
409+gitHubStandaloneLoaderV2 = T.unlines
485 [ "# DO NOT HAND-EDIT THIS FILE" --TODO: Add something about how to get more info on Obelisk, etc.
410 [ "# DO NOT HAND-EDIT THIS FILE" --TODO: Add something about how to get more info on Obelisk, etc.
486 , "import ((import <nixpkgs> {}).fetchFromGitHub ("
411 , "import ((import <nixpkgs> {}).fetchFromGitHub ("
487 , " let json = builtins.fromJSON (builtins.readFile ./github.json);"
412 , " let json = builtins.fromJSON (builtins.readFile ./github.json);"
@@ -491,8 +416,8 @@ gitHubThunkSpecV2 = legacyGitHubThunkSpec "github-v2" $ T.unlines
494−gitHubThunkSpecV3 :: ThunkSpec
419+gitHubStandaloneLoaderV3 :: Text
495−gitHubThunkSpecV3 = legacyGitHubThunkSpec "github-v3" $ T.unlines
420+gitHubStandaloneLoaderV3 = T.unlines
496 [ "# DO NOT HAND-EDIT THIS FILE"
421 [ "# DO NOT HAND-EDIT THIS FILE"
498 , " fetch = { private ? false, ... }@args: if private && builtins.hasAttr \"fetchGit\" builtins"
423 , " fetch = { private ? false, ... }@args: if private && builtins.hasAttr \"fetchGit\" builtins"
@@ -511,62 +436,22 @@ gitHubThunkSpecV3 = legacyGitHubThunkSpec "github-v3" $ T.unlines
511 , "in import (fetch (builtins.fromJSON (builtins.readFile ./github.json)))"
436 , "in import (fetch (builtins.fromJSON (builtins.readFile ./github.json)))"
514−gitHubThunkSpecV4 :: ThunkSpec
439+plainGitStandaloneLoaders :: NonEmpty Text
515−gitHubThunkSpecV4 = legacyGitHubThunkSpec "github-v4" $ T.unlines
440+plainGitStandaloneLoaders =
516− [ "# DO NOT HAND-EDIT THIS FILE"
441+ plainGitStandaloneLoaderV1 :|
517− , "let fetch = { private ? false, fetchSubmodules ? false, owner, repo, rev, sha256, ... }:"
442+ [ plainGitStandaloneLoaderV2
518− , " if !fetchSubmodules && !private then builtins.fetchTarball {"
519− , " url = \"https://github.com/${owner}/${repo}/archive/${rev}.tar.gz\"; inherit sha256;"
520− , " } else (import <nixpkgs> {}).fetchFromGitHub {"
521− , " inherit owner repo rev sha256 fetchSubmodules private;"
523− , "in import (fetch (builtins.fromJSON (builtins.readFile ./github.json)))"
526−legacyGitHubThunkSpec :: Text -> Text -> ThunkSpec
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)
534−gitHubThunkSpecV5 :: ThunkSpec
445+plainGitStandaloneLoaderV1 :: Text
535−gitHubThunkSpecV5 = mkThunkSpec "github-v5" "github.json" parseGitHubJsonBytes [here|
446+plainGitStandaloneLoaderV1 = T.unlines
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;
543− json = builtins.fromJSON (builtins.readFile ./github.json);
547−parseGitHubJsonBytes :: LBS.ByteString -> Either String ThunkPtr
548−parseGitHubJsonBytes = parseJsonObject $ parseThunkPtr $ \v ->
549− ThunkSource_GitHub <$> parseGitHubSource v <|> ThunkSource_Git <$> parseGitSource v
551−gitThunkSpecs :: NonEmpty ThunkSpec
560−gitThunkSpecV1 :: ThunkSpec
561−gitThunkSpecV1 = legacyGitThunkSpec "git-v1" $ T.unlines
562 [ "# DO NOT HAND-EDIT THIS FILE"
447 [ "# DO NOT HAND-EDIT THIS FILE"
563 , "let fetchGit = {url, rev, ref ? null, branch ? null, sha256 ? null, fetchSubmodules ? null}:"
448 , "let fetchGit = {url, rev, ref ? null, branch ? null, sha256 ? null, fetchSubmodules ? null}:"
564 , " assert !fetchSubmodules; (import <nixpkgs> {}).fetchgit { inherit url rev sha256; };"
449 , " assert !fetchSubmodules; (import <nixpkgs> {}).fetchgit { inherit url rev sha256; };"
565 , "in import (fetchGit (builtins.fromJSON (builtins.readFile ./git.json)))"
450 , "in import (fetchGit (builtins.fromJSON (builtins.readFile ./git.json)))"
568−gitThunkSpecV2 :: ThunkSpec
453+plainGitStandaloneLoaderV2 :: Text
569−gitThunkSpecV2 = legacyGitThunkSpec "git-v2" $ T.unlines
454+plainGitStandaloneLoaderV2 = T.unlines
570 [ "# DO NOT HAND-EDIT THIS FILE"
455 [ "# DO NOT HAND-EDIT THIS FILE"
571 , "let fetchGit = {url, rev, ref ? null, branch ? null, sha256 ? null, fetchSubmodules ? null}:"
456 , "let fetchGit = {url, rev, ref ? null, branch ? null, sha256 ? null, fetchSubmodules ? null}:"
572 , " if builtins.hasAttr \"fetchGit\" builtins"
457 , " if builtins.hasAttr \"fetchGit\" builtins"
@@ -575,87 +460,10 @@ gitThunkSpecV2 = legacyGitThunkSpec "git-v2" $ T.unlines
575 , "in import (fetchGit (builtins.fromJSON (builtins.readFile ./git.json)))"
460 , "in import (fetchGit (builtins.fromJSON (builtins.readFile ./git.json)))"
578−-- This loader has a bug because @builtins.fetchGit@ is not given a @ref@
463+thunkFileNames :: [FilePath]
579−-- and will fail to find commits without this because it does shallow clones.
464+thunkFileNames = ["default.nix", "github.json", "git.json"]
580−gitThunkSpecV3 :: ThunkSpec
581−gitThunkSpecV3 = legacyGitThunkSpec "git-v3" $ T.unlines
582− [ "# DO NOT HAND-EDIT THIS FILE"
583− , "let fetch = {url, rev, ref ? null, sha256 ? null, fetchSubmodules ? false, private ? false, ...}:"
584− , " let realUrl = let firstChar = builtins.substring 0 1 url; in"
585− , " if firstChar == \"/\" then /. + url"
586− , " else if firstChar == \".\" then ./. + url"
588− , " in if !fetchSubmodules && private then builtins.fetchGit {"
589− , " url = realUrl; inherit rev;"
590− , " } else (import <nixpkgs> {}).fetchgit {"
591− , " url = realUrl; inherit rev sha256;"
593− , "in import (fetch (builtins.fromJSON (builtins.readFile ./git.json)))"
596−gitThunkSpecV4 :: ThunkSpec
466+--TODO: when checking something out, make a shallow clone
597−gitThunkSpecV4 = legacyGitThunkSpec "git-v4" $ T.unlines
598− [ "# DO NOT HAND-EDIT THIS FILE"
599− , "let fetch = {url, rev, branch ? null, sha256 ? null, fetchSubmodules ? false, private ? false, ...}:"
600− , " let realUrl = let firstChar = builtins.substring 0 1 url; in"
601− , " if firstChar == \"/\" then /. + url"
602− , " else if firstChar == \".\" then ./. + url"
604− , " in if !fetchSubmodules && private then builtins.fetchGit {"
605− , " url = realUrl; inherit rev;"
606− , " ${if branch == null then null else \"ref\"} = branch;"
607− , " } else (import <nixpkgs> {}).fetchgit {"
608− , " url = realUrl; inherit rev sha256;"
610− , "in import (fetch (builtins.fromJSON (builtins.readFile ./git.json)))"
613−legacyGitThunkSpec :: Text -> Text -> ThunkSpec
614−legacyGitThunkSpec name loader = ThunkSpec name $ Map.fromList
615− [ ("default.nix", ThunkFileSpec_FileMatches $ T.strip loader)
616− , ("git.json" , ThunkFileSpec_Ptr parseGitJsonBytes)
617− , (attrCacheFileName, ThunkFileSpec_AttrCache)
618− , (".git", ThunkFileSpec_CheckoutIndicator)
621−gitThunkSpecV5 :: ThunkSpec
622−gitThunkSpecV5 = mkThunkSpec "git-v5" "git.json" parseGitJsonBytes [here|
623−# DO NOT HAND-EDIT THIS FILE
624−let fetch = {url, rev, branch ? null, sha256 ? null, fetchSubmodules ? false, private ? false, ...}:
625− let realUrl = let firstChar = builtins.substring 0 1 url; in
626− if firstChar == "/" then /. + url
627− else if firstChar == "." then ./. + url
629− in if !fetchSubmodules && private then builtins.fetchGit {
630− url = realUrl; inherit rev;
631− ${if branch == null then null else "ref"} = branch;
632− } else (import <nixpkgs> {}).fetchgit {
633− url = realUrl; inherit rev sha256;
635− json = builtins.fromJSON (builtins.readFile ./git.json);
639−parseGitJsonBytes :: LBS.ByteString -> Either String ThunkPtr
640−parseGitJsonBytes = parseJsonObject $ parseThunkPtr $ fmap ThunkSource_Git . parseGitSource
642−mkThunkSpec :: Text -> FilePath -> (LBS.ByteString -> Either String ThunkPtr) -> Text -> ThunkSpec
643−mkThunkSpec name jsonFileName parser srcNix = ThunkSpec name $ Map.fromList
644− [ ("default.nix", ThunkFileSpec_FileMatches defaultNixViaSrc)
645− , ("thunk.nix", ThunkFileSpec_FileMatches srcNix)
646− , (jsonFileName, ThunkFileSpec_Ptr parser)
647− , (attrCacheFileName, ThunkFileSpec_AttrCache)
648− , (normalise $ unpackedDirName </> ".git", ThunkFileSpec_CheckoutIndicator)
651− defaultNixViaSrc = [here|
652−# DO NOT HAND-EDIT THIS FILE
653−import (import ./thunk.nix)
657−parseJsonObject :: (Aeson.Object -> Aeson.Parser a) -> LBS.ByteString -> Either String a
658−parseJsonObject p bytes = Aeson.parseEither p =<< Aeson.eitherDecode bytes
660-- | Checks a cache directory to see if there is a fresh symlink
468-- | Checks a cache directory to see if there is a fresh symlink
661-- to the result of building an attribute of a thunk.
469-- to the result of building an attribute of a thunk.
@@ -663,49 +471,44 @@ parseJsonObject p bytes = Aeson.parseEither p =<< Aeson.eitherDecode bytes
663-- and the result is symlinked into the cache.
471-- and the result is symlinked into the cache.
664nixBuildThunkAttrWithCache
472nixBuildThunkAttrWithCache
665 :: MonadObelisk m
473 :: MonadObelisk m
666− => ThunkSpec
474+ => FilePath
668 -- ^ Path to directory containing Thunk
475 -- ^ Path to directory containing Thunk
669 -> String
476 -> String
670 -- ^ Attribute to build
477 -- ^ Attribute to build
671− -> m (Maybe FilePath)
478+ -> m FilePath
672 -- ^ Symlink to cached or built nix output
479 -- ^ Symlink to cached or built nix output
673-- WARNING: If the thunk uses an impure reference such as '<nixpkgs>'
480-- WARNING: If the thunk uses an impure reference such as '<nixpkgs>'
674-- the caching mechanism will fail as it merely measures the modification
481-- the caching mechanism will fail as it merely measures the modification
675-- time of the cache link and the expression to build.
482-- time of the cache link and the expression to build.
676−nixBuildThunkAttrWithCache thunkSpec thunkDir attr = do
483+nixBuildThunkAttrWithCache thunkDir attr = do
484+ --NB: Expects thunkDir to be normalised with no trailing path separator.
485+ --This should be guaranteed by the command argument parser.
486+ let cacheErrHandler e
487+ | isDoesNotExistError e = return Nothing -- expected from a cache miss
488+ | otherwise = putLog Error (T.pack $ displayException e) >> return Nothing
489+ cacheDir = thunkDir </> ".attr-cache"
490+ cachePath = cacheDir </> attr <.> "out"
677 latestChange <- liftIO $ do
491 latestChange <- liftIO $ do
678− let
492+ createDirectoryIfMissing False cacheDir
679− getModificationTimeMaybe = fmap rightToMaybe . try @IOError . getModificationTime
493+ let getModificationTimeMaybe = fmap rightToMaybe . try @IOError . getModificationTime
680− thunkFileNames = Map.keys $ _thunkSpec_files thunkSpec
494+ maximum . catMaybes <$> mapM (getModificationTimeMaybe . (thunkDir </>)) thunkFileNames
681− maximum . catMaybes <$> traverse (getModificationTimeMaybe . (thunkDir </>)) thunkFileNames
495+ cacheHit <- handle cacheErrHandler $ do
682−
496+ cacheTime <- liftIO $ posixSecondsToUTCTime . realToFrac . modificationTime <$> getSymbolicLinkStatus cachePath
683− let cachePaths' = nonEmpty $ Map.keys $ Map.filter (\case ThunkFileSpec_AttrCache -> True; _ -> False) $
497+ return $ if latestChange <= cacheTime
684− _thunkSpec_files thunkSpec
498+ then Just cachePath
685− for cachePaths' $ \cachePaths ->
499+ else Nothing
686− fmap NonEmpty.head $ for cachePaths $ \cacheDir -> do
500+ case cacheHit of
687− let
501+ Just c -> return c
688− cachePath = thunkDir </> cacheDir </> attr <.> "out"
502+ Nothing -> do
689− cacheErrHandler e
503+ putLog Warning $ T.pack $ mconcat [thunkDir, ": ", attr, " not cached, building ..."]
690− | isDoesNotExistError e = pure Nothing -- expected from a cache miss
504+ _ <- nixBuild $ def
691− | otherwise = Nothing <$ putLog Error (T.pack $ displayException e)
505+ { _nixBuildConfig_target = Target
692− cacheHit <- handle cacheErrHandler $ do
506+ { _target_path = thunkDir
693− cacheTime <- liftIO $ posixSecondsToUTCTime . realToFrac . modificationTime <$> getSymbolicLinkStatus cachePath
507+ , _target_attr = Just attr
694− pure $ if latestChange <= cacheTime
508+ }
695− then Just cachePath
509+ , _nixBuildConfig_outLink = OutLink_IndirectRoot cachePath
697− case cacheHit of
511+ return cachePath
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
710-- | Build a nix attribute, and cache the result if possible
513-- | Build a nix attribute, and cache the result if possible
711nixBuildAttrWithCache
514nixBuildAttrWithCache
@@ -716,19 +519,17 @@ nixBuildAttrWithCache
716 -- ^ Attribute to build
519 -- ^ Attribute to build
717 -> m FilePath
520 -> m FilePath
718 -- ^ Symlink to cached or built nix output
521 -- ^ Symlink to cached or built nix output
719−nixBuildAttrWithCache exprPath attr = readThunk exprPath >>= \case
522+nixBuildAttrWithCache exprPath attr = do
720− -- Only packed thunks are cached. In particular, checkouts are not.
523+ readThunk exprPath >>= \case
721− Right (ThunkData_Packed spec _) ->
524+ -- Only packed thunks are cached. in particular, checkouts are not
722− maybe build pure =<< nixBuildThunkAttrWithCache spec exprPath attr
525+ Right (ThunkData_Packed _) -> nixBuildThunkAttrWithCache exprPath attr
723− _ -> build
526+ _ -> nixBuild $ def
724− where
527+ { _nixBuildConfig_target = Target
725− build = nixCmd $ NixCmd_Build $ def
528+ { _target_path = exprPath
726− & nixBuildConfig_outLink .~ OutLink_None
727− & nixCmdConfig_target .~ Target
728− { _target_path = Just exprPath
729 , _target_attr = Just attr
529 , _target_attr = Just attr
730− , _target_expr = Nothing
531+ , _nixBuildConfig_outLink = OutLink_None
733-- | Safely update thunk using a custom action
534-- | Safely update thunk using a custom action
@@ -745,153 +546,92 @@ updateThunk p f = withSystemTempDirectory "obelisk-thunkptr-" $ \tmpDir -> do
746 copyThunkToTmp tmpDir thunkDir = readThunk thunkDir >>= \case
547 copyThunkToTmp tmpDir thunkDir = readThunk thunkDir >>= \case
747 Left err -> failWith $ "withThunkUnpacked: " <> T.pack (show err)
548 Left err -> failWith $ "withThunkUnpacked: " <> T.pack (show err)
748− Right ThunkData_Packed{} -> do
549+ Right (ThunkData_Packed _) -> do
749 let tmpThunk = tmpDir </> "thunk"
550 let tmpThunk = tmpDir </> "thunk"
750 callProcessAndLogOutput (Notice, Error) $
551 callProcessAndLogOutput (Notice, Error) $
751− proc cp ["-r", "-T", thunkDir, tmpThunk]
552+ proc "cp" ["-r", "-T", thunkDir, tmpThunk]
752 return tmpThunk
553 return tmpThunk
753− Right _ -> failWith "Thunk is not packed"
554+ Right _ -> failWith $ "Thunk is not packed"
754 updateThunkFromTmp p' = do
555 updateThunkFromTmp p' = do
755− _ <- packThunk' True (ThunkPackConfig False (ThunkConfig Nothing)) p'
556+ packThunk' True p'
756 callProcessAndLogOutput (Notice, Error) $
557 callProcessAndLogOutput (Notice, Error) $
757− proc cp ["-r", "-T", p', p]
558+ proc "cp" ["-r", "-T", p', p]
759finalMsg :: Bool -> (a -> Text) -> Maybe (a -> Text)
560finalMsg :: Bool -> (a -> Text) -> Maybe (a -> Text)
760finalMsg noTrail s = if noTrail then Nothing else Just s
561finalMsg noTrail s = if noTrail then Nothing else Just s
762−-- | Check that we are not somewhere inside the thunk directory
763−checkThunkDirectory :: MonadObelisk m => FilePath -> m ()
764−checkThunkDirectory thunkDir = do
765− currentDir <- liftIO getCurrentDirectory
766− thunkDir' <- liftIO $ canonicalizePath thunkDir
767− when (thunkDir' `L.isInfixOf` currentDir) $
768− failWith [i|Can't perform thunk operations from within the thunk directory: ${thunkDir}|]
770− -- Don't let thunk commands work when directly given an unpacked repo
771− when (takeFileName thunkDir == unpackedDirName) $
772− readThunk (takeDirectory thunkDir) >>= \case
773− Right _ -> failWith [i|Refusing to perform thunk operation on ${thunkDir} because it is a thunk's unpacked source|]
776unpackThunk :: MonadObelisk m => FilePath -> m ()
563unpackThunk :: MonadObelisk m => FilePath -> m ()
777unpackThunk = unpackThunk' False
564unpackThunk = unpackThunk' False
779unpackThunk' :: MonadObelisk m => Bool -> FilePath -> m ()
566unpackThunk' :: MonadObelisk m => Bool -> FilePath -> m ()
780−unpackThunk' noTrail thunkDir = checkThunkDirectory thunkDir *> readThunk thunkDir >>= \case
567+unpackThunk' noTrail thunkDir = readThunk thunkDir >>= \case
781− Left err -> failWith [i|Invalid thunk at ${thunkDir}: ${err}|]
568+ Left err -> failWith $ "thunk unpack: " <> T.pack (show err)
782 --TODO: Overwrite option that rechecks out thunk; force option to do so even if working directory is dirty
569 --TODO: Overwrite option that rechecks out thunk; force option to do so even if working directory is dirty
783− Right ThunkData_Checkout -> failWith [i|Thunk at ${thunkDir} is already unpacked|]
570+ Right (ThunkData_Checkout _) -> failWith "thunk unpack: thunk is already unpacked"
784− Right (ThunkData_Packed _ tptr) -> do
571+ Right (ThunkData_Packed tptr) -> do
785 let (thunkParent, thunkName) = splitFileName thunkDir
572 let (thunkParent, thunkName) = splitFileName thunkDir
786− withTempDirectory thunkParent thunkName $ \tmpThunk -> do
573+ withTempDirectory thunkParent thunkName $ \tmpRepo -> do
787− let
574+ let obGitDir = tmpRepo </> ".git" </> "obelisk"
788− gitSrc = thunkSourceToGitSource $ _thunkPtr_source tptr
575+ s = case _thunkPtr_source tptr of
789− newSpec = case _thunkPtr_source tptr of
576+ ThunkSource_GitHub s' -> forgetGithub False s'
790− ThunkSource_GitHub _ -> NonEmpty.head gitHubThunkSpecs
577+ ThunkSource_Git s' -> s'
791− ThunkSource_Git _ -> NonEmpty.head gitThunkSpecs
792 withSpinner' ("Fetching thunk " <> T.pack thunkName)
578 withSpinner' ("Fetching thunk " <> T.pack thunkName)
793 (finalMsg noTrail $ const $ "Fetched thunk " <> T.pack thunkName) $ do
579 (finalMsg noTrail $ const $ "Fetched thunk " <> T.pack thunkName) $ do
794− let unpackedPath = tmpThunk </> unpackedDirName
580+ let git = callProcessAndLogOutput (Notice, Notice) . gitProc tmpRepo
795− gitCloneForThunkUnpack gitSrc (_thunkRev_commit $ _thunkPtr_rev tptr) unpackedPath
581+ git $ [ "clone" ]
796−
582+ ++ ("--recursive" <$ guard (_gitSource_fetchSubmodules s))
797− let normalizeMore = dropTrailingPathSeparator . normalise
583+ ++ [ T.unpack $ render $ _gitSource_url s ]
798− when (normalizeMore unpackedPath /= normalizeMore tmpThunk) $ -- Only write meta data if the checkout is not inplace
584+ ++ do branch <- maybeToList $ _gitSource_branch s
799− createThunk tmpThunk $ Left newSpec
585+ [ "--branch", T.unpack $ untagName branch ]
800−
586+ git ["reset", "--hard", Ref.toHexString $ _thunkRev_commit $ _thunkPtr_rev tptr]
801− liftIO $ do
587+ when (_gitSource_fetchSubmodules s) $
802− removePathForcibly thunkDir
588+ git ["submodule", "update", "--recursive", "--init"]
803− renameDirectory tmpThunk thunkDir
589+
804−
590+ liftIO $ createDirectory obGitDir
805−gitCloneForThunkUnpack
591+ callProcessAndLogOutput (Notice, Error) $
806− :: MonadObelisk m
592+ proc "cp" ["-r", "-T", thunkDir </> ".", obGitDir </> "orig-thunk"]
807− => GitSource -- ^ Git source to use
593+ callProcessAndLogOutput (Notice, Error) $
808− -> Ref hash -- ^ Commit hash to reset to
594+ proc "rm" ["-r", thunkDir]
809− -> FilePath -- ^ Directory to clone into
595+ callProcessAndLogOutput (Notice, Error) $
810− -> m ()
596+ proc "mv" ["-T", tmpRepo, thunkDir]
811−gitCloneForThunkUnpack gitSrc commit dir = do
812− let git = callProcessAndLogOutput (Notice, Notice) . gitProc dir
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"]
598+--TODO: add force mode to pack even if changes are present
822--TODO: add a rollback mode to pack to the original thunk
599--TODO: add a rollback mode to pack to the original thunk
823−packThunk :: MonadObelisk m => ThunkPackConfig -> FilePath -> m ThunkPtr
600+packThunk :: MonadObelisk m => FilePath -> m ()
824packThunk = packThunk' False
601packThunk = packThunk' False
826−packThunk' :: MonadObelisk m => Bool -> ThunkPackConfig -> FilePath -> m ThunkPtr
603+packThunk' :: MonadObelisk m => Bool -> FilePath -> m ()
827−packThunk' noTrail (ThunkPackConfig force thunkConfig) thunkDir = checkThunkDirectory thunkDir *> readThunk thunkDir >>= \case
604+packThunk' noTrail thunkDir = readThunk thunkDir >>= \case
828− Right ThunkData_Packed{} -> failWith [i|Thunk at ${thunkDir} is is already packed|]
605+ Left err -> failWith $ T.pack $ "thunk pack: " <> show err
829− _ -> withSpinner'
606+ Right (ThunkData_Packed _) -> failWith "pack: thunk is already packed"
830− ("Packing thunk " <> T.pack thunkDir)
607+ Right (ThunkData_Checkout _) -> do
831− (finalMsg noTrail $ const $ "Packed thunk " <> T.pack thunkDir) $
608+ withSpinner' ("Packing thunk " <> T.pack thunkDir)
832− do
609+ (finalMsg noTrail $ const $ "Packed thunk " <> T.pack thunkDir) $ do
833− let checkClean = if force then CheckClean_NoCheck else CheckClean_FullCheck
610+ thunkPtr <- getThunkPtr thunkDir
834− thunkPtr <- modifyThunkPtrByConfig thunkConfig <$> getThunkPtr checkClean thunkDir (_thunkConfig_private thunkConfig)
611+ callProcessAndLogOutput (Debug, Error) $ proc "rm" ["-rf", thunkDir]
835− liftIO $ removePathForcibly thunkDir
612+ liftIO $ createThunk thunkDir thunkPtr
836− createThunk thunkDir $ Right thunkPtr
613+
837− pure thunkPtr
614+getThunkPtr :: MonadObelisk m => FilePath -> m ThunkPtr
838−
615+getThunkPtr = getThunkPtr' True
839−modifyThunkPtrByConfig :: ThunkConfig -> ThunkPtr -> ThunkPtr
616+
840−modifyThunkPtrByConfig (ThunkConfig markPrivate') ptr = case markPrivate' of
617+getThunkPtr' :: forall m. MonadObelisk m => Bool -> FilePath -> m ThunkPtr
841− Nothing -> ptr
618+getThunkPtr' checkClean thunkDir = do
842− Just markPrivate -> ptr { _thunkPtr_source = case _thunkPtr_source ptr of
619+ when checkClean $ ensureCleanGitRepo thunkDir True $
843− ThunkSource_Git s -> ThunkSource_Git $ s { _gitSource_private = markPrivate }
844− ThunkSource_GitHub s -> ThunkSource_GitHub $ s { _gitHubSource_private = markPrivate }
848− = CheckClean_FullCheck
849− -- ^ Check that the repo is clean, including .gitignored files
850− | CheckClean_NotIgnored
851− -- ^ Check that the repo is clean, not including .gitignored files
852− | CheckClean_NoCheck
853− -- ^ Don't check that the repo is clean
855−getThunkPtr :: forall m. MonadObelisk m => CheckClean -> FilePath -> Maybe Bool -> m ThunkPtr
856−getThunkPtr gitCheckClean dir mPrivate = do
857− let repoLocations = nubOrd $ map (first normalise)
858− [(".git", "."), (unpackedDirName </> ".git", unpackedDirName)]
859− repoLocation' <- liftIO $ flip findM repoLocations $ doesDirectoryExist . (dir </>) . fst
860− thunkDir <- case repoLocation' of
861− Nothing -> failWith [i|Can't find an unpacked thunk in ${dir}|]
862− Just (_, path) -> pure $ normalise $ dir </> path
864− let (checkClean, checkIgnored) = case gitCheckClean of
865− CheckClean_FullCheck -> (True, True)
866− CheckClean_NotIgnored -> (True, False)
867− CheckClean_NoCheck -> (False, False)
868− when checkClean $ ensureCleanGitRepo thunkDir checkIgnored
869 "thunk pack: thunk checkout contains unsaved modifications"
620 "thunk pack: thunk checkout contains unsaved modifications"
871 -- Check whether there are any stashes
622 -- Check whether there are any stashes
872− when checkClean $ do
623+ stashOutput <- readGitProcess thunkDir ["stash", "list"]
873− stashOutput <- readGitProcess thunkDir ["stash", "list"]
624+ when checkClean $ case T.null stashOutput of
874− unless (T.null stashOutput) $
625+ False -> do
875 failWith $ T.unlines $
626 failWith $ T.unlines $
876 [ "thunk pack: thunk checkout has stashes"
627 [ "thunk pack: thunk checkout has stashes"
877 , "git stash list:"
628 , "git stash list:"
878 ] ++ T.lines stashOutput
629 ] ++ T.lines stashOutput
879−
630+ True -> return ()
880− -- Get current branch
881− (mCurrentBranch, mCurrentCommit) <- do
882− b <- listToMaybe . T.lines <$> readGitProcess thunkDir ["rev-parse", "--abbrev-ref", "HEAD"]
883− c <- listToMaybe . T.lines <$> readGitProcess thunkDir ["rev-parse", "HEAD"]
885− (Just "HEAD") -> failWith $ T.unlines
886− [ "thunk pack: You are in 'detached HEAD' state."
887− , "If you want to pack at the current ref \
888− \then please create a new branch with 'git checkout -b <new-branch-name>' and push this upstream."
892 -- Get information on all branches and their (optional) designated upstream
632 -- Get information on all branches and their (optional) designated upstream
893 -- correspondents
633 -- correspondents
894− headDump :: [Text] <- T.lines <$> readGitProcess thunkDir
634+ (headDump :: [Text]) <- T.lines <$> readGitProcess thunkDir
895 [ "for-each-ref"
635 [ "for-each-ref"
896 , "--format=%(refname:short) %(upstream:short) %(upstream:remotename)"
636 , "--format=%(refname:short) %(upstream:short) %(upstream:remotename)"
897 , "refs/heads/"
637 , "refs/heads/"
@@ -921,7 +661,7 @@ getThunkPtr gitCheckClean dir mPrivate = do
921 let untrackedBranches = Map.keys errorMap
661 let untrackedBranches = Map.keys errorMap
922 when (not $ L.null untrackedBranches) $ failWith $ T.unlines $
662 when (not $ L.null untrackedBranches) $ failWith $ T.unlines $
923 [ "thunk pack: Certain branches in the thunk have no upstream branch \
663 [ "thunk pack: Certain branches in the thunk have no upstream branch \
924− \set. This means we don't know to check whether all your work is \
664+ \set. This means don't know to check whether all your work is \
925 \saved. The offending branches are:"
665 \saved. The offending branches are:"
927 , T.unwords untrackedBranches
667 , T.unwords untrackedBranches
@@ -937,7 +677,7 @@ getThunkPtr gitCheckClean dir mPrivate = do
939 -- loosely by https://stackoverflow.com/questions/7773939/show-git-ahead-and-behind-info-for-all-branches-including-remotes
679 -- loosely by https://stackoverflow.com/questions/7773939/show-git-ahead-and-behind-info-for-all-branches-including-remotes
940− stats <- ifor headUpstream $ \branch (upstream, _remote) -> do
680+ stats <- iforM headUpstream $ \branch (upstream, _remote) -> do
941 (stat :: [Text]) <- T.lines <$> readGitProcess thunkDir
681 (stat :: [Text]) <- T.lines <$> readGitProcess thunkDir
942 [ "rev-list", "--left-right"
682 [ "rev-list", "--left-right"
943 , T.unpack branch <> "..." <> T.unpack upstream
683 , T.unpack branch <> "..." <> T.unpack upstream
@@ -954,16 +694,20 @@ getThunkPtr gitCheckClean dir mPrivate = do
954 [ "thunk pack: Certain branches in the thunk have commits not yet pushed upstream:"
694 [ "thunk pack: Certain branches in the thunk have commits not yet pushed upstream:"
957− flip map (Map.toList nonGood) (\(branch, (upstream, (ahead, behind))) -> mconcat
697+ (flip map (Map.toList nonGood) $ \(branch, (upstream, (ahead, behind))) -> mconcat
958 [" ", branch, " ahead: ", T.pack (show ahead), " behind: ", T.pack (show behind), " remote branch ", upstream]) ++
698 [" ", branch, " ahead: ", T.pack (show ahead), " behind: ", T.pack (show behind), " remote branch ", upstream]) ++
960 , "Please push these upstream and try again. (Or just fetch, if they are somehow \
700 , "Please push these upstream and try again. (Or just fetch, if they are somehow \
961 \pushed but this repo's remote tracking branches don't know it.)"
701 \pushed but this repo's remote tracking branches don't know it.)"
964− when checkClean $ do
704+ -- We assume it's safe to pack the thunk at this point
965− -- We assume it's safe to pack the thunk at this point
705+ putLog Informational $ "All changes safe in git remotes. OK to pack thunk."
966− putLog Informational "All changes safe in git remotes. OK to pack thunk."
706+
707+ -- Get current branch ``
708+ mCurrentBranch <- listToMaybe
710+ <$> readGitProcess thunkDir ["rev-parse", "--abbrev-ref", "HEAD"]
968 let remote = maybe "origin" snd $ flip Map.lookup headUpstream =<< mCurrentBranch
712 let remote = maybe "origin" snd $ flip Map.lookup headUpstream =<< mCurrentBranch
@@ -976,12 +720,14 @@ getThunkPtr gitCheckClean dir mPrivate = do
976 remoteUri <- case parseGitUri remoteUri' of
720 remoteUri <- case parseGitUri remoteUri' of
977 Nothing -> failWith $ "Could not identify git remote: " <> remoteUri'
721 Nothing -> failWith $ "Could not identify git remote: " <> remoteUri'
978 Just uri -> pure uri
722 Just uri -> pure uri
979− uriThunkPtr remoteUri mPrivate mCurrentBranch mCurrentCommit
723+ uriThunkPtr remoteUri mCurrentBranch
981-- | Get the latest revision available from the given source
725-- | Get the latest revision available from the given source
982getLatestRev :: MonadObelisk m => ThunkSource -> m ThunkRev
726getLatestRev :: MonadObelisk m => ThunkSource -> m ThunkRev
983getLatestRev os = do
727getLatestRev os = do
984− let gitS = thunkSourceToGitSource os
728+ let gitS = case os of
729+ ThunkSource_GitHub s -> forgetGithub False s
730+ ThunkSource_Git s -> s
985 (_, commit) <- gitGetCommitBranch (_gitSource_url gitS) (untagName <$> _gitSource_branch gitS)
731 (_, commit) <- gitGetCommitBranch (_gitSource_url gitS) (untagName <$> _gitSource_branch gitS)
986 case os of
732 case os of
987 ThunkSource_GitHub s -> githubThunkRev s commit
733 ThunkSource_GitHub s -> githubThunkRev s commit
@@ -993,18 +739,16 @@ getLatestRev os = do
993-- performance. If that doesn't work (e.g. authentication issue), we fall back
739-- performance. If that doesn't work (e.g. authentication issue), we fall back
994-- on just doing things the normal way for git repos in general, and save it as
740-- on just doing things the normal way for git repos in general, and save it as
995-- a regular git thunk.
741-- a regular git thunk.
996−uriThunkPtr :: MonadObelisk m => GitUri -> Maybe Bool -> Maybe Text -> Maybe Text -> m ThunkPtr
742+uriThunkPtr :: MonadObelisk m => URI -> Maybe Text -> m ThunkPtr
997−uriThunkPtr uri mPrivate mbranch mcommit = do
743+uriThunkPtr uri mbranch = do
998− commit <- case mcommit of
744+ (_, commit) <- gitGetCommitBranch uri mbranch
999− Nothing -> gitGetCommitBranch uri mbranch >>= return . snd
745+ (src, rev) <- case uriToThunkSource uri mbranch of
1000− (Just c) -> return c
1001− (src, rev) <- uriToThunkSource uri mPrivate mbranch >>= \case
1002 ThunkSource_GitHub s -> do
746 ThunkSource_GitHub s -> do
1003 rev <- runExceptT $ githubThunkRev s commit
747 rev <- runExceptT $ githubThunkRev s commit
1004 case rev of
748 case rev of
1005 Right r -> pure (ThunkSource_GitHub s, r)
749 Right r -> pure (ThunkSource_GitHub s, r)
1006 Left e -> do
750 Left e -> do
1007− putLog Warning "\
751+ putLog Warning $ "\
1008\Failed to fetch archive from GitHub. This is probably a private repo. \
752\Failed to fetch archive from GitHub. This is probably a private repo. \
1009\Falling back on normal fetchgit. Original failure:"
753\Falling back on normal fetchgit. Original failure:"
1010 errorToWarning e
754 errorToWarning e
@@ -1021,66 +765,34 @@ uriThunkPtr uri mPrivate mbranch mcommit = do
1021-- If the thunk is a GitHub thunk and fails, we do *not* fall back like with
765-- If the thunk is a GitHub thunk and fails, we do *not* fall back like with
1022-- `uriThunkPtr`. Unlike a plain URL, a thunk src explicitly states which method
766-- `uriThunkPtr`. Unlike a plain URL, a thunk src explicitly states which method
1023-- should be employed, and so we respect that.
767-- should be employed, and so we respect that.
1024−uriToThunkSource :: MonadObelisk m => GitUri -> Maybe Bool -> Maybe Text -> m ThunkSource
768+uriToThunkSource :: URI -> Maybe Text -> ThunkSource
1025−uriToThunkSource (GitUri u) mPrivate
769+uriToThunkSource u
1026− | Right uriAuth <- URI.uriAuthority u
770+ | Right uriAuth <- uriAuthority u
1027− , Just scheme <- URI.unRText <$> URI.uriScheme u
771+ , Just scheme <- unRText <$> uriScheme u
1028 , case scheme of
772 , case scheme of
1029− "ssh" -> uriAuth == URI.Authority
773+ "ssh" -> uriAuth == Authority
1030− { URI.authUserInfo = Just $ URI.UserInfo (fromRight' $ URI.mkUsername "git") Nothing
774+ { authUserInfo = Just $ UserInfo (fromRight' $ mkUsername "git") Nothing
1031− , URI.authHost = fromRight' $ URI.mkHost "github.com"
775+ , authHost = fromRight' $ mkHost "github.com"
1032− , URI.authPort = Nothing
776+ , authPort = Nothing
1034 s -> s `L.elem` [ "git", "https", "http" ] -- "http:" just redirects to "https:"
778 s -> s `L.elem` [ "git", "https", "http" ] -- "http:" just redirects to "https:"
1035− && URI.unRText (URI.authHost uriAuth) == "github.com"
779+ && unRText (authHost uriAuth) == "github.com"
1036− , Just (_, owner :| [repoish]) <- URI.uriPath u
780+ , Just (_, owner :| [repoish]) <- uriPath u
1037− = \mbranch -> do
781+ = \mbranch -> ThunkSource_GitHub $ GitHubSource
1038− isPrivate <- getIsPrivate
782+ { _gitHubSource_owner = N $ unRText owner
1039− pure $ ThunkSource_GitHub $ GitHubSource
783+ , _gitHubSource_repo = N $ let
1040− { _gitHubSource_owner = N $ URI.unRText owner
784+ repoish' = unRText repoish
1041− , _gitHubSource_repo = N $ let
785+ in case T.stripSuffix ".git" repoish' of
1042− repoish' = URI.unRText repoish
786+ Just repo -> repo
1043− in fromMaybe repoish' $ T.stripSuffix ".git" repoish'
787+ Nothing -> repoish'
1044− , _gitHubSource_branch = N <$> mbranch
788+ , _gitHubSource_branch = N <$> mbranch
1045− , _gitHubSource_private = isPrivate
789+ }
1048− | otherwise = \mbranch -> do
791+ | otherwise = \mbranch -> ThunkSource_Git $ GitSource
1049− isPrivate <- getIsPrivate
792+ { _gitSource_url = u
1050− pure $ ThunkSource_Git $ GitSource
793+ , _gitSource_branch = N <$> mbranch
1051− { _gitSource_url = GitUri u
794+ , _gitSource_fetchSubmodules = False -- TODO: How do we determine if this should be true?
1052− , _gitSource_branch = N <$> mbranch
795+ }
1053− , _gitSource_fetchSubmodules = False -- TODO: How do we determine if this should be true?
1054− , _gitSource_private = isPrivate
1057− getIsPrivate = maybe (guessGitRepoIsPrivate $ GitUri u) pure mPrivate
1059−guessGitRepoIsPrivate :: MonadObelisk m => GitUri -> m Bool
1060−guessGitRepoIsPrivate uri = flip fix urisToTry $ \loop -> \case
1062− uriAttempt:xs -> do
1063− result <- readCreateProcessWithExitCode $
1070− , T.unpack $ gitUriToText uriAttempt
1073− (ExitSuccess, _, _) -> pure False -- Must be a public repo
1076− urisToTry = nubOrd $
1077− -- Include the original URI if it isn't using SSH because SSH will certainly fail.
1078− [uri | fmap URI.unRText (URI.uriScheme (unGitUri uri)) /= Just "ssh"] <>
1079− [changeScheme "https" uri, changeScheme "http" uri]
1080− changeScheme scheme (GitUri u) = GitUri $ u
1081− { URI.uriScheme = URI.mkScheme scheme
1082− , URI.uriAuthority = (\x -> x { URI.authUserInfo = Nothing }) <$> URI.uriAuthority u
1085-- Funny signature indicates no effects depend on the optional branch name.
797-- Funny signature indicates no effects depend on the optional branch name.
1086githubThunkRev
798githubThunkRev
@@ -1092,19 +804,19 @@ githubThunkRev
1092githubThunkRev s commit = do
804githubThunkRev s commit = do
1093 owner <- forcePP $ _gitHubSource_owner s
805 owner <- forcePP $ _gitHubSource_owner s
1094 repo <- forcePP $ _gitHubSource_repo s
806 repo <- forcePP $ _gitHubSource_repo s
1095− revTarball <- URI.mkPathPiece $ commit <> ".tar.gz"
807+ revTarball <- mkPathPiece $ commit <> ".tar.gz"
1096− let archiveUri = GitUri $ URI.URI
808+ let archiveUri = URI
1097− { URI.uriScheme = Just $ fromRight' $ URI.mkScheme "https"
809+ { uriScheme = Just $ fromRight' $ mkScheme "https"
1098− , URI.uriAuthority = Right $ URI.Authority
810+ , uriAuthority = Right $ Authority
1099− { URI.authUserInfo = Nothing
811+ { authUserInfo = Nothing
1100− , URI.authHost = fromRight' $ URI.mkHost "github.com"
812+ , authHost = fromRight' $ mkHost "github.com"
1101− , URI.authPort = Nothing
813+ , authPort = Nothing
1103− , URI.uriPath = Just ( False
815+ , uriPath = Just ( False
1104− , owner :| [ repo, fromRight' $ URI.mkPathPiece "archive", revTarball ]
816+ , owner :| [ repo, fromRight' $ mkPathPiece "archive", revTarball ]
1106− , URI.uriQuery = []
818+ , uriQuery = []
1107− , URI.uriFragment = Nothing
819+ , uriFragment = Nothing
1109 hash <- getNixSha256ForUriUnpacked archiveUri
821 hash <- getNixSha256ForUriUnpacked archiveUri
1110 putLog Debug $ "Nix sha256 is " <> hash
822 putLog Debug $ "Nix sha256 is " <> hash
@@ -1113,8 +825,8 @@ githubThunkRev s commit = do
1113 , _thunkRev_nixSha256 = hash
825 , _thunkRev_nixSha256 = hash
1116− forcePP :: Name entity -> m (URI.RText 'URI.PathPiece)
828+ forcePP :: Name entity -> m (RText 'PathPiece)
1117− forcePP = URI.mkPathPiece . untagName
829+ forcePP = mkPathPiece . untagName
1119gitThunkRev
831gitThunkRev
1120 :: MonadObelisk m
832 :: MonadObelisk m
@@ -1123,11 +835,11 @@ gitThunkRev
1123 -> m ThunkRev
835 -> m ThunkRev
1124gitThunkRev s commit = do
836gitThunkRev s commit = do
1125 let u = _gitSource_url s
837 let u = _gitSource_url s
1126− protocols = ["file", "https", "ssh", "git"]
838+ protocols = ["https", "ssh", "git"]
1127− scheme = maybe "file" URI.unRText $ URI.uriScheme $ (\(GitUri x) -> x) u
839+ Just scheme <- pure $ unRText <$> uriScheme u
1128 unless (T.toLower scheme `elem` protocols) $
840 unless (T.toLower scheme `elem` protocols) $
1129 failWith $ "obelisk currently only supports "
841 failWith $ "obelisk currently only supports "
1130− <> T.intercalate ", " protocols <> " protocols for plain Git remotes"
842+ <> T.intercalate ", " protocols <> " protocols for non-GitHub remotes"
1131 hash <- nixPrefetchGit u commit $ _gitSource_fetchSubmodules s
843 hash <- nixPrefetchGit u commit $ _gitSource_fetchSubmodules s
1132 putLog Informational $ "Nix sha256 is " <> hash
844 putLog Informational $ "Nix sha256 is " <> hash
1133 pure $ ThunkRev
845 pure $ ThunkRev
@@ -1140,14 +852,12 @@ gitThunkRev s commit = do
1141-- If the branch name is passed in, it is returned exactly as-is. If it is not
853-- If the branch name is passed in, it is returned exactly as-is. If it is not
1142-- passed it, the default branch of the repo is used instead.
854-- passed it, the default branch of the repo is used instead.
1144gitGetCommitBranch
855gitGetCommitBranch
1145− :: MonadObelisk m => GitUri -> Maybe Text -> m (Text, CommitId)
856+ :: MonadObelisk m => URI -> Maybe Text -> m (Text, CommitId)
1146gitGetCommitBranch uri mbranch = withExitFailMessage ("Failure for git remote " <> uriMsg) $ do
857gitGetCommitBranch uri mbranch = withExitFailMessage ("Failure for git remote " <> uriMsg) $ do
1147− (_, bothMaps) <- gitLsRemote
858+ bothMaps <- gitLsRemote
1148− (T.unpack $ gitUriToText uri)
859+ (T.unpack $ render uri)
1149 (GitRef_Branch <$> mbranch)
860 (GitRef_Branch <$> mbranch)
1151 branch <- case mbranch of
861 branch <- case mbranch of
1152 Nothing -> withExitFailMessage "Failed to find default branch" $ do
862 Nothing -> withExitFailMessage "Failed to find default branch" $ do
1153 b <- rethrowE $ gitLookupDefaultBranch bothMaps
863 b <- rethrowE $ gitLookupDefaultBranch bothMaps
@@ -1161,21 +871,18 @@ gitGetCommitBranch uri mbranch = withExitFailMessage ("Failure for git remote "
1161 pure (branch, commit)
871 pure (branch, commit)
1163 rethrowE = either failWith pure
873 rethrowE = either failWith pure
1164− uriMsg = gitUriToText uri
874+ uriMsg = render uri
1166−parseGitUri :: Text -> Maybe GitUri
1167−parseGitUri x = GitUri <$> (parseFileURI x <|> parseAbsoluteURI x <|> parseSshShorthand x)
1169−parseFileURI :: Text -> Maybe URI.URI
876+parseGitUri :: Text -> Maybe URI
1170−parseFileURI uri = if "/" `T.isPrefixOf` uri then parseAbsoluteURI ("file://" <> uri) else Nothing
877+parseGitUri x = parseAbsoluteURI x <|> parseSshShorthand x
1172−parseAbsoluteURI :: Text -> Maybe URI.URI
879+parseAbsoluteURI :: Text -> Maybe URI
1173parseAbsoluteURI uri = do
880parseAbsoluteURI uri = do
1174− parsedUri <- URI.mkURI uri
881+ parsedUri <- mkURI uri
1175− guard $ URI.isPathAbsolute parsedUri
882+ guard $ isPathAbsolute parsedUri
1176− pure parsedUri
883+ pure $ parsedUri
1178−parseSshShorthand :: Text -> Maybe URI.URI
885+parseSshShorthand :: Text -> Maybe URI
1179parseSshShorthand uri = do
886parseSshShorthand uri = do
1180 -- This is what git does to check that the remote
887 -- This is what git does to check that the remote
1181 -- is not a local file path when parsing shorthand.
888 -- is not a local file path when parsing shorthand.
@@ -1188,4 +895,4 @@ parseSshShorthand uri = do
1188 -- This check is used to disambiguate a filepath containing a colon from shorthand
895 -- This check is used to disambiguate a filepath containing a colon from shorthand
1189 guard $ isNothing (T.findIndex (=='/') authAndHostname)
896 guard $ isNothing (T.findIndex (=='/') authAndHostname)
1190 && not (T.null colonAndPath)
897 && not (T.null colonAndPath)
1191− URI.mkURI properUri
898+ mkURI properUri