Disable companies we are no longer singatory in (#615)

* Add active flag, set flag on block update

* Hide inactive companies from the UI

Author: tompro

crates/bcr-ebill-api/src/service/company_service.rs

@@ -340,6 +340,7 @@ impl CompanyServiceApi for CompanyService {
             proof_of_registration_file,
             logo_file,
             signatories: vec![full_identity.identity.node_id.clone()], // add caller as signatory
+            active: true,
         };
         self.store.insert(&company).await?;
 
@@ -935,6 +936,7 @@ pub mod tests {
                     proof_of_registration_file: None,
                     logo_file: None,
                     signatories: vec![node_id_test()],
+                    active: true,
                 },
                 CompanyKeys {
                     private_key: private_key_test(),

crates/bcr-ebill-core/src/blockchain/company/mod.rs

@@ -585,6 +585,7 @@ mod tests {
                     proof_of_registration_file: None,
                     logo_file: None,
                     signatories: vec![node_id_test()],
+                    active: true,
                 },
                 CompanyKeys {
                     private_key: private_key_test(),

crates/bcr-ebill-core/src/company.rs

@@ -20,11 +20,13 @@ pub struct Company {
     pub proof_of_registration_file: Option<File>,
     pub logo_file: Option<File>,
     pub signatories: Vec<NodeId>,
+    pub active: bool,
 }
 
 impl Company {
     /// Creates a new company from a block data payload
-    pub fn from_block_data(data: CompanyCreateBlockData) -> Self {
+    pub fn from_block_data(data: CompanyCreateBlockData, our_node_id: &NodeId) -> Self {
+        let active = data.signatories.contains(our_node_id);
         Self {
             id: data.id,
             name: data.name,
@@ -37,10 +39,11 @@ impl Company {
             proof_of_registration_file: data.proof_of_registration_file,
             logo_file: data.logo_file,
             signatories: data.signatories,
+            active,
         }
     }
     /// Applies data from a block to this company.
-    pub fn apply_block_data(&mut self, data: &CompanyBlockPayload) {
+    pub fn apply_block_data(&mut self, data: &CompanyBlockPayload, our_node_id: &NodeId) {
         match data {
             CompanyBlockPayload::Update(payload) => {
                 self.name = payload.name.to_owned().unwrap_or(self.name.to_owned());
@@ -90,10 +93,16 @@ impl Company {
             CompanyBlockPayload::AddSignatory(payload) => {
                 if !self.signatories.contains(&payload.signatory) {
                     self.signatories.push(payload.signatory.to_owned());
+                    if &payload.signatory == our_node_id {
+                        self.active = true;
+                    }
                 }
             }
             CompanyBlockPayload::RemoveSignatory(payload) => {
                 self.signatories.retain(|i| i != &payload.signatory);
+                if &payload.signatory == our_node_id {
+                    self.active = false;
+                }
             }
             _ => {}
         }

crates/bcr-ebill-persistence/src/db/company.rs

@@ -38,7 +38,7 @@ impl CompanyStoreApi for SurrealCompanyStore {
         bindings.add(DB_TABLE, Self::DATA_TABLE)?;
         bindings.add(DB_SEARCH_TERM, search_term.to_owned())?;
         let results: Vec<CompanyDb> = self.db
-            .query("SELECT * from type::table($table) WHERE string::lowercase(name) CONTAINS $search_term", bindings).await?;
+            .query("SELECT * from type::table($table) WHERE string::lowercase(name) CONTAINS $search_term AND active != false", bindings).await?;
         results.into_iter().map(|c| c.try_into()).collect()
     }
 
@@ -57,7 +57,15 @@ impl CompanyStoreApi for SurrealCompanyStore {
     }
 
     async fn get_all(&self) -> Result<HashMap<NodeId, (Company, CompanyKeys)>> {
-        let companies: Vec<CompanyDb> = self.db.select_all(Self::DATA_TABLE).await?;
+        let mut bindings = Bindings::default();
+        bindings.add(DB_TABLE, Self::DATA_TABLE)?;
+        let companies: Vec<CompanyDb> = self
+            .db
+            .query(
+                "SELECT * from type::table($table) WHERE active != false",
+                bindings,
+            )
+            .await?;
         let company_keys: Vec<CompanyKeysDb> = self.db.select_all(Self::KEYS_TABLE).await?;
         let companies_map: HashMap<NodeId, CompanyDb> = companies
             .into_iter()
@@ -145,6 +153,13 @@ pub struct CompanyDb {
     pub proof_of_registration_file: Option<FileDb>,
     pub logo_file: Option<FileDb>,
     pub signatories: Vec<NodeId>,
+    #[serde(default = "active_default")]
+    pub active: bool,
+}
+
+// needed to default existing companies to active
+fn active_default() -> bool {
+    true
 }
 
 #[derive(Debug, Clone, Serialize, Deserialize)]
@@ -170,6 +185,7 @@ impl TryFrom<CompanyDb> for Company {
             proof_of_registration_file: value.proof_of_registration_file.map(|f| f.into()),
             logo_file: value.logo_file.map(|f| f.into()),
             signatories: value.signatories,
+            active: value.active,
         })
     }
 }
@@ -195,6 +211,7 @@ impl From<&Company> for CompanyDb {
                 .map(|f| (&f).into()),
             logo_file: value.logo_file.clone().map(|f| (&f).into()),
             signatories: value.signatories.clone(),
+            active: value.active,
         }
     }
 }
@@ -249,6 +266,7 @@ mod tests {
             proof_of_registration_file: None,
             logo_file: None,
             signatories: vec![node_id_test()],
+            active: true,
         }
     }
 
@@ -379,4 +397,50 @@ mod tests {
             node_id_test().pub_key()
         );
     }
+
+    #[tokio::test]
+    async fn test_get_all_and_search_only_return_active_companies() {
+        let store = get_store().await;
+        let mut company = get_baseline_company();
+        company.name = "first company".to_string();
+        store.insert(&company).await.unwrap();
+        store
+            .save_key_pair(
+                &node_id_test(),
+                &CompanyKeys {
+                    private_key: private_key_test(),
+                    public_key: node_id_test().pub_key(),
+                },
+            )
+            .await
+            .unwrap();
+        let mut company2 = get_baseline_company();
+        company2.id = node_id_test_other();
+        company2.name = "second company".to_string();
+        company2.active = false;
+
+        store.insert(&company2).await.unwrap();
+        store
+            .save_key_pair(
+                &company2.id,
+                &CompanyKeys {
+                    private_key: private_key_test(),
+                    public_key: node_id_test().pub_key(),
+                },
+            )
+            .await
+            .unwrap();
+        let companies = store.get_all().await.unwrap();
+        assert_eq!(companies.len(), 1);
+        assert_eq!(
+            companies.get(&node_id_test()).as_ref().unwrap().0.name,
+            "first company".to_owned()
+        );
+        let search_results = store.search("company").await.unwrap();
+        assert_eq!(search_results.len(), 1);
+        assert_eq!(
+            search_results.first().unwrap().name,
+            "first company".to_owned()
+        );
+    }
 }

crates/bcr-ebill-persistence/src/db/company_chain.rs

@@ -283,6 +283,7 @@ mod tests {
                 proof_of_registration_file: None,
                 logo_file: None,
                 signatories: vec![node_id_test()],
+                active: true,
             }
             .into(),
             &BcrKeys::new(),
@@ -338,6 +339,7 @@ mod tests {
                 proof_of_registration_file: None,
                 logo_file: None,
                 signatories: vec![node_id_test()],
+                active: true,
             }
             .into(),
             &BcrKeys::new(),