chore(boundary): add candid error types and unit tests for rate-limit canister

rs/boundary_node/rate_limits/api/src/lib.rs

@@ -11,18 +11,60 @@ pub type RuleId = String;
 pub type IncidentId = String;
 pub type SchemaVersion = u64;
 
-pub type GetConfigResponse = Result<ConfigResponse, String>;
-pub type AddConfigResponse = Result<(), String>;
-pub type GetRuleByIdResponse = Result<OutputRuleMetadata, String>;
+pub type GetConfigResponse = Result<ConfigResponse, GetConfigError>;
+pub type AddConfigResponse = Result<(), AddConfigError>;
+pub type GetRuleByIdResponse = Result<OutputRuleMetadata, GetRuleByIdError>;
 pub type DiscloseRulesResponse = Result<(), DiscloseRulesError>;
-pub type GetRulesByIncidentIdResponse = Result<Vec<OutputRuleMetadata>, String>;
+pub type GetRulesByIncidentIdResponse = Result<Vec<OutputRuleMetadata>, GetRulesByIncidentIdError>;
 
 #[derive(CandidType, Deserialize, Debug, Clone)]
 pub enum DiscloseRulesArg {
     RuleIds(Vec<RuleId>),
     IncidentIds(Vec<IncidentId>),
 }
 
+#[derive(CandidType, Debug, Deserialize)]
+pub enum GetConfigError {
+    /// Indicates that a config with the specified version does not exist
+    NotFound,
+    /// Indicates that no configs exist, hence nothing could be returned
+    NoExistingConfigsFound,
+    /// Captures all unexpected internal errors
+    Internal(String),
+}
+
+#[derive(CandidType, Debug, Deserialize)]
+pub enum GetRuleByIdError {
+    /// Indicates that a rule with the specified ID does not exist
+    NotFound,
+    // Indicates that the provided ID is not a valid UUID
+    InvalidUuidFormat,
+    /// Captures all unexpected internal errors
+    Internal(String),
+}
+
+#[derive(CandidType, Debug, Deserialize)]
+pub enum GetRulesByIncidentIdError {
+    /// Indicates that an incident with the specified ID does not exist
+    NotFound,
+    /// Indicates that the provided ID is not a valid UUID
+    InvalidUuidFormat,
+    /// Captures all unexpected internal errors
+    Internal(String),
+}
+
+#[derive(CandidType, Debug, Deserialize)]
+pub enum AddConfigError {
+    /// Indicates an unauthorized attempt to add a new config
+    Unauthorized,
+    /// Signifies that the provided input config is malformed
+    InvalidInputConfig(String),
+    /// Signifies that a new configuration cannot be added due to some policy infringement
+    PolicyViolation(String),
+    /// Captures all unexpected internal errors during the disclosure process
+    Internal(String),
+}
+
 #[derive(CandidType, Debug, Deserialize)]
 pub enum DiscloseRulesError {
     /// Indicates an unauthorized attempt to disclose rules
@@ -37,42 +79,42 @@ pub enum DiscloseRulesError {
     Internal(String),
 }
 
-#[derive(CandidType, Deserialize, Debug)]
+#[derive(CandidType, Deserialize, Debug, PartialEq)]
 pub struct ConfigResponse {
     pub version: Version,
     pub active_since: Timestamp,
     pub config: OutputConfig,
 }
 
-#[derive(CandidType, Deserialize, Debug)]
+#[derive(CandidType, Deserialize, Debug, PartialEq)]
 pub struct OutputConfig {
     pub schema_version: SchemaVersion,
     pub is_redacted: bool,
     pub rules: Vec<OutputRule>,
 }
 
-#[derive(CandidType, Deserialize, Debug)]
+#[derive(CandidType, Deserialize, Debug, Clone)]
 pub struct InputConfig {
     pub schema_version: SchemaVersion,
     pub rules: Vec<InputRule>,
 }
 
-#[derive(CandidType, Deserialize, Debug)]
+#[derive(CandidType, Deserialize, Debug, Clone)]
 pub struct InputRule {
     pub incident_id: IncidentId,
     pub rule_raw: Vec<u8>,
     pub description: String,
 }
 
-#[derive(CandidType, Deserialize, Debug)]
+#[derive(CandidType, Deserialize, Debug, PartialEq)]
 pub struct OutputRule {
     pub id: RuleId,
     pub incident_id: IncidentId,
     pub rule_raw: Option<Vec<u8>>,
     pub description: Option<String>,
 }
 
-#[derive(CandidType, Deserialize, Debug)]
+#[derive(CandidType, Deserialize, Debug, PartialEq)]
 pub struct OutputRuleMetadata {
     pub id: RuleId,
     pub incident_id: IncidentId,

rs/boundary_node/rate_limits/canister/access_control.rs

@@ -2,18 +2,18 @@ use candid::Principal;
 use mockall::automock;
 
 use crate::{
-    add_config::{AddConfigError, AddsConfig},
+    add_config::AddsConfig,
     disclose::DisclosesRules,
     state::CanisterApi,
-    types::{DiscloseRulesError, Timestamp},
+    types::{AddConfigError, DiscloseRulesError, Timestamp},
 };
 
 #[automock]
 pub trait ResolveAccessLevel {
     fn get_access_level(&self) -> AccessLevel;
 }
 
-#[derive(PartialEq, Eq)]
+#[derive(Clone, PartialEq, Eq)]
 pub enum AccessLevel {
     FullAccess,
     FullRead,