chore(errors): hide the TooManyFunctions error variant behind a featu…

…re flag (#5052) Context: #5042 (comment) Hides the `TooManyFunctions` error variant behind a feature gate to avoid it leaking into the `rpc_errors_schema.json` dump.
near · Oct 21, 2021 · 4c98e20 · 4c98e20
1 parent 2a3747e
commit 4c98e20
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 11 deletions.
diff --git a/runtime/near-vm-errors/Cargo.toml b/runtime/near-vm-errors/Cargo.toml
@@ -24,6 +24,7 @@ near-rpc-error-macro = { path = "../../tools/rpctypegen/macro", version = "0.1.0
 [features]
 dump_errors_schema = ["near-rpc-error-macro/dump_errors_schema"]
 protocol_feature_alt_bn128 = []
+protocol_feature_limit_contract_functions_number = []
 
 [package.metadata.workspaces]
 independent = true
diff --git a/runtime/near-vm-errors/src/lib.rs b/runtime/near-vm-errors/src/lib.rs
@@ -144,6 +144,7 @@ pub enum PrepareError {
     /// Error creating memory.
     Memory,
     /// Contract contains too many functions.
+    #[cfg(feature = "protocol_feature_limit_contract_functions_number")]
     TooManyFunctions,
 }
 
@@ -293,6 +294,7 @@ impl fmt::Display for PrepareError {
             StackHeightInstrumentation => write!(f, "Stack instrumentation failed."),
             Instantiate => write!(f, "Error happened during instantiation."),
             Memory => write!(f, "Error creating memory."),
+            #[cfg(feature = "protocol_feature_limit_contract_functions_number")]
             TooManyFunctions => write!(f, "Too many functions in contract."),
         }
     }

diff --git a/runtime/near-vm-runner/Cargo.toml b/runtime/near-vm-runner/Cargo.toml
@@ -72,7 +72,7 @@ protocol_feature_alt_bn128 = [
     "near-primitives/protocol_feature_alt_bn128",
     "near-vm-errors/protocol_feature_alt_bn128"
 ]
-protocol_feature_limit_contract_functions_number = ["near-primitives/protocol_feature_limit_contract_functions_number"]
+protocol_feature_limit_contract_functions_number = ["near-primitives/protocol_feature_limit_contract_functions_number", "near-vm-errors/protocol_feature_limit_contract_functions_number"]
 nightly_protocol = ["near-primitives/nightly_protocol"]
 
 [package.metadata.cargo-udeps.ignore]

diff --git a/runtime/near-vm-runner/src/tests/compile_errors.rs b/runtime/near-vm-runner/src/tests/compile_errors.rs
@@ -4,6 +4,7 @@ use near_primitives::version::ProtocolFeature;
 use near_primitives::version::PROTOCOL_VERSION;
 use near_vm_errors::{CompilationError, FunctionCallError, PrepareError, VMError};
 
+#[cfg(feature = "protocol_feature_limit_contract_functions_number")]
 use assert_matches::assert_matches;
 
 use crate::tests::{
@@ -191,15 +192,14 @@ fn test_limit_contract_functions_number() {
             new_protocol_version,
             vm_kind,
         );
-        if cfg!(feature = "protocol_feature_limit_contract_functions_number") {
-            assert_matches!(
-                err,
-                Some(VMError::FunctionCallError(FunctionCallError::CompilationError(
-                    CompilationError::PrepareError(PrepareError::TooManyFunctions)
-                )))
-            );
-        } else {
-            assert_eq!(err, None);
-        }
+        #[cfg(not(feature = "protocol_feature_limit_contract_functions_number"))]
+        assert_eq!(err, None);
+        #[cfg(feature = "protocol_feature_limit_contract_functions_number")]
+        assert_matches!(
+            err,
+            Some(VMError::FunctionCallError(FunctionCallError::CompilationError(
+                CompilationError::PrepareError(PrepareError::TooManyFunctions)
+            )))
+        );
     });
 }