Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix injecting block when injectable param is null #171

Merged
merged 2 commits into from
May 9, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
96 changes: 68 additions & 28 deletions src/middlewares/methods/inject_params.rs
Original file line number Diff line number Diff line change
Expand Up @@ -122,42 +122,44 @@ impl Middleware<CallRequest, CallResult> for InjectParamsMiddleware {

let idx = self.get_index();
match request.params.len() {
len if len == idx + 1 => {
// full params with current block
len if len > idx + 1 => {
// unexpected number of params
return handle_request(request).await;
}
len if len <= idx => {
async move {
// without current block
let to_inject = self.get_parameter().await;
tracing::trace!("Injected param {} to method {}", &to_inject, request.method);
let params_passed = request.params.len();
while request.params.len() < idx {
let current = request.params.len();
if self.params[current].optional {
request.params.push(JsonValue::Null);
} else {
let (required, optional) = self.params_count();
return Err(errors::invalid_params(format!(
"Expected {:?} parameters ({:?} optional), {:?} found instead",
required + optional,
optional,
params_passed
)));
}
// without current block
let params_passed = request.params.len();
while request.params.len() < idx {
let current = request.params.len();
if self.params[current].optional {
request.params.push(JsonValue::Null);
} else {
let (required, optional) = self.params_count();
return Err(errors::invalid_params(format!(
"Expected {:?} parameters ({:?} optional), {:?} found instead",
required + optional,
optional,
params_passed
)));
}
request.params.push(to_inject);

handle_request(request).await
}
.with_context(TRACER.context("inject_params"))
.await
// Set param to null, it will be replaced later
request.params.push(JsonValue::Null);
}
_ => {
// unexpected number of params
handle_request(request).await
_ => {} // full params, block potentially might be null
};

// Here we are sure we have full params in the request, but it still might be set to null
async move {
if request.params[idx] == JsonValue::Null {
let to_inject = self.get_parameter().await;
tracing::trace!("Injected param {} to method {}", &to_inject, request.method);
request.params[idx] = to_inject;
}
handle_request(request).await
}
.with_context(TRACER.context("inject_params"))
.await
}
}

Expand Down Expand Up @@ -286,6 +288,44 @@ mod tests {
assert_eq!(result, json!("0x1111"));
}

#[tokio::test]
async fn inject_if_param_is_null() {
let params = vec![json!("0x1234"), json!(None::<()>)];
let (middleware, _) = create_inject_middleware(
InjectType::BlockHashAt(1),
vec![
MethodParam {
name: "key".to_string(),
ty: "StorageKey".to_string(),
optional: false,
inject: false,
},
MethodParam {
name: "at".to_string(),
ty: "BlockHash".to_string(),
optional: true,
inject: true,
},
],
)
.await;
let result = middleware
.call(
CallRequest::new("state_getStorage", params.clone()),
Default::default(),
Box::new(move |req: CallRequest, _| {
async move {
assert_eq!(req.params, vec![json!("0x1234"), json!("0xabcd")]);
Ok(json!("0x1111"))
}
.boxed()
}),
)
.await
.unwrap();
assert_eq!(result, json!("0x1111"));
}

#[tokio::test]
async fn inject_if_without_current_block_hash() {
let (middleware, _context) = create_inject_middleware(
Expand Down
Loading