[#674] Move internal service check logic to ServiceName

Author: orecham

BUILD.bazel

@@ -177,7 +177,6 @@ filegroup(
         "//benchmarks/publish-subscribe:all_srcs",
         "//benchmarks/queue:all_srcs",
         "//benchmarks/request-response:all_srcs",
-        "//iceoryx2-services/common:all_srcs",
         "//iceoryx2-services/discovery:all_srcs",
         "//iceoryx2:all_srcs",
         "//iceoryx2-bb/container:all_srcs",

Cargo.lock

@@ -22,7 +22,6 @@ members = [
     "iceoryx2-pal/posix/",
     "iceoryx2-pal/configuration/",
 
-    "iceoryx2-services/common",
     "iceoryx2-services/discovery",
 
     "iceoryx2-cli",
@@ -77,7 +76,6 @@ iceoryx2-ffi-macros = { version = "0.5.0", path = "iceoryx2-ffi/ffi-macros" }
 
 iceoryx2 = { version = "0.5.0", path = "iceoryx2/" }
 
-iceoryx2-services-common = { version = "0.5.0", path = "iceoryx2-services/common"}
 iceoryx2-services-discovery = { version = "0.5.0", path = "iceoryx2-services/discovery"}
 
 iceoryx2-cli = { version = "0.5.0", path = "iceoryx2_cli/"}

Cargo.toml

@@ -90,7 +90,6 @@ maybe(
         "//:benchmarks/queue/Cargo.toml",
         "//:benchmarks/request-response/Cargo.toml",
         "//:examples/Cargo.toml",
-        "//:iceoryx2-services/common/Cargo.toml",
         "//:iceoryx2-services/discovery/Cargo.toml",
         "//:iceoryx2/Cargo.toml",
         "//:iceoryx2-bb/container/Cargo.toml",

WORKSPACE.bazel

@@ -24,7 +24,6 @@ rust_library(
     srcs = glob(["src/**/*.rs"]),
     deps = [
         "//iceoryx2:iceoryx2",
-        "//iceoryx2-services/common:iceoryx2-services-common",
         "@crate_index//:once_cell",
         "@crate_index//:serde",
         "@crate_index//:serde_json",

iceoryx2-services/common/BUILD.bazel

@@ -17,7 +17,6 @@ path = "src/lib.rs"
 
 [dependencies]
 iceoryx2 = { workspace = true }
-iceoryx2-services-common = { workspace = true }
 once_cell = { workspace = true }
 serde = { workspace = true }
 serde_json = { workspace = true }

iceoryx2-services/common/Cargo.toml

@@ -18,7 +18,6 @@ use iceoryx2::{
     prelude::{AllocationStrategy, ServiceName},
     service::{static_config::StaticConfig, Service as ServiceType, ServiceDetails},
 };
-use iceoryx2_services_common::{is_internal_service, INTERNAL_SERVICE_PREFIX};
 
 use once_cell::sync::Lazy;
 
@@ -290,7 +289,7 @@ impl<S: ServiceType> Service<S> {
         for id in &added_ids {
             if let Some(service) = self.tracker.get(id) {
                 if !self.discovery_config.include_internal
-                    && is_internal_service(service.static_details.name())
+                    && ServiceName::is_internal(service.static_details.name())
                 {
                     continue;
                 }
@@ -302,7 +301,7 @@ impl<S: ServiceType> Service<S> {
 
         for service in &removed_services {
             if !self.discovery_config.include_internal
-                && is_internal_service(service.static_details.name())
+                && ServiceName::is_internal(service.static_details.name())
             {
                 continue;
             }
@@ -358,7 +357,7 @@ impl<S: ServiceType> Service<S> {
 ///
 pub fn service_name() -> &'static ServiceName {
     static SERVICE_NAME_INSTANCE: Lazy<ServiceName> = Lazy::new(|| {
-        ServiceName::new(&(INTERNAL_SERVICE_PREFIX.to_owned() + SERVICE_DISCOVERY_SERVICE_NAME))
+        ServiceName::__internal_new(SERVICE_DISCOVERY_SERVICE_NAME)
             .expect("shouldn't occur: invalid service name for service discovery service")
     });
 

iceoryx2-services/common/src/lib.rs

@@ -25,15 +25,33 @@
 use iceoryx2_bb_container::semantic_string::SemanticStringError;
 use serde::{de::Visitor, Deserialize, Serialize};
 
+/// Prefix used to identify internal iceoryx2 services.
+///
+/// This prefix is used to distinguish between user-defined services and internal
+/// iceoryx2 services. Services with this prefix are considered internal and are
+/// managed by the iceoryx2 system.
+pub const INTERNAL_SERVICE_PREFIX: &str = "iox2://";
+
 /// The name of a [`Service`](crate::service::Service).
 #[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
 pub struct ServiceName {
     value: String,
 }
 
 impl ServiceName {
-    /// Creates a new [`ServiceName`]. The name is not allowed to be empty.
+    /// Creates a new [`ServiceName`].
+    ///
+    /// The name is not allowed to be empty nor be prefixed with "iox2://".
     pub fn new(name: &str) -> Result<Self, SemanticStringError> {
+        if Self::is_internal(name) {
+            return Err(SemanticStringError::InvalidContent);
+        }
+
+        Self::__internal_new(name)
+    }
+
+    #[doc(hidden)]
+    pub fn __internal_new(name: &str) -> Result<Self, SemanticStringError> {
         if name.is_empty() {
             return Err(SemanticStringError::InvalidContent);
         }
@@ -45,6 +63,11 @@ impl ServiceName {
     pub fn as_str(&self) -> &str {
         &self.value
     }
+
+    /// Checks if a service is an internal iceoryx2 service.
+    pub fn is_internal(name: &str) -> bool {
+        name.starts_with(INTERNAL_SERVICE_PREFIX)
+    }
 }
 
 impl core::fmt::Display for ServiceName {