Enforce activity name validation and handle reserved formats

Added validation to disallow empty activity names and prevent usage of the reserved "Activity-{number}" format. Updated logic to ensure unique system-generated names do not conflict with user-specified or reserved names. Introduced the `regex` crate to facilitate pattern matching.

Author: Onyekachukwu-Nweke

Cargo.lock

@@ -27,6 +27,7 @@ futures = "0.3.30"
 console-subscriber = { version = "0.4.0", optional = true}
 tokio-util = { version = "0.7.13", features = ["rt"] }
 openssl = { version = "0.10", features = ["vendored"] }
+regex = "1.11.1"
 
 [features]
 dev = ["console-subscriber"]

sim-cli/Cargo.toml

@@ -15,6 +15,7 @@ use std::path::PathBuf;
 use std::sync::Arc;
 use tokio::sync::Mutex;
 use tokio_util::task::TaskTracker;
+use regex::Regex;
 
 /// The default directory where the simulation files are stored and where the results will be written to.
 pub const DEFAULT_DATA_DIR: &str = ".";
@@ -268,8 +269,24 @@ async fn validate_activities(
     for (index, act) in activity.into_iter().enumerate() {
         // Generate a default name if one is not provided
         let name = match &act.name {
-            Some(name) if !name.is_empty() => {
-                // Optionally check for duplicate names
+            Some(name) => {
+                // Disallow empty names
+                if name.is_empty() {
+                    return Err(LightningError::ValidationError(
+                        "activity name cannot be empty".to_string()
+                    ));
+                }
+
+                // Disallow users from using the reserved "Activity-x" format
+                let reserved_pattern = Regex::new(r"^Activity-\d+$").unwrap();
+                if reserved_pattern.is_match(name) {
+                    return Err(LightningError::ValidationError(format!(
+                        "'{}' uses a reserved name format. 'Activity-{{number}}' is reserved for system use.",
+                        name
+                    )));
+                }
+
+                // Check for duplicate names
                 if !activity_names.insert(name.clone()) {
                     return Err(LightningError::ValidationError(format!(
                         "duplicate activity name: {}",
@@ -278,15 +295,19 @@ async fn validate_activities(
                 }
                 name.clone()
             },
-            _ => {
-                let default_name = format!("Activity-{}", index);
-                // Ensure the default name doesn't conflict with an explicit name
-                let mut unique_name = default_name.clone();
-                let mut counter = 1;
-                while !activity_names.insert(unique_name.clone()) {
-                    unique_name = format!("{}-{}", default_name, counter);
+            None => {
+                // Generate a unique system name
+                let mut counter = index;
+                let mut unique_name;
+
+                loop {
+                    unique_name = format!("Activity-{}", counter);
+                    if activity_names.insert(unique_name.clone()) {
+                        break;
+                    }
                     counter += 1;
                 }
+
                 unique_name
             },
         };

sim-cli/src/parsing.rs

@@ -164,7 +164,7 @@ pub type Interval = ValueOrRange<u16>;
 /// This is constructed during activity validation and passed along to the [Simulation].
 #[derive(Debug, Clone)]
 pub struct ActivityDefinition {
-    /// Optional name/identifier for this activity
+    /// Optional identifier for this activity.
     pub name: Option<String>,
     /// The source of the payment.
     pub source: NodeInfo,