diff --git a/Cargo.lock b/Cargo.lock index 4364da5fa69..0462ce4432a 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -2500,6 +2500,12 @@ dependencies = [ "wasm-bindgen", ] +[[package]] +name = "json_comments" +version = "0.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "41ee439ee368ba4a77ac70d04f14015415af8600d6c894dc1f11bd79758c57d5" + [[package]] name = "keccak" version = "0.1.0" @@ -3016,6 +3022,7 @@ dependencies = [ "anyhow", "chrono", "derive_more", + "near-config-utils", "near-crypto", "near-o11y", "near-primitives", @@ -3134,6 +3141,13 @@ dependencies = [ "thiserror", ] +[[package]] +name = "near-config-utils" +version = "0.0.0" +dependencies = [ + "json_comments", +] + [[package]] name = "near-crypto" version = "0.0.0" @@ -3147,6 +3161,7 @@ dependencies = [ "ed25519-dalek", "hex-literal", "near-account-id", + "near-config-utils", "near-stdx", "once_cell", "primitive-types", @@ -3839,6 +3854,7 @@ dependencies = [ "near-chunks", "near-client", "near-client-primitives", + "near-config-utils", "near-crypto", "near-dyn-configs", "near-epoch-manager", diff --git a/Cargo.toml b/Cargo.toml index f21e603ee34..1d9b06f8206 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -57,6 +57,7 @@ members = [ "tools/state-viewer", "tools/storage-usage-delta-calculator", "tools/themis", + "utils/config", "utils/mainnet-res", "utils/near-cache", "utils/stdx", @@ -124,6 +125,7 @@ indicatif = { version = "0.15.0", features = ["with_rayon"] } insta = { version = "1.26.0", features = ["json", "yaml"] } itertools = "0.10.0" itoa = "1.0" +json_comments = "0.2.1" libc = "0.2.81" libfuzzer-sys = { version = "0.4", features = ["arbitrary-derive"] } log = "0.4" diff --git a/core/chain-configs/Cargo.toml b/core/chain-configs/Cargo.toml index 59347e863d0..31954c486dd 100644 --- a/core/chain-configs/Cargo.toml +++ b/core/chain-configs/Cargo.toml @@ -25,6 +25,7 @@ tracing.workspace = true near-crypto = { path = "../crypto" } near-o11y = { path = "../o11y" } near-primitives = { path = "../primitives" } +near-config-utils = { path = "../../utils/config" } [features] default = [] diff --git a/core/chain-configs/src/genesis_config.rs b/core/chain-configs/src/genesis_config.rs index ad1d958f557..e03e4daab05 100644 --- a/core/chain-configs/src/genesis_config.rs +++ b/core/chain-configs/src/genesis_config.rs @@ -258,21 +258,28 @@ pub struct Genesis { impl GenesisConfig { /// Parses GenesisConfig from a JSON string. - /// + /// The string can be a JSON with comments. /// It panics if the contents cannot be parsed from JSON to the GenesisConfig structure. pub fn from_json(value: &str) -> Self { - serde_json::from_str(value).expect("Failed to deserialize the genesis config.") + let json_str_without_comments: String = + near_config_utils::strip_comments_from_json_str(&value.to_string()) + .expect("Failed to strip comments from genesis config."); + serde_json::from_str(&json_str_without_comments) + .expect("Failed to deserialize the genesis config.") } /// Reads GenesisConfig from a JSON file. - /// + /// The file can be a JSON with comments. /// It panics if file cannot be open or read, or the contents cannot be parsed from JSON to the /// GenesisConfig structure. pub fn from_file>(path: P) -> anyhow::Result { - let file = File::open(path).with_context(|| "Could not open genesis config file.")?; - let reader = BufReader::new(file); - let genesis_config: GenesisConfig = serde_json::from_reader(reader) - .with_context(|| "Failed to deserialize the genesis records.")?; + let mut file = File::open(path).with_context(|| "Could not open genesis config file.")?; + let mut json_str = String::new(); + file.read_to_string(&mut json_str)?; + let json_str_without_comments: String = + near_config_utils::strip_comments_from_json_str(&json_str)?; + let genesis_config: GenesisConfig = serde_json::from_str(&json_str_without_comments) + .with_context(|| "Failed to deserialize the genesis config.")?; Ok(genesis_config) } @@ -309,12 +316,19 @@ impl GenesisRecords { } /// Reads GenesisRecords from a JSON file. - /// + /// The file can be a JSON with comments. /// It panics if file cannot be open or read, or the contents cannot be parsed from JSON to the /// GenesisConfig structure. pub fn from_file>(path: P) -> Self { - let reader = BufReader::new(File::open(path).expect("Could not open genesis config file.")); - serde_json::from_reader(reader).expect("Failed to deserialize the genesis records.") + let mut file = File::open(path).expect("Failed to open genesis config file."); + let mut json_str = String::new(); + file.read_to_string(&mut json_str) + .expect("Failed to read the genesis config file to string. "); + let json_str_without_comments: String = + near_config_utils::strip_comments_from_json_str(&json_str) + .expect("Failed to strip comments from Genesis config file."); + serde_json::from_str(&json_str_without_comments) + .expect("Failed to deserialize the genesis records.") } /// Writes GenesisRecords to the file. @@ -394,11 +408,13 @@ impl<'de, F: FnMut(StateRecord)> DeserializeSeed<'de> for RecordsProcessor<&'_ m } } +/// The file can be a JSON with comments pub fn stream_records_from_file( reader: impl Read, mut callback: impl FnMut(StateRecord), ) -> serde_json::Result<()> { - let mut deserializer = serde_json::Deserializer::from_reader(reader); + let reader_without_comments = near_config_utils::strip_comments_from_json_reader(reader); + let mut deserializer = serde_json::Deserializer::from_reader(reader_without_comments); let records_processor = RecordsProcessor { sink: &mut callback }; deserializer.deserialize_any(records_processor) } @@ -449,10 +465,16 @@ impl Genesis { } /// Reads Genesis from a single file. + /// the file can be JSON with comments pub fn from_file>(path: P, genesis_validation: GenesisValidationMode) -> Self { - let reader = BufReader::new(File::open(path).expect("Could not open genesis config file.")); - let genesis: Genesis = - serde_json::from_reader(reader).expect("Failed to deserialize the genesis records."); + let mut file = File::open(path).expect("Could not open genesis config file."); + let mut json_str = String::new(); + file.read_to_string(&mut json_str).expect("Failed to read genesis config file to string. "); + let json_str_without_comments: String = + near_config_utils::strip_comments_from_json_str(&json_str) + .expect("Failed to strip comments from Genesis config file."); + let genesis: Genesis = serde_json::from_str(&json_str_without_comments) + .expect("Failed to deserialize the genesis records."); // As serde skips the `records_file` field, we can assume that `Genesis` has `records` and // doesn't have `records_file`. Self::new_validated(genesis.config, genesis.records, genesis_validation) diff --git a/core/crypto/Cargo.toml b/core/crypto/Cargo.toml index a3834fbb4b5..2a0a0ac9c1c 100644 --- a/core/crypto/Cargo.toml +++ b/core/crypto/Cargo.toml @@ -28,6 +28,7 @@ serde_json.workspace = true stdx.workspace = true subtle.workspace = true thiserror.workspace = true +near-config-utils = { path = "../../utils/config" } [dev-dependencies] hex-literal = "0.2" diff --git a/core/crypto/src/key_file.rs b/core/crypto/src/key_file.rs index 6d570fd9985..2e2182d124d 100644 --- a/core/crypto/src/key_file.rs +++ b/core/crypto/src/key_file.rs @@ -1,12 +1,10 @@ +use serde::{Deserialize, Serialize}; use std::fs::File; use std::io; -use std::io::Write; +use std::io::{Read, Write}; use std::path::Path; -use serde::{Deserialize, Serialize}; - use crate::{PublicKey, SecretKey}; - use near_account_id::AccountId; #[derive(Serialize, Deserialize)] @@ -39,8 +37,13 @@ impl KeyFile { } pub fn from_file(path: &Path) -> io::Result { - let content = std::fs::read_to_string(path)?; - Ok(serde_json::from_str(&content)?) + let mut file = File::open(path)?; + let mut json_config_str = String::new(); + file.read_to_string(&mut json_config_str)?; + let json_str_without_comments: String = + near_config_utils::strip_comments_from_json_str(&json_config_str)?; + + Ok(serde_json::from_str(&json_str_without_comments)?) } } diff --git a/nearcore/Cargo.toml b/nearcore/Cargo.toml index 28090e5d071..bc070ec74f4 100644 --- a/nearcore/Cargo.toml +++ b/nearcore/Cargo.toml @@ -56,6 +56,7 @@ near-store = { path = "../core/store" } near-telemetry = { path = "../chain/telemetry" } near-vm-runner = { path = "../runtime/near-vm-runner"} node-runtime = { path = "../runtime/runtime" } +near-config-utils = { path = "../utils/config" } delay-detector = { path = "../tools/delay-detector" } diff --git a/nearcore/src/config.rs b/nearcore/src/config.rs index 43f05120c0b..2ad4d0b3118 100644 --- a/nearcore/src/config.rs +++ b/nearcore/src/config.rs @@ -395,11 +395,12 @@ impl Default for Config { impl Config { pub fn from_file(path: &Path) -> anyhow::Result { - let contents = std::fs::read_to_string(path) + let json_str = std::fs::read_to_string(path) .with_context(|| format!("Failed to read config from {}", path.display()))?; let mut unrecognised_fields = Vec::new(); + let json_str_without_comments = near_config_utils::strip_comments_from_json_str(&json_str)?; let config: Config = serde_ignored::deserialize( - &mut serde_json::Deserializer::from_str(&contents), + &mut serde_json::Deserializer::from_str(&json_str_without_comments), |field| { let field = field.to_string(); // TODO(mina86): Remove this deprecation notice some time by the @@ -1297,11 +1298,15 @@ struct NodeKeyFile { } impl NodeKeyFile { + // the file can be JSON with comments fn from_file(path: &Path) -> std::io::Result { let mut file = File::open(path)?; - let mut content = String::new(); - file.read_to_string(&mut content)?; - Ok(serde_json::from_str(&content)?) + let mut json_str = String::new(); + file.read_to_string(&mut json_str)?; + + let json_str_without_comments = near_config_utils::strip_comments_from_json_str(&json_str)?; + + Ok(serde_json::from_str(&json_str_without_comments)?) } } diff --git a/nearcore/src/dyn_config.rs b/nearcore/src/dyn_config.rs index e68fd67b3a6..e6a6884c4a6 100644 --- a/nearcore/src/dyn_config.rs +++ b/nearcore/src/dyn_config.rs @@ -52,6 +52,7 @@ fn read_log_config(home_dir: &Path) -> Result, UpdateableConfi read_json_config::(&home_dir.join(LOG_CONFIG_FILENAME)) } +// the file can be JSON with comments fn read_json_config( path: &Path, ) -> Result, UpdateableConfigLoaderError> @@ -59,12 +60,21 @@ where for<'a> T: Deserialize<'a>, { match std::fs::read_to_string(path) { - Ok(config_str) => match serde_json::from_str::(&config_str) { - Ok(config) => { - tracing::info!(target: "neard", config=?config, "Changing the config {path:?}."); - return Ok(Some(config)); + Ok(config_str) => match near_config_utils::strip_comments_from_json_str(&config_str) { + Ok(config_str_without_comments) => { + match serde_json::from_str::(&config_str_without_comments) { + Ok(config) => { + tracing::info!(target: "neard", config=?config, "Changing the config {path:?}."); + return Ok(Some(config)); + } + Err(err) => { + Err(UpdateableConfigLoaderError::Parse { file: path.to_path_buf(), err }) + } + } + } + Err(err) => { + Err(UpdateableConfigLoaderError::OpenAndRead { file: path.to_path_buf(), err }) } - Err(err) => Err(UpdateableConfigLoaderError::Parse { file: path.to_path_buf(), err }), }, Err(err) => match err.kind() { std::io::ErrorKind::NotFound => { diff --git a/utils/config/Cargo.toml b/utils/config/Cargo.toml new file mode 100644 index 00000000000..eb999287df0 --- /dev/null +++ b/utils/config/Cargo.toml @@ -0,0 +1,14 @@ +[package] +name = "near-config-utils" +version = "0.0.0" +license = "MIT OR Apache-2.0" +authors.workspace = true +publish = true +# Please update rust-toolchain.toml as well when changing version here: +rust-version.workspace = true +edition.workspace = true +repository = "https://github.com/near/nearcore" +description = "This is an internal crate to provide utils for reading config files" + +[dependencies] +json_comments.workspace = true diff --git a/utils/config/LICENSE-APACHE b/utils/config/LICENSE-APACHE new file mode 100644 index 00000000000..f49a4e16e68 --- /dev/null +++ b/utils/config/LICENSE-APACHE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. \ No newline at end of file diff --git a/utils/config/LICENSE-MIT b/utils/config/LICENSE-MIT new file mode 100644 index 00000000000..749aa1ecd9b --- /dev/null +++ b/utils/config/LICENSE-MIT @@ -0,0 +1,19 @@ +The MIT License (MIT) + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. \ No newline at end of file diff --git a/utils/config/src/lib.rs b/utils/config/src/lib.rs new file mode 100644 index 00000000000..2de28c90418 --- /dev/null +++ b/utils/config/src/lib.rs @@ -0,0 +1,18 @@ +use std::io::Read; + +use json_comments::StripComments; + +// strip comments from a JSON string with comments. +// the comment formats that are supported: //, /* */ and #. +// json-comments-rs is used +// check out more details: https://github.com/tmccombs/json-comments-rs/blob/main/src/lib.rs +pub fn strip_comments_from_json_str(json_str: &String) -> std::io::Result { + let mut content_without_comments = String::new(); + StripComments::new(json_str.as_bytes()).read_to_string(&mut content_without_comments)?; + Ok(content_without_comments) +} + +// strip comments from a JSON input with comments. +pub fn strip_comments_from_json_reader(reader: impl Read) -> impl Read { + StripComments::new(reader) +}