aboutsummaryrefslogtreecommitdiffstats
path: root/app/History.hs
blob: a3cdf75fc8ed99fca4c21e3e1cb528da2f94b532 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
{-# LANGUAGE OverloadedRecordDot #-}
{-# LANGUAGE OverloadedStrings #-}

module History (getIssues, listIssues) where

import Control.Exception (Exception, catch, handle, throw)
import Data.Aeson (eitherDecode)
import Data.Binary (Binary, decodeFile, encodeFile)
import Data.ByteString.Lazy.Char8 qualified as L8
import Data.Function ((&))
import Data.List (intercalate)
import Data.Maybe (catMaybes, mapMaybe)
import Data.String (fromString)
import Data.Text (Text, lines, unpack)
import Data.Text.Encoding (decodeUtf8)
import Issue (Issue (..), fromMatch, id)
import Issue.Filter (Filter, applyFilter)
import Parallel (parMapM)
import Process (quote, sh, sh_)
import System.Directory (createDirectoryIfMissing, doesFileExist, getCurrentDirectory)
import System.Exit (ExitCode (ExitFailure), exitWith)
import System.FilePath (takeExtension, (</>))
import System.IO.Temp (withSystemTempDirectory)
import System.Process.Typed (setWorkingDir)
import Text.Printf (printf)
import TreeGrepper.Match qualified as G
import TreeGrepper.Result qualified as G
import Prelude hiding (id, lines)
import Prelude qualified as Prelude

listIssues :: [Filter] -> [FilePath] -> IO [Issue]
listIssues filters paths = do
  commitHashes <- getCommitHashes
  issuesWorkingTreeAll <- getIssuesWorkingTreeAll paths
  historicalIssues <- fmap concat $ parMapM (\hash -> cached hash (\_ -> getIssuesCommitChanged hash)) commitHashes
  let currentIssuesFiltered = filter (applyFilter filters) issuesWorkingTreeAll
  pure $ map (fixProvenance historicalIssues) currentIssuesFiltered

getCommitHashes :: IO [Text]
getCommitHashes =
  fmap (lines . decodeUtf8 . L8.toStrict) $ sh "git log --format=%H"

fixProvenance :: [Issue] -> Issue -> Issue
fixProvenance historicalIssues =
  merge . pick historicalIssues

pick :: [Issue] -> Issue -> (Issue, [Issue])
pick issues issue =
  (issue, filter (isSameIssue) issues)
  where
    isSameIssue otherIssue =
      id otherIssue == id issue

merge :: (Issue, [Issue]) -> Issue
merge (issue, issues) =
  case (mapMaybe provenance (reverse issues)) of
    [] ->
      issue
    provenance : _ ->
      issue {provenance = Just provenance}

-- | Gets issues in all files in your current [working
-- - tree](https://git-scm.com/docs/gitglossary#Documentation/gitglossary.txt-aiddefworkingtreeaworkingtree)
getIssuesWorkingTreeAll :: [FilePath] -> IO [Issue]
getIssuesWorkingTreeAll paths = do
  cwd <- getCurrentDirectory
  files <- getFilesAllIn cwd paths
  concat <$> catch (getIssuesPar cwd files) dieOfInvalidTreeGrepperResult

-- | Given the hash of a commit, get all issues in all files at the
-- [tree](https://git-scm.com/docs/gitglossary#Documentation/gitglossary.txt-aiddeftreeatree)
-- of this commit.
getIssuesCommitAll :: Text -> IO [Issue]
getIssuesCommitAll hash = do
  withSystemTempDirectory "history" $ \tmp -> do
    cwd <- do
      let cwd = tmp </> unpack hash
      sh_ $ fromString $ printf "git worktree add --detach %s %s" (quote cwd) (quote $ unpack hash)
      pure cwd
    files <- getFilesAll cwd
    concat <$> catch (getIssuesPar cwd files) (dieOfInvalidTreeGrepperResult)

-- | Given the hash of a commit, get all issues in the files which have
-- been changed by this commit.
getIssuesCommitChanged :: Text -> IO [Issue]
getIssuesCommitChanged hash = do
  withSystemTempDirectory "history" $ \tmp -> do
    cwd <- do
      let cwd = tmp </> unpack hash
      sh_ $ fromString $ printf "git worktree add --detach %s %s" (quote cwd) (quote $ unpack hash)
      pure cwd
    files <- getFilesChanged cwd
    concat <$> catch (getIssuesPar cwd files) (dieOfInvalidTreeGrepperResult)

getFilesAll :: FilePath -> IO [FilePath]
getFilesAll cwd =
  Prelude.lines . L8.unpack
    <$> sh ("git ls-files --cached --exclude-standard --other" & setWorkingDir cwd)

getFilesAllIn :: FilePath -> [String] -> IO [FilePath]
getFilesAllIn cwd paths =
  Prelude.lines . L8.unpack
    <$> sh
      ( fromString
          ( (printf "git ls-files --cached --exclude-standard --other%s")
              ( case paths of
                  [] -> ""
                  _ -> " -- " ++ intercalate " " (map quote paths)
              )
          )
          & setWorkingDir cwd
      )

getFilesChanged :: FilePath -> IO [FilePath]
getFilesChanged cwd =
  Prelude.lines . L8.unpack
    <$> sh ("git show -p --name-only --format=''" & setWorkingDir cwd)

-- | Get all issues in the given directory and files.  Runs
-- parallelized.
getIssuesPar :: FilePath -> [FilePath] -> IO [[Issue]]
getIssuesPar cwd files =
  parMapM (handle forgetGetIssuesExceptions . getIssues cwd) files

data UnknownFileExtension = UnknownFileExtension
  { extension :: String
  }
  deriving (Show)

instance Exception UnknownFileExtension

forgetGetIssuesExceptions :: UnknownFileExtension -> IO [a]
forgetGetIssuesExceptions _ = pure []

data InvalidTreeGrepperResult = InvalidTreeGrepperResult
  { error :: String
  }
  deriving (Show)

instance Exception InvalidTreeGrepperResult

dieOfInvalidTreeGrepperResult :: InvalidTreeGrepperResult -> IO a
dieOfInvalidTreeGrepperResult (InvalidTreeGrepperResult e) =
  die e

-- | Get all issues in the given directory and file.
getIssues :: FilePath -> FilePath -> IO [Issue]
getIssues cwd filename = do
  let extension = takeExtension filename
      treeGrepperLanguage =
        -- TODO Add support for all tree-grepper supported files
        --
        -- tree-grepper supported files can be listed through `tree-grepper
        -- --languages`.
        case extension of
          ".elm" -> "elm"
          ".hs" -> "haskell"
          ".nix" -> "nix"
          ".sh" -> "sh"
          _ -> throw (UnknownFileExtension extension)
      treeGrepperQuery =
        case extension of
          ".elm" -> "([(line_comment) (block_comment)])"
          ".hs" -> "(comment)"
          ".nix" -> "(comment)"
          ".sh" -> "(comment)"
          _ -> throw (UnknownFileExtension extension)
      decode raw =
        case eitherDecode raw of
          Left e -> throw (InvalidTreeGrepperResult e)
          Right treeGrepperResult -> treeGrepperResult

  matches <-
    concatMap (\result -> map ((,) result) result.matches)
      . map fixTreeGrepper
      . decode
      <$> sh
        ( fromString
            ( printf
                "tree-grepper --query %s %s --format json %s"
                (quote treeGrepperLanguage)
                (quote treeGrepperQuery)
                (quote filename)
            )
            & setWorkingDir cwd
        )

  catMaybes <$> mapM (uncurry (fromMatch cwd)) matches

fixTreeGrepper :: G.Result -> G.Result
fixTreeGrepper treeGrepperResult =
  treeGrepperResult {G.matches = G.merge treeGrepperResult.matches}

cached :: Binary a => Text -> (Text -> IO a) -> IO a
cached hash func = do
  cwd <- getCurrentDirectory
  createDirectoryIfMissing True (cwd ++ "/.anissue")
  let file = (cwd ++ "/.anissue/" ++ unpack hash)
  fileExists <- doesFileExist file
  if fileExists
    then decodeFile file
    else do
      blob <- func hash
      encodeFile file blob
      pure blob

die :: String -> IO a
die s = do
  printf "error: %s\n" s
  exitWith (ExitFailure 1)