sentry - GET /v5/units-for-slot:

- primitives - sentry - units_for_slot move from supermarket
- refactor units-for-slot route
- sentry - PlatformApi - refactor and remove old code
- primitives - platform - response refactor
- sentry - units_for_slot - refactor response

Author: elpiel

adview-manager/serve/src/routes.rs

@@ -1,8 +1,7 @@
 use std::sync::Arc;
 
 use adex_primitives::{
-    sentry::IMPRESSION,
-    supermarket::units_for_slot,
+    sentry::{units_for_slot, IMPRESSION},
     targeting::{input::Global, Input},
     test_util::{DUMMY_CAMPAIGN, DUMMY_IPFS},
     ToHex,
@@ -110,9 +109,9 @@ pub async fn get_preview_ad(Extension(state): Extension<Arc<State>>) -> Html<Str
 
     debug!("Mocked response: {demand_resp:?}");
 
-    let supermarket_ad_unit = adex_primitives::supermarket::units_for_slot::response::AdUnit {
+    let supermarket_ad_unit = adex_primitives::sentry::units_for_slot::response::AdUnit {
         /// Same as `ipfs`
-        id: DUMMY_IPFS[1],
+        ipfs: DUMMY_IPFS[1],
         media_url: "ipfs://QmcUVX7fvoLMM93uN2bD3wGTH8MXSxeL8hojYfL2Lhp7mR".to_string(),
         media_mime: "image/jpeg".to_string(),
         target_url: "https://www.adex.network/?stremio-test-banner-1".to_string(),
@@ -163,9 +162,9 @@ pub async fn get_preview_video(Extension(state): Extension<Arc<State>>) -> Html<
     };
 
     // legacy_728x90
-    let video_ad_unit = adex_primitives::supermarket::units_for_slot::response::AdUnit {
+    let video_ad_unit = adex_primitives::sentry::units_for_slot::response::AdUnit {
         /// Same as `ipfs`
-        id: "QmShJ6tsJ7LHLiYGX4EAmPyCPWJuCnvm6AKjweQPnw9qfh"
+        ipfs: "QmShJ6tsJ7LHLiYGX4EAmPyCPWJuCnvm6AKjweQPnw9qfh"
             .parse()
             .expect("Valid IPFS"),
         media_url: "ipfs://Qmevmms1AZgYXS27A9ghSjHn4DSaHMfgYcD2SoGW14RYGy".to_string(),

adview-manager/src/helpers.rs

@@ -2,8 +2,9 @@ use std::ops::{Add, Mul};
 
 use adex_primitives::{
     campaign::Validators,
-    sentry::{Event, EventType, InsertEventsRequest, CLICK, IMPRESSION},
-    supermarket::units_for_slot::response::AdUnit,
+    sentry::{
+        units_for_slot::response::AdUnit, Event, EventType, InsertEventsRequest, CLICK, IMPRESSION,
+    },
     BigNum, CampaignId,
 };
 use num_integer::Integer;
@@ -68,7 +69,7 @@ pub(crate) fn is_video(ad_unit: &AdUnit) -> bool {
 
 /// Does not copy the JS impl, instead it generates the BigNum from the IPFS CID bytes
 pub(crate) fn randomized_sort_pos(ad_unit: &AdUnit, seed: BigNum) -> BigNum {
-    let bytes = ad_unit.id.0.to_bytes();
+    let bytes = ad_unit.ipfs.0.to_bytes();
 
     let unit_id = BigNum::from_bytes_be(&bytes);
 
@@ -138,13 +139,13 @@ pub fn get_unit_html_with_events(
         let event = match event_type {
             EventType::Impression => Event::Impression {
                 publisher: options.publisher_addr,
-                ad_unit: ad_unit.id,
+                ad_unit: ad_unit.ipfs,
                 ad_slot: options.market_slot,
                 referrer: Some("document.referrer".to_string()),
             },
             EventType::Click => Event::Click {
                 publisher: options.publisher_addr,
-                ad_unit: ad_unit.id,
+                ad_unit: ad_unit.ipfs,
                 ad_slot: options.market_slot,
                 referrer: Some("document.referrer".to_string()),
             },
@@ -204,7 +205,7 @@ mod test {
 
     fn get_ad_unit(media_mime: &str) -> AdUnit {
         AdUnit {
-            id: DUMMY_IPFS[0],
+            ipfs: DUMMY_IPFS[0],
             media_url: "".to_string(),
             media_mime: media_mime.to_string(),
             target_url: "".to_string(),
@@ -237,7 +238,7 @@ mod test {
         #[test]
         fn test_randomized_position() {
             let ad_unit = AdUnit {
-                id: DUMMY_IPFS[0],
+                ipfs: DUMMY_IPFS[0],
                 media_url: "ipfs://QmWWQSuPMS6aXCbZKpEjPHPUZN2NjB3YrhJTHsV4X3vb2t".to_string(),
                 media_mime: "image/jpeg".to_string(),
                 target_url: "https://google.com".to_string(),

adview-manager/src/manager.rs

@@ -1,8 +1,9 @@
 //! The AdView Manager
 use adex_primitives::{
-    sentry::IMPRESSION,
-    supermarket::units_for_slot,
-    supermarket::units_for_slot::response::{AdUnit, Campaign},
+    sentry::{
+        units_for_slot::response::{AdUnit, Campaign, Response},
+        IMPRESSION,
+    },
     targeting::{self, input},
     util::ApiUrl,
     Address, BigNum, CampaignId, ToHex, UnifiedNum, IPFS,
@@ -200,7 +201,7 @@ impl Manager {
             .units_with_price
             .iter()
             .find_map(|u| {
-                if u.unit.id == sticky_entry.unit_id {
+                if u.unit.ipfs == sticky_entry.unit_id {
                     Some(u.unit.clone())
                 } else {
                     None
@@ -239,9 +240,7 @@ impl Manager {
         }
     }
 
-    pub async fn get_market_demand_resp(
-        &self,
-    ) -> Result<units_for_slot::response::Response, Error> {
+    pub async fn get_market_demand_resp(&self) -> Result<Response, Error> {
         let pub_prefix = self.options.publisher_addr.to_hex();
 
         let deposit_asset = self
@@ -320,7 +319,7 @@ impl Manager {
                     .units_with_price
                     .iter()
                     .filter(|unit_with_price| {
-                        unit_input.ad_unit_id = Some(unit_with_price.unit.id);
+                        unit_input.ad_unit_id = Some(unit_with_price.unit.ipfs);
 
                         let mut output = targeting::Output {
                             show: true,
@@ -359,7 +358,7 @@ impl Manager {
 
             let new_entry = HistoryEntry {
                 time: Utc::now(),
-                unit_id: unit_with_price.unit.id,
+                unit_id: unit_with_price.unit.ipfs,
                 campaign_id: *campaign_id,
                 slot_id: self.options.market_slot,
             };

primitives/src/lib.rs

@@ -44,7 +44,6 @@ pub mod merkle_tree;
 pub mod platform;
 pub mod sentry;
 pub mod spender;
-pub mod supermarket;
 pub mod targeting;
 // It's not possible to enable this feature for doctest,
 // so we always must pass `--feature=test-util` or `--all-features` when running doctests:

primitives/src/platform.rs

@@ -1,16 +1,30 @@
-pub use ad_unit::{AdUnitResponse, AdUnitsResponse};
+use std::collections::HashSet;
 
-mod ad_unit {
-    use crate::AdUnit;
-    use serde::{Deserialize, Serialize};
+use serde::{Deserialize, Serialize};
+use url::Url;
 
-    #[derive(Serialize, Deserialize, Debug, Clone, PartialEq)]
-    #[serde(rename_all = "camelCase")]
-    pub struct AdUnitsResponse(pub Vec<AdUnit>);
+use crate::{AdSlot, AdUnit};
 
-    #[derive(Serialize, Deserialize, Debug, Clone, PartialEq)]
-    #[serde(rename_all = "camelCase")]
-    pub struct AdUnitResponse {
-        pub unit: AdUnit,
-    }
+#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
+pub struct Website {
+    #[serde(default)]
+    pub categories: HashSet<String>,
+    #[serde(default)]
+    pub accepted_referrers: Vec<Url>,
+}
+
+#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct AdSlotResponse {
+    pub slot: AdSlot,
+    /// The fetched Fallback [`AdUnit`] ( [`AdSlot.fallback_unit`] ) of the [`AdSlot`] if set.
+    ///
+    /// [`AdSlot.fallback_unit`]: AdSlot::fallback_unit
+    #[serde(default)]
+    pub fallback: Option<AdUnit>,
+    /// The [`AdSlot.website`] information if it's provided and information is available for it.
+    ///
+    /// [`AdSlot.website`]: AdSlot::website
+    #[serde(default, flatten)]
+    pub website: Option<Website>,
 }

primitives/src/sentry.rs

@@ -1150,6 +1150,72 @@ pub mod campaign_modify {
     }
 }
 
+pub mod units_for_slot {
+    use std::collections::HashSet;
+
+    use serde::{Deserialize, Serialize};
+
+    use crate::Address;
+
+    #[derive(Debug, Clone, Serialize, Deserialize)]
+    #[serde(rename_all = "camelCase")]
+    pub struct Query {
+        pub deposit_assets: HashSet<Address>,
+    }
+
+    pub mod response {
+        use serde::{Deserialize, Serialize};
+        use url::Url;
+
+        use crate::{targeting::Input, UnifiedNum, IPFS};
+
+        #[derive(Debug, Serialize, Deserialize, PartialEq)]
+        #[serde(rename_all = "camelCase")]
+        pub struct Response {
+            pub targeting_input_base: Input,
+            pub accepted_referrers: Vec<Url>,
+            pub fallback_unit: Option<AdUnit>,
+            pub campaigns: Vec<Campaign>,
+        }
+
+        #[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
+        #[serde(rename_all = "camelCase")]
+        pub struct UnitsWithPrice {
+            pub unit: AdUnit,
+            pub price: UnifiedNum,
+        }
+
+        #[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
+        #[serde(rename_all = "camelCase")]
+        pub struct Campaign {
+            #[serde(flatten)]
+            pub campaign: crate::Campaign,
+            /// units-for-slot Specific Campaign field
+            pub units_with_price: Vec<UnitsWithPrice>,
+        }
+
+        #[derive(Debug, Serialize, Deserialize, Clone, Eq, PartialEq)]
+        #[serde(rename_all = "camelCase")]
+        pub struct AdUnit {
+            pub ipfs: IPFS,
+            pub media_url: String,
+            pub media_mime: String,
+            pub target_url: String,
+        }
+
+        impl From<&crate::AdUnit> for AdUnit {
+            fn from(ad_unit: &crate::AdUnit) -> Self {
+                Self {
+                    ipfs: ad_unit.ipfs,
+                    media_url: ad_unit.media_url.clone(),
+                    media_mime: ad_unit.media_mime.clone(),
+                    target_url: ad_unit.target_url.clone(),
+                }
+            }
+        }
+    }
+}
+
 #[cfg(feature = "postgres")]
 mod postgres {
     use bytes::BytesMut;