Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Add extensible compression support for RPC requests #6084

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

Open
fubhy wants to merge 4 commits into master
base: master
Choose a base branch
Loading
from feature/extensible-rpc-compression
Open
Show file tree
Hide file tree
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
14 changes: 14 additions & 0 deletions Cargo.lock
View file Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 5 additions & 0 deletions chain/ethereum/src/network.rs
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -393,6 +393,7 @@ mod tests {
HeaderMap::new(),
metrics.clone(),
"",
graph::endpoint::Compression::None,
);
let provider_metrics = Arc::new(ProviderEthRpcMetrics::new(mock_registry.clone()));

Expand Down Expand Up @@ -499,6 +500,7 @@ mod tests {
HeaderMap::new(),
metrics.clone(),
"",
graph::endpoint::Compression::None,
);
let provider_metrics = Arc::new(ProviderEthRpcMetrics::new(mock_registry.clone()));

Expand Down Expand Up @@ -570,6 +572,7 @@ mod tests {
HeaderMap::new(),
metrics.clone(),
"",
graph::endpoint::Compression::None,
);
let provider_metrics = Arc::new(ProviderEthRpcMetrics::new(mock_registry.clone()));

Expand Down Expand Up @@ -637,6 +640,7 @@ mod tests {
HeaderMap::new(),
metrics.clone(),
"",
graph::endpoint::Compression::None,
);
let provider_metrics = Arc::new(ProviderEthRpcMetrics::new(mock_registry.clone()));

Expand Down Expand Up @@ -931,6 +935,7 @@ mod tests {
HeaderMap::new(),
endpoint_metrics.clone(),
"",
graph::endpoint::Compression::None,
);

Arc::new(
Expand Down
23 changes: 18 additions & 5 deletions chain/ethereum/src/transport.rs
View file Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
use graph::components::network_provider::ProviderName;
use graph::endpoint::{EndpointMetrics, RequestLabels};
use graph::endpoint::{Compression, EndpointMetrics, RequestLabels};
use jsonrpc_core::types::Call;
use jsonrpc_core::Value;

Expand Down Expand Up @@ -54,12 +54,25 @@ impl Transport {
headers: graph::http::HeaderMap,
metrics: Arc<EndpointMetrics>,
provider: impl AsRef<str>,
compression: Compression,
) -> Self {
// Unwrap: This only fails if something is wrong with the system's TLS config.
let client = reqwest::Client::builder()
.default_headers(headers)
.build()
.unwrap();
let mut client_builder = reqwest::Client::builder().default_headers(headers);

match compression {
Compression::Gzip => {
// Enable gzip compression/decompression for requests and responses
client_builder = client_builder.gzip(true);
}
Compression::None => {
// No compression
} // Future compression methods can be handled here:
// Compression::Brotli => {
// client_builder = client_builder.brotli(true);
// }
}

let client = client_builder.build().unwrap();

Transport::RPC {
client: http::Http::with_client(client, rpc),
Expand Down
2 changes: 1 addition & 1 deletion graph/Cargo.toml
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ chrono = "0.4.41"
envconfig = "0.11.0"
Inflector = "0.11.3"
atty = "0.2"
reqwest = { version = "0.12.15", features = ["json", "stream", "multipart"] }
reqwest = { version = "0.12.15", features = ["json", "stream", "multipart", "gzip"] }
ethabi = "17.2"
hex = "0.4.3"
http0 = { version = "0", package = "http" }
Expand Down
4 changes: 2 additions & 2 deletions graph/src/components/link_resolver/arweave.rs
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ impl Default for ArweaveClient {

Self {
base_url: "https://arweave.net".parse().unwrap(),
client: Client::default(),
client: Client::builder().gzip(false).build().unwrap(),
logger: Logger::root(slog::Discard, o!()),
}
}
Expand All @@ -53,7 +53,7 @@ impl ArweaveClient {
Self {
base_url,
logger,
client: Client::default(),
client: Client::builder().gzip(false).build().unwrap(),
}
}
}
Expand Down
21 changes: 21 additions & 0 deletions graph/src/endpoint.rs
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ use std::{
};

use prometheus::IntCounterVec;
use serde::{Deserialize, Serialize};
use slog::{warn, Logger};

use crate::components::network_provider::ProviderName;
Expand All @@ -17,6 +18,26 @@ use crate::{components::metrics::MetricsRegistry, data::value::Word};
/// avoid locking since we don't need to modify the entire struture.
type ProviderCount = Arc<HashMap<ProviderName, AtomicU64>>;

/// Compression methods for RPC transports
#[derive(Copy, Clone, Debug, Deserialize, Serialize, PartialEq)]
pub enum Compression {
#[serde(rename = "none")]
None,
#[serde(rename = "gzip")]
Gzip,
// Future compression methods can be added here:
// #[serde(rename = "brotli")]
// Brotli,
// #[serde(rename = "deflate")]
// Deflate,
}

impl Default for Compression {
fn default() -> Self {
Compression::None
}
}

/// This struct represents all the current labels except for the result
/// which is added separately. If any new labels are necessary they should
/// remain in the same order as added in [`EndpointMetrics::new`]
Expand Down
1 change: 1 addition & 0 deletions node/resources/tests/full_config.toml
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ shard = "primary"
provider = [
{ label = "mainnet-0", url = "http://rpc.mainnet.io", features = ["archive", "traces"] },
{ label = "mainnet-1", details = { type = "web3call", url = "http://rpc.mainnet.io", features = ["archive", "traces"] }},
{ label = "mainnet-2", details = { type = "web3", url = "http://rpc.mainnet.io", features = ["archive"], compression = "gzip" }},
{ label = "firehose", details = { type = "firehose", url = "http://localhost:9000", features = [] }},
{ label = "substreams", details = { type = "substreams", url = "http://localhost:9000", features = [] }},
]
Expand Down
4 changes: 3 additions & 1 deletion node/src/chain.rs
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,8 @@ pub async fn create_ethereum_networks_for_chain(
logger,
"Creating transport";
"url" => &web3.url,
"capabilities" => capabilities
"capabilities" => capabilities,
"compression" => ?web3.compression
);

use crate::config::Transport::*;
Expand All @@ -293,6 +294,7 @@ pub async fn create_ethereum_networks_for_chain(
web3.headers.clone(),
endpoint_metrics.cheap_clone(),
&provider.label,
web3.compression,
),
Ipc => Transport::new_ipc(&web3.url).await,
Ws => Transport::new_ws(&web3.url).await,
Expand Down
73 changes: 73 additions & 0 deletions node/src/config.rs
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ use graph::{
anyhow::Error,
blockchain::BlockchainKind,
components::network_provider::ChainName,
endpoint::Compression,
env::ENV_VARS,
firehose::{SubgraphLimit, SUBGRAPHS_PER_CONN},
itertools::Itertools,
Expand Down Expand Up @@ -502,6 +503,7 @@ impl ChainSection {
features,
headers: Default::default(),
rules: vec![],
compression: Compression::None,
}),
};
let entry = chains.entry(name.to_string()).or_insert_with(|| Chain {
Expand Down Expand Up @@ -705,6 +707,10 @@ pub struct Web3Provider {

#[serde(default, rename = "match")]
rules: Vec<Web3Rule>,

/// Compression method for RPC requests and responses
#[serde(default)]
pub compression: Compression,
}

impl Web3Provider {
Expand Down Expand Up @@ -901,6 +907,7 @@ impl<'de> Deserialize<'de> for Provider {
.ok_or_else(|| serde::de::Error::missing_field("features"))?,
headers: headers.unwrap_or_else(HeaderMap::new),
rules: nodes,
compression: Compression::None,
}),
};

Expand Down Expand Up @@ -1219,6 +1226,7 @@ mod tests {
Chain, Config, FirehoseProvider, Provider, ProviderDetails, Shard, Transport, Web3Provider,
};
use graph::blockchain::BlockchainKind;
use graph::endpoint::Compression;
use graph::firehose::SubgraphLimit;
use graph::http::{HeaderMap, HeaderValue};
use graph::prelude::regex::Regex;
Expand Down Expand Up @@ -1307,6 +1315,7 @@ mod tests {
features: BTreeSet::new(),
headers: HeaderMap::new(),
rules: Vec::new(),
compression: Compression::None,
}),
},
actual
Expand All @@ -1333,6 +1342,7 @@ mod tests {
features: BTreeSet::new(),
headers: HeaderMap::new(),
rules: Vec::new(),
compression: Compression::None,
}),
},
actual
Expand Down Expand Up @@ -1440,6 +1450,7 @@ mod tests {
features,
headers,
rules: Vec::new(),
compression: Compression::None,
}),
},
actual
Expand All @@ -1465,6 +1476,7 @@ mod tests {
features: BTreeSet::new(),
headers: HeaderMap::new(),
rules: Vec::new(),
compression: Compression::None,
}),
},
actual
Expand Down Expand Up @@ -1834,6 +1846,7 @@ mod tests {
features: BTreeSet::new(),
headers: HeaderMap::new(),
rules: Vec::new(),
compression: Compression::None,
}),
},
actual
Expand All @@ -1846,6 +1859,66 @@ mod tests {
assert!(SubgraphLimit::Limit(10) > SubgraphLimit::Disabled);
}

#[test]
fn it_parses_web3_provider_with_compression() {
let actual = toml::from_str(
r#"
label = "compressed"
details = { type = "web3", url = "http://localhost:8545", features = ["archive"], compression = "gzip" }
"#,
)
.unwrap();

assert_eq!(
Provider {
label: "compressed".to_owned(),
details: ProviderDetails::Web3(Web3Provider {
transport: Transport::Rpc,
url: "http://localhost:8545".to_owned(),
features: {
let mut features = BTreeSet::new();
features.insert("archive".to_string());
features
},
headers: HeaderMap::new(),
rules: Vec::new(),
compression: Compression::Gzip,
}),
},
actual
);
}

#[test]
fn it_parses_web3_provider_with_no_compression() {
let actual = toml::from_str(
r#"
label = "uncompressed"
details = { type = "web3", url = "http://localhost:8545", features = ["archive"], compression = "none" }
"#,
)
.unwrap();

assert_eq!(
Provider {
label: "uncompressed".to_owned(),
details: ProviderDetails::Web3(Web3Provider {
transport: Transport::Rpc,
url: "http://localhost:8545".to_owned(),
features: {
let mut features = BTreeSet::new();
features.insert("archive".to_string());
features
},
headers: HeaderMap::new(),
rules: Vec::new(),
compression: Compression::None,
}),
},
actual
);
}

#[test]
fn duplicated_labels_are_not_allowed_within_chain() {
let mut actual = toml::from_str::<ChainSection>(
Expand Down

AltStyle によって変換されたページ (->オリジナル) /