rename ingestor_url to ingestor_endpoint

Author: Eshanatnight

server/src/cli.rs

@@ -88,7 +88,7 @@ pub struct Cli {
     pub mode: Mode,
 
     /// public address for the parseable server ingestor
-    pub ingestor_url: String,
+    pub ingestor_endpoint: String,
 }
 
 impl Cli {
@@ -115,7 +115,7 @@ impl Cli {
     pub const ROW_GROUP_SIZE: &'static str = "row-group-size";
     pub const PARQUET_COMPRESSION_ALGO: &'static str = "compression-algo";
     pub const MODE: &'static str = "mode";
-    pub const INGESTOR_URL: &'static str = "ingestor-url";
+    pub const INGESTOR_ENDPOINT: &'static str = "ingestor-endpoint";
     pub const DEFAULT_USERNAME: &'static str = "admin";
     pub const DEFAULT_PASSWORD: &'static str = "admin";
 
@@ -317,9 +317,9 @@ impl Cli {
                     .help("Mode of operation"),
             )
             .arg(
-            	Arg::new(Self::INGESTOR_URL)
-             		.long(Self::INGESTOR_URL)
-               		.env("P_INGESTOR_URL")
+            	Arg::new(Self::INGESTOR_ENDPOINT)
+             		.long(Self::INGESTOR_ENDPOINT)
+               		.env("P_INGESTOR_ENDPOINT")
                  	.value_name("URL")
                   	.required(false)
                     .help("URL to connect to this specific ingestor. Default is the address of the server.")
@@ -367,8 +367,8 @@ impl FromArgMatches for Cli {
             .cloned()
             .expect("default value for address");
 
-        self.ingestor_url = m
-            .get_one::<String>(Self::INGESTOR_URL)
+        self.ingestor_endpoint = m
+            .get_one::<String>(Self::INGESTOR_ENDPOINT)
             .cloned()
             .unwrap_or_else(String::default);
 

server/src/utils.rs

@@ -226,24 +226,27 @@ impl TimePeriod {
     }
 }
 
-// TODO: CLEAN UP
 pub fn get_address() -> Url {
-    if CONFIG.parseable.ingestor_url.is_empty() {
-        let url = format!(
+    if CONFIG.parseable.ingestor_endpoint.is_empty() {
+        return format!(
             "{}://{}",
             CONFIG.parseable.get_scheme(),
             CONFIG.parseable.address
-        );
-        return url.parse::<Url>().unwrap();
+        )
+        .parse::<Url>() // if the value was improperly set, this will panic before hand
+        .unwrap();
     }
     let addr_from_env = CONFIG
         .parseable
-        .ingestor_url
+        .ingestor_endpoint
         .split(':')
         .collect::<Vec<&str>>();
 
     let mut hostname = addr_from_env[0].to_string();
     let mut port = addr_from_env[1].to_string();
+
+    // if the env var value fits the pattern $VAR_NAME:$VAR_NAME
+    // fetch the value from the specified env vars
     if hostname.starts_with('$') {
         let var_hostname = hostname[1..].to_string();
         hostname = get_from_env(&var_hostname);
@@ -259,6 +262,7 @@ pub fn get_address() -> Url {
     format!("{}:{}", hostname, port).parse::<Url>().unwrap()
 }
 
+/// util fuction to fetch value from an env var
 fn get_from_env(var_to_fetch: &str) -> String {
     env::var(var_to_fetch).unwrap_or_else(|_| "".to_string())
 }