// @flow import { Lbryio } from 'lbryinc'; import * as Sentry from '@sentry/browser'; import MatomoTracker from '@datapunt/matomo-tracker-js'; import { history } from './store'; import { SDK_API_PATH } from './index'; // @if TARGET='app' import Native from 'native'; import ElectronCookies from '@exponent/electron-cookies'; import { generateInitialUrl } from 'util/url'; // @endif import { MATOMO_ID, MATOMO_URL } from 'config'; import getConnectionSpeed from 'util/detect-user-bandwidth'; let userDownloadBandwidthInBitsPerSecond; async function getUserBandwidth() { userDownloadBandwidthInBitsPerSecond = await getConnectionSpeed(); } // get user bandwidth every minute, starting after an initial one minute wait setInterval(getUserBandwidth, 1000 * 60); const isProduction = process.env.NODE_ENV === 'production'; const devInternalApis = process.env.LBRY_API_URL && process.env.LBRY_API_URL.includes('dev'); export const SHARE_INTERNAL = 'shareInternal'; const SHARE_THIRD_PARTY = 'shareThirdParty'; const WATCHMAN_BACKEND_ENDPOINT = 'https://watchman.na-backend.odysee.com/reports/playback'; const SEND_DATA_TO_WATCHMAN_INTERVAL = 10; // in seconds // @if TARGET='app' if (isProduction) { ElectronCookies.enable({ origin: 'https://lbry.tv', }); } // @endif type Analytics = { error: (string) => Promise, sentryError: ({} | string, {}) => Promise, pageView: (string, ?string) => void, setUser: (Object) => void, toggleInternal: (boolean, ?boolean) => void, apiLogView: (string, string, string, ?number, ?() => void) => Promise, apiLogPublish: (ChannelClaim | StreamClaim) => void, apiSyncTags: ({}) => void, tagFollowEvent: (string, boolean, ?string) => void, playerLoadedEvent: (?boolean) => void, playerStartedEvent: (?boolean) => void, videoStartEvent: (string, number, string, number, string, any, number) => void, videoIsPlaying: (boolean, any) => void, videoBufferEvent: ( StreamClaim, { timeAtBuffer: number, bufferDuration: number, bitRate: number, duration: number, userId: string, playerPoweredBy: string, readyState: number, } ) => Promise, adsFetchedEvent: () => void, adsReceivedEvent: (any) => void, adsErrorEvent: (any) => void, emailProvidedEvent: () => void, emailVerifiedEvent: () => void, rewardEligibleEvent: () => void, startupEvent: () => void, purchaseEvent: (number) => void, readyEvent: (number) => void, openUrlEvent: (string) => void, }; type LogPublishParams = { uri: string, claim_id: string, outpoint: string, channel_claim_id?: string, }; let internalAnalyticsEnabled: boolean = IS_WEB || false; // let thirdPartyAnalyticsEnabled: boolean = IS_WEB || false; // @if TARGET='app' if (window.localStorage.getItem(SHARE_INTERNAL) === 'true') internalAnalyticsEnabled = true; // if (window.localStorage.getItem(SHARE_THIRD_PARTY) === 'true') thirdPartyAnalyticsEnabled = true; // @endif /** * Determine the mobile device type viewing the data * This function returns one of 'and' (Android), 'ios', or 'web'. * * @returns {String} */ function getDeviceType() { // We may not care what the device is if it's in a web browser. Commenting out for now. // if (!IS_WEB) { // return 'elt'; // } // const userAgent = navigator.userAgent || navigator.vendor || window.opera; // // if (/android/i.test(userAgent)) { // return 'adr'; // } // // // iOS detection from: http://stackoverflow.com/a/9039885/177710 // if (/iPad|iPhone|iPod/.test(userAgent) && !window.MSStream) { // return 'ios'; // } // default as web, this can be optimized if (!IS_WEB) { return 'dsk'; } return 'web'; } // variables initialized for watchman let amountOfBufferEvents = 0; let amountOfBufferTimeInMS = 0; let videoType, userId, claimUrl, playerPoweredBy, videoPlayer, bitrateAsBitsPerSecond; let lastSentTime; // calculate data for backend, send them, and reset buffer data for next interval async function sendAndResetWatchmanData() { if (!userId) { return 'Can only be used with a user id'; } if (!videoPlayer) { return 'Video player not initialized'; } let timeSinceLastIntervalSend = new Date() - lastSentTime; lastSentTime = new Date(); // TODO: hook into here to calculate bandwidth let protocol; if (videoType === 'application/x-mpegURL') { protocol = 'hls'; } else { protocol = 'stb'; } // current position in video in MS const positionInVideo = Math.round(videoPlayer.currentTime()) * 1000; // get the duration marking the time in the video for relative position calculation const totalDurationInSeconds = Math.round(videoPlayer.duration()); // build object for watchman backend const objectToSend = { rebuf_count: amountOfBufferEvents, rebuf_duration: amountOfBufferTimeInMS, url: claimUrl.replace('lbry://', ''), device: getDeviceType(), duration: timeSinceLastIntervalSend, protocol, player: playerPoweredBy, user_id: userId.toString(), position: Math.round(positionInVideo), rel_position: Math.round((positionInVideo / (totalDurationInSeconds * 1000)) * 100), ...(userDownloadBandwidthInBitsPerSecond && {bandwidth: userDownloadBandwidthInBitsPerSecond}), // add bandwidth if populated ...(bitrateAsBitsPerSecond && {bitrate: bitrateAsBitsPerSecond}), // add bitrate if video (audio doesn't work) }; // post to watchman await sendWatchmanData(objectToSend); // reset buffer data amountOfBufferEvents = 0; amountOfBufferTimeInMS = 0; } let watchmanInterval; // clear watchman interval and mark it as null (when video paused) function stopWatchmanInterval() { clearInterval(watchmanInterval); watchmanInterval = null; } // creates the setInterval that will run send to watchman on recurring basis function startWatchmanIntervalIfNotRunning() { if (!watchmanInterval) { // instantiate the first time to calculate duration from lastSentTime = new Date(); // only set an interval if analytics are enabled and is prod if (isProduction && IS_WEB) { watchmanInterval = setInterval(sendAndResetWatchmanData, 1000 * SEND_DATA_TO_WATCHMAN_INTERVAL); } } } // post data to the backend async function sendWatchmanData(body) { try { const response = await fetch(WATCHMAN_BACKEND_ENDPOINT, { method: 'POST', headers: { Accept: 'application/json', 'Content-Type': 'application/json', }, body: JSON.stringify(body), }); return response; } catch (err) { console.log('ERROR FROM WATCHMAN BACKEND'); console.log(err); } } const analytics: Analytics = { // receive buffer events from tracking plugin and save buffer amounts and times for backend call videoBufferEvent: async (claim, data) => { amountOfBufferEvents = amountOfBufferEvents + 1; amountOfBufferTimeInMS = amountOfBufferTimeInMS + data.bufferDuration; }, onDispose: () => { stopWatchmanInterval(); }, /** * Is told whether video is being started or paused, and adjusts interval accordingly * @param {boolean} isPlaying - Whether video was started or paused * @param {object} passedPlayer - VideoJS Player object */ videoIsPlaying: (isPlaying, passedPlayer) => { let playerIsSeeking = false; // have to use this because videojs pauses/unpauses during seek // sometimes the seeking function isn't populated yet so check for it as well if (passedPlayer && passedPlayer.seeking) { playerIsSeeking = passedPlayer.seeking(); } // if being paused, and not seeking, send existing data and stop interval if (!isPlaying && !playerIsSeeking) { sendAndResetWatchmanData(); stopWatchmanInterval(); // if being told to pause, and seeking, send and restart interval } else if (!isPlaying && playerIsSeeking) { sendAndResetWatchmanData(); stopWatchmanInterval(); startWatchmanIntervalIfNotRunning(); // is being told to play, and seeking, don't do anything, // assume it's been started already from pause } else if (isPlaying && playerIsSeeking) { // start but not a seek, assuming a start from paused content } else if (isPlaying && !playerIsSeeking) { startWatchmanIntervalIfNotRunning(); } }, videoStartEvent: (claimId, duration, poweredBy, passedUserId, canonicalUrl, passedPlayer, videoBitrate) => { // populate values for watchman when video starts userId = passedUserId; claimUrl = canonicalUrl; playerPoweredBy = poweredBy; videoType = passedPlayer.currentSource().type; videoPlayer = passedPlayer; bitrateAsBitsPerSecond = videoBitrate; sendPromMetric('time_to_start', duration); sendMatomoEvent('Media', 'TimeToStart', claimId, duration); }, error: (message) => { return new Promise((resolve) => { if (internalAnalyticsEnabled && isProduction) { return Lbryio.call('event', 'desktop_error', { error_message: message }).then(() => { resolve(true); }); } else { resolve(false); } }); }, sentryError: (error, errorInfo) => { return new Promise((resolve) => { if (internalAnalyticsEnabled && isProduction) { Sentry.withScope((scope) => { scope.setExtras(errorInfo); const eventId = Sentry.captureException(error); resolve(eventId); }); } else { resolve(null); } }); }, pageView: (path, search) => { if (internalAnalyticsEnabled) { const params: { href: string, customDimensions?: Array<{ id: number, value: ?string }> } = { href: `${path}` }; const dimensions = []; const searchParams = search && new URLSearchParams(search); if (searchParams && searchParams.get('src')) { dimensions.push({ id: 1, value: searchParams.get('src') }); } if (dimensions.length) { params['customDimensions'] = dimensions; } MatomoInstance.trackPageView(params); } }, setUser: (userId) => { if (internalAnalyticsEnabled && userId) { window._paq.push(['setUserId', String(userId)]); // @if TARGET='app' Native.getAppVersionInfo().then(({ localVersion }) => { sendMatomoEvent('Version', 'Desktop-Version', localVersion); }); // @endif } }, toggleInternal: (enabled: boolean): void => { // Always collect analytics on lbry.tv // @if TARGET='app' internalAnalyticsEnabled = enabled; window.localStorage.setItem(SHARE_INTERNAL, enabled); // @endif }, toggleThirdParty: (enabled: boolean): void => { // Always collect analytics on lbry.tv // @if TARGET='app' // thirdPartyAnalyticsEnabled = enabled; window.localStorage.setItem(SHARE_THIRD_PARTY, enabled); // @endif }, apiLogView: (uri, outpoint, claimId, timeToStart) => { return new Promise((resolve, reject) => { if (internalAnalyticsEnabled && (isProduction || devInternalApis)) { const params: { uri: string, outpoint: string, claim_id: string, time_to_start?: number, } = { uri, outpoint, claim_id: claimId, }; // lbry.tv streams from AWS so we don't care about the time to start if (timeToStart && !IS_WEB) { params.time_to_start = timeToStart; } resolve(Lbryio.call('file', 'view', params)); } else { resolve(); } }); }, apiLogSearch: () => { if (internalAnalyticsEnabled && isProduction) { Lbryio.call('event', 'search'); } }, apiLogPublish: (claimResult: ChannelClaim | StreamClaim) => { // Don't check if this is production so channels created on localhost are still linked to user if (internalAnalyticsEnabled) { const { permanent_url: uri, claim_id: claimId, txid, nout, signing_channel: signingChannel } = claimResult; let channelClaimId; if (signingChannel) { channelClaimId = signingChannel.claim_id; } const outpoint = `${txid}:${nout}`; const params: LogPublishParams = { uri, claim_id: claimId, outpoint }; if (channelClaimId) { params['channel_claim_id'] = channelClaimId; } Lbryio.call('event', 'publish', params); } }, apiSyncTags: (params) => { if (internalAnalyticsEnabled && isProduction) { Lbryio.call('content_tags', 'sync', params); } }, adsFetchedEvent: () => { sendMatomoEvent('Media', 'AdsFetched'); }, adsReceivedEvent: (response) => { sendMatomoEvent('Media', 'AdsReceived', JSON.stringify(response)); }, adsErrorEvent: (response) => { sendMatomoEvent('Media', 'AdsError', JSON.stringify(response)); }, playerLoadedEvent: (embedded) => { sendMatomoEvent('Player', 'Loaded', embedded ? 'embedded' : 'onsite'); }, playerStartedEvent: (embedded) => { sendMatomoEvent('Player', 'Started', embedded ? 'embedded' : 'onsite'); }, tagFollowEvent: (tag, following) => { sendMatomoEvent('Tag', following ? 'Tag-Follow' : 'Tag-Unfollow', tag); }, channelBlockEvent: (uri, blocked, location) => { sendMatomoEvent(blocked ? 'Channel-Hidden' : 'Channel-Unhidden', uri); }, emailProvidedEvent: () => { sendMatomoEvent('Engagement', 'Email-Provided'); }, emailVerifiedEvent: () => { sendMatomoEvent('Engagement', 'Email-Verified'); }, rewardEligibleEvent: () => { sendMatomoEvent('Engagement', 'Reward-Eligible'); }, openUrlEvent: (url: string) => { sendMatomoEvent('Engagement', 'Open-Url', url); }, trendingAlgorithmEvent: (trendingAlgorithm: string) => { sendMatomoEvent('Engagement', 'Trending-Algorithm', trendingAlgorithm); }, startupEvent: () => { sendMatomoEvent('Startup', 'Startup'); }, readyEvent: (timeToReady: number) => { sendMatomoEvent('Startup', 'App-Ready', 'Time', timeToReady); }, purchaseEvent: (purchaseInt: number) => { sendMatomoEvent('Purchase', 'Purchase-Complete', 'someLabel', purchaseInt); }, }; function sendMatomoEvent(category, action, name, value) { if (internalAnalyticsEnabled) { const event = { category, action, name, value }; MatomoInstance.trackEvent(event); } } function sendPromMetric(name: string, value?: number) { if (IS_WEB) { let url = new URL(SDK_API_PATH + '/metric/ui'); const params = { name: name, value: value ? value.toString() : '' }; url.search = new URLSearchParams(params).toString(); return fetch(url, { method: 'post' }); } } const MatomoInstance = new MatomoTracker({ urlBase: MATOMO_URL, siteId: MATOMO_ID, // optional, default value: `1` // heartBeat: { // optional, enabled by default // active: true, // optional, default value: true // seconds: 10 // optional, default value: `15 // }, // linkTracking: false // optional, default value: true }); // Manually call the first page view // React Router doesn't include this on `history.listen` // @if TARGET='web' analytics.pageView(window.location.pathname + window.location.search, window.location.search); // @endif // @if TARGET='app' analytics.pageView( window.location.pathname.split('.html')[1] + window.location.search || generateInitialUrl(window.location.hash) ); // @endif; // Listen for url changes and report // This will include search queries history.listen((location) => { const { pathname, search } = location; const page = `${pathname}${search}`; analytics.pageView(page, search); }); export default analytics;