[server] Add db auditing #979

.gitignore

@@ -19,5 +19,6 @@ agdb_server.yaml
 agdb_benchmarks.agdb
 .agdb_server.agdb
 agdb_server.agdb
+agdb_server_data/
 !.github/workflows/agdb_benchmarks.yaml
 !.github/workflows/agdb_server.yaml

agdb/src/query.rs

@@ -55,6 +55,7 @@ use crate::{
 #[cfg(any(feature = "serde", feature = "opeanapi"))]
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
+#[derive(Debug, PartialEq)]
 pub enum QueryType {
     InsertAlias(InsertAliasesQuery),
     InsertEdges(InsertEdgesQuery),
@@ -193,3 +194,56 @@ impl From<SelectValuesQuery> for QueryType {
         QueryType::SelectValues(value)
     }
 }
+
+#[cfg(any(feature = "serde", feature = "opeanapi"))]
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use crate::QueryBuilder;
+
+    #[test]
+    fn derived_from_debug_and_partial_eq() {
+        let queries: Vec<QueryType> = vec![
+            QueryBuilder::insert().nodes().count(2).query().into(),
+            QueryBuilder::insert()
+                .aliases(vec!["node1", "node2"])
+                .ids(vec![1, 2])
+                .query()
+                .into(),
+            QueryBuilder::insert()
+                .edges()
+                .from("node1")
+                .to("node2")
+                .query()
+                .into(),
+            QueryBuilder::insert()
+                .values(vec![vec![("key", 1.1).into()]])
+                .ids("node1")
+                .query()
+                .into(),
+            QueryBuilder::insert().index("key").query().into(),
+            QueryBuilder::search().from(1).query().into(),
+            QueryBuilder::select().ids(1).query().into(),
+            QueryBuilder::select().aliases().ids(1).query().into(),
+            QueryBuilder::select().aliases().query().into(),
+            QueryBuilder::select().indexes().query().into(),
+            QueryBuilder::select().keys().ids(1).query().into(),
+            QueryBuilder::select().key_count().ids(1).query().into(),
+            QueryBuilder::select()
+                .values(vec!["key".into()])
+                .ids(1)
+                .query()
+                .into(),
+            QueryBuilder::remove().aliases("node2").query().into(),
+            QueryBuilder::remove().index("key").query().into(),
+            QueryBuilder::remove()
+                .values(vec!["key".into()])
+                .ids(1)
+                .query()
+                .into(),
+            QueryBuilder::remove().ids("node1").query().into(),
+        ];
+        format!("{:?}", queries);
+        assert_eq!(queries, queries);
+    }
+}

agdb/src/query/insert_aliases_query.rs

@@ -15,6 +15,7 @@ use crate::StorageData;
 /// The result will contain number of aliases inserted/updated but no elements.
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
+#[derive(Debug, PartialEq)]
 pub struct InsertAliasesQuery {
     /// Ids to be aliased
     pub ids: QueryIds,

agdb/src/query/insert_edges_query.rs

@@ -22,6 +22,7 @@ use crate::StorageData;
 /// their ids but no properties.
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
+#[derive(Debug, PartialEq)]
 pub struct InsertEdgesQuery {
     /// Origins
     pub from: QueryIds,

agdb/src/query/insert_index_query.rs

@@ -9,6 +9,7 @@ use crate::StorageData;
 /// a given key.
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
+#[derive(Debug, PartialEq)]
 pub struct InsertIndexQuery(pub DbValue);
 
 impl QueryMut for InsertIndexQuery {

agdb/src/query/insert_nodes_query.rs

@@ -18,6 +18,7 @@ use crate::StorageData;
 /// their ids but no properties.
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
+#[derive(Debug, PartialEq)]
 pub struct InsertNodesQuery {
     /// Number of nodes to be inserted.
     pub count: u64,

agdb/src/query/insert_values_query.rs

@@ -17,6 +17,7 @@ use crate::StorageData;
 /// NOTE: The result is NOT number of affected elements but individual properties.
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
+#[derive(Debug, PartialEq)]
 pub struct InsertValuesQuery {
     /// Ids whose properties should be updated
     pub ids: QueryIds,

agdb/src/query/query_values.rs

@@ -6,6 +6,7 @@ use crate::DbValue;
 /// and multiple (`Multi`) values in database queries.
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
+#[derive(Debug, PartialEq)]
 pub enum QueryValues {
     /// Single list of properties (key-value pairs)
     /// to be applied to all elements in a query.

agdb/src/query/remove_aliases_query.rs

@@ -12,6 +12,7 @@ use crate::StorageData;
 /// many aliases have been actually removed.
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
+#[derive(Debug, PartialEq)]
 pub struct RemoveAliasesQuery(pub Vec<String>);
 
 impl QueryMut for RemoveAliasesQuery {

agdb/src/query/remove_index_query.rs

@@ -9,6 +9,7 @@ use crate::StorageData;
 /// a given key.
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
+#[derive(Debug, PartialEq)]
 pub struct RemoveIndexQuery(pub DbValue);
 
 impl QueryMut for RemoveIndexQuery {

agdb/src/query/remove_query.rs

@@ -14,6 +14,7 @@ use crate::StorageData;
 /// also removed along with their properties.
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
+#[derive(Debug, PartialEq)]
 pub struct RemoveQuery(pub QueryIds);
 
 impl QueryMut for RemoveQuery {

agdb/src/query/remove_values_query.rs

@@ -13,6 +13,7 @@ use crate::StorageData;
 /// do not exist on any of the elements).
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
+#[derive(Debug, PartialEq)]
 pub struct RemoveValuesQuery(pub SelectValuesQuery);
 
 impl QueryMut for RemoveValuesQuery {

agdb/src/query/search_query.rs

@@ -13,9 +13,9 @@ use crate::StorageData;
 use std::cmp::Ordering;
 
 /// Search algorithm to be used
-#[derive(Debug, Clone, Copy, PartialEq)]
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
+#[derive(Debug, Clone, Copy, PartialEq)]
 pub enum SearchQueryAlgorithm {
     /// Examines each distance level from the search origin in full
     /// before continuing with the next level. E.g. when starting at

agdb/src/query/select_aliases_query.rs

@@ -15,6 +15,7 @@ use crate::StorageData;
 /// the value `String`.
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
+#[derive(Debug, PartialEq)]
 pub struct SelectAliasesQuery(pub QueryIds);
 
 impl Query for SelectAliasesQuery {

agdb/src/query/select_all_aliases_query.rs

@@ -12,6 +12,7 @@ use crate::StorageData;
 /// the value `String`.
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
+#[derive(Debug, PartialEq)]
 pub struct SelectAllAliasesQuery {}
 
 impl Query for SelectAllAliasesQuery {

agdb/src/query/select_indexes_query.rs

@@ -14,6 +14,7 @@ use crate::StorageData;
 /// index.
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
+#[derive(Debug, PartialEq)]
 pub struct SelectIndexesQuery {}
 
 impl Query for SelectIndexesQuery {

agdb/src/query/select_key_count_query.rs

@@ -14,6 +14,7 @@ use crate::StorageData;
 /// a value `u64`.
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
+#[derive(Debug, PartialEq)]
 pub struct SelectKeyCountQuery(pub QueryIds);
 
 impl Query for SelectKeyCountQuery {

agdb/src/query/select_keys_query.rs

@@ -13,6 +13,7 @@ use crate::StorageData;
 /// of elements with all properties except all values will be empty.
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
+#[derive(Debug, PartialEq)]
 pub struct SelectKeysQuery(pub QueryIds);
 
 impl Query for SelectKeysQuery {

agdb/src/query/select_query.rs

@@ -13,6 +13,7 @@ use crate::StorageData;
 /// list of elements with all properties.
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
+#[derive(Debug, PartialEq)]
 pub struct SelectQuery(pub QueryIds);
 
 impl Query for SelectQuery {

agdb/src/query/select_values_query.rs

@@ -15,6 +15,7 @@ use crate::StorageData;
 /// list of elements with the requested properties.
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
+#[derive(Debug, PartialEq)]
 pub struct SelectValuesQuery {
     pub keys: Vec<DbValue>,
     pub ids: QueryIds,

agdb_api/rust/src/api.rs

@@ -1,16 +1,16 @@
-use agdb::QueryResult;
-use agdb::QueryType;
-
 use crate::api_result::AgdbApiResult;
 use crate::api_types::DbType;
 use crate::api_types::ServerDatabase;
 use crate::api_types::UserCredentials;
 use crate::http_client::HttpClient;
 use crate::ChangePassword;
+use crate::DbAudit;
 use crate::DbUser;
 use crate::DbUserRole;
 use crate::UserLogin;
 use crate::UserStatus;
+use agdb::QueryResult;
+use agdb::QueryType;
 
 pub struct AgdbApi<T: HttpClient> {
     client: T,
@@ -41,6 +41,15 @@ impl<T: HttpClient> AgdbApi<T> {
             .0)
     }
 
+    pub async fn admin_db_audit(&self, owner: &str, db: &str) -> AgdbApiResult<(u16, DbAudit)> {
+        self.client
+            .get(
+                &self.url(&format!("/admin/db/{owner}/{db}/audit")),
+                &self.token,
+            )
+            .await
+    }
+
     pub async fn admin_db_backup(&self, owner: &str, db: &str) -> AgdbApiResult<u16> {
         Ok(self
             .client
@@ -268,6 +277,12 @@ impl<T: HttpClient> AgdbApi<T> {
             .0)
     }
 
+    pub async fn db_audit(&self, owner: &str, db: &str) -> AgdbApiResult<(u16, DbAudit)> {
+        self.client
+            .get(&self.url(&format!("/db/{owner}/{db}/audit")), &self.token)
+            .await
+    }
+
     pub async fn db_backup(&self, owner: &str, db: &str) -> AgdbApiResult<u16> {
         Ok(self
             .client

agdb_api/rust/src/api_types.rs

@@ -48,6 +48,16 @@ pub struct Queries(pub Vec<QueryType>);
 #[derive(Serialize, ToSchema)]
 pub struct QueriesResults(pub Vec<QueryResult>);
 
+#[derive(Debug, Deserialize, Serialize, ToSchema, PartialEq)]
+pub struct QueryAudit {
+    pub timestamp: u64,
+    pub user: String,
+    pub query: QueryType,
+}
+
+#[derive(Debug, Deserialize, Serialize, ToSchema, PartialEq)]
+pub struct DbAudit(pub Vec<QueryAudit>);
+
 #[derive(Debug, Default, Deserialize, Serialize, ToSchema, PartialEq, Eq, PartialOrd, Ord)]
 pub struct ServerDatabase {
     pub name: String,
@@ -139,6 +149,8 @@ impl Display for DbUserRole {
 
 #[cfg(test)]
 mod tests {
+    use agdb::SelectIndexesQuery;
+
     use super::*;
 
     #[test]
@@ -168,6 +180,26 @@ mod tests {
                 name: "user".to_string()
             }
         );
+        format!(
+            "{:?}",
+            QueryAudit {
+                timestamp: 0,
+                user: "user".to_string(),
+                query: QueryType::SelectIndexes(SelectIndexesQuery {})
+            }
+        );
+        format!("{:?}", DbAudit(vec![]));
+    }
+
+    #[test]
+    fn derived_from_partial_eq() {
+        let query_audit = QueryAudit {
+            timestamp: 0,
+            user: "user".to_string(),
+            query: QueryType::SelectIndexes(SelectIndexesQuery {}),
+        };
+        let audit = DbAudit(vec![query_audit]);
+        assert_eq!(audit, audit);
     }
 
     #[test]

agdb_api/rust/src/lib.rs

@@ -8,11 +8,13 @@ pub use api::AgdbApi;
 pub use api_error::AgdbApiError;
 pub use api_result::AgdbApiResult;
 pub use api_types::ChangePassword;
+pub use api_types::DbAudit;
 pub use api_types::DbType;
 pub use api_types::DbUser;
 pub use api_types::DbUserRole;
 pub use api_types::Queries;
 pub use api_types::QueriesResults;
+pub use api_types::QueryAudit;
 pub use api_types::ServerDatabase;
 pub use api_types::UserCredentials;
 pub use api_types::UserLogin;