feat(ide): avoid GET url length issues (#756)

## What problem are you trying to solve?

See #754 for more details.

Essentially, the problem we may encounter is URL length being a problem for some of the GET endpoints.

## What is your solution?

Added a v2 version for some GET endpoints that were expecting a base64 representation of a file content as URL path.

We also added a new version for the POST rulesets endpoint just because the naming was more convenient.

## Alternatives considered

## What the reviewer should know

This is a continuation of #754

The idea is to remove the v1 endpoints in 6 months (or re-evaluate).

IDE-4957

Author: robertohuertasm

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

@@ -1,5 +1,9 @@
 use std::path::PathBuf;
 
+use crate::datadog_static_analyzer_server::ide::configuration_file::models::{
+    CanOnboardRequest, GetRulesetsRequest,
+};
+
 use super::error::ConfigFileError;
 use super::models::{AddRuleSetsRequest, IgnoreRuleRequest};
 use super::static_analysis_config_file::StaticAnalysisConfigFile;
@@ -9,13 +13,23 @@ use rocket::response::status::Custom;
 use rocket::serde::json::Json;
 use tracing::instrument;
 
+// TODO: Review DEPRECATED endpoints in 6 months from now: 2025-09-03
+// Considering if we want to support those endpoints for more than 6 months.
+// If not, feel free to remove them.
+
+/// Ignores a rule in the static analysis configuration file.
+///
+/// # Arguments
+/// * `request` - The request containing the rule to ignore and the configuration file (base64).
 #[instrument()]
 #[rocket::post(
     "/v1/config/ignore-rule",
     format = "application/json",
     data = "<request>"
 )]
-pub fn ignore_rule(request: Json<IgnoreRuleRequest>) -> Result<String, Custom<ConfigFileError>> {
+pub fn post_ignore_rule(
+    request: Json<IgnoreRuleRequest>,
+) -> Result<String, Custom<ConfigFileError>> {
     let IgnoreRuleRequest {
         rule,
         configuration_base64,
@@ -27,9 +41,110 @@ pub fn ignore_rule(request: Json<IgnoreRuleRequest>) -> Result<String, Custom<Co
     to_response_result(result, encoded)
 }
 
+/// Checks if onboarding is allowed for the configuration file (deprecated).
+///
+/// # Deprecation
+/// Deprecated: Use [`post_can_onboard_v2`] instead.
+///
+/// # Arguments
+/// * `content` - The path to the configuration file.
+#[instrument()]
+#[rocket::get("/v1/config/can-onboard/<content..>")]
+pub fn get_can_onboard(content: PathBuf) -> Result<Json<bool>, Custom<ConfigFileError>> {
+    let content_str = content.to_string_lossy().into_owned();
+    can_onboard(content_str)
+}
+
+/// Checks if onboarding is allowed for the configuration file (v2).
+///
+/// # Arguments
+/// * `request` - The request containing the configuration file (base64).
+#[instrument()]
+#[rocket::post(
+    "/v2/config/can-onboard",
+    format = "application/json",
+    data = "<request>"
+)]
+pub fn post_can_onboard_v2(
+    request: Json<CanOnboardRequest>,
+) -> Result<Json<bool>, Custom<ConfigFileError>> {
+    let CanOnboardRequest {
+        configuration_base64,
+        ..
+    } = request.into_inner();
+    can_onboard(configuration_base64)
+}
+
+/// Gets the rulesets from the static analysis configuration file (deprecated).
+///
+/// # Deprecation
+/// Deprecated: Use [`post_get_rulesets_v2`] instead.
+///
+/// # Arguments
+/// * `content` - The path to the configuration file.
+#[instrument()]
+#[rocket::get("/v1/config/rulesets/<content..>")]
+pub fn get_get_rulesets(content: PathBuf) -> Json<Vec<String>> {
+    let content_str = content.to_string_lossy().into_owned();
+    get_rulesets(content_str)
+}
+
+/// Gets the rulesets from the static analysis configuration file (v2).
+///
+/// # Arguments
+/// * `request` - The request containing the configuration file (base64).
+#[instrument()]
+#[rocket::post(
+    "/v2/config/get-rulesets",
+    format = "application/json",
+    data = "<request>"
+)]
+pub fn post_get_rulesets_v2(request: Json<GetRulesetsRequest>) -> Json<Vec<String>> {
+    let GetRulesetsRequest {
+        configuration_base64,
+        ..
+    } = request.into_inner();
+    get_rulesets(configuration_base64)
+}
+
+/// Adds rulesets to the static analysis configuration file (deprecated).
+///
+/// # Deprecation
+/// Deprecated: Use [`post_add_rulesets_v2`] instead.
+///
+/// # Arguments
+/// * `request` - The request containing rulesets and configuration file (base64).
 #[instrument()]
 #[rocket::post("/v1/config/rulesets", format = "application/json", data = "<request>")]
-pub fn post_rulesets(request: Json<AddRuleSetsRequest>) -> Result<String, Custom<ConfigFileError>> {
+pub fn post_add_rulesets(
+    request: Json<AddRuleSetsRequest>,
+) -> Result<String, Custom<ConfigFileError>> {
+    add_rulesets(request)
+}
+
+/// Adds rulesets to the static analysis configuration file (v2).
+///
+/// # Arguments
+/// * `request` - The request containing rulesets and configuration file (base64).
+#[instrument()]
+#[rocket::post(
+    "/v2/config/add-rulesets",
+    format = "application/json",
+    data = "<request>"
+)]
+pub fn post_add_rulesets_v2(
+    request: Json<AddRuleSetsRequest>,
+) -> Result<String, Custom<ConfigFileError>> {
+    add_rulesets(request)
+}
+
+// ----------
+
+/// Adds rulesets to the configuration file.
+///
+/// # Arguments
+/// * `request` - The request containing rulesets and configuration file (base64).
+fn add_rulesets(request: Json<AddRuleSetsRequest>) -> Result<String, Custom<ConfigFileError>> {
     let AddRuleSetsRequest {
         rulesets,
         configuration_base64,
@@ -44,25 +159,42 @@ pub fn post_rulesets(request: Json<AddRuleSetsRequest>) -> Result<String, Custom
     to_response_result(result, encoded)
 }
 
-#[instrument()]
-#[rocket::get("/v1/config/rulesets/<content..>")]
-pub fn get_rulesets(content: PathBuf) -> Json<Vec<String>> {
-    let content_str = content.to_string_lossy().into_owned();
-    tracing::debug!(%content_str);
-    Json(StaticAnalysisConfigFile::to_rulesets(content_str))
+/// Extracts rulesets from the configuration file.
+///
+/// # Arguments
+/// * `content` - The configuration file content (base64).
+fn get_rulesets(mut content: String) -> Json<Vec<String>> {
+    if cfg!(target_os = "windows") {
+        // NOTE: this is needed due to how Rocket works with multiple segment captures.
+        // we may get rid of this once v1 endpoints are no longer needed.
+        content = content.replace("\\", "/");
+    }
+    tracing::debug!(%content);
+    Json(StaticAnalysisConfigFile::to_rulesets(content))
 }
 
-#[instrument()]
-#[rocket::get("/v1/config/can-onboard/<content..>")]
-pub fn can_onboard(content: PathBuf) -> Result<Json<bool>, Custom<ConfigFileError>> {
-    let content_str = content.to_string_lossy().into_owned();
-    tracing::debug!(%content_str);
-    let config = StaticAnalysisConfigFile::try_from(content_str)
+/// Checks if onboarding is allowed for the configuration file.
+///
+/// # Arguments
+/// * `content` - The configuration file content (base64).
+fn can_onboard(mut content: String) -> Result<Json<bool>, Custom<ConfigFileError>> {
+    if cfg!(target_os = "windows") {
+        // NOTE: this is needed due to how Rocket works with multiple segment captures.
+        // we may get rid of this once v1 endpoints are no longer needed.
+        content = content.replace("\\", "/");
+    }
+    tracing::debug!(%content);
+    let config = StaticAnalysisConfigFile::try_from(content)
         .map_err(|e| Custom(Status::InternalServerError, e))?;
     let can_onboard = config.is_onboarding_allowed();
     Ok(Json(can_onboard))
 }
 
+/// Converts the result to a response string, optionally encoding it in base64.
+///
+/// # Arguments
+/// * `result` - The result string or error.
+/// * `encode` - Whether to encode the result in base64.
 fn to_response_result(
     result: Result<String, ConfigFileError>,
     encode: bool,

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

@@ -15,3 +15,15 @@ pub struct AddRuleSetsRequest {
     pub configuration_base64: Option<String>,
     pub encoded: bool,
 }
+
+#[derive(Serialize, Deserialize, Debug, Clone, Eq, PartialEq)]
+pub struct GetRulesetsRequest {
+    #[serde(rename = "configuration")]
+    pub configuration_base64: String,
+}
+
+#[derive(Serialize, Deserialize, Debug, Clone, Eq, PartialEq)]
+pub struct CanOnboardRequest {
+    #[serde(rename = "configuration")]
+    pub configuration_base64: String,
+}