mssf-core 0.7.0

// ------------------------------------------------------------
// Copyright (c) Microsoft Corporation.  All rights reserved.
// Licensed under the MIT License (MIT). See License.txt in the repo root for license information.
// ------------------------------------------------------------
//! Handle callbacks for configuration package changes
//! TODO: We probably should also provide a helpful callback to use in conjunction with the config-rs support (so that it processes configuration changes)
use mssf_com::FabricRuntime::{
    IFabricConfigurationPackageChangeHandler, IFabricConfigurationPackageChangeHandler_Impl,
};

use crate::runtime::{CodePackageActivationContext, config::ConfigurationPackage};

use super::ConfigurationPackageChangeEvent;

/// Rust trait to turn rust code into IFabricConfigurationPackageChangeHandler.
/// Not exposed to user
pub trait ConfigurationPackageChangeEventHandler: 'static {
    fn on_change(&self, change: &ConfigurationPackageChangeEvent);
}

// Bridge implementation for the change handler to turn rust code into SF com object.
#[windows_core::implement(IFabricConfigurationPackageChangeHandler)]
#[allow(non_camel_case_types)] // Suppress lint for _Impl struct
pub struct ConfigurationPackageChangeEventHandlerBridge<T>
where
    T: ConfigurationPackageChangeEventHandler,
{
    inner: T,
}

impl<T> ConfigurationPackageChangeEventHandlerBridge<T>
where
    T: ConfigurationPackageChangeEventHandler,
{
    pub fn new(inner: T) -> Self {
        Self { inner }
    }
}

impl<T> IFabricConfigurationPackageChangeHandler_Impl
    for ConfigurationPackageChangeEventHandlerBridge_Impl<T>
where
    T: ConfigurationPackageChangeEventHandler,
{
    fn OnPackageAdded(
        &self,
        _source: windows_core::Ref<mssf_com::FabricRuntime::IFabricCodePackageActivationContext>,
        configpackage: windows_core::Ref<mssf_com::FabricRuntime::IFabricConfigurationPackage>,
    ) {
        let new_package = ConfigurationPackage::from(configpackage.unwrap().clone());
        let event = ConfigurationPackageChangeEvent::Addition { new_package };
        self.inner.on_change(&event)
    }

    fn OnPackageRemoved(
        &self,
        _source: windows_core::Ref<mssf_com::FabricRuntime::IFabricCodePackageActivationContext>,
        configpackage: windows_core::Ref<mssf_com::FabricRuntime::IFabricConfigurationPackage>,
    ) {
        let previous_package = ConfigurationPackage::from(configpackage.unwrap().clone());
        let event = ConfigurationPackageChangeEvent::Removal { previous_package };
        self.inner.on_change(&event)
    }

    fn OnPackageModified(
        &self,
        _source: windows_core::Ref<mssf_com::FabricRuntime::IFabricCodePackageActivationContext>,
        previousconfigpackage: windows_core::Ref<
            mssf_com::FabricRuntime::IFabricConfigurationPackage,
        >,
        configpackage: windows_core::Ref<mssf_com::FabricRuntime::IFabricConfigurationPackage>,
    ) {
        let new_package = ConfigurationPackage::from(configpackage.unwrap().clone());
        let previous_package = ConfigurationPackage::from(previousconfigpackage.unwrap().clone());
        let event = ConfigurationPackageChangeEvent::Modification {
            previous_package,
            new_package,
        };
        self.inner.on_change(&event)
    }
}

/// Lambda implementation of ConfigurationPackageChangeEventHandler trait.
/// This is used in FabricClientBuilder to build function into handler.
/// Not exposed to user.
/// Strictly speaking we don't need this layer. But it would allow us to open the door to trait implementations someday
pub(crate) struct LambdaConfigurationPackageEventHandler<T>
where
    T: Fn(&ConfigurationPackageChangeEvent),
{
    f: T,
}

impl<T> LambdaConfigurationPackageEventHandler<T>
where
    T: Fn(&ConfigurationPackageChangeEvent) + 'static,
{
    pub fn new(f: T) -> Self {
        Self { f }
    }
}

impl<T> ConfigurationPackageChangeEventHandler for LambdaConfigurationPackageEventHandler<T>
where
    T: Fn(&ConfigurationPackageChangeEvent) + 'static,
{
    fn on_change(&self, change: &ConfigurationPackageChangeEvent) {
        (self.f)(change)
    }
}

/// An opaque id representing a registered Configuration Package Change callback
#[derive(Debug)]
pub struct ConfigurationPackageChangeCallbackHandle(pub(crate) i64);

impl ConfigurationPackageChangeCallbackHandle {
    /// # Safety
    /// Caller ensures this is a registered callback id
    pub const unsafe fn from(com: i64) -> Self {
        Self(com)
    }
}

/// This struct manages deregistering the Service Fabric Config Package Change callback
/// when it leaves scope.
#[derive(Debug)]
pub struct AutoConfigurationPackageChangeCallbackHandle {
    /// Service Fabric Activation Context
    activation_ctx: CodePackageActivationContext,
    /// Handle to deregister on drop
    handle: Option<ConfigurationPackageChangeCallbackHandle>,
}

impl AutoConfigurationPackageChangeCallbackHandle {
    /// Register a new handle for the provided lambda.
    /// Clones (e.g. adjusts reference count) on activation_ctx
    pub fn new<T>(activation_ctx: &CodePackageActivationContext, handler: T) -> crate::Result<Self>
    where
        T: Fn(&ConfigurationPackageChangeEvent) + 'static,
    {
        let handle = activation_ctx.register_configuration_package_change_handler(handler)?;
        Ok(Self {
            activation_ctx: activation_ctx.clone(),
            handle: Some(handle),
        })
    }
}

impl Drop for AutoConfigurationPackageChangeCallbackHandle {
    fn drop(&mut self) {
        if let Some(my_handle) = self.handle.take() {
            self.activation_ctx
                .unregister_configuration_package_change_handler(my_handle)
                .expect("Unregistering handle should succeed.");
        }
    }
}