Preset mappers

v-api/Cargo.toml

@@ -46,7 +46,7 @@ thiserror = { workspace = true }
 tokio = { workspace = true, features = ["rt-multi-thread", "macros"] }
 tracing = { workspace = true }
 url = { workspace = true }
-uuid = { workspace = true, features = ["v4", "serde"]  }
+uuid = { workspace = true, features = ["v4", "v5", "serde"]  }
 v-api-param = { path = "../v-api-param" }
 v-api-permission-derive = { path = "../v-api-permission-derive" }
 v-model = { path = "../v-model" }

v-api/src/context/mapping.rs

@@ -6,9 +6,10 @@ use newtype_uuid::TypedUuid;
 use serde_json::Value;
 use std::{collections::BTreeSet, sync::Arc};
 use v_model::{
-    AccessGroupId, Mapper, MapperId, NewMapper, Permissions,
+    AccessGroupId, Mapper, MapperEvent, MapperId, MapperSource, NewMapper, NewMapperEvent,
+    Permissions, UserId,
     permissions::Caller,
-    storage::{ListPagination, MapperFilter, MapperStore, StoreError},
+    storage::{ListPagination, MapperEventStore, MapperFilter, MapperStore, StoreError},
 };
 
 use crate::{
@@ -22,6 +23,7 @@ use crate::{
 pub struct MappingContext<T> {
     engine: Option<Arc<dyn MappingEngine<T>>>,
     storage: Arc<dyn VApiStorage<T>>,
+    preset_mappers: Vec<Mapper>,
 }
 
 impl<T> MappingContext<T>
@@ -32,6 +34,7 @@ where
         Self {
             engine: None,
             storage,
+            preset_mappers: Vec::new(),
         }
     }
 
@@ -48,6 +51,14 @@ where
         previous
     }
 
+    pub fn set_preset_mappers(&mut self, mappers: Vec<Mapper>) {
+        self.preset_mappers = mappers;
+    }
+
+    pub fn is_preset(&self, id: &TypedUuid<MapperId>) -> bool {
+        self.preset_mappers.iter().any(|m| &m.id == id)
+    }
+
     pub fn validate(&self, value: &Value) -> bool {
         match &self.engine {
             Some(engine) => engine.validate_mapping_data(value),
@@ -61,12 +72,15 @@ where
         included_depleted: bool,
     ) -> ResourceResult<Vec<Mapper>, StoreError> {
         if caller.can(&VPermission::GetMappersAll.into()) {
-            Ok(MapperStore::list(
+            let mut mappers = MapperStore::list(
                 &*self.storage,
                 MapperFilter::default().depleted(included_depleted),
                 &ListPagination::unlimited(),
             )
-            .await?)
+            .await?;
+            mappers.extend(self.preset_mappers.iter().cloned());
+
+            Ok(mappers)
         } else {
             resource_restricted()
         }
@@ -100,6 +114,7 @@ where
         &self,
         caller: &Caller<T>,
         info: &UserInfo,
+        user_id: TypedUuid<UserId>,
     ) -> ResourceResult<(Permissions<T>, BTreeSet<TypedUuid<AccessGroupId>>), StoreError> {
         let mut mapped_permissions = Permissions::new();
         let mut mapped_groups = BTreeSet::new();
@@ -111,10 +126,10 @@ where
             // instead handle mappers that become depleted before we can evaluate them at evaluation
             // time.
             for mapper in self.get_mappers(caller, false).await? {
-                tracing::trace!(?mapper.name, "Attempt to run mapper");
+                let is_preset = mapper.source == MapperSource::Preset;
+                tracing::trace!(?mapper.name, is_preset, "Attempt to run mapper");
 
                 // Try to transform this mapper into a mapping
-                // let mappings = self.mapping_fns.iter().filter_map(|mapping_fn| mapping_fn(mapper.clone()).ok()).nth(0);
                 let mapping = engine.create_mapping(mapper.clone());
 
                 let (mut permissions, mut groups) = match mapping {
@@ -127,38 +142,48 @@ where
                     }
                     Err(err) => {
                         // Errors here can be expected. They are reported, but not acted upon
-                        tracing::info!(?err, "Not mapping was found for mapper");
+                        tracing::info!(?err, "No mapping was found for mapper");
                         (Permissions::new(), BTreeSet::default())
                     }
                 };
 
-                // If a rule is set to apply a permission or group to a user, then the rule needs to be
-                // checked for usage. If it does not have an activation limit then nothing is needed.
-                // If it does have a limit then we need to attempt to consume an activation. If the
-                // consumption works then we add the permissions. If they fail then we do not, but we
-                // do not fail the entire mapping process
                 let apply = if !permissions.is_empty() || !groups.is_empty() {
-                    if mapper.max_activations.is_some() {
+                    if is_preset {
+                        // Preset mappers always apply - no activation gating
+                        true
+                    } else if mapper.max_activations.is_some() {
+                        // Dynamic mappers with activation limits need to consume an activation
                         match self.consume_mapping_activation(&mapper).await {
                             Ok(_) => true,
                             Err(err) => {
                                 // TODO: Inspect the error. We expect to see a conflict error, and
                                 // should is expected to be seen. Other errors are problematic.
-                                tracing::warn!(
+                                tracing::info!(
                                     ?err,
-                                    "Login may have attempted to use depleted mapper. This may be ok if it is an isolated occurrence, but should occur repeatedly."
+                                    "Login may have attempted to use depleted mapper."
                                 );
                                 false
                             }
                         }
                     } else {
+                        // Dynamic mappers without activation limits always apply
                         true
                     }
                 } else {
                     false
                 };
 
                 if apply {
+                    // Record the mapper event for audit purposes.
+                    // TODO: This should hook into an audit log feature
+                    if let Err(err) = self.record_mapper_event(&mapper, user_id).await {
+                        tracing::warn!(
+                            ?err,
+                            mapper_name = ?mapper.name,
+                            "Failed to record mapper event"
+                        );
+                    }
+
                     mapped_permissions.append(&mut permissions);
                     mapped_groups.append(&mut groups);
                 }
@@ -182,4 +207,21 @@ where
             .await
             .map(|_| ())
     }
+
+    async fn record_mapper_event(
+        &self,
+        mapper: &Mapper,
+        user_id: TypedUuid<UserId>,
+    ) -> Result<MapperEvent, StoreError> {
+        let event = NewMapperEvent {
+            id: TypedUuid::new_v4(),
+            mapper_id: mapper.id,
+            mapper_name: mapper.name.clone(),
+            user_id,
+            rule: mapper.rule.clone(),
+            source: mapper.source,
+        };
+
+        MapperEventStore::record(&*self.storage, &event).await
+    }
 }