1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108

//! Compatibility fixes for JSON-RPC remote procedure calls.
//!
//! These fixes are applied at the JSON-RPC call level,
//! after the RPC request is parsed and split into calls.

use std::future::Future;

use futures::future::{Either, FutureExt};
use jsonrpc_core::{
    middleware::Middleware,
    types::{Call, Failure, Output, Response},
    BoxFuture, ErrorCode, Metadata, MethodCall, Notification,
};

use crate::constants::{INVALID_PARAMETERS_ERROR_CODE, MAX_PARAMS_LOG_LENGTH};

/// JSON-RPC [`Middleware`] with compatibility workarounds.
///
/// This middleware makes the following changes to JSON-RPC calls:
///
/// ## Make RPC framework response codes match `zcashd`
///
/// [`jsonrpc_core`] returns specific error codes while parsing requests:
/// <https://docs.rs/jsonrpc-core/18.0.0/jsonrpc_core/types/error/enum.ErrorCode.html#variants>
///
/// But these codes are different from `zcashd`, and some RPC clients rely on the exact code.
///
/// ## Read-Only Functionality
///
/// This middleware also logs unrecognized RPC requests.
pub struct FixRpcResponseMiddleware;

impl<M: Metadata> Middleware<M> for FixRpcResponseMiddleware {
    type Future = BoxFuture<Option<Response>>;
    type CallFuture = BoxFuture<Option<Output>>;

    fn on_call<Next, NextFuture>(
        &self,
        call: Call,
        meta: M,
        next: Next,
    ) -> Either<Self::CallFuture, NextFuture>
    where
        Next: Fn(Call, M) -> NextFuture + Send + Sync,
        NextFuture: Future<Output = Option<Output>> + Send + 'static,
    {
        Either::Left(
            next(call.clone(), meta)
                .map(|mut output| {
                    Self::fix_error_codes(&mut output);
                    output
                })
                .inspect(|output| Self::log_if_error(output, call))
                .boxed(),
        )
    }
}

impl FixRpcResponseMiddleware {
    /// Replace [`jsonrpc_core`] server error codes in `output` with the `zcashd` equivalents.
    fn fix_error_codes(output: &mut Option<Output>) {
        if let Some(Output::Failure(Failure { ref mut error, .. })) = output {
            if matches!(error.code, ErrorCode::InvalidParams) {
                let original_code = error.code.clone();

                error.code = INVALID_PARAMETERS_ERROR_CODE;
                tracing::debug!("Replacing RPC error: {original_code:?} with {error}");
            }
        }
    }

    /// Obtain a description string for a received request.
    ///
    /// Prints out only the method name and the received parameters.
    fn call_description(call: &Call) -> String {
        match call {
            Call::MethodCall(MethodCall { method, params, .. }) => {
                let mut params = format!("{params:?}");
                if params.len() >= MAX_PARAMS_LOG_LENGTH {
                    params.truncate(MAX_PARAMS_LOG_LENGTH);
                    params.push_str("...");
                }

                format!(r#"method = {method:?}, params = {params}"#)
            }
            Call::Notification(Notification { method, params, .. }) => {
                let mut params = format!("{params:?}");
                if params.len() >= MAX_PARAMS_LOG_LENGTH {
                    params.truncate(MAX_PARAMS_LOG_LENGTH);
                    params.push_str("...");
                }

                format!(r#"notification = {method:?}, params = {params}"#)
            }
            Call::Invalid { .. } => "invalid request".to_owned(),
        }
    }

    /// Check RPC output and log any errors.
    //
    // TODO: do we want to ignore ErrorCode::ServerError(_), or log it at debug?
    fn log_if_error(output: &Option<Output>, call: Call) {
        if let Some(Output::Failure(Failure { error, .. })) = output {
            let call_description = Self::call_description(&call);
            tracing::info!("RPC error: {error} in call: {call_description}");
        }
    }
}