Attempt to improve the geth tx indexing issue.

We're facing an issue where Geth transaction indexing can sometimes stall
on some of the nodes we're running. The logs show that for all transactions
we always need 1 second of waiting time. However, during certain runs we
sometimes run into an issue with some of the nodes where it seems like
their transaction indexer fails (either at the start or after some amount
of time) which leads us to never get the receipts back from these specific
nodes.

This is not a load issue as it appears like all of the other nodes handle
it just fine. However, it looks like once a node gets into this state it
can not get out of it and its bricked for the entire run.

This commit adds some more command line arguments to the geth command in
hopes of improving this issue.

crates/compiler/src/revive_resolc.rs

@@ -10,6 +10,10 @@ use crate::{CompilerInput, CompilerOutput, SolidityCompiler};
 use revive_dt_config::Arguments;
 use revive_solc_json_interface::SolcStandardJsonOutput;
 
+// TODO: I believe that we need to also pass the solc compiler to resolc so that resolc uses the
+// specified solc compiler. I believe that currently we completely ignore the specified solc binary
+// when invoking resolc which doesn't seem right if we're using solc as a compiler frontend.
+
 /// A wrapper around the `resolc` binary, emitting PVM-compatible bytecode.
 #[derive(Debug)]
 pub struct Resolc {

crates/core/src/driver/mod.rs

@@ -3,6 +3,7 @@
 use std::collections::HashMap;
 use std::fmt::Debug;
 use std::marker::PhantomData;
+use std::str::FromStr;
 
 use alloy::json_abi::JsonAbi;
 use alloy::network::{Ethereum, TransactionBuilder};
@@ -100,12 +101,30 @@ where
             anyhow::bail!("unsupported solc version: {:?}", &mode.solc_version);
         };
 
+        // Note: if the metadata is contained within a solidity file then this is the only file that
+        // we wish to compile since this is a self-contained test. Otherwise, if it's a JSON file
+        // then we need to compile all of the contracts that are in the directory since imports are
+        // allowed in there.
+        let Some(ref metadata_file_path) = metadata.file_path else {
+            anyhow::bail!("The metadata file path is not defined");
+        };
+        let mut files_to_compile = if metadata_file_path
+            .extension()
+            .is_some_and(|extension| extension.eq_ignore_ascii_case("sol"))
+        {
+            Box::new(std::iter::once(metadata_file_path.clone())) as Box<dyn Iterator<Item = _>>
+        } else {
+            Box::new(
+                FilesWithExtensionIterator::new(metadata.directory()?)
+                    .with_allowed_extension("sol"),
+            )
+        };
+
         let compiler = Compiler::<T::Compiler>::new()
             .allow_path(metadata.directory()?)
             .solc_optimizer(mode.solc_optimize());
-        let mut compiler = FilesWithExtensionIterator::new(metadata.directory()?)
-            .with_allowed_extension("sol")
-            .try_fold(compiler, |compiler, path| compiler.with_source(&path))?;
+        let mut compiler =
+            files_to_compile.try_fold(compiler, |compiler, path| compiler.with_source(&path))?;
         for (library_instance, (library_address, _)) in self.deployed_libraries.iter() {
             let library_ident = &metadata
                 .contracts
@@ -200,12 +219,13 @@ where
         case_idx: CaseIdx,
         input: &Input,
         node: &T::Blockchain,
+        mode: &SolcMode,
     ) -> anyhow::Result<(TransactionReceipt, GethTrace, DiffMode)> {
         let deployment_receipts =
             self.handle_contract_deployment(metadata, case_idx, input, node)?;
         let execution_receipt =
             self.handle_input_execution(case_idx, input, deployment_receipts, node)?;
-        self.handle_input_expectations(case_idx, input, &execution_receipt, node)?;
+        self.handle_input_expectations(case_idx, input, &execution_receipt, node, mode)?;
         self.handle_input_diff(case_idx, execution_receipt, node)
     }
 
@@ -312,6 +332,7 @@ where
         input: &Input,
         execution_receipt: &TransactionReceipt,
         node: &T::Blockchain,
+        mode: &SolcMode,
     ) -> anyhow::Result<()> {
         let span = tracing::info_span!("Handling input expectations");
         let _guard = span.enter();
@@ -367,6 +388,7 @@ where
                 node,
                 expectation,
                 &tracing_result,
+                mode,
             )?;
         }
 
@@ -380,11 +402,16 @@ where
         node: &T::Blockchain,
         expectation: &ExpectedOutput,
         tracing_result: &CallFrame,
+        mode: &SolcMode,
     ) -> anyhow::Result<()> {
-        // TODO: We want to respect the compiler version filter on the expected output but would
-        // require some changes to the interfaces of the compiler and such. So, we add it later.
-        // Additionally, what happens if the compiler filter doesn't match? Do we consider that the
-        // transaction should succeed? Do we just ignore the expectation?
+        if let Some(ref version_requirement) = expectation.compiler_version {
+            let Some(compiler_version) = mode.last_patch_version(&self.config.solc) else {
+                anyhow::bail!("unsupported solc version: {:?}", &mode.solc_version);
+            };
+            if !version_requirement.matches(&compiler_version) {
+                return Ok(());
+            }
+        }
 
         let deployed_contracts = self.deployed_contracts(case_idx);
         let chain_state_provider = node;
@@ -431,8 +458,18 @@ where
                 expected_events.iter().zip(execution_receipt.logs())
             {
                 // Handling the emitter assertion.
-                if let Some(expected_address) = expected_event.address {
-                    let expected = expected_address;
+                if let Some(ref expected_address) = expected_event.address {
+                    let expected = if let Some(contract_instance) = expected_address
+                        .strip_suffix(".address")
+                        .map(ContractInstance::new)
+                    {
+                        deployed_contracts
+                            .get(&contract_instance)
+                            .map(|(address, _)| *address)
+                    } else {
+                        Address::from_str(expected_address).ok()
+                    }
+                    .context("Failed to get the address of the event")?;
                     let actual = actual_event.address();
                     if actual != expected {
                         tracing::error!(
@@ -865,8 +902,13 @@ where
                         tracing::info_span!("Executing input", contract_name = ?input.instance)
                             .in_scope(|| {
                                 let (leader_receipt, _, leader_diff) = match leader_state
-                                    .handle_input(self.metadata, case_idx, &input, self.leader_node)
-                                {
+                                    .handle_input(
+                                        self.metadata,
+                                        case_idx,
+                                        &input,
+                                        self.leader_node,
+                                        &mode,
+                                    ) {
                                     Ok(result) => result,
                                     Err(error) => {
                                         tracing::error!(
@@ -895,6 +937,7 @@ where
                                         case_idx,
                                         &input,
                                         self.follower_node,
+                                        &mode,
                                     ) {
                                     Ok(result) => result,
                                     Err(error) => {

crates/format/src/corpus.rs

@@ -35,33 +35,47 @@ impl Corpus {
 ///
 /// `path` is expected to be a directory.
 pub fn collect_metadata(path: &Path, tests: &mut Vec<MetadataFile>) {
-    let dir_entry = match std::fs::read_dir(path) {
-        Ok(dir_entry) => dir_entry,
-        Err(error) => {
-            tracing::error!("failed to read dir '{}': {error}", path.display());
-            return;
-        }
-    };
-
-    for entry in dir_entry {
-        let entry = match entry {
-            Ok(entry) => entry,
+    if path.is_dir() {
+        let dir_entry = match std::fs::read_dir(path) {
+            Ok(dir_entry) => dir_entry,
             Err(error) => {
-                tracing::error!("error reading dir entry: {error}");
-                continue;
+                tracing::error!("failed to read dir '{}': {error}", path.display());
+                return;
             }
         };
 
-        let path = entry.path();
-        if path.is_dir() {
-            collect_metadata(&path, tests);
-            continue;
-        }
+        for entry in dir_entry {
+            let entry = match entry {
+                Ok(entry) => entry,
+                Err(error) => {
+                    tracing::error!("error reading dir entry: {error}");
+                    continue;
+                }
+            };
 
-        if path.is_file() {
-            if let Some(metadata) = MetadataFile::try_from_file(&path) {
+            let path = entry.path();
+            if path.is_dir() {
+                collect_metadata(&path, tests);
+                continue;
+            }
+
+            if path.is_file() {
+                if let Some(metadata) = MetadataFile::try_from_file(&path) {
+                    tests.push(metadata)
+                }
+            }
+        }
+    } else {
+        let Some(extension) = path.extension() else {
+            tracing::error!("Failed to get file extension");
+            return;
+        };
+        if extension.eq_ignore_ascii_case("sol") || extension.eq_ignore_ascii_case("json") {
+            if let Some(metadata) = MetadataFile::try_from_file(path) {
                 tests.push(metadata)
             }
+        } else {
+            tracing::error!(?extension, "Unsupported file extension");
         }
     }
 }

crates/format/src/input.rs

@@ -51,7 +51,7 @@ pub struct ExpectedOutput {
 
 #[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq)]
 pub struct Event {
-    pub address: Option<Address>,
+    pub address: Option<String>,
     pub topics: Vec<String>,
     pub values: Calldata,
 }
@@ -1010,4 +1010,53 @@ mod tests {
         // Assert
         assert!(resolved.is_err())
     }
+
+    #[test]
+    fn expected_json_can_be_deserialized1() {
+        // Arrange
+        let str = r#"
+        {
+            "return_data": [
+                "1"
+            ],
+            "events": [
+                {
+                    "topics": [],
+                    "values": []
+                }
+            ]
+        }
+        "#;
+
+        // Act
+        let expected = serde_json::from_str::<Expected>(str);
+
+        // Assert
+        expected.expect("Failed to deserialize");
+    }
+
+    #[test]
+    fn expected_json_can_be_deserialized2() {
+        // Arrange
+        let str = r#"
+        {
+            "return_data": [
+                "1"
+            ],
+            "events": [
+                {
+                    "address": "Main.address",
+                    "topics": [],
+                    "values": []
+                }
+            ]
+        }
+        "#;
+
+        // Act
+        let expected = serde_json::from_str::<Expected>(str);
+
+        // Assert
+        expected.expect("Failed to deserialize");
+    }
 }

crates/format/src/metadata.rs

@@ -193,7 +193,7 @@ impl Metadata {
                 metadata.file_path = Some(path.to_path_buf());
                 metadata.contracts = Some(
                     [(
-                        ContractInstance::new("test"),
+                        ContractInstance::new("Test"),
                         ContractPathAndIdent {
                             contract_source_path: path.to_path_buf(),
                             contract_ident: ContractIdent::new("Test"),

crates/node/src/geth.rs

@@ -152,6 +152,10 @@ impl Instance {
             .arg("--nodiscover")
             .arg("--maxpeers")
             .arg("0")
+            .arg("--txlookuplimit")
+            .arg("0")
+            .arg("--cache.blocklogs")
+            .arg("512")
             .stderr(stderr_logs_file.try_clone()?)
             .stdout(stdout_logs_file.try_clone()?)
             .spawn()?
@@ -294,7 +298,10 @@ impl EthereumNode for Instance {
                 }
 
                 match provider.get_transaction_receipt(*transaction_hash).await {
-                    Ok(Some(receipt)) => break Ok(receipt),
+                    Ok(Some(receipt)) => {
+                        tracing::info!(?total_wait_duration, "Found receipt");
+                        break Ok(receipt);
+                    }
                     Ok(None) => {}
                     Err(error) => {
                         let error_string = error.to_string();