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