Deprecate writeFileTextEnvelopeWithOwnerPermissions. Use writeLazyByt…

…eStringFileWithOwnerPermissions and textEnvelopeToJSON instead
IntersectMBO · Apr 4, 2023 · b54b187 · b54b187
1 parent 288a39a
commit b54b187
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 10 deletions.
diff --git a/cardano-api/src/Cardano/Api/SerialiseTextEnvelope.hs b/cardano-api/src/Cardano/Api/SerialiseTextEnvelope.hs
@@ -225,7 +225,8 @@ writeFileTextEnvelopeWithOwnerPermissions
   -> IO (Either (FileError ()) ())
 writeFileTextEnvelopeWithOwnerPermissions targetPath mbDescr a =
   writeLazyByteStringFileWithOwnerPermissions targetPath $ textEnvelopeToJSON mbDescr a
-
+{-# DEPRECATED writeFileTextEnvelopeWithOwnerPermissions
+  "Use writeLazyByteStringFileWithOwnerPermissions and textEnvelopeToJSON instead" #-}
 
 textEnvelopeToJSON :: HasTextEnvelope a =>  Maybe TextEnvelopeDescr -> a -> LBS.ByteString
 textEnvelopeToJSON mbDescr a  =

diff --git a/cardano-cli/src/Cardano/CLI/Shelley/Run/Node.hs b/cardano-cli/src/Cardano/CLI/Shelley/Run/Node.hs
@@ -129,7 +129,8 @@ runNodeKeyGenVRF (VerificationKeyFile vkeyPath) (SigningKeyFile skeyPath) = do
     let vkey = getVerificationKey skey
     firstExceptT ShelleyNodeCmdWriteFileError
       . newExceptT
-      $ writeFileTextEnvelopeWithOwnerPermissions skeyPath (Just skeyDesc) skey
+      $ writeLazyByteStringFileWithOwnerPermissions skeyPath
+      $ textEnvelopeToJSON (Just skeyDesc) skey
     firstExceptT ShelleyNodeCmdWriteFileError
       . newExceptT
       $ writeLazyByteStringFile vkeyPath

diff --git a/cardano-node/test/Test/Cardano/Node/FilePermissions.hs b/cardano-node/test/Test/Cardano/Node/FilePermissions.hs
@@ -18,21 +18,21 @@ import           System.Directory (removeFile)
 import           Cardano.Api
 import           Cardano.Node.Run (checkVRFFilePermissions)
 import           Control.Exception (bracket)
-import           Control.Monad (Monad(..))
-import           Control.Monad.Except(MonadIO(liftIO), runExceptT )
+import           Control.Monad (Monad (..))
+import           Control.Monad.Except (MonadIO (liftIO), runExceptT)
 import           Data.Bool (Bool, not)
-import           Data.Either (Either(..))
+import           Data.Either (Either (..))
 import           Data.Eq ((==))
 import           Data.Foldable (foldl', length)
-import           Data.Function (($), (.), const)
-import           Data.Maybe (Maybe(..))
-import           Data.Semigroup (Semigroup(..))
+import           Data.Function (const, ($), (.))
 import qualified Data.List as L
+import           Data.Maybe (Maybe (..))
+import           Data.Semigroup (Semigroup (..))
 import           Hedgehog (Property, PropertyT, property, success)
 import qualified Hedgehog
 import           Hedgehog.Internal.Property (Group (..), failWith)
 import           System.IO (FilePath, IO)
-import           Text.Show (Show(..))
+import           Text.Show (Show (..))
 
 #ifdef UNIX
 import           Cardano.Node.Types (VRFPrivateKeyFilePermissionError (..))
@@ -63,7 +63,7 @@ prop_createVRFFileWithOwnerPermissions =
 
 createFileWithOwnerPermissions :: HasTextEnvelope a => FilePath -> a -> PropertyT IO ()
 createFileWithOwnerPermissions targetfp value = do
-  result <- liftIO $ writeFileTextEnvelopeWithOwnerPermissions targetfp Nothing value
+  result <- liftIO $ writeLazyByteStringFileWithOwnerPermissions targetfp $ textEnvelopeToJSON Nothing value
   case result of
     Left err -> failWith Nothing $ displayError err
     Right () -> return ()