Create Query endpoint

Author: Polleps

CHANGELOG.md

@@ -15,6 +15,7 @@ See [STATUS.md](server/STATUS.md) to learn more about which features will remain
 - Don't require building index for populate commands
 - Refactor `for_agent` arguments to use the new `ForAgent` enum #623
 - Add support for Bearer token authentication, find in `/app/token` #632
+- Add a `query` endpoint that allows peroforming collection queries via an enpoint instead of repurposing the collections collection.
 
 ## [v0.34.2] - 2023-03-04
 

lib/src/endpoints.rs

@@ -84,5 +84,6 @@ pub fn default_endpoints() -> Vec<Endpoint> {
         #[cfg(feature = "html")]
         plugins::bookmark::bookmark_endpoint(),
         plugins::importer::import_endpoint(),
+        plugins::query::query_endpoint(),
     ]
 }

lib/src/plugins/mod.rs

@@ -43,5 +43,6 @@ pub mod invite;
 pub mod bookmark;
 pub mod files;
 pub mod path;
+pub mod query;
 pub mod search;
 pub mod versioning;

lib/src/plugins/query.rs

@@ -0,0 +1,46 @@
+use crate::{
+    endpoints::{Endpoint, HandleGetContext},
+    errors::AtomicResult,
+    urls, Resource,
+};
+
+// Note that the actual logic of this endpoint resides in `atomic-server`, as it depends on the Actix runtime.
+pub fn query_endpoint() -> Endpoint {
+    Endpoint {
+        path: urls::PATH_QUERY.into(),
+        params: [
+            urls::COLLECTION_PROPERTY.to_string(),
+            urls::COLLECTION_VALUE.to_string(),
+            urls::COLLECTION_PAGE_SIZE.to_string(),
+            urls::COLLECTION_CURRENT_PAGE.to_string(),
+            urls::COLLECTION_INCLUDE_EXTERNAL.to_string(),
+            urls::COLLECTION_INCLUDE_NESTED.to_string(),
+            urls::COLLECTION_SORT_BY.to_string(),
+            urls::COLLECTION_SORT_DESC.to_string(),
+        ]
+        .into(),
+        description: "Query the server for resources matching the query filter.".to_string(),
+        shortname: "query".to_string(),
+        handle: Some(handle_query_request),
+        handle_post: None,
+    }
+}
+
+fn handle_query_request(context: HandleGetContext) -> AtomicResult<Resource> {
+    let HandleGetContext {
+        subject,
+        store,
+        for_agent,
+    } = context;
+
+    if subject.query_pairs().into_iter().next().is_none() {
+        return query_endpoint().to_resource(store);
+    }
+    let mut resource = Resource::new(subject.to_string());
+    crate::collections::construct_collection_from_params(
+        store,
+        subject.query_pairs(),
+        &mut resource,
+        for_agent,
+    )
+}

lib/src/urls.rs

@@ -145,3 +145,4 @@ pub fn construct_path_import(base: &str) -> String {
 
 pub const PATH_IMPORT: &str = "/import";
 pub const PATH_FETCH_BOOKMARK: &str = "/fetch-bookmark";
+pub const PATH_QUERY: &str = "/query";