umami/pages/api/collect.ts

145 lines
3.6 KiB
TypeScript

const { Resolver } = require('dns').promises;
import isbot from 'isbot';
import ipaddr from 'ipaddr.js';
import {
createToken,
unauthorized,
send,
badRequest,
forbidden,
tooManyRequest,
} from 'next-basics';
import { savePageView, saveEvent } from 'queries';
import { useCors, useSession } from 'lib/middleware';
import { getJsonBody, getIpAddress } from 'lib/detect';
import { secret } from 'lib/crypto';
import { NextApiRequest, NextApiResponse } from 'next';
import cache from 'lib/cache';
import { Team, Website } from '@prisma/client';
export interface NextApiRequestCollect extends NextApiRequest {
session: {
error?: {
status: number;
message: string;
};
session?: {
id: string;
websiteId: string;
hostname: string;
browser: string;
os: string;
device: string;
screen: string;
language: string;
country: string;
};
website?: Website & { team?: Team };
};
}
export default async (req: NextApiRequestCollect, res: NextApiResponse) => {
await useCors(req, res);
if (isbot(req.headers['user-agent']) && !process.env.DISABLE_BOT_CHECK) {
return unauthorized(res);
}
const { type, payload } = getJsonBody(req);
const { referrer, eventName, eventData } = payload;
let { url } = payload;
// Validate eventData is JSON
if (eventData && !(typeof eventData === 'object' && !Array.isArray(eventData))) {
return badRequest(res, 'Event Data must be in the form of a JSON Object.');
}
// Validate eventData is less than 100kB
if (eventData && new TextEncoder().encode(eventData).length / 1024 > 100) {
return badRequest(res, 'Event Data exceeds maximum size of 100 kB.');
}
const ignoreIps = process.env.IGNORE_IP;
const ignoreHostnames = process.env.IGNORE_HOSTNAME;
if (ignoreIps || ignoreHostnames) {
const ips = [];
if (ignoreIps) {
ips.push(...ignoreIps.split(',').map(n => n.trim()));
}
if (ignoreHostnames) {
const resolver = new Resolver();
const promises = ignoreHostnames
.split(',')
.map(n => resolver.resolve4(n.trim()).catch(() => {}));
await Promise.all(promises).then(resolvedIps => {
ips.push(...resolvedIps.filter(n => n).flatMap(n => n));
});
}
const clientIp = getIpAddress(req);
const blocked = ips.find(ip => {
if (ip === clientIp) return true;
// CIDR notation
if (ip.indexOf('/') > 0) {
const addr = ipaddr.parse(clientIp);
const range = ipaddr.parseCIDR(ip);
if (addr.kind() === range[0].kind() && addr.match(range)) return true;
}
return false;
});
if (blocked) {
return forbidden(res);
}
}
await useSession(req, res);
const { session, website } = req.session;
// Check collection limit
if (process.env.ENABLE_COLLECT_LIMIT) {
const userId = website.userId ? website.userId : website.team.userId;
const limit = await cache.fetchCollectLimit(userId);
// To-do: Need to implement logic to find user-specific limit. Defaulted to 10k.
if (limit > 10000) {
return tooManyRequest(res, 'Collect currently exceeds monthly limit of 10000.');
}
await cache.incrementCollectLimit(userId);
}
if (process.env.REMOVE_TRAILING_SLASH) {
url = url.replace(/\/$/, '');
}
if (type === 'pageview') {
await savePageView({ ...session, url, referrer });
} else if (type === 'event') {
await saveEvent({
...session,
url,
referrer,
eventName,
eventData,
});
} else {
return badRequest(res);
}
const token = createToken(session, secret());
return send(res, token);
};