Round percent progress in ad events

snowplow · May 15, 2023 · b74c7b3 · b74c7b3
1 parent 79df441
commit b74c7b3
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 12 deletions.
diff --git a/plugins/browser-plugin-media/src/api.ts b/plugins/browser-plugin-media/src/api.ts
@@ -393,7 +393,8 @@ export function trackMediaAdSkip(
     CommonMediaEventProperties,
   trackers: Array<string> = Object.keys(_trackers)
 ) {
-  const { percentProgress } = args;
+  let { percentProgress } = args;
+  if (percentProgress !== undefined) { percentProgress = Math.floor(percentProgress); }
   track(
     {
       mediaEvent: {
@@ -502,7 +503,8 @@ export function trackMediaAdClick(
     CommonMediaEventProperties,
   trackers: Array<string> = Object.keys(_trackers)
 ) {
-  const { percentProgress } = args;
+  let { percentProgress } = args;
+  if (percentProgress !== undefined) { percentProgress = Math.floor(percentProgress); }
   track(
     {
       mediaEvent: {
@@ -529,7 +531,8 @@ export function trackMediaAdPause(
     CommonMediaEventProperties,
   trackers: Array<string> = Object.keys(_trackers)
 ) {
-  const { percentProgress } = args;
+  let { percentProgress } = args;
+  if (percentProgress !== undefined) { percentProgress = Math.floor(percentProgress); }
   track(
     {
       mediaEvent: {
@@ -557,7 +560,8 @@ export function trackMediaAdResume(
     CommonMediaEventProperties,
   trackers: Array<string> = Object.keys(_trackers)
 ) {
-  const { percentProgress } = args;
+  let { percentProgress } = args;
+  if (percentProgress !== undefined) { percentProgress = Math.floor(percentProgress); }
   track(
     {
       mediaEvent: {

diff --git a/plugins/browser-plugin-media/src/types.ts b/plugins/browser-plugin-media/src/types.ts
@@ -78,7 +78,10 @@ export type MediaTrackingConfiguration = {
   /** Attributes for the media player context entity */
   player?: MediaPlayerUpdate;
   /** Attributes for the media player session context entity or false to disable it. Enabled by default. */
-  session?: { startedAt?: Date } | false;
+  session?: {
+    /** Local date-time timestamp of when the session started. Automatically set to current time if not given. */
+    startedAt?: Date
+  } | false;
   /** Configuration for sending ping events. Enabled by default.  */
   pings?:
     | {
@@ -115,12 +118,12 @@ export type MediaTrackVolumeChangeArguments = {
 };
 
 export type MediaTrackFullscreenChangeArguments = {
-  /** Whether the video element is fullscreen. */
+  /** Whether the video element is fullscreen after the change. */
   fullscreen: boolean;
 };
 
 export type MediaTrackPictureInPictureChangeArguments = {
-  /** Whether the video element is showing picture-in-picture. */
+  /** Whether the video element is showing picture-in-picture after the change. */
   pictureInPicture: boolean;
 };
 
@@ -257,7 +260,7 @@ export interface MediaPlayerUpdate {
 
 /** Partial type/schema for a context entity for media player events that tracks a session of a single media player usage */
 export interface MediaSession extends Record<string, unknown> {
-  /** An identifier for the media session */
+  /** An identifier for the media session that is kept while the media content is played in the media player. Does not reset automatically. */
   mediaSessionId: string;
   /** Date-time timestamp of when the session started */
   startedAt?: Date;

diff --git a/plugins/browser-plugin-media/test/api.test.ts b/plugins/browser-plugin-media/test/api.test.ts
@@ -227,7 +227,7 @@ describe('Media Tracking API', () => {
     it('tracks an ad skip event', () => {
       startMediaTracking({ id, session: false });
 
-      trackMediaAdSkip({ id, percentProgress: 33 })
+      trackMediaAdSkip({ id, percentProgress: 33.33 })
 
       expect(eventQueue).toMatchObject([
         {
@@ -242,7 +242,7 @@ describe('Media Tracking API', () => {
     it('tracks an ad click event', () => {
       startMediaTracking({ id, session: false });
 
-      trackMediaAdClick({ id, percentProgress: 33 })
+      trackMediaAdClick({ id, percentProgress: 33.33 })
 
       expect(eventQueue).toMatchObject([
         {
@@ -257,7 +257,7 @@ describe('Media Tracking API', () => {
     it('tracks an ad pause event', () => {
       startMediaTracking({ id, session: false });
 
-      trackMediaAdPause({ id, percentProgress: 33 })
+      trackMediaAdPause({ id, percentProgress: 33.33 })
 
       expect(eventQueue).toMatchObject([
         {
@@ -272,7 +272,7 @@ describe('Media Tracking API', () => {
     it('tracks an ad resume event', () => {
       startMediaTracking({ id, session: false });
 
-      trackMediaAdResume({ id, percentProgress: 33 })
+      trackMediaAdResume({ id, percentProgress: 33.33 })
 
       expect(eventQueue).toMatchObject([
         {