[DA] Implement auto refresh limit (#128)

Author: alcocerd

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "adjs",
-  "version": "2.0.0-beta.31",
+  "version": "2.0.0-beta.32",
   "description": "Ad Library to simplify and optimize integration with ad networks such as DFP",
   "main": "./core.js",
   "types": "./types.d.ts",

package.json

@@ -11,6 +11,8 @@ class AutoRefresh extends GenericPlugin {
 
   // SetInterval Reference
   private timerReference?: number;
+  // Number of times the ad refreshed.
+  private refreshCount: number = 0;
 
   public afterRender() {
     dispatchEvent(this.ad.id, LOG_LEVELS.INFO, 'AutoRefresh Plugin', 'Adding monitoring for ad.');
@@ -47,7 +49,7 @@ class AutoRefresh extends GenericPlugin {
       return;
     }
 
-    const { refreshRateInSeconds = 30 } = this.ad.configuration;
+    const { refreshRateInSeconds = 30, refreshLimit = null } = this.ad.configuration;
     dispatchEvent(
       this.ad.id,
       LOG_LEVELS.INFO,
@@ -59,8 +61,15 @@ class AutoRefresh extends GenericPlugin {
       this.timeInView += 1;
 
       // Determine whether the ad should refresh
-      if (!this.isRefreshing && this.timeInView >= refreshRateInSeconds) {
+      const underRefreshLimit = (refreshLimit === null || this.refreshCount < refreshLimit);
+      if (!this.isRefreshing && this.timeInView >= refreshRateInSeconds && underRefreshLimit) {
         this.isRefreshing = true;
+        this.refreshCount += 1;
+
+        // Once we hit the limit, clear the interval.
+        if (this.refreshCount === refreshLimit) {
+          clearInterval(this.timerReference);
+        }
 
         dispatchEvent(
           this.ad.id,

src/plugins/AutoRefresh.ts

@@ -177,6 +177,7 @@ export interface IAdConfiguration {
   plugins?: IPluginConstructorOrSingleton[];
   refreshOnBreakpoint?: boolean;
   refreshRateInSeconds?: number;
+  refreshLimit?: number;
   sizes?: AdSizes;
   targeting?: IAdTargeting;
 }