Use StrictByteString and LazyByteString instead of ByteString in a few modules

Author: Bodigrim

hackage-server.cabal

@@ -149,7 +149,7 @@ common defaults
     , array                  >= 0.5   && < 0.6
     , base                   >= 4.18  && < 4.22
     , binary                 >= 0.8   && < 0.9
-    , bytestring             >= 0.10  && < 0.13
+    , bytestring             >= 0.11.2 && < 0.13
     , containers             >= 0.6.0 && < 0.9
     , deepseq                >= 1.4   && < 1.6
     , directory              >= 1.3   && < 1.4

src/Distribution/Server/Features/Core.hs

@@ -27,7 +27,7 @@ import qualified Codec.Compression.GZip                             as GZip
 import           Data.Aeson                                         (Value (..), toJSON)
 import qualified Data.Aeson.Key                                     as Key
 import qualified Data.Aeson.KeyMap                                  as KeyMap
-import           Data.ByteString.Lazy                               (ByteString)
+import           Data.ByteString.Lazy                               (LazyByteString)
 import qualified Data.Foldable                                      as Foldable
 import qualified Data.Text                                          as Text
 import           Data.Time.Clock                                    (UTCTime, getCurrentTime)
@@ -130,7 +130,7 @@ data CoreFeature = CoreFeature {
     -- modification time for the tar entry.
     --
     -- This runs a `PackageChangeIndexExtra` hook when done.
-    updateArchiveIndexEntry :: forall m. MonadIO m => FilePath -> ByteString -> UTCTime -> m (),
+    updateArchiveIndexEntry :: forall m. MonadIO m => FilePath -> LazyByteString -> UTCTime -> m (),
 
     -- | Notification of package or index changes.
     packageChangeHook :: Hook PackageChange (),
@@ -175,7 +175,7 @@ data PackageChange
     | PackageChangeInfo PackageUpdate PkgInfo PkgInfo
     -- | A file has changed in the package index tar not covered by any of the
     -- other change types.
-    | PackageChangeIndexExtra String ByteString UTCTime
+    | PackageChangeIndexExtra String LazyByteString UTCTime
 
 -- | A predicate to use with `packageChangeHook` and `registerHookJust` for
 -- keeping other features synchronized with the main package index.
@@ -212,7 +212,7 @@ isPackageDeleteVersion             :: Maybe PackageId,
 isPackageChangeCabalFile           :: Maybe (PackageId, CabalFileText),
 isPackageChangeCabalFileUploadInfo :: Maybe (PackageId, UploadInfo),
 isPackageChangeTarball             :: Maybe (PackageId, PkgTarball),
-isPackageIndexExtraChange          :: Maybe (String, ByteString, UTCTime)
+isPackageIndexExtraChange          :: Maybe (String, LazyByteString, UTCTime)
 -}
 
 data CoreResource = CoreResource {
@@ -591,7 +591,7 @@ coreFeature ServerEnv{serverBlobStore = store} UserFeature{..}
           runHook_ packageChangeHook  (PackageChangeInfo PackageUpdatedUploadTime oldpkginfo newpkginfo)
           return True
 
-    updateArchiveIndexEntry :: MonadIO m => FilePath -> ByteString -> UTCTime -> m ()
+    updateArchiveIndexEntry :: MonadIO m => FilePath -> LazyByteString -> UTCTime -> m ()
     updateArchiveIndexEntry entryName entryData entryTime = logTiming maxBound ("updateArchiveIndexEntry " ++ show entryName) $ do
       updateState packagesState $
         AddOtherIndexEntry $ ExtraEntry entryName entryData entryTime

src/Distribution/Server/Features/EditCabalFiles.hs

@@ -23,7 +23,7 @@ import Distribution.Server.Util.CabalRevisions
          (Change(..), diffCabalRevisions, insertRevisionField)
 import Text.StringTemplate.Classes (SElem(SM))
 
-import Data.ByteString.Lazy (ByteString)
+import Data.ByteString.Lazy (LazyByteString)
 import qualified Data.ByteString.Lazy as BS.L
 import qualified Data.Map as Map
 import Data.Time (getCurrentTime)
@@ -126,7 +126,7 @@ editCabalFilesFeature _env templates
                                (look "publish" >> return True)
 
          responseTemplate :: ([TemplateAttr] -> Template) -> PackageId
-                          -> ByteString -> Bool -> [String] -> [Change]
+                          -> LazyByteString -> Bool -> [String] -> [Change]
                           -> ServerPartE Response
          responseTemplate template pkgid cabalFile publish errors changes =
            ok $ toResponse $ template
@@ -139,9 +139,9 @@ editCabalFilesFeature _env templates
 
 
 -- | Wrapper around 'diffCabalRevisions' which operates on
--- 'ByteString' decoded with lenient UTF8 and with any leading BOM
+-- 'LazyByteString' decoded with lenient UTF8 and with any leading BOM
 -- stripped.
-diffCabalRevisionsByteString :: ByteString -> ByteString -> Either String [Change]
+diffCabalRevisionsByteString :: LazyByteString -> LazyByteString -> Either String [Change]
 diffCabalRevisionsByteString oldRevision newRevision =
     maybe (diffCabalRevisions (BS.L.toStrict oldRevision) (BS.L.toStrict newRevision))
           Left

src/Distribution/Server/Features/Html.hs

@@ -68,7 +68,7 @@ import qualified Data.Map as Map
 import qualified Data.Set as Set
 import qualified Data.Vector as Vec
 import qualified Data.Text as T
-import qualified Data.ByteString.Lazy.Char8 as BS (ByteString)
+import qualified Data.ByteString.Lazy as BS (LazyByteString)
 import qualified Network.URI as URI
 
 import Text.XHtml.Strict
@@ -849,7 +849,7 @@ mkHtmlCore ServerEnv{serverBaseURI, serverBlobStore}
 
 
 -- | Common helper used by 'serveCandidatePage' and 'servePackagePage'
-makeReadme :: MonadIO m => PackageRender -> m (Maybe BS.ByteString)
+makeReadme :: MonadIO m => PackageRender -> m (Maybe BS.LazyByteString)
 makeReadme render = case rendReadme render of
   Just (tarfile, _, offset, _) ->
         either (\_err -> return Nothing) (return . Just . snd) =<<

src/Distribution/Server/Features/Upload.hs

@@ -29,7 +29,7 @@ import Data.Maybe (fromMaybe)
 import Data.List (dropWhileEnd, intersperse)
 import Data.Time.Clock (getCurrentTime)
 import Data.Function (fix)
-import Data.ByteString.Lazy (ByteString)
+import Data.ByteString.Lazy (LazyByteString)
 
 import Distribution.Package
 import Distribution.PackageDescription (GenericPackageDescription)
@@ -97,7 +97,7 @@ data UploadResult = UploadResult {
     -- The parsed Cabal file.
     uploadDesc :: !GenericPackageDescription,
     -- The text of the Cabal file.
-    uploadCabal :: !ByteString,
+    uploadCabal :: !LazyByteString,
     -- Any warnings from unpacking the tarball.
     uploadWarnings :: ![String]
 }
@@ -417,7 +417,7 @@ uploadFeature ServerEnv{serverBlobStore = store}
             --FIXME: this should have been covered earlier
             uid <- guardAuthenticated
             now <- liftIO getCurrentTime
-            let processPackage :: ByteString -> IO (Either ErrorResponse (UploadResult, BlobStorage.BlobId))
+            let processPackage :: LazyByteString -> IO (Either ErrorResponse (UploadResult, BlobStorage.BlobId))
                 processPackage content' = do
                     -- as much as it would be nice to do requirePackageAuth in here,
                     -- processPackage is run in a handle bracket

src/Distribution/Server/Packages/Index.hs

@@ -43,7 +43,7 @@ import Data.SafeCopy (base, deriveSafeCopy)
 import Data.Map (Map)
 import qualified Data.Map as Map
 import qualified Data.Vector as Vec
-import Data.ByteString.Lazy (ByteString)
+import Data.ByteString.Lazy (LazyByteString)
 import System.FilePath.Posix
 import Data.Maybe (mapMaybe)
 
@@ -76,7 +76,7 @@ data TarIndexEntry =
     -- | Additional entries that we add to the tarball
     --
     -- This is currently used for @preferred-versions@.
-  | ExtraEntry !FilePath !ByteString !UTCTime
+  | ExtraEntry !FilePath !LazyByteString !UTCTime
   deriving (Eq, Show)
 
 type RevisionNo = Int
@@ -92,7 +92,7 @@ deriveSafeCopy 0 'base ''TarIndexEntry
 -- a package index, an index tarball. This tarball has the modification times
 -- and uploading users built-in.
 
-writeIncremental :: PackageIndex PkgInfo -> [TarIndexEntry] -> ByteString
+writeIncremental :: PackageIndex PkgInfo -> [TarIndexEntry] -> LazyByteString
 writeIncremental pkgs =
     Tar.write . mapMaybe mkTarEntry
   where
@@ -144,14 +144,14 @@ utcToUnixTime :: UTCTime -> Int64
 utcToUnixTime = truncate . utcTimeToPOSIXSeconds
 
 -- | Extract legacy entries
-legacyExtras :: [TarIndexEntry] -> Map String (ByteString, UTCTime)
+legacyExtras :: [TarIndexEntry] -> Map String (LazyByteString, UTCTime)
 legacyExtras = go Map.empty
   where
     -- Later entries in the update log will override earlier ones. This is
     -- intentional.
-    go :: Map String (ByteString, UTCTime)
+    go :: Map String (LazyByteString, UTCTime)
        -> [TarIndexEntry]
-       -> Map String (ByteString, UTCTime)
+       -> Map String (LazyByteString, UTCTime)
     go acc [] = acc
     go acc (ExtraEntry fp bs time : es) =
        let acc' = Map.insert fp (bs, time) acc
@@ -173,7 +173,7 @@ legacyExtras = go Map.empty
 -- compression), contains at most one preferred-version per package (important
 -- because of a bug in cabal which would otherwise merge all preferred-versions
 -- files for a package), and does not contain the TUF files.
-writeLegacy :: Users -> Map String (ByteString, UTCTime) -> PackageIndex PkgInfo -> ByteString
+writeLegacy :: Users -> Map String (LazyByteString, UTCTime) -> PackageIndex PkgInfo -> LazyByteString
 writeLegacy users =
     writeLegacyAux (cabalFileByteString . pkgLatestCabalFileText) setModTime
   . extraEntries
@@ -192,25 +192,25 @@ writeLegacy users =
 
     userName = display . userIdToName users
 
-    extraEntries :: Map FilePath (ByteString, UTCTime) -> [Tar.Entry]
+    extraEntries :: Map FilePath (LazyByteString, UTCTime) -> [Tar.Entry]
     extraEntries emap = do
         (path, (entry, mtime)) <- Map.toList emap
         Right tarPath <- return $ Tar.toTarPath False path
         return $ (Tar.fileEntry tarPath entry) { Tar.entryTime = utcToUnixTime mtime }
 
--- | Create an uncompressed tar repository index file as a 'ByteString'.
+-- | Create an uncompressed tar repository index file as a 'LazyByteString'.
 --
 -- Takes a couple functions to turn a package into a tar entry. Extra
 -- entries are also accepted.
 --
 -- This used to live in Distribution.Server.Util.Index.
 --
 writeLegacyAux :: Package pkg
-               => (pkg -> ByteString)
+               => (pkg -> LazyByteString)
                -> (pkg -> Tar.Entry -> Tar.Entry)
                -> [Tar.Entry]
                -> PackageIndex pkg
-               -> ByteString
+               -> LazyByteString
 writeLegacyAux externalPackageRep updateEntry extras =
   Tar.write . (extras++) . map entry . PackageIndex.allPackages
   where

src/Distribution/Server/Packages/Types.hs

@@ -35,7 +35,7 @@ import Distribution.PackageDescription.Parsec
          ( parseGenericPackageDescription, runParseResult )
 
 import Data.Serialize (Serialize)
-import Data.ByteString.Lazy (ByteString)
+import Data.ByteString.Lazy (LazyByteString)
 import Data.Time.Clock (UTCTime(..))
 import Data.Time.Calendar (Day(..))
 import Data.SafeCopy
@@ -47,7 +47,7 @@ import qualified Data.Vector          as Vec
   Datatypes
 -------------------------------------------------------------------------------}
 
-newtype CabalFileText = CabalFileText { cabalFileByteString :: ByteString }
+newtype CabalFileText = CabalFileText { cabalFileByteString :: LazyByteString }
   deriving (Eq, MemSize)
 
 -- | The information we keep about a particular version of a package.
@@ -227,7 +227,7 @@ pkgDescMaybe pkgInfo =
       (_, Right x)     -> Just x
 
 
-blobInfoFromBS :: BlobId -> ByteString -> BlobInfo
+blobInfoFromBS :: BlobId -> LazyByteString -> BlobInfo
 blobInfoFromBS blobId bs = BlobInfo {
       blobInfoId         = blobId
     , blobInfoLength     = fromIntegral $ BS.L.length bs

src/Distribution/Server/Util/Parse.hs

@@ -6,7 +6,7 @@ module Distribution.Server.Util.Parse (
 import qualified Text.ParserCombinators.ReadP as Parse
 
 import qualified Data.Char as Char
-import Data.ByteString.Lazy (ByteString)
+import Data.ByteString.Lazy (LazyByteString)
 import qualified Data.Text.Lazy           as Text
 import qualified Data.Text.Lazy.Encoding  as Text
 import qualified Data.Text.Encoding.Error as Text
@@ -28,8 +28,8 @@ ignoreBOM :: String -> String
 ignoreBOM ('\xFEFF':string) = string
 ignoreBOM string            = string
 
-unpackUTF8 :: ByteString -> String
+unpackUTF8 :: LazyByteString -> String
 unpackUTF8 = ignoreBOM . Text.unpack . Text.decodeUtf8With Text.lenientDecode
 
-packUTF8 :: String -> ByteString
+packUTF8 :: String -> LazyByteString
 packUTF8 = Text.encodeUtf8 . Text.pack

src/Distribution/Server/Util/ParseSpecVer.hs

@@ -12,7 +12,7 @@ module Distribution.Server.Util.ParseSpecVer
 
 import           Distribution.Server.Prelude
 
-import           Data.ByteString       (ByteString)
+import           Data.ByteString       (StrictByteString)
 import qualified Data.ByteString       as BS
 import qualified Data.ByteString.Char8 as BC8
 import qualified Data.ByteString.Lazy  as BSL
@@ -47,10 +47,10 @@ import           Distribution.PackageDescription.Parsec ( runParseResult, parseG
 -- @.cabal@ files are accepted which support the heuristic parsing.
 --
 -- If no valid version field can be found, @Nothing@ is returned.
-parseSpecVer :: ByteString -> Maybe CabalSpecVersion
+parseSpecVer :: StrictByteString -> Maybe CabalSpecVersion
 parseSpecVer = findCabVer
 
-parseSpecVerLazy :: BSL.ByteString -> Maybe CabalSpecVersion
+parseSpecVerLazy :: BSL.LazyByteString -> Maybe CabalSpecVersion
 parseSpecVerLazy = parseSpecVer . BSL.toStrict
 
 versionToCabalSpecVersion :: Version -> Maybe CabalSpecVersion
@@ -59,11 +59,11 @@ versionToCabalSpecVersion = cabalSpecFromVersionDigits . versionNumbers
 isWS :: Word8 -> Bool
 isWS = (`elem` [0x20,0x09])
 
-eatWS :: ByteString -> ByteString
+eatWS :: StrictByteString -> StrictByteString
 eatWS = BS.dropWhile isWS
 
 -- | Try to heuristically locate & parse a 'cabal-version' field
-findCabVer :: ByteString -> Maybe CabalSpecVersion
+findCabVer :: StrictByteString -> Maybe CabalSpecVersion
 findCabVer raw = msum [ versionToCabalSpecVersion =<< decodeVer y | (_,_,y) <- findCabVers raw ]
 
 -- | Return list of @cabal-version@ candidates as 3-tuples of
@@ -81,7 +81,7 @@ findCabVer raw = msum [ versionToCabalSpecVersion =<< decodeVer y | (_,_,y) <- f
 --
 -- NB: Later occurrences of @cabal-version@ override earlier ones. In
 --     future @cabal-versions@ it will be disallowed.
-findCabVers :: ByteString -> [(ByteString,Int,[ByteString])]
+findCabVers :: StrictByteString -> [(StrictByteString, Int, [StrictByteString])]
 findCabVers buf0 = mapMaybe go ixs
   where
     go i
@@ -105,7 +105,7 @@ findCabVers buf0 = mapMaybe go ixs
                      map getInd l'
 
     -- split off indentation for single line
-    getInd :: ByteString -> (Int,ByteString)
+    getInd :: StrictByteString -> (Int, StrictByteString)
     getInd x = case BS.span isWS x of (i,r) -> (BS.length i,r)
 
     isNonComment = not . BS.isPrefixOf "--"
@@ -114,11 +114,11 @@ findCabVers buf0 = mapMaybe go ixs
     ixs = strCaseStrAll buf0 "cabal-version"
 
 -- | Lookup-table mapping "x.y.z" strings to 'Version'
-verDictV :: Map.HashMap ByteString Version
+verDictV :: Map.HashMap StrictByteString Version
 verDictV = Map.fromList [ (BC8.pack (prettyShow v), v) | v <- knownVers ]
 
 -- | Lookup-table mapping ">=x.y.z" strings to 'Version'
-verDictRg :: Map.HashMap ByteString Version
+verDictRg :: Map.HashMap StrictByteString Version
 verDictRg = Map.fromList [ (">=" <> BC8.pack (prettyShow v), v) | v <- knownVers ]
 
 -- | List of cabal-version values contained in Hackage's package index as of 2017-07
@@ -224,7 +224,7 @@ knownVers = map mkVersion
     ]
 
 -- | Fast decoder
-decodeVer :: [ByteString] -> Maybe Version
+decodeVer :: [StrictByteString] -> Maybe Version
 decodeVer ws = case ws of
   [">=",v] -> Map.lookup v verDictV      -- most common case
   [v]      -> Map.lookup v verDictRg <|> -- most common case
@@ -233,7 +233,7 @@ decodeVer ws = case ws of
   _        -> decodeVerFallback (mconcat ws)
 
 -- | Fallback parser for when lookup-table based parsing fails
-decodeVerFallback :: ByteString -> Maybe Version
+decodeVerFallback :: StrictByteString -> Maybe Version
 decodeVerFallback v0 = simpleParse v <|> parseSpecVR
   where
     parseSpecVR = do
@@ -250,7 +250,7 @@ foreign import ccall unsafe "string.h strcasestr" c_strcasestr :: Ptr CChar -> P
 -- | Find indices (in reverse order) of all non-overlapping
 -- case-insensitive occurrences of s2 in s1
 {-# NOINLINE strCaseStrAll  #-}
-strCaseStrAll :: ByteString -> ByteString -> [Int]
+strCaseStrAll :: StrictByteString -> StrictByteString -> [Int]
 strCaseStrAll s1 s2
     | BS.null s1 || BS.null s2 = []
     | BS.elem 0 s1 || BS.elem 0 s2 = undefined
@@ -286,7 +286,7 @@ scanSpecVersionLazy bs = do
 -- * Starting with cabal-version:2.2 'scanSpecVersionLazy' must succeed
 --
 -- 'True' is returned in the first element if sanity checks passes.
-parseGenericPackageDescriptionChecked :: BSL.ByteString -> (Bool, [PWarning], Either (Maybe Version, [PError]) GenericPackageDescription)
+parseGenericPackageDescriptionChecked :: BSL.LazyByteString -> (Bool, [PWarning], Either (Maybe Version, [PError]) GenericPackageDescription)
 parseGenericPackageDescriptionChecked bs = case parseGenericPackageDescription' bs of
    (warns, Left pe) -> (False, warns, Left $ fmap toList pe)
    (warns, Right gpd) -> (isOk (specVersion (packageDescription gpd)), warns, Right gpd)