feat: add tracker and tracker build script

This commit is contained in:
moonrailgun 2023-09-03 03:49:44 +08:00
parent 84c663985a
commit 55463ac17f
3 changed files with 276 additions and 1 deletions

View File

@ -5,7 +5,8 @@
"scripts": {
"dev": "nodemon src/server/main.ts -w src/server",
"start": "NODE_ENV=production ts-node src/server/main.ts",
"build": "vite build",
"build": "vite build && pnpm build:tracker",
"build:tracker": "ts-node scripts/build-tracker.ts",
"db:push": "prisma db push",
"db:generate": "prisma generate",
"db:studio": "prisma studio"

20
scripts/build-tracker.ts Normal file
View File

@ -0,0 +1,20 @@
import { resolve } from 'path';
import vite from 'vite';
console.log('Start Build Tracker');
vite
.build({
build: {
lib: {
entry: resolve(__dirname, '../src/tracker/index.js'),
name: 'tianji',
fileName: () => 'tracker.js',
formats: ['iife'],
},
emptyOutDir: false,
},
})
.then((res) => {
console.log('Build Tracker Completed');
});

254
src/tracker/index.js Normal file
View File

@ -0,0 +1,254 @@
/**
* Fork from https://github.com/umami-software/umami/blob/master/src/tracker/index.js
*/
((window) => {
const {
screen: { width, height },
navigator: { language },
location,
localStorage,
document,
history,
} = window;
const { hostname, pathname, search } = location;
const { currentScript } = document;
if (!currentScript) return;
const _data = 'data-';
const _false = 'false';
const attr = currentScript.getAttribute.bind(currentScript);
const website = attr(_data + 'website-id');
const hostUrl = attr(_data + 'host-url');
const autoTrack = attr(_data + 'auto-track') !== _false;
const dnt = attr(_data + 'do-not-track');
const domain = attr(_data + 'domains') || '';
const domains = domain.split(',').map((n) => n.trim());
const root = hostUrl
? hostUrl.replace(/\/$/, '')
: currentScript.src.split('/').slice(0, -1).join('/');
const endpoint = `${root}/api/send`;
const screen = `${width}x${height}`;
const eventRegex = /data-tianji-event-([\w-_]+)/;
const eventNameAttribute = _data + 'tianji-event';
const delayDuration = 300;
/* Helper functions */
const hook = (_this, method, callback) => {
const orig = _this[method];
return (...args) => {
callback.apply(null, args);
return orig.apply(_this, args);
};
};
const getPath = (url) => {
if (url.substring(0, 4) === 'http') {
return '/' + url.split('/').splice(3).join('/');
}
return url;
};
const getPayload = () => ({
website,
hostname,
screen,
language,
title,
url: currentUrl,
referrer: currentRef,
});
/* Tracking functions */
const doNotTrack = () => {
const { doNotTrack, navigator, external } = window;
const msTrackProtection = 'msTrackingProtectionEnabled';
const msTracking = () => {
return (
external &&
msTrackProtection in external &&
external[msTrackProtection]()
);
};
const dnt =
doNotTrack ||
navigator.doNotTrack ||
navigator.msDoNotTrack ||
msTracking();
return dnt == '1' || dnt === 'yes';
};
const trackingDisabled = () =>
(localStorage && localStorage.getItem('tianji.disabled')) ||
(dnt && doNotTrack()) ||
(domain && !domains.includes(hostname));
const handlePush = (state, title, url) => {
if (!url) return;
currentRef = currentUrl;
currentUrl = getPath(url.toString());
if (currentUrl !== currentRef) {
setTimeout(track, delayDuration);
}
};
const handleClick = () => {
const trackElement = (el) => {
const attr = el.getAttribute.bind(el);
const eventName = attr(eventNameAttribute);
if (eventName) {
const eventData = {};
el.getAttributeNames().forEach((name) => {
const match = name.match(eventRegex);
if (match) {
eventData[match[1]] = attr(name);
}
});
return track(eventName, eventData);
}
return Promise.resolve();
};
const callback = (e) => {
const findATagParent = (rootElem, maxSearchDepth) => {
let currentElement = rootElem;
for (let i = 0; i < maxSearchDepth; i++) {
if (currentElement.tagName === 'A') {
return currentElement;
}
currentElement = currentElement.parentElement;
if (!currentElement) {
return null;
}
}
return null;
};
const el = e.target;
const anchor = el.tagName === 'A' ? el : findATagParent(el, 10);
if (anchor) {
const { href, target } = anchor;
const external =
target === '_blank' ||
e.ctrlKey ||
e.shiftKey ||
e.metaKey ||
(e.button && e.button === 1);
const eventName = anchor.getAttribute(eventNameAttribute);
if (eventName && href) {
if (!external) {
e.preventDefault();
}
return trackElement(anchor).then(() => {
if (!external) location.href = href;
});
}
} else {
trackElement(el);
}
};
document.addEventListener('click', callback, true);
};
const observeTitle = () => {
const callback = ([entry]) => {
title = entry && entry.target ? entry.target.text : undefined;
};
const observer = new MutationObserver(callback);
const node = document.querySelector('head > title');
if (node) {
observer.observe(node, {
subtree: true,
characterData: true,
childList: true,
});
}
};
const send = (payload, type = 'event') => {
if (trackingDisabled()) return;
const headers = {
'Content-Type': 'application/json',
};
if (typeof cache !== 'undefined') {
headers['x-tianji-cache'] = cache;
}
return fetch(endpoint, {
method: 'POST',
body: JSON.stringify({ type, payload }),
headers,
})
.then((res) => res.text())
.then((text) => (cache = text));
};
const track = (obj, data) => {
if (typeof obj === 'string') {
return send({
...getPayload(),
name: obj,
data: typeof data === 'object' ? data : undefined,
});
} else if (typeof obj === 'object') {
return send(obj);
} else if (typeof obj === 'function') {
return send(obj(getPayload()));
}
return send(getPayload());
};
const identify = (data) => send({ ...getPayload(), data }, 'identify');
/* Start */
if (!window.tianji) {
window.tianji = {
track,
identify,
};
}
let currentUrl = `${pathname}${search}`;
let currentRef = document.referrer;
let title = document.title;
let cache;
let initialized;
if (autoTrack && !trackingDisabled()) {
history.pushState = hook(history, 'pushState', handlePush);
history.replaceState = hook(history, 'replaceState', handlePush);
handleClick();
observeTitle();
const init = () => {
if (document.readyState === 'complete' && !initialized) {
track();
initialized = true;
}
};
document.addEventListener('readystatechange', init, true);
init();
}
})(window);