AIP #6 impl

routes/schemas.js

@@ -114,12 +114,23 @@ module.exports = {
 				.keys()
 				.pattern(
 					/^(IMPRESSION|CLICK)$/,
-					Joi.object({ min: numericString.default('0'), max: numericString.default('0') })
+					Joi.object({ min: numericString.required(), max: numericString.required() })
 				),
 			eventSubmission: Joi.object({ allow: Joi.array().items(Joi.object()) }),
 			nonce: Joi.string(),
 			created: Joi.number(),
-			activeFrom: Joi.number()
+			activeFrom: Joi.number(),
+			priceMultiplicationRules: Joi.array().items(
+				Joi.object({
+					multiplier: Joi.number().precision(10), // max 10 decimal places
+					amount: numericString,
+					evType: Joi.array().items(Joi.string().lowercase()),
+					country: Joi.array().items(Joi.string().lowercase()),
+					publisher: Joi.array().items(Joi.string()),
+					osType: Joi.array().items(Joi.string().lowercase())
+				})
+			),
+			priceDynamicAdjustment: Joi.bool()
 		}).required()
 	},
 	validatorMessage: {

services/sentry/eventAggregator.js

@@ -73,7 +73,7 @@ function makeRecorder(channelId) {
 		// this will be saved in the channel object, which is passed into the eventReducer
 
 		// Record the events
-		aggr = events.reduce(eventReducer.reduce.bind(null, channel), aggr)
+		aggr = events.reduce(eventReducer.reduce.bind(null, channel, session), aggr)
 		if (cfg.AGGR_THROTTLE) {
 			throttledPersistAndReset()
 			return { success: true }

services/sentry/lib/eventReducer.js

@@ -6,9 +6,9 @@ function newAggr(channelId) {
 	return { channelId, created: new Date(), events: {}, totals: {}, earners: [] }
 }
 
-function reduce(channel, initialAggr, ev) {
+function reduce(channel, session, initialAggr, event) {
 	let aggr = { ...initialAggr }
-
+	const ev = { ...event, ...session } // add session details (i.e country, device type etc) to event
 	const payout = getPayout(channel, ev)
 	if (payout) {
 		aggr.events[ev.type] = mergeEv(initialAggr.events[ev.type], payout)

services/sentry/lib/getPayout.js

@@ -1,18 +1,84 @@
+/* eslint-disable no-nested-ternary */
+// const BN = require('bignumber.js') // allows
 const BN = require('bn.js')
 const toBalancesKey = require('../toBalancesKey')
 
-function getPayout(channel, ev) {
+function getPayout(channel, ev, session) {
 	if (ev.type === 'IMPRESSION' && ev.publisher) {
 		// add the minimum price for the event to the current amount
-		return [toBalancesKey(ev.publisher), new BN(channel.spec.minPerImpression || 1)]
+		const [minPrice, maxPrice] = getPriceBounds(channel.spec, ev.type)
+		const price = channel.spec.priceMultiplicationRules
+			? payout(channel.spec.priceMultiplicationRules, ev, session, maxPrice, minPrice)
+			: minPrice
+		return [toBalancesKey(ev.publisher), new BN(price.toString())]
 	}
 	if (ev.type === 'CLICK' && ev.publisher) {
-		return [
-			toBalancesKey(ev.publisher),
-			new BN((channel.spec.pricingBounds && channel.spec.pricingBounds.CLICK.min) || 0)
-		]
+		const [minPrice, maxPrice] = getPriceBounds(channel.spec, ev.type)
+		const price = channel.spec.priceMultiplicationRules
+			? payout(channel.spec.priceMultiplicationRules, ev, session, maxPrice, minPrice)
+			: minPrice
+		return [toBalancesKey(ev.publisher), new BN(price.toString())]
 	}
 	return null
 }
 
+function payout(rules, ev, session, maxPrice, startPrice) {
+	const match = isRuleMatching.bind(null, ev, session)
+	const matchingRules = rules.filter(match)
+	let finalPrice = startPrice
+
+	if (matchingRules.length > 0) {
+		const divisionExponent = new BN(10).pow(new BN(18, 10))
+		const firstFixed = matchingRules.find(x => x.amount)
+		const priceByRules = firstFixed
+			? new BN(firstFixed.amount)
+			: startPrice
+					.mul(
+						new BN(
+							(
+								matchingRules
+									.filter(x => x.multiplier)
+									.map(x => x.multiplier)
+									.reduce((a, b) => a * b, 1) * 1e18
+							).toString()
+						)
+					)
+					.div(divisionExponent)
+		finalPrice = BN.min(maxPrice, priceByRules)
+	}
+
+	return finalPrice
+}
+
+function isRuleMatching(ev, session, rule) {
+	return rule.eventType
+		? rule.eventType.includes(ev.type.toLowerCase())
+		: true && rule.publisher
+		? rule.publisher.includes(ev.publisher)
+		: true && rule.osType
+		? rule.osType.includes(session.os && session.os.toLowerCase())
+		: true && rule.country
+		? rule.country.includes(session.country && session.country.toLowerCase())
+		: true
+}
+
+function getPriceBounds(spec, evType) {
+	const { pricingBounds, minPerImpression, maxPerImpression } = spec
+	if (evType === 'IMPRESSION') {
+		return (
+			(pricingBounds &&
+				pricingBounds[evType] && [
+					new BN(pricingBounds[evType].min),
+					new BN(pricingBounds[evType].max)
+				]) || [new BN(minPerImpression || 1), new BN(maxPerImpression || 1)]
+		)
+	}
+	return (
+		(pricingBounds &&
+			pricingBounds[evType] && [
+				new BN(pricingBounds[evType].min),
+				new BN(pricingBounds[evType].max)
+			]) || [new BN(0), new BN(0)]
+	)
+}
 module.exports = getPayout