@@ -5,70 +5,83 @@
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 (..)
18+ , updateThunkToLatest
20+ , createThunkWithLatest
21+ , nixBuildAttrWithCache
22+ , nixBuildThunkAttrWithCache
13import Control.Applicative
30import Control.Applicative
14−import Control.Exception (displayException, try)
31+import Control.Exception (displayException, throwIO, try)
15−import Control.Lens (ifor, ifor_, (.~))
16import Control.Monad
32import Control.Monad
17−import Control.Monad.Extra (findM)
33+import Control.Monad.Catch (handle)
18−import Control.Monad.Catch (MonadCatch, handle)
19import Control.Monad.Except
34import Control.Monad.Except
20import Data.Aeson ((.=))
35import Data.Aeson ((.=))
21import qualified Data.Aeson as Aeson
36import qualified Data.Aeson as Aeson
22import Data.Aeson.Encode.Pretty
37import Data.Aeson.Encode.Pretty
23import qualified Data.Aeson.Types as Aeson
38import qualified Data.Aeson.Types as Aeson
24−import Data.Bifunctor (first)
25import qualified Data.ByteString.Lazy as LBS
39import qualified Data.ByteString.Lazy as LBS
26−import Data.Containers.ListUtils (nubOrd)
40+import qualified Data.ByteString.Lazy.Char8 as LBSC
27import Data.Default
41import Data.Default
28−import Data.Either.Combinators (fromRight', rightToMaybe)
42+import Data.Either.Combinators (rightToMaybe)
29−import Data.Foldable (toList)
43+import Data.Foldable
30−import Data.Function ((&))
31−import Data.Functor ((<&>))
32import Data.Git.Ref (Ref)
44import Data.Git.Ref (Ref)
33import qualified Data.Git.Ref as Ref
45import qualified Data.Git.Ref as Ref
34import qualified Data.List as L
46import qualified Data.List as L
35−import Data.List.NonEmpty (NonEmpty (..), nonEmpty)
47+import Data.List.NonEmpty (NonEmpty (..))
36import qualified Data.List.NonEmpty as NonEmpty
48import qualified Data.List.NonEmpty as NonEmpty
38import qualified Data.Map as Map
49import qualified Data.Map as Map
39import Data.Maybe
50import Data.Maybe
40import Data.Set (Set)
52import Data.Set (Set)
41import qualified Data.Set as Set
53import qualified Data.Set as Set
42−import Data.String.Here.Interpolated (i)
43−import Data.String.Here.Uninterpolated (here)
44import Data.Text (Text)
54import Data.Text (Text)
45import qualified Data.Text as T
55import qualified Data.Text as T
46import Data.Text.Encoding
56import Data.Text.Encoding
47import qualified Data.Text.IO as T
57import qualified Data.Text.IO as T
48import Data.Time.Clock.POSIX (posixSecondsToUTCTime)
58import Data.Time.Clock.POSIX (posixSecondsToUTCTime)
49−import Data.Traversable (for)
50−import Data.Yaml (parseMaybe)
59+import Data.Yaml (parseMaybe, (.:))
60+import qualified Data.Yaml as Yaml
51import GitHub
61import GitHub
52import GitHub.Data.Name
62import GitHub.Data.Name
63+import GitHub.Endpoints.Repos.Contents (archiveForR)
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)
73import Obelisk.App (MonadObelisk)
63−import Obelisk.CliApp
74+import Obelisk.CliApp (Severity (..), callProcessAndLogOutput, failWith, putLog, readProcessAndLogStderr,
75+ withExitFailMessage, withSpinner)
64−import Obelisk.Command.Utils
76+import Obelisk.Command.Utils (checkGitCleanStatus, gitProc)
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,11 +107,6 @@ 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
@@ -107,208 +115,177 @@ data GitHubSource = GitHubSource
108 deriving (Show, Eq, Ord)
116 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
118data GitSource = GitSource
120− { _gitSource_url :: GitUri
119+ { _gitSource_url :: URI
121− , _gitSource_branch :: Maybe (Name Branch)
120+ , _gitSource_branch :: Name Branch
122 , _gitSource_fetchSubmodules :: Bool
121 , _gitSource_fetchSubmodules :: Bool
123− , _gitSource_private :: Bool
125 deriving (Show, Eq, Ord)
123 deriving (Show, Eq, Ord)
127−newtype ThunkConfig = ThunkConfig
128− { _thunkConfig_private :: Maybe Bool
131−data ThunkUpdateConfig = ThunkUpdateConfig
132− { _thunkUpdateConfig_branch :: Maybe String
133− , _thunkUpdateConfig_config :: ThunkConfig
136−data ThunkPackConfig = ThunkPackConfig
137− { _thunkPackConfig_force :: Bool
138− , _thunkPackConfig_config :: ThunkConfig
141−-- | Convert a GitHub source to a regular Git source. Assumes no submodules.
142−forgetGithub :: Bool -> GitHubSource -> GitSource
143−forgetGithub useSsh s = GitSource
144− { _gitSource_url = GitUri $ URI.URI
145− { URI.uriScheme = Just $ fromRight' $ URI.mkScheme $ if useSsh then "ssh" else "https"
146− , URI.uriAuthority = Right $ URI.Authority
147− { URI.authUserInfo = URI.UserInfo (fromRight' $ URI.mkUsername "git") Nothing
149− , URI.authHost = fromRight' $ URI.mkHost "github.com"
150− , URI.authPort = Nothing
152− , URI.uriPath = Just ( False
153− , fromRight' . URI.mkPathPiece <$>
154− untagName (_gitHubSource_owner s)
155− :| [ untagName (_gitHubSource_repo s) <> ".git" ]
158− , URI.uriFragment = Nothing
160− , _gitSource_branch = _gitHubSource_branch s
161− , _gitSource_fetchSubmodules = False
162− , _gitSource_private = _gitHubSource_private s
165−getThunkGitBranch :: ThunkPtr -> Maybe Text
166−getThunkGitBranch (ThunkPtr _ src) = fmap untagName $ case src of
167− ThunkSource_GitHub s -> _gitHubSource_branch s
168− ThunkSource_Git s -> _gitSource_branch s
170−commitNameToRef :: Name Commit -> Ref Ref.SHA1
125+commitNameToRef :: Name Commit -> Ref
171commitNameToRef (N c) = Ref.fromHex $ encodeUtf8 c
126commitNameToRef (N c) = Ref.fromHex $ encodeUtf8 c
173-- TODO: Use spinner here.
128-- TODO: Use spinner here.
174−getNixSha256ForUriUnpacked
129+getNixSha256ForUriUnpacked :: MonadObelisk m => URI -> m NixSha256
178getNixSha256ForUriUnpacked uri =
130getNixSha256ForUriUnpacked uri =
179− withExitFailMessage ("nix-prefetch-url: Failed to determine sha256 hash of URL " <> gitUriToText uri) $ do
131+ withExitFailMessage ("nix-prefetch-url: Failed to determine sha256 hash of URL " <> T.pack (show uri)) $ do
180− [hash] <- fmap T.lines $ readProcessAndLogOutput (Debug, Debug) $
132+ fmap T.pack $ readProcessAndLogStderr Debug $
181− proc nixPrefetchUrlPath ["--unpack", "--type", "sha256", T.unpack $ gitUriToText uri]
133+ proc "nix-prefetch-url" ["--unpack" , "--type" , "sha256" , show uri]
184−nixPrefetchGit :: MonadObelisk m => GitUri -> Text -> Bool -> m NixSha256
135+nixPrefetchGit :: MonadObelisk m => URI -> Text -> Bool -> m NixSha256
185nixPrefetchGit uri rev fetchSubmodules =
136nixPrefetchGit uri rev fetchSubmodules =
186− withExitFailMessage ("nix-prefetch-git: Failed to determine sha256 hash of Git repo " <> gitUriToText uri <> " at " <> rev) $ do
137+ withExitFailMessage ("nix-prefetch-git: Failed to determine sha256 hash of Git repo " <> T.pack (show uri) <> " at " <> rev) $ do
187 out <- readProcessAndLogStderr Debug $
138 out <- readProcessAndLogStderr Debug $
188− proc nixPrefetchGitPath $ filter (/="")
139+ proc "nix-prefetch-git" $ filter (/="")
189− [ "--url", T.unpack $ gitUriToText uri
140+ [ "--url", show uri
190 , "--rev", T.unpack rev
141 , "--rev", T.unpack rev
191 , if fetchSubmodules then "--fetch-submodules" else ""
142 , if fetchSubmodules then "--fetch-submodules" else ""
192 , "--quiet"
143 , "--quiet"
195− case parseMaybe (Aeson..: "sha256") =<< Aeson.decodeStrict (encodeUtf8 out) of
146+ case parseMaybe (Aeson..: "sha256") =<< Aeson.decode (LBSC.pack out) of
196− Nothing -> failWith $ "nix-prefetch-git: unrecognized output " <> out
147+ Nothing -> failWith $ "nix-prefetch-git: unrecognized output " <> T.pack out
197 Just x -> pure x
148 Just x -> pure x
150+getLatestGitRev :: MonadObelisk m => GitSource -> m ThunkRev
151+getLatestGitRev s = withSystemTempDirectory "git-clone" $ \tmpDir -> do
152+ withExitFailMessage ("Unable to determine latest git revision for branch " <> branch) $ do
153+ let git = fmap T.pack . readProcessAndLogStderr Debug . gitProc tmpDir
155+ (git ["clone", "--no-checkout", show $ _gitSource_url s]) -- Might be able to use --bare here instead to go faster.
156+ (git ["log", T.unpack branch, "--max-count=1", "--format=%H"])
158+ case T.strip <$> safeLast (T.lines out) of
159+ Nothing -> failWith $ "Unable to parse git log: " <> out
161+ putLog Debug $ "Latest commit in " <> branch <> " is " <> rev
162+ sha <- nixPrefetchGit (_gitSource_url s) rev (_gitSource_fetchSubmodules s)
163+ putLog Debug $ "Nix sha256 is " <> sha
165+ { _thunkRev_commit = Ref.fromHexString $ T.unpack rev
166+ , _thunkRev_nixSha256 = sha
169+ remote :: Text = "origin"
170+ branch :: Text = remote <> "/" <> untagName (_gitSource_branch s)
172+ safeLast [] = Nothing
173+ safeLast xs = Just $ last xs
175+-- | Get the latest revision available from the given source
176+getLatestRev :: MonadObelisk m => ThunkSource -> m ThunkRev
178+ ThunkSource_GitHub s -> do
179+ auth <- liftIO $ getHubAuth "github.com"
180+ commitsResult <- liftIO $ executeRequestMaybe auth $ commitsWithOptionsForR
181+ (_gitHubSource_owner s)
182+ (_gitHubSource_repo s)
184+ $ case _gitHubSource_branch s of
186+ Just b -> [CommitQuerySha $ untagName b]
187+ commitInfos <- either (liftIO . throwIO) return commitsResult
188+ commitInfo : _ <- return $ toList commitInfos
189+ let commit = commitSha commitInfo
190+ putLog Debug $ "Latest commit is " <> untagName commit
191+ Right archiveUri <- liftIO $ executeRequestMaybe auth $ archiveForR (_gitHubSource_owner s) (_gitHubSource_repo s) ArchiveFormatTarball $ Just $ untagName commit
192+ nixSha256 <- getNixSha256ForUriUnpacked archiveUri
193+ putLog Debug $ "Nix sha256 is " <> nixSha256
195+ { _thunkRev_commit = commitNameToRef commit
196+ , _thunkRev_nixSha256 = nixSha256
198+ ThunkSource_Git s -> getLatestGitRev s
199--TODO: Pretty print these
200--TODO: Pretty print these
200data ReadThunkError
201data ReadThunkError
201− = ReadThunkError_UnrecognizedThunk
202+ = ReadThunkError_UnrecognizedFiles
202− | ReadThunkError_UnrecognizedPaths (NonEmpty FilePath)
203+ | ReadThunkError_AmbiguousFiles
203− | ReadThunkError_MissingPaths (NonEmpty FilePath)
204+ | ReadThunkError_UnrecognizedLoader Text
204− | ReadThunkError_UnparseablePtr FilePath String
205+ | ReadThunkError_UnparseablePtr LBS.ByteString
205− | ReadThunkError_FileError IOError
206− | ReadThunkError_FileDoesNotMatch FilePath Text
207− | ReadThunkError_UnrecognizedState String
208− | ReadThunkError_AmbiguousPackedState ThunkPtr ThunkPtr
209− deriving (Show)
206+ deriving (Show)
211−unpackedDirName :: FilePath
208+-- | Read a thunk and validate that it is only a thunk, either packed or unpacked.
212−unpackedDirName = "."
209+-- If the thunk is packed and additional data is present, fail.
213−
210+readThunk :: MonadObelisk m => FilePath -> m (Either ReadThunkError ThunkData)
214−attrCacheFileName :: FilePath
211+readThunk thunkDir = do
215−attrCacheFileName = ".attr-cache"
212+ files <- liftIO $ listDirectory thunkDir
216−
213+ case ".git" `elem` files of
217−-- | Specification for how a file in a thunk version works.
214+ True -> fmap ThunkData_Checkout <$> do
218−data ThunkFileSpec
215+ let origThunkPath = thunkDir </> ".git" </> "obelisk" </> "orig-thunk"
219− = ThunkFileSpec_Ptr (LBS.ByteString -> Either String ThunkPtr) -- ^ This file specifies 'ThunkPtr' data
216+ liftIO $ doesDirectoryExist origThunkPath >>= \case
220− | ThunkFileSpec_FileMatches Text -- ^ This file must match the given content exactly
217+ True -> fmap Just <$> readPackedThunk origThunkPath
221− | ThunkFileSpec_CheckoutIndicator -- ^ Existence of this directory indicates that the thunk is unpacked
218+ False -> return $ return Nothing
222− | ThunkFileSpec_AttrCache -- ^ This directory is an attribute cache
219+ False -> liftIO $ fmap ThunkData_Packed <$> readPackedThunk thunkDir
224−-- | Specification for how a set of files in a thunk version work.
221+data ThunkType = ThunkType
225−data ThunkSpec = ThunkSpec
222+ { _thunkType_loader :: FilePath
226− { _thunkSpec_name :: !Text
223+ , _thunkType_json :: FilePath
227− , _thunkSpec_files :: !(Map FilePath ThunkFileSpec)
224+ , _thunkType_optional :: Set FilePath
225+ , _thunkType_loaderVersions :: NonEmpty Text
226+ , _thunkType_parser :: Aeson.Object -> Aeson.Parser ThunkPtr
230−thunkSpecTypes :: NonEmpty (NonEmpty ThunkSpec)
229+gitHubThunkType :: ThunkType
231−thunkSpecTypes = gitThunkSpecs :| [gitHubThunkSpecs]
230+gitHubThunkType = ThunkType
232−
231+ { _thunkType_loader = "default.nix"
233−-- | Attempts to match a 'ThunkSpec' to a given directory.
232+ , _thunkType_json = "github.json"
234−matchThunkSpecToDir
233+ , _thunkType_optional = Set.fromList [".attr-cache"]
235− :: (MonadError ReadThunkError m, MonadIO m, MonadCatch m)
234+ , _thunkType_loaderVersions = gitHubStandaloneLoaders
236− => ThunkSpec -- ^ 'ThunkSpec' to match against the given files/directory
235+ , _thunkType_parser = parseThunkPtr $ \v ->
237− -> FilePath -- ^ Path to directory
236+ ThunkSource_GitHub <$> parseGitHubSource v <|> ThunkSource_Git <$> parseGitSource v
238− -> Set FilePath -- ^ Set of file paths relative to the given directory
237+ }
240−matchThunkSpecToDir thunkSpec dir dirFiles = do
239+gitThunkType :: ThunkType
241− case nonEmpty (toList $ dirFiles `Set.difference` expectedPaths) of
240+gitThunkType = ThunkType
242− Just fs -> throwError $ ReadThunkError_UnrecognizedPaths $ (dir </>) <$> fs
241+ { _thunkType_loader = "default.nix"
243− Nothing -> pure ()
242+ , _thunkType_json = "git.json"
244− case nonEmpty (toList $ requiredPaths `Set.difference` dirFiles) of
243+ , _thunkType_optional = Set.fromList [".attr-cache"]
245− Just fs -> throwError $ ReadThunkError_MissingPaths $ (dir </>) <$> fs
244+ , _thunkType_loaderVersions = plainGitStandaloneLoaders
246− Nothing -> pure ()
245+ , _thunkType_parser = parseThunkPtr $ fmap ThunkSource_Git . parseGitSource
247− datas <- fmap toList $ flip Map.traverseMaybeWithKey (_thunkSpec_files thunkSpec) $ \expectedPath -> \case
246+ }
248− ThunkFileSpec_AttrCache -> Nothing <$ dirMayExist expectedPath
247+
249− ThunkFileSpec_CheckoutIndicator -> liftIO (doesDirectoryExist (dir </> expectedPath)) <&> \case
248+thunkTypes :: [ThunkType]
250− False -> Nothing
249+thunkTypes = [gitThunkType, gitHubThunkType]
251− True -> Just ThunkData_Checkout
250+
252− ThunkFileSpec_FileMatches expectedContents -> handle (\(e :: IOError) -> throwError $ ReadThunkError_FileError e) $ do
251+findThunkType :: [ThunkType] -> FilePath -> IO (Either ReadThunkError ThunkType)
253− actualContents <- liftIO (T.readFile $ dir </> expectedPath)
252+findThunkType types thunkDir = do
254− case T.strip expectedContents == T.strip actualContents of
253+ matches <- fmap catMaybes $ forM types $ \thunkType -> do
255− True -> pure Nothing
254+ let
256− False -> throwError $ ReadThunkError_FileDoesNotMatch (dir </> expectedPath) expectedContents
255+ expectedContents = Set.fromList $ (thunkDir </>) <$>
257− ThunkFileSpec_Ptr parser -> handle (\(e :: IOError) -> throwError $ ReadThunkError_FileError e) $ do
256+ [ _thunkType_loader thunkType
258− let path = dir </> expectedPath
257+ , _thunkType_json thunkType
259− liftIO (doesFileExist path) >>= \case
258+ ]
260− False -> pure Nothing
259+ optionalContents = Set.map (thunkDir </>) (_thunkType_optional thunkType)
262− actualContents <- liftIO $ LBS.readFile path
261+ -- Ensure that there aren't any other files in the thunk
263− case parser actualContents of
262+ -- NB: System.Directory.listDirectory returns the contents without the directory path
264− Right v -> pure $ Just (ThunkData_Packed thunkSpec v)
263+ files <- liftIO $ Set.fromList . fmap (thunkDir </>) <$> listDirectory thunkDir
265− Left e -> throwError $ ReadThunkError_UnparseablePtr (dir </> expectedPath) e
264+ let unexpectedContents = files `Set.difference` (expectedContents `Set.union` optionalContents)
266−
265+ missingContents = expectedContents `Set.difference` files
267− case nonEmpty datas of
266+ pure $ if Set.null unexpectedContents && Set.null missingContents
268− Nothing -> throwError ReadThunkError_UnrecognizedThunk
267+ then Just thunkType
269− Just xs -> fold1WithM xs $ \a b -> either throwError pure (mergeThunkData a b)
268+ else Nothing
271− rootPathsOnly = Set.fromList . mapMaybe takeRootDir . Map.keys
270+ pure $ case matches of
272− takeRootDir = fmap NonEmpty.head . nonEmpty . splitPath
271+ [singleMatch] -> Right singleMatch
273−
272+ [] -> Left ReadThunkError_UnrecognizedFiles
274− expectedPaths = rootPathsOnly $ _thunkSpec_files thunkSpec
273+ _ -> 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.
275-- | Read a thunk and validate that it is exactly a packed thunk.
309-- If additional data is present, fail.
276-- If additional data is present, fail.
310−readThunk :: (MonadObelisk m) => FilePath -> m (Either ReadThunkError ThunkData)
277+readPackedThunk :: FilePath -> IO (Either ReadThunkError ThunkPtr)
311−readThunk = readThunkWith thunkSpecTypes
278+readPackedThunk thunkDir = runExceptT $ do
279+ thunkType <- ExceptT $ findThunkType thunkTypes thunkDir
280+ -- Ensure that we recognize the thunk loader
281+ loader <- liftIO $ T.readFile $ thunkDir </> _thunkType_loader thunkType
282+ unless (loader `elem` _thunkType_loaderVersions thunkType) $ do
283+ throwError $ ReadThunkError_UnrecognizedLoader loader
285+ txt <- liftIO $ LBS.readFile $ thunkDir </> _thunkType_json thunkType
286+ case parseMaybe (_thunkType_parser thunkType) =<< Aeson.decode txt of
287+ Nothing -> throwError $ ReadThunkError_UnparseablePtr txt
288+ Just ptr -> return ptr
313parseThunkPtr :: (Aeson.Object -> Aeson.Parser ThunkSource) -> Aeson.Object -> Aeson.Parser ThunkPtr
290parseThunkPtr :: (Aeson.Object -> Aeson.Parser ThunkSource) -> Aeson.Object -> Aeson.Parser ThunkPtr
314parseThunkPtr parseSrc v = do
291parseThunkPtr parseSrc v = do
@@ -328,42 +305,38 @@ parseGitHubSource v = do
328 owner <- v Aeson..: "owner"
305 owner <- v Aeson..: "owner"
329 repo <- v Aeson..: "repo"
306 repo <- v Aeson..: "repo"
330 branch <- v Aeson..:! "branch"
307 branch <- v Aeson..:! "branch"
331− private <- v Aeson..:? "private"
308+ mPrivate <- v Aeson..:! "private"
332 pure $ GitHubSource
309 pure $ GitHubSource
333 { _gitHubSource_owner = owner
310 { _gitHubSource_owner = owner
334 , _gitHubSource_repo = repo
311 , _gitHubSource_repo = repo
335 , _gitHubSource_branch = branch
312 , _gitHubSource_branch = branch
336− , _gitHubSource_private = fromMaybe False private
313+ , _gitHubSource_private = fromMaybe False mPrivate
339parseGitSource :: Aeson.Object -> Aeson.Parser GitSource
316parseGitSource :: Aeson.Object -> Aeson.Parser GitSource
340parseGitSource v = do
317parseGitSource v = do
341 Just url <- parseGitUri <$> v Aeson..: "url"
318 Just url <- parseGitUri <$> v Aeson..: "url"
342− branch <- v Aeson..:! "branch"
319+ branch <- v Aeson..: "branch"
343 fetchSubmodules <- v Aeson..:! "fetchSubmodules"
320 fetchSubmodules <- v Aeson..:! "fetchSubmodules"
344− private <- v Aeson..:? "private"
345 pure $ GitSource
321 pure $ GitSource
346 { _gitSource_url = url
322 { _gitSource_url = url
347 , _gitSource_branch = branch
323 , _gitSource_branch = branch
348 , _gitSource_fetchSubmodules = fromMaybe False fetchSubmodules
324 , _gitSource_fetchSubmodules = fromMaybe False fetchSubmodules
349− , _gitSource_private = fromMaybe False private
352overwriteThunk :: MonadObelisk m => FilePath -> ThunkPtr -> m ()
327overwriteThunk :: MonadObelisk m => FilePath -> ThunkPtr -> m ()
353overwriteThunk target thunk = do
328overwriteThunk target thunk = do
354 -- Ensure that this directory is a valid thunk (i.e. so we aren't losing any data)
329 -- Ensure that this directory is a valid thunk (i.e. so we aren't losing any data)
355− readThunk target >>= \case
330+ Right _ <- readThunk target
356− Left e -> failWith [i|Invalid thunk at ${target}: ${e}|]
359 --TODO: Is there a safer way to do this overwriting?
332 --TODO: Is there a safer way to do this overwriting?
360− liftIO $ removePathForcibly target
333+ liftIO $ removeDirectoryRecursive target
361− createThunk target $ Right thunk
334+ liftIO $ createThunk target thunk
363−thunkPtrToSpec :: ThunkPtr -> ThunkSpec
336+thunkPtrLoader :: ThunkPtr -> Text
364−thunkPtrToSpec thunk = case _thunkPtr_source thunk of
337+thunkPtrLoader thunk = case _thunkPtr_source thunk of
365− ThunkSource_GitHub _ -> NonEmpty.head gitHubThunkSpecs
338+ ThunkSource_GitHub _ -> NonEmpty.head gitHubStandaloneLoaders
366− ThunkSource_Git _ -> NonEmpty.head gitThunkSpecs
339+ ThunkSource_Git _ -> NonEmpty.head plainGitStandaloneLoaders
368-- It's important that formatting be very consistent here, because
341-- It's important that formatting be very consistent here, because
369-- otherwise when people update thunks, their patches will be messy
342-- otherwise when people update thunks, their patches will be messy
@@ -372,18 +345,22 @@ encodeThunkPtrData (ThunkPtr rev src) = case src of
372 ThunkSource_GitHub s -> encodePretty' githubCfg $ Aeson.object $ catMaybes
345 ThunkSource_GitHub s -> encodePretty' githubCfg $ Aeson.object $ catMaybes
373 [ Just $ "owner" .= _gitHubSource_owner s
346 [ Just $ "owner" .= _gitHubSource_owner s
374 , Just $ "repo" .= _gitHubSource_repo s
347 , Just $ "repo" .= _gitHubSource_repo s
375− , ("branch" .=) <$> _gitHubSource_branch s
348+ , case _gitHubSource_branch s of
349+ Just b -> Just $ "branch" .= b
351+ , if _gitHubSource_private s
352+ then Just $ "private" .= True
376 , Just $ "rev" .= Ref.toHexString (_thunkRev_commit rev)
354 , Just $ "rev" .= Ref.toHexString (_thunkRev_commit rev)
377 , Just $ "sha256" .= _thunkRev_nixSha256 rev
355 , Just $ "sha256" .= _thunkRev_nixSha256 rev
378− , Just $ "private" .= _gitHubSource_private s
380 ThunkSource_Git s -> encodePretty' plainGitCfg $ Aeson.object $ catMaybes
357 ThunkSource_Git s -> encodePretty' plainGitCfg $ Aeson.object $ catMaybes
358+ --TODO: Is this safe? read/show is jank for `URI`
381− [ Just $ "url" .= gitUriToText (_gitSource_url s)
359+ [ Just $ "url" .= show (_gitSource_url s)
382 , Just $ "rev" .= Ref.toHexString (_thunkRev_commit rev)
360 , Just $ "rev" .= Ref.toHexString (_thunkRev_commit rev)
383− , ("branch" .=) <$> _gitSource_branch s
361+ , Just $ "branch" .= _gitSource_branch s
384 , Just $ "sha256" .= _thunkRev_nixSha256 rev
362 , Just $ "sha256" .= _thunkRev_nixSha256 rev
385 , Just $ "fetchSubmodules" .= _gitSource_fetchSubmodules s
363 , Just $ "fetchSubmodules" .= _gitSource_fetchSubmodules s
386− , Just $ "private" .= _gitSource_private s
389 githubCfg = defConfig
366 githubCfg = defConfig
@@ -404,84 +381,59 @@ encodeThunkPtrData (ThunkPtr rev src) = case src of
406 , "sha256"
383 , "sha256"
408 , "fetchSubmodules"
384 , "fetchSubmodules"
409 ] <> compare
385 ] <> compare
410 , confTrailingNewline = True
386 , confTrailingNewline = True
413−createThunk :: MonadObelisk m => FilePath -> Either ThunkSpec ThunkPtr -> m ()
389+createThunk :: MonadIO m => FilePath -> ThunkPtr -> m ()
414−createThunk target ptrInfo =
390+createThunk target thunk = liftIO $ do
415− ifor_ (_thunkSpec_files spec) $ \path -> \case
416− ThunkFileSpec_FileMatches content -> withReadyPath path $ \p -> liftIO $ T.writeFile p content
417− ThunkFileSpec_Ptr _ -> case ptrInfo of
418− Left _ -> pure () -- We can't write the ptr without it
419− Right ptr -> withReadyPath path $ \p -> liftIO $ LBS.writeFile p (encodeThunkPtrData ptr)
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
391+ createDirectoryIfMissing True (target </> ".attr-cache")
427− f fullPath
392+ T.writeFile (target </> "default.nix") (thunkPtrLoader thunk)
394+ jsonFileName = case _thunkPtr_source thunk of
395+ ThunkSource_GitHub _ -> "github"
396+ ThunkSource_Git _ -> "git"
397+ LBS.writeFile (target </> jsonFileName <.> "json") (encodeThunkPtrData thunk)
429createThunkWithLatest :: MonadObelisk m => FilePath -> ThunkSource -> m ()
399createThunkWithLatest :: MonadObelisk m => FilePath -> ThunkSource -> m ()
430createThunkWithLatest target s = do
400createThunkWithLatest target s = do
431 rev <- getLatestRev s
401 rev <- getLatestRev s
432− createThunk target $ Right $ ThunkPtr
402+ createThunk target $ ThunkPtr
433 { _thunkPtr_source = s
403 { _thunkPtr_source = s
434 , _thunkPtr_rev = rev
404 , _thunkPtr_rev = rev
437−updateThunkToLatest :: MonadObelisk m => ThunkUpdateConfig -> FilePath -> m ()
407+updateThunkToLatest :: MonadObelisk m => FilePath -> m ()
438−updateThunkToLatest (ThunkUpdateConfig mBranch thunkConfig) target = spinner $ do
408+updateThunkToLatest target = withSpinner ("Updating thunk " <> T.pack target <> " to latest") $ do
439− checkThunkDirectory target
440− -- check to see if thunk should be updated to a specific branch or just update it's current branch
443− (overwrite, ptr) <- readThunk target >>= \case
409+ (overwrite, ptr) <- readThunk target >>= \case
444− Left err -> failWith [i|Thunk update: ${err}|]
410+ Left err -> failWith $ T.pack $ "thunk update: " <> show err
445− Right c -> case c of
411+ Right c -> case c of
446− ThunkData_Packed _ t -> return (target, t)
412+ ThunkData_Packed t -> return (target, t)
447− ThunkData_Checkout -> failWith "cannot update an unpacked thunk"
413+ ThunkData_Checkout _ -> failWith "cannot update an unpacked thunk"
448− let src = _thunkPtr_source ptr
414+ let src = _thunkPtr_source ptr
449− rev <- getLatestRev src
415+ rev <- getLatestRev src
450− overwriteThunk overwrite $ modifyThunkPtrByConfig thunkConfig $ ThunkPtr
416+ overwriteThunk overwrite $ ThunkPtr
451− { _thunkPtr_source = src
417+ { _thunkPtr_source = src
452− , _thunkPtr_rev = rev
418+ , _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.
421-- | 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.
422-- This tool will only ever produce the newest one when it writes a thunk.
470−gitHubThunkSpecs :: NonEmpty ThunkSpec
423+gitHubStandaloneLoaders :: NonEmpty Text
471−gitHubThunkSpecs =
424+gitHubStandaloneLoaders =
472− gitHubThunkSpecV5 :|
425+ gitHubStandaloneLoaderV2 :|
473− [ gitHubThunkSpecV4
426+ [ gitHubStandaloneLoaderV3
474− , gitHubThunkSpecV3
427+ , gitHubStandaloneLoaderV1
479−gitHubThunkSpecV1 :: ThunkSpec
430+gitHubStandaloneLoaderV1 :: Text
480−gitHubThunkSpecV1 = legacyGitHubThunkSpec "github-v1"
431+gitHubStandaloneLoaderV1 = T.unlines
481− "import ((import <nixpkgs> {}).fetchFromGitHub (builtins.fromJSON (builtins.readFile ./github.json)))"
432+ [ "import ((import <nixpkgs> {}).fetchFromGitHub (builtins.fromJSON (builtins.readFile ./github.json)))"
483−gitHubThunkSpecV2 :: ThunkSpec
435+gitHubStandaloneLoaderV2 :: Text
484−gitHubThunkSpecV2 = legacyGitHubThunkSpec "github-v2" $ T.unlines
436+gitHubStandaloneLoaderV2 = T.unlines
485 [ "# DO NOT HAND-EDIT THIS FILE" --TODO: Add something about how to get more info on Obelisk, etc.
437 [ "# DO NOT HAND-EDIT THIS FILE" --TODO: Add something about how to get more info on Obelisk, etc.
486 , "import ((import <nixpkgs> {}).fetchFromGitHub ("
438 , "import ((import <nixpkgs> {}).fetchFromGitHub ("
487 , " let json = builtins.fromJSON (builtins.readFile ./github.json);"
439 , " let json = builtins.fromJSON (builtins.readFile ./github.json);"
@@ -491,8 +443,8 @@ gitHubThunkSpecV2 = legacyGitHubThunkSpec "github-v2" $ T.unlines
494−gitHubThunkSpecV3 :: ThunkSpec
446+gitHubStandaloneLoaderV3 :: Text
495−gitHubThunkSpecV3 = legacyGitHubThunkSpec "github-v3" $ T.unlines
447+gitHubStandaloneLoaderV3 = T.unlines
496 [ "# DO NOT HAND-EDIT THIS FILE"
448 [ "# DO NOT HAND-EDIT THIS FILE"
498 , " fetch = { private ? false, ... }@args: if private && builtins.hasAttr \"fetchGit\" builtins"
450 , " fetch = { private ? false, ... }@args: if private && builtins.hasAttr \"fetchGit\" builtins"
@@ -511,62 +463,22 @@ gitHubThunkSpecV3 = legacyGitHubThunkSpec "github-v3" $ T.unlines
511 , "in import (fetch (builtins.fromJSON (builtins.readFile ./github.json)))"
463 , "in import (fetch (builtins.fromJSON (builtins.readFile ./github.json)))"
514−gitHubThunkSpecV4 :: ThunkSpec
466+plainGitStandaloneLoaders :: NonEmpty Text
515−gitHubThunkSpecV4 = legacyGitHubThunkSpec "github-v4" $ T.unlines
467+plainGitStandaloneLoaders =
516− [ "# DO NOT HAND-EDIT THIS FILE"
468+ plainGitStandaloneLoaderV1 :|
517− , "let fetch = { private ? false, fetchSubmodules ? false, owner, repo, rev, sha256, ... }:"
469+ [ 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
472+plainGitStandaloneLoaderV1 :: Text
527−legacyGitHubThunkSpec name loader = ThunkSpec name $ Map.fromList
473+plainGitStandaloneLoaderV1 = T.unlines
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
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
562 [ "# DO NOT HAND-EDIT THIS FILE"
474 [ "# DO NOT HAND-EDIT THIS FILE"
563 , "let fetchGit = {url, rev, ref ? null, branch ? null, sha256 ? null, fetchSubmodules ? null}:"
475 , "let fetchGit = {url, rev, ref ? null, branch ? null, sha256 ? null, fetchSubmodules ? null}:"
564 , " assert !fetchSubmodules; (import <nixpkgs> {}).fetchgit { inherit url rev sha256; };"
476 , " assert !fetchSubmodules; (import <nixpkgs> {}).fetchgit { inherit url rev sha256; };"
565 , "in import (fetchGit (builtins.fromJSON (builtins.readFile ./git.json)))"
477 , "in import (fetchGit (builtins.fromJSON (builtins.readFile ./git.json)))"
568−gitThunkSpecV2 :: ThunkSpec
480+plainGitStandaloneLoaderV2 :: Text
569−gitThunkSpecV2 = legacyGitThunkSpec "git-v2" $ T.unlines
481+plainGitStandaloneLoaderV2 = T.unlines
570 [ "# DO NOT HAND-EDIT THIS FILE"
482 [ "# DO NOT HAND-EDIT THIS FILE"
571 , "let fetchGit = {url, rev, ref ? null, branch ? null, sha256 ? null, fetchSubmodules ? null}:"
483 , "let fetchGit = {url, rev, ref ? null, branch ? null, sha256 ? null, fetchSubmodules ? null}:"
572 , " if builtins.hasAttr \"fetchGit\" builtins"
484 , " if builtins.hasAttr \"fetchGit\" builtins"
@@ -575,87 +487,24 @@ gitThunkSpecV2 = legacyGitThunkSpec "git-v2" $ T.unlines
575 , "in import (fetchGit (builtins.fromJSON (builtins.readFile ./git.json)))"
487 , "in import (fetchGit (builtins.fromJSON (builtins.readFile ./git.json)))"
578−-- This loader has a bug because @builtins.fetchGit@ is not given a @ref@
490+thunkFileNames :: [FilePath]
579−-- and will fail to find commits without this because it does shallow clones.
491+thunkFileNames = ["default.nix", "github.json", "git.json"]
580−gitThunkSpecV3 :: ThunkSpec
492+
581−gitThunkSpecV3 = legacyGitThunkSpec "git-v3" $ T.unlines
493+-- | Look for authentication info from the 'hub' command
582− [ "# DO NOT HAND-EDIT THIS FILE"
494+getHubAuth
583− , "let fetch = {url, rev, ref ? null, sha256 ? null, fetchSubmodules ? false, private ? false, ...}:"
495+ :: Text -- ^ Domain name
584− , " let realUrl = let firstChar = builtins.substring 0 1 url; in"
496+ -> IO (Maybe Auth)
585− , " if firstChar == \"/\" then /. + url"
497+getHubAuth domain = do
586− , " else if firstChar == \".\" then ./. + url"
498+ hubConfig <- getXdgDirectory XdgConfig "hub"
587− , " else url;"
499+ Yaml.decodeFileEither hubConfig >>= \case
588− , " in if !fetchSubmodules && private then builtins.fetchGit {"
500+ Left _ -> return Nothing
589− , " url = realUrl; inherit rev;"
501+ Right v -> return $ flip parseMaybe v $ \v' -> do
590− , " } else (import <nixpkgs> {}).fetchgit {"
502+ Yaml.Array domainConfigs <- v' .: domain --TODO: Determine what multiple domainConfigs means
591− , " url = realUrl; inherit rev sha256;"
503+ [Yaml.Object domainConfig] <- return $ toList domainConfigs
592− , " };"
504+ token <- domainConfig .: "oauth_token"
593− , "in import (fetch (builtins.fromJSON (builtins.readFile ./git.json)))"
505+ return $ OAuth $ encodeUtf8 token
595−
507+--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
660-- | Checks a cache directory to see if there is a fresh symlink
509-- | Checks a cache directory to see if there is a fresh symlink
661-- to the result of building an attribute of a thunk.
510-- to the result of building an attribute of a thunk.
@@ -663,49 +512,44 @@ parseJsonObject p bytes = Aeson.parseEither p =<< Aeson.eitherDecode bytes
663-- and the result is symlinked into the cache.
512-- and the result is symlinked into the cache.
664nixBuildThunkAttrWithCache
513nixBuildThunkAttrWithCache
665 :: MonadObelisk m
514 :: MonadObelisk m
667− -> FilePath
515+ => FilePath
668 -- ^ Path to directory containing Thunk
516 -- ^ Path to directory containing Thunk
669 -> String
517 -> String
670 -- ^ Attribute to build
518 -- ^ Attribute to build
671− -> m (Maybe FilePath)
519+ -> m FilePath
672 -- ^ Symlink to cached or built nix output
520 -- ^ Symlink to cached or built nix output
673-- WARNING: If the thunk uses an impure reference such as '<nixpkgs>'
521-- WARNING: If the thunk uses an impure reference such as '<nixpkgs>'
674-- the caching mechanism will fail as it merely measures the modification
522-- the caching mechanism will fail as it merely measures the modification
675-- time of the cache link and the expression to build.
523-- time of the cache link and the expression to build.
676−nixBuildThunkAttrWithCache thunkSpec thunkDir attr = do
524+nixBuildThunkAttrWithCache thunkDir attr = do
525+ --NB: Expects thunkDir to be normalised with no trailing path separator.
526+ --This should be guaranteed by the command argument parser.
527+ let cacheErrHandler e
528+ | isDoesNotExistError e = return Nothing -- expected from a cache miss
529+ | otherwise = putLog Error (T.pack $ displayException e) >> return Nothing
530+ cacheDir = thunkDir </> ".attr-cache"
531+ cachePath = cacheDir </> attr <.> "out"
677 latestChange <- liftIO $ do
532 latestChange <- liftIO $ do
678− let
533+ createDirectoryIfMissing False cacheDir
679− getModificationTimeMaybe = fmap rightToMaybe . try @IOError . getModificationTime
534+ let getModificationTimeMaybe = fmap rightToMaybe . try @IOError . getModificationTime
680− thunkFileNames = Map.keys $ _thunkSpec_files thunkSpec
681− maximum . catMaybes <$> traverse (getModificationTimeMaybe . (thunkDir </>)) thunkFileNames
535+ maximum . catMaybes <$> mapM (getModificationTimeMaybe . (thunkDir </>)) thunkFileNames
683− let cachePaths' = nonEmpty $ Map.keys $ Map.filter (\case ThunkFileSpec_AttrCache -> True; _ -> False) $
684− _thunkSpec_files thunkSpec
685− for cachePaths' $ \cachePaths ->
686− fmap NonEmpty.head $ for cachePaths $ \cacheDir -> do
688− cachePath = thunkDir </> cacheDir </> attr <.> "out"
690− | isDoesNotExistError e = pure Nothing -- expected from a cache miss
691− | otherwise = Nothing <$ putLog Error (T.pack $ displayException e)
692− cacheHit <- handle cacheErrHandler $ do
536+ cacheHit <- handle cacheErrHandler $ do
693− cacheTime <- liftIO $ posixSecondsToUTCTime . realToFrac . modificationTime <$> getSymbolicLinkStatus cachePath
537+ cacheTime <- liftIO $ posixSecondsToUTCTime . realToFrac . modificationTime <$> getSymbolicLinkStatus cachePath
694− pure $ if latestChange <= cacheTime
538+ return $ if latestChange <= cacheTime
695− then Just cachePath
539+ then Just cachePath
696− else Nothing
540+ else Nothing
697− case cacheHit of
541+ case cacheHit of
698− Just c -> pure c
542+ Just c -> return c
699− Nothing -> do
543+ Nothing -> do
700− putLog Warning $ T.pack $ mconcat [thunkDir, ": ", attr, " not cached, building ..."]
544+ putLog Warning $ T.pack $ mconcat [thunkDir, ": ", attr, " not cached, building ..."]
701− liftIO $ createDirectoryIfMissing True (takeDirectory cachePath)
545+ _ <- nixBuild $ def
702− (cachePath <$) $ nixCmd $ NixCmd_Build $ def
546+ { _nixBuildConfig_target = Target
703− & nixBuildConfig_outLink .~ OutLink_IndirectRoot cachePath
704− & nixCmdConfig_target .~ Target
705− { _target_path = Just thunkDir
547+ { _target_path = thunkDir
706− , _target_attr = Just attr
548+ , _target_attr = Just attr
707− , _target_expr = Nothing
549+ }
550+ , _nixBuildConfig_outLink = OutLink_IndirectRoot cachePath
710-- | Build a nix attribute, and cache the result if possible
554-- | Build a nix attribute, and cache the result if possible
711nixBuildAttrWithCache
555nixBuildAttrWithCache
@@ -716,466 +560,221 @@ nixBuildAttrWithCache
716 -- ^ Attribute to build
560 -- ^ Attribute to build
717 -> m FilePath
561 -> m FilePath
718 -- ^ Symlink to cached or built nix output
562 -- ^ Symlink to cached or built nix output
719−nixBuildAttrWithCache exprPath attr = readThunk exprPath >>= \case
563+nixBuildAttrWithCache exprPath attr = do
564+ readThunk exprPath >>= \case
720− -- Only packed thunks are cached. In particular, checkouts are not.
565+ -- Only packed thunks are cached. in particular, checkouts are not
721− Right (ThunkData_Packed spec _) ->
722− maybe build pure =<< nixBuildThunkAttrWithCache spec exprPath attr
566+ Right (ThunkData_Packed _) -> nixBuildThunkAttrWithCache exprPath attr
723− _ -> build
567+ _ -> nixBuild $ def
724− where
568+ { _nixBuildConfig_target = Target
725− build = nixCmd $ NixCmd_Build $ def
726− & nixBuildConfig_outLink .~ OutLink_None
727− & nixCmdConfig_target .~ Target
728− { _target_path = Just exprPath
569+ { _target_path = exprPath
729 , _target_attr = Just attr
570 , _target_attr = Just attr
730− , _target_expr = Nothing
572+ , _nixBuildConfig_outLink = OutLink_None
733−-- | Safely update thunk using a custom action
575+unpackThunk
735−-- A temporary working space is used to do any update. When the custom
736−-- action successfully completes, the resulting (packed) thunk is copied
737−-- back to the original location.
738−updateThunk :: MonadObelisk m => FilePath -> (FilePath -> m a) -> m a
576+ :: MonadObelisk m
739−updateThunk p f = withSystemTempDirectory "obelisk-thunkptr-" $ \tmpDir -> do
577+ => FilePath
740− p' <- copyThunkToTmp tmpDir p
578+ -> m ()
741− unpackThunk' True p'
743− updateThunkFromTmp p'
746− copyThunkToTmp tmpDir thunkDir = readThunk thunkDir >>= \case
579+unpackThunk thunkDir = readThunk thunkDir >>= \case
747− Left err -> failWith $ "withThunkUnpacked: " <> T.pack (show err)
580+ Left err -> failWith $ "thunk unpack: " <> T.pack (show err)
748− Right ThunkData_Packed{} -> do
749− let tmpThunk = tmpDir </> "thunk"
750− callProcessAndLogOutput (Notice, Error) $
751− proc cp ["-r", "-T", thunkDir, tmpThunk]
753− Right _ -> failWith "Thunk is not packed"
754− updateThunkFromTmp p' = do
755− _ <- packThunk' True (ThunkPackConfig False (ThunkConfig Nothing)) p'
756− callProcessAndLogOutput (Notice, Error) $
757− proc cp ["-r", "-T", p', p]
759−finalMsg :: Bool -> (a -> Text) -> Maybe (a -> Text)
760−finalMsg noTrail s = if noTrail then Nothing else Just s
762−-- | Check that we are not somewhere inside the thunk directory
763−checkThunkDirectory :: MonadObelisk m => FilePath -> m ()
764−checkThunkDirectory thunkDir = do
765− currentDir <- liftIO getCurrentDirectory
766− thunkDir' <- liftIO $ canonicalizePath thunkDir
767− when (thunkDir' `L.isInfixOf` currentDir) $
768− failWith [i|Can't perform thunk operations from within the thunk directory: ${thunkDir}|]
770− -- Don't let thunk commands work when directly given an unpacked repo
771− when (takeFileName thunkDir == unpackedDirName) $
772− readThunk (takeDirectory thunkDir) >>= \case
773− Right _ -> failWith [i|Refusing to perform thunk operation on ${thunkDir} because it is a thunk's unpacked source|]
776−unpackThunk :: MonadObelisk m => FilePath -> m ()
777−unpackThunk = unpackThunk' False
779−unpackThunk' :: MonadObelisk m => Bool -> FilePath -> m ()
780−unpackThunk' noTrail thunkDir = checkThunkDirectory thunkDir *> readThunk thunkDir >>= \case
781− Left err -> failWith [i|Invalid thunk at ${thunkDir}: ${err}|]
782 --TODO: Overwrite option that rechecks out thunk; force option to do so even if working directory is dirty
581 --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|]
582+ Right (ThunkData_Checkout _) -> failWith "thunk unpack: thunk is already unpacked"
784− Right (ThunkData_Packed _ tptr) -> do
583+ Right (ThunkData_Packed tptr) -> do
785 let (thunkParent, thunkName) = splitFileName thunkDir
584 let (thunkParent, thunkName) = splitFileName thunkDir
786− withTempDirectory thunkParent thunkName $ \tmpThunk -> do
585+ withTempDirectory thunkParent thunkName $ \tmpRepo -> do
787− let
586+ let obGitDir = tmpRepo </> ".git" </> "obelisk"
788− gitSrc = thunkSourceToGitSource $ _thunkPtr_source tptr
789− newSpec = case _thunkPtr_source tptr of
587+ case _thunkPtr_source tptr of
790− ThunkSource_GitHub _ -> NonEmpty.head gitHubThunkSpecs
588+ ThunkSource_GitHub s -> do
589+ mauth <- liftIO $ getHubAuth "github.com"
590+ repoResult <- liftIO $ executeRequestMaybe mauth $ repositoryR (_gitHubSource_owner s) (_gitHubSource_repo s)
591+ githubURI <- either (liftIO . throwIO) (return . repoSshUrl) repoResult >>= \case
592+ Nothing -> failWith "Cannot determine clone URI for thunk source"
593+ Just c -> return $ T.unpack $ getUrl c
595+ withSpinner ("Retrieving thunk " <> T.pack thunkName <> " from GitHub") $ do
596+ callProcessAndLogOutput (Notice, Notice) $
597+ proc "hub" ["clone", "-n", githubURI, tmpRepo]
598+ --If this directory already exists then something is weird and we should fail
599+ liftIO $ createDirectory obGitDir
600+ callProcessAndLogOutput (Notice, Error) $
601+ proc "cp" ["-r", "-T", thunkDir </> ".", obGitDir </> "orig-thunk"]
603+ withSpinner ("Preparing thunk in " <> T.pack thunkDir) $ do
605+ putLog Notice $ "Checking out " <> T.pack (show $ maybe "" untagName $ _gitHubSource_branch s)
606+ callProcessAndLogOutput (Notice, Notice) $
610+ , maybe [] (\n -> ["-B", T.unpack (untagName n)]) (_gitHubSource_branch s)
611+ , pure $ Ref.toHexString $ _thunkRev_commit $ _thunkPtr_rev tptr
613+ -- Set upstream branch
614+ forM_ (_gitHubSource_branch s) $ \branch ->
615+ callProcessAndLogOutput (Notice, Error) $
616+ proc "hub" ["-C", tmpRepo, "branch", "-u", "origin/" <> T.unpack (untagName branch)]
617+ callProcessAndLogOutput (Notice, Error) $ proc "rm" ["-r", thunkDir]
618+ callProcessAndLogOutput (Notice, Error) $ proc "mv" ["-T", tmpRepo, thunkDir]
791− ThunkSource_Git _ -> NonEmpty.head gitThunkSpecs
620+ ThunkSource_Git s -> do
792− withSpinner' ("Fetching thunk " <> T.pack thunkName)
621+ withSpinner ("Retreiving thunk " <> T.pack thunkName <> " from Git repo") $ do
793− (finalMsg noTrail $ const $ "Fetched thunk " <> T.pack thunkName) $ do
622+ let git = callProcessAndLogOutput (Notice, Notice) . gitProc tmpRepo
794− let unpackedPath = tmpThunk </> unpackedDirName
623+ git ["clone", if _gitSource_fetchSubmodules s then "--recursive" else "", show (_gitSource_url s)]
795− gitCloneForThunkUnpack gitSrc (_thunkRev_commit $ _thunkPtr_rev tptr) unpackedPath
624+ git ["reset", "--hard", Ref.toHexString $ _thunkRev_commit $ _thunkPtr_rev tptr]
796−
625+ when (_gitSource_fetchSubmodules s) $
797− let normalizeMore = dropTrailingPathSeparator . normalise
626+ git ["submodule", "update", "--recursive", "--init"]
798− when (normalizeMore unpackedPath /= normalizeMore tmpThunk) $ -- Only write meta data if the checkout is not inplace
627+ git ["branch", "-u", "origin/" <> T.unpack (untagName $ _gitSource_branch s)]
799− createThunk tmpThunk $ Left newSpec
628+
800−
629+ withSpinner ("Preparing thunk in " <> T.pack thunkDir) $ do
801− liftIO $ do
630+ liftIO $ createDirectory obGitDir
802− removePathForcibly thunkDir
631+ callProcessAndLogOutput (Notice, Error) $
803− renameDirectory tmpThunk thunkDir
632+ proc "cp" ["-r", "-T", thunkDir </> ".", obGitDir </> "orig-thunk"]
804−
633+ callProcessAndLogOutput (Notice, Error) $
805−gitCloneForThunkUnpack
634+ proc "rm" ["-r", thunkDir]
635+ callProcessAndLogOutput (Notice, Error) $
636+ proc "mv" ["-T", tmpRepo, thunkDir]
638+--TODO: add force mode to pack even if changes are present
639+--TODO: add a rollback mode to pack to the original thunk
806 :: MonadObelisk m
641 :: MonadObelisk m
807− => GitSource -- ^ Git source to use
808− -> Ref hash -- ^ Commit hash to reset to
809− -> FilePath -- ^ Directory to clone into
642+ => FilePath
811−gitCloneForThunkUnpack gitSrc commit dir = do
645+packThunk thunkDir upstream = readThunk thunkDir >>= \case
812− let git = callProcessAndLogOutput (Notice, Notice) . gitProc dir
646+ Left err -> failWith $ T.pack $ "thunk pack: " <> show err
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"]
822−--TODO: add a rollback mode to pack to the original thunk
823−packThunk :: MonadObelisk m => ThunkPackConfig -> FilePath -> m ThunkPtr
824−packThunk = packThunk' False
826−packThunk' :: MonadObelisk m => Bool -> ThunkPackConfig -> FilePath -> m ThunkPtr
827−packThunk' noTrail (ThunkPackConfig force thunkConfig) thunkDir = checkThunkDirectory thunkDir *> readThunk thunkDir >>= \case
828− Right ThunkData_Packed{} -> failWith [i|Thunk at ${thunkDir} is is already packed|]
647+ Right (ThunkData_Packed _) -> failWith "pack: thunk is already packed"
829− _ -> withSpinner'
648+ Right (ThunkData_Checkout _) -> do
830− ("Packing thunk " <> T.pack thunkDir)
649+ withSpinner ("Packing thunk " <> T.pack thunkDir) $ do
831− (finalMsg noTrail $ const $ "Packed thunk " <> T.pack thunkDir) $
650+ thunkPtr <- getThunkPtr thunkDir upstream
832− do
651+ callProcessAndLogOutput (Debug, Error) $ proc "rm" ["-rf", thunkDir]
833− let checkClean = if force then CheckClean_NoCheck else CheckClean_FullCheck
834− thunkPtr <- modifyThunkPtrByConfig thunkConfig <$> getThunkPtr checkClean thunkDir (_thunkConfig_private thunkConfig)
835− liftIO $ removePathForcibly thunkDir
836− createThunk thunkDir $ Right thunkPtr
652+ liftIO $ createThunk thunkDir thunkPtr
838−
654+getThunkPtr :: MonadObelisk m => FilePath -> Text -> m ThunkPtr
839−modifyThunkPtrByConfig :: ThunkConfig -> ThunkPtr -> ThunkPtr
655+getThunkPtr = getThunkPtr' True
840−modifyThunkPtrByConfig (ThunkConfig markPrivate') ptr = case markPrivate' of
656+
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
657+getThunkPtr' :: MonadObelisk m => Bool -> FilePath -> Text -> m ThunkPtr
856−getThunkPtr gitCheckClean dir mPrivate = do
658+getThunkPtr' checkClean thunkDir upstream = do
857− let repoLocations = nubOrd $ map (first normalise)
659+ when checkClean $ checkGitCleanStatus thunkDir >>= \case
858− [(".git", "."), (unpackedDirName </> ".git", unpackedDirName)]
660+ False -> do
859− repoLocation' <- liftIO $ flip findM repoLocations $ doesDirectoryExist . (dir </>) . fst
661+ statusDebug <- readGitProcess thunkDir ["status", "--ignored"]
860− thunkDir <- case repoLocation' of
662+ putLog Warning "cannot proceed with unsaved working copy (git status):"
861− Nothing -> failWith [i|Can't find an unpacked thunk in ${dir}|]
663+ putLog Notice statusDebug
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"
664+ failWith "thunk pack: thunk checkout contains unsaved modifications"
870−
665+ True -> return ()
871− -- Check whether there are any stashes
667+ -- Check whether there are any stashes
872− when checkClean $ do
873 stashOutput <- readGitProcess thunkDir ["stash", "list"]
668 stashOutput <- readGitProcess thunkDir ["stash", "list"]
874− unless (T.null stashOutput) $
669+ when checkClean $ case T.null stashOutput of
875− failWith $ T.unlines $
670+ False -> do
876− [ "thunk pack: thunk checkout has stashes"
671+ failWith $ T.unlines $
877− , "git stash list:"
672+ [ "thunk pack: thunk checkout has stashes"
878− ] ++ T.lines stashOutput
673+ , "git stash list:"
879−
674+ ] ++ T.lines stashOutput
880− -- Get current branch
675+ True -> return ()
881− (mCurrentBranch, mCurrentCommit) <- do
676+
882− b <- listToMaybe . T.lines <$> readGitProcess thunkDir ["rev-parse", "--abbrev-ref", "HEAD"]
677+ --Check whether all local heads are pushed
883− c <- listToMaybe . T.lines <$> readGitProcess thunkDir ["rev-parse", "HEAD"]
678+ repoHeads <- T.lines <$> readGitProcess thunkDir ["for-each-ref", "--format=%(refname:short)", "refs/heads/"]
884− case b of
679+ remotes <- T.lines <$> readGitProcess thunkDir ["remote"]
885− (Just "HEAD") -> failWith $ T.unlines
680+ --Check that the upstream specified actually exists
886− [ "thunk pack: You are in 'detached HEAD' state."
681+ case L.find (== upstream) remotes of
887− , "If you want to pack at the current ref \
682+ Nothing -> failWith $ "thunk pack: upstream " <> upstream <> " does not exist. Available upstreams are " <> T.intercalate ", " remotes
888− \then please create a new branch with 'git checkout -b <new-branch-name>' and push this upstream."
683+ Just _ -> return ()
889− ]
684+ -- iterate over cartesian product
890− _ -> return (b, c)
685+ when checkClean $ forM_ repoHeads $ \hd -> do
891−
686+ [localRev] <- T.lines <$> readGitProcess thunkDir ["rev-parse", T.unpack hd]
892− -- Get information on all branches and their (optional) designated upstream
687+ forM_ remotes $ \rm -> do
893− -- correspondents
688+ --TODO: The error you get if a branch isn't pushed anywhere could be made more user friendly
894− headDump :: [Text] <- T.lines <$> readGitProcess thunkDir
689+ [remoteMergeRev] <- fmap T.lines $ readGitProcess thunkDir
895− [ "for-each-ref"
690+ ["merge-base", T.unpack localRev, "remotes/" <> T.unpack rm <> "/" <> T.unpack hd]
896− , "--format=%(refname:short) %(upstream:short) %(upstream:remotename)"
691+ case remoteMergeRev == localRev of
897− , "refs/heads/"
692+ False -> failWith $ mconcat [ "thunk unpack: branch ", hd, " has not been pushed to ", rm ]
898− ]
693+ True -> return ()
900− (headInfo :: Map Text (Maybe (Text, Text)))
695+ --We assume it's safe to pack the thunk at this point
901− <- fmap Map.fromList $ forM headDump $ \line -> do
696+ [remoteUri'] <- fmap T.lines $ readGitProcess thunkDir ["config", "--get", "remote." <> T.unpack upstream <> ".url"]
902− (branch : restOfLine) <- pure $ T.words line
697+
903− mUpstream <- case restOfLine of
698+ let uriParseFailure = "Could not identify git remote: " <> remoteUri'
904− [] -> pure Nothing
699+ mRemoteUri = parseGitUri remoteUri'
905− [u, r] -> pure $ Just (u, r)
700+ case mRemoteUri of
906− (_:_) -> failWith "git for-each-ref invalid output"
701+ Nothing -> failWith uriParseFailure
907− pure (branch, mUpstream)
702+ Just remoteUri -> do
908−
703+ refs <- fmap (map (refsToTuples . T.words) . T.lines) $ readGitProcess thunkDir ["show-ref", "--head"]
909− putLog Debug $ "branches: " <> T.pack (show headInfo)
704+ -- safe because exactly one hash is associated with HEAD
910−
705+ let Just currentHead = fst <$> L.find ((== "HEAD") . snd) refs
911− let errorMap :: Map Text ()
706+ remoteHeads = Map.fromList $ catMaybes $ fmap
912− headUpstream :: Map Text (Text, Text)
707+ (\(x,y) -> (,) x <$> T.stripPrefix ("refs/remotes/" <> upstream <> "/") y)
913− (errorMap, headUpstream) = flip Map.mapEither headInfo $ \case
708+ refs
914− Nothing -> Left ()
709+ localHeads = Map.fromList $ catMaybes $ fmap
915− Just b -> Right b
710+ (\(x,y) -> (,) x <$> T.stripPrefix "refs/heads/" y)
917− putLog Debug $ "branches with upstream branch set: " <> T.pack (show headUpstream)
712+ currentUpstreamBranch = Map.lookup currentHead remoteHeads
918−
713+ <|> Map.lookup currentHead localHeads
919− -- Check that every branch has a remote equivalent
714+ if isGithubThunk remoteUri
920− when checkClean $ do
715+ then githubThunkPtr remoteUri currentHead currentUpstreamBranch
921− let untrackedBranches = Map.keys errorMap
716+ else gitThunkPtr remoteUri currentHead currentUpstreamBranch
922− when (not $ L.null untrackedBranches) $ failWith $ T.unlines $
717+ where
923− [ "thunk pack: Certain branches in the thunk have no upstream branch \
718+ refsToTuples [x, y] = (x, y)
924− \set. This means we don't know to check whether all your work is \
719+ refsToTuples x = error $ "thunk pack: cannot parse ref " <> show x
925− \saved. The offending branches are:"
720+ isGithubThunk u
926− , ""
721+ | Just uriAuth <- uriAuthority u
927− , T.unwords untrackedBranches
722+ = case uriScheme u of
928− , ""
723+ "ssh:" -> uriAuth == URIAuth "git@" "github.com" ""
929− , "To fix this, you probably want to do:"
724+ s -> s `L.elem` [ "git:", "https:", "http:" ] -- "http:" just redirects to "https:"
930− , ""
725+ && uriRegName uriAuth == "github.com"
931− ] ++
726+ | otherwise = False
932− ((\branch -> "git push -u origin " <> branch) <$> untrackedBranches) ++
727+ githubThunkPtr u commit' branch' = do
933− [ ""
728+ ["/", owner', repo'] <- return $ splitDirectories (uriPath u)
934− , "These will push the branches to the default remote under the same \
729+ let owner = N (T.pack owner')
935− \name, and (thanks to the `-u`) remember that choice so you don't \
730+ dropGitExtension r = fromMaybe r $ T.stripSuffix ".git" r
936− \get this error again."
731+ repo = N $ dropGitExtension $ T.pack repo'
937− ]
732+ commit = N commit'
938−
733+ branch = N <$> branch'
939− -- loosely by https://stackoverflow.com/questions/7773939/show-git-ahead-and-behind-info-for-all-branches-including-remotes
734+ mauth <- liftIO $ getHubAuth "github.com"
940− stats <- ifor headUpstream $ \branch (upstream, _remote) -> do
735+ repoResult <- liftIO $ executeRequestMaybe mauth $ repositoryR owner repo
941− (stat :: [Text]) <- T.lines <$> readGitProcess thunkDir
736+ repoIsPrivate <- either (liftIO . throwIO) (return . repoPrivate) repoResult
942− [ "rev-list", "--left-right"
737+ archiveResult <- liftIO $ executeRequestMaybe mauth $
943− , T.unpack branch <> "..." <> T.unpack upstream
738+ archiveForR owner repo ArchiveFormatTarball (Just (untagName commit))
944− ]
739+ archiveUri <- either (liftIO . throwIO) return archiveResult
945− let ahead = length $ [ () | Just ('<', _) <- T.uncons <$> stat ]
740+ hash <- getNixSha256ForUriUnpacked archiveUri
946− behind = length $ [ () | Just ('>', _) <- T.uncons <$> stat ]
741+ return $ ThunkPtr
947− pure (upstream, (ahead, behind))
742+ { _thunkPtr_rev = ThunkRev
948−
743+ { _thunkRev_commit = commitNameToRef commit
949− -- Those branches which have commits ahead of, i.e. not on, the upstream
744+ , _thunkRev_nixSha256 = hash
950− -- branch. Purely being behind is fine.
951− let nonGood = Map.filter ((/= 0) . fst . snd) stats
953− when (not $ Map.null nonGood) $ failWith $ T.unlines $
954− [ "thunk pack: Certain branches in the thunk have commits not yet pushed upstream:"
957− flip map (Map.toList nonGood) (\(branch, (upstream, (ahead, behind))) -> mconcat
958− [" ", branch, " ahead: ", T.pack (show ahead), " behind: ", T.pack (show behind), " remote branch ", upstream]) ++
960− , "Please push these upstream and try again. (Or just fetch, if they are somehow \
961− \pushed but this repo's remote tracking branches don't know it.)"
964− when checkClean $ do
965− -- We assume it's safe to pack the thunk at this point
966− putLog Informational "All changes safe in git remotes. OK to pack thunk."
968− let remote = maybe "origin" snd $ flip Map.lookup headUpstream =<< mCurrentBranch
970− [remoteUri'] <- fmap T.lines $ readGitProcess thunkDir
973− , "remote." <> T.unpack remote <> ".url"
976− remoteUri <- case parseGitUri remoteUri' of
977− Nothing -> failWith $ "Could not identify git remote: " <> remoteUri'
978− Just uri -> pure uri
979− uriThunkPtr remoteUri mPrivate mCurrentBranch mCurrentCommit
981−-- | Get the latest revision available from the given source
982−getLatestRev :: MonadObelisk m => ThunkSource -> m ThunkRev
984− let gitS = thunkSourceToGitSource os
985− (_, commit) <- gitGetCommitBranch (_gitSource_url gitS) (untagName <$> _gitSource_branch gitS)
987− ThunkSource_GitHub s -> githubThunkRev s commit
988− ThunkSource_Git s -> gitThunkRev s commit
990−-- | Convert a URI to a thunk
992−-- If the URL is a github URL, we try to just download an archive for
993−-- 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
995−-- a regular git thunk.
996−uriThunkPtr :: MonadObelisk m => GitUri -> Maybe Bool -> Maybe Text -> Maybe Text -> m ThunkPtr
997−uriThunkPtr uri mPrivate mbranch mcommit = do
998− commit <- case mcommit of
999− Nothing -> gitGetCommitBranch uri mbranch >>= return . snd
1000− (Just c) -> return c
1001− (src, rev) <- uriToThunkSource uri mPrivate mbranch >>= \case
1002− ThunkSource_GitHub s -> do
1003− rev <- runExceptT $ githubThunkRev s commit
1005− Right r -> pure (ThunkSource_GitHub s, r)
1008−\Failed to fetch archive from GitHub. This is probably a private repo. \
1009−\Falling back on normal fetchgit. Original failure:"
1011− let s' = forgetGithub True s
1012− (,) (ThunkSource_Git s') <$> gitThunkRev s' commit
1013− ThunkSource_Git s -> (,) (ThunkSource_Git s) <$> gitThunkRev s commit
1015− { _thunkPtr_rev = rev
1016− , _thunkPtr_source = src
1019−-- | N.B. Cannot infer all fields.
1021−-- 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
1023−-- should be employed, and so we respect that.
1024−uriToThunkSource :: MonadObelisk m => GitUri -> Maybe Bool -> Maybe Text -> m ThunkSource
1025−uriToThunkSource (GitUri u) mPrivate
1026− | Right uriAuth <- URI.uriAuthority u
1027− , Just scheme <- URI.unRText <$> URI.uriScheme u
1029− "ssh" -> uriAuth == URI.Authority
1030− { URI.authUserInfo = Just $ URI.UserInfo (fromRight' $ URI.mkUsername "git") Nothing
1031− , URI.authHost = fromRight' $ URI.mkHost "github.com"
1032− , URI.authPort = Nothing
1034− s -> s `L.elem` [ "git", "https", "http" ] -- "http:" just redirects to "https:"
746+ , _thunkPtr_source = ThunkSource_GitHub $ GitHubSource
1035− && URI.unRText (URI.authHost uriAuth) == "github.com"
747+ { _gitHubSource_owner = owner
1036− , Just (_, owner :| [repoish]) <- URI.uriPath u
748+ , _gitHubSource_repo = repo
1037− = \mbranch -> do
749+ , _gitHubSource_branch = branch
1038− isPrivate <- getIsPrivate
750+ , _gitHubSource_private = repoIsPrivate
1039− pure $ ThunkSource_GitHub $ GitHubSource
1040− { _gitHubSource_owner = N $ URI.unRText owner
1041− , _gitHubSource_repo = N $ let
1042− repoish' = URI.unRText repoish
1043− in fromMaybe repoish' $ T.stripSuffix ".git" repoish'
1044− , _gitHubSource_branch = N <$> mbranch
1045− , _gitHubSource_private = isPrivate
1048− | otherwise = \mbranch -> do
753+ gitThunkPtr u commit branch' = do
1049− isPrivate <- getIsPrivate
754+ let protocols = ["https:", "ssh:", "git:"]
1050− pure $ ThunkSource_Git $ GitSource
755+ unless (T.toLower (T.pack $ uriScheme u) `elem` protocols) $
1051− { _gitSource_url = GitUri u
756+ failWith $ "thunk pack: obelisk currently only supports "
1052− , _gitSource_branch = N <$> mbranch
757+ <> T.intercalate ", " protocols <> " protocols for non-GitHub remotes"
758+ hash <- nixPrefetchGit u commit False
759+ branch <- case branch' of
760+ Nothing -> failWith "thunk pack: git thunks must track a branch"
761+ Just b -> pure $ N b
763+ { _thunkPtr_rev = ThunkRev
764+ { _thunkRev_commit = commitNameToRef (N commit)
765+ , _thunkRev_nixSha256 = hash
767+ , _thunkPtr_source = ThunkSource_Git $ GitSource
768+ { _gitSource_url = u
769+ , _gitSource_branch = branch
1053 , _gitSource_fetchSubmodules = False -- TODO: How do we determine if this should be true?
770 , _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.
774+parseGitUri :: Text -> Maybe URI
1086−githubThunkRev
775+parseGitUri x = parseURIReference (T.unpack x) <|> parseSshShorthand x
1092−githubThunkRev s commit = do
1093− owner <- forcePP $ _gitHubSource_owner s
1094− repo <- forcePP $ _gitHubSource_repo s
1095− revTarball <- URI.mkPathPiece $ commit <> ".tar.gz"
1096− let archiveUri = GitUri $ URI.URI
1097− { URI.uriScheme = Just $ fromRight' $ URI.mkScheme "https"
1098− , URI.uriAuthority = Right $ URI.Authority
1099− { URI.authUserInfo = Nothing
1100− , URI.authHost = fromRight' $ URI.mkHost "github.com"
1101− , URI.authPort = Nothing
1103− , URI.uriPath = Just ( False
1104− , owner :| [ repo, fromRight' $ URI.mkPathPiece "archive", revTarball ]
1106− , URI.uriQuery = []
1107− , URI.uriFragment = Nothing
1109− hash <- getNixSha256ForUriUnpacked archiveUri
1110− putLog Debug $ "Nix sha256 is " <> hash
1112− { _thunkRev_commit = commitNameToRef $ N commit
1113− , _thunkRev_nixSha256 = hash
1116− forcePP :: Name entity -> m (URI.RText 'URI.PathPiece)
1117− forcePP = URI.mkPathPiece . untagName
1119−gitThunkRev
777+parseSshShorthand :: Text -> Maybe URI
1124−gitThunkRev s commit = do
1125− let u = _gitSource_url s
1126− protocols = ["file", "https", "ssh", "git"]
1127− scheme = maybe "file" URI.unRText $ URI.uriScheme $ (\(GitUri x) -> x) u
1128− unless (T.toLower scheme `elem` protocols) $
1129− failWith $ "obelisk currently only supports "
1130− <> T.intercalate ", " protocols <> " protocols for plain Git remotes"
1131− hash <- nixPrefetchGit u commit $ _gitSource_fetchSubmodules s
1132− putLog Informational $ "Nix sha256 is " <> hash
1134− { _thunkRev_commit = commitNameToRef (N commit)
1135− , _thunkRev_nixSha256 = hash
1138−-- | Given the URI to a git remote, and an optional branch name, return the name
1139−-- of the branch along with the hash of the commit at tip of that branch.
1141−-- If the branch name is passed in, it is returned exactly as-is. If it is not
1142−-- passed it, the default branch of the repo is used instead.
1145− :: MonadObelisk m => GitUri -> Maybe Text -> m (Text, CommitId)
1146−gitGetCommitBranch uri mbranch = withExitFailMessage ("Failure for git remote " <> uriMsg) $ do
1147− (_, bothMaps) <- gitLsRemote
1148− (T.unpack $ gitUriToText uri)
1149− (GitRef_Branch <$> mbranch)
1151− branch <- case mbranch of
1152− Nothing -> withExitFailMessage "Failed to find default branch" $ do
1153− b <- rethrowE $ gitLookupDefaultBranch bothMaps
1154− putLog Debug $ "Default branch for remote repo " <> uriMsg <> " is " <> b
1157− commit <- rethrowE $ gitLookupCommitForRef bothMaps (GitRef_Branch branch)
1158− putLog Informational $ "Latest commit in branch " <> branch
1159− <> " from remote repo " <> uriMsg
1160− <> " is " <> commit
1161− pure (branch, commit)
1163− rethrowE = either failWith pure
1164− uriMsg = gitUriToText uri
1166−parseGitUri :: Text -> Maybe GitUri
1167−parseGitUri x = GitUri <$> (parseFileURI x <|> parseAbsoluteURI x <|> parseSshShorthand x)
1169−parseFileURI :: Text -> Maybe URI.URI
1170−parseFileURI uri = if "/" `T.isPrefixOf` uri then parseAbsoluteURI ("file://" <> uri) else Nothing
1172−parseAbsoluteURI :: Text -> Maybe URI.URI
1173−parseAbsoluteURI uri = do
1174− parsedUri <- URI.mkURI uri
1175− guard $ URI.isPathAbsolute parsedUri
1178−parseSshShorthand :: Text -> Maybe URI.URI
1179parseSshShorthand uri = do
778parseSshShorthand uri = do
1180 -- This is what git does to check that the remote
779 -- This is what git does to check that the remote
1181 -- is not a local file path when parsing shorthand.
780 -- is not a local file path when parsing shorthand.
@@ -1188,4 +787,8 @@ parseSshShorthand uri = do
1188 -- This check is used to disambiguate a filepath containing a colon from shorthand
787 -- This check is used to disambiguate a filepath containing a colon from shorthand
1189 guard $ isNothing (T.findIndex (=='/') authAndHostname)
788 guard $ isNothing (T.findIndex (=='/') authAndHostname)
1190 && not (T.null colonAndPath)
789 && not (T.null colonAndPath)
1191− URI.mkURI properUri
790+ parseURI $ T.unpack properUri
793+readGitProcess :: MonadObelisk m => FilePath -> [String] -> m Text
794+readGitProcess repo = fmap T.pack . readProcessAndLogStderr Notice . gitProc repo