Merge pull request #3825 from input-output-hk/devops-1099-develop

[DEVOPS-1099] make the wallet documentation optional, and default it to off

Author: disassembler

lib/src/Pos/Client/CLI/Options.hs

@@ -172,9 +172,9 @@ walletAddressOption na =
   where
     helpMsg = "IP and port for backend wallet API."
 
-docAddressOption :: Maybe NetworkAddress -> Opt.Parser NetworkAddress
+docAddressOption :: Maybe NetworkAddress -> Opt.Parser (Maybe NetworkAddress)
 docAddressOption na =
-    Opt.option (fromParsec addrParser) $
+    Opt.optional $ Opt.option (fromParsec addrParser) $
             Opt.long "wallet-doc-address"
          <> Opt.metavar "IP:PORT"
          <> Opt.help helpMsg

wallet-new/src/Cardano/Wallet/Action.hs

@@ -91,17 +91,16 @@ actionWithWallet params genesisConfig walletConfig txpConfig ntpConfig nodeParam
                 , unsupportedMimeTypeMiddleware
                 ])
 
-            -- The corresponding wallet documention, served as a different
-            -- server which doesn't require client x509 certificates to
-            -- connect, but still serves the doc through TLS
-            , ("doc worker", Plugins.docServer params)
-
             -- Periodically compact & snapshot the acid-state database.
             , ("acid state cleanup", Plugins.acidStateSnapshots (view Kernel.Internal.wallets (snd w)) params dbMode)
 
             -- A @Plugin@ to watch and store incoming update proposals
             , ("update watcher", Plugins.updateWatcher)
             ]
+        -- The corresponding wallet documention, served as a different
+        -- server which doesn't require client x509 certificates to
+        -- connect, but still serves the doc through TLS
+        , maybe [] (pure . ("doc server",)) (Plugins.docServer params)
         -- The monitoring API for the Core node.
         , Plugins.monitoringServer params
         ]

wallet-new/src/Cardano/Wallet/Server/CLI.hs

@@ -57,7 +57,7 @@ data WalletBackendParams = WalletBackendParams
     -- ^ The TLS parameters.
     , walletAddress       :: !NetworkAddress
     -- ^ The wallet address.
-    , walletDocAddress    :: !NetworkAddress
+    , walletDocAddress    :: !(Maybe NetworkAddress)
     -- ^ The wallet documentation address.
     , walletRunMode       :: !RunMode
     -- ^ The mode this node is running in.
@@ -157,8 +157,8 @@ walletBackendParamsParser = WalletBackendParams <$> enableMonitoringApiParser
     addressParser :: Parser NetworkAddress
     addressParser = CLI.walletAddressOption $ Just (localhost, 8090)
 
-    docAddressParser :: Parser NetworkAddress
-    docAddressParser = CLI.docAddressOption $ Just (localhost, 8091)
+    docAddressParser :: Parser (Maybe NetworkAddress)
+    docAddressParser = CLI.docAddressOption Nothing
 
     runModeParser :: Parser RunMode
     runModeParser = (\debugMode -> if debugMode then DebugMode else ProductionMode) <$>

wallet-new/src/Cardano/Wallet/Server/Plugins.hs

@@ -1,3 +1,5 @@
+{-# LANGUAGE NamedFieldPuns #-}
+
 {- | A collection of plugins used by this edge node.
      A @Plugin@ is essentially a set of actions which will be run in
      a particular monad, at some point in time.
@@ -123,17 +125,17 @@ apiServer (NewWalletBackendParams WalletBackendParams{..}) (passiveLayer, passiv
 docServer
     :: (HasConfigurations, HasCompileInfo)
     => NewWalletBackendParams
-    -> Plugin Kernel.WalletMode
-docServer (NewWalletBackendParams WalletBackendParams{..}) = const $
-    serveDocImpl
+    -> Maybe (Plugin Kernel.WalletMode)
+docServer (NewWalletBackendParams WalletBackendParams{walletDocAddress = Nothing}) = Nothing
+docServer (NewWalletBackendParams WalletBackendParams{walletDocAddress = Just (ip, port), walletRunMode, walletTLSParams}) = Just (const $ makeWalletServer)
+  where
+    makeWalletServer = serveDocImpl
         application
         (BS8.unpack ip)
         port
         (if isDebugMode walletRunMode then Nothing else walletTLSParams)
         (Just defaultSettings)
         Nothing
-  where
-    (ip, port) = walletDocAddress
 
     application :: Kernel.WalletMode Application
     application =