feat(config): preserve comments in the static analysis configuration file - IDE-2599

Cargo.toml

@@ -5,7 +5,7 @@ default-members = [
     "crates/cli",
     "crates/static-analysis-kernel",
     "crates/static-analysis-server",
-    "crates/secrets"
+    "crates/secrets",
 ]
 resolver = "2"
 
@@ -39,3 +39,4 @@ sha2 = "0.10.7"
 num_cpus = "1.15.0"
 tracing = "0.1.40"
 uuid = { version = "1.6.1", features = ["v4"] }
+tree-sitter = "0.22.6"

LICENSE-3rdparty.csv

@@ -13,6 +13,7 @@ num_cpus,https://github.com/seanmonstar/num_cpus,MIT, Copyright (c) 2015 Sean Mc
 percent-encoding,https://github.com/servo/rust-url/,MIT, Copyright (c) 2013-2022 The rust-url developers
 prettytable-rs,https://github.com/phsym/prettytable-rs/,BSD-3-Clause,Copyright (c) 2022 Pierre-Henri Symoneaux
 rayon,https://crates.io/crates/rayon,MIT,Copyright (c) 2010 The Rust Project Developers
+pretty_yaml,https://github.com/g-plane/pretty_yaml,MIT,Copyright (c) 2024-present Pig Fang
 rocket,https://github.com/SergioBenitez/Rocket,Apache-2.0,Copyright 2016 Sergio Benitez
 tree-sitter,https://github.com/tree-sitter/tree-sitter,MIT,2014 Max Brunsfeld
 sarif-rs,https://github.com/psastras/sarif-rs,MIT,Copyright (c) 2021 Paul Sastrasinh

crates/bins/Cargo.toml

@@ -48,9 +48,11 @@ serde_json = { workspace = true }
 tracing = { workspace = true }
 uuid = { workspace = true }
 indexmap = { workspace = true }
-num_cpus = { workspace = true}
+num_cpus = { workspace = true }
 serde = { workspace = true }
 serde_yaml = { workspace = true }
+tree-sitter = { workspace = true }
+
 # other
 terminal-emoji = "0.4.1"
 getopts = "0.2.21"
@@ -59,6 +61,7 @@ rayon = "1.7.0"
 rocket = { version = "=0.5.0", features = ["json"] }
 tracing-subscriber = { version = "0.3.18", features = ["fmt", "env-filter"] }
 thiserror = "1"
+pretty_yaml = "0.4"
 
 
 # For linux and macos, we need the vendored ssl

crates/bins/src/bin/datadog-static-analyzer-server.rs

@@ -2,5 +2,5 @@ mod datadog_static_analyzer_server;
 
 #[rocket::main]
 async fn main() {
-    datadog_static_analyzer_server::start().await
+    datadog_static_analyzer_server::start().await;
 }

crates/bins/src/bin/datadog-static-analyzer.rs

@@ -500,7 +500,7 @@ fn main() -> Result<()> {
                 "Analyzing {}, {} files detected",
                 language,
                 files_for_language.len()
-            )
+            );
         }
 
         // take the relative path for the analysis

crates/bins/src/bin/datadog_static_analyzer_server/cli.rs

@@ -8,7 +8,7 @@ use std::{env, process, thread};
 use super::state::ServerState;
 use super::utils::get_current_timestamp_ms;
 
-fn print_usage(program: &str, opts: Options) {
+fn print_usage(program: &str, opts: &Options) {
     let brief = format!("Usage: {} [options]", program);
     print!("{}", opts.usage(&brief));
 }
@@ -61,7 +61,7 @@ pub fn prepare_rocket() -> (Rocket<Build>, ServerState, Sender<Shutdown>) {
     }
 
     if matches.opt_present("h") {
-        print_usage(&program, opts);
+        print_usage(&program, &opts);
         process::exit(0);
     }
 
@@ -122,7 +122,7 @@ pub fn prepare_rocket() -> (Rocket<Build>, ServerState, Sender<Shutdown>) {
 
                     if latest_timestamp > 0 && current_timestamp > latest_timestamp + timeout_ms {
                         eprintln!("exiting because of timeout, trying to exit gracefully");
-                        shutdown_handle.clone().notify();
+                        shutdown_handle.notify();
                         // we give 10 seconds for the process to terminate
                         // if it does not, we abort
                         thread::sleep(Duration::from_secs(10));

crates/bins/src/bin/datadog_static_analyzer_server/endpoints.rs

@@ -149,9 +149,9 @@ async fn serve_static(
 
 /// Catches all OPTION requests in order to get the CORS related Fairing triggered.
 #[rocket::options("/<_..>")]
-fn get_options() -> String {
+const fn get_options() -> String {
     /* Intentionally left empty */
-    "".to_string()
+    String::new()
 }
 
 /// Simple ping method that will return "pong" as response.

crates/bins/src/bin/datadog_static_analyzer_server/fairings.rs

@@ -96,9 +96,9 @@ impl Fairing for KeepAlive {
     }
 }
 
-/// Provides functionality to associate a UUIDv4 per request.
+/// Provides functionality to associate a `UUIDv4` per request.
 ///
-/// Rocket 0.5.0 does not generate per-request IDs (see: https://github.com/rwf2/Rocket/issues/21)
+/// Rocket 0.5.0 does not generate per-request IDs (see: [#21](https://github.com/rwf2/Rocket/issues/21))
 /// Until upstream natively supports this, we use a custom [Fairing] to generate one.
 pub struct TracingFairing;
 
@@ -122,10 +122,10 @@ impl TraceSpan {
     }
 }
 
-/// A newtype Option representing a [Span] that is used to conform to the [Request::local_cache] API
+/// A newtype Option representing a [Span] that is used to conform to the [`Request::local_cache`] API
 struct FairingTraceSpan(Option<Span>);
 
-/// A newtype Option representing a [String] request ID that is used to conform to the [Request::local_cache] API
+/// A newtype Option representing a [String] request ID that is used to conform to the [`Request::local_cache`] API
 struct FairingRequestId(Option<String>);
 
 #[rocket::async_trait]
@@ -141,8 +141,7 @@ impl Fairing for TracingFairing {
         let request_id = req
             .headers()
             .get_one("X-Request-Id")
-            .map(String::from)
-            .unwrap_or_else(|| Uuid::new_v4().to_string());
+            .map_or_else(|| Uuid::new_v4().to_string(), String::from);
 
         let request_span = tracing::info_span!(
             "http_request",

crates/bins/src/bin/datadog_static_analyzer_server/ide/configuration_file/comment_preserver/mod.rs

@@ -0,0 +1,3 @@
+mod models;
+mod reconciler;
+pub use reconciler::{prettify_yaml, reconcile_comments, ReconcileError};

crates/bins/src/bin/datadog_static_analyzer_server/ide/configuration_file/comment_preserver/models.rs

@@ -0,0 +1,24 @@
+#[derive(Debug, Clone, Default)]
+pub struct Line {
+    pub row: usize,
+    pub content: String,
+}
+
+impl Line {
+    pub const fn new(row: usize, content: String) -> Self {
+        Self { row, content }
+    }
+}
+
+#[derive(Debug, Clone)]
+pub enum Comment {
+    Inline {
+        line: Line,
+        original_content: String,
+    },
+    Block {
+        line: Line,
+        above_line: Option<Line>,
+        below_line: Option<Line>,
+    },
+}