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 [
@@ -504,7 +517,11 @@ fn build_versions_list(
     let mut versions_list = IndexMap::new();
 
     for operator in operator::VALID_OPERATORS {
+        tracing::info!("iteration");
+        // TODO (@NickLarsenNZ): IMO, helm_repo_name should be inside ChartSourceMetadata
         for (helm_repo_name, helm_repo_index_file) in helm_index_files {
+            tracing::warn!("inner iteration");
+            // TODO (@NickLarsenNZ): Make this helm_repo_index_file.versions(operator);
             let versions = list_operator_versions_from_repo(operator, helm_repo_index_file)?;
             let entry = versions_list.entry(operator.to_string());
             let entry = entry.or_insert(OperatorVersionList(HashMap::new()));
@@ -531,6 +548,7 @@ where
     let operator_name = operator_name.as_ref();
 
     for (helm_repo_name, helm_repo_index_file) in helm_index_files {
+        // tracing::error!("and called again");
         let versions = list_operator_versions_from_repo(operator_name, helm_repo_index_file)?;
         versions_list.0.insert(helm_repo_name.to_string(), versions);
     }
@@ -547,7 +565,11 @@ fn list_operator_versions_from_repo<T>(
 where
     T: AsRef<str> + std::fmt::Display + std::fmt::Debug,
 {
-    debug!("Listing operator versions from repo");
+    // TODO (@NickLarsenNZ): Consider tracing::trace! here
+    debug!(
+        "Listing operator versions from repo {:?}",
+        helm_repo.entries
+    );
 
     let operator_name = utils::operator_chart_name(operator_name.as_ref());
 
@@ -556,6 +578,7 @@ where
             let mut versions = entries
                 .iter()
                 .map(|entry| {
+                    debug!(entry.version, "what is going on?");
                     Version::parse(&entry.version).with_context(|_| InvalidHelmChartVersionSnafu {
                         version: entry.version.clone(),
                     })