Add logging around submitting proposals (#4538)

open-chat-labs · Oct 10, 2023 · 15e12b6 · 15e12b6
1 parent da7d65b
commit 15e12b6
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 4 deletions.
diff --git a/backend/canisters/proposals_bot/CHANGELOG.md b/backend/canisters/proposals_bot/CHANGELOG.md
@@ -9,6 +9,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 - Automatically create proposals groups for new SNSes ([#4528](https://github.com/open-chat-labs/open-chat/pull/4528))
 
+### Changed
+
+- Add logging around submitting proposals ([#4538](https://github.com/open-chat-labs/open-chat/pull/4538))
+
 ### Removed
 
 - Remove `add_governance_canister` since it is now automated ([#4532](https://github.com/open-chat-labs/open-chat/pull/4532))

diff --git a/backend/canisters/proposals_bot/impl/src/updates/c2c_submit_proposal.rs b/backend/canisters/proposals_bot/impl/src/updates/c2c_submit_proposal.rs
@@ -8,6 +8,7 @@ use proposals_bot_canister::{ProposalToSubmit, ProposalToSubmitAction, Treasury}
 use sns_governance_canister::types::manage_neuron::Command;
 use sns_governance_canister::types::proposal::Action;
 use sns_governance_canister::types::{manage_neuron_response, Motion, Proposal, Subaccount, TransferSnsTreasuryFunds};
+use tracing::{error, info};
 use types::{CanisterId, MultiUserChat, SnsNeuronId, UserDetails, UserId};
 use user_index_canister_c2c_client::{lookup_user, LookupUserError};
 use utils::time::SECOND_IN_MS;
@@ -30,7 +31,10 @@ async fn c2c_submit_proposal(args: Args) -> Response {
     let UserDetails { user_id, username, .. } = match lookup_user(caller, user_index_canister_id).await {
         Ok(u) => u,
         Err(LookupUserError::UserNotFound) => unreachable!(),
-        Err(LookupUserError::InternalError(error)) => return InternalError(error),
+        Err(LookupUserError::InternalError(error)) => {
+            error!(error = error.as_str(), %caller, "Failed to lookup user");
+            return InternalError(error);
+        }
     };
 
     let proposal = prepare_proposal(args.proposal, user_id, username, chat);
@@ -106,20 +110,26 @@ pub(crate) async fn submit_proposal(
             if let Some(command) = response.command {
                 return match command {
                     manage_neuron_response::Command::MakeProposal(p) => {
+                        let proposal_id = p.proposal_id.unwrap().id;
                         mutate_state(|state| {
                             state.data.nervous_systems.record_user_submitted_proposal(
                                 governance_canister_id,
                                 user_id,
-                                p.proposal_id.unwrap().id,
+                                proposal_id,
                             )
                         });
+                        info!(proposal_id, %user_id, "Proposal submitted");
                         Success
                     }
-                    manage_neuron_response::Command::Error(error) => InternalError(format!("{error:?}")),
+                    manage_neuron_response::Command::Error(error) => {
+                        error!(?error, %user_id, "Failed to submit proposal");
+                        InternalError(format!("{error:?}"))
+                    }
                     _ => unreachable!(),
                 };
             }
-            InternalError("Response command was empty".to_string())
+            error!(%user_id, "Failed to submit proposal, response was empty");
+            InternalError("Empty response from `manage_neuron`".to_string())
         }
         Err(error) => {
             mutate_state(|state| {