Merge branch 'main' into nathan/more-ui-tests

Author: nathanosdev

Cargo.lock

@@ -5,6 +5,7 @@ members = [
   "src/backend/impl",
   "src/backend/external_canisters",
   "src/backend/logs",
+  "src/backend/macros",
 ]
 
 [profile.release]

Cargo.toml

@@ -11,6 +11,7 @@ dev = []
 
 [dependencies]
 backend_api = { path = "../api" }
+backend_macros = { path = "../macros" }
 external_canisters = { path = "../external_canisters" }
 
 ic-cdk.workspace = true

src/backend/impl/Cargo.toml

@@ -8,10 +8,12 @@ use crate::{
 use backend_api::{
     ApiError, ApiResult, ListProposalsRequest, ListProposalsResponse, SyncProposalsResponse,
 };
+use backend_macros::log_errors;
 use candid::Principal;
 use ic_cdk::*;
 
 #[update]
+#[log_errors(crate::services::log_update_call_error)]
 async fn sync_proposals() -> ApiResult<SyncProposalsResponse> {
     let calling_principal = caller();
 

src/backend/impl/src/controllers/proposal_controller.rs

@@ -2,6 +2,7 @@ use backend_api::{
     ApiError, ApiResult, CreateProposalReviewCommitRequest, CreateProposalReviewCommitResponse,
     DeleteProposalReviewCommitRequest, UpdateProposalReviewCommitRequest,
 };
+use backend_macros::log_errors;
 use candid::Principal;
 use ic_cdk::*;
 
@@ -17,6 +18,7 @@ use crate::{
 };
 
 #[update]
+#[log_errors(crate::services::log_update_call_error)]
 async fn create_proposal_review_commit(
     request: CreateProposalReviewCommitRequest,
 ) -> ApiResult<CreateProposalReviewCommitResponse> {
@@ -29,6 +31,7 @@ async fn create_proposal_review_commit(
 }
 
 #[update]
+#[log_errors(crate::services::log_update_call_error)]
 async fn update_proposal_review_commit(
     request: UpdateProposalReviewCommitRequest,
 ) -> ApiResult<()> {
@@ -40,6 +43,7 @@ async fn update_proposal_review_commit(
 }
 
 #[update]
+#[log_errors(crate::services::log_update_call_error)]
 async fn delete_proposal_review_commit(
     request: DeleteProposalReviewCommitRequest,
 ) -> ApiResult<()> {

src/backend/impl/src/controllers/proposal_review_commit_controller.rs

@@ -16,10 +16,12 @@ use backend_api::{
     GetMyProposalReviewSummaryResponse, GetProposalReviewRequest, GetProposalReviewResponse,
     ListProposalReviewsRequest, ListProposalReviewsResponse, UpdateProposalReviewRequest,
 };
+use backend_macros::log_errors;
 use candid::Principal;
 use ic_cdk::*;
 
 #[update]
+#[log_errors(crate::services::log_update_call_error)]
 async fn create_proposal_review(
     request: CreateProposalReviewRequest,
 ) -> ApiResult<CreateProposalReviewResponse> {
@@ -32,6 +34,7 @@ async fn create_proposal_review(
 }
 
 #[update]
+#[log_errors(crate::services::log_update_call_error)]
 fn update_proposal_review(request: UpdateProposalReviewRequest) -> ApiResult<()> {
     let calling_principal = caller();
 
@@ -61,6 +64,7 @@ fn get_proposal_review(request: GetProposalReviewRequest) -> ApiResult<GetPropos
 }
 
 #[update]
+#[log_errors(crate::services::log_update_call_error)]
 async fn create_proposal_review_image(
     request: CreateProposalReviewImageRequest,
 ) -> ApiResult<CreateProposalReviewImageResponse> {
@@ -73,6 +77,7 @@ async fn create_proposal_review_image(
 }
 
 #[update]
+#[log_errors(crate::services::log_update_call_error)]
 fn delete_proposal_review_image(request: DeleteProposalReviewImageRequest) -> ApiResult<()> {
     let calling_principal = caller();
 

src/backend/impl/src/controllers/proposal_review_controller.rs

@@ -9,6 +9,7 @@ use backend_api::{
     GetMyUserProfileResponse, ListReviewerProfilesResponse, UpdateMyUserProfileRequest,
     UpdateUserProfileRequest,
 };
+use backend_macros::log_errors;
 use candid::Principal;
 use ic_cdk::*;
 
@@ -38,6 +39,7 @@ fn get_my_user_profile_history() -> ApiResult<GetMyUserProfileHistoryResponse> {
 }
 
 #[update]
+#[log_errors(crate::services::log_update_call_error)]
 async fn create_my_user_profile() -> ApiResult<CreateMyUserProfileResponse> {
     let calling_principal = caller();
 
@@ -48,6 +50,7 @@ async fn create_my_user_profile() -> ApiResult<CreateMyUserProfileResponse> {
 }
 
 #[update]
+#[log_errors(crate::services::log_update_call_error)]
 fn update_my_user_profile(request: UpdateMyUserProfileRequest) -> ApiResult<()> {
     let calling_principal = caller();
 
@@ -57,6 +60,7 @@ fn update_my_user_profile(request: UpdateMyUserProfileRequest) -> ApiResult<()>
 }
 
 #[update]
+#[log_errors(crate::services::log_update_call_error)]
 async fn update_user_profile(request: UpdateUserProfileRequest) -> ApiResult<()> {
     let calling_principal = caller();
 

src/backend/impl/src/controllers/user_profile_controller.rs

@@ -85,6 +85,24 @@ impl<T: LogRepository> LogServiceImpl<T> {
     }
 }
 
+/// Mainly used with the `log_errors` macro.
+///
+/// # Example
+/// ```
+/// use ic_cdk::update;
+/// use backend_macros::log_errors;
+///
+/// #[update]
+/// #[log_errors(crate::services::log_update_call_error)]
+/// async fn create_proposal_review() -> ApiResult<()> {
+///     Ok(())
+/// }
+/// ```
+pub fn log_update_call_error(message: String, context: String) {
+    // We can ignore this error
+    let _ = LogServiceImpl::default().log_error(message, Some(context));
+}
+
 #[cfg(test)]
 mod tests {
     use super::*;

src/backend/impl/src/services/log_service.rs

@@ -0,0 +1,13 @@
+[package]
+name = "backend_macros"
+version = "0.1.0"
+edition = "2021"
+
+[lib]
+proc-macro = true
+
+[dependencies]
+backend_api = { path = "../api" }
+
+syn = "2.0"
+quote = "1.0"

src/backend/macros/Cargo.toml

@@ -0,0 +1,44 @@
+extern crate proc_macro;
+use proc_macro::TokenStream;
+use quote::quote;
+use syn::{parse_macro_input, ItemFn, Path, ReturnType};
+
+#[proc_macro_attribute]
+pub fn log_errors(attr: TokenStream, item: TokenStream) -> TokenStream {
+    let log_fn = parse_macro_input!(attr as Path);
+
+    let input = parse_macro_input!(item as ItemFn);
+    let fn_name = &input.sig.ident;
+    let fn_args = &input.sig.inputs;
+    let fn_return_type = &input.sig.output;
+    let fn_block = &input.block;
+    let fn_async = &input.sig.asyncness;
+
+    // Ensure the function returns a Result
+    let result = match fn_return_type {
+        ReturnType::Type(_, _) => {
+            let block = if fn_async.is_some() {
+                quote! { (async { #fn_block }).await }
+            } else {
+                quote! { (|| #fn_block)() }
+            };
+
+            quote! {
+                #fn_async fn #fn_name(#fn_args) #fn_return_type {
+                    let result = #block;
+                    if let backend_api::ApiResult::Err(ref e) = result {
+                        let message = e.to_string();
+                        let context = stringify!(#fn_name);
+                        #log_fn(message, context.to_string());
+                    }
+                    result
+                }
+            }
+        }
+        _ => quote! {
+            compile_error!("The log_errors macro can only be applied to functions that return a Result.");
+        },
+    };
+
+    result.into()
+}