feat(lsp): clear documentation on new scans (#23)

This change ensures that previous documentation, such as vulnerability
summaries, is cleared from the editor when a new scan is initiated.

Previously, old documentation would persist after a new build-and-scan
or scan-base-image command was executed, leading to potentially outdated 
information being displayed.

Author: tembleking

.gitignore

@@ -8,3 +8,4 @@ result
 
 .idea
 .vscode
+scan-logs

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "sysdig-lsp"
-version = "0.7.0"
+version = "0.7.1"
 edition = "2024"
 authors = [ "Sysdig Inc." ]
 readme = "README.md"

Cargo.toml

@@ -68,4 +68,8 @@ where
             .read_documentation_at(uri, position)
             .await
     }
+
+    pub async fn remove_documentations(&self, uri: &str) {
+        self.document_database.remove_documentations(uri).await
+    }
 }

src/app/lsp_interactor.rs

@@ -113,6 +113,7 @@ where
             diagnostics_for_layers(&document_text, &scan_result)?;
 
         self.interactor.remove_diagnostics(uri).await;
+        self.interactor.remove_documentations(uri).await;
         self.interactor
             .append_document_diagnostics(uri, &[diagnostic])
             .await;

src/app/lsp_server/commands/build_and_scan.rs

@@ -102,6 +102,7 @@ where
 
         let uri = self.location.uri.as_str();
         self.interactor.remove_diagnostics(uri).await;
+        self.interactor.remove_documentations(uri).await;
         self.interactor
             .append_document_diagnostics(uri, &[diagnostic])
             .await;

src/app/lsp_server/commands/scan_base_image.rs

@@ -66,8 +66,10 @@ mod test {
                 pull_string: "ubuntu:23.04".to_string(),
                 image_id: "sha256:f4cdeba72b994748f5eb1f525a70a9cc553b66037ec37e23645fbf3f0f5c160d"
                     .to_string(),
-                digest: "sha256:5a828e28de105c3d7821c4442f0f5d1c52dc16acf4999d5f31a3bc0f03f06edd"
-                    .to_string(),
+                digest: Some(
+                    "sha256:5a828e28de105c3d7821c4442f0f5d1c52dc16acf4999d5f31a3bc0f03f06edd"
+                        .to_string(),
+                ),
                 base_os: "ubuntu 23.04".to_string(),
 
                 total_vulns_found: MarkdownSummaryTable {

src/app/markdown/markdown_data.rs

@@ -8,7 +8,7 @@ use super::markdown_summary_table::MarkdownSummaryTable;
 pub struct MarkdownSummary {
     pub pull_string: String,
     pub image_id: String,
-    pub digest: String,
+    pub digest: Option<String>,
     pub base_os: String,
     pub total_vulns_found: MarkdownSummaryTable,
 }
@@ -18,7 +18,7 @@ impl From<&ScanResult> for MarkdownSummary {
         MarkdownSummary {
             pull_string: value.metadata().pull_string().to_string(),
             image_id: value.metadata().image_id().to_string(),
-            digest: value.metadata().digest().unwrap_or("").to_string(),
+            digest: value.metadata().digest().map(|s| s.to_string()),
             base_os: value.metadata().base_os().name().to_string(),
             total_vulns_found: MarkdownSummaryTable::from(value),
         }
@@ -27,11 +27,15 @@ impl From<&ScanResult> for MarkdownSummary {
 
 impl Display for MarkdownSummary {
     fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
-        let format = format!(
-            "### Summary\n* **PullString**: {}\n* **ImageID**: `{}`\n* **Digest**: `{}`\n* **BaseOS**: {}\n\n{}",
-            &self.pull_string, &self.image_id, &self.digest, &self.base_os, &self.total_vulns_found
-        );
-
-        f.write_str(&format)
+        writeln!(f, "### Summary")?;
+        writeln!(f, "* **PullString**: {}", self.pull_string)?;
+        writeln!(f, "* **ImageID**: `{}`", self.image_id)?;
+        match &self.digest {
+            Some(digest) => writeln!(f, "* **Digest**: `{}`", digest)?,
+            None => writeln!(f, "* **Digest**: None")?,
+        }
+        writeln!(f, "* **BaseOS**: {}", self.base_os)?;
+        writeln!(f)?;
+        write!(f, "{}", self.total_vulns_found)
     }
 }