OpenShell/crates/openshell-core/src/metadata.rs

// SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
// SPDX-License-Identifier: Apache-2.0

//! Object metadata accessors for Kubernetes-style resources.
//!
//! These traits provide uniform access to `ObjectMeta` fields across all resource types.

use crate::proto::{
    ObjectForTest, Provider, Sandbox, SandboxStatus, SandboxWorkloadTemplate, ServiceEndpoint,
    SshSession, Workspace, WorkspaceMember,
};
use std::collections::HashMap;

/// Provides access to the object's unique identifier.
pub trait ObjectId {
    fn object_id(&self) -> &str;
}

/// Provides access to the object's human-readable name.
pub trait ObjectName {
    fn object_name(&self) -> &str;
}

/// Provides access to the object's labels (key-value metadata).
pub trait ObjectLabels {
    fn object_labels(&self) -> Option<HashMap<String, String>>;
}

/// Provides mutable access to set the object's resource version from persistence.
pub trait SetResourceVersion {
    fn set_resource_version(&mut self, version: u64);
}

/// Provides read access to the object's current resource version.
pub trait GetResourceVersion {
    fn get_resource_version(&self) -> u64;
}

/// Provides access to the object's workspace for persistence scoping.
pub trait ObjectWorkspace {
    fn object_workspace(&self) -> &str;
    fn requires_workspace() -> bool;
}

// Implementations for Sandbox
impl ObjectId for Sandbox {
    fn object_id(&self) -> &str {
        self.metadata.as_ref().map_or("", |m| m.id.as_str())
    }
}

impl ObjectName for Sandbox {
    fn object_name(&self) -> &str {
        self.metadata.as_ref().map_or("", |m| m.name.as_str())
    }
}

impl ObjectLabels for Sandbox {
    fn object_labels(&self) -> Option<HashMap<String, String>> {
        self.metadata.as_ref().map(|m| m.labels.clone())
    }
}

impl SetResourceVersion for Sandbox {
    fn set_resource_version(&mut self, version: u64) {
        if let Some(meta) = self.metadata.as_mut() {
            meta.resource_version = version;
        }
    }
}

impl GetResourceVersion for Sandbox {
    fn get_resource_version(&self) -> u64 {
        self.metadata.as_ref().map_or(0, |m| m.resource_version)
    }
}

impl ObjectWorkspace for Sandbox {
    fn object_workspace(&self) -> &str {
        self.metadata.as_ref().map_or("", |m| m.workspace.as_str())
    }
    fn requires_workspace() -> bool {
        true
    }
}

impl Sandbox {
    pub fn phase(&self) -> i32 {
        self.status.as_ref().map_or(0, |s| s.phase)
    }

    pub fn set_phase(&mut self, phase: i32) {
        self.status.get_or_insert_with(SandboxStatus::default).phase = phase;
    }

    pub fn current_policy_version(&self) -> u32 {
        self.status.as_ref().map_or(0, |s| s.current_policy_version)
    }

    pub fn set_current_policy_version(&mut self, version: u32) {
        self.status
            .get_or_insert_with(SandboxStatus::default)
            .current_policy_version = version;
    }
}

// Implementations for SandboxWorkloadTemplate
impl ObjectId for SandboxWorkloadTemplate {
    fn object_id(&self) -> &str {
        self.metadata.as_ref().map_or("", |m| m.id.as_str())
    }
}

impl ObjectName for SandboxWorkloadTemplate {
    fn object_name(&self) -> &str {
        self.metadata.as_ref().map_or("", |m| m.name.as_str())
    }
}

impl ObjectLabels for SandboxWorkloadTemplate {
    fn object_labels(&self) -> Option<HashMap<String, String>> {
        self.metadata.as_ref().map(|m| m.labels.clone())
    }
}

impl SetResourceVersion for SandboxWorkloadTemplate {
    fn set_resource_version(&mut self, version: u64) {
        if let Some(meta) = self.metadata.as_mut() {
            meta.resource_version = version;
        }
    }
}

impl GetResourceVersion for SandboxWorkloadTemplate {
    fn get_resource_version(&self) -> u64 {
        self.metadata.as_ref().map_or(0, |m| m.resource_version)
    }
}

impl ObjectWorkspace for SandboxWorkloadTemplate {
    fn object_workspace(&self) -> &str {
        self.metadata.as_ref().map_or("", |m| m.workspace.as_str())
    }

    fn requires_workspace() -> bool {
        true
    }
}

// Implementations for Workspace
impl ObjectId for Workspace {
    fn object_id(&self) -> &str {
        self.metadata.as_ref().map_or("", |m| m.id.as_str())
    }
}

impl ObjectName for Workspace {
    fn object_name(&self) -> &str {
        self.metadata.as_ref().map_or("", |m| m.name.as_str())
    }
}

impl ObjectLabels for Workspace {
    fn object_labels(&self) -> Option<HashMap<String, String>> {
        self.metadata.as_ref().map(|m| m.labels.clone())
    }
}

impl SetResourceVersion for Workspace {
    fn set_resource_version(&mut self, version: u64) {
        if let Some(meta) = self.metadata.as_mut() {
            meta.resource_version = version;
        }
    }
}

impl GetResourceVersion for Workspace {
    fn get_resource_version(&self) -> u64 {
        self.metadata.as_ref().map_or(0, |m| m.resource_version)
    }
}

impl ObjectWorkspace for Workspace {
    #[allow(clippy::unnecessary_literal_bound)]
    fn object_workspace(&self) -> &str {
        ""
    }
    fn requires_workspace() -> bool {
        false
    }
}

// Implementations for Provider
impl ObjectId for Provider {
    fn object_id(&self) -> &str {
        self.metadata.as_ref().map_or("", |m| m.id.as_str())
    }
}

impl ObjectName for Provider {
    fn object_name(&self) -> &str {
        self.metadata.as_ref().map_or("", |m| m.name.as_str())
    }
}

impl ObjectLabels for Provider {
    fn object_labels(&self) -> Option<HashMap<String, String>> {
        self.metadata.as_ref().map(|m| m.labels.clone())
    }
}

impl SetResourceVersion for Provider {
    fn set_resource_version(&mut self, version: u64) {
        if let Some(meta) = self.metadata.as_mut() {
            meta.resource_version = version;
        }
    }
}

impl GetResourceVersion for Provider {
    fn get_resource_version(&self) -> u64 {
        self.metadata.as_ref().map_or(0, |m| m.resource_version)
    }
}

impl ObjectWorkspace for Provider {
    fn object_workspace(&self) -> &str {
        self.metadata.as_ref().map_or("", |m| m.workspace.as_str())
    }
    fn requires_workspace() -> bool {
        true
    }
}

// Implementations for SshSession
impl ObjectId for SshSession {
    fn object_id(&self) -> &str {
        self.metadata.as_ref().map_or("", |m| m.id.as_str())
    }
}

impl ObjectName for SshSession {
    fn object_name(&self) -> &str {
        self.metadata.as_ref().map_or("", |m| m.name.as_str())
    }
}

impl ObjectLabels for SshSession {
    fn object_labels(&self) -> Option<HashMap<String, String>> {
        self.metadata.as_ref().map(|m| m.labels.clone())
    }
}

impl SetResourceVersion for SshSession {
    fn set_resource_version(&mut self, version: u64) {
        if let Some(meta) = self.metadata.as_mut() {
            meta.resource_version = version;
        }
    }
}

impl GetResourceVersion for SshSession {
    fn get_resource_version(&self) -> u64 {
        self.metadata.as_ref().map_or(0, |m| m.resource_version)
    }
}

impl ObjectWorkspace for SshSession {
    fn object_workspace(&self) -> &str {
        self.metadata.as_ref().map_or("", |m| m.workspace.as_str())
    }
    fn requires_workspace() -> bool {
        true
    }
}

// Implementations for ServiceEndpoint
impl ObjectId for ServiceEndpoint {
    fn object_id(&self) -> &str {
        self.metadata.as_ref().map_or("", |m| m.id.as_str())
    }
}

impl ObjectName for ServiceEndpoint {
    fn object_name(&self) -> &str {
        self.metadata.as_ref().map_or("", |m| m.name.as_str())
    }
}

impl ObjectLabels for ServiceEndpoint {
    fn object_labels(&self) -> Option<HashMap<String, String>> {
        self.metadata.as_ref().map(|m| m.labels.clone())
    }
}

impl SetResourceVersion for ServiceEndpoint {
    fn set_resource_version(&mut self, version: u64) {
        if let Some(meta) = self.metadata.as_mut() {
            meta.resource_version = version;
        }
    }
}

impl GetResourceVersion for ServiceEndpoint {
    fn get_resource_version(&self) -> u64 {
        self.metadata.as_ref().map_or(0, |m| m.resource_version)
    }
}

impl ObjectWorkspace for ServiceEndpoint {
    fn object_workspace(&self) -> &str {
        self.metadata.as_ref().map_or("", |m| m.workspace.as_str())
    }
    fn requires_workspace() -> bool {
        true
    }
}

// Implementations for WorkspaceMember
impl ObjectId for WorkspaceMember {
    fn object_id(&self) -> &str {
        self.metadata.as_ref().map_or("", |m| m.id.as_str())
    }
}

impl ObjectName for WorkspaceMember {
    fn object_name(&self) -> &str {
        self.metadata.as_ref().map_or("", |m| m.name.as_str())
    }
}

impl ObjectLabels for WorkspaceMember {
    fn object_labels(&self) -> Option<HashMap<String, String>> {
        self.metadata.as_ref().map(|m| m.labels.clone())
    }
}

impl SetResourceVersion for WorkspaceMember {
    fn set_resource_version(&mut self, version: u64) {
        if let Some(meta) = self.metadata.as_mut() {
            meta.resource_version = version;
        }
    }
}

impl GetResourceVersion for WorkspaceMember {
    fn get_resource_version(&self) -> u64 {
        self.metadata.as_ref().map_or(0, |m| m.resource_version)
    }
}

impl ObjectWorkspace for WorkspaceMember {
    fn object_workspace(&self) -> &str {
        self.metadata.as_ref().map_or("", |m| m.workspace.as_str())
    }
    fn requires_workspace() -> bool {
        true
    }
}

// Implementations for ObjectForTest (test-only proto type)
impl ObjectId for ObjectForTest {
    fn object_id(&self) -> &str {
        &self.id
    }
}

impl ObjectName for ObjectForTest {
    fn object_name(&self) -> &str {
        &self.name
    }
}

impl ObjectLabels for ObjectForTest {
    fn object_labels(&self) -> Option<HashMap<String, String>> {
        None
    }
}

impl SetResourceVersion for ObjectForTest {
    fn set_resource_version(&mut self, _version: u64) {
        // ObjectForTest doesn't have metadata, so this is a no-op
    }
}

impl GetResourceVersion for ObjectForTest {
    fn get_resource_version(&self) -> u64 {
        // ObjectForTest doesn't have metadata
        0
    }
}

impl ObjectWorkspace for ObjectForTest {
    #[allow(clippy::unnecessary_literal_bound)]
    fn object_workspace(&self) -> &str {
        ""
    }
    fn requires_workspace() -> bool {
        false
    }
}