@@ -1,74 +1,75 @@
11{-# LANGUAGE DataKinds #-}
2−{-# LANGUAGE FlexibleContexts #-}
32{-# LANGUAGE LambdaCase #-}
4−{-# LANGUAGE MultiParamTypeClasses #-}
53{-# LANGUAGE MultiWayIf #-}
64{-# LANGUAGE OverloadedStrings #-}
75{-# LANGUAGE PatternGuards #-}
8−{-# LANGUAGE QuasiQuotes #-}
9−{-# LANGUAGE ScopedTypeVariables #-}
10−{-# LANGUAGE TypeApplications #-}
11−module Obelisk.Command.Thunk where
6+{-# LANGUAGE TemplateHaskell #-}
7+
8+module Obelisk.Command.Thunk
9+ ( ThunkPtr (..)
10+ , ThunkRev (..)
11+ , ThunkSource (..)
12+ , ThunkData (..)
13+ , GitHubSource (..)
14+ , getLatestRev
15+ , updateThunkToLatest
16+ , createThunkWithLatest
17+ , nixBuildAttrWithCache
18+ , nixBuildThunkAttrWithCache
19+ , unpackThunk
20+ , packThunk
21+ , readThunk
22+ ) where
1223
1324import Control.Applicative
14−import Control.Exception (displayException, try)
15−import Control.Lens (ifor, ifor_, (.~))
25+import Control.Exception
1626import Control.Monad
17−import Control.Monad.Extra (findM)
18−import Control.Monad.Catch (MonadCatch, handle)
1927import Control.Monad.Except
20−import Data.Aeson ((.=))
21−import qualified Data.Aeson as Aeson
28+import Data.Aeson as Aeson
2229import Data.Aeson.Encode.Pretty
23−import qualified Data.Aeson.Types as Aeson
24−import Data.Bifunctor (first)
2530import qualified Data.ByteString.Lazy as LBS
26−import Data.Containers.ListUtils (nubOrd)
2731import Data.Default
28−import Data.Either.Combinators (fromRight', rightToMaybe)
29−import Data.Foldable (toList)
30−import Data.Function ((&))
31−import Data.Functor ((<&>))
32+import Data.Foldable
3233import Data.Git.Ref (Ref)
3334import qualified Data.Git.Ref as Ref
3435import qualified Data.List as L
35−import Data.List.NonEmpty (NonEmpty (..), nonEmpty)
36+import Data.List.NonEmpty (NonEmpty (..))
3637import qualified Data.List.NonEmpty as NonEmpty
37−import Data.Map (Map)
3838import qualified Data.Map as Map
3939import Data.Maybe
40+import Data.Monoid
4041import Data.Set (Set)
4142import qualified Data.Set as Set
42−import Data.String.Here.Interpolated (i)
43−import Data.String.Here.Uninterpolated (here)
4443import Data.Text (Text)
4544import qualified Data.Text as T
46−import Data.Text.Encoding
4745import qualified Data.Text.IO as T
46+import Data.Text.Encoding
4847import Data.Time.Clock.POSIX (posixSecondsToUTCTime)
49−import Data.Traversable (for)
50−import Data.Yaml (parseMaybe)
48+import Data.Yaml (parseMaybe, (.:))
49+import qualified Data.Yaml as Yaml
5150import GitHub
51+import GitHub.Endpoints.Repos.Contents (archiveForR)
5252import GitHub.Data.Name
53+import Network.URI
5354import Obelisk.Command.Nix
5455import System.Directory
5556import System.Exit
5657import System.FilePath
58+import System.IO
5759import System.IO.Error
5860import System.IO.Temp
59−import System.PosixCompat.Files (getSymbolicLinkStatus, modificationTime)
60−import qualified Text.URI as URI
61+import System.Posix (modificationTime, getSymbolicLinkStatus)
62+import System.Process
6163
62−import Obelisk.App (MonadObelisk)
63−import Obelisk.CliApp
64−import Obelisk.Command.Utils
64+import Development.Placeholders
6565
6666--TODO: Support symlinked thunk data
6767data ThunkData
68− = ThunkData_Packed ThunkSpec ThunkPtr
68+ = ThunkData_Packed ThunkPtr
6969 -- ^ Packed thunk
70− | ThunkData_Checkout
70+ | ThunkData_Checkout (Maybe ThunkPtr)
7171 -- ^ Checked out thunk that was unpacked from this pointer
72+ deriving (Show, Eq, Ord)
7273
7374-- | A reference to the exact data that a thunk should translate into
7475data ThunkPtr = ThunkPtr
@@ -81,7 +82,7 @@ type NixSha256 = Text --TODO: Use a smart constructor and make this actually ver
8182
8283-- | A specific revision of data; it may be available from multiple sources
8384data ThunkRev = ThunkRev
84− { _thunkRev_commit :: Ref Ref.SHA1
85+ { _thunkRev_commit :: Ref
8586 , _thunkRev_nixSha256 :: NixSha256
8687 }
8788 deriving (Show, Eq, Ord)
@@ -94,11 +95,6 @@ data ThunkSource
9495 | ThunkSource_Git GitSource
9596 deriving (Show, Eq, Ord)
9697
97−thunkSourceToGitSource :: ThunkSource -> GitSource
98−thunkSourceToGitSource = \case
99− ThunkSource_GitHub s -> forgetGithub False s
100− ThunkSource_Git s -> s
101−
10298data GitHubSource = GitHubSource
10399 { _gitHubSource_owner :: Name Owner
104100 , _gitHubSource_repo :: Name Repo
@@ -107,263 +103,157 @@ data GitHubSource = GitHubSource
107103 }
108104 deriving (Show, Eq, Ord)
109105
110−newtype GitUri = GitUri { unGitUri :: URI.URI } deriving (Eq, Ord, Show)
111−
112−gitUriToText :: GitUri -> Text
113−gitUriToText (GitUri uri)
114− | (T.toLower . URI.unRText <$> URI.uriScheme uri) == Just "file"
115− , Just (_, path) <- URI.uriPath uri
116− = "/" <> T.intercalate "/" (map URI.unRText $ NonEmpty.toList path)
117− | otherwise = URI.render uri
118−
119106data GitSource = GitSource
120− { _gitSource_url :: GitUri
107+ { _gitSource_url :: URI
108+ --TODO: Is it ok to use the types from the GitHub api bindings?
121109 , _gitSource_branch :: Maybe (Name Branch)
122110 , _gitSource_fetchSubmodules :: Bool
123− , _gitSource_private :: Bool
124111 }
125112 deriving (Show, Eq, Ord)
126113
127−newtype ThunkConfig = ThunkConfig
128− { _thunkConfig_private :: Maybe Bool
129− } deriving Show
130−
131−data ThunkUpdateConfig = ThunkUpdateConfig
132− { _thunkUpdateConfig_branch :: Maybe String
133− , _thunkUpdateConfig_config :: ThunkConfig
134− } deriving Show
135−
136−data ThunkPackConfig = ThunkPackConfig
137− { _thunkPackConfig_force :: Bool
138− , _thunkPackConfig_config :: ThunkConfig
139− } deriving Show
140−
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
148− <$ guard useSsh
149− , URI.authHost = fromRight' $ URI.mkHost "github.com"
150− , URI.authPort = Nothing
151− }
152− , URI.uriPath = Just ( False
153− , fromRight' . URI.mkPathPiece <$>
154− untagName (_gitHubSource_owner s)
155− :| [ untagName (_gitHubSource_repo s) <> ".git" ]
156− )
157− , URI.uriQuery = []
158− , URI.uriFragment = Nothing
159− }
160− , _gitSource_branch = _gitHubSource_branch s
161− , _gitSource_fetchSubmodules = False
162− , _gitSource_private = _gitHubSource_private s
163− }
164−
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
169−
170−commitNameToRef :: Name Commit -> Ref Ref.SHA1
114+commitNameToRef :: Name Commit -> Ref
171115commitNameToRef (N c) = Ref.fromHex $ encodeUtf8 c
172116
173−-- TODO: Use spinner here.
174−getNixSha256ForUriUnpacked
175− :: MonadObelisk m
176− => GitUri
177− -> m NixSha256
178−getNixSha256ForUriUnpacked uri =
179− withExitFailMessage ("nix-prefetch-url: Failed to determine sha256 hash of URL " <> gitUriToText uri) $ do
180− [hash] <- fmap T.lines $ readProcessAndLogOutput (Debug, Debug) $
181− proc nixPrefetchUrlPath ["--unpack", "--type", "sha256", T.unpack $ gitUriToText uri]
182− pure hash
183−
184−nixPrefetchGit :: MonadObelisk m => GitUri -> Text -> Bool -> m NixSha256
185−nixPrefetchGit uri rev fetchSubmodules =
186− withExitFailMessage ("nix-prefetch-git: Failed to determine sha256 hash of Git repo " <> gitUriToText uri <> " at " <> rev) $ do
187− out <- readProcessAndLogStderr Debug $
188− proc nixPrefetchGitPath $ filter (/="")
189− [ "--url", T.unpack $ gitUriToText uri
190− , "--rev", T.unpack rev
191− , if fetchSubmodules then "--fetch-submodules" else ""
192− , "--quiet"
193− ]
117+getNixSha256ForUriUnpacked :: URI -> IO NixSha256
118+getNixSha256ForUriUnpacked uri = do
119+ (_, out, err, p) <- runInteractiveProcess "nix-prefetch-url" --TODO: Make this package depend on nix-prefetch-url properly
120+ [ "--unpack"
121+ , "--type"
122+ , "sha256"
123+ , show uri
124+ ] Nothing Nothing
125+ --TODO: Deal with errors here; usually they're HTTP errors
126+ waitForProcess p >>= \case
127+ ExitSuccess -> return ()
128+ _ -> do
129+ hPutStrLn stdout =<< hGetContents out
130+ hPutStrLn stderr =<< hGetContents err
131+ --TODO: actual error
132+ fail $ "nix-prefetch-url"
133+ T.strip <$> T.hGetContents out
194134
195− case parseMaybe (Aeson..: "sha256") =<< Aeson.decodeStrict (encodeUtf8 out) of
196− Nothing -> failWith $ "nix-prefetch-git: unrecognized output " <> out
197− Just x -> pure x
135+-- | Get the latest revision available from the given source
136+getLatestRev :: ThunkSource -> IO ThunkRev
137+getLatestRev = \case
138+ ThunkSource_GitHub s -> do
139+ auth <- getHubAuth "github.com"
140+ commitsResult <- executeRequestMaybe auth $ commitsWithOptionsForR
141+ (_gitHubSource_owner s)
142+ (_gitHubSource_repo s)
143+ (FetchAtLeast 1)
144+ $ case _gitHubSource_branch s of
145+ Nothing -> []
146+ Just b -> [CommitQuerySha $ untagName b]
147+ commitInfos <- either throwIO return commitsResult
148+ commitInfo : _ <- return $ toList commitInfos
149+ let commit = commitSha commitInfo
150+ Right archiveUri <- executeRequestMaybe auth $ archiveForR (_gitHubSource_owner s) (_gitHubSource_repo s) ArchiveFormatTarball $ Just $ untagName commit
151+ nixSha256 <- getNixSha256ForUriUnpacked archiveUri
152+ return $ ThunkRev
153+ { _thunkRev_commit = commitNameToRef commit
154+ , _thunkRev_nixSha256 = nixSha256
155+ }
156+ ThunkSource_Git _s -> do
157+ $notImplemented
198158
199159--TODO: Pretty print these
200160data ReadThunkError
201− = ReadThunkError_UnrecognizedThunk
202− | ReadThunkError_UnrecognizedPaths (NonEmpty FilePath)
203− | ReadThunkError_MissingPaths (NonEmpty FilePath)
204− | ReadThunkError_UnparseablePtr FilePath String
205− | ReadThunkError_FileError IOError
206− | ReadThunkError_FileDoesNotMatch FilePath Text
207− | ReadThunkError_UnrecognizedState String
208− | ReadThunkError_AmbiguousPackedState ThunkPtr ThunkPtr
209− deriving (Show)
210−
211−unpackedDirName :: FilePath
212−unpackedDirName = "."
213−
214−attrCacheFileName :: FilePath
215−attrCacheFileName = ".attr-cache"
216−
217−-- | Specification for how a file in a thunk version works.
218−data ThunkFileSpec
219− = ThunkFileSpec_Ptr (LBS.ByteString -> Either String ThunkPtr) -- ^ This file specifies 'ThunkPtr' data
220− | ThunkFileSpec_FileMatches Text -- ^ This file must match the given content exactly
221− | ThunkFileSpec_CheckoutIndicator -- ^ Existence of this directory indicates that the thunk is unpacked
222− | ThunkFileSpec_AttrCache -- ^ This directory is an attribute cache
223−
224−-- | Specification for how a set of files in a thunk version work.
225−data ThunkSpec = ThunkSpec
226− { _thunkSpec_name :: !Text
227− , _thunkSpec_files :: !(Map FilePath ThunkFileSpec)
228− }
229−
230−thunkSpecTypes :: NonEmpty (NonEmpty ThunkSpec)
231−thunkSpecTypes = gitThunkSpecs :| [gitHubThunkSpecs]
232−
233−-- | Attempts to match a 'ThunkSpec' to a given directory.
234−matchThunkSpecToDir
235− :: (MonadError ReadThunkError m, MonadIO m, MonadCatch m)
236− => ThunkSpec -- ^ 'ThunkSpec' to match against the given files/directory
237− -> FilePath -- ^ Path to directory
238− -> Set FilePath -- ^ Set of file paths relative to the given directory
239− -> m ThunkData
240−matchThunkSpecToDir thunkSpec dir dirFiles = do
241− case nonEmpty (toList $ dirFiles `Set.difference` expectedPaths) of
242− Just fs -> throwError $ ReadThunkError_UnrecognizedPaths $ (dir </>) <$> fs
243− Nothing -> pure ()
244− case nonEmpty (toList $ requiredPaths `Set.difference` dirFiles) of
245− Just fs -> throwError $ ReadThunkError_MissingPaths $ (dir </>) <$> fs
246− Nothing -> pure ()
247− datas <- fmap toList $ flip Map.traverseMaybeWithKey (_thunkSpec_files thunkSpec) $ \expectedPath -> \case
248− ThunkFileSpec_AttrCache -> Nothing <$ dirMayExist expectedPath
249− ThunkFileSpec_CheckoutIndicator -> liftIO (doesDirectoryExist (dir </> expectedPath)) <&> \case
250− False -> Nothing
251− True -> Just ThunkData_Checkout
252− ThunkFileSpec_FileMatches expectedContents -> handle (\(e :: IOError) -> throwError $ ReadThunkError_FileError e) $ do
253− actualContents <- liftIO (T.readFile $ dir </> expectedPath)
254− case T.strip expectedContents == T.strip actualContents of
255− True -> pure Nothing
256− False -> throwError $ ReadThunkError_FileDoesNotMatch (dir </> expectedPath) expectedContents
257− ThunkFileSpec_Ptr parser -> handle (\(e :: IOError) -> throwError $ ReadThunkError_FileError e) $ do
258− let path = dir </> expectedPath
259− liftIO (doesFileExist path) >>= \case
260− False -> pure Nothing
261− True -> do
262− actualContents <- liftIO $ LBS.readFile path
263− case parser actualContents of
264− Right v -> pure $ Just (ThunkData_Packed thunkSpec v)
265− Left e -> throwError $ ReadThunkError_UnparseablePtr (dir </> expectedPath) e
266−
267− case nonEmpty datas of
268− Nothing -> throwError ReadThunkError_UnrecognizedThunk
269− Just xs -> fold1WithM xs $ \a b -> either throwError pure (mergeThunkData a b)
270− where
271− rootPathsOnly = Set.fromList . mapMaybe takeRootDir . Map.keys
272− takeRootDir = fmap NonEmpty.head . nonEmpty . splitPath
273−
274− expectedPaths = rootPathsOnly $ _thunkSpec_files thunkSpec
275−
276− requiredPaths = rootPathsOnly $ Map.filter isRequiredFileSpec $ _thunkSpec_files thunkSpec
277− isRequiredFileSpec = \case
278− ThunkFileSpec_FileMatches _ -> True
279− _ -> False
280−
281− dirMayExist expectedPath = liftIO (doesFileExist (dir </> expectedPath)) >>= \case
282− True -> throwError $ ReadThunkError_UnrecognizedPaths $ expectedPath :| []
283− False -> pure ()
284−
285− -- Combine 'ThunkData' from different files, preferring "Checkout" over "Packed"
286− mergeThunkData ThunkData_Checkout ThunkData_Checkout = Right ThunkData_Checkout
287− mergeThunkData ThunkData_Checkout ThunkData_Packed{} = Left bothPackedAndUnpacked
288− mergeThunkData ThunkData_Packed{} ThunkData_Checkout = Left bothPackedAndUnpacked
289− mergeThunkData a@(ThunkData_Packed _ ptrA) (ThunkData_Packed _ ptrB) =
290− if ptrA == ptrB then Right a else Left $ ReadThunkError_AmbiguousPackedState ptrA ptrB
291−
292− bothPackedAndUnpacked = ReadThunkError_UnrecognizedState "Both packed data and checkout present"
293−
294− fold1WithM (x :| xs) f = foldM f x xs
295−
296−readThunkWith
297− :: (MonadObelisk m)
298− => NonEmpty (NonEmpty ThunkSpec) -> FilePath -> m (Either ReadThunkError ThunkData)
299−readThunkWith specTypes dir = do
300− dirFiles <- Set.fromList <$> liftIO (listDirectory dir)
301− let specs = concatMap toList $ toList $ NonEmpty.transpose specTypes -- Interleave spec types so we try each one in a "fair" ordering
302− flip fix specs $ \loop -> \case
303− [] -> pure $ Left ReadThunkError_UnrecognizedThunk
304− spec:rest -> runExceptT (matchThunkSpecToDir spec dir dirFiles) >>= \case
305− Left e -> putLog Debug [i|Thunk specification ${_thunkSpec_name spec} did not match ${dir}: ${e}|] *> loop rest
306− x@(Right _) -> x <$ putLog Debug [i|Thunk specification ${_thunkSpec_name spec} matched ${dir}|]
161+ = ReadThunkError_WrongContents (Set String) (Set String)
162+ | ReadThunkError_UnrecognizedLoader Text
163+ | ReadThunkError_UnparseablePtr LBS.ByteString
164+ deriving (Show)
165+
166+-- | Read a thunk and validate that it is only a thunk, either packed or unpacked.
167+-- If the thunk is packed and additional data is present, fail.
168+readThunk :: FilePath -> IO (Either ReadThunkError ThunkData)
169+readThunk thunkDir = do
170+ files <- listDirectory thunkDir
171+ case ".git" `elem` files of
172+ True -> fmap ThunkData_Checkout <$> do
173+ let origThunkPath = thunkDir </> ".git" </> "obelisk" </> "orig-thunk"
174+ doesDirectoryExist origThunkPath >>= \case
175+ True -> fmap Just <$> readPackedThunk origThunkPath
176+ False -> return $ return Nothing
177+ False -> fmap ThunkData_Packed <$> readPackedThunk thunkDir
307178
308179-- | Read a thunk and validate that it is exactly a packed thunk.
309180-- If additional data is present, fail.
310−readThunk :: (MonadObelisk m) => FilePath -> m (Either ReadThunkError ThunkData)
311−readThunk = readThunkWith thunkSpecTypes
312−
313−parseThunkPtr :: (Aeson.Object -> Aeson.Parser ThunkSource) -> Aeson.Object -> Aeson.Parser ThunkPtr
314−parseThunkPtr parseSrc v = do
315− rev <- v Aeson..: "rev"
316− sha256 <- v Aeson..: "sha256"
317− src <- parseSrc v
318− pure $ ThunkPtr
319− { _thunkPtr_rev = ThunkRev
320− { _thunkRev_commit = Ref.fromHexString rev
321− , _thunkRev_nixSha256 = sha256
322− }
323− , _thunkPtr_source = src
324− }
325−
326−parseGitHubSource :: Aeson.Object -> Aeson.Parser GitHubSource
327−parseGitHubSource v = do
328− owner <- v Aeson..: "owner"
329− repo <- v Aeson..: "repo"
330− branch <- v Aeson..:! "branch"
331− private <- v Aeson..:? "private"
332− pure $ GitHubSource
333− { _gitHubSource_owner = owner
334− , _gitHubSource_repo = repo
335− , _gitHubSource_branch = branch
336− , _gitHubSource_private = fromMaybe False private
337− }
181+readPackedThunk :: FilePath -> IO (Either ReadThunkError ThunkPtr)
182+readPackedThunk thunkDir = runExceptT $ do
183+ let thunkLoader = thunkDir </> "default.nix"
184+ githubJson = thunkDir </> "github.json"
185+ attrCache = thunkDir </> ".attr-cache"
186+ expectedContents = Set.fromList $
187+ [ githubJson
188+ , thunkLoader
189+ ]
190+ optionalContents = Set.fromList $
191+ [ attrCache
192+ ]
338193
339−parseGitSource :: Aeson.Object -> Aeson.Parser GitSource
340−parseGitSource v = do
341− Just url <- parseGitUri <$> v Aeson..: "url"
342− branch <- v Aeson..:! "branch"
343− fetchSubmodules <- v Aeson..:! "fetchSubmodules"
344− private <- v Aeson..:? "private"
345− pure $ GitSource
346− { _gitSource_url = url
347− , _gitSource_branch = branch
348− , _gitSource_fetchSubmodules = fromMaybe False fetchSubmodules
349− , _gitSource_private = fromMaybe False private
350− }
194+ -- Ensure that there aren't any other files in the thunk
195+ -- NB: System.Directory.listDirectory returns the contents without the directory path
196+ files <- liftIO $ Set.fromList . fmap (thunkDir </>) <$> listDirectory thunkDir
197+ let unexpectedContents = files `Set.difference` (expectedContents `Set.union` optionalContents)
198+ missingContents = expectedContents `Set.difference` files
199+ unless (Set.null unexpectedContents && Set.null missingContents) $ do
200+ throwError $ ReadThunkError_WrongContents unexpectedContents missingContents
201+
202+ -- Ensure that we recognize the thunk loader
203+ loader <- liftIO $ T.readFile thunkLoader
204+ unless (loader `elem` gitHubStandaloneLoaders) $ do
205+ throwError $ ReadThunkError_UnrecognizedLoader loader
206+
207+ txt <- liftIO $ LBS.readFile githubJson
208+ let parseThunk v = do
209+ rev <- v Aeson..: "rev"
210+ sha256 <- v Aeson..: "sha256"
211+ src <- parseGitHubSource v
212+ <|> parseGitSource v
213+ return $ ThunkPtr
214+ { _thunkPtr_rev = ThunkRev
215+ { _thunkRev_commit = Ref.fromHexString rev
216+ , _thunkRev_nixSha256 = sha256
217+ }
218+ , _thunkPtr_source = src
219+ }
220+ parseGitHubSource v = do
221+ owner <- v Aeson..: "owner"
222+ repo <- v Aeson..: "repo"
223+ branch <- v Aeson..:! "branch"
224+ mPrivate <- v Aeson..:! "private"
225+ return $ ThunkSource_GitHub $ GitHubSource
226+ { _gitHubSource_owner = owner
227+ , _gitHubSource_repo = repo
228+ , _gitHubSource_branch = branch
229+ , _gitHubSource_private = fromMaybe False mPrivate
230+ }
231+ parseGitSource v = do
232+ Just url <- parseURI <$> v Aeson..: "url"
233+ branch <- v Aeson..:! "branch"
234+ fetchSubmodules <- v Aeson..: "fetchSubmodules"
235+ return $ ThunkSource_Git $ GitSource
236+ { _gitSource_url = url
237+ , _gitSource_branch = branch
238+ , _gitSource_fetchSubmodules = fetchSubmodules
239+ }
240+ case parseMaybe parseThunk =<< decode txt of
241+ Nothing -> throwError $ ReadThunkError_UnparseablePtr txt
242+ Just ptr -> return ptr
351243
352−overwriteThunk :: MonadObelisk m => FilePath -> ThunkPtr -> m ()
244+overwriteThunk :: FilePath -> ThunkPtr -> IO ()
353245overwriteThunk target thunk = do
354246 -- Ensure that this directory is a valid thunk (i.e. so we aren't losing any data)
355− readThunk target >>= \case
356− Left e -> failWith [i|Invalid thunk at ${target}: ${e}|]
357− Right _ -> pure ()
247+ Right _ <- readThunk target
358248
359249 --TODO: Is there a safer way to do this overwriting?
360− liftIO $ removePathForcibly target
361− createThunk target $ Right thunk
250+ removeDirectoryRecursive target
251+ createThunk target thunk
362252
363−thunkPtrToSpec :: ThunkPtr -> ThunkSpec
364−thunkPtrToSpec thunk = case _thunkPtr_source thunk of
365− ThunkSource_GitHub _ -> NonEmpty.head gitHubThunkSpecs
366− ThunkSource_Git _ -> NonEmpty.head gitThunkSpecs
253+thunkPtrLoader :: ThunkPtr -> Text
254+thunkPtrLoader thunk = case _thunkPtr_source thunk of
255+ ThunkSource_GitHub _ -> NonEmpty.head gitHubStandaloneLoaders
256+ ThunkSource_Git _ -> NonEmpty.head plainGitStandaloneLoaders
367257
368258-- It's important that formatting be very consistent here, because
369259-- otherwise when people update thunks, their patches will be messy
@@ -372,18 +262,21 @@ encodeThunkPtrData (ThunkPtr rev src) = case src of
372262 ThunkSource_GitHub s -> encodePretty' githubCfg $ Aeson.object $ catMaybes
373263 [ Just $ "owner" .= _gitHubSource_owner s
374264 , Just $ "repo" .= _gitHubSource_repo s
375− , ("branch" .=) <$> _gitHubSource_branch s
265+ , case _gitHubSource_branch s of
266+ Just b -> Just $ "branch" .= b
267+ Nothing -> Nothing
268+ , if _gitHubSource_private s
269+ then Just $ "private" .= True
270+ else Nothing
376271 , Just $ "rev" .= Ref.toHexString (_thunkRev_commit rev)
377272 , Just $ "sha256" .= _thunkRev_nixSha256 rev
378− , Just $ "private" .= _gitHubSource_private s
379273 ]
380274 ThunkSource_Git s -> encodePretty' plainGitCfg $ Aeson.object $ catMaybes
381− [ Just $ "url" .= gitUriToText (_gitSource_url s)
275+ --TODO: Is this safe? read/show is jank for `URI`
276+ [ Just $ "url" .= show (_gitSource_url s)
382277 , Just $ "rev" .= Ref.toHexString (_thunkRev_commit rev)
383− , ("branch" .=) <$> _gitSource_branch s
384278 , Just $ "sha256" .= _thunkRev_nixSha256 rev
385279 , Just $ "fetchSubmodules" .= _gitSource_fetchSubmodules s
386− , Just $ "private" .= _gitSource_private s
387280 ]
388281 where
389282 githubCfg = defConfig
@@ -404,84 +297,54 @@ encodeThunkPtrData (ThunkPtr rev src) = case src of
404297 [ "url"
405298 , "rev"
406299 , "sha256"
407− , "private"
408300 , "fetchSubmodules"
409301 ] <> compare
410302 , confTrailingNewline = True
411303 }
412304
413−createThunk :: MonadObelisk m => FilePath -> Either ThunkSpec ThunkPtr -> m ()
414−createThunk target ptrInfo =
415− ifor_ (_thunkSpec_files spec) $ \path -> \case
416− ThunkFileSpec_FileMatches content -> withReadyPath path $ \p -> liftIO $ T.writeFile p content
417− ThunkFileSpec_Ptr _ -> case ptrInfo of
418− Left _ -> pure () -- We can't write the ptr without it
419− Right ptr -> withReadyPath path $ \p -> liftIO $ LBS.writeFile p (encodeThunkPtrData ptr)
420− _ -> pure ()
421− where
422− spec = either id thunkPtrToSpec ptrInfo
423− withReadyPath path f = do
424− let fullPath = target </> path
425− putLog Debug $ "Writing thunk file " <> T.pack fullPath
426− liftIO $ createDirectoryIfMissing True $ takeDirectory fullPath
427− f fullPath
305+createThunk :: FilePath -> ThunkPtr -> IO ()
306+createThunk target thunk = do
307+ createDirectoryIfMissing True (target </> ".attr-cache")
308+ T.writeFile (target </> "default.nix") (thunkPtrLoader thunk)
309+ LBS.writeFile (target </> "github.json") (encodeThunkPtrData thunk)
428310
429−createThunkWithLatest :: MonadObelisk m => FilePath -> ThunkSource -> m ()
311+createThunkWithLatest :: FilePath -> ThunkSource -> IO ()
430312createThunkWithLatest target s = do
431313 rev <- getLatestRev s
432− createThunk target $ Right $ ThunkPtr
314+ createThunk target $ ThunkPtr
433315 { _thunkPtr_source = s
434316 , _thunkPtr_rev = rev
435317 }
436318
437−updateThunkToLatest :: MonadObelisk m => ThunkUpdateConfig -> FilePath -> m ()
438−updateThunkToLatest (ThunkUpdateConfig mBranch thunkConfig) target = spinner $ do
439− checkThunkDirectory target
440− -- check to see if thunk should be updated to a specific branch or just update it's current branch
441− case mBranch of
442− Nothing -> do
443− (overwrite, ptr) <- readThunk target >>= \case
444− Left err -> failWith [i|Thunk update: ${err}|]
445− Right c -> case c of
446− ThunkData_Packed _ t -> return (target, t)
447− ThunkData_Checkout -> failWith "cannot update an unpacked thunk"
448− let src = _thunkPtr_source ptr
449− rev <- getLatestRev src
450− overwriteThunk overwrite $ modifyThunkPtrByConfig thunkConfig $ ThunkPtr
451− { _thunkPtr_source = src
452− , _thunkPtr_rev = rev
453− }
454− Just branch -> readThunk target >>= \case
455− Left err -> failWith [i|Thunk update: ${err}|]
456− Right c -> case c of
457− ThunkData_Packed _ t -> setThunk thunkConfig target (thunkSourceToGitSource $ _thunkPtr_source t) branch
458− ThunkData_Checkout -> failWith [i|Thunk located at ${target} is unpacked. Use 'ob thunk pack' on the desired directory and then try 'ob thunk update' again.|]
459− where
460− spinner = withSpinner' ("Updating thunk " <> T.pack target <> " to latest") (pure $ const $ "Thunk " <> T.pack target <> " updated to latest")
461−
462−setThunk :: MonadObelisk m => ThunkConfig -> FilePath -> GitSource -> String -> m ()
463−setThunk thunkConfig target gs branch = do
464− newThunkPtr <- uriThunkPtr (_gitSource_url gs) (_thunkConfig_private thunkConfig) (Just $ T.pack branch) Nothing
465− overwriteThunk target newThunkPtr
466− updateThunkToLatest (ThunkUpdateConfig Nothing thunkConfig) target
319+updateThunkToLatest :: FilePath -> IO ()
320+updateThunkToLatest target = do
321+ (overwrite, ptr) <- readThunk target >>= \case
322+ Left err -> fail $ "thunk update: " <> show err
323+ Right c -> return $ case c of
324+ ThunkData_Packed t -> (target, t)
325+ ThunkData_Checkout _ -> fail "cannot update an unpacked thunk"
326+ let src = _thunkPtr_source ptr
327+ rev <- getLatestRev src
328+ overwriteThunk overwrite $ ThunkPtr
329+ { _thunkPtr_source = src
330+ , _thunkPtr_rev = rev
331+ }
467332
468333-- | All recognized github standalone loaders, ordered from newest to oldest.
469334-- This tool will only ever produce the newest one when it writes a thunk.
470−gitHubThunkSpecs :: NonEmpty ThunkSpec
471−gitHubThunkSpecs =
472− gitHubThunkSpecV5 :|
473− [ gitHubThunkSpecV4
474− , gitHubThunkSpecV3
475− , gitHubThunkSpecV2
476− , gitHubThunkSpecV1
335+gitHubStandaloneLoaders :: NonEmpty Text
336+gitHubStandaloneLoaders =
337+ gitHubStandaloneLoaderV2 :|
338+ [ gitHubStandaloneLoaderV1
477339 ]
478340
479−gitHubThunkSpecV1 :: ThunkSpec
480−gitHubThunkSpecV1 = legacyGitHubThunkSpec "github-v1"
481− "import ((import <nixpkgs> {}).fetchFromGitHub (builtins.fromJSON (builtins.readFile ./github.json)))"
341+gitHubStandaloneLoaderV1 :: Text
342+gitHubStandaloneLoaderV1 = T.unlines
343+ [ "import ((import <nixpkgs> {}).fetchFromGitHub (builtins.fromJSON (builtins.readFile ./github.json)))"
344+ ]
482345
483−gitHubThunkSpecV2 :: ThunkSpec
484−gitHubThunkSpecV2 = legacyGitHubThunkSpec "github-v2" $ T.unlines
346+gitHubStandaloneLoaderV2 :: Text
347+gitHubStandaloneLoaderV2 = T.unlines
485348 [ "# DO NOT HAND-EDIT THIS FILE" --TODO: Add something about how to get more info on Obelisk, etc.
486349 , "import ((import <nixpkgs> {}).fetchFromGitHub ("
487350 , " let json = builtins.fromJSON (builtins.readFile ./github.json);"
@@ -491,701 +354,287 @@ gitHubThunkSpecV2 = legacyGitHubThunkSpec "github-v2" $ T.unlines
491354 , "))"
492355 ]
493356
494−gitHubThunkSpecV3 :: ThunkSpec
495−gitHubThunkSpecV3 = legacyGitHubThunkSpec "github-v3" $ T.unlines
496− [ "# DO NOT HAND-EDIT THIS FILE"
497− , "let"
498− , " fetch = { private ? false, ... }@args: if private && builtins.hasAttr \"fetchGit\" builtins"
499− , " then fetchFromGitHubPrivate args"
500− , " else (import <nixpkgs> {}).fetchFromGitHub (builtins.removeAttrs args [\"branch\"]);"
501− , " fetchFromGitHubPrivate ="
502− , " { owner, repo, rev, branch ? null, name ? null, sha256 ? null, private ? false"
503− , " , fetchSubmodules ? false, githubBase ? \"github.com\", ..."
504− , " }: assert !fetchSubmodules;"
505− , " builtins.fetchGit ({"
506− , " url = \"ssh://git@${githubBase}/${owner}/${repo}.git\";"
507− , " inherit rev;"
508− , " }"
509− , " // (if branch == null then {} else { ref = branch; })"
510− , " // (if name == null then {} else { inherit name; }));"
511− , "in import (fetch (builtins.fromJSON (builtins.readFile ./github.json)))"
512− ]
513−
514−gitHubThunkSpecV4 :: ThunkSpec
515−gitHubThunkSpecV4 = legacyGitHubThunkSpec "github-v4" $ T.unlines
516− [ "# DO NOT HAND-EDIT THIS FILE"
517− , "let fetch = { private ? false, fetchSubmodules ? false, owner, repo, rev, sha256, ... }:"
518− , " if !fetchSubmodules && !private then builtins.fetchTarball {"
519− , " url = \"https://github.com/${owner}/${repo}/archive/${rev}.tar.gz\"; inherit sha256;"
520− , " } else (import <nixpkgs> {}).fetchFromGitHub {"
521− , " inherit owner repo rev sha256 fetchSubmodules private;"
522− , " };"
523− , "in import (fetch (builtins.fromJSON (builtins.readFile ./github.json)))"
524− ]
525−
526−legacyGitHubThunkSpec :: Text -> Text -> ThunkSpec
527−legacyGitHubThunkSpec name loader = ThunkSpec name $ Map.fromList
528− [ ("default.nix", ThunkFileSpec_FileMatches $ T.strip loader)
529− , ("github.json" , ThunkFileSpec_Ptr parseGitHubJsonBytes)
530− , (attrCacheFileName, ThunkFileSpec_AttrCache)
531− , (".git", ThunkFileSpec_CheckoutIndicator)
532− ]
533−
534−gitHubThunkSpecV5 :: ThunkSpec
535−gitHubThunkSpecV5 = mkThunkSpec "github-v5" "github.json" parseGitHubJsonBytes [here|
536−# DO NOT HAND-EDIT THIS FILE
537−let fetch = { private ? false, fetchSubmodules ? false, owner, repo, rev, sha256, ... }:
538− if !fetchSubmodules && !private then builtins.fetchTarball {
539− url = "https://github.com/${owner}/${repo}/archive/${rev}.tar.gz"; inherit sha256;
540− } else (import <nixpkgs> {}).fetchFromGitHub {
541− inherit owner repo rev sha256 fetchSubmodules private;
542− };
543− json = builtins.fromJSON (builtins.readFile ./github.json);
544−in fetch json
545−|]
546−
547−parseGitHubJsonBytes :: LBS.ByteString -> Either String ThunkPtr
548−parseGitHubJsonBytes = parseJsonObject $ parseThunkPtr $ \v ->
549− ThunkSource_GitHub <$> parseGitHubSource v <|> ThunkSource_Git <$> parseGitSource v
550−
551−gitThunkSpecs :: NonEmpty ThunkSpec
552−gitThunkSpecs =
553− gitThunkSpecV5 :|
554− [ gitThunkSpecV4
555− , gitThunkSpecV3
556− , gitThunkSpecV2
557− , gitThunkSpecV1
558− ]
559−
560−gitThunkSpecV1 :: ThunkSpec
561−gitThunkSpecV1 = legacyGitThunkSpec "git-v1" $ T.unlines
562− [ "# DO NOT HAND-EDIT THIS FILE"
563− , "let fetchGit = {url, rev, ref ? null, branch ? null, sha256 ? null, fetchSubmodules ? null}:"
564− , " assert !fetchSubmodules; (import <nixpkgs> {}).fetchgit { inherit url rev sha256; };"
565− , "in import (fetchGit (builtins.fromJSON (builtins.readFile ./git.json)))"
566− ]
567−
568−gitThunkSpecV2 :: ThunkSpec
569−gitThunkSpecV2 = legacyGitThunkSpec "git-v2" $ T.unlines
570− [ "# DO NOT HAND-EDIT THIS FILE"
571− , "let fetchGit = {url, rev, ref ? null, branch ? null, sha256 ? null, fetchSubmodules ? null}:"
572− , " if builtins.hasAttr \"fetchGit\" builtins"
573− , " then builtins.fetchGit ({ inherit url rev; } // (if branch == null then {} else { ref = branch; }))"
574− , " else abort \"Plain Git repositories are only supported on nix 2.0 or higher.\";"
575− , "in import (fetchGit (builtins.fromJSON (builtins.readFile ./git.json)))"
576− ]
577−
578−-- This loader has a bug because @builtins.fetchGit@ is not given a @ref@
579−-- and will fail to find commits without this because it does shallow clones.
580−gitThunkSpecV3 :: ThunkSpec
581−gitThunkSpecV3 = legacyGitThunkSpec "git-v3" $ T.unlines
582− [ "# DO NOT HAND-EDIT THIS FILE"
583− , "let fetch = {url, rev, ref ? null, sha256 ? null, fetchSubmodules ? false, private ? false, ...}:"
584− , " let realUrl = let firstChar = builtins.substring 0 1 url; in"
585− , " if firstChar == \"/\" then /. + url"
586− , " else if firstChar == \".\" then ./. + url"
587− , " else url;"
588− , " in if !fetchSubmodules && private then builtins.fetchGit {"
589− , " url = realUrl; inherit rev;"
590− , " } else (import <nixpkgs> {}).fetchgit {"
591− , " url = realUrl; inherit rev sha256;"
592− , " };"
593− , "in import (fetch (builtins.fromJSON (builtins.readFile ./git.json)))"
594− ]
595−
596−gitThunkSpecV4 :: ThunkSpec
597−gitThunkSpecV4 = legacyGitThunkSpec "git-v4" $ T.unlines
598− [ "# DO NOT HAND-EDIT THIS FILE"
599− , "let fetch = {url, rev, branch ? null, sha256 ? null, fetchSubmodules ? false, private ? false, ...}:"
600− , " let realUrl = let firstChar = builtins.substring 0 1 url; in"
601− , " if firstChar == \"/\" then /. + url"
602− , " else if firstChar == \".\" then ./. + url"
603− , " else url;"
604− , " in if !fetchSubmodules && private then builtins.fetchGit {"
605− , " url = realUrl; inherit rev;"
606− , " ${if branch == null then null else \"ref\"} = branch;"
607− , " } else (import <nixpkgs> {}).fetchgit {"
608− , " url = realUrl; inherit rev sha256;"
609− , " };"
610− , "in import (fetch (builtins.fromJSON (builtins.readFile ./git.json)))"
357+plainGitStandaloneLoaders :: NonEmpty Text
358+plainGitStandaloneLoaders =
359+ plainGitStandaloneLoaderV1 :|
360+ [
611361 ]
612362
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)
363+plainGitStandaloneLoaderV1 :: Text
364+plainGitStandaloneLoaderV1 = T.unlines
365+ [ $notImplemented
619366 ]
620367
621−gitThunkSpecV5 :: ThunkSpec
622−gitThunkSpecV5 = mkThunkSpec "git-v5" "git.json" parseGitJsonBytes [here|
623−# DO NOT HAND-EDIT THIS FILE
624−let fetch = {url, rev, branch ? null, sha256 ? null, fetchSubmodules ? false, private ? false, ...}:
625− let realUrl = let firstChar = builtins.substring 0 1 url; in
626− if firstChar == "/" then /. + url
627− else if firstChar == "." then ./. + url
628− else url;
629− in if !fetchSubmodules && private then builtins.fetchGit {
630− url = realUrl; inherit rev;
631− ${if branch == null then null else "ref"} = branch;
632− } else (import <nixpkgs> {}).fetchgit {
633− url = realUrl; inherit rev sha256;
634− };
635− json = builtins.fromJSON (builtins.readFile ./git.json);
636−in fetch json
637−|]
638−
639−parseGitJsonBytes :: LBS.ByteString -> Either String ThunkPtr
640−parseGitJsonBytes = parseJsonObject $ parseThunkPtr $ fmap ThunkSource_Git . parseGitSource
641−
642−mkThunkSpec :: Text -> FilePath -> (LBS.ByteString -> Either String ThunkPtr) -> Text -> ThunkSpec
643−mkThunkSpec name jsonFileName parser srcNix = ThunkSpec name $ Map.fromList
644− [ ("default.nix", ThunkFileSpec_FileMatches defaultNixViaSrc)
645− , ("thunk.nix", ThunkFileSpec_FileMatches srcNix)
646− , (jsonFileName, ThunkFileSpec_Ptr parser)
647− , (attrCacheFileName, ThunkFileSpec_AttrCache)
648− , (normalise $ unpackedDirName </> ".git", ThunkFileSpec_CheckoutIndicator)
649− ]
650− where
651− defaultNixViaSrc = [here|
652−# DO NOT HAND-EDIT THIS FILE
653−import (import ./thunk.nix)
654−|]
655−
656−
657−parseJsonObject :: (Aeson.Object -> Aeson.Parser a) -> LBS.ByteString -> Either String a
658−parseJsonObject p bytes = Aeson.parseEither p =<< Aeson.eitherDecode bytes
368+-- | Look for authentication info from the 'hub' command
369+getHubAuth
370+ :: Text -- ^ Domain name
371+ -> IO (Maybe Auth)
372+getHubAuth domain = do
373+ hubConfig <- getXdgDirectory XdgConfig "hub"
374+ Yaml.decodeFile hubConfig >>= \case
375+ Nothing -> return Nothing
376+ Just v -> return $ flip parseMaybe v $ \v' -> do
377+ Yaml.Array domainConfigs <- v' .: domain --TODO: Determine what multiple domainConfigs means
378+ [Yaml.Object domainConfig] <- return $ toList domainConfigs
379+ token <- domainConfig .: "oauth_token"
380+ return $ OAuth $ encodeUtf8 token
381+
382+--TODO: when checking something out, make a shallow clone
659383
660384-- | Checks a cache directory to see if there is a fresh symlink
661385-- to the result of building an attribute of a thunk.
662386-- If no cache hit is found, nix-build is called to build the attribute
663387-- and the result is symlinked into the cache.
664−nixBuildThunkAttrWithCache
665− :: MonadObelisk m
666− => ThunkSpec
667− -> FilePath
668− -- ^ Path to directory containing Thunk
669− -> String
670− -- ^ Attribute to build
671− -> m (Maybe FilePath)
672− -- ^ Symlink to cached or built nix output
388+nixBuildThunkAttrWithCache :: FilePath
389+ -- ^ Path to directory containing Thunk
390+ -> String
391+ -- ^ Attribute to build
392+ -> IO FilePath
393+ -- ^ Symlink to cached or built nix output
673394-- WARNING: If the thunk uses an impure reference such as '<nixpkgs>'
674395-- the caching mechanism will fail as it merely measures the modification
675396-- time of the cache link and the expression to build.
676−nixBuildThunkAttrWithCache thunkSpec thunkDir attr = do
677− latestChange <- liftIO $ do
678− let
679− getModificationTimeMaybe = fmap rightToMaybe . try @IOError . getModificationTime
680− thunkFileNames = Map.keys $ _thunkSpec_files thunkSpec
681− maximum . catMaybes <$> traverse (getModificationTimeMaybe . (thunkDir </>)) thunkFileNames
682−
683− let cachePaths' = nonEmpty $ Map.keys $ Map.filter (\case ThunkFileSpec_AttrCache -> True; _ -> False) $
684− _thunkSpec_files thunkSpec
685− for cachePaths' $ \cachePaths ->
686− fmap NonEmpty.head $ for cachePaths $ \cacheDir -> do
687− let
688− cachePath = thunkDir </> cacheDir </> attr <.> "out"
689− cacheErrHandler e
690− | isDoesNotExistError e = pure Nothing -- expected from a cache miss
691− | otherwise = Nothing <$ putLog Error (T.pack $ displayException e)
692− cacheHit <- handle cacheErrHandler $ do
693− cacheTime <- liftIO $ posixSecondsToUTCTime . realToFrac . modificationTime <$> getSymbolicLinkStatus cachePath
694− pure $ if latestChange <= cacheTime
695− then Just cachePath
696− else Nothing
697− case cacheHit of
698− Just c -> pure c
699− Nothing -> do
700− putLog Warning $ T.pack $ mconcat [thunkDir, ": ", attr, " not cached, building ..."]
701− liftIO $ createDirectoryIfMissing True (takeDirectory cachePath)
702− (cachePath <$) $ nixCmd $ NixCmd_Build $ def
703− & nixBuildConfig_outLink .~ OutLink_IndirectRoot cachePath
704− & nixCmdConfig_target .~ Target
705− { _target_path = Just thunkDir
706− , _target_attr = Just attr
707− , _target_expr = Nothing
708− }
397+nixBuildThunkAttrWithCache thunkDir attr = do
398+ --NB: Expects thunkDir to be normalised with no trailing path separator.
399+ --This should be guaranteed by the command argument parser.
400+ let cacheErrHandler e
401+ | isDoesNotExistError e = return Nothing -- expected from a cache miss
402+ | otherwise = hPutStrLn stderr (displayException e) >> return Nothing
403+ cacheDir = thunkDir </> ".attr-cache"
404+ cachePath = cacheDir </> attr <.> "out"
405+ createDirectoryIfMissing False cacheDir
406+ latestChange <- maximum <$> mapM (getModificationTime . (thunkDir </>)) ["default.nix", "github.json"]
407+ cacheHit <- handle cacheErrHandler $ do
408+ cacheTime <- posixSecondsToUTCTime . realToFrac . modificationTime <$> getSymbolicLinkStatus cachePath
409+ return $ if latestChange <= cacheTime
410+ then Just cachePath
411+ else Nothing
412+ case cacheHit of
413+ Just c -> return c
414+ Nothing -> do
415+ hPutStrLn stderr (mconcat [thunkDir, ": ", attr, " not cached, building ..."])
416+ _ <- nixBuild $ def
417+ { _nixBuildConfig_target = Target
418+ { _target_path = thunkDir
419+ , _target_attr = Just attr
420+ }
421+ , _nixBuildConfig_outLink = OutLink_IndirectRoot cachePath
422+ }
423+ return cachePath
709424
710425-- | Build a nix attribute, and cache the result if possible
711−nixBuildAttrWithCache
712− :: MonadObelisk m
713− => FilePath
714− -- ^ Path to directory containing Thunk
715− -> String
716− -- ^ Attribute to build
717− -> m FilePath
718− -- ^ Symlink to cached or built nix output
719−nixBuildAttrWithCache exprPath attr = readThunk exprPath >>= \case
720− -- Only packed thunks are cached. In particular, checkouts are not.
721− Right (ThunkData_Packed spec _) ->
722− maybe build pure =<< nixBuildThunkAttrWithCache spec exprPath attr
723− _ -> build
724− where
725− build = nixCmd $ NixCmd_Build $ def
726− & nixBuildConfig_outLink .~ OutLink_None
727− & nixCmdConfig_target .~ Target
728− { _target_path = Just exprPath
426+nixBuildAttrWithCache :: FilePath
427+ -- ^ Path to directory containing Thunk
428+ -> String
429+ -- ^ Attribute to build
430+ -> IO FilePath
431+ -- ^ Symlink to cached or built nix output
432+nixBuildAttrWithCache exprPath attr = do
433+ readThunk exprPath >>= \case
434+ -- Only packed thunks are cached. in particular, checkouts are not
435+ Right (ThunkData_Packed _) -> nixBuildThunkAttrWithCache exprPath attr
436+ _ -> nixBuild $ def
437+ { _nixBuildConfig_target = Target
438+ { _target_path = exprPath
729439 , _target_attr = Just attr
730− , _target_expr = Nothing
731440 }
441+ , _nixBuildConfig_outLink = OutLink_None
442+ }
732443
733−-- | Safely update thunk using a custom action
734−--
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
739−updateThunk p f = withSystemTempDirectory "obelisk-thunkptr-" $ \tmpDir -> do
740− p' <- copyThunkToTmp tmpDir p
741− unpackThunk' True p'
742− result <- f p'
743− updateThunkFromTmp p'
744− return result
745− where
746− copyThunkToTmp tmpDir thunkDir = readThunk thunkDir >>= \case
747− Left err -> failWith $ "withThunkUnpacked: " <> 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]
752− return 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]
758−
759−finalMsg :: Bool -> (a -> Text) -> Maybe (a -> Text)
760−finalMsg noTrail s = if noTrail then Nothing else Just s
761−
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}|]
769−
770− -- Don't let thunk commands work when directly given an unpacked repo
771− when (takeFileName thunkDir == unpackedDirName) $
772− readThunk (takeDirectory thunkDir) >>= \case
773− Right _ -> failWith [i|Refusing to perform thunk operation on ${thunkDir} because it is a thunk's unpacked source|]
774− Left _ -> pure ()
775−
776−unpackThunk :: MonadObelisk m => FilePath -> m ()
777−unpackThunk = unpackThunk' False
778−
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}|]
444+unpackThunk :: FilePath
445+ -> IO ()
446+unpackThunk thunkDir = readThunk thunkDir >>= \case
447+ Left err -> fail $ "thunk unpack: " <> show err
782448 --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|]
784− Right (ThunkData_Packed _ tptr) -> do
785− let (thunkParent, thunkName) = splitFileName thunkDir
786− withTempDirectory thunkParent thunkName $ \tmpThunk -> do
787− let
788− gitSrc = thunkSourceToGitSource $ _thunkPtr_source tptr
789− newSpec = case _thunkPtr_source tptr of
790− ThunkSource_GitHub _ -> NonEmpty.head gitHubThunkSpecs
791− ThunkSource_Git _ -> NonEmpty.head gitThunkSpecs
792− withSpinner' ("Fetching thunk " <> T.pack thunkName)
793− (finalMsg noTrail $ const $ "Fetched thunk " <> T.pack thunkName) $ do
794− let unpackedPath = tmpThunk </> unpackedDirName
795− gitCloneForThunkUnpack gitSrc (_thunkRev_commit $ _thunkPtr_rev tptr) unpackedPath
796−
797− let normalizeMore = dropTrailingPathSeparator . normalise
798− when (normalizeMore unpackedPath /= normalizeMore tmpThunk) $ -- Only write meta data if the checkout is not inplace
799− createThunk tmpThunk $ Left newSpec
800−
801− liftIO $ do
802− removePathForcibly thunkDir
803− renameDirectory tmpThunk thunkDir
804−
805−gitCloneForThunkUnpack
806− :: MonadObelisk m
807− => GitSource -- ^ Git source to use
808− -> Ref hash -- ^ Commit hash to reset to
809− -> FilePath -- ^ Directory to clone into
810− -> m ()
811−gitCloneForThunkUnpack gitSrc commit dir = do
812− let git = callProcessAndLogOutput (Notice, Notice) . gitProc dir
813− git $ [ "clone" ]
814− ++ ["--recursive" | _gitSource_fetchSubmodules gitSrc]
815− ++ [ T.unpack $ gitUriToText $ _gitSource_url gitSrc ]
816− ++ do branch <- maybeToList $ _gitSource_branch gitSrc
817− [ "--branch", T.unpack $ untagName branch ]
818− git ["reset", "--hard", Ref.toHexString commit]
819− when (_gitSource_fetchSubmodules gitSrc) $
820− git ["submodule", "update", "--recursive", "--init"]
821−
822−--TODO: add a rollback mode to pack to the original thunk
823−packThunk :: MonadObelisk m => ThunkPackConfig -> FilePath -> m ThunkPtr
824−packThunk = packThunk' False
825−
826−packThunk' :: MonadObelisk m => Bool -> ThunkPackConfig -> FilePath -> m ThunkPtr
827−packThunk' noTrail (ThunkPackConfig force thunkConfig) thunkDir = checkThunkDirectory thunkDir *> readThunk thunkDir >>= \case
828− Right ThunkData_Packed{} -> failWith [i|Thunk at ${thunkDir} is is already packed|]
829− _ -> withSpinner'
830− ("Packing thunk " <> T.pack thunkDir)
831− (finalMsg noTrail $ const $ "Packed thunk " <> T.pack thunkDir) $
832− do
833− let checkClean = if force then CheckClean_NoCheck else CheckClean_FullCheck
834− thunkPtr <- modifyThunkPtrByConfig thunkConfig <$> getThunkPtr checkClean thunkDir (_thunkConfig_private thunkConfig)
835− liftIO $ removePathForcibly thunkDir
836− createThunk thunkDir $ Right thunkPtr
837− pure thunkPtr
838−
839−modifyThunkPtrByConfig :: ThunkConfig -> ThunkPtr -> ThunkPtr
840−modifyThunkPtrByConfig (ThunkConfig markPrivate') ptr = case markPrivate' of
841− Nothing -> ptr
842− Just markPrivate -> ptr { _thunkPtr_source = case _thunkPtr_source ptr of
843− ThunkSource_Git s -> ThunkSource_Git $ s { _gitSource_private = markPrivate }
844− ThunkSource_GitHub s -> ThunkSource_GitHub $ s { _gitHubSource_private = markPrivate }
845− }
846−
847−data CheckClean
848− = CheckClean_FullCheck
849− -- ^ Check that the repo is clean, including .gitignored files
850− | CheckClean_NotIgnored
851− -- ^ Check that the repo is clean, not including .gitignored files
852− | CheckClean_NoCheck
853− -- ^ Don't check that the repo is clean
854−
855−getThunkPtr :: forall m. MonadObelisk m => CheckClean -> FilePath -> Maybe Bool -> m ThunkPtr
856−getThunkPtr gitCheckClean dir mPrivate = do
857− let repoLocations = nubOrd $ map (first normalise)
858− [(".git", "."), (unpackedDirName </> ".git", unpackedDirName)]
859− repoLocation' <- liftIO $ flip findM repoLocations $ doesDirectoryExist . (dir </>) . fst
860− thunkDir <- case repoLocation' of
861− Nothing -> failWith [i|Can't find an unpacked thunk in ${dir}|]
862− Just (_, path) -> pure $ normalise $ dir </> path
863−
864− let (checkClean, checkIgnored) = case gitCheckClean of
865− CheckClean_FullCheck -> (True, True)
866− CheckClean_NotIgnored -> (True, False)
867− CheckClean_NoCheck -> (False, False)
868− when checkClean $ ensureCleanGitRepo thunkDir checkIgnored
869− "thunk pack: thunk checkout contains unsaved modifications"
870−
871− -- Check whether there are any stashes
872− when checkClean $ do
873− stashOutput <- readGitProcess thunkDir ["stash", "list"]
874− unless (T.null stashOutput) $
875− failWith $ T.unlines $
876− [ "thunk pack: thunk checkout has stashes"
877− , "git stash list:"
878− ] ++ T.lines stashOutput
879−
880− -- Get current branch
881− (mCurrentBranch, mCurrentCommit) <- do
882− b <- listToMaybe . T.lines <$> readGitProcess thunkDir ["rev-parse", "--abbrev-ref", "HEAD"]
883− c <- listToMaybe . T.lines <$> readGitProcess thunkDir ["rev-parse", "HEAD"]
884− case b of
885− (Just "HEAD") -> failWith $ T.unlines
886− [ "thunk pack: You are in 'detached HEAD' state."
887− , "If you want to pack at the current ref \
888− \then please create a new branch with 'git checkout -b <new-branch-name>' and push this upstream."
449+ Right (ThunkData_Checkout _) -> fail "thunk unpack: thunk is already unpacked"
450+ Right (ThunkData_Packed tptr) -> case _thunkPtr_source tptr of
451+ ThunkSource_GitHub s | (thunkParent, thunkName) <- splitFileName thunkDir -> withTempDirectory thunkParent thunkName $ \tmpRepo -> do
452+ mauth <- getHubAuth "github.com"
453+ repoResult <- executeRequestMaybe mauth $ repositoryR (_gitHubSource_owner s) (_gitHubSource_repo s)
454+ githubURI <- either throwIO (return . repoSshUrl) repoResult >>= \case
455+ Nothing -> fail "Cannot determine clone URI for thunk source"
456+ Just c -> return $ T.unpack $ getUrl c
457+ callProcess "hub" --TODO: Depend on hub explicitly
458+ [ "clone"
459+ , "-n"
460+ , githubURI
461+ , tmpRepo
889462 ]
890− _ -> return (b, c)
891−
892− -- Get information on all branches and their (optional) designated upstream
893− -- correspondents
894− headDump :: [Text] <- T.lines <$> readGitProcess thunkDir
895− [ "for-each-ref"
896− , "--format=%(refname:short) %(upstream:short) %(upstream:remotename)"
897− , "refs/heads/"
898− ]
899−
900− (headInfo :: Map Text (Maybe (Text, Text)))
901− <- fmap Map.fromList $ forM headDump $ \line -> do
902− (branch : restOfLine) <- pure $ T.words line
903− mUpstream <- case restOfLine of
904− [] -> pure Nothing
905− [u, r] -> pure $ Just (u, r)
906− (_:_) -> failWith "git for-each-ref invalid output"
907− pure (branch, mUpstream)
908−
909− putLog Debug $ "branches: " <> T.pack (show headInfo)
910−
911− let errorMap :: Map Text ()
912− headUpstream :: Map Text (Text, Text)
913− (errorMap, headUpstream) = flip Map.mapEither headInfo $ \case
914− Nothing -> Left ()
915− Just b -> Right b
916−
917− putLog Debug $ "branches with upstream branch set: " <> T.pack (show headUpstream)
918−
919− -- Check that every branch has a remote equivalent
920− when checkClean $ do
921− let untrackedBranches = Map.keys errorMap
922− when (not $ L.null untrackedBranches) $ failWith $ T.unlines $
923− [ "thunk pack: Certain branches in the thunk have no upstream branch \
924− \set. This means we don't know to check whether all your work is \
925− \saved. The offending branches are:"
926− , ""
927− , T.unwords untrackedBranches
928− , ""
929− , "To fix this, you probably want to do:"
930− , ""
931− ] ++
932− ((\branch -> "git push -u origin " <> branch) <$> untrackedBranches) ++
933− [ ""
934− , "These will push the branches to the default remote under the same \
935− \name, and (thanks to the `-u`) remember that choice so you don't \
936− \get this error again."
937− ]
938−
939− -- loosely by https://stackoverflow.com/questions/7773939/show-git-ahead-and-behind-info-for-all-branches-including-remotes
940− stats <- ifor headUpstream $ \branch (upstream, _remote) -> do
941− (stat :: [Text]) <- T.lines <$> readGitProcess thunkDir
942− [ "rev-list", "--left-right"
943− , T.unpack branch <> "..." <> T.unpack upstream
463+ let obGitDir = tmpRepo </> ".git" </> "obelisk"
464+ --If this directory already exists then something is weird and we should fail
465+ createDirectory obGitDir
466+ callProcess "cp"
467+ [ "-r"
468+ , "-T"
469+ , thunkDir </> "."
470+ , obGitDir </> "orig-thunk"
944471 ]
945− let ahead = length $ [ () | Just ('<', _) <- T.uncons <$> stat ]
946− behind = length $ [ () | Just ('>', _) <- T.uncons <$> stat ]
947− pure (upstream, (ahead, behind))
948−
949− -- Those branches which have commits ahead of, i.e. not on, the upstream
950− -- branch. Purely being behind is fine.
951− let nonGood = Map.filter ((/= 0) . fst . snd) stats
472+ let checkoutOptions = concat
473+ [ ["-C", tmpRepo]
474+ , pure "checkout"
475+ , maybe [] (\n -> ["-B", T.unpack (untagName n)]) (_gitHubSource_branch s)
476+ , pure $ Ref.toHexString $ _thunkRev_commit $ _thunkPtr_rev tptr
477+ ]
478+ callProcess "hub" checkoutOptions
479+ callProcess "rm"
480+ [ "-r"
481+ , thunkDir
482+ ]
483+ callProcess "mv"
484+ [ "-T"
485+ , tmpRepo
486+ , thunkDir
487+ ]
488+ return ()
489+ ThunkSource_Git _s -> do
490+ $notImplemented
952491
953− when (not $ Map.null nonGood) $ failWith $ T.unlines $
954− [ "thunk pack: Certain branches in the thunk have commits not yet pushed upstream:"
955− , ""
956− ] ++
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]) ++
959− [ ""
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.)"
492+--TODO: add force mode to pack even if changes are present
493+--TODO: add a rollback mode to pack to the original thunk
494+packThunk :: FilePath
495+ -> String
496+ -> IO ()
497+packThunk thunkDir upstream = readThunk thunkDir >>= \case
498+ Left err -> fail $ "thunk pack: " <> show err
499+ Right (ThunkData_Packed _) -> fail "pack: thunk is already packed"
500+ Right (ThunkData_Checkout _) -> do
501+ --Check whether the working directory is clean
502+ statusOutput <- readProcess "hub"
503+ [ "-C", thunkDir
504+ , "status", "--porcelain", "--ignored" ] ""
505+ diffOutput <- readProcess "hub" [ "-C", thunkDir , "diff" ] ""
506+ case null statusOutput && null diffOutput of
507+ False -> do
508+ statusDebug <- readProcess "hub"
509+ [ "-C", thunkDir, "status", "--ignored" ] ""
510+ fail $ unlines $
511+ [ "thunk pack: thunk checkout contains unsaved modifications"
512+ , "git status:"
513+ ] ++ lines statusDebug
514+ True -> return ()
515+
516+ -- Check whether there are any stashes
517+ stashOutput <- readProcess "hub" [ "-C", thunkDir, "stash", "list" ] ""
518+ case null stashOutput of
519+ False -> do
520+ fail $ unlines $
521+ [ "thunk pack: thunk checkout has stashes"
522+ , "git stash list:"
523+ ] ++ lines stashOutput
524+ True -> return ()
525+
526+ --Check whether all local heads are pushed
527+ repoHeads <- lines <$> readProcess "hub"
528+ [ "-C", thunkDir
529+ , "for-each-ref", "--format=%(refname:short)", "refs/heads/"
530+ ] ""
531+ remotes <- lines <$> readProcess "hub" [ "-C", thunkDir, "remote" ] ""
532+ --Check that the upstream specified actually exists
533+ case L.find (== upstream) remotes of
534+ Nothing -> fail $ "thunk pack: upstream " <> upstream <> " does not exist"
535+ Just _ -> return ()
536+ -- iterate over cartesian product
537+ forM_ repoHeads $ \hd -> do
538+ [localRev] <- lines <$> readProcess "hub" [ "-C", thunkDir, "rev-parse", hd ] ""
539+ forM_ remotes $ \rm -> do
540+ --TODO: The error you get if a branch isn't pushed anywhere could be made more user friendly
541+ [remoteMergeRev] <- lines <$> readProcess "hub"
542+ [ "-C", thunkDir
543+ , "merge-base"
544+ , localRev
545+ , "remotes/" <> rm <> "/" <> hd
546+ ] ""
547+ case remoteMergeRev == localRev of
548+ False -> fail $ mconcat [ "thunk unpack: branch ", hd, " has not been pushed to ", rm ]
549+ True -> return ()
550+
551+ --We assume it's safe to pack the thunk at this point
552+ [remoteUri'] <- lines <$> readProcess "hub"
553+ [ "-C", thunkDir
554+ , "config", "--get", "remote." <> upstream <> ".url"
555+ ] ""
556+
557+ let uriParseFailure = "Could not identify git remote: " <> remoteUri'
558+ mRemoteUri = parseURIReference remoteUri'
559+ <|> parseSshShorthand remoteUri'
560+ thunkPtr <- case mRemoteUri of
561+ Nothing -> fail uriParseFailure
562+ Just remoteUri -> do
563+ refs <- fmap (refsToTuples . words) . lines <$> readProcess "hub"
564+ [ "-C"
565+ , thunkDir
566+ , "show-ref"
567+ , "--head" ] ""
568+ -- safe because exactly one hash is associated with HEAD
569+ let Just currentHead = fst <$> L.find ((== "HEAD") . snd) refs
570+ remoteHeads = Map.fromList $ catMaybes $ fmap
571+ (\(x,y) -> (,) x <$> L.stripPrefix ("refs/remotes/" <> upstream <> "/") y)
572+ refs
573+ localHeads = Map.fromList $ catMaybes $ fmap
574+ (\(x,y) -> (,) x <$> L.stripPrefix "refs/heads/" y)
575+ refs
576+ currentUpstreamBranch = Map.lookup currentHead remoteHeads
577+ <|> Map.lookup currentHead localHeads
578+ if
579+ | isGithubThunk remoteUri -> githubThunkPtr remoteUri currentHead currentUpstreamBranch
580+ | otherwise -> gitThunkPtr remoteUri currentHead currentUpstreamBranch
581+ callProcess "rm"
582+ [ "-rf"
583+ , thunkDir
962584 ]
963−
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."
967−
968− let remote = maybe "origin" snd $ flip Map.lookup headUpstream =<< mCurrentBranch
969−
970− [remoteUri'] <- fmap T.lines $ readGitProcess thunkDir
971− [ "config"
972− , "--get"
973− , "remote." <> T.unpack remote <> ".url"
974− ]
975−
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
980−
981−-- | Get the latest revision available from the given source
982−getLatestRev :: MonadObelisk m => ThunkSource -> m ThunkRev
983−getLatestRev os = do
984− let gitS = thunkSourceToGitSource os
985− (_, commit) <- gitGetCommitBranch (_gitSource_url gitS) (untagName <$> _gitSource_branch gitS)
986− case os of
987− ThunkSource_GitHub s -> githubThunkRev s commit
988− ThunkSource_Git s -> gitThunkRev s commit
989−
990−-- | Convert a URI to a thunk
991−--
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
1004− case rev of
1005− Right r -> pure (ThunkSource_GitHub s, r)
1006− Left e -> do
1007− putLog Warning "\
1008−\Failed to fetch archive from GitHub. This is probably a private repo. \
1009−\Falling back on normal fetchgit. Original failure:"
1010− errorToWarning e
1011− let s' = forgetGithub True s
1012− (,) (ThunkSource_Git s') <$> gitThunkRev s' commit
1013− ThunkSource_Git s -> (,) (ThunkSource_Git s) <$> gitThunkRev s commit
1014− pure $ ThunkPtr
1015− { _thunkPtr_rev = rev
1016− , _thunkPtr_source = src
1017− }
1018−
1019−-- | N.B. Cannot infer all fields.
1020−--
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
1028− , case scheme of
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
1033− }
1034− s -> s `L.elem` [ "git", "https", "http" ] -- "http:" just redirects to "https:"
1035− && URI.unRText (URI.authHost uriAuth) == "github.com"
1036− , Just (_, owner :| [repoish]) <- URI.uriPath u
1037− = \mbranch -> do
1038− isPrivate <- getIsPrivate
1039− pure $ ThunkSource_GitHub $ GitHubSource
1040− { _gitHubSource_owner = N $ URI.unRText owner
1041− , _gitHubSource_repo = N $ let
1042− repoish' = URI.unRText repoish
1043− in fromMaybe repoish' $ T.stripSuffix ".git" repoish'
1044− , _gitHubSource_branch = N <$> mbranch
1045− , _gitHubSource_private = isPrivate
585+ createThunk thunkDir thunkPtr
586+ return ()
587+ where
588+ refsToTuples [x, y] = (x, y)
589+ refsToTuples x = error $ "thunk pack: cannot parse ref " <> show x
590+ isGithubThunk u
591+ | Just uriAuth <- uriAuthority u
592+ = case uriScheme u of
593+ "ssh:" -> uriAuth == URIAuth "git@" "github.com" ""
594+ s -> s `L.elem` [ "git:", "https:", "http:" ] -- "http:" just redirects to "https:"
595+ && uriRegName uriAuth == "github.com"
596+ | otherwise = False
597+ githubThunkPtr u commit' branch' = do
598+ ["/", owner', repo'] <- return $ splitDirectories (uriPath u)
599+ let owner = N (T.pack owner')
600+ repo = N (T.pack (dropExtension repo'))
601+ commit = N (T.pack commit')
602+ branch = N . T.pack <$> branch'
603+ mauth <- getHubAuth "github.com"
604+ repoResult <- executeRequestMaybe mauth $ repositoryR owner repo
605+ repoIsPrivate <- either throwIO (return . repoPrivate) repoResult
606+ archiveResult <- executeRequestMaybe mauth $
607+ archiveForR owner repo ArchiveFormatTarball (Just (untagName commit))
608+ archiveUri <- either throwIO return archiveResult
609+ hash <- getNixSha256ForUriUnpacked archiveUri
610+ return $ ThunkPtr
611+ { _thunkPtr_rev = ThunkRev
612+ { _thunkRev_commit = commitNameToRef commit
613+ , _thunkRev_nixSha256 = hash
1046614 }
1047−
1048− | otherwise = \mbranch -> do
1049− isPrivate <- getIsPrivate
1050− pure $ ThunkSource_Git $ GitSource
1051− { _gitSource_url = GitUri u
1052− , _gitSource_branch = N <$> mbranch
1053− , _gitSource_fetchSubmodules = False -- TODO: How do we determine if this should be true?
1054− , _gitSource_private = isPrivate
615+ , _thunkPtr_source = ThunkSource_GitHub $ GitHubSource
616+ { _gitHubSource_owner = owner
617+ , _gitHubSource_repo = repo
618+ , _gitHubSource_branch = branch
619+ , _gitHubSource_private = repoIsPrivate
1055620 }
1056− where
1057− getIsPrivate = maybe (guessGitRepoIsPrivate $ GitUri u) pure mPrivate
1058−
1059−guessGitRepoIsPrivate :: MonadObelisk m => GitUri -> m Bool
1060−guessGitRepoIsPrivate uri = flip fix urisToTry $ \loop -> \case
1061− [] -> pure True
1062− uriAttempt:xs -> do
1063− result <- readCreateProcessWithExitCode $
1064− isolateGitProc $
1065− gitProcNoRepo
1066− [ "ls-remote"
1067− , "--quiet"
1068− , "--exit-code"
1069− , "--symref"
1070− , T.unpack $ gitUriToText uriAttempt
1071− ]
1072− case result of
1073− (ExitSuccess, _, _) -> pure False -- Must be a public repo
1074− _ -> loop xs
1075− where
1076− urisToTry = nubOrd $
1077− -- Include the original URI if it isn't using SSH because SSH will certainly fail.
1078− [uri | fmap URI.unRText (URI.uriScheme (unGitUri uri)) /= Just "ssh"] <>
1079− [changeScheme "https" uri, changeScheme "http" uri]
1080− changeScheme scheme (GitUri u) = GitUri $ u
1081− { URI.uriScheme = URI.mkScheme scheme
1082− , URI.uriAuthority = (\x -> x { URI.authUserInfo = Nothing }) <$> URI.uriAuthority u
1083621 }
1084−
1085−-- Funny signature indicates no effects depend on the optional branch name.
1086−githubThunkRev
1087− :: forall m
1088− . MonadObelisk m
1089− => GitHubSource
1090− -> Text
1091− -> m ThunkRev
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
1102− }
1103− , URI.uriPath = Just ( False
1104− , owner :| [ repo, fromRight' $ URI.mkPathPiece "archive", revTarball ]
1105− )
1106− , URI.uriQuery = []
1107− , URI.uriFragment = Nothing
1108− }
1109− hash <- getNixSha256ForUriUnpacked archiveUri
1110− putLog Debug $ "Nix sha256 is " <> hash
1111− return $ ThunkRev
1112− { _thunkRev_commit = commitNameToRef $ N commit
1113− , _thunkRev_nixSha256 = hash
1114− }
1115− where
1116− forcePP :: Name entity -> m (URI.RText 'URI.PathPiece)
1117− forcePP = URI.mkPathPiece . untagName
1118−
1119−gitThunkRev
1120− :: MonadObelisk m
1121− => GitSource
1122− -> Text
1123− -> m ThunkRev
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
1133− pure $ ThunkRev
1134− { _thunkRev_commit = commitNameToRef (N commit)
1135− , _thunkRev_nixSha256 = hash
1136− }
1137−
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.
1140−--
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.
1143−
1144−gitGetCommitBranch
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)
1150− Nothing
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
1155− pure b
1156− Just b -> pure 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)
1162− where
1163− rethrowE = either failWith pure
1164− uriMsg = gitUriToText uri
1165−
1166−parseGitUri :: Text -> Maybe GitUri
1167−parseGitUri x = GitUri <$> (parseFileURI x <|> parseAbsoluteURI x <|> parseSshShorthand x)
1168−
1169−parseFileURI :: Text -> Maybe URI.URI
1170−parseFileURI uri = if "/" `T.isPrefixOf` uri then parseAbsoluteURI ("file://" <> uri) else Nothing
1171−
1172−parseAbsoluteURI :: Text -> Maybe URI.URI
1173−parseAbsoluteURI uri = do
1174− parsedUri <- URI.mkURI uri
1175− guard $ URI.isPathAbsolute parsedUri
1176− pure parsedUri
1177−
1178−parseSshShorthand :: Text -> Maybe URI.URI
1179−parseSshShorthand uri = do
1180− -- This is what git does to check that the remote
1181− -- is not a local file path when parsing shorthand.
1182− -- Last referenced from here:
1183− -- https://github.com/git/git/blob/95ec6b1b3393eb6e26da40c565520a8db9796e9f/connect.c#L712
1184− let
1185− (authAndHostname, colonAndPath) = T.break (== ':') uri
1186− properUri = "ssh://" <> authAndHostname <> "/" <> T.drop 1 colonAndPath
1187− -- Shorthand is valid iff a colon is present and it occurs before the first slash
1188− -- This check is used to disambiguate a filepath containing a colon from shorthand
1189− guard $ isNothing (T.findIndex (=='/') authAndHostname)
1190− && not (T.null colonAndPath)
1191− URI.mkURI properUri
622+ gitThunkPtr u _commit' _branch' = do
623+ case uriScheme u of
624+ "https:" -> return ()
625+ "git:" -> return ()
626+ _ -> fail $ "thunk pack: obelisk currently only supports https and git protocols for non-GitHub remotes"
627+ $notImplemented
628+ parseSshShorthand uri' = do
629+ -- This is what git does to check that the remote
630+ -- is not a local file path when parsing shorthand.
631+ -- Last referenced from here:
632+ -- https://github.com/git/git/blob/95ec6b1b3393eb6e26da40c565520a8db9796e9f/connect.c#L712
633+ let uri = T.pack uri'
634+ (authAndHostname, colonAndPath) = T.break (== ':') uri
635+ properUri = "ssh://" <> authAndHostname <> "/" <> T.drop 1 colonAndPath
636+ -- Shorthand is valid iff a colon is present and it occurs before the first slash
637+ -- This check is used to disambiguate a filepath containing a colon from shorthand
638+ guard $ isNothing (T.findIndex (=='/') authAndHostname)
639+ && not (T.null colonAndPath)
640+ parseURI $ T.unpack properUri