added google analytics to all routes

This commit is contained in:
bill bittner 2017-06-29 17:10:14 -07:00
parent 9fcbcd299c
commit b23087094a
6 changed files with 91 additions and 46 deletions

View file

@ -1,5 +1,8 @@
const db = require('../../models');
const logger = require('winston');
const ua = require('universal-analytics');
const config = require('config');
const googleApiKey = config.get('AnalyticsConfig.GoogleId');
module.exports = {
postToStats: (action, url, ipAddress, result) => {
@ -24,4 +27,32 @@ module.exports = {
logger.error('sequelize error', error);
});
},
sendGoogleAnalytics: (action, ip, originalUrl) => {
const visitorId = ip.replace(/\./g, '-');
const visitor = ua(googleApiKey, visitorId, { strictCidFormat: false, https: true });
switch (action) {
case 'serve':
visitor.event('serve', originalUrl, (err) => {
if (err) {
logger.error('Google Analytics Event Error >>', err);
}
});
break;
case 'show':
visitor.pageview(originalUrl, 'https://spee.ch', 'show route', (err) => {
if (err) {
logger.error('Google Analytics Pageview Error >>', err);
}
});
break;
case 'publish':
visitor.event('publish', originalUrl, (err) => {
if (err) {
logger.error('Google Analytics Event Error >>', err);
}
});
break;
default: break;
}
},
};

View file

@ -5,12 +5,16 @@ const publishController = require('../controllers/publishController.js');
const lbryApi = require('../helpers/libraries/lbryApi.js');
const publishHelpers = require('../helpers/libraries/publishHelpers.js');
const errorHandlers = require('../helpers/libraries/errorHandlers.js');
const { postToStats } = require('../helpers/libraries/statsHelpers.js');
const { postToStats, sendGoogleAnalytics } = require('../helpers/libraries/statsHelpers.js');
module.exports = app => {
// route to run a claim_list request on the daemon
app.get('/api/claim_list/:claim', ({ originalUrl, params, ip }, res) => {
app.get('/api/claim_list/:claim', ({ ip, originalUrl, params }, res) => {
// google analytics
sendGoogleAnalytics('serve', ip, originalUrl);
// log
logger.verbose(`GET request on ${originalUrl} from ${ip}`);
// serve the content
lbryApi
.getClaimsList(params.claim)
.then(claimsList => {
@ -22,8 +26,12 @@ module.exports = app => {
});
});
// route to run a resolve request on the daemon
app.get('/api/resolve/:uri', ({ originalUrl, params, ip }, res) => {
app.get('/api/resolve/:uri', ({ ip, originalUrl, params }, res) => {
// google analytics
sendGoogleAnalytics('serve', ip, originalUrl);
// log
logger.verbose(`GET request on ${originalUrl} from ${ip}`);
// serve content
lbryApi
.resolveUri(params.uri)
.then(resolvedUri => {
@ -35,7 +43,10 @@ module.exports = app => {
});
});
// route to run a publish request on the daemon
app.post('/api/publish', multipartMiddleware, ({ originalUrl, body, files, ip }, res) => {
app.post('/api/publish', multipartMiddleware, ({ body, files, ip, originalUrl }, res) => {
// google analytics
sendGoogleAnalytics('publish', ip, originalUrl);
// log
logger.verbose(`POST request on ${originalUrl} from ${ip}`);
// validate that a file was provided
const file = files.speech || files.null;

View file

@ -1,16 +1,25 @@
const logger = require('winston');
const { postToStats } = require('../helpers/libraries/statsHelpers.js');
const { postToStats, sendGoogleAnalytics } = require('../helpers/libraries/statsHelpers.js');
module.exports = app => {
// route for the home page
app.get('/', ({ originalUrl, ip, headers }, res) => {
app.get('/', ({ headers, ip, originalUrl }, res) => {
// google analytics
sendGoogleAnalytics('serve', ip, originalUrl);
// logging
logger.verbose(`GET request on ${originalUrl} from ${ip}`);
// send response
res.status(200).render('index');
});
// a catch-all route if someone visits a page that does not exist
app.use('*', ({ originalUrl, ip }, res) => {
// google analytics
sendGoogleAnalytics('serve', ip, originalUrl);
// logging
logger.error(`Get request on ${originalUrl} from ${ip} which was a 404`);
postToStats('post', originalUrl, ip, 'Error: 404');
// post to stats
postToStats('show', originalUrl, ip, 'Error: 404');
// send response
res.status(404).render('fourOhFour');
});
};

View file

@ -1,21 +1,7 @@
const errorHandlers = require('../helpers/libraries/errorHandlers.js');
const serveController = require('../controllers/serveController.js');
const logger = require('winston');
const { postToStats } = require('../helpers/libraries/statsHelpers.js');
function sendGoogleAnalytics (ua, googleApiKey, ip, originalUrl) {
const visitorId = ip.replace(/\./g, '-');
const visitor = ua(googleApiKey, visitorId, { strictCidFormat: false, https: true });
visitor.pageview(originalUrl, 'https://spee.ch', 'Serve Route', (err) => {
if (err) {
logger.error('Google Analytics Pageview Error >>', err);
}
}).event('Serve', originalUrl, (err) => {
if (err) {
logger.error('Google Analytics Event Error >>', err);
}
});
}
const { postToStats, sendGoogleAnalytics } = require('../helpers/libraries/statsHelpers.js');
function serveFile ({ fileName, fileType, filePath }, res) {
logger.info(`serving file ${fileName}`);
@ -46,13 +32,17 @@ function serveFile ({ fileName, fileType, filePath }, res) {
res.status(200).sendFile(filePath, options);
}
module.exports = (app, ua, googleApiKey) => {
function sendAnalyticsAndLog (ip, originalUrl) {
// google analytics
sendGoogleAnalytics('serve', ip, originalUrl);
// logging
logger.verbose(`GET request on ${originalUrl} from ${ip}`);
}
module.exports = (app) => {
// route to fetch one free public claim
app.get('/:name/:claim_id', ({ originalUrl, params, ip }, res) => {
// google analytics
sendGoogleAnalytics(ua, googleApiKey, ip, originalUrl);
// logging
logger.verbose(`GET request on ${originalUrl} from ${ip}`);
app.get('/:name/:claim_id', ({ ip, originalUrl, params }, res) => {
sendAnalyticsAndLog(ip, originalUrl);
// begin image-serve processes
serveController
.getClaimByClaimId(params.name, params.claim_id)
@ -65,11 +55,8 @@ module.exports = (app, ua, googleApiKey) => {
});
});
// route to fetch one free public claim
app.get('/:name', ({ originalUrl, params, ip }, res) => {
// google analytics
sendGoogleAnalytics(ua, googleApiKey, ip, originalUrl);
// logging
logger.verbose(`GET request on ${originalUrl} from ${ip}`);
app.get('/:name', ({ ip, originalUrl, params }, res) => {
sendAnalyticsAndLog(ip, originalUrl);
// begin image-serve processes
serveController
.getClaimByName(params.name)

View file

@ -1,14 +1,22 @@
const logger = require('winston');
const errorHandlers = require('../helpers/libraries/errorHandlers.js');
const showController = require('../controllers/showController.js');
const { postToStats } = require('../helpers/libraries/statsHelpers.js');
const { postToStats, sendGoogleAnalytics } = require('../helpers/libraries/statsHelpers.js');
const statsController = require('../controllers/statsController.js');
function sendAnalyticsAndLog (ip, originalUrl) {
// google analytics
sendGoogleAnalytics('show', ip, originalUrl);
// logging
logger.verbose(`POST request on ${originalUrl} from ${ip}`);
// get and serve the content
}
module.exports = (app) => {
// route to show the meme-fodder meme maker
app.get('/meme-fodder/play', ({ originalUrl, ip }, res) => {
logger.verbose(`POST request on ${originalUrl} from ${ip}`);
// get and serve the content
app.get('/meme-fodder/play', ({ ip, originalUrl }, res) => {
sendAnalyticsAndLog(ip, originalUrl);
// get and render the content
showController
.getAllClaims('meme-fodder')
.then(orderedFreePublicClaims => {
@ -20,9 +28,9 @@ module.exports = (app) => {
});
});
// route to show statistics for spee.ch
app.get('/stats', ({ originalUrl, ip }, res) => {
logger.verbose(`POST request on ${originalUrl} from ${ip}`);
// get and serve the content
app.get('/stats', ({ ip, originalUrl }, res) => {
sendAnalyticsAndLog(ip, originalUrl);
// get and render the content
statsController
.getStatsSummary()
.then(result => {
@ -34,9 +42,9 @@ module.exports = (app) => {
});
});
// route to display all free public claims at a given name
app.get('/:name/all', ({ originalUrl, params, ip }, res) => {
logger.verbose(`POST request on ${originalUrl} from ${ip}`);
// get and serve the content
app.get('/:name/all', ({ ip, originalUrl, params }, res) => {
sendAnalyticsAndLog(ip, originalUrl);
// get and render the content
showController
.getAllClaims(params.name)
.then(orderedFreePublicClaims => {

View file

@ -6,8 +6,7 @@ const expressHandlebars = require('express-handlebars');
const Handlebars = require('handlebars');
const config = require('config');
const winston = require('winston');
const ua = require('universal-analytics');
const googleApiKey = config.get('AnalyticsConfig.GoogleId');
const hostedContentPath = config.get('Database.PublishUploadPath');
// configure logging
@ -58,7 +57,7 @@ app.set('view engine', 'handlebars');
// require express routes
require('./routes/api-routes.js')(app);
require('./routes/show-routes.js')(app);
require('./routes/serve-routes.js')(app, ua, googleApiKey);
require('./routes/serve-routes.js')(app);
require('./routes/home-routes.js')(app);
// require socket.io routes