Scope plugins to drives #73

Author: Polleps

lib/src/class_extender.rs

@@ -29,12 +29,19 @@ pub type ResourceGetHandler = Arc<
 pub type CommitHandler =
     Arc<dyn for<'a> Fn(CommitExtenderContext<'a>) -> BoxFuture<'a, AtomicResult<()>> + Send + Sync>;
 
+#[derive(Clone, Debug)]
+pub enum ClassExtenderScope {
+    Global,
+    Drive(String),
+}
+
 #[derive(Clone)]
 pub struct ClassExtender {
     pub classes: Vec<String>,
     pub on_resource_get: Option<ResourceGetHandler>,
     pub before_commit: Option<CommitHandler>,
     pub after_commit: Option<CommitHandler>,
+    pub scope: ClassExtenderScope,
 }
 
 impl ClassExtender {
@@ -66,4 +73,44 @@ impl ClassExtender {
     {
         Arc::new(handler)
     }
+
+    /// Checks if the resource is within the scope of the extender.
+    /// To prevent unnecessary database lookups, the cached root can be supplied.
+    /// Returns a tuple of (is_in_scope, cached_root).
+    pub async fn check_scope(
+        &self,
+        resource: &Resource,
+        store: &Db,
+        cached_root: Option<String>,
+    ) -> AtomicResult<(bool, Option<String>)> {
+        match &self.scope {
+            ClassExtenderScope::Drive(scope) => {
+                // If the resource is the scope itself we can just return true.
+                if resource.get_subject().clone() == scope.clone() {
+                    return Ok((true, Some(resource.get_subject().clone())));
+                }
+
+                // Find the root parent of the resource or use the cached root.
+                let rs = if let Some(rs) = &cached_root {
+                    rs.clone()
+                } else {
+                    let parents = resource.get_parent_tree(store).await?;
+                    let Some(root) = parents.last() else {
+                        return Ok((false, None));
+                    };
+
+                    root.get_subject().clone()
+                };
+
+                if rs != *scope {
+                    return Ok((false, Some(rs)));
+                }
+
+                return Ok((true, Some(rs)));
+            }
+            ClassExtenderScope::Global => {
+                return Ok((true, cached_root));
+            }
+        }
+    }
 }

lib/src/collections.rs

@@ -1,6 +1,6 @@
 //! Collections are dynamic resources that refer to multiple resources.
 //! They are constructed using a [Query]
-use crate::class_extender::{ClassExtender, GetExtenderContext};
+use crate::class_extender::{ClassExtender, ClassExtenderScope, GetExtenderContext};
 use crate::{
     agents::ForAgent,
     errors::AtomicResult,
@@ -25,6 +25,7 @@ pub fn get_collection_class_extender() -> ClassExtender {
         })),
         before_commit: None,
         after_commit: None,
+        scope: ClassExtenderScope::Global,
     }
 }
 

lib/src/db.rs

@@ -731,10 +731,22 @@ impl Storelike for Db {
 
         let mut transaction = Transaction::new();
 
+        let mut root_subject: Option<String> = None;
+
         // BEFORE APPLY COMMIT HANDLERS
         if let Some(resource_new) = &commit_response.resource_new {
             for extender in self.class_extenders.iter() {
                 if extender.resource_has_extender(resource_new)? {
+                    let (is_in_scope, cached_root) = extender
+                        .check_scope(&resource_new, self, root_subject)
+                        .await?;
+
+                    root_subject = cached_root;
+
+                    if !is_in_scope {
+                        continue;
+                    }
+
                     let Some(handler) = extender.before_commit.as_ref() else {
                         continue;
                     };
@@ -799,6 +811,16 @@ impl Storelike for Db {
         if let Some(resource_new) = &commit_response.resource_new {
             for extender in self.class_extenders.iter() {
                 if extender.resource_has_extender(resource_new)? {
+                    let (is_in_scope, cached_root) = extender
+                        .check_scope(&resource_new, self, root_subject)
+                        .await?;
+
+                    root_subject = cached_root;
+
+                    if !is_in_scope {
+                        continue;
+                    }
+
                     use crate::class_extender::CommitExtenderContext;
 
                     let Some(handler) = extender.after_commit.as_ref() else {
@@ -886,9 +908,20 @@ impl Storelike for Db {
 
             let _explanation = crate::hierarchy::check_read(self, &resource, for_agent).await?;
 
+            let mut root_subject: Option<String> = None;
+
             // If a certain class needs to be extended, add it to this match statement
             for extender in self.class_extenders.iter() {
                 if extender.resource_has_extender(&resource)? {
+                    let (is_in_scope, cached_root) =
+                        extender.check_scope(&resource, self, root_subject).await?;
+
+                    root_subject = cached_root;
+
+                    if !is_in_scope {
+                        continue;
+                    }
+
                     if skip_dynamic {
                         // This lets clients know that the resource may have dynamic properties that are currently not included
                         resource

server/src/plugins/chatroom.rs

@@ -5,7 +5,9 @@ They list a bunch of Messages.
 */
 
 use atomic_lib::{
-    class_extender::{BoxFuture, ClassExtender, CommitExtenderContext, GetExtenderContext},
+    class_extender::{
+        BoxFuture, ClassExtender, ClassExtenderScope, CommitExtenderContext, GetExtenderContext,
+    },
     commit::{CommitBuilder, CommitOpts},
     errors::AtomicResult,
     storelike::{Query, QueryResult, ResourceResponse},
@@ -149,6 +151,7 @@ pub fn build_chatroom_extender() -> ClassExtender {
         on_resource_get: Some(ClassExtender::wrap_get_handler(construct_chatroom)),
         before_commit: None,
         after_commit: None,
+        scope: ClassExtenderScope::Global,
     }
 }
 
@@ -160,5 +163,6 @@ pub fn build_message_extender() -> ClassExtender {
         after_commit: Some(ClassExtender::wrap_commit_handler(
             after_apply_commit_message,
         )),
+        scope: ClassExtenderScope::Global,
     }
 }

server/src/plugins/invite.rs

@@ -1,6 +1,8 @@
 use atomic_lib::{
     agents::Agent,
-    class_extender::{BoxFuture, ClassExtender, CommitExtenderContext, GetExtenderContext},
+    class_extender::{
+        BoxFuture, ClassExtender, ClassExtenderScope, CommitExtenderContext, GetExtenderContext,
+    },
     errors::AtomicResult,
     hierarchy,
     storelike::ResourceResponse,
@@ -200,5 +202,6 @@ pub fn build_invite_extender() -> ClassExtender {
         on_resource_get: Some(ClassExtender::wrap_get_handler(construct_invite_redirect)),
         before_commit: Some(ClassExtender::wrap_commit_handler(before_apply_commit)),
         after_commit: None,
+        scope: ClassExtenderScope::Global,
     }
 }