[DEST-1703] Nielsen DTVR Feature Updates/Bump to v1.0.0 (#420)

* [Nielsen DTVR] Only send events to DTVR when load_type is linear.

* [Nielsen DTVR] Bump Nielsen to version 1.0.0 and add release history.

* [Nielsen DTVR] Correct HISTORY.md.

* [Nielsen DTVR] Add parameter for recoverable interrupts.

* [Nielsen DTVR] Add beta flag.

* Remove beta  flag for RT

Co-authored-by: Brie McNally <31782219+briemcnally@users.noreply.github.com>
Co-authored-by: Brie <brienne.mcnally@segment.com>

Author: 3 people

integrations/nielsen-dtvr/HISTORY.md

@@ -0,0 +1,24 @@
+1.0.0 / 2020-05-18
+==================
+
+  * Events are mapped to Nielsen DTVR only when `load_type` property is 'linear'.
+
+0.0.4 / 2020-01-07
+==================
+
+  * Sends unix timestamp in seconds (rather than milliseconds) when livestreams end.
+
+0.0.3 / 2019-09-03
+==================
+
+  * Supports loading Nielsen tag via `https`.
+
+0.0.2 / 2019-07-15
+==================
+
+  * Fixes casing issue preventing customers from choosing a custom key name for mapping `ID3` tag properties.
+
+0.0.1 / 2019-07-11
+==================
+
+  * Initial scaffold :sparkles:

integrations/nielsen-dtvr/lib/index.js

@@ -41,6 +41,7 @@ NielsenDTVR.prototype.initialize = function() {
   var config = {};
   this.ID3 = null;
   this.previousEvent = null;
+  this.isDTVRStream = false;
 
   // Modified Nielsen snippet. It shouldn't load the Nielsen tag, but it should
   // still successfully queue events fired before the tag loads.
@@ -136,107 +137,52 @@ NielsenDTVR.prototype.videoContentStarted = function(track) {
 
 /**
  * Video Content Completed
+ * Video Playback Completed
  *
  * @api public
  */
 
-NielsenDTVR.prototype.videoContentCompleted = function(track) {
+NielsenDTVR.prototype.videoContentCompleted = NielsenDTVR.prototype.videoPlaybackCompleted = function(
+  track
+) {
+  if (!this.isDTVRStream) return;
   this.end(track);
 };
 
 /**
  * Video Playback Interrupted
- *
- * @api public
- */
-
-NielsenDTVR.prototype.videoPlaybackInterrupted = function(track) {
-  this.sendID3(track);
-  this.end(track);
-};
-
-/**
  * Video Playback Seek Started
- *
- * @api public
- */
-
-NielsenDTVR.prototype.videoPlaybackSeekStarted = function(track) {
-  this.sendID3(track);
-  this.end(track);
-};
-
-/**
- * Video Playback Seek Completed
- *
- * @api public
- */
-
-NielsenDTVR.prototype.videoPlaybackSeekCompleted = function(track) {
-  var metadata = this.mapMetadata(track);
-  if (!metadata) return;
-  this.client.ggPM('loadMetadata', metadata);
-  this.sendID3(track);
-};
-
-/**
  * Video Playback Buffer Started
- *
- * @api public
- */
-
-NielsenDTVR.prototype.videoPlaybackBufferStarted = function(track) {
-  this.sendID3(track);
-  this.end(track);
-};
-
-/**
- * Video Playback Buffer Completed
- *
- * @api public
- */
-
-NielsenDTVR.prototype.videoPlaybackBufferCompleted = function(track) {
-  var metadata = this.mapMetadata(track);
-  if (!metadata) return;
-  this.client.ggPM('loadMetadata', metadata);
-  this.sendID3(track);
-};
-
-/**
  * Video Playback Paused
  *
  * @api public
  */
 
-NielsenDTVR.prototype.videoPlaybackPaused = function(track) {
+NielsenDTVR.prototype.videoPlaybackInterrupted = NielsenDTVR.prototype.videoPlaybackSeekStarted = NielsenDTVR.prototype.videoPlaybackBufferStarted = NielsenDTVR.prototype.videoPlaybackPaused = function(
+  track
+) {
+  if (!this.isDTVRStream) return;
   this.sendID3(track);
-  this.end(track);
+  this.end(track, 'recoverable');
 };
 
 /**
+ * Video Playback Seek Completed
+ * Video Playback Buffer Completed
  * Video Playback Resumed
  *
  * @api public
  */
 
-NielsenDTVR.prototype.videoPlaybackResumed = function(track) {
+NielsenDTVR.prototype.videoPlaybackSeekCompleted = NielsenDTVR.prototype.videoPlaybackBufferCompleted = NielsenDTVR.prototype.videoPlaybackResumed = function(
+  track
+) {
   var metadata = this.mapMetadata(track);
-  if (!metadata) return;
+  if (!metadata || !this.isDTVRStream) return;
   this.client.ggPM('loadMetadata', metadata);
   this.sendID3(track);
 };
 
-/**
- * Video Playback Completed
- *
- * @api public
- */
-
-NielsenDTVR.prototype.videoPlaybackCompleted = function(track) {
-  this.end(track);
-};
-
 /**
  * Send ID3 tags to Nielsen
  *
@@ -277,7 +223,7 @@ NielsenDTVR.prototype.sendID3 = function(event) {
  * @api private
  */
 
-NielsenDTVR.prototype.end = function(event) {
+NielsenDTVR.prototype.end = function(event, interruptType) {
   var livestream = event.proxy('properties.livestream');
   var position = event.proxy('properties.position');
   var time;
@@ -291,8 +237,11 @@ NielsenDTVR.prototype.end = function(event) {
     this.client.ggPM('end', time);
   }
 
-  this.ID3 = null;
-  this.previousEvent = null;
+  if (interruptType !== 'recoverable') {
+    this.ID3 = null;
+    this.previousEvent = null;
+    this.isDTVRStream = null;
+  }
 };
 
 /**
@@ -325,19 +274,25 @@ function validate(metadata) {
  */
 
 NielsenDTVR.prototype.mapMetadata = function(event) {
-  var adModel;
   var loadType =
-    event.proxy('properties.loadType') || event.proxy('properties.load_type');
-
-  if (loadType === 'linear') {
-    adModel = '1';
-  } else if (loadType === 'dynamic') {
-    adModel = '2';
+    event.proxy('properties.loadType') ||
+    event.proxy('properties.load_type') ||
+    event.proxy('properties.content.loadType') ||
+    event.proxy('properties.content.load_type');
+
+  // only video streams of load_type "linear" should be mapped to Nielsen DTVR
+  // we need to persist the fact that a stream is/isn't a DTVR stream for events
+  // that may not contain a `load_type` k:v pair, such as "Video Playback" events
+  if (loadType !== 'linear') {
+    this.isDTVRStream = false;
+    return false;
   }
 
+  this.isDTVRStream = true;
+
   return validate({
     type: 'content',
     channelName: event.proxy('properties.channel'),
-    adModel: adModel
+    adModel: '1'
   });
 };

integrations/nielsen-dtvr/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@segment/analytics.js-integration-nielsen-dtvr",
   "description": "The Nielsen DTVR analytics.js integration.",
-  "version": "0.0.4",
+  "version": "1.0.0",
   "keywords": [
     "analytics.js",
     "analytics.js-integration",

integrations/nielsen-dtvr/test/index.test.js

@@ -90,6 +90,7 @@ describe('NielsenDTVR', function() {
     beforeEach(function(done) {
       analytics.once('ready', done);
       analytics.initialize();
+      analytics.track('Video Content Started', { load_type: 'linear' });
     });
 
     describe('options', function() {
@@ -224,7 +225,7 @@ describe('NielsenDTVR', function() {
             asset_id: '123',
             ad_asset_id: null,
             channel: 'segment',
-            load_type: 'dynamic',
+            load_type: 'linear',
             position: 1,
             id3: '1',
             livestream: false
@@ -241,17 +242,28 @@ describe('NielsenDTVR', function() {
           analytics.called(nielsenDTVR.client.ggPM, 'loadMetadata', {
             type: 'content',
             channelName: 'segment',
-            adModel: '2'
+            adModel: '1'
           });
           analytics.called(nielsenDTVR.client.ggPM, 'sendID3', props.id3);
         });
 
+        it('should NOT send video content started if `load_type` is `dynamic`', function() {
+          props.load_type = 'dynamic';
+          analytics.track('Video Content Started', props);
+          analytics.didNotCall(nielsenDTVR.client.ggPM, 'loadMetadata', {
+            type: 'content',
+            channelName: 'segment',
+            adModel: '1'
+          });
+          analytics.didNotCall(nielsenDTVR.client.ggPM, 'sendID3', props.id3);
+        });
+
         it('should call end before starting a new content stream if the previous stream was not ended correctly', function() {
           var previousEvent = {
             asset_id: '123',
             ad_asset_id: null,
             channel: 'segment',
-            load_type: 'dynamic',
+            load_type: 'linear',
             position: 1,
             id3: '1',
             livestream: true