chore(instrumentation): Add comments for future improvements

Author: NickLarsenNZ

rust/helm-sys/src/lib.rs

@@ -56,6 +56,8 @@ pub fn uninstall_helm_release(
     }
 }
 
+// TODO (@NickLarsenNZ): Add tracing to helm-sys, maybe?
+// #[instrument]
 pub fn check_helm_release_exists(release_name: &str, namespace: &str) -> bool {
     let release_name = CString::new(release_name).unwrap();
     let namespace = CString::new(namespace).unwrap();

rust/stackable-cockpit/src/utils/chartsource.rs

@@ -4,6 +4,9 @@ use serde::Deserialize;
 
 #[derive(Clone, Debug, Deserialize)]
 pub struct ChartSourceMetadata {
+    // TODO (@NickLarsenNZ): Add a field for the repo name.
+    // This would remove the need for the nested HashMaps
+    // See: around rust/stackablectl/src/cmds/operator.rs:519
     pub entries: HashMap<String, Vec<ChartSourceEntry>>,
 }
 

rust/stackablectl/src/cmds/operator.rs

@@ -468,6 +468,19 @@ async fn build_source_index_file_list<'a>(
             source_index_files = oci::get_oci_index().await.context(OciSnafu)?;
 
             debug!(count = source_index_files.len(), "OCI Repository entries");
+
+            // TODO (@NickLarsenNZ): Look into why this is so deeply nested with duplicate data.
+            // source_index_files
+            //     .iter()
+            //     .for_each(|(&repo_name, chart_source_metadata)| {
+            //         let x = chart_source_metadata.entries.len();
+            //         tracing::trace!(repo_name, x, "thing");
+            //         let _ = &chart_source_metadata
+            //             .entries
+            //             .iter()
+            //             // y (below) is a Vec
+            //             .for_each(|(x, y)| tracing::error!(x, "blah {:?}", y));
+            //     });
         }
         ChartSourceType::Repo => {
             for helm_repo_name in [