@@ -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
32import Control.Applicative
13import Control.Applicative
33−import Control.Exception (displayException, throwIO, try)
14+import Control.Exception (displayException, try)
15+import Control.Lens (ifor, ifor_, (.~))
34import Control.Monad
16import Control.Monad
35−import Control.Monad.Catch (handle)
17+import Control.Monad.Extra (findM)
18+import Control.Monad.Catch (MonadCatch, handle)
36import Control.Monad.Except
19import Control.Monad.Except
37import Data.Aeson ((.=))
20import Data.Aeson ((.=))
38import qualified Data.Aeson as Aeson
21import qualified Data.Aeson as Aeson
39import Data.Aeson.Encode.Pretty
22import Data.Aeson.Encode.Pretty
40import qualified Data.Aeson.Types as Aeson
23import qualified Data.Aeson.Types as Aeson
24+import Data.Bifunctor (first)
41import qualified Data.ByteString.Lazy as LBS
25import qualified Data.ByteString.Lazy as LBS
42−import qualified Data.ByteString.Lazy.Char8 as LBSC
26+import Data.Containers.ListUtils (nubOrd)
43import Data.Default
27import Data.Default
44−import Data.Either.Combinators (rightToMaybe)
28+import Data.Either.Combinators (fromRight', rightToMaybe)
45−import Data.Foldable
29+import Data.Foldable (toList)
30+import Data.Function ((&))
31+import Data.Functor ((<&>))
46import Data.Git.Ref (Ref)
32import Data.Git.Ref (Ref)
47import qualified Data.Git.Ref as Ref
33import qualified Data.Git.Ref as Ref
48import qualified Data.List as L
34import qualified Data.List as L
49−import Data.List.NonEmpty (NonEmpty (..))
35+import Data.List.NonEmpty (NonEmpty (..), nonEmpty)
50import qualified Data.List.NonEmpty as NonEmpty
36import qualified Data.List.NonEmpty as NonEmpty
51import qualified Data.Map as Map
38import qualified Data.Map as Map
52import Data.Maybe
39import Data.Maybe
53import Data.Set (Set)
40import Data.Set (Set)
54import 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)
55import Data.Text (Text)
44import Data.Text (Text)
56import qualified Data.Text as T
45import qualified Data.Text as T
57import Data.Text.Encoding
46import Data.Text.Encoding
58import qualified Data.Text.IO as T
47import qualified Data.Text.IO as T
59import Data.Time.Clock.POSIX (posixSecondsToUTCTime)
48import Data.Time.Clock.POSIX (posixSecondsToUTCTime)
60−import Data.Yaml (parseMaybe, (.:))
49+import Data.Traversable (for)
61−import qualified Data.Yaml as Yaml
50+import Data.Yaml (parseMaybe)
62import GitHub
51import GitHub
63import GitHub.Data.Name
52import GitHub.Data.Name
64−import GitHub.Endpoints.Repos.Contents (archiveForR)
66import Obelisk.Command.Nix
53import Obelisk.Command.Nix
67import System.Directory
54import System.Directory
68import System.FilePath
56import System.FilePath
69import System.IO.Error
57import System.IO.Error
70import System.IO.Temp
58import System.IO.Temp
71−import System.Posix (getSymbolicLinkStatus, modificationTime)
59+import System.PosixCompat.Files (getSymbolicLinkStatus, modificationTime)
72−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,6 +94,11 @@ 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
@@ -116,182 +107,208 @@ data GitHubSource = GitHubSource
117 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
119data GitSource = GitSource
119data GitSource = GitSource
120− { _gitSource_url :: URI
120+ { _gitSource_url :: GitUri
121− , _gitSource_branch :: Name Branch
121+ , _gitSource_branch :: Maybe (Name Branch)
122 , _gitSource_fetchSubmodules :: Bool
122 , _gitSource_fetchSubmodules :: Bool
123+ , _gitSource_private :: Bool
124 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
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
126getThunkGitBranch :: ThunkPtr -> Maybe Text
165getThunkGitBranch :: ThunkPtr -> Maybe Text
127getThunkGitBranch (ThunkPtr _ src) = fmap untagName $ case src of
166getThunkGitBranch (ThunkPtr _ src) = fmap untagName $ case src of
128 ThunkSource_GitHub s -> _gitHubSource_branch s
167 ThunkSource_GitHub s -> _gitHubSource_branch s
129− ThunkSource_Git s -> Just $ _gitSource_branch s
168+ ThunkSource_Git s -> _gitSource_branch s
131−commitNameToRef :: Name Commit -> Ref
170+commitNameToRef :: Name Commit -> Ref Ref.SHA1
132commitNameToRef (N c) = Ref.fromHex $ encodeUtf8 c
171commitNameToRef (N c) = Ref.fromHex $ encodeUtf8 c
134-- TODO: Use spinner here.
173-- TODO: Use spinner here.
135−getNixSha256ForUriUnpacked :: MonadObelisk m => URI -> m NixSha256
174+getNixSha256ForUriUnpacked
136getNixSha256ForUriUnpacked uri =
178getNixSha256ForUriUnpacked uri =
137− withExitFailMessage ("nix-prefetch-url: Failed to determine sha256 hash of URL " <> T.pack (show uri)) $ do
179+ withExitFailMessage ("nix-prefetch-url: Failed to determine sha256 hash of URL " <> gitUriToText uri) $ do
138− fmap T.pack $ withNixRemoteCheck $ readProcessAndLogStderr Debug $
180+ [hash] <- fmap T.lines $ readProcessAndLogOutput (Debug, Debug) $
139− proc "nix-prefetch-url" ["--unpack" , "--type" , "sha256" , show uri]
181+ proc nixPrefetchUrlPath ["--unpack", "--type", "sha256", T.unpack $ gitUriToText uri]
141−nixPrefetchGit :: MonadObelisk m => URI -> Text -> Bool -> m NixSha256
184+nixPrefetchGit :: MonadObelisk m => GitUri -> Text -> Bool -> m NixSha256
142nixPrefetchGit uri rev fetchSubmodules =
185nixPrefetchGit uri rev fetchSubmodules =
143− withExitFailMessage ("nix-prefetch-git: Failed to determine sha256 hash of Git repo " <> T.pack (show uri) <> " at " <> rev) $ do
186+ withExitFailMessage ("nix-prefetch-git: Failed to determine sha256 hash of Git repo " <> gitUriToText uri <> " at " <> rev) $ do
144− out <- withNixRemoteCheck $ readProcessAndLogStderr Debug $
187+ out <- readProcessAndLogStderr Debug $
145− proc "nix-prefetch-git" $ filter (/="")
188+ proc nixPrefetchGitPath $ filter (/="")
146− [ "--url", show uri
189+ [ "--url", T.unpack $ gitUriToText uri
147 , "--rev", T.unpack rev
190 , "--rev", T.unpack rev
148 , if fetchSubmodules then "--fetch-submodules" else ""
191 , if fetchSubmodules then "--fetch-submodules" else ""
149 , "--quiet"
192 , "--quiet"
152− case parseMaybe (Aeson..: "sha256") =<< Aeson.decode (LBSC.pack out) of
195+ case parseMaybe (Aeson..: "sha256") =<< Aeson.decodeStrict (encodeUtf8 out) of
153− Nothing -> failWith $ "nix-prefetch-git: unrecognized output " <> T.pack out
196+ Nothing -> failWith $ "nix-prefetch-git: unrecognized output " <> out
154 Just x -> pure x
197 Just x -> pure x
156−getLatestGitRev :: MonadObelisk m => GitSource -> m ThunkRev
157−getLatestGitRev s = withSystemTempDirectory "git-clone" $ \tmpDir -> do
158− withExitFailMessage ("Unable to determine latest git revision for branch " <> branch) $ do
159− let git = fmap T.pack . readProcessAndLogStderr Debug . gitProc tmpDir
161− (git ["clone", "--no-checkout", show $ _gitSource_url s]) -- Might be able to use --bare here instead to go faster.
162− (git ["log", T.unpack branch, "--max-count=1", "--format=%H"])
164− case T.strip <$> safeLast (T.lines out) of
165− Nothing -> failWith $ "Unable to parse git log: " <> out
167− putLog Debug $ "Latest commit in " <> branch <> " is " <> rev
168− sha <- nixPrefetchGit (_gitSource_url s) rev (_gitSource_fetchSubmodules s)
169− putLog Debug $ "Nix sha256 is " <> sha
171− { _thunkRev_commit = Ref.fromHexString $ T.unpack rev
172− , _thunkRev_nixSha256 = sha
175− remote :: Text = "origin"
176− branch :: Text = remote <> "/" <> untagName (_gitSource_branch s)
178− safeLast [] = Nothing
179− safeLast xs = Just $ last xs
181−-- | Get the latest revision available from the given source
182−getLatestRev :: MonadObelisk m => ThunkSource -> m ThunkRev
184− ThunkSource_GitHub s -> do
185− auth <- liftIO $ getHubAuth "github.com"
186− commitsResult <- liftIO $ executeRequestMaybe auth $ commitsWithOptionsForR
187− (_gitHubSource_owner s)
188− (_gitHubSource_repo s)
190− $ case _gitHubSource_branch s of
192− Just b -> [CommitQuerySha $ untagName b]
193− commitInfos <- either (liftIO . throwIO) return commitsResult
194− commitInfo : _ <- return $ toList commitInfos
195− let commit = commitSha commitInfo
196− putLog Debug $ "Latest commit is " <> untagName commit
197− Right archiveUri <- liftIO $ executeRequestMaybe auth $ archiveForR (_gitHubSource_owner s) (_gitHubSource_repo s) ArchiveFormatTarball $ Just $ untagName commit
198− nixSha256 <- getNixSha256ForUriUnpacked archiveUri
199− putLog Debug $ "Nix sha256 is " <> nixSha256
201− { _thunkRev_commit = commitNameToRef commit
202− , _thunkRev_nixSha256 = nixSha256
204− ThunkSource_Git s -> getLatestGitRev s
206--TODO: Pretty print these
199--TODO: Pretty print these
207data ReadThunkError
200data ReadThunkError
208− = ReadThunkError_UnrecognizedFiles
201+ = ReadThunkError_UnrecognizedThunk
209− | ReadThunkError_AmbiguousFiles
202+ | ReadThunkError_UnrecognizedPaths (NonEmpty FilePath)
210− | ReadThunkError_UnrecognizedLoader Text
203+ | ReadThunkError_MissingPaths (NonEmpty FilePath)
211− | ReadThunkError_UnparseablePtr LBS.ByteString
204+ | ReadThunkError_UnparseablePtr FilePath String
212− deriving (Show)
205+ | ReadThunkError_FileError IOError
213−
206+ | ReadThunkError_FileDoesNotMatch FilePath Text
214−-- | Read a thunk and validate that it is only a thunk, either packed or unpacked.
207+ | ReadThunkError_UnrecognizedState String
215−-- If the thunk is packed and additional data is present, fail.
208+ | ReadThunkError_AmbiguousPackedState ThunkPtr ThunkPtr
216−readThunk :: MonadObelisk m => FilePath -> m (Either ReadThunkError ThunkData)
209+ deriving (Show)
217−readThunk thunkDir = do
210+
218− files <- liftIO $ listDirectory thunkDir
211+unpackedDirName :: FilePath
219− case ".git" `elem` files of
212+unpackedDirName = "."
220− True -> fmap ThunkData_Checkout <$> do
213+
221− let origThunkPath = thunkDir </> ".git" </> "obelisk" </> "orig-thunk"
214+attrCacheFileName :: FilePath
222− liftIO $ doesDirectoryExist origThunkPath >>= \case
215+attrCacheFileName = ".attr-cache"
223− True -> fmap Just <$> readPackedThunk origThunkPath
216+
224− False -> return $ return Nothing
217+-- | Specification for how a file in a thunk version works.
225− False -> liftIO $ fmap ThunkData_Packed <$> readPackedThunk thunkDir
218+data ThunkFileSpec
226−
219+ = ThunkFileSpec_Ptr (LBS.ByteString -> Either String ThunkPtr) -- ^ This file specifies 'ThunkPtr' data
227−data ThunkType = ThunkType
220+ | ThunkFileSpec_FileMatches Text -- ^ This file must match the given content exactly
228− { _thunkType_loader :: FilePath
221+ | ThunkFileSpec_CheckoutIndicator -- ^ Existence of this directory indicates that the thunk is unpacked
229− , _thunkType_json :: FilePath
222+ | ThunkFileSpec_AttrCache -- ^ This directory is an attribute cache
230− , _thunkType_optional :: Set FilePath
223+
231− , _thunkType_loaderVersions :: NonEmpty Text
224+-- | Specification for how a set of files in a thunk version work.
232− , _thunkType_parser :: Aeson.Object -> Aeson.Parser ThunkPtr
225+data ThunkSpec = ThunkSpec
226+ { _thunkSpec_name :: !Text
227+ , _thunkSpec_files :: !(Map FilePath ThunkFileSpec)
235−gitHubThunkType :: ThunkType
230+thunkSpecTypes :: NonEmpty (NonEmpty ThunkSpec)
236−gitHubThunkType = ThunkType
231+thunkSpecTypes = gitThunkSpecs :| [gitHubThunkSpecs]
237− { _thunkType_loader = "default.nix"
232+
238− , _thunkType_json = "github.json"
233+-- | Attempts to match a 'ThunkSpec' to a given directory.
239− , _thunkType_optional = Set.fromList [".attr-cache"]
234+matchThunkSpecToDir
240− , _thunkType_loaderVersions = gitHubStandaloneLoaders
235+ :: (MonadError ReadThunkError m, MonadIO m, MonadCatch m)
241− , _thunkType_parser = parseThunkPtr $ \v ->
236+ => ThunkSpec -- ^ 'ThunkSpec' to match against the given files/directory
242− ThunkSource_GitHub <$> parseGitHubSource v <|> ThunkSource_Git <$> parseGitSource v
237+ -> FilePath -- ^ Path to directory
243− }
238+ -> Set FilePath -- ^ Set of file paths relative to the given directory
245−gitThunkType :: ThunkType
240+matchThunkSpecToDir thunkSpec dir dirFiles = do
246−gitThunkType = ThunkType
241+ case nonEmpty (toList $ dirFiles `Set.difference` expectedPaths) of
247− { _thunkType_loader = "default.nix"
242+ Just fs -> throwError $ ReadThunkError_UnrecognizedPaths $ (dir </>) <$> fs
248− , _thunkType_json = "git.json"
243+ Nothing -> pure ()
249− , _thunkType_optional = Set.fromList [".attr-cache"]
244+ case nonEmpty (toList $ requiredPaths `Set.difference` dirFiles) of
250− , _thunkType_loaderVersions = plainGitStandaloneLoaders
245+ Just fs -> throwError $ ReadThunkError_MissingPaths $ (dir </>) <$> fs
251− , _thunkType_parser = parseThunkPtr $ fmap ThunkSource_Git . parseGitSource
246+ Nothing -> pure ()
252− }
247+ datas <- fmap toList $ flip Map.traverseMaybeWithKey (_thunkSpec_files thunkSpec) $ \expectedPath -> \case
253−
248+ ThunkFileSpec_AttrCache -> Nothing <$ dirMayExist expectedPath
254−thunkTypes :: [ThunkType]
249+ ThunkFileSpec_CheckoutIndicator -> liftIO (doesDirectoryExist (dir </> expectedPath)) <&> \case
255−thunkTypes = [gitThunkType, gitHubThunkType]
250+ False -> Nothing
256−
251+ True -> Just ThunkData_Checkout
257−findThunkType :: [ThunkType] -> FilePath -> IO (Either ReadThunkError ThunkType)
252+ ThunkFileSpec_FileMatches expectedContents -> handle (\(e :: IOError) -> throwError $ ReadThunkError_FileError e) $ do
258−findThunkType types thunkDir = do
253+ actualContents <- liftIO (T.readFile $ dir </> expectedPath)
259− matches <- fmap catMaybes $ forM types $ \thunkType -> do
254+ case T.strip expectedContents == T.strip actualContents of
260− let
255+ True -> pure Nothing
261− expectedContents = Set.fromList $ (thunkDir </>) <$>
256+ False -> throwError $ ReadThunkError_FileDoesNotMatch (dir </> expectedPath) expectedContents
262− [ _thunkType_loader thunkType
257+ ThunkFileSpec_Ptr parser -> handle (\(e :: IOError) -> throwError $ ReadThunkError_FileError e) $ do
263− , _thunkType_json thunkType
258+ let path = dir </> expectedPath
264− ]
259+ liftIO (doesFileExist path) >>= \case
265− optionalContents = Set.map (thunkDir </>) (_thunkType_optional thunkType)
260+ False -> pure Nothing
267− -- Ensure that there aren't any other files in the thunk
262+ actualContents <- liftIO $ LBS.readFile path
268− -- NB: System.Directory.listDirectory returns the contents without the directory path
263+ case parser actualContents of
269− files <- liftIO $ Set.fromList . fmap (thunkDir </>) <$> listDirectory thunkDir
264+ Right v -> pure $ Just (ThunkData_Packed thunkSpec v)
270− let unexpectedContents = files `Set.difference` (expectedContents `Set.union` optionalContents)
265+ Left e -> throwError $ ReadThunkError_UnparseablePtr (dir </> expectedPath) e
271− missingContents = expectedContents `Set.difference` files
266+
272− pure $ if Set.null unexpectedContents && Set.null missingContents
267+ case nonEmpty datas of
273− then Just thunkType
268+ Nothing -> throwError ReadThunkError_UnrecognizedThunk
274− else Nothing
269+ Just xs -> fold1WithM xs $ \a b -> either throwError pure (mergeThunkData a b)
276− pure $ case matches of
271+ rootPathsOnly = Set.fromList . mapMaybe takeRootDir . Map.keys
277− [singleMatch] -> Right singleMatch
272+ takeRootDir = fmap NonEmpty.head . nonEmpty . splitPath
278− [] -> Left ReadThunkError_UnrecognizedFiles
273+
279− _ -> 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}|]
281-- | 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.
282-- If additional data is present, fail.
309-- If additional data is present, fail.
283−readPackedThunk :: FilePath -> IO (Either ReadThunkError ThunkPtr)
310+readThunk :: (MonadObelisk m) => FilePath -> m (Either ReadThunkError ThunkData)
284−readPackedThunk thunkDir = runExceptT $ do
311+readThunk = readThunkWith thunkSpecTypes
285− thunkType <- ExceptT $ findThunkType thunkTypes thunkDir
286− -- Ensure that we recognize the thunk loader
287− loader <- liftIO $ T.readFile $ thunkDir </> _thunkType_loader thunkType
288− unless (loader `elem` _thunkType_loaderVersions thunkType) $ do
289− throwError $ ReadThunkError_UnrecognizedLoader loader
291− txt <- liftIO $ LBS.readFile $ thunkDir </> _thunkType_json thunkType
292− case parseMaybe (_thunkType_parser thunkType) =<< Aeson.decode txt of
293− Nothing -> throwError $ ReadThunkError_UnparseablePtr txt
294− Just ptr -> return ptr
296parseThunkPtr :: (Aeson.Object -> Aeson.Parser ThunkSource) -> Aeson.Object -> Aeson.Parser ThunkPtr
313parseThunkPtr :: (Aeson.Object -> Aeson.Parser ThunkSource) -> Aeson.Object -> Aeson.Parser ThunkPtr
297parseThunkPtr parseSrc v = do
314parseThunkPtr parseSrc v = do
@@ -311,38 +328,42 @@ parseGitHubSource v = do
311 owner <- v Aeson..: "owner"
328 owner <- v Aeson..: "owner"
312 repo <- v Aeson..: "repo"
329 repo <- v Aeson..: "repo"
313 branch <- v Aeson..:! "branch"
330 branch <- v Aeson..:! "branch"
314− mPrivate <- v Aeson..:! "private"
331+ private <- v Aeson..:? "private"
315 pure $ GitHubSource
332 pure $ GitHubSource
316 { _gitHubSource_owner = owner
333 { _gitHubSource_owner = owner
317 , _gitHubSource_repo = repo
334 , _gitHubSource_repo = repo
318 , _gitHubSource_branch = branch
335 , _gitHubSource_branch = branch
319− , _gitHubSource_private = fromMaybe False mPrivate
336+ , _gitHubSource_private = fromMaybe False private
322parseGitSource :: Aeson.Object -> Aeson.Parser GitSource
339parseGitSource :: Aeson.Object -> Aeson.Parser GitSource
323parseGitSource v = do
340parseGitSource v = do
324 Just url <- parseGitUri <$> v Aeson..: "url"
341 Just url <- parseGitUri <$> v Aeson..: "url"
325− branch <- v Aeson..: "branch"
342+ branch <- v Aeson..:! "branch"
326 fetchSubmodules <- v Aeson..:! "fetchSubmodules"
343 fetchSubmodules <- v Aeson..:! "fetchSubmodules"
344+ private <- v Aeson..:? "private"
327 pure $ GitSource
345 pure $ GitSource
328 { _gitSource_url = url
346 { _gitSource_url = url
329 , _gitSource_branch = branch
347 , _gitSource_branch = branch
330 , _gitSource_fetchSubmodules = fromMaybe False fetchSubmodules
348 , _gitSource_fetchSubmodules = fromMaybe False fetchSubmodules
349+ , _gitSource_private = fromMaybe False private
333overwriteThunk :: MonadObelisk m => FilePath -> ThunkPtr -> m ()
352overwriteThunk :: MonadObelisk m => FilePath -> ThunkPtr -> m ()
334overwriteThunk target thunk = do
353overwriteThunk target thunk = do
335 -- 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)
336− Right _ <- readThunk target
355+ readThunk target >>= \case
356+ Left e -> failWith [i|Invalid thunk at ${target}: ${e}|]
338 --TODO: Is there a safer way to do this overwriting?
359 --TODO: Is there a safer way to do this overwriting?
339− liftIO $ removeDirectoryRecursive target
360+ liftIO $ removePathForcibly target
340− liftIO $ createThunk target thunk
361+ createThunk target $ Right thunk
342−thunkPtrLoader :: ThunkPtr -> Text
363+thunkPtrToSpec :: ThunkPtr -> ThunkSpec
343−thunkPtrLoader thunk = case _thunkPtr_source thunk of
364+thunkPtrToSpec thunk = case _thunkPtr_source thunk of
344− ThunkSource_GitHub _ -> NonEmpty.head gitHubStandaloneLoaders
365+ ThunkSource_GitHub _ -> NonEmpty.head gitHubThunkSpecs
345− ThunkSource_Git _ -> NonEmpty.head plainGitStandaloneLoaders
366+ ThunkSource_Git _ -> NonEmpty.head gitThunkSpecs
347-- It's important that formatting be very consistent here, because
368-- It's important that formatting be very consistent here, because
348-- otherwise when people update thunks, their patches will be messy
369-- otherwise when people update thunks, their patches will be messy
@@ -351,22 +372,18 @@ encodeThunkPtrData (ThunkPtr rev src) = case src of
351 ThunkSource_GitHub s -> encodePretty' githubCfg $ Aeson.object $ catMaybes
372 ThunkSource_GitHub s -> encodePretty' githubCfg $ Aeson.object $ catMaybes
352 [ Just $ "owner" .= _gitHubSource_owner s
373 [ Just $ "owner" .= _gitHubSource_owner s
353 , Just $ "repo" .= _gitHubSource_repo s
374 , Just $ "repo" .= _gitHubSource_repo s
354− , case _gitHubSource_branch s of
375+ , ("branch" .=) <$> _gitHubSource_branch s
355− Just b -> Just $ "branch" .= b
357− , if _gitHubSource_private s
358− then Just $ "private" .= True
360 , Just $ "rev" .= Ref.toHexString (_thunkRev_commit rev)
376 , Just $ "rev" .= Ref.toHexString (_thunkRev_commit rev)
361 , Just $ "sha256" .= _thunkRev_nixSha256 rev
377 , Just $ "sha256" .= _thunkRev_nixSha256 rev
378+ , Just $ "private" .= _gitHubSource_private s
363 ThunkSource_Git s -> encodePretty' plainGitCfg $ Aeson.object $ catMaybes
380 ThunkSource_Git s -> encodePretty' plainGitCfg $ Aeson.object $ catMaybes
364− --TODO: Is this safe? read/show is jank for `URI`
381+ [ Just $ "url" .= gitUriToText (_gitSource_url s)
365− [ Just $ "url" .= show (_gitSource_url s)
366 , Just $ "rev" .= Ref.toHexString (_thunkRev_commit rev)
382 , Just $ "rev" .= Ref.toHexString (_thunkRev_commit rev)
367− , Just $ "branch" .= _gitSource_branch s
383+ , ("branch" .=) <$> _gitSource_branch s
368 , Just $ "sha256" .= _thunkRev_nixSha256 rev
384 , Just $ "sha256" .= _thunkRev_nixSha256 rev
369 , Just $ "fetchSubmodules" .= _gitSource_fetchSubmodules s
385 , Just $ "fetchSubmodules" .= _gitSource_fetchSubmodules s
386+ , Just $ "private" .= _gitSource_private s
372 githubCfg = defConfig
389 githubCfg = defConfig
@@ -387,59 +404,84 @@ encodeThunkPtrData (ThunkPtr rev src) = case src of
389 , "sha256"
406 , "sha256"
390 , "fetchSubmodules"
408 , "fetchSubmodules"
391 ] <> compare
409 ] <> compare
392 , confTrailingNewline = True
410 , confTrailingNewline = True
395−createThunk :: MonadIO m => FilePath -> ThunkPtr -> m ()
413+createThunk :: MonadObelisk m => FilePath -> Either ThunkSpec ThunkPtr -> m ()
396−createThunk target thunk = liftIO $ do
414+createThunk target ptrInfo =
397− createDirectoryIfMissing True (target </> ".attr-cache")
415+ ifor_ (_thunkSpec_files spec) $ \path -> \case
398− T.writeFile (target </> "default.nix") (thunkPtrLoader thunk)
416+ ThunkFileSpec_FileMatches content -> withReadyPath path $ \p -> liftIO $ T.writeFile p content
399− let
417+ ThunkFileSpec_Ptr _ -> case ptrInfo of
400− jsonFileName = case _thunkPtr_source thunk of
418+ Left _ -> pure () -- We can't write the ptr without it
401− ThunkSource_GitHub _ -> "github"
419+ Right ptr -> withReadyPath path $ \p -> liftIO $ LBS.writeFile p (encodeThunkPtrData ptr)
402− ThunkSource_Git _ -> "git"
420+ _ -> pure ()
403− 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
405createThunkWithLatest :: MonadObelisk m => FilePath -> ThunkSource -> m ()
429createThunkWithLatest :: MonadObelisk m => FilePath -> ThunkSource -> m ()
406createThunkWithLatest target s = do
430createThunkWithLatest target s = do
407 rev <- getLatestRev s
431 rev <- getLatestRev s
408− createThunk target $ ThunkPtr
432+ createThunk target $ Right $ ThunkPtr
409 { _thunkPtr_source = s
433 { _thunkPtr_source = s
410 , _thunkPtr_rev = rev
434 , _thunkPtr_rev = rev
413−updateThunkToLatest :: MonadObelisk m => FilePath -> m ()
437+updateThunkToLatest :: MonadObelisk m => ThunkUpdateConfig -> FilePath -> m ()
414−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
415− (overwrite, ptr) <- readThunk target >>= \case
439+ checkThunkDirectory target
416− 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
417− Right c -> case c of
441+ case mBranch of
418− ThunkData_Packed t -> return (target, t)
442+ Nothing -> do
419− ThunkData_Checkout _ -> failWith "cannot update an unpacked thunk"
443+ (overwrite, ptr) <- readThunk target >>= \case
420− let src = _thunkPtr_source ptr
444+ Left err -> failWith [i|Thunk update: ${err}|]
421− rev <- getLatestRev src
445+ Right c -> case c of
422− overwriteThunk overwrite $ ThunkPtr
446+ ThunkData_Packed _ t -> return (target, t)
423− { _thunkPtr_source = src
447+ ThunkData_Checkout -> failWith "cannot update an unpacked thunk"
424− , _thunkPtr_rev = rev
448+ let src = _thunkPtr_source ptr
425− }
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
427-- | All recognized github standalone loaders, ordered from newest to oldest.
468-- | All recognized github standalone loaders, ordered from newest to oldest.
428-- 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.
429−gitHubStandaloneLoaders :: NonEmpty Text
470+gitHubThunkSpecs :: NonEmpty ThunkSpec
430−gitHubStandaloneLoaders =
471+gitHubThunkSpecs =
431− gitHubStandaloneLoaderV2 :|
472+ gitHubThunkSpecV5 :|
432− [ gitHubStandaloneLoaderV3
473+ [ gitHubThunkSpecV4
433− , gitHubStandaloneLoaderV1
474+ , gitHubThunkSpecV3
436−gitHubStandaloneLoaderV1 :: Text
479+gitHubThunkSpecV1 :: ThunkSpec
437−gitHubStandaloneLoaderV1 = T.unlines
480+gitHubThunkSpecV1 = legacyGitHubThunkSpec "github-v1"
438− [ "import ((import <nixpkgs> {}).fetchFromGitHub (builtins.fromJSON (builtins.readFile ./github.json)))"
481+ "import ((import <nixpkgs> {}).fetchFromGitHub (builtins.fromJSON (builtins.readFile ./github.json)))"
441−gitHubStandaloneLoaderV2 :: Text
483+gitHubThunkSpecV2 :: ThunkSpec
442−gitHubStandaloneLoaderV2 = T.unlines
484+gitHubThunkSpecV2 = legacyGitHubThunkSpec "github-v2" $ T.unlines
443 [ "# 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.
444 , "import ((import <nixpkgs> {}).fetchFromGitHub ("
486 , "import ((import <nixpkgs> {}).fetchFromGitHub ("
445 , " let json = builtins.fromJSON (builtins.readFile ./github.json);"
487 , " let json = builtins.fromJSON (builtins.readFile ./github.json);"
@@ -449,8 +491,8 @@ gitHubStandaloneLoaderV2 = T.unlines
452−gitHubStandaloneLoaderV3 :: Text
494+gitHubThunkSpecV3 :: ThunkSpec
453−gitHubStandaloneLoaderV3 = T.unlines
495+gitHubThunkSpecV3 = legacyGitHubThunkSpec "github-v3" $ T.unlines
454 [ "# DO NOT HAND-EDIT THIS FILE"
496 [ "# DO NOT HAND-EDIT THIS FILE"
456 , " fetch = { private ? false, ... }@args: if private && builtins.hasAttr \"fetchGit\" builtins"
498 , " fetch = { private ? false, ... }@args: if private && builtins.hasAttr \"fetchGit\" builtins"
@@ -469,22 +511,62 @@ gitHubStandaloneLoaderV3 = T.unlines
469 , "in import (fetch (builtins.fromJSON (builtins.readFile ./github.json)))"
511 , "in import (fetch (builtins.fromJSON (builtins.readFile ./github.json)))"
472−plainGitStandaloneLoaders :: NonEmpty Text
514+gitHubThunkSpecV4 :: ThunkSpec
473−plainGitStandaloneLoaders =
515+gitHubThunkSpecV4 = legacyGitHubThunkSpec "github-v4" $ T.unlines
474− plainGitStandaloneLoaderV1 :|
516+ [ "# DO NOT HAND-EDIT THIS FILE"
475− [ 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)))"
478−plainGitStandaloneLoaderV1 :: Text
526+legacyGitHubThunkSpec :: Text -> Text -> ThunkSpec
479−plainGitStandaloneLoaderV1 = T.unlines
527+legacyGitHubThunkSpec name loader = ThunkSpec name $ Map.fromList
528+ [ ("default.nix", ThunkFileSpec_FileMatches $ T.strip loader)
529+ , ("github.json" , ThunkFileSpec_Ptr parseGitHubJsonBytes)
530+ , (attrCacheFileName, ThunkFileSpec_AttrCache)
531+ , (".git", ThunkFileSpec_CheckoutIndicator)
534+gitHubThunkSpecV5 :: ThunkSpec
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
480 [ "# DO NOT HAND-EDIT THIS FILE"
562 [ "# DO NOT HAND-EDIT THIS FILE"
481 , "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}:"
482 , " assert !fetchSubmodules; (import <nixpkgs> {}).fetchgit { inherit url rev sha256; };"
564 , " assert !fetchSubmodules; (import <nixpkgs> {}).fetchgit { inherit url rev sha256; };"
483 , "in import (fetchGit (builtins.fromJSON (builtins.readFile ./git.json)))"
565 , "in import (fetchGit (builtins.fromJSON (builtins.readFile ./git.json)))"
486−plainGitStandaloneLoaderV2 :: Text
568+gitThunkSpecV2 :: ThunkSpec
487−plainGitStandaloneLoaderV2 = T.unlines
569+gitThunkSpecV2 = legacyGitThunkSpec "git-v2" $ T.unlines
488 [ "# DO NOT HAND-EDIT THIS FILE"
570 [ "# DO NOT HAND-EDIT THIS FILE"
489 , "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}:"
490 , " if builtins.hasAttr \"fetchGit\" builtins"
572 , " if builtins.hasAttr \"fetchGit\" builtins"
@@ -493,24 +575,87 @@ plainGitStandaloneLoaderV2 = T.unlines
493 , "in import (fetchGit (builtins.fromJSON (builtins.readFile ./git.json)))"
575 , "in import (fetchGit (builtins.fromJSON (builtins.readFile ./git.json)))"
496−thunkFileNames :: [FilePath]
578+-- This loader has a bug because @builtins.fetchGit@ is not given a @ref@
497−thunkFileNames = ["default.nix", "github.json", "git.json"]
579+-- and will fail to find commits without this because it does shallow clones.
498−
580+gitThunkSpecV3 :: ThunkSpec
499−-- | Look for authentication info from the 'hub' command
581+gitThunkSpecV3 = legacyGitThunkSpec "git-v3" $ T.unlines
500−getHubAuth
582+ [ "# DO NOT HAND-EDIT THIS FILE"
501− :: Text -- ^ Domain name
583+ , "let fetch = {url, rev, ref ? null, sha256 ? null, fetchSubmodules ? false, private ? false, ...}:"
502− -> IO (Maybe Auth)
584+ , " let realUrl = let firstChar = builtins.substring 0 1 url; in"
503−getHubAuth domain = do
585+ , " if firstChar == \"/\" then /. + url"
504− hubConfig <- getXdgDirectory XdgConfig "hub"
586+ , " else if firstChar == \".\" then ./. + url"
505− Yaml.decodeFileEither hubConfig >>= \case
587+ , " else url;"
506− Left _ -> return Nothing
588+ , " in if !fetchSubmodules && private then builtins.fetchGit {"
507− Right v -> return $ flip parseMaybe v $ \v' -> do
589+ , " url = realUrl; inherit rev;"
508− Yaml.Array domainConfigs <- v' .: domain --TODO: Determine what multiple domainConfigs means
590+ , " } else (import <nixpkgs> {}).fetchgit {"
509− [Yaml.Object domainConfig] <- return $ toList domainConfigs
591+ , " url = realUrl; inherit rev sha256;"
510− token <- domainConfig .: "oauth_token"
592+ , " };"
511− return $ OAuth $ encodeUtf8 token
593+ , "in import (fetch (builtins.fromJSON (builtins.readFile ./git.json)))"
513−--TODO: when checking something out, make a shallow clone
595+
596+gitThunkSpecV4 :: ThunkSpec
597+gitThunkSpecV4 = legacyGitThunkSpec "git-v4" $ T.unlines
598+ [ "# DO NOT HAND-EDIT THIS FILE"
599+ , "let fetch = {url, rev, branch ? null, sha256 ? null, fetchSubmodules ? false, private ? false, ...}:"
600+ , " let realUrl = let firstChar = builtins.substring 0 1 url; in"
601+ , " if firstChar == \"/\" then /. + url"
602+ , " else if firstChar == \".\" then ./. + url"
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
515-- | 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
516-- to the result of building an attribute of a thunk.
661-- to the result of building an attribute of a thunk.
@@ -518,44 +663,49 @@ getHubAuth domain = do
518-- and the result is symlinked into the cache.
663-- and the result is symlinked into the cache.
519nixBuildThunkAttrWithCache
664nixBuildThunkAttrWithCache
520 :: MonadObelisk m
665 :: MonadObelisk m
521− => FilePath
666+ => ThunkSpec
522 -- ^ Path to directory containing Thunk
668 -- ^ Path to directory containing Thunk
523 -> String
669 -> String
524 -- ^ Attribute to build
670 -- ^ Attribute to build
525− -> m FilePath
671+ -> m (Maybe FilePath)
526 -- ^ Symlink to cached or built nix output
672 -- ^ Symlink to cached or built nix output
527-- WARNING: If the thunk uses an impure reference such as '<nixpkgs>'
673-- WARNING: If the thunk uses an impure reference such as '<nixpkgs>'
528-- the caching mechanism will fail as it merely measures the modification
674-- the caching mechanism will fail as it merely measures the modification
529-- time of the cache link and the expression to build.
675-- time of the cache link and the expression to build.
530−nixBuildThunkAttrWithCache thunkDir attr = do
676+nixBuildThunkAttrWithCache thunkSpec thunkDir attr = do
531− --NB: Expects thunkDir to be normalised with no trailing path separator.
532− --This should be guaranteed by the command argument parser.
533− let cacheErrHandler e
534− | isDoesNotExistError e = return Nothing -- expected from a cache miss
535− | otherwise = putLog Error (T.pack $ displayException e) >> return Nothing
536− cacheDir = thunkDir </> ".attr-cache"
537− cachePath = cacheDir </> attr <.> "out"
538 latestChange <- liftIO $ do
677 latestChange <- liftIO $ do
539− createDirectoryIfMissing False cacheDir
678+ let
540− let getModificationTimeMaybe = fmap rightToMaybe . try @IOError . getModificationTime
679+ getModificationTimeMaybe = fmap rightToMaybe . try @IOError . getModificationTime
541− maximum . catMaybes <$> mapM (getModificationTimeMaybe . (thunkDir </>)) thunkFileNames
680+ thunkFileNames = Map.keys $ _thunkSpec_files thunkSpec
542− cacheHit <- handle cacheErrHandler $ do
681+ maximum . catMaybes <$> traverse (getModificationTimeMaybe . (thunkDir </>)) thunkFileNames
543− cacheTime <- liftIO $ posixSecondsToUTCTime . realToFrac . modificationTime <$> getSymbolicLinkStatus cachePath
682+
544− return $ if latestChange <= cacheTime
683+ let cachePaths' = nonEmpty $ Map.keys $ Map.filter (\case ThunkFileSpec_AttrCache -> True; _ -> False) $
545− then Just cachePath
684+ _thunkSpec_files thunkSpec
546− else Nothing
685+ for cachePaths' $ \cachePaths ->
547− case cacheHit of
686+ fmap NonEmpty.head $ for cachePaths $ \cacheDir -> do
548− Just c -> return c
687+ let
549− Nothing -> do
688+ cachePath = thunkDir </> cacheDir </> attr <.> "out"
550− putLog Warning $ T.pack $ mconcat [thunkDir, ": ", attr, " not cached, building ..."]
689+ cacheErrHandler e
551− _ <- nixBuild $ def
690+ | isDoesNotExistError e = pure Nothing -- expected from a cache miss
552− { _nixBuildConfig_target = Target
691+ | otherwise = Nothing <$ putLog Error (T.pack $ displayException e)
553− { _target_path = thunkDir
692+ cacheHit <- handle cacheErrHandler $ do
554− , _target_attr = Just attr
693+ cacheTime <- liftIO $ posixSecondsToUTCTime . realToFrac . modificationTime <$> getSymbolicLinkStatus cachePath
555− }
694+ pure $ if latestChange <= cacheTime
556− , _nixBuildConfig_outLink = OutLink_IndirectRoot cachePath
695+ then Just cachePath
558− 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
560-- | Build a nix attribute, and cache the result if possible
710-- | Build a nix attribute, and cache the result if possible
561nixBuildAttrWithCache
711nixBuildAttrWithCache
@@ -566,17 +716,19 @@ nixBuildAttrWithCache
566 -- ^ Attribute to build
716 -- ^ Attribute to build
567 -> m FilePath
717 -> m FilePath
568 -- ^ Symlink to cached or built nix output
718 -- ^ Symlink to cached or built nix output
569−nixBuildAttrWithCache exprPath attr = do
719+nixBuildAttrWithCache exprPath attr = readThunk exprPath >>= \case
570− readThunk exprPath >>= \case
720+ -- Only packed thunks are cached. In particular, checkouts are not.
571− -- Only packed thunks are cached. in particular, checkouts are not
721+ Right (ThunkData_Packed spec _) ->
572− Right (ThunkData_Packed _) -> nixBuildThunkAttrWithCache exprPath attr
722+ maybe build pure =<< nixBuildThunkAttrWithCache spec exprPath attr
573− _ -> nixBuild $ def
723+ _ -> build
574− { _nixBuildConfig_target = Target
724+ where
575− { _target_path = exprPath
725+ build = nixCmd $ NixCmd_Build $ def
726+ & nixBuildConfig_outLink .~ OutLink_None
727+ & nixCmdConfig_target .~ Target
728+ { _target_path = Just exprPath
576 , _target_attr = Just attr
729 , _target_attr = Just attr
730+ , _target_expr = Nothing
578− , _nixBuildConfig_outLink = OutLink_None
581-- | Safely update thunk using a custom action
733-- | Safely update thunk using a custom action
@@ -588,223 +740,442 @@ updateThunk p f = withSystemTempDirectory "obelisk-thunkptr-" $ \tmpDir -> do
588 p' <- copyThunkToTmp tmpDir p
740 p' <- copyThunkToTmp tmpDir p
589 unpackThunk' True p'
741 unpackThunk' True p'
590 result <- f p'
742 result <- f p'
591− updateThunkFromTmp p' "origin" -- TODO: stop hardcoding remote
743+ updateThunkFromTmp p'
592 return result
744 return result
594 copyThunkToTmp tmpDir thunkDir = readThunk thunkDir >>= \case
746 copyThunkToTmp tmpDir thunkDir = readThunk thunkDir >>= \case
595 Left err -> failWith $ "withThunkUnpacked: " <> T.pack (show err)
747 Left err -> failWith $ "withThunkUnpacked: " <> T.pack (show err)
596− Right (ThunkData_Packed _) -> do
748+ Right ThunkData_Packed{} -> do
597 let tmpThunk = tmpDir </> "thunk"
749 let tmpThunk = tmpDir </> "thunk"
598 callProcessAndLogOutput (Notice, Error) $
750 callProcessAndLogOutput (Notice, Error) $
599− proc "cp" ["-r", "-T", thunkDir, tmpThunk]
751+ proc cp ["-r", "-T", thunkDir, tmpThunk]
600 return tmpThunk
752 return tmpThunk
601− Right _ -> failWith $ "Thunk is not packed"
753+ Right _ -> failWith "Thunk is not packed"
602− updateThunkFromTmp p' remote = do
754+ updateThunkFromTmp p' = do
603− packThunk' True p' remote
755+ _ <- packThunk' True (ThunkPackConfig False (ThunkConfig Nothing)) p'
604 callProcessAndLogOutput (Notice, Error) $
756 callProcessAndLogOutput (Notice, Error) $
605− proc "cp" ["-r", "-T", p', p]
757+ proc cp ["-r", "-T", p', p]
607finalMsg :: Bool -> (a -> Text) -> Maybe (a -> Text)
759finalMsg :: Bool -> (a -> Text) -> Maybe (a -> Text)
608finalMsg 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|]
610unpackThunk :: MonadObelisk m => FilePath -> m ()
776unpackThunk :: MonadObelisk m => FilePath -> m ()
611unpackThunk = unpackThunk' False
777unpackThunk = unpackThunk' False
613unpackThunk' :: MonadObelisk m => Bool -> FilePath -> m ()
779unpackThunk' :: MonadObelisk m => Bool -> FilePath -> m ()
614−unpackThunk' noTrail thunkDir = readThunk thunkDir >>= \case
780+unpackThunk' noTrail thunkDir = checkThunkDirectory thunkDir *> readThunk thunkDir >>= \case
615− Left err -> failWith $ "thunk unpack: " <> T.pack (show err)
781+ Left err -> failWith [i|Invalid thunk at ${thunkDir}: ${err}|]
616 --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
617− Right (ThunkData_Checkout _) -> failWith "thunk unpack: thunk is already unpacked"
783+ Right ThunkData_Checkout -> failWith [i|Thunk at ${thunkDir} is already unpacked|]
618− Right (ThunkData_Packed tptr) -> do
784+ Right (ThunkData_Packed _ tptr) -> do
619 let (thunkParent, thunkName) = splitFileName thunkDir
785 let (thunkParent, thunkName) = splitFileName thunkDir
620− withTempDirectory thunkParent thunkName $ \tmpRepo -> do
786+ withTempDirectory thunkParent thunkName $ \tmpThunk -> do
621− let obGitDir = tmpRepo </> ".git" </> "obelisk"
787+ let
622− case _thunkPtr_source tptr of
788+ gitSrc = thunkSourceToGitSource $ _thunkPtr_source tptr
623− ThunkSource_GitHub s -> do
789+ newSpec = case _thunkPtr_source tptr of
624− mauth <- liftIO $ getHubAuth "github.com"
790+ ThunkSource_GitHub _ -> NonEmpty.head gitHubThunkSpecs
625− repoResult <- liftIO $ executeRequestMaybe mauth $ repositoryR (_gitHubSource_owner s) (_gitHubSource_repo s)
791+ ThunkSource_Git _ -> NonEmpty.head gitThunkSpecs
626− githubURI <- either (liftIO . throwIO) (return . repoSshUrl) repoResult >>= \case
792+ withSpinner' ("Fetching thunk " <> T.pack thunkName)
627− Nothing -> failWith "Cannot determine clone URI for thunk source"
793+ (finalMsg noTrail $ const $ "Fetched thunk " <> T.pack thunkName) $ do
628− Just c -> return $ T.unpack $ getUrl c
794+ let unpackedPath = tmpThunk </> unpackedDirName
629−
795+ gitCloneForThunkUnpack gitSrc (_thunkRev_commit $ _thunkPtr_rev tptr) unpackedPath
630− withSpinner' ("Fetching thunk " <> T.pack thunkDir)
796+
631− ( finalMsg noTrail $ const $ "Fetched thunk " <> T.pack thunkDir) $ do
797+ let normalizeMore = dropTrailingPathSeparator . normalise
632− callProcessAndLogOutput (Debug, Debug) $
798+ when (normalizeMore unpackedPath /= normalizeMore tmpThunk) $ -- Only write meta data if the checkout is not inplace
633− proc "hub" ["clone", "-n", githubURI, tmpRepo]
799+ createThunk tmpThunk $ Left newSpec
634− --If this directory already exists then something is weird and we should fail
800+
635− liftIO $ createDirectory obGitDir
801+ liftIO $ do
636− callProcessAndLogOutput (Debug, Error) $
802+ removePathForcibly thunkDir
637− proc "cp" ["-r", "-T", thunkDir </> ".", obGitDir </> "orig-thunk"]
803+ renameDirectory tmpThunk thunkDir
639− -- Checkout
805+gitCloneForThunkUnpack
640− putLog Debug $ "Checking out " <> T.pack (show $ maybe "" untagName $ _gitHubSource_branch s)
806+ :: MonadObelisk m
641− callProcessAndLogOutput (Debug, Debug) $
807+ => GitSource -- ^ Git source to use
642− proc "hub" $ concat
808+ -> Ref hash -- ^ Commit hash to reset to
643− [ ["-C", tmpRepo]
809+ -> FilePath -- ^ Directory to clone into
644− , pure "checkout"
810+ -> m ()
645− , maybe [] (\n -> ["-B", T.unpack (untagName n)]) (_gitHubSource_branch s)
811+gitCloneForThunkUnpack gitSrc commit dir = do
646− , pure $ Ref.toHexString $ _thunkRev_commit $ _thunkPtr_rev tptr
812+ let git = callProcessAndLogOutput (Notice, Notice) . gitProc dir
647− ]
813+ git $ [ "clone" ]
648− -- Set upstream branch
814+ ++ ["--recursive" | _gitSource_fetchSubmodules gitSrc]
649− forM_ (_gitHubSource_branch s) $ \branch ->
815+ ++ [ T.unpack $ gitUriToText $ _gitSource_url gitSrc ]
650− callProcessAndLogOutput (Debug, Error) $
816+ ++ do branch <- maybeToList $ _gitSource_branch gitSrc
651− proc "hub" ["-C", tmpRepo, "branch", "-u", "origin/" <> T.unpack (untagName branch)]
817+ [ "--branch", T.unpack $ untagName branch ]
652− callProcessAndLogOutput (Notice, Error) $ proc "rm" ["-r", thunkDir]
818+ git ["reset", "--hard", Ref.toHexString commit]
653− callProcessAndLogOutput (Notice, Error) $ proc "mv" ["-T", tmpRepo, thunkDir]
819+ when (_gitSource_fetchSubmodules gitSrc) $
654−
820+ git ["submodule", "update", "--recursive", "--init"]
655− ThunkSource_Git s -> do
821+
656− withSpinner' ("Fetching thunk " <> T.pack thunkName)
657− (finalMsg noTrail $ const $ "Fetched thunk " <> T.pack thunkName) $ do
658− let git = callProcessAndLogOutput (Notice, Notice) . gitProc tmpRepo
659− git ["clone", if _gitSource_fetchSubmodules s then "--recursive" else "", show (_gitSource_url s)]
660− git ["reset", "--hard", Ref.toHexString $ _thunkRev_commit $ _thunkPtr_rev tptr]
661− when (_gitSource_fetchSubmodules s) $
662− git ["submodule", "update", "--recursive", "--init"]
663− git ["branch", "-u", "origin/" <> T.unpack (untagName $ _gitSource_branch s)]
665− liftIO $ createDirectory obGitDir
666− callProcessAndLogOutput (Notice, Error) $
667− proc "cp" ["-r", "-T", thunkDir </> ".", obGitDir </> "orig-thunk"]
668− callProcessAndLogOutput (Notice, Error) $
669− proc "rm" ["-r", thunkDir]
670− callProcessAndLogOutput (Notice, Error) $
671− proc "mv" ["-T", tmpRepo, thunkDir]
673−--TODO: add force mode to pack even if changes are present
674--TODO: add a rollback mode to pack to the original thunk
822--TODO: add a rollback mode to pack to the original thunk
675−packThunk :: MonadObelisk m => FilePath -> Text -> m ()
823+packThunk :: MonadObelisk m => ThunkPackConfig -> FilePath -> m ThunkPtr
676packThunk = packThunk' False
824packThunk = packThunk' False
678−packThunk' :: MonadObelisk m => Bool -> FilePath -> Text -> m ()
826+packThunk' :: MonadObelisk m => Bool -> ThunkPackConfig -> FilePath -> m ThunkPtr
679−packThunk' noTrail thunkDir upstream = readThunk thunkDir >>= \case
827+packThunk' noTrail (ThunkPackConfig force thunkConfig) thunkDir = checkThunkDirectory thunkDir *> readThunk thunkDir >>= \case
680− Left err -> failWith $ T.pack $ "thunk pack: " <> show err
828+ Right ThunkData_Packed{} -> failWith [i|Thunk at ${thunkDir} is is already packed|]
681− Right (ThunkData_Packed _) -> failWith "pack: thunk is already packed"
829+ _ -> withSpinner'
682− Right (ThunkData_Checkout _) -> do
830+ ("Packing thunk " <> T.pack thunkDir)
683− withSpinner' ("Packing thunk " <> T.pack thunkDir)
831+ (finalMsg noTrail $ const $ "Packed thunk " <> T.pack thunkDir) $
684− (finalMsg noTrail $ const $ "Packed thunk " <> T.pack thunkDir) $ do
832+ do
685− thunkPtr <- getThunkPtr thunkDir upstream
833+ let checkClean = if force then CheckClean_NoCheck else CheckClean_FullCheck
686− callProcessAndLogOutput (Debug, Error) $ proc "rm" ["-rf", thunkDir]
834+ thunkPtr <- modifyThunkPtrByConfig thunkConfig <$> getThunkPtr checkClean thunkDir (_thunkConfig_private thunkConfig)
687− liftIO $ createThunk thunkDir thunkPtr
835+ liftIO $ removePathForcibly thunkDir
688−
836+ createThunk thunkDir $ Right thunkPtr
689−getThunkPtr :: MonadObelisk m => FilePath -> Text -> m ThunkPtr
837+ pure thunkPtr
690−getThunkPtr = getThunkPtr' True
838+
691−
839+modifyThunkPtrByConfig :: ThunkConfig -> ThunkPtr -> ThunkPtr
692−getThunkPtr' :: MonadObelisk m => Bool -> FilePath -> Text -> m ThunkPtr
840+modifyThunkPtrByConfig (ThunkConfig markPrivate') ptr = case markPrivate' of
693−getThunkPtr' checkClean thunkDir upstream = do
841+ Nothing -> ptr
694− when checkClean $ ensureCleanGitRepo thunkDir True $
842+ Just markPrivate -> ptr { _thunkPtr_source = case _thunkPtr_source ptr of
695− "thunk pack: thunk checkout contains unsaved modifications"
843+ ThunkSource_Git s -> ThunkSource_Git $ s { _gitSource_private = markPrivate }
696−
844+ ThunkSource_GitHub s -> ThunkSource_GitHub $ s { _gitHubSource_private = markPrivate }
697− -- Check whether there are any stashes
845+ }
848+ = CheckClean_FullCheck
849+ -- ^ Check that the repo is clean, including .gitignored files
850+ | CheckClean_NotIgnored
851+ -- ^ Check that the repo is clean, not including .gitignored files
852+ | CheckClean_NoCheck
853+ -- ^ Don't check that the repo is clean
855+getThunkPtr :: forall m. MonadObelisk m => CheckClean -> FilePath -> Maybe Bool -> m ThunkPtr
856+getThunkPtr gitCheckClean dir mPrivate = do
857+ let repoLocations = nubOrd $ map (first normalise)
858+ [(".git", "."), (unpackedDirName </> ".git", unpackedDirName)]
859+ repoLocation' <- liftIO $ flip findM repoLocations $ doesDirectoryExist . (dir </>) . fst
860+ thunkDir <- case repoLocation' of
861+ Nothing -> failWith [i|Can't find an unpacked thunk in ${dir}|]
862+ Just (_, path) -> pure $ normalise $ dir </> path
864+ let (checkClean, checkIgnored) = case gitCheckClean of
865+ CheckClean_FullCheck -> (True, True)
866+ CheckClean_NotIgnored -> (True, False)
867+ CheckClean_NoCheck -> (False, False)
868+ when checkClean $ ensureCleanGitRepo thunkDir checkIgnored
869+ "thunk pack: thunk checkout contains unsaved modifications"
871+ -- Check whether there are any stashes
872+ when checkClean $ do
698 stashOutput <- readGitProcess thunkDir ["stash", "list"]
873 stashOutput <- readGitProcess thunkDir ["stash", "list"]
699− when checkClean $ case T.null stashOutput of
874+ unless (T.null stashOutput) $
700− False -> do
875+ failWith $ T.unlines $
701− failWith $ T.unlines $
876+ [ "thunk pack: thunk checkout has stashes"
702− [ "thunk pack: thunk checkout has stashes"
877+ , "git stash list:"
703− , "git stash list:"
878+ ] ++ T.lines stashOutput
704− ] ++ T.lines stashOutput
879+
705− True -> return ()
880+ -- Get current branch
706−
881+ (mCurrentBranch, mCurrentCommit) <- do
707− --Check whether all local heads are pushed
882+ b <- listToMaybe . T.lines <$> readGitProcess thunkDir ["rev-parse", "--abbrev-ref", "HEAD"]
708− repoHeads <- T.lines <$> readGitProcess thunkDir ["for-each-ref", "--format=%(refname:short)", "refs/heads/"]
883+ c <- listToMaybe . T.lines <$> readGitProcess thunkDir ["rev-parse", "HEAD"]
709− remotes <- T.lines <$> readGitProcess thunkDir ["remote"]
884+ case b of
710− --Check that the upstream specified actually exists
885+ (Just "HEAD") -> failWith $ T.unlines
711− case L.find (== upstream) remotes of
886+ [ "thunk pack: You are in 'detached HEAD' state."
712− Nothing -> failWith $ "thunk pack: upstream " <> upstream <> " does not exist. Available upstreams are " <> T.intercalate ", " remotes
887+ , "If you want to pack at the current ref \
713− Just _ -> return ()
888+ \then please create a new branch with 'git checkout -b <new-branch-name>' and push this upstream."
714− -- iterate over cartesian product
889+ ]
715− when checkClean $ forM_ repoHeads $ \hd -> do
890+ _ -> return (b, c)
716− [localRev] <- T.lines <$> readGitProcess thunkDir ["rev-parse", T.unpack hd]
891+
717− forM_ remotes $ \rm -> do
892+ -- Get information on all branches and their (optional) designated upstream
718− --TODO: The error you get if a branch isn't pushed anywhere could be made more user friendly
893+ -- correspondents
719− [remoteMergeRev] <- fmap T.lines $ readGitProcess thunkDir
894+ headDump :: [Text] <- T.lines <$> readGitProcess thunkDir
720− ["merge-base", T.unpack localRev, "remotes/" <> T.unpack rm <> "/" <> T.unpack hd]
895+ [ "for-each-ref"
721− case remoteMergeRev == localRev of
896+ , "--format=%(refname:short) %(upstream:short) %(upstream:remotename)"
722− False -> failWith $ mconcat [ "thunk unpack: branch ", hd, " has not been pushed to ", rm ]
897+ , "refs/heads/"
723− True -> return ()
898+ ]
725− --We assume it's safe to pack the thunk at this point
900+ (headInfo :: Map Text (Maybe (Text, Text)))
726− [remoteUri'] <- fmap T.lines $ readGitProcess thunkDir ["config", "--get", "remote." <> T.unpack upstream <> ".url"]
901+ <- fmap Map.fromList $ forM headDump $ \line -> do
727−
902+ (branch : restOfLine) <- pure $ T.words line
728− let uriParseFailure = "Could not identify git remote: " <> remoteUri'
903+ mUpstream <- case restOfLine of
729− mRemoteUri = parseGitUri remoteUri'
904+ [] -> pure Nothing
730− case mRemoteUri of
905+ [u, r] -> pure $ Just (u, r)
731− Nothing -> failWith uriParseFailure
906+ (_:_) -> failWith "git for-each-ref invalid output"
732− Just remoteUri -> do
907+ pure (branch, mUpstream)
733− refs <- fmap (map (refsToTuples . T.words) . T.lines) $ readGitProcess thunkDir ["show-ref", "--head"]
908+
734− -- safe because exactly one hash is associated with HEAD
909+ putLog Debug $ "branches: " <> T.pack (show headInfo)
735− let Just currentHead = fst <$> L.find ((== "HEAD") . snd) refs
910+
736− remoteHeads = Map.fromList $ catMaybes $ fmap
911+ let errorMap :: Map Text ()
737− (\(x,y) -> (,) x <$> T.stripPrefix ("refs/remotes/" <> upstream <> "/") y)
912+ headUpstream :: Map Text (Text, Text)
738− refs
913+ (errorMap, headUpstream) = flip Map.mapEither headInfo $ \case
739− localHeads = Map.fromList $ catMaybes $ fmap
914+ Nothing -> Left ()
740− (\(x,y) -> (,) x <$> T.stripPrefix "refs/heads/" y)
915+ Just b -> Right b
742− currentUpstreamBranch = Map.lookup currentHead remoteHeads
917+ putLog Debug $ "branches with upstream branch set: " <> T.pack (show headUpstream)
743− <|> Map.lookup currentHead localHeads
918+
744− if isGithubThunk remoteUri
919+ -- Check that every branch has a remote equivalent
745− then githubThunkPtr remoteUri currentHead currentUpstreamBranch
920+ when checkClean $ do
746− else gitThunkPtr remoteUri currentHead currentUpstreamBranch
921+ let untrackedBranches = Map.keys errorMap
747− where
922+ when (not $ L.null untrackedBranches) $ failWith $ T.unlines $
748− refsToTuples [x, y] = (x, y)
923+ [ "thunk pack: Certain branches in the thunk have no upstream branch \
749− refsToTuples x = error $ "thunk pack: cannot parse ref " <> show x
924+ \set. This means we don't know to check whether all your work is \
750− isGithubThunk u
925+ \saved. The offending branches are:"
751− | Just uriAuth <- uriAuthority u
926+ , ""
752− = case uriScheme u of
927+ , T.unwords untrackedBranches
753− "ssh:" -> uriAuth == URIAuth "git@" "github.com" ""
928+ , ""
754− s -> s `L.elem` [ "git:", "https:", "http:" ] -- "http:" just redirects to "https:"
929+ , "To fix this, you probably want to do:"
755− && uriRegName uriAuth == "github.com"
930+ , ""
756− | otherwise = False
931+ ] ++
757− githubThunkPtr u commit' branch' = do
932+ ((\branch -> "git push -u origin " <> branch) <$> untrackedBranches) ++
758− ["/", owner', repo'] <- return $ splitDirectories (uriPath u)
933+ [ ""
759− let owner = N (T.pack owner')
934+ , "These will push the branches to the default remote under the same \
760− dropGitExtension r = fromMaybe r $ T.stripSuffix ".git" r
935+ \name, and (thanks to the `-u`) remember that choice so you don't \
761− repo = N $ dropGitExtension $ T.pack repo'
936+ \get this error again."
762− commit = N commit'
937+ ]
763− branch = N <$> branch'
938+
764− mauth <- liftIO $ getHubAuth "github.com"
939+ -- loosely by https://stackoverflow.com/questions/7773939/show-git-ahead-and-behind-info-for-all-branches-including-remotes
765− repoResult <- liftIO $ executeRequestMaybe mauth $ repositoryR owner repo
940+ stats <- ifor headUpstream $ \branch (upstream, _remote) -> do
766− repoIsPrivate <- either (liftIO . throwIO) (return . repoPrivate) repoResult
941+ (stat :: [Text]) <- T.lines <$> readGitProcess thunkDir
767− archiveResult <- liftIO $ executeRequestMaybe mauth $
942+ [ "rev-list", "--left-right"
768− archiveForR owner repo ArchiveFormatTarball (Just (untagName commit))
943+ , T.unpack branch <> "..." <> T.unpack upstream
769− archiveUri <- either (liftIO . throwIO) return archiveResult
944+ ]
770− hash <- getNixSha256ForUriUnpacked archiveUri
945+ let ahead = length $ [ () | Just ('<', _) <- T.uncons <$> stat ]
771− return $ ThunkPtr
946+ behind = length $ [ () | Just ('>', _) <- T.uncons <$> stat ]
772− { _thunkPtr_rev = ThunkRev
947+ pure (upstream, (ahead, behind))
773− { _thunkRev_commit = commitNameToRef commit
948+
774− , _thunkRev_nixSha256 = hash
949+ -- Those branches which have commits ahead of, i.e. not on, the upstream
775− }
950+ -- branch. Purely being behind is fine.
776− , _thunkPtr_source = ThunkSource_GitHub $ GitHubSource
951+ let nonGood = Map.filter ((/= 0) . fst . snd) stats
777− { _gitHubSource_owner = owner
952+
778− , _gitHubSource_repo = repo
953+ when (not $ Map.null nonGood) $ failWith $ T.unlines $
779− , _gitHubSource_branch = branch
954+ [ "thunk pack: Certain branches in the thunk have commits not yet pushed upstream:"
780− , _gitHubSource_private = repoIsPrivate
955+ , ""
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
782− }
1034+ s -> s `L.elem` [ "git", "https", "http" ] -- "http:" just redirects to "https:"
783− gitThunkPtr u commit branch' = do
1035+ && URI.unRText (URI.authHost uriAuth) == "github.com"
784− let protocols = ["https:", "ssh:", "git:"]
1036+ , Just (_, owner :| [repoish]) <- URI.uriPath u
785− unless (T.toLower (T.pack $ uriScheme u) `elem` protocols) $
1037+ = \mbranch -> do
786− failWith $ "thunk pack: obelisk currently only supports "
1038+ isPrivate <- getIsPrivate
787− <> T.intercalate ", " protocols <> " protocols for non-GitHub remotes"
1039+ pure $ ThunkSource_GitHub $ GitHubSource
788− hash <- nixPrefetchGit u commit False
1040+ { _gitHubSource_owner = N $ URI.unRText owner
789− branch <- case branch' of
1041+ , _gitHubSource_repo = N $ let
790− Nothing -> failWith "thunk pack: git thunks must track a branch"
1042+ repoish' = URI.unRText repoish
791− Just b -> pure $ N b
1043+ in fromMaybe repoish' $ T.stripSuffix ".git" repoish'
792− pure $ ThunkPtr
1044+ , _gitHubSource_branch = N <$> mbranch
793− { _thunkPtr_rev = ThunkRev
1045+ , _gitHubSource_private = isPrivate
794− { _thunkRev_commit = commitNameToRef (N commit)
795− , _thunkRev_nixSha256 = hash
797− , _thunkPtr_source = ThunkSource_Git $ GitSource
1047+
798− { _gitSource_url = u
1048+ | otherwise = \mbranch -> do
799− , _gitSource_branch = branch
1049+ isPrivate <- getIsPrivate
1050+ pure $ ThunkSource_Git $ GitSource
1051+ { _gitSource_url = GitUri u
1052+ , _gitSource_branch = N <$> mbranch
800 , _gitSource_fetchSubmodules = False -- TODO: How do we determine if this should be true?
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
804−parseGitUri :: Text -> Maybe URI
1085+-- Funny signature indicates no effects depend on the optional branch name.
805−parseGitUri x = parseURIReference (T.unpack x) <|> parseSshShorthand x
1086+githubThunkRev
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
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
807−parseSshShorthand :: Text -> Maybe URI
1178+parseSshShorthand :: Text -> Maybe URI.URI
808parseSshShorthand uri = do
1179parseSshShorthand uri = do
809 -- This is what git does to check that the remote
1180 -- This is what git does to check that the remote
810 -- is not a local file path when parsing shorthand.
1181 -- is not a local file path when parsing shorthand.
@@ -817,4 +1188,4 @@ parseSshShorthand uri = do
817 -- 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
818 guard $ isNothing (T.findIndex (=='/') authAndHostname)
1189 guard $ isNothing (T.findIndex (=='/') authAndHostname)
819 && not (T.null colonAndPath)
1190 && not (T.null colonAndPath)
820− parseURI $ T.unpack properUri
1191+ URI.mkURI properUri