Merge pull request #512 from AmbireTech/channel-list-filter-by-chain

Channel list filter by chain

Author: simzzz

primitives/src/sentry.rs

@@ -550,7 +550,10 @@ impl<'de> Deserialize<'de> for DateHour<Utc> {
 #[derive(Debug, Serialize, Deserialize, PartialEq)]
 #[serde(rename_all = "camelCase")]
 pub struct Pagination {
+    /// The total amount of pages available for this request
     pub total_pages: u64,
+    /// The current page number returned from this request
+    /// First page starts from `0`
     pub page: u64,
 }
 
@@ -637,7 +640,7 @@ pub struct ValidationErrorResponse {
 }
 
 pub mod channel_list {
-    use crate::{Channel, ValidatorId};
+    use crate::{ChainId, Channel, ValidatorId};
     use serde::{Deserialize, Serialize};
 
     use super::Pagination;
@@ -652,11 +655,14 @@ pub mod channel_list {
 
     #[derive(Debug, Serialize, Deserialize)]
     pub struct ChannelListQuery {
+        /// default is `u64::default()` = `0`
         #[serde(default)]
-        // default is `u64::default()` = `0`
         pub page: u64,
-        /// filters the channels containing a specific validator if provided
+        /// Returns only the [`Channel`]s containing a specified validator if provided.
         pub validator: Option<ValidatorId>,
+        /// Returns only the Channels from the specified [`ChainId`]s.
+        #[serde(default)]
+        pub chains: Vec<ChainId>,
     }
 }
 
@@ -677,15 +683,15 @@ pub mod campaign_list {
 
     #[derive(Debug, Serialize, Deserialize, PartialEq)]
     pub struct CampaignListQuery {
+        /// default is `u64::default()` = `0`
         #[serde(default)]
-        // default is `u64::default()` = `0`
         pub page: u64,
         /// filters the list on `active.to >= active_to_ge`
         /// It should be the same timestamp format as the `Campaign.active.to`: **seconds**
         #[serde(with = "ts_seconds", default = "Utc::now", rename = "activeTo")]
         pub active_to_ge: DateTime<Utc>,
         pub creator: Option<Address>,
-        /// filters the campaigns containing a specific validator if provided
+        /// Returns only the [`Campaign`]s containing a specified validator if provided.
         #[serde(flatten)]
         pub validator: Option<ValidatorParam>,
     }

sentry/migrations/20190806011140_initial-tables/up.sql

@@ -6,6 +6,7 @@ CREATE TABLE channels (
     token varchar(42) NOT NULL,
     -- Using varchar for U256 for simplicity
     nonce varchar(78) NOT NULL,
+    chain_id integer NOT NULL,
     -- In order to be able to order the channels for the `GET channel` request
     created timestamp(2) with time zone NOT NULL,
     -- Do not rename the Primary key constraint (`channels_pkey`)!

sentry/src/db/accounting.rs

@@ -185,8 +185,9 @@ pub async fn spend_amount(
 
 #[cfg(test)]
 mod test {
-    use primitives::test_util::{
-        ADVERTISER, ADVERTISER_2, CREATOR, DUMMY_CAMPAIGN, PUBLISHER, PUBLISHER_2,
+    use primitives::{
+        config::GANACHE_CONFIG,
+        test_util::{ADVERTISER, ADVERTISER_2, CREATOR, DUMMY_CAMPAIGN, PUBLISHER, PUBLISHER_2},
     };
 
     use crate::db::{
@@ -203,8 +204,14 @@ mod test {
         setup_test_migrations(database.pool.clone())
             .await
             .expect("Migrations should succeed");
+
+        let channel_chain = GANACHE_CONFIG
+            .find_chain_of(DUMMY_CAMPAIGN.channel.token)
+            .expect("Channel token should be whitelisted in config!");
+        let channel_context = channel_chain.with_channel(DUMMY_CAMPAIGN.channel);
+
         // insert the channel into the DB
-        let channel = insert_channel(&database.pool, DUMMY_CAMPAIGN.channel)
+        let channel = insert_channel(&database.pool, &channel_context)
             .await
             .expect("Should insert");
 
@@ -399,8 +406,13 @@ mod test {
             .await
             .expect("Migrations should succeed");
 
+        let channel_chain = GANACHE_CONFIG
+            .find_chain_of(DUMMY_CAMPAIGN.channel.token)
+            .expect("Channel token should be whitelisted in config!");
+        let channel_context = channel_chain.with_channel(DUMMY_CAMPAIGN.channel);
+
         // insert the channel into the DB
-        let channel = insert_channel(&database.pool, DUMMY_CAMPAIGN.channel)
+        let channel = insert_channel(&database.pool, &channel_context)
             .await
             .expect("Should insert");
 
@@ -486,8 +498,13 @@ mod test {
             .await
             .expect("Migrations should succeed");
 
+        let channel_chain = GANACHE_CONFIG
+            .find_chain_of(DUMMY_CAMPAIGN.channel.token)
+            .expect("Channel token should be whitelisted in config!");
+        let channel_context = channel_chain.with_channel(DUMMY_CAMPAIGN.channel);
+
         // insert the channel into the DB
-        let channel = insert_channel(&database.pool, DUMMY_CAMPAIGN.channel)
+        let channel = insert_channel(&database.pool, &channel_context)
             .await
             .expect("Should insert");
 

sentry/src/db/campaign.rs

@@ -579,6 +579,7 @@ mod test {
     use primitives::{
         campaign,
         campaign::Validators,
+        config::GANACHE_CONFIG,
         event_submission::{RateLimit, Rule},
         sentry::{campaign_modify::ModifyCampaign, CLICK, IMPRESSION},
         targeting::Rules,
@@ -603,8 +604,13 @@ mod test {
 
         let campaign = DUMMY_CAMPAIGN.clone();
 
+        let channel_chain = GANACHE_CONFIG
+            .find_chain_of(DUMMY_CAMPAIGN.channel.token)
+            .expect("Channel token should be whitelisted in config!");
+        let channel_context = channel_chain.with_channel(DUMMY_CAMPAIGN.channel);
+
         // insert the channel into the DB
-        let _channel = insert_channel(&database.pool, DUMMY_CAMPAIGN.channel)
+        let _channel = insert_channel(&database.pool, &channel_context)
             .await
             .expect("Should insert");
 
@@ -699,10 +705,17 @@ mod test {
         let mut channel_with_different_leader = DUMMY_CAMPAIGN.channel;
         channel_with_different_leader.leader = IDS[&ADVERTISER_2];
 
-        insert_channel(&database, DUMMY_CAMPAIGN.channel)
+        let channel_chain = GANACHE_CONFIG
+            .find_chain_of(DUMMY_CAMPAIGN.channel.token)
+            .expect("Channel token should be whitelisted in config!");
+        let channel_context = channel_chain.clone().with_channel(DUMMY_CAMPAIGN.channel);
+        let channel_context_different_leader =
+            channel_chain.with_channel(channel_with_different_leader);
+
+        insert_channel(&database, &channel_context)
             .await
             .expect("Should insert");
-        insert_channel(&database, channel_with_different_leader)
+        insert_channel(&database, &channel_context_different_leader)
             .await
             .expect("Should insert");