Print invalid state, if hitting precondition (#545)

fabianfett · web-flow · commit 2497a68427f8 · 2022-01-24T12:26:08.000+01:00
diff --git a/Sources/AsyncHTTPClient/ConnectionPool/HTTP1/HTTP1ConnectionStateMachine.swift b/Sources/AsyncHTTPClient/ConnectionPool/HTTP1/HTTP1ConnectionStateMachine.swift
@@ -159,7 +159,7 @@ struct HTTP1ConnectionStateMachine {
         metadata: RequestFramingMetadata
     ) -> Action {
         guard case .idle = self.state else {
-            preconditionFailure("Invalid state")
+            preconditionFailure("Invalid state: \(self.state)")
         }
 
         var requestStateMachine = HTTPRequestStateMachine(isChannelWritable: self.isChannelWritable)
@@ -173,7 +173,7 @@ struct HTTP1ConnectionStateMachine {
 
     mutating func requestStreamPartReceived(_ part: IOData) -> Action {
         guard case .inRequest(var requestStateMachine, let close) = self.state else {
-            preconditionFailure("Invalid state")
+            preconditionFailure("Invalid state: \(self.state)")
         }
 
         return self.avoidingStateMachineCoW { state -> Action in
@@ -185,7 +185,7 @@ struct HTTP1ConnectionStateMachine {
 
     mutating func requestStreamFinished() -> Action {
         guard case .inRequest(var requestStateMachine, let close) = self.state else {
-            preconditionFailure("Invalid state")
+            preconditionFailure("Invalid state: \(self.state)")
         }
 
         return self.avoidingStateMachineCoW { state -> Action in
@@ -198,7 +198,7 @@ struct HTTP1ConnectionStateMachine {
     mutating func requestCancelled(closeConnection: Bool) -> Action {
         switch self.state {
         case .initialized:
-            preconditionFailure("This event must only happen, if the connection is leased. During startup this is impossible")
+            preconditionFailure("This event must only happen, if the connection is leased. During startup this is impossible. Invalid state: \(self.state)")
 
         case .idle:
             if closeConnection {
@@ -250,7 +250,7 @@ struct HTTP1ConnectionStateMachine {
     mutating func channelRead(_ part: HTTPClientResponsePart) -> Action {
         switch self.state {
         case .initialized, .idle:
-            preconditionFailure("Invalid state")
+            preconditionFailure("Invalid state: \(self.state)")
 
         case .inRequest(var requestStateMachine, var close):
             return self.avoidingStateMachineCoW { state -> Action in
@@ -369,7 +369,7 @@ extension HTTP1ConnectionStateMachine.State {
             return .forwardResponseBodyParts(parts)
         case .succeedRequest(let finalAction, let finalParts):
             guard case .inRequest(_, close: let close) = self else {
-                preconditionFailure("Invalid state")
+                preconditionFailure("Invalid state: \(self)")
             }
 
             let newFinalAction: HTTP1ConnectionStateMachine.Action.FinalStreamAction
@@ -388,7 +388,7 @@ extension HTTP1ConnectionStateMachine.State {
         case .failRequest(let error, let finalAction):
             switch self {
             case .initialized:
-                preconditionFailure("Invalid state")
+                preconditionFailure("Invalid state: \(self)")
             case .idle:
                 preconditionFailure("How can we fail a task, if we are idle")
             case .inRequest(_, close: let close):
@@ -433,7 +433,7 @@ extension HTTP1ConnectionStateMachine: CustomStringConvertible {
         case .closed:
             return ".closed"
         case .modifying:
-            preconditionFailure(".modifying")
+            preconditionFailure("Invalid state: \(self.state)")
         }
     }
 }
diff --git a/Sources/AsyncHTTPClient/RequestBag+StateMachine.swift b/Sources/AsyncHTTPClient/RequestBag+StateMachine.swift
@@ -127,10 +127,10 @@ extension RequestBag.StateMachine {
             return .none
 
         case .finished:
-            preconditionFailure("Invalid state")
+            preconditionFailure("Invalid state: \(self.state)")
 
         case .modifying:
-            preconditionFailure("Invalid state")
+            preconditionFailure("Invalid state: \(self.state)")
         }
     }
 
@@ -158,7 +158,7 @@ extension RequestBag.StateMachine {
             // the request is already finished nothing further to do
             break
         case .modifying:
-            preconditionFailure("Invalid state")
+            preconditionFailure("Invalid state: \(self.state)")
         }
     }
 
@@ -205,7 +205,7 @@ extension RequestBag.StateMachine {
         case .finished(error: .none):
             return .failFuture(HTTPClientError.requestStreamCancelled)
         case .modifying:
-            preconditionFailure("Invalid state")
+            preconditionFailure("Invalid state: \(self.state)")
         }
     }
 
@@ -251,7 +251,7 @@ extension RequestBag.StateMachine {
         case .finished(error: _):
             return .none
         case .modifying:
-            preconditionFailure("Invalid state")
+            preconditionFailure("Invalid state: \(self.state)")
         }
     }
 
@@ -285,7 +285,7 @@ extension RequestBag.StateMachine {
         case .finished(error: .none):
             preconditionFailure("How can the request be finished without error, before receiving response head?")
         case .modifying:
-            preconditionFailure("Invalid state")
+            preconditionFailure("Invalid state: \(self.state)")
         }
     }
 
@@ -322,7 +322,7 @@ extension RequestBag.StateMachine {
         case .finished(error: .none):
             preconditionFailure("How can the request be finished without error, before receiving response head?")
         case .modifying:
-            preconditionFailure("Invalid state")
+            preconditionFailure("Invalid state: \(self.state)")
         }
     }
 
@@ -374,7 +374,7 @@ extension RequestBag.StateMachine {
         case .finished(error: .none):
             preconditionFailure("How can the request be finished without error, before receiving response head?")
         case .modifying:
-            preconditionFailure("Invalid state")
+            preconditionFailure("Invalid state: \(self.state)")
         }
     }
 
@@ -398,7 +398,7 @@ extension RequestBag.StateMachine {
     private mutating func failWithConsumptionError(_ error: Error) -> ConsumeAction {
         switch self.state {
         case .initialized, .queued:
-            preconditionFailure("Invalid state")
+            preconditionFailure("Invalid state: \(self.state)")
         case .executing(_, _, .initialized):
             preconditionFailure("Invalid state: Must have received response head, before this method is called for the first time")
 
@@ -521,7 +521,7 @@ extension RequestBag.StateMachine {
             // this might happen, if the stream consumer has failed... let's just drop the data
             return .none
         case .modifying:
-            preconditionFailure("Invalid state")
+            preconditionFailure("Invalid state: \(self.state)")
         }
     }
 }
diff --git a/Tests/AsyncHTTPClientTests/HTTP2ConnectionTests.swift b/Tests/AsyncHTTPClientTests/HTTP2ConnectionTests.swift
@@ -352,7 +352,7 @@ extension TestConnectionCreator: HTTPConnectionRequester {
                 return .fail(promise, Error.wantedHTTP2ConnectionButGotHTTP1)
 
             case .idle:
-                preconditionFailure("Invalid state")
+                preconditionFailure("Invalid state: \(self.state)")
             }
         }
         wrapper.complete()
@@ -369,7 +369,7 @@ extension TestConnectionCreator: HTTPConnectionRequester {
                 return .succeed(promise, connection)
 
             case .idle:
-                preconditionFailure("Invalid state")
+                preconditionFailure("Invalid state: \(self.state)")
             }
         }
         wrapper.complete()
@@ -400,7 +400,7 @@ extension TestConnectionCreator: HTTPConnectionRequester {
                 return .type2(promise)
 
             case .idle:
-                preconditionFailure("Invalid state")
+                preconditionFailure("Invalid state: \(self.state)")
             }
         }
         wrapper.fail(error)

Original file line number	Diff line number	Diff line change
`@@ -127,10 +127,10 @@ extension RequestBag.StateMachine {`
`127`	`127`	`return .none`
`128`	`128`
`129`	`129`	`case .finished:`
`130`		`- preconditionFailure("Invalid state")`
	`130`	`+ preconditionFailure("Invalid state: \(self.state)")`
`131`	`131`
`132`	`132`	`case .modifying:`
`133`		`- preconditionFailure("Invalid state")`
	`133`	`+ preconditionFailure("Invalid state: \(self.state)")`
`134`	`134`	`}`
`135`	`135`	`}`
`136`	`136`
`@@ -158,7 +158,7 @@ extension RequestBag.StateMachine {`
`158`	`158`	`// the request is already finished nothing further to do`
`159`	`159`	`break`
`160`	`160`	`case .modifying:`
`161`		`- preconditionFailure("Invalid state")`
	`161`	`+ preconditionFailure("Invalid state: \(self.state)")`
`162`	`162`	`}`
`163`	`163`	`}`
`164`	`164`
`@@ -205,7 +205,7 @@ extension RequestBag.StateMachine {`
`205`	`205`	`case .finished(error: .none):`
`206`	`206`	`return .failFuture(HTTPClientError.requestStreamCancelled)`
`207`	`207`	`case .modifying:`
`208`		`- preconditionFailure("Invalid state")`
	`208`	`+ preconditionFailure("Invalid state: \(self.state)")`
`209`	`209`	`}`
`210`	`210`	`}`
`211`	`211`
`@@ -251,7 +251,7 @@ extension RequestBag.StateMachine {`
`251`	`251`	`case .finished(error: _):`
`252`	`252`	`return .none`
`253`	`253`	`case .modifying:`
`254`		`- preconditionFailure("Invalid state")`
	`254`	`+ preconditionFailure("Invalid state: \(self.state)")`
`255`	`255`	`}`
`256`	`256`	`}`
`257`	`257`
`@@ -285,7 +285,7 @@ extension RequestBag.StateMachine {`
`285`	`285`	`case .finished(error: .none):`
`286`	`286`	`preconditionFailure("How can the request be finished without error, before receiving response head?")`
`287`	`287`	`case .modifying:`
`288`		`- preconditionFailure("Invalid state")`
	`288`	`+ preconditionFailure("Invalid state: \(self.state)")`
`289`	`289`	`}`
`290`	`290`	`}`
`291`	`291`
`@@ -322,7 +322,7 @@ extension RequestBag.StateMachine {`
`322`	`322`	`case .finished(error: .none):`
`323`	`323`	`preconditionFailure("How can the request be finished without error, before receiving response head?")`
`324`	`324`	`case .modifying:`
`325`		`- preconditionFailure("Invalid state")`
	`325`	`+ preconditionFailure("Invalid state: \(self.state)")`
`326`	`326`	`}`
`327`	`327`	`}`
`328`	`328`
`@@ -374,7 +374,7 @@ extension RequestBag.StateMachine {`
`374`	`374`	`case .finished(error: .none):`
`375`	`375`	`preconditionFailure("How can the request be finished without error, before receiving response head?")`
`376`	`376`	`case .modifying:`
`377`		`- preconditionFailure("Invalid state")`
	`377`	`+ preconditionFailure("Invalid state: \(self.state)")`
`378`	`378`	`}`
`379`	`379`	`}`
`380`	`380`
`@@ -398,7 +398,7 @@ extension RequestBag.StateMachine {`
`398`	`398`	`private mutating func failWithConsumptionError(_ error: Error) -> ConsumeAction {`
`399`	`399`	`switch self.state {`
`400`	`400`	`case .initialized, .queued:`
`401`		`- preconditionFailure("Invalid state")`
	`401`	`+ preconditionFailure("Invalid state: \(self.state)")`
`402`	`402`	`case .executing(_, _, .initialized):`
`403`	`403`	`preconditionFailure("Invalid state: Must have received response head, before this method is called for the first time")`
`404`	`404`
`@@ -521,7 +521,7 @@ extension RequestBag.StateMachine {`
`521`	`521`	`// this might happen, if the stream consumer has failed... let's just drop the data`
`522`	`522`	`return .none`
`523`	`523`	`case .modifying:`
`524`		`- preconditionFailure("Invalid state")`
	`524`	`+ preconditionFailure("Invalid state: \(self.state)")`
`525`	`525`	`}`
`526`	`526`	`}`
`527`	`527`	`}`
Original file line number	Diff line number	Diff line change
`@@ -352,7 +352,7 @@ extension TestConnectionCreator: HTTPConnectionRequester {`
`352`	`352`	`return .fail(promise, Error.wantedHTTP2ConnectionButGotHTTP1)`
`353`	`353`
`354`	`354`	`case .idle:`
`355`		`- preconditionFailure("Invalid state")`
	`355`	`+ preconditionFailure("Invalid state: \(self.state)")`
`356`	`356`	`}`
`357`	`357`	`}`
`358`	`358`	`wrapper.complete()`
`@@ -369,7 +369,7 @@ extension TestConnectionCreator: HTTPConnectionRequester {`
`369`	`369`	`return .succeed(promise, connection)`
`370`	`370`
`371`	`371`	`case .idle:`
`372`		`- preconditionFailure("Invalid state")`
	`372`	`+ preconditionFailure("Invalid state: \(self.state)")`
`373`	`373`	`}`
`374`	`374`	`}`
`375`	`375`	`wrapper.complete()`
`@@ -400,7 +400,7 @@ extension TestConnectionCreator: HTTPConnectionRequester {`
`400`	`400`	`return .type2(promise)`
`401`	`401`
`402`	`402`	`case .idle:`
`403`		`- preconditionFailure("Invalid state")`
	`403`	`+ preconditionFailure("Invalid state: \(self.state)")`
`404`	`404`	`}`
`405`	`405`	`}`
`406`	`406`	`wrapper.fail(error)`