fix(server): improve too big batch response msg (#1107)

* fix(server): improve too big batch response msg

* adjust tests

* fix tests

core/src/server/helpers.rs

@@ -28,7 +28,9 @@ use std::io;
 use std::time::Duration;
 
 use crate::tracing::tx_log_from_str;
-use jsonrpsee_types::error::{ErrorCode, ErrorObject, OVERSIZED_RESPONSE_CODE, OVERSIZED_RESPONSE_MSG};
+use jsonrpsee_types::error::{
+	reject_too_big_batch_response, ErrorCode, ErrorObject, OVERSIZED_RESPONSE_CODE, OVERSIZED_RESPONSE_MSG,
+};
 use jsonrpsee_types::{Id, InvalidRequest, Response, ResponsePayload};
 use serde::Serialize;
 use serde_json::value::to_raw_value;
@@ -268,7 +270,7 @@ impl BatchResponseBuilder {
 		let len = response.result.len() + self.result.len() + 1;
 
 		if len > self.max_response_size {
-			Err(batch_response_error(Id::Null, ErrorObject::from(ErrorCode::InvalidRequest)))
+			Err(batch_response_error(Id::Null, reject_too_big_batch_response(self.max_response_size)))
 		} else {
 			self.result.push_str(&response.result);
 			self.result.push(',');
@@ -365,7 +367,7 @@ mod tests {
 
 		let batch = BatchResponseBuilder::new_with_limit(63).append(&method).unwrap_err();
 
-		let exp_err = r#"{"jsonrpc":"2.0","error":{"code":-32600,"message":"Invalid request"},"id":null}"#;
+		let exp_err = r#"{"jsonrpc":"2.0","error":{"code":-32011,"message":"The batch response was too large","data":"Exceeded max limit of 63"},"id":null}"#;
 		assert_eq!(batch, exp_err);
 	}
 }

server/src/tests/http.rs

@@ -511,7 +511,7 @@ async fn can_set_the_max_response_size_to_batch() {
 	// Two response will end up in a response of 102 bytes which is too big.
 	let req = r#"[{"jsonrpc":"2.0", "method":"anything", "id":1},{"jsonrpc":"2.0", "method":"anything", "id":2}]"#;
 	let response = http_request(req.into(), uri.clone()).with_default_timeout().await.unwrap().unwrap();
-	assert_eq!(response.body, invalid_request(Id::Null));
+	assert_eq!(response.body, batch_response_too_large(100));
 
 	handle.stop().unwrap();
 	handle.stopped().await;

server/src/tests/ws.rs

@@ -108,7 +108,7 @@ async fn can_set_the_max_response_size_to_batch() {
 	// Two response will end up in a response bigger than 100 bytes.
 	let req = r#"[{"jsonrpc":"2.0", "method":"anything", "id":1},{"jsonrpc":"2.0", "method":"anything", "id":2}]"#;
 	let response = client.send_request_text(req).await.unwrap();
-	assert_eq!(response, invalid_request(Id::Null));
+	assert_eq!(response, batch_response_too_large(100));
 
 	server_handle.stop().unwrap();
 	server_handle.stopped().await;

test-utils/src/helpers.rs

@@ -87,6 +87,12 @@ pub fn batches_too_large(max_limit: usize) -> String {
 	)
 }
 
+pub fn batch_response_too_large(max_limit: usize) -> String {
+	format!(
+		r#"{{"jsonrpc":"2.0","error":{{"code":-32011,"message":"The batch response was too large","data":"Exceeded max limit of {max_limit}"}},"id":null}}"#
+	)
+}
+
 pub fn oversized_response(id: Id, max_limit: u32) -> String {
 	format!(
 		r#"{{"jsonrpc":"2.0","error":{{"code":-32008,"message":"Response is too big","data":"Exceeded max limit of {}"}},"id":{}}}"#,

types/src/error.rs

@@ -135,7 +135,9 @@ pub const OVERSIZED_RESPONSE_CODE: i32 = -32008;
 /// Server is busy error code.
 pub const SERVER_IS_BUSY_CODE: i32 = -32009;
 /// Batch request limit was exceed.
-pub const TOO_BIG_BATCH_CODE: i32 = -32010;
+pub const TOO_BIG_BATCH_REQUEST_CODE: i32 = -32010;
+/// Batch request limit was exceed.
+pub const TOO_BIG_BATCH_RESPONSE_CODE: i32 = -32011;
 
 /// Parse error message
 pub const PARSE_ERROR_MSG: &str = "Parse error";
@@ -160,7 +162,9 @@ pub const BATCHES_NOT_SUPPORTED_MSG: &str = "Batched requests are not supported
 /// Subscription limit per connection was exceeded.
 pub const TOO_MANY_SUBSCRIPTIONS_MSG: &str = "Too many subscriptions on the connection";
 /// Batched requests limit was exceed.
-pub const TOO_BIG_BATCH_MSG: &str = "The batch request was too large";
+pub const TOO_BIG_BATCH_REQUEST_MSG: &str = "The batch request was too large";
+/// Batch request response limit was exceed.
+pub const TOO_BIG_BATCH_RESPONSE_MSG: &str = "The batch response was too large";
 
 /// JSONRPC error code
 #[derive(Error, Debug, PartialEq, Eq, Copy, Clone)]
@@ -276,7 +280,20 @@ pub fn reject_too_big_request(limit: u32) -> ErrorObjectOwned {
 
 /// Helper to get a `JSON-RPC` error object when the maximum batch request size have been exceeded.
 pub fn reject_too_big_batch_request(limit: usize) -> ErrorObjectOwned {
-	ErrorObjectOwned::owned(TOO_BIG_BATCH_CODE, TOO_BIG_BATCH_MSG, Some(format!("Exceeded max limit of {limit}")))
+	ErrorObjectOwned::owned(
+		TOO_BIG_BATCH_REQUEST_CODE,
+		TOO_BIG_BATCH_REQUEST_MSG,
+		Some(format!("Exceeded max limit of {limit}")),
+	)
+}
+
+/// Helper to get a `JSON-RPC` error object when the maximum batch response size have been exceeded.
+pub fn reject_too_big_batch_response(limit: usize) -> ErrorObjectOwned {
+	ErrorObjectOwned::owned(
+		TOO_BIG_BATCH_RESPONSE_CODE,
+		TOO_BIG_BATCH_RESPONSE_MSG,
+		Some(format!("Exceeded max limit of {limit}")),
+	)
 }
 
 #[cfg(test)]