add some configuration checking + normalization

Signed-off-by: Lance-Drane <[email protected]>

Author: Lance-Drane

.dockerignore

@@ -1,5 +1,7 @@
-/target
-*.tmp
-*.log
-Dockerfile
-.dockerignore
+*
+!proxy-http-client
+!proxy-http-server
+!shared-deps
+!Cargo.lock
+!Cargo.toml
+!rust-toolchain.toml

charts/proxy-http-client/Chart.yaml

@@ -1,7 +1,7 @@
 apiVersion: v2
 name: proxy-http-client
 description: "Subscribe to events over HTTP from a proxy-http-server instance, and publish them on a local broker"
-version: 0.1.0
+version: 0.1.1
 dependencies:
   - name: common
     repository: oci://registry-1.docker.io/bitnamicharts

charts/proxy-http-client/values.yaml

@@ -128,9 +128,9 @@ serviceAccount:
 
 app:
   log_level: "info"
-  topic_prefix: "" # i.e. "organization.facility.system.", you should consciously set this value. It MUST end with a "."
+  topic_prefix: "" # i.e. "organization.facility.system.", you should consciously set this value.
   other_proxy:
-    url: "" # this should not include the path or a trailing slash
+    url: "" # this should not include the path
     username: "" # needed credential for clients calling HTTP endpoints other than /healthcheck
     password: "" # needed credential for clients calling HTTP endpoints other than /healthcheck
   broker:

charts/proxy-http-server/Chart.yaml

@@ -1,7 +1,7 @@
 apiVersion: v2
 name: proxy-http-server
 description: "Subscribe to broker messages and broadcast them to HTTP listeners"
-version: 0.1.0
+version: 0.1.1
 dependencies:
   - name: common
     repository: oci://registry-1.docker.io/bitnamicharts

charts/proxy-http-server/values.yaml

@@ -160,7 +160,7 @@ serviceAccount:
 
 app:
   log_level: "info"
-  topic_prefix: "" # i.e. "organization.facility.system.", you should consciously set this value. It MUST end with a "."
+  topic_prefix: "" # i.e. "organization.facility.system.", you should consciously set this value.
   username: "" # needed credential for clients calling HTTP endpoints other than /healthcheck
   password: "" # needed credential for clients calling HTTP endpoints other than /healthcheck
   broker:

proxy-http-client/conf.yaml

@@ -1,6 +1,6 @@
 # local development config file for the HTTP client
 other_proxy:
-  url: "http://localhost:8080"  # do not include the trailing "/" or any part of the path
+  url: "http://localhost:8080/"  # do not include the path, trailing slash is optional
   username: dummy_username
   password: dummy_password
 broker:
@@ -10,7 +10,6 @@ broker:
   # note: differs from other config file (two separate brokers used)
   port: 5673
 # use amqp topic notation, note that the system is different from the other configuration
-# TODO: current implementation requires this to end with a "." character, this should be fixed...
-topic_prefix: "organization.facility.system2."  # CHANGE THIS PER DEPLOYMENT!!!
+topic_prefix: "organization.facility.system2"  # CHANGE THIS PER DEPLOYMENT!!!
 log_level: "debug"
 production: false

proxy-http-client/src/configuration.rs

@@ -6,10 +6,13 @@
 /// 5) Additional logic can be found in shared-deps/src/configuration.rs
 use secrecy::SecretString;
 
-use intersect_ingress_proxy_common::configuration::{BrokerSettings, LogLevel};
+use intersect_ingress_proxy_common::configuration::{
+    deserialize_enforce_topic_prefixes, deserialize_trim_trailing_slash, BrokerSettings, LogLevel,
+};
 
 #[derive(serde::Deserialize, Clone, Debug)]
 pub struct ExternalProxy {
+    #[serde(deserialize_with = "deserialize_trim_trailing_slash")]
     /// URL for the other ingress proxy we are communicating with
     pub url: String,
     /// Basic authentication credentials for the other proxy
@@ -28,6 +31,7 @@ pub struct Settings {
     pub log_level: LogLevel,
     /// set to true for developer-unfriendly settings (currently just log formats)
     pub production: bool,
+    #[serde(deserialize_with = "deserialize_enforce_topic_prefixes")]
     /// this should only contain the SYSTEM prefix, i.e. "organization.facility.system."
     pub topic_prefix: String,
 }

proxy-http-server/conf.yaml

@@ -7,8 +7,7 @@ broker:
   # note: differs from other config file (two separate brokers used)
   port: 5672
 # use amqp topic notation
-# TODO: current implementation requires this to end with a "." character, this should be fixed...
-topic_prefix: "organization.facility.system."  # CHANGE THIS PER DEPLOYMENT!!!
+topic_prefix: "organization.facility.system"  # CHANGE THIS PER DEPLOYMENT!!!
 log_level: "debug"
 username: dummy_username
 password: dummy_password

proxy-http-server/src/configuration.rs

@@ -7,7 +7,9 @@
 use secrecy::SecretString;
 use serde_aux::field_attributes::deserialize_number_from_string;
 
-use intersect_ingress_proxy_common::configuration::{BrokerSettings, LogLevel};
+use intersect_ingress_proxy_common::configuration::{
+    deserialize_enforce_topic_prefixes, BrokerSettings, LogLevel,
+};
 
 #[derive(serde::Deserialize, Clone)]
 pub struct Settings {
@@ -18,6 +20,7 @@ pub struct Settings {
     pub app_port: u16,
     /// log level of the entire application
     pub log_level: LogLevel,
+    #[serde(deserialize_with = "deserialize_enforce_topic_prefixes")]
     /// this should only contain the SYSTEM prefix, i.e. "organization.facility.system."
     pub topic_prefix: String,
     /// username for Basic Authentication

shared-deps/src/configuration.rs

@@ -4,6 +4,7 @@
 use std::{fmt::Display, str::FromStr};
 
 use secrecy::SecretString;
+use serde::{de::Error as deError, Deserialize, Deserializer};
 use serde_aux::field_attributes::deserialize_number_from_string;
 
 #[derive(serde::Deserialize, Clone, Debug)]
@@ -55,6 +56,67 @@ impl Display for LogLevel {
     }
 }
 
+/// when deserializing, strip out any trailing slashes from the end (useful for URLs)
+pub fn deserialize_trim_trailing_slash<'de, D>(deserializer: D) -> Result<String, D::Error>
+where
+    D: Deserializer<'de>,
+{
+    let mut base: String = Deserialize::deserialize(deserializer)?;
+    if base.ends_with("/") {
+        base.pop();
+    }
+    Ok(base)
+}
+
+/// custom deserializer which enforces and normalizes system names
+pub fn deserialize_enforce_topic_prefixes<'de, D>(deserializer: D) -> Result<String, D::Error>
+where
+    D: Deserializer<'de>,
+{
+    let mut base: String = Deserialize::deserialize(deserializer)?;
+
+    // TODO will need to update this logic later, when we reduce the namespacing as part of a new INTERSECT release
+    let mut period_count = 0_u16;
+    for character in base.chars() {
+        if character == '-' || character.is_ascii_digit() || character.is_ascii_lowercase() {
+            continue;
+        } else if character == '.' {
+            period_count += 1;
+        } else {
+            return Err(deError::custom(format!(
+                "topic_prefix: Invalid character detected: {}",
+                character
+            )));
+        }
+    }
+
+    match period_count {
+        2 => {
+            if base.ends_with(".") {
+                Err(deError::custom(
+                    "topic_prefix: 3 levels of namespacing expected but only 2 provided",
+                ))
+            } else {
+                base += ".";
+                Ok(base)
+            }
+        }
+        3 => {
+            if base.ends_with(".") {
+                Ok(base)
+            } else {
+                Err(deError::custom(
+                    "topic_prefix: 3 levels of namespacing expected but 4 provided",
+                ))
+            }
+        }
+        c => Err(deError::custom(format!(
+            "topic_prefix: Too many periods ({})",
+            c
+        ))),
+    }
+}
+
 /// Common logic for obtaining a configuration of type T
 ///
 /// Rules: