take ChainOutOfSync type out from the server output hierarchy

Author: ffakenz

hydra-node/golden/ServerOutput/ChainOutOfSync.json renamed to hydra-node/golden/ChainOutOfSync/ChainOutOfSync.json

@@ -3,18 +3,18 @@
         {
             "syncedStatus": {
                 "point": {
-                    "blockHash": "0101000000000000000000000000010001000100010000010100010101010000",
-                    "slot": 0,
+                    "blockHash": "0001000001000100010000010000010000000100010001010100010001010001",
+                    "slot": 1,
                     "tag": "ChainPoint"
                 },
                 "tip": {
-                    "blockHash": "0101000001000101010001000101000001010101010101000101010101010001",
-                    "slot": 1,
+                    "blockHash": "0101000101000100000101010101010000010100000001010101010001000001",
+                    "slot": 0,
                     "tag": "ChainPoint"
                 }
             },
             "tag": "ChainOutOfSync"
         }
     ],
-    "seed": -429184662
+    "seed": -455573634
 }

hydra-node/json-schemas/api.yaml

@@ -168,6 +168,7 @@ channels:
           * DraftCommitTxResponse - 200 ok
           * CommittedTooMuchADAForMainnet - 400 bad request
           * UnsupportedLegacyOutput - 400 bad request
+          * ChainOutOfSync - 503 service unavailable
       message:
         $ref: "api.yaml#/components/messages/DraftCommitTxResponse"
       bindings:
@@ -227,6 +228,7 @@ channels:
         Possible responses of this endpoint are:
           * 200 OK
           * 400 Bad Request
+          * 503 Service Unavailable
       message:
         payload:
           type: string
@@ -333,6 +335,7 @@ channels:
         Possible responses of this endpoint are:
           * String - 200 OK
           * String - 400 bad request
+          * ChainOutOfSync - 503 service unavailable
       message:
         payload:
             $ref: "api.yaml#/components/messages/DecommitResponse"
@@ -389,6 +392,10 @@ channels:
           summary: 400 Bad Request
           payload:
             $ref: "api.yaml#/components/schemas/PostTxError"
+        - name: ChainOutOfSync
+          summary: 503 Service Unavailable
+          payload:
+            $ref: "api.yaml#/components/schemas/ChainOutOfSync"
       bindings:
         http:
           type: response
@@ -450,6 +457,10 @@ channels:
               tag:
                 type: string
                 enum: ["SubmitTxSubmitted"]
+        - name: ChainOutOfSync
+          summary: 503 Service Unavailable
+          payload:
+            $ref: "api.yaml#/components/schemas/ChainOutOfSync"
       bindings:
         http:
           type: response
@@ -1804,19 +1815,13 @@ components:
       type: object
       required:
         - tag
-        - seq
         - syncedStatus
-        - timestamp
       properties:
         tag:
           type: string
           enum: ["ChainOutOfSync"]
-        seq:
-          $ref: "api.yaml#/components/schemas/SequenceNumber"
         syncedStatus:
           $ref: "api.yaml#/components/schemas/SyncedStatus"
-        timestamp:
-          $ref: "api.yaml#/components/schemas/UTCTime"
 
     # END OF SERVER OUTPUT SCHEMAS
 
@@ -3582,7 +3587,7 @@ components:
       properties:
         point:
           oneOf:
-            - $ref: "api.yaml#/components/schemas/ChainPoint"
-            - type: "null"
+          - $ref: "api.yaml#/components/schemas/ChainPoint"
+          - type: "null"
         tip:
           $ref: "api.yaml#/components/schemas/ChainPoint"

hydra-node/src/Hydra/API/ServerOutput.hs

@@ -5,7 +5,7 @@
 module Hydra.API.ServerOutput where
 
 import Control.Lens ((.~))
-import Data.Aeson (Value (..), defaultOptions, encode, genericParseJSON, genericToJSON, omitNothingFields, tagSingleConstructors, withObject, (.:))
+import Data.Aeson (Value (..), defaultOptions, encode, genericParseJSON, genericToJSON, object, omitNothingFields, tagSingleConstructors, withObject, (.:), (.=))
 import Data.Aeson.KeyMap qualified as KeyMap
 import Data.Aeson.Lens (atKey, key)
 import Data.ByteString.Lazy qualified as LBS
@@ -142,6 +142,21 @@ data InvalidInput = InvalidInput
 deriving instance ToJSON InvalidInput
 deriving instance FromJSON InvalidInput
 
+newtype ChainOutOfSync = ChainOutOfSync {syncedStatus :: SyncedStatus}
+  deriving newtype (Eq, Show)
+  deriving (Generic)
+  deriving newtype (Arbitrary)
+
+instance ToJSON ChainOutOfSync where
+  toJSON (ChainOutOfSync s) =
+    object ["tag" .= String "ChainOutOfSync", "syncedStatus" .= s]
+
+instance FromJSON ChainOutOfSync where
+  parseJSON = withObject "ChainOutOfSync" $ \o ->
+    ChainOutOfSync <$> o .: "syncedStatus"
+
+instance ToADTArbitrary ChainOutOfSync
+
 data ServerOutput tx
   = NetworkConnected
   | NetworkDisconnected
@@ -216,7 +231,6 @@ data ServerOutput tx
     -- Any signing round has been discarded, and the snapshot leader has changed accordingly.
     SnapshotSideLoaded {headId :: HeadId, snapshotNumber :: SnapshotNumber}
   | EventLogRotated {checkpoint :: NodeState tx}
-  | ChainOutOfSync {syncedStatus :: SyncedStatus}
   deriving stock (Generic)
 
 deriving stock instance IsChainState tx => Eq (ServerOutput tx)
@@ -290,7 +304,6 @@ prepareServerOutput config response =
     PeerDisconnected{} -> encodedResponse
     SnapshotSideLoaded{} -> encodedResponse
     EventLogRotated{} -> encodedResponse
-    ChainOutOfSync{} -> encodedResponse
  where
   encodedResponse = encode response
 

hydra-node/src/Hydra/API/WSServer.hs

@@ -17,12 +17,12 @@ import Hydra.API.APIServerLog (APIServerLog (..))
 import Hydra.API.ClientInput (ClientInput)
 import Hydra.API.Projection (Projection (..))
 import Hydra.API.ServerOutput (
+  ChainOutOfSync (..),
   ClientMessage,
   Greetings (..),
   HeadStatus (..),
   InvalidInput (..),
   NetworkInfo,
-  ServerOutput (ChainOutOfSync),
   ServerOutputConfig (..),
   TimedServerOutput (..),
   WithAddressedTx (..),
@@ -85,9 +85,9 @@ wsApp env party tracer history callback nodeStateP networkInfoP responseChannel
   -- we notify clients every time the chain is out of sync
   -- as their inputs will get rejected
   _ <- forkLabelled "ws-check-sync-status" $ forever $ do
-    synced <- chainSyncedStatus
-    unless (status synced) $ do
-      let output :: ServerOutput tx = ChainOutOfSync synced
+    syncedStatus <- chainSyncedStatus
+    unless (status syncedStatus) $ do
+      let output = ChainOutOfSync syncedStatus
       sendTextData con (Aeson.encode output)
     -- check every second
     -- TODO! configure threadDelay

hydra-node/test/Hydra/API/ServerOutputSpec.hs

@@ -6,7 +6,7 @@ import Test.Hydra.Prelude
 import Control.Lens (toListOf, (^.))
 import Data.Aeson (Value)
 import Data.Aeson.Lens (key, values, _Array)
-import Hydra.API.ServerOutput (ClientMessage, Greetings (..), ServerOutput, TimedServerOutput)
+import Hydra.API.ServerOutput (ChainOutOfSync (..), ClientMessage, Greetings (..), ServerOutput, TimedServerOutput)
 import Hydra.Chain.Direct.State ()
 import Hydra.JSONSchema (prop_specIsComplete, prop_validateJSONSchema)
 import Hydra.Ledger.Cardano (Tx)
@@ -22,6 +22,7 @@ spec :: Spec
 spec = parallel $ do
   roundtripAndGoldenADTSpecsWithSettings defaultSettings{sampleSize = 1} $ Proxy @(MinimumSized (ServerOutput Tx))
   roundtripAndGoldenADTSpecsWithSettings defaultSettings{sampleSize = 1} $ Proxy @(MinimumSized (Greetings Tx))
+  roundtripAndGoldenADTSpecsWithSettings defaultSettings{sampleSize = 1} $ Proxy @(MinimumSized ChainOutOfSync)
 
   -- NOTE: Kupo and maybe other downstream projects use this file as a test vector.
   it "golden SnapshotConfirmed is good" $ do
@@ -42,6 +43,8 @@ spec = parallel $ do
             key "components" . key "schemas" . key "Greetings"
         , prop_validateJSONSchema @(ClientMessage Tx) "api.json" $
             key "components" . key "schemas" . key "ClientMessage"
+        , prop_validateJSONSchema @ChainOutOfSync "api.json" $
+            key "components" . key "schemas" . key "ChainOutOfSync"
         ]
 
   -- XXX: This seems no to be working? Adding a new message does not lead to a failure here
@@ -53,4 +56,6 @@ spec = parallel $ do
           key "channels" . key "/" . key "subscribe" . key "message"
       , prop_specIsComplete @(ClientMessage Tx) "api.json" $
           key "channels" . key "/" . key "subscribe" . key "message"
+      , prop_specIsComplete @ChainOutOfSync "api.json" $
+          key "channels" . key "/" . key "subscribe" . key "message"
       ]