lbry-desktop/ui/analytics.js

316 lines
8.9 KiB
JavaScript
Raw Normal View History

2018-02-16 09:47:52 +01:00
// @flow
2018-09-24 05:44:42 +02:00
import { Lbryio } from 'lbryinc';
2019-04-01 16:30:19 +02:00
import ReactGA from 'react-ga';
2020-02-14 19:58:09 +01:00
import * as Sentry from '@sentry/browser';
2019-04-09 23:21:00 +02:00
import { history } from './store';
2020-03-24 19:43:51 +01:00
import { SDK_API_PATH } from './index';
2019-05-14 22:35:49 +02:00
// @if TARGET='app'
import Native from 'native';
2019-05-14 22:35:49 +02:00
import ElectronCookies from '@exponent/electron-cookies';
2020-02-12 05:59:30 +01:00
import { generateInitialUrl } from 'util/url';
2019-05-14 22:35:49 +02:00
// @endif
2018-02-16 09:47:52 +01:00
2019-06-20 02:57:51 +02:00
const isProduction = process.env.NODE_ENV === 'production';
const devInternalApis = process.env.LBRY_API_URL;
const LBRY_TV_MINUS_PIRATE_BAY_UA_ID = 'UA-60403362-16';
const LBRY_TV_UA_ID = 'UA-60403362-12';
const DESKTOP_UA_ID = 'UA-60403362-13';
2019-11-07 16:33:00 +01:00
const SECOND_TRACKER_NAME = 'tracker2';
export const SHARE_INTERNAL = 'shareInternal';
const SHARE_THIRD_PARTY = 'shareThirdParty';
// @if TARGET='app'
2020-05-15 21:12:11 +02:00
if (isProduction) {
ElectronCookies.enable({
origin: 'https://lbry.tv',
});
}
// @endif
2019-06-20 02:57:51 +02:00
2018-02-16 09:47:52 +01:00
type Analytics = {
2020-02-14 19:58:09 +01:00
error: string => Promise<any>,
sentryError: ({}, {}) => Promise<any>,
2019-04-01 16:30:19 +02:00
pageView: string => void,
2018-02-24 01:24:00 +01:00
setUser: Object => void,
toggleInternal: (boolean, ?boolean) => void,
toggleThirdParty: (boolean, ?boolean) => void,
apiLogView: (string, string, string, ?number, ?() => void) => Promise<any>,
2019-10-16 23:36:50 +02:00
apiLogPublish: (ChannelClaim | StreamClaim) => void,
apiSyncTags: ({}) => void,
2019-07-22 01:35:59 +02:00
tagFollowEvent: (string, boolean, string) => void,
2020-01-22 18:19:49 +01:00
videoStartEvent: (string, number) => void,
videoBufferEvent: (string, number) => void,
emailProvidedEvent: () => void,
emailVerifiedEvent: () => void,
rewardEligibleEvent: () => void,
2019-10-02 20:20:25 +02:00
startupEvent: () => void,
readyEvent: number => void,
2019-11-04 16:55:02 +01:00
openUrlEvent: string => void,
2018-02-24 01:24:00 +01:00
};
2018-02-16 09:47:52 +01:00
2019-10-16 23:36:50 +02:00
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
2020-01-02 23:30:58 +01:00
2018-02-16 09:47:52 +01:00
const analytics: Analytics = {
2020-02-05 15:45:20 +01:00
error: message => {
2020-02-14 19:58:09 +01:00
return new Promise(resolve => {
if (internalAnalyticsEnabled && isProduction) {
2020-02-14 19:58:09 +01:00
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) {
2020-02-14 19:58:09 +01:00
Sentry.withScope(scope => {
scope.setExtras(errorInfo);
const eventId = Sentry.captureException(error);
resolve(eventId);
});
} else {
resolve(null);
}
});
},
2019-04-01 16:30:19 +02:00
pageView: path => {
if (thirdPartyAnalyticsEnabled) {
2019-11-07 16:33:00 +01:00
ReactGA.pageview(path, [SECOND_TRACKER_NAME]);
2018-02-16 09:47:52 +01:00
}
},
2019-07-22 04:28:49 +02:00
setUser: userId => {
if (thirdPartyAnalyticsEnabled && userId) {
ReactGA.set({
userId,
});
// @if TARGET='app'
Native.getAppVersionInfo().then(({ localVersion }) => {
2019-08-15 05:09:34 +02:00
sendGaEvent('Desktop-Version', localVersion);
2019-07-22 04:28:49 +02:00
});
// @endif
2019-07-22 04:28:49 +02:00
}
},
toggleInternal: (enabled: boolean): void => {
2019-04-14 07:48:11 +02:00
// Always collect analytics on lbry.tv
// @if TARGET='app'
internalAnalyticsEnabled = enabled;
window.localStorage.setItem(SHARE_INTERNAL, enabled);
2019-04-14 07:48:11 +02:00
// @endif
2018-02-24 01:24:00 +01:00
},
toggleThirdParty: (enabled: boolean): void => {
// Always collect analytics on lbry.tv
// @if TARGET='app'
thirdPartyAnalyticsEnabled = enabled;
window.localStorage.setItem(SHARE_THIRD_PARTY, enabled);
// @endif
},
2019-08-14 05:04:08 +02:00
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();
}
});
2018-03-08 06:07:42 +01:00
},
2019-02-05 19:36:40 +01:00
apiLogSearch: () => {
if (internalAnalyticsEnabled && isProduction) {
2019-02-05 19:36:40 +01:00
Lbryio.call('event', 'search');
}
},
2019-10-16 23:36:50 +02:00
apiLogPublish: (claimResult: ChannelClaim | StreamClaim) => {
if (internalAnalyticsEnabled && isProduction) {
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}`;
2019-10-16 23:36:50 +02:00
const params: LogPublishParams = { uri, claim_id: claimId, outpoint };
if (channelClaimId) {
params['channel_claim_id'] = channelClaimId;
}
2019-10-16 23:36:50 +02:00
Lbryio.call('event', 'publish', params);
}
},
apiSyncTags: params => {
if (internalAnalyticsEnabled && isProduction) {
Lbryio.call('content_tags', 'sync', params);
}
},
apiSearchFeedback: (query, vote) => {
2019-06-20 02:57:51 +02:00
if (isProduction) {
// We don't need to worry about analytics enabled here because users manually click on the button to provide feedback
Lbryio.call('feedback', 'search', { query, vote });
}
},
2020-01-22 18:19:49 +01:00
videoStartEvent: (claimId, duration) => {
sendGaTimingEvent('Media', 'TimeToStart', duration, claimId);
2020-03-23 22:16:28 +01:00
sendPromMetric('time_to_start', duration);
2020-01-22 18:19:49 +01:00
},
videoBufferEvent: (claimId, currentTime) => {
2020-01-27 00:34:36 +01:00
sendGaTimingEvent('Media', 'BufferTimestamp', currentTime * 1000, claimId);
2020-03-23 22:16:28 +01:00
sendPromMetric('buffer');
2020-01-22 18:19:49 +01:00
},
2019-07-22 01:35:59 +02:00
tagFollowEvent: (tag, following, location) => {
2019-08-15 05:09:34 +02:00
sendGaEvent(following ? 'Tag-Follow' : 'Tag-Unfollow', tag);
2019-07-22 01:35:59 +02:00
},
channelBlockEvent: (uri, blocked, location) => {
2019-08-15 05:09:34 +02:00
sendGaEvent(blocked ? 'Channel-Hidden' : 'Channel-Unhidden', uri);
},
emailProvidedEvent: () => {
2019-08-15 05:09:34 +02:00
sendGaEvent('Engagement', 'Email-Provided');
},
emailVerifiedEvent: () => {
2019-08-15 05:09:34 +02:00
sendGaEvent('Engagement', 'Email-Verified');
},
rewardEligibleEvent: () => {
2019-08-15 05:09:34 +02:00
sendGaEvent('Engagement', 'Reward-Eligible');
},
2019-11-04 16:55:02 +01:00
openUrlEvent: (url: string) => {
sendGaEvent('Engagement', 'Open-Url', url);
},
2020-03-12 17:36:45 +01:00
trendingAlgorithmEvent: (trendingAlgorithm: string) => {
sendGaEvent('Engagement', 'Trending-Algorithm', trendingAlgorithm);
},
2019-10-02 20:20:25 +02:00
startupEvent: () => {
sendGaEvent('Startup', 'Startup');
},
readyEvent: (timeToReady: number) => {
sendGaEvent('Startup', 'App-Ready');
sendGaTimingEvent('Startup', 'App-Ready', timeToReady);
},
2018-02-24 01:24:00 +01:00
};
2018-02-16 09:47:52 +01:00
2020-01-22 18:19:49 +01:00
function sendGaEvent(category, action, label, value) {
if (thirdPartyAnalyticsEnabled && isProduction) {
2019-11-07 16:33:00 +01:00
ReactGA.event(
{
category,
action,
...(label ? { label } : {}),
2020-01-22 18:19:49 +01:00
...(value ? { value } : {}),
2019-11-07 16:33:00 +01:00
},
[SECOND_TRACKER_NAME]
);
2019-08-15 05:09:34 +02:00
}
}
2020-01-27 00:34:36 +01:00
function sendGaTimingEvent(category: string, action: string, timeInMs: number, label?: string) {
if (thirdPartyAnalyticsEnabled && isProduction) {
2019-11-07 16:33:00 +01:00
ReactGA.timing(
{
category,
variable: action,
value: timeInMs,
2020-01-27 00:34:36 +01:00
...(label ? { label } : {}),
2019-11-07 16:33:00 +01:00
},
[SECOND_TRACKER_NAME]
);
2019-10-02 20:20:25 +02:00
}
}
2020-03-23 22:16:28 +01:00
function sendPromMetric(name: string, value?: number) {
if (IS_WEB) {
2020-03-24 19:43:51 +01:00
let url = new URL(SDK_API_PATH + '/metric/ui');
2020-03-23 22:16:28 +01:00
const params = { name: name, value: value ? value.toString() : '' };
url.search = new URLSearchParams(params).toString();
2020-03-24 20:31:00 +01:00
return fetch(url, { method: 'post' });
2020-03-23 22:16:28 +01:00
}
}
let gaTrackers = [];
2019-04-11 20:22:47 +02:00
if (!IS_WEB) {
gaTrackers.push({
trackingId: DESKTOP_UA_ID,
});
} else {
gaTrackers.push({
trackingId: LBRY_TV_UA_ID,
});
const { search } = window.location;
const urlParams = new URLSearchParams(search);
2019-11-06 18:18:15 +01:00
const isPirateBayUser = urlParams.get('utm_source') === 'PB';
if (!isPirateBayUser) {
gaTrackers.push({
trackingId: LBRY_TV_MINUS_PIRATE_BAY_UA_ID,
2019-11-07 16:33:00 +01:00
gaOptions: {
name: SECOND_TRACKER_NAME,
},
});
}
}
2019-05-14 22:35:49 +02:00
ReactGA.initialize(gaTrackers, {
2019-04-09 23:21:00 +02:00
testMode: process.env.NODE_ENV !== 'production',
2019-05-14 22:35:49 +02:00
cookieDomain: 'auto',
2019-10-02 20:20:25 +02:00
siteSpeedSampleRate: 100,
2019-08-15 05:09:34 +02:00
// un-comment to see events as they are sent to google
// debug: true,
2019-04-09 23:21:00 +02:00
});
2019-04-01 16:30:19 +02:00
// Manually call the first page view
2019-04-09 23:21:00 +02:00
// React Router doesn't include this on `history.listen`
2019-07-09 18:18:06 +02:00
// @if TARGET='web'
2019-04-09 23:21:00 +02:00
analytics.pageView(window.location.pathname + window.location.search);
2019-07-09 18:18:06 +02:00
// @endif
2019-04-01 16:30:19 +02:00
2019-05-14 22:35:49 +02:00
// @if TARGET='app'
ReactGA.set({ checkProtocolTask: null });
ReactGA.set({ location: 'https://lbry.tv' });
2020-02-12 05:59:30 +01:00
analytics.pageView(
window.location.pathname.split('.html')[1] + window.location.search || generateInitialUrl(window.location.hash)
);
2019-05-14 22:35:49 +02:00
// @endif;
2019-04-01 16:30:19 +02:00
// Listen for url changes and report
2019-04-09 23:21:00 +02:00
// This will include search queries
history.listen(location => {
2019-04-15 05:49:50 +02:00
const { pathname, search } = location;
2019-04-14 07:48:11 +02:00
2019-04-15 05:49:50 +02:00
const page = `${pathname}${search}`;
analytics.pageView(page);
2019-04-09 23:21:00 +02:00
});
2019-04-01 16:30:19 +02:00
2018-02-16 09:47:52 +01:00
export default analytics;