Skip to content

AIP#61 AdEx V5: Targeting rules use UnifiedNum #412

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Jun 25, 2021
Merged

AIP#61 AdEx V5: Targeting rules use UnifiedNum #412

Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
4833db8
primitives - campaign:
elpiel Jun 16, 2021
906639d
primitives - lib - re-export UnifiedNum
elpiel Jun 16, 2021
a41ff23
primitives - UnifiedNum - (de)serialize as string
elpiel Jun 18, 2021
9c723a1
primitives - Cargo - update `parse-display` to `0.5`
elpiel Jun 18, 2021
8635a99
primitives - sentry - use campaign::prefix_active
elpiel Jun 18, 2021
4b72b2b
primitives - supermarket - simplify Campaign & use UnifiedNum
elpiel Jun 18, 2021
d7863c9
primitives - targeting - use UnifiedNum & update for AIP#61 (v5)
elpiel Jun 18, 2021
dde043a
sentry - payout - update result to use UnifiedNum
elpiel Jun 18, 2021
87e2558
adview-manager - use Campaign & UnifiedNum
elpiel Jun 18, 2021
ae4a94d
fix clippy & primitives - IPFS is now Copy
elpiel Jun 18, 2021
3c22b5d
primitives - Cargo - update `serde_with`
elpiel Jun 23, 2021
ff642c7
small fixes
elpiel Jun 23, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 36 additions & 13 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

64 changes: 32 additions & 32 deletions adview-manager/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,11 @@
#![deny(clippy::all)]

use adex_primitives::{
campaign::Validators,
supermarket::units_for_slot,
supermarket::units_for_slot::response::{AdUnit, Campaign},
targeting::{self, input},
BigNum, ChannelId, SpecValidators, ValidatorId, IPFS,
Address, BigNum, CampaignId, ToHex, UnifiedNum, IPFS,
};
use async_std::{sync::RwLock, task::block_on};
use chrono::{DateTime, Utc};
Expand All @@ -23,7 +24,6 @@ use std::{
sync::Arc,
};
use thiserror::Error;
use units_for_slot::response::UnitsWithPrice;
use url::Url;

const IPFS_GATEWAY: &str = "https://ipfs.moonicorn.network/ipfs/";
Expand All @@ -48,7 +48,7 @@ pub struct Options {
#[serde(rename = "marketURL")]
pub market_url: Url,
pub market_slot: IPFS,
pub publisher_addr: ValidatorId,
pub publisher_addr: Address,
// All passed tokens must be of the same price and decimals, so that the amounts can be accurately compared
pub whitelisted_tokens: Vec<String>,
pub width: Option<u64>,
Expand All @@ -70,7 +70,7 @@ impl Options {
pub struct HistoryEntry {
time: DateTime<Utc>,
unit_id: IPFS,
campaign_id: ChannelId,
campaign_id: CampaignId,
slot_id: IPFS,
}

Expand All @@ -79,7 +79,7 @@ pub struct HistoryEntry {
struct Event {
#[serde(rename = "type")]
event_type: String,
publisher: ValidatorId,
publisher: Address,
ad_unit: IPFS,
ad_slot: IPFS,
#[serde(rename = "ref")]
Expand Down Expand Up @@ -209,16 +209,16 @@ pub fn get_unit_html_with_events(
options: &Options,
ad_unit: &AdUnit,
hostname: &str,
channel_id: ChannelId,
validators: &SpecValidators,
campaign_id: CampaignId,
validators: &Validators,
no_impression: impl Into<bool>,
) -> String {
let get_body = |event_type: &str| EventBody {
events: vec![Event {
event_type: event_type.to_string(),
publisher: options.publisher_addr,
ad_unit: ad_unit.id.clone(),
ad_slot: options.market_slot.clone(),
ad_unit: ad_unit.id,
ad_slot: options.market_slot,
referrer: "document.referrer".to_string(),
}],
};
Expand All @@ -234,7 +234,7 @@ pub fn get_unit_html_with_events(
.map(|validator| {
let fetch_url = format!(
"{}/channel/{}/events?pubAddr={}",
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will be fixed when the events route for a Campaign is updated, see tasks for #382

validator.url, channel_id, options.publisher_addr
validator.url, campaign_id, options.publisher_addr
);

format!("fetch('{}', fetchOpts)", fetch_url)
Expand Down Expand Up @@ -304,7 +304,7 @@ impl Manager {
pub async fn get_targeting_input(
&self,
mut input: input::Input,
channel_id: ChannelId,
campaign_id: CampaignId,
) -> input::Input {
let seconds_since_campaign_impression = self
.history
Expand All @@ -313,7 +313,7 @@ impl Manager {
.iter()
.rev()
.find_map(|h| {
if h.campaign_id == channel_id {
if h.campaign_id == campaign_id {
let last_impression: chrono::Duration = Utc::now() - h.time;

u64::try_from(last_impression.num_seconds()).ok()
Expand Down Expand Up @@ -352,7 +352,7 @@ impl Manager {

let stick_campaign = campaigns
.iter()
.find(|c| c.channel.id == sticky_entry.campaign_id)?;
.find(|c| c.campaign.id == sticky_entry.campaign_id)?;

let unit = stick_campaign
.units_with_price
Expand All @@ -370,8 +370,8 @@ impl Manager {
&self.options,
&unit,
hostname,
stick_campaign.channel.id,
&stick_campaign.channel.spec.validators,
stick_campaign.campaign.id,
&stick_campaign.campaign.validators,
true,
);

Expand All @@ -383,7 +383,7 @@ impl Manager {
})
}

async fn is_campaign_sticky(&self, campaign_id: ChannelId) -> bool {
async fn is_campaign_sticky(&self, campaign_id: CampaignId) -> bool {
if self.options.disabled_sticky {
false
} else {
Expand All @@ -400,7 +400,7 @@ impl Manager {
pub async fn get_market_demand_resp(
&self,
) -> Result<units_for_slot::response::Response, Error> {
let pub_prefix: String = self.options.publisher_addr.to_hex_non_prefix_string();
let pub_prefix = self.options.publisher_addr.to_hex();

let deposit_asset = self
.options
Expand Down Expand Up @@ -461,36 +461,36 @@ impl Manager {
let seed = BigNum::from(random as u64);

// Apply targeting, now with adView.* variables, and sort the resulting ad units
let mut units_with_price: Vec<(UnitsWithPrice, ChannelId)> = campaigns
let mut units_with_price = campaigns
.iter()
.map(|campaign| {
// since we are in a Iterator.map(), we can't use async, so we block
if block_on(self.is_campaign_sticky(campaign.channel.id)) {
if block_on(self.is_campaign_sticky(campaign.campaign.id)) {
return vec![];
}

let campaign_id = campaign.channel.id;
let campaign_id = campaign.campaign.id;

let mut unit_input = targeting_input.clone().with_market_channel(campaign.channel.clone());
let mut unit_input = targeting_input.clone().with_campaign(campaign.campaign.clone());

campaign
.units_with_price
.iter()
.filter(|unit_with_price| {
unit_input.ad_unit_id = Some(unit_with_price.unit.id.clone());
unit_input.ad_unit_id = Some(unit_with_price.unit.id);

let mut output = targeting::Output {
show: true,
boost: 1.0,
price: vec![("IMPRESSION".to_string(), unit_with_price.price.clone())]
price: vec![("IMPRESSION".to_string(), unit_with_price.price)]
.into_iter()
.collect(),
};

let on_type_error = |error, rule| error!(&self.logger, "Rule evaluation error for {:?}", campaign_id; "error" => ?error, "rule" => ?rule);

targeting::eval_with_callback(
&campaign.targeting_rules,
&campaign.campaign.targeting_rules,
&unit_input,
&mut output,
Some(on_type_error)
Expand All @@ -503,7 +503,7 @@ impl Manager {
})
.flatten()
.filter(|x| !(self.options.disabled_video && is_video(&x.0.unit)))
.collect();
.collect::<Vec<_>>();

units_with_price.sort_by(|b, a| match (&a.0.price).cmp(&b.0.price) {
Ordering::Equal => randomized_sort_pos(&a.0.unit, seed.clone())
Expand All @@ -519,9 +519,9 @@ impl Manager {

let new_entry = HistoryEntry {
time: Utc::now(),
unit_id: unit_with_price.unit.id.clone(),
unit_id: unit_with_price.unit.id,
campaign_id: *campaign_id,
slot_id: self.options.market_slot.clone(),
slot_id: self.options.market_slot,
};

*self.history.write().await = history
Expand All @@ -542,8 +542,8 @@ impl Manager {
let validators = campaigns
.iter()
.find_map(|campaign| {
if &campaign.channel.id == campaign_id {
Some(&campaign.channel.spec.validators)
if &campaign.campaign.id == campaign_id {
Some(&campaign.campaign.validators)
} else {
None
}
Expand All @@ -562,7 +562,7 @@ impl Manager {

Ok(Some(NextAdUnit {
unit: unit_with_price.unit.clone(),
price: unit_with_price.price.clone(),
price: unit_with_price.price,
accepted_referrers: units_for_slot.accepted_referrers,
html,
}))
Expand All @@ -582,14 +582,14 @@ impl Manager {

pub struct NextAdUnit {
pub unit: AdUnit,
pub price: BigNum,
pub price: UnifiedNum,
pub accepted_referrers: Vec<Url>,
pub html: String,
}

pub struct StickyAdUnit {
pub unit: AdUnit,
pub price: BigNum,
pub price: UnifiedNum,
pub html: String,
pub is_sticky: bool,
}
Expand Down
2 changes: 1 addition & 1 deletion primitives/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ ethabi = "13.0.0"
# For the nonce U256
ethereum-types = "0.11"
# Macro for easier derive of Display & FromStr
parse-display = "^0.4.1"
parse-display = "^0.5.0"
# CID & multihash / multibase
cid = "0.6"
hex = "0.4"
Expand Down
4 changes: 2 additions & 2 deletions primitives/src/balances_map.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,8 +109,8 @@ mod test {

let actual_json = serde_json::to_value(&unified_map).expect("Should serialize it");
let expected_json = json!({
"0xC91763D7F14ac5c5dDfBCD012e0D2A61ab9bDED3":100,
"0xce07CbB7e054514D590a0262C93070D838bFBA2e":50
"0xC91763D7F14ac5c5dDfBCD012e0D2A61ab9bDED3":"100",
"0xce07CbB7e054514D590a0262C93070D838bFBA2e":"50"
});

assert_eq!(expected_json, actual_json);
Expand Down
Loading