Merge pull request #439 from AdExNetwork/issue-431-get-accounting-for-channel

simzzz · web-flow · commit aecadaa63aed · 2021-09-30T12:56:21.000+03:00
Issue 431 get accounting for channel
diff --git a/sentry/src/db/accounting.rs b/sentry/src/db/accounting.rs
@@ -83,6 +83,20 @@ pub async fn get_accounting(
     Ok(row.as_ref().map(Accounting::from))
 }
 
+pub async fn get_all_accountings_for_channel(
+    pool: DbPool,
+    channel_id: ChannelId,
+) -> Result<Vec<Accounting>, PoolError> {
+    let client = pool.get().await?;
+    let statement = client.prepare("SELECT channel_id, side, address, amount, updated, created FROM accounting WHERE channel_id = $1").await?;
+
+    let rows = client.query(&statement, &[&channel_id]).await?;
+
+    let accountings = rows.iter().map(Accounting::from).collect();
+
+    Ok(accountings)
+}
+
 /// Will update current Spender/Earner amount or insert a new Accounting record
 ///
 /// See `UPDATE_ACCOUNTING_STATEMENT` static for full query.
diff --git a/sentry/src/lib.rs b/sentry/src/lib.rs
@@ -25,8 +25,8 @@ use {
         campaign::{campaign_list, create_campaign, update_campaign},
         cfg::config,
         channel::{
-            channel_list, create_validator_messages, get_all_spender_limits, get_spender_limits,
-            last_approved,
+            channel_list, create_validator_messages, get_accounting_for_channel,
+            get_all_spender_limits, get_spender_limits, last_approved,
         },
         event_aggregate::list_channel_event_aggregates,
         validator_message::{extract_params, list_validator_messages},
@@ -81,6 +81,10 @@ static CHANNEL_ALL_SPENDER_LIMITS: Lazy<Regex> = Lazy::new(|| {
     Regex::new(r"^/v5/channel/0x([a-zA-Z0-9]{64})/spender/all/?$")
         .expect("The regex should be valid")
 });
+static CHANNEL_ACCOUNTING: Lazy<Regex> = Lazy::new(|| {
+    Regex::new(r"^/v5/channel/0x([a-zA-Z0-9]{64})/accounting/?$")
+        .expect("The regex should be valid")
+});
 
 #[derive(Debug, Clone)]
 pub struct RouteParams(pub Vec<String>);
@@ -394,6 +398,19 @@ async fn channels_router<A: Adapter + 'static>(
             .await?;
 
         get_all_spender_limits(req, app).await
+    } else if let (Some(caps), &Method::GET) = (CHANNEL_ACCOUNTING.captures(&path), method) {
+        let param = RouteParams(vec![caps
+            .get(1)
+            .map_or("".to_string(), |m| m.as_str().to_string())]);
+        req.extensions_mut().insert(param);
+
+        req = Chain::new()
+            .chain(AuthRequired)
+            .chain(ChannelLoad)
+            .apply(req, app)
+            .await?;
+
+        get_accounting_for_channel(req, app).await
     } else {
         Err(ResponseError::NotFound)
     }
diff --git a/sentry/src/routes/channel.rs b/sentry/src/routes/channel.rs
@@ -1,4 +1,5 @@
 use crate::db::{
+    accounting::{get_all_accountings_for_channel, Side},
     event_aggregate::{latest_approve_state_v5, latest_heartbeats, latest_new_state_v5},
     insert_channel, insert_validator_messages, list_channels,
     spendable::{fetch_spendable, get_all_spendables_for_channel, update_spendable},
@@ -9,11 +10,11 @@ use futures::future::try_join_all;
 use hyper::{Body, Request, Response};
 use primitives::{
     adapter::Adapter,
-    balances::{CheckedState, UncheckedState},
+    balances::{Balances, CheckedState, UncheckedState},
     config::TokenInfo,
     sentry::{
-        channel_list::ChannelListQuery, AllSpendersResponse, LastApproved, LastApprovedQuery,
-        LastApprovedResponse, Pagination, SpenderResponse, SuccessResponse,
+        channel_list::ChannelListQuery, AccountingResponse, AllSpendersResponse, LastApproved,
+        LastApprovedQuery, LastApprovedResponse, Pagination, SpenderResponse, SuccessResponse,
     },
     spender::{Spendable, Spender, SpenderLeaf},
     validator::{MessageTypes, NewState},
@@ -341,13 +342,54 @@ async fn get_corresponding_new_state(
     new_state
 }
 
+pub async fn get_accounting_for_channel<A: Adapter + 'static>(
+    req: Request<Body>,
+    app: &Application<A>,
+) -> Result<Response<Body>, ResponseError> {
+    let channel = req
+        .extensions()
+        .get::<Channel>()
+        .expect("Request should have Channel")
+        .to_owned();
+
+    let accountings = get_all_accountings_for_channel(app.pool.clone(), channel.id()).await?;
+
+    let mut unchecked_balances: Balances<UncheckedState> = Balances::default();
+
+    for accounting in accountings {
+        match accounting.side {
+            Side::Earner => unchecked_balances
+                .earners
+                .insert(accounting.address, accounting.amount),
+            Side::Spender => unchecked_balances
+                .spenders
+                .insert(accounting.address, accounting.amount),
+        };
+    }
+
+    let balances = match unchecked_balances.check() {
+        Ok(balances) => balances,
+        Err(error) => {
+            error!(&app.logger, "{}", &error; "module" => "channel_accounting");
+            return Err(ResponseError::FailedValidation(
+                "Earners sum is not equal to spenders sum for channel".to_string(),
+            ));
+        }
+    };
+
+    let res = AccountingResponse::<CheckedState> { balances };
+    Ok(success_response(serde_json::to_string(&res)?))
+}
+
 #[cfg(test)]
 mod test {
     use super::*;
+    use crate::db::{accounting::spend_amount, insert_channel};
     use crate::test_util::setup_dummy_app;
+    use hyper::StatusCode;
     use primitives::{
         adapter::Deposit,
-        util::tests::prep_db::{ADDRESSES, DUMMY_CAMPAIGN},
+        util::tests::prep_db::{ADDRESSES, DUMMY_CAMPAIGN, IDS},
         BigNum,
     };
 
@@ -433,4 +475,122 @@ mod test {
         );
         assert_eq!(updated_spendable.spender, ADDRESSES["creator"]);
     }
+
+    async fn res_to_accounting_response(res: Response<Body>) -> AccountingResponse<CheckedState> {
+        let json = hyper::body::to_bytes(res.into_body())
+            .await
+            .expect("Should get json");
+
+        let accounting_response: AccountingResponse<CheckedState> =
+            serde_json::from_slice(&json).expect("Should get AccouuntingResponse");
+        accounting_response
+    }
+
+    #[tokio::test]
+    async fn get_accountings_for_channel() {
+        let app = setup_dummy_app().await;
+        let channel = DUMMY_CAMPAIGN.channel.clone();
+        insert_channel(&app.pool, channel)
+            .await
+            .expect("should insert channel");
+        let build_request = |channel: Channel| {
+            Request::builder()
+                .extension(channel)
+                .body(Body::empty())
+                .expect("Should build Request")
+        };
+        // Testing for no accounting yet
+        {
+            let res = get_accounting_for_channel(build_request(channel.clone()), &app)
+                .await
+                .expect("should get response");
+            assert_eq!(StatusCode::OK, res.status());
+
+            let accounting_response = res_to_accounting_response(res).await;
+            assert_eq!(accounting_response.balances.earners.len(), 0);
+            assert_eq!(accounting_response.balances.spenders.len(), 0);
+        }
+
+        // Testing for 2 accountings - first channel
+        {
+            let mut balances = Balances::<CheckedState>::new();
+            balances
+                .spend(
+                    ADDRESSES["creator"],
+                    ADDRESSES["publisher"],
+                    UnifiedNum::from_u64(200),
+                )
+                .expect("should not overflow");
+            balances
+                .spend(
+                    ADDRESSES["tester"],
+                    ADDRESSES["publisher2"],
+                    UnifiedNum::from_u64(100),
+                )
+                .expect("Should not overflow");
+            spend_amount(app.pool.clone(), channel.id(), balances.clone())
+                .await
+                .expect("should spend");
+
+            let res = get_accounting_for_channel(build_request(channel.clone()), &app)
+                .await
+                .expect("should get response");
+            assert_eq!(StatusCode::OK, res.status());
+
+            let accounting_response = res_to_accounting_response(res).await;
+
+            assert_eq!(balances, accounting_response.balances);
+        }
+
+        // Testing for 2 accountings - second channel (same address is both an earner and a spender)
+        {
+            let mut second_channel = DUMMY_CAMPAIGN.channel.clone();
+            second_channel.leader = IDS["user"]; // channel.id() will be different now
+            insert_channel(&app.pool, second_channel)
+                .await
+                .expect("should insert channel");
+
+            let mut balances = Balances::<CheckedState>::new();
+            balances
+                .spend(ADDRESSES["tester"], ADDRESSES["publisher"], 300.into())
+                .expect("Should not overflow");
+
+            balances
+                .spend(ADDRESSES["publisher"], ADDRESSES["user"], 300.into())
+                .expect("Should not overflow");
+
+            spend_amount(app.pool.clone(), second_channel.id(), balances.clone())
+                .await
+                .expect("should spend");
+
+            let res = get_accounting_for_channel(build_request(second_channel.clone()), &app)
+                .await
+                .expect("should get response");
+            assert_eq!(StatusCode::OK, res.status());
+
+            let accounting_response = res_to_accounting_response(res).await;
+
+            assert_eq!(balances, accounting_response.balances)
+        }
+
+        // Testing for when sums don't match on first channel - Error case
+        {
+            let mut balances = Balances::<CheckedState>::new();
+            balances
+                .earners
+                .insert(ADDRESSES["publisher"], UnifiedNum::from_u64(100));
+            balances
+                .spenders
+                .insert(ADDRESSES["creator"], UnifiedNum::from_u64(200));
+            spend_amount(app.pool.clone(), channel.id(), balances)
+                .await
+                .expect("should spend");
+
+            let res = get_accounting_for_channel(build_request(channel.clone()), &app).await;
+            let expected = ResponseError::FailedValidation(
+                "Earners sum is not equal to spenders sum for channel".to_string(),
+            );
+            assert_eq!(expected, res.expect_err("Should return an error"));
+        }
+    }
 }
