Skip to content

fix: refactor and separate source & cloud config #896

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tsi merged 6 commits into from
Aug 11, 2025
Merged

fix: refactor and separate source & cloud config #896

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
439be80
fix: refactor and separate source & cloud config
tsi Aug 6, 2025
cbc37da
Merge branch 'VIDEO-19832-playlist-analytics' into VIDEO-19832-source…
tsi Aug 6, 2025
edcf8ff
Merge branch 'VIDEO-19832-playlist-analytics' into VIDEO-19832-source…
tsi Aug 11, 2025
5e9c5f7
fix: default abrStrategy
tsi Aug 11, 2025
1149ad2
fix: styledTextTracks + transcript analytics
tsi Aug 11, 2025
01da294
fix: missing import in all.js
tsi Aug 11, 2025
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
1 change: 1 addition & 0 deletions src/index.all.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ export * from './plugins/playlist/playlist.js';
export * from './plugins/interaction-areas/interaction-areas.service.js';
export * from './plugins/visual-search/visual-search.js';
export * from './plugins/srt-text-tracks/srt-text-tracks.js';
export * from './plugins/share/share.js';
export * from './components/shoppable-bar/shoppable-widget.js';
export * from './components/recommendations-overlay/recommendations-overlay.js';

Expand Down
70 changes: 32 additions & 38 deletions src/utils/get-analytics-player-options.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,30 +11,11 @@ const filterDefaultsAndNulls = (obj) => Object.entries(obj).reduce((filtered, [k
return filtered;
}, {});

const getCloudinaryOptions = (cloudinaryOptions = {}) => ({
autoShowRecommendations: cloudinaryOptions.autoShowRecommendations,
fontFace: cloudinaryOptions.fontFace,
posterOptions: hasConfig(cloudinaryOptions.posterOptions),
posterOptionsPublicId: cloudinaryOptions.posterOptions && hasConfig(cloudinaryOptions.posterOptions.publicId)
});

const getTranscriptOptions = (textTracks = {}) => {
const tracksArr = [textTracks.captions, ...(textTracks.subtitles || [])];
return {
textTracks: hasConfig(textTracks),
textTracksLength: tracksArr.length,
textTracksOptions: hasConfig(textTracks.options) && Object.keys(textTracks.options).join(','),
pacedTextTracks: hasConfig(textTracks) && JSON.stringify(textTracks || {}).includes('"maxWords":') || null,
wordHighlight: hasConfig(textTracks) && JSON.stringify(textTracks || {}).includes('"wordHighlight":') || null,
transcriptLanguages: tracksArr.filter((track) => !track.url).map((track) => track.language || '').join(',') || null,
transcriptAutoLoaded: tracksArr.some((track) => !track.url) || null,
transcriptFromURl: tracksArr.some((track) => track.url?.endsWith('.transcript')) || null,
vttFromUrl: tracksArr.some((track) => track.url?.endsWith('.vtt')) || null,
srtFromUrl: tracksArr.some((track) => track.url?.endsWith('.srt')) || null
};
};

const getSourceOptions = (sourceOptions = {}) => ({
posterOptions: hasConfig(sourceOptions.posterOptions),
posterOptionsPublicId: sourceOptions.posterOptions && hasConfig(sourceOptions.posterOptions.publicId),
autoShowRecommendations: sourceOptions.autoShowRecommendations,
fontFace: sourceOptions.fontFace,
sourceTypes: sourceOptions.sourceTypes,
chapters: (() => {
if (sourceOptions.chapters === true) return 'auto';
Expand All @@ -46,7 +27,7 @@ const getSourceOptions = (sourceOptions = {}) => ({
download: hasConfig(sourceOptions.download),
recommendations: sourceOptions.recommendations && sourceOptions.recommendations.length,
...(hasConfig(sourceOptions.adaptiveStreaming) ? {
abrStrategy: sourceOptions?.adaptiveStreaming?.strategy,
abrStrategy: sourceOptions?.adaptiveStreaming?.strategy === defaults.adaptiveStreaming.strategy ? undefined : sourceOptions?.adaptiveStreaming?.strategy,
} : {}),
shoppable: hasConfig(sourceOptions.shoppable),
shoppableProductsLength: sourceOptions.shoppable && sourceOptions.shoppable.products && sourceOptions.shoppable.products.length,
Expand All @@ -55,20 +36,34 @@ const getSourceOptions = (sourceOptions = {}) => ({
sourceTitle: (typeof sourceOptions.title === 'string' ? sourceOptions.title : sourceOptions.info?.title),
sourceDescription: (typeof sourceOptions.description === 'string' ? sourceOptions.description : sourceOptions.info?.subtitle || sourceOptions.info?.description)
} : {}),
...(sourceOptions.textTracks ? {
...(hasConfig(sourceOptions.textTracks) && getTranscriptOptions(sourceOptions.textTracks)),
...(sourceOptions.textTracks.options ? {
styledTextTracksTheme: sourceOptions.textTracks.options.theme,
styledTextTracksFont: sourceOptions.textTracks.options.fontFace,
styledTextTracksFontSize: sourceOptions.textTracks.options.fontSize,
styledTextTracksGravity: sourceOptions.textTracks.options.gravity,
styledTextTracksBox: hasConfig(sourceOptions.textTracks.options.box),
styledTextTracksStyle: hasConfig(sourceOptions.textTracks.options.style),
styledTextTracksWordHighlightStyle: hasConfig(sourceOptions.textTracks.options.wordHighlightStyle)
} : {})
} : {})
...(hasConfig(sourceOptions.textTracks) ? getTextTracksOptions(sourceOptions.textTracks) : {})
});

const getTextTracksOptions = (textTracks = {}) => {
const tracksArr = [textTracks.captions, ...(textTracks.subtitles || [])];
return {
textTracks: hasConfig(textTracks),
textTracksLength: tracksArr.length,
textTracksOptions: hasConfig(textTracks.options) && Object.keys(textTracks.options).join(','),
pacedTextTracks: hasConfig(textTracks) && JSON.stringify(textTracks || {}).includes('"maxWords":') || null,
wordHighlight: hasConfig(textTracks) && JSON.stringify(textTracks || {}).includes('"wordHighlight":') || null,
transcriptLanguages: tracksArr.filter((track) => !track.url).map((track) => track.language || '').join(',') || null,
transcriptAutoLoaded: tracksArr.some((track) => !track.url) || null,
transcriptFromURl: tracksArr.some((track) => track.url?.endsWith('.transcript')) || null,
vttFromUrl: tracksArr.some((track) => track.url?.endsWith('.vtt')) || null,
srtFromUrl: tracksArr.some((track) => track.url?.endsWith('.srt')) || null,
...(textTracks.options ? {
styledTextTracksTheme: textTracks.options.theme,
styledTextTracksFont: textTracks.options.fontFace,
styledTextTracksFontSize: textTracks.options.fontSize,
styledTextTracksGravity: textTracks.options.gravity,
styledTextTracksBox: hasConfig(textTracks.options.box),
styledTextTracksStyle: hasConfig(textTracks.options.style),
styledTextTracksWordHighlightStyle: hasConfig(textTracks.options.wordHighlightStyle)
} : {})
};
};

const getAdsOptions = (adsOptions = {}) => ({
adsAdTagUrl: adsOptions.adTagUrl,
adsShowCountdown: adsOptions.showCountdown,
Expand Down Expand Up @@ -126,8 +121,7 @@ export const getAnalyticsFromPlayerOptions = (playerOptions) => filterDefaultsAn
colors: playerOptions.colors && JSON.stringify(playerOptions.colors),
controlBar: (JSON.stringify(playerOptions.controlBar) !== JSON.stringify(defaults.controlBar)) && JSON.stringify(playerOptions.controlBar),

...getCloudinaryOptions(playerOptions.cloudinary),
...getSourceOptions(playerOptions.sourceOptions),
...getSourceOptions(playerOptions.sourceOptions || {}),
...getAdsOptions(playerOptions.ads),
...getPlaylistOptions(playerOptions.playlistWidget)
});
25 changes: 14 additions & 11 deletions src/video-player.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ import { PLAYER_EVENT, SOURCE_TYPE } from './utils/consts';
import { getAnalyticsFromPlayerOptions } from './utils/get-analytics-player-options';
import { extendCloudinaryConfig, normalizeOptions, isRawUrl, ERROR_CODE } from './plugins/cloudinary/common';
import { isVideoInReadyState, checkIfVideoIsAvailable } from './utils/video-retry';
import { SOURCE_PARAMS } from './video-player.const';

const INTERNAL_ANALYTICS_URL = 'https://analytics-api-s.cloudinary.com';

Expand Down Expand Up @@ -117,7 +116,7 @@ class VideoPlayer extends Utils.mixin(Eventable) {
const baseParams = new URLSearchParams({
vpVersion: VERSION,
vpInstanceId: this.getVPInstanceId(),
cloudName: options.cloudinary.cloudinaryConfig.cloud_name,
cloudName: options.cloudinary.cloud_name,
...internalAnalyticsMetadata,
}).toString();
fetch(`${INTERNAL_ANALYTICS_URL}/video_player_source?${analyticsParams}&${baseParams}`);
Expand Down Expand Up @@ -410,14 +409,20 @@ class VideoPlayer extends Utils.mixin(Eventable) {
}

_initCloudinary() {
const { cloudinaryConfig } = this.playerOptions.cloudinary;
const cloudinaryConfig = this.playerOptions.cloudinary;
cloudinaryConfig.chainTarget = this;

if (cloudinaryConfig.secure !== false) {
extendCloudinaryConfig(cloudinaryConfig, { secure: true });
}

this.videojs.cloudinary(this.playerOptions.cloudinary);
// Merge cloudinary config with source config for the plugin
const cloudinaryOptions = {
cloudinaryConfig,
...this.playerOptions.sourceOptions
};

this.videojs.cloudinary(cloudinaryOptions);
}

_initAnalytics() {
Expand Down Expand Up @@ -516,11 +521,11 @@ class VideoPlayer extends Utils.mixin(Eventable) {
this._setExtendedEvents();

// Load first video (mainly to support video tag 'source' and 'public-id' attributes)
// Source parameters are set to playerOptions.cloudinary
const source = this.playerOptions.cloudinary.source || this.playerOptions.cloudinary.publicId;
// Source parameters are set to playerOptions.sourceOptions
const source = this.playerOptions.sourceOptions.source || this.playerOptions.sourceOptions.publicId;

if (source) {
const sourceOptions = Object.assign({}, this.playerOptions.cloudinary);
const sourceOptions = Object.assign({}, this.playerOptions.sourceOptions);

this.source(source, sourceOptions);
}
Expand Down Expand Up @@ -597,10 +602,8 @@ class VideoPlayer extends Utils.mixin(Eventable) {
}

// Inherit source parameters from player options (source options take precedence)
const inherited = pick(this.playerOptions, SOURCE_PARAMS);
const inheritedNested = this.playerOptions.cloudinary ? pick(this.playerOptions.cloudinary, SOURCE_PARAMS) : {};

options = { ...inherited, ...inheritedNested, ...options };
const inherited = this.playerOptions.sourceOptions || {};
options = { ...inherited, ...options };

if (options.shoppable && this.videojs.shoppable) {
this.videojs.shoppable(this.videojs, options);
Expand Down
14 changes: 12 additions & 2 deletions src/video-player.utils.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import defaults from './config/defaults';
import {
PLAYER_PARAMS,
SOURCE_PARAMS,
CLOUDINARY_CONFIG_PARAM,
FLUID_CLASS_NAME,
AUTO_PLAY_MODE
} from './video-player.const';
Expand Down Expand Up @@ -89,8 +90,17 @@ export const extractOptions = (elem, options) => {
// VideoPlayer specific options
const playerOptions = Utils.sliceAndUnsetProperties(options, ...PLAYER_PARAMS);

// Cloudinary plugin specific options
playerOptions.cloudinary = Utils.sliceAndUnsetProperties(playerOptions, ...SOURCE_PARAMS);
// Cloudinary SDK config (cloud_name, secure, etc.)
playerOptions.cloudinary = Utils.sliceAndUnsetProperties(playerOptions, ...CLOUDINARY_CONFIG_PARAM);

// Merge with cloudinaryConfig from src/index.js (e.g., secureDistribution -> secure_distribution)
if (playerOptions.cloudinaryConfig) {
Object.assign(playerOptions.cloudinary, playerOptions.cloudinaryConfig);
delete playerOptions.cloudinaryConfig;
}

// Source-level config (visualSearch, chapters, etc.)
playerOptions.sourceOptions = Utils.sliceAndUnsetProperties(playerOptions, ...SOURCE_PARAMS);

// Allow explicitly passing options to videojs using the `videojs` namespace, in order
// to avoid param name conflicts:
Expand Down