Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"changes": [
{
"packageName": "@snowplow/browser-plugin-media",
"comment": "Prevent empty values in media entity",
"type": "none"
}
],
"packageName": "@snowplow/browser-plugin-media"
}
7 changes: 6 additions & 1 deletion plugins/browser-plugin-media/src/core.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,14 @@ export function buildMediaPlayerEvent(event: MediaEvent): SelfDescribingJson {
}

export function buildMediaPlayerEntity(mediaPlayer: MediaPlayer): SelfDescribingJson {
const player = { ...mediaPlayer };
if (player.label === '') delete player.label;
if (player.playerType === '') delete player.playerType;
if (player.quality === '') delete player.quality;

return {
schema: MEDIA_PLAYER_SCHEMA,
data: removeEmptyProperties(mediaPlayer),
data: removeEmptyProperties(player),
};
}

Expand Down
32 changes: 32 additions & 0 deletions plugins/browser-plugin-media/test/api.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -316,6 +316,38 @@ describe('Media Tracking API', () => {
]);
});

it('strips empty string values from optional media player fields', () => {
startMediaTracking({
id,
session: false,
player: { label: '', playerType: '', quality: '' },
});

trackMediaPlay({ id });

const playerContext = eventQueue[0].context[0].data;
expect(playerContext).not.toHaveProperty('label');
expect(playerContext).not.toHaveProperty('playerType');
expect(playerContext).not.toHaveProperty('quality');
});

it('preserves non-empty string values for optional media player fields', () => {
startMediaTracking({
id,
session: false,
player: { label: 'My Video', playerType: 'html5', quality: '1080p' },
});

trackMediaPlay({ id });

const playerContext = eventQueue[0].context[0].data;
expect(playerContext).toMatchObject({
label: 'My Video',
playerType: 'html5',
quality: '1080p',
});
});

it('tracks error event', () => {
startMediaTracking({ id, session: false });

Expand Down
Loading