Core: Internal: mv Base enc -> Base, Hash.encode(InBase->DigestWith)

Author: Anton-Latukha

hnix-store-core/src/System/Nix/Hash.hs

@@ -14,7 +14,7 @@ module System.Nix.Hash
   , Hash.mkNamedDigest
 
   , Base.BaseEncoding(..)
-  , Hash.encodeInBase
+  , Hash.encodeDigestWith
   , Hash.decodeBase
   )
 where

hnix-store-core/src/System/Nix/Internal/Base.hs

@@ -1,15 +1,28 @@
 module System.Nix.Internal.Base
   ( module System.Nix.Internal.Base
-  , encode
-  , decode
+  , Base32.encode
+  , Base32.decode
   )
 where
 
-import System.Nix.Internal.Base32
+import qualified Data.Text              as T
+import qualified Data.Text.Encoding     as T
+import qualified Data.ByteString        as Bytes
+import qualified Data.ByteString.Base16 as Base16
+import qualified System.Nix.Base32      as Base32  -- Nix has own Base32 encoding
+import qualified Data.ByteString.Base64 as Base64
 
 -- | Constructors to indicate the base encodings
 data BaseEncoding
-  = Base16
-  | NixBase32
+  = NixBase32
   -- | ^ Nix has a special map of Base32 encoding
+  -- Placed first, since it determines Haskell optimizations of pattern matches, & NixBase seems be the most widely used in Nix.
+  | Base16
   | Base64
+
+
+-- | Encode @ByteString@ with @Base@ encoding, produce @Text@.
+encodeWith :: BaseEncoding -> Bytes.ByteString -> T.Text
+encodeWith Base16 = T.decodeUtf8 . Base16.encode
+encodeWith NixBase32 = Base32.encode
+encodeWith Base64 = T.decodeUtf8 . Base64.encode

hnix-store-core/src/System/Nix/Internal/Hash.hs

@@ -35,7 +35,9 @@ import qualified GHC.TypeLits           as Kind
                                         (Nat, KnownNat, natVal)
 import           Data.Coerce            (coerce)
 import           System.Nix.Internal.Base
-                                        (BaseEncoding(Base16,NixBase32,Base64))
+                                        ( BaseEncoding(Base16,NixBase32,Base64)
+                                        , encodeWith
+                                        )
 
 -- | The universe of supported hash algorithms.
 --
@@ -55,7 +57,7 @@ newtype Digest (a :: HashAlgorithm) =
   Digest BS.ByteString deriving (Eq, Ord, DataHashable.Hashable)
 
 instance Show (Digest a) where
-  show = ("Digest " <>) . show . encodeInBase NixBase32
+  show = ("Digest " <>) . show . encodeDigestWith NixBase32
 
 -- | The primitive interface for incremental hashing for a given
 -- 'HashAlgorithm'. Every 'HashAlgorithm' should have an instance.
@@ -97,7 +99,7 @@ data SomeNamedDigest = forall a . NamedAlgo a => SomeDigest (Digest a)
 
 instance Show SomeNamedDigest where
   show sd = case sd of
-    SomeDigest (digest :: Digest hashType) -> T.unpack $ "SomeDigest " <> algoName @hashType <> ":" <> encodeInBase NixBase32 digest
+    SomeDigest (digest :: Digest hashType) -> T.unpack $ "SomeDigest " <> algoName @hashType <> ":" <> encodeDigestWith NixBase32 digest
 
 mkNamedDigest :: Text -> Text -> Either String SomeNamedDigest
 mkNamedDigest name sriHash =
@@ -147,10 +149,8 @@ hashLazy bsl =
 
 
 -- | Take BaseEncoding type of the output -> take the Digeest as input -> encode Digest
-encodeInBase :: BaseEncoding -> Digest a -> T.Text
-encodeInBase Base16 = T.decodeUtf8 . Base16.encode . coerce
-encodeInBase NixBase32 = Base32.encode . coerce
-encodeInBase Base64 = T.decodeUtf8 . Base64.encode . coerce
+encodeDigestWith :: BaseEncoding -> Digest a -> T.Text
+encodeDigestWith b = encodeWith b . coerce
 
 
 -- | Take BaseEncoding type of the input -> take the input itself -> decodeBase into Digest

hnix-store-core/src/System/Nix/Internal/StorePath.hs

@@ -16,7 +16,7 @@ import           System.Nix.Hash                ( HashAlgorithm
                                                   )
                                                 , Digest
                                                 , BaseEncoding(..)
-                                                , encodeInBase
+                                                , encodeDigestWith
                                                 , decodeBase
                                                 , SomeNamedDigest
                                                 )
@@ -154,7 +154,7 @@ storePathToRawFilePath StorePath{..} =
   root <> "/" <> hashPart <> "-" <> name
  where
   root     = Bytes.Char8.pack storePathRoot
-  hashPart = Text.encodeUtf8 $ encodeInBase NixBase32 storePathHash
+  hashPart = Text.encodeUtf8 $ encodeDigestWith NixBase32 storePathHash
   name     = Text.encodeUtf8 $ unStorePathName storePathName
 
 -- | Render a 'StorePath' as a 'FilePath'.
@@ -169,7 +169,7 @@ storePathToText = Text.pack . Bytes.Char8.unpack . storePathToRawFilePath
 -- can be used to query binary caches.
 storePathToNarInfo :: StorePath -> Bytes.Char8.ByteString
 storePathToNarInfo StorePath{..} =
-  Text.encodeUtf8 $ encodeInBase NixBase32 storePathHash <> ".narinfo"
+  Text.encodeUtf8 $ encodeDigestWith NixBase32 storePathHash <> ".narinfo"
 
 -- | Parse `StorePath` from `Bytes.Char8.ByteString`, checking
 -- that store directory matches `expectedRoot`.

hnix-store-core/src/System/Nix/ReadonlyStore.hs

@@ -34,7 +34,7 @@ makeStorePath fp ty h nm = StorePath storeHash nm fp
     BS.intercalate ":" $
       ty:fmap encodeUtf8
         [ algoName @hashAlgo
-        , encodeInBase Base16 h
+        , encodeDigestWith Base16 h
         , T.pack fp
         , unStorePathName nm
         ]
@@ -64,7 +64,7 @@ makeFixedOutputPath fp recursive h =
       $  "fixed:out:"
       <> encodeUtf8 (algoName @hashAlgo)
       <> (if recursive then ":r:" else ":")
-      <> encodeUtf8 (encodeInBase Base16 h)
+      <> encodeUtf8 (encodeDigestWith Base16 h)
       <> ":"
 
 computeStorePathForText

hnix-store-core/tests/Hash.hs

@@ -27,13 +27,13 @@ spec_hash = do
   describe "hashing parity with nix-store" $ do
 
     it "produces (base32 . sha256) of \"nix-output:foo\" the same as Nix does at the moment for placeholder \"foo\"" $
-      shouldBe (encodeInBase NixBase32 (hash @'SHA256 "nix-output:foo"))
+      shouldBe (encodeDigestWith NixBase32 (hash @'SHA256 "nix-output:foo"))
                "1x0ymrsy7yr7i9wdsqy9khmzc1yy7nvxw6rdp72yzn50285s67j5"
     it "produces (base16 . md5) of \"Hello World\" the same as the thesis" $
-      shouldBe (encodeInBase Base16 (hash @'MD5 "Hello World"))
+      shouldBe (encodeDigestWith Base16 (hash @'MD5 "Hello World"))
                "b10a8db164e0754105b7a99be72e3fe5"
     it "produces (base32 . sha1) of \"Hello World\" the same as the thesis" $
-      shouldBe (encodeInBase NixBase32 (hash @'SHA1 "Hello World"))
+      shouldBe (encodeDigestWith NixBase32 (hash @'SHA1 "Hello World"))
                "s23c9fs0v32pf6bhmcph5rbqsyl5ak8a"
 
     -- The example in question:
@@ -42,11 +42,11 @@ spec_hash = do
       let exampleStr =
             "source:sha256:2bfef67de873c54551d884fdab3055d84d573e654efa79db3"
             <> "c0d7b98883f9ee3:/nix/store:myfile"
-      shouldBe (encodeInBase32 @StorePathHashAlgo (hash exampleStr))
+      shouldBe (encodeDigestWith32 @StorePathHashAlgo (hash exampleStr))
         "xv2iccirbrvklck36f1g7vldn5v58vck"
    where
-    encodeInBase32 :: Digest a -> Text
-    encodeInBase32 = encodeInBase NixBase32
+    encodeDigestWith32 :: Digest a -> Text
+    encodeDigestWith32 = encodeDigestWith NixBase32
 
 -- | Test that Nix-like base32 encoding roundtrips
 prop_nixBase32Roundtrip :: Property
@@ -55,7 +55,7 @@ prop_nixBase32Roundtrip = forAllShrink nonEmptyString genericShrink $
 
 -- | API variants
 prop_nixBase16Roundtrip :: Digest StorePathHashAlgo -> Property
-prop_nixBase16Roundtrip x = pure x === (decodeBase Base16 . encodeInBase Base16 $ x)
+prop_nixBase16Roundtrip x = pure x === (decodeBase Base16 . encodeDigestWith Base16 $ x)
 
 -- | Hash encoding conversion ground-truth.
 -- Similiar to nix/tests/hash.sh