remote: add Types.TrusteFlag, serializer, use in client, more props for handshake

Co-Authored-By: John Ericson <[email protected]>

Author: sorki

hnix-store-remote/hnix-store-remote.cabal

@@ -92,6 +92,7 @@ library
     , System.Nix.Store.Remote.Types.StoreRequest
     , System.Nix.Store.Remote.Types.StoreText
     , System.Nix.Store.Remote.Types.SubstituteMode
+    , System.Nix.Store.Remote.Types.TrustedFlag
     , System.Nix.Store.Remote.Types.Verbosity
     , System.Nix.Store.Remote.Types.WorkerMagic
     , System.Nix.Store.Remote.Types.WorkerOp

hnix-store-remote/src/System/Nix/Store/Remote/Arbitrary.hs

@@ -69,6 +69,19 @@ deriving via GenericArbitrary Logger
 deriving via GenericArbitrary Verbosity
   instance Arbitrary Verbosity
 
+-- * Handshake
+
+deriving via GenericArbitrary WorkerMagic
+  instance Arbitrary WorkerMagic
+
+deriving via GenericArbitrary TrustedFlag
+  instance Arbitrary TrustedFlag
+
+-- * Worker protocol
+
+deriving via GenericArbitrary WorkerOp
+  instance Arbitrary WorkerOp
+
 instance Arbitrary (Some StoreRequest) where
   arbitrary = oneof
     [ Some <$> (AddToStore <$> arbitrary <*> arbitrary <*> arbitrary <*> arbitrary)

hnix-store-remote/src/System/Nix/Store/Remote/Client.hs

@@ -23,7 +23,7 @@ import qualified Network.Socket.ByteString
 import System.Nix.Store.Remote.Logger (processOutput)
 import System.Nix.Store.Remote.MonadStore
 import System.Nix.Store.Remote.Socket (sockPutS, sockGetS)
-import System.Nix.Store.Remote.Serializer (bool, enum, int, mapErrorS, protoVersion, text, workerMagic)
+import System.Nix.Store.Remote.Serializer (bool, enum, int, mapErrorS, protoVersion, text, trustedFlag, workerMagic)
 import System.Nix.Store.Remote.Types.Logger (Logger)
 import System.Nix.Store.Remote.Types.ProtoVersion (ProtoVersion(..), ourProtoVersion)
 import System.Nix.Store.Remote.Types.StoreConfig (PreStoreConfig(..), StoreConfig(..))
@@ -133,6 +133,13 @@ runStoreSocket preStoreConfig code =
               text
         return ()
 
+      _remoteTrustsUs <- if ourProtoVersion >= ProtoVersion 1 35
+        then do
+          sockGetS
+            $ mapErrorS RemoteStoreError_SerializerHandshake trustedFlag
+        else do
+          return Nothing
+
       -- TODO do something with it
       -- TODO patter match better
       _ <- mapStoreConfig

hnix-store-remote/src/System/Nix/Store/Remote/Serializer.hs

@@ -66,6 +66,7 @@ module System.Nix.Store.Remote.Serializer
   -- * Handshake
   , HandshakeSError(..)
   , workerMagic
+  , trustedFlag
   -- * Worker protocol
   , storeText
   , workerOp
@@ -914,6 +915,7 @@ verbosity = Serializer
 
 data HandshakeSError
   = HandshakeSError_InvalidWorkerMagic Word64
+  | HandshakeSError_InvalidTrustedFlag Word8
   deriving (Eq, Ord, Generic, Show)
 
 workerMagic :: NixSerializer r HandshakeSError WorkerMagic
@@ -927,6 +929,21 @@ workerMagic = Serializer
   , putS = putS int . workerMagicToWord64
   }
 
+trustedFlag :: NixSerializer r HandshakeSError (Maybe TrustedFlag)
+trustedFlag = Serializer
+  { getS = do
+      n :: Word8 <- getS int
+      case n of
+        0 -> return $ Nothing
+        1 -> return $ Just TrustedFlag_Trusted
+        2 -> return $ Just TrustedFlag_NotTrusted
+        _ -> throwError (HandshakeSError_InvalidTrustedFlag n)
+  , putS = \n -> putS int $ case n of
+      Nothing -> 0 :: Word8
+      Just TrustedFlag_Trusted -> 1
+      Just TrustedFlag_NotTrusted -> 2
+  }
+
 -- * Worker protocol
 
 storeText :: NixSerializer r SError StoreText

hnix-store-remote/src/System/Nix/Store/Remote/Types.hs

@@ -8,6 +8,7 @@ module System.Nix.Store.Remote.Types
   , module System.Nix.Store.Remote.Types.StoreRequest
   , module System.Nix.Store.Remote.Types.StoreText
   , module System.Nix.Store.Remote.Types.SubstituteMode
+  , module System.Nix.Store.Remote.Types.TrustedFlag
   , module System.Nix.Store.Remote.Types.Verbosity
   , module System.Nix.Store.Remote.Types.WorkerMagic
   , module System.Nix.Store.Remote.Types.WorkerOp
@@ -22,6 +23,7 @@ import System.Nix.Store.Remote.Types.StoreConfig
 import System.Nix.Store.Remote.Types.StoreRequest
 import System.Nix.Store.Remote.Types.StoreText
 import System.Nix.Store.Remote.Types.SubstituteMode
+import System.Nix.Store.Remote.Types.TrustedFlag
 import System.Nix.Store.Remote.Types.Verbosity
 import System.Nix.Store.Remote.Types.WorkerMagic
 import System.Nix.Store.Remote.Types.WorkerOp

hnix-store-remote/src/System/Nix/Store/Remote/Types/TrustedFlag.hs

@@ -0,0 +1,11 @@
+module System.Nix.Store.Remote.Types.TrustedFlag
+  ( TrustedFlag(..)
+  ) where
+
+import GHC.Generics (Generic)
+
+-- | Whether remote side trust us
+data TrustedFlag
+  = TrustedFlag_Trusted
+  | TrustedFlag_NotTrusted
+  deriving (Bounded, Eq, Generic, Enum, Ord, Show)

hnix-store-remote/src/System/Nix/Store/Remote/Types/WorkerOp.hs

@@ -2,6 +2,8 @@ module System.Nix.Store.Remote.Types.WorkerOp
   ( WorkerOp(..)
   ) where
 
+import GHC.Generics (Generic)
+
 -- | Worker opcode
 --
 -- This type has gaps filled in so that the GHC builtin
@@ -54,4 +56,4 @@ data WorkerOp
   | WorkerOp_AddMultipleToStore --  44 0x2c
   | WorkerOp_AddBuildLog --  45 0x2d
   | WorkerOp_BuildPathsWithResults --  46 0x2e
-  deriving (Bounded, Eq, Enum, Ord, Show, Read)
+  deriving (Bounded, Eq, Enum, Generic, Ord, Show, Read)

hnix-store-remote/tests/NixSerializerSpec.hs

@@ -132,7 +132,13 @@ spec = parallel $ do
       it' "IsValidPath"           WorkerOp_IsValidPath            1
       it' "BuildPathsWithResults" WorkerOp_BuildPathsWithResults 46
 
+
+  describe "Handshake" $ do
+    prop "WorkerMagic" $ roundtripS workerMagic
+    prop "TrustedFlag" $ roundtripS trustedFlag
+
   describe "Worker protocol" $ do
+    prop "WorkerOp" $ roundtripS workerOp
     prop "StoreText" $ roundtripS storeText
 
     prop "StoreRequest"