Merge pull request #35 from basiclines/develop

New display impression strategy

Author: basiclines

src/App.js

@@ -24,7 +24,7 @@ class ui extends Element {
 			}
 
 			if (msg.type == 'init') {
-				this.insertDisplay(msg.AD_LAST_SHOWN_DATE)
+				this.insertDisplay(msg.AD_LAST_SHOWN_DATE, msg.AD_LAST_SHOWN_IMPRESSION)
 			}
 		})
 
@@ -38,9 +38,10 @@ class ui extends Element {
 		Router.on('change:url', url => this.showActiveView(url))
 	}
 
-	insertDisplay(lastShownDate) {
+	insertDisplay(lastShownDate, lastShownImpression) {
 		let elem = document.createElement('c-display')
 		elem.setAttribute('lastshowndate', lastShownDate)
+		elem.setAttribute('lastshownimpression', lastShownImpression)
 		elem.setAttribute('hidden', '')				
 		document.body.insertBefore(elem, document.body.querySelector('root-ui'))
 	}

src/Core.js

@@ -149,12 +149,14 @@ Promise.all([
 	figma.clientStorage.getAsync('UUID'),
 	figma.clientStorage.getAsync('preferences'),
 	figma.clientStorage.getAsync('AD_LAST_SHOWN_DATE'),
+	figma.clientStorage.getAsync('AD_LAST_SHOWN_IMPRESSION'),
 	figma.clientStorage.getAsync('spacing') // legacy
 ]).then(values => {
 	let UUID = values[0]
 	let preferences = values[1]
 	let AD_LAST_SHOWN_DATE = values[2] || 572083200 // initial date, if no date was saved previously
-	let spacing = values[3]
+	let AD_LAST_SHOWN_IMPRESSION = values[3] || 0 // initial impressions
+	let spacing = values[4]
 
 	let SPACING = { x: 100, y: 200 }
 	let START_NAME = '000'
@@ -224,7 +226,8 @@ Promise.all([
 			UUID: UUID,
 			cmd: cmd,
 			preferences: preferences,
-			AD_LAST_SHOWN_DATE: AD_LAST_SHOWN_DATE
+			AD_LAST_SHOWN_DATE: AD_LAST_SHOWN_DATE,
+			AD_LAST_SHOWN_IMPRESSION: AD_LAST_SHOWN_IMPRESSION
 		})
 		figma.ui.postMessage({ type: 'selection', selection: figma.currentPage.selection })
 
@@ -252,6 +255,11 @@ Promise.all([
 			if (msg.type === 'displayImpression') {
 				figma.ui.resize(320, 540+124)
 				figma.clientStorage.setAsync('AD_LAST_SHOWN_DATE', Date.now())
+				figma.clientStorage.setAsync('AD_LAST_SHOWN_IMPRESSION', parseInt(AD_LAST_SHOWN_IMPRESSION)+1)
+			}
+			
+			if (msg.type === 'resetImpression') {
+				figma.clientStorage.setAsync('AD_LAST_SHOWN_IMPRESSION', 0)
 			}
 		}
 	}

src/ui/components/display/DisplayComponent.js

@@ -11,11 +11,11 @@ class DisplayComponent extends Element {
 		// avoid display without proper data
 		if (this.attrs.lastshowndate == 'undefined') return
 
-		DisplayNetwork.getAvailableAd(this.attrs.lastshowndate)
+		DisplayNetwork.getAvailableAd(this.attrs.lastshowndate, this.attrs.lastshownimpression)
 		.then(ad => {
 			// if we have an available ad, then render and display it
 			if (!!ad) {
-				ad.link = ad.link + '?utm_source=figma&utm_medium=partner&utm_campaign='+PLUGIN_NAME
+				ad.link = ad.link + '&utm_campaign='+PLUGIN_NAME
 				this.data.ad = ad
 				this.showDisplay()
 			}

src/utils/DisplayNetwork.js

@@ -17,13 +17,13 @@ class DisplayNetwork {
 		return fetch(this.root, { method: 'GET' })
 	}
 
-	getAvailableAd(lastShownDate) {
+	getAvailableAd(lastShownDate, lastShownImpression) {
 		return new Promise((resolve, reject) => {
 			this.getAds().then(response => {
 				response.json().then(ads => {
 
 					let availableAds = ads.reduce((prev, current) => {
-						if (this.checkImpressionAvailability(parseInt(lastShownDate), current)) {
+						if (this.checkImpressionAvailability(parseInt(lastShownDate), parseInt(lastShownImpression), current)) {
 							prev.push(current)
 						}
 						return prev
@@ -42,28 +42,36 @@ class DisplayNetwork {
 	}
 
 	getAdInterval(ad) {
-		if (WP_ENV == 'development') return 1000
+		if (WP_ENV == 'development') return 10000
 
-		let interval = 0
-		switch (ad.impression_interval) {
-				case 'daily': interval = DAILY_INTERVAL
-				break;
-				case 'weekly': interval = WEEKLY_INTERVAL
-				break;
-				case 'monthly': interval = MONTHLY_INTERVAL
-				break;
-		}
-		
-		return interval
+		return parseInt(ad.impression_net_interval)
 	}
 
-	checkImpressionAvailability(lastShownDate, ad) {
+	checkImpressionAvailability(lastShownDate, lastShownImpression, ad) {
+		
 		let adInterval = this.getAdInterval(ad)
 		let availableTimeWindow = (!lastShownDate || lastShownDate + adInterval < this.timeStampNow)
 
-		return availableTimeWindow
-	}
+		// Check if the ad is optimised for impression rather than time
+		if (ad.impression_count) {
+			let availableImpression = (lastShownImpression < parseInt(ad.impression_count))
+			
+			if (availableTimeWindow && availableImpression || !availableTimeWindow && availableImpression) {
+				// meanwhile there is impressions left, spend the impression
+				return true
+			} else
+			if (availableTimeWindow && !availableImpression) {
+				// when impressions limit is reached and time window is valid, reset the impression
+				parent.postMessage({ pluginMessage: { type: 'resetImpression' } }, '*')
+				return false
+			} else {
+				return false
+			}
+		} else {
+			return availableTimeWindow
+		}
 
+	}
 }
 
 export default new DisplayNetwork()