π Open source, privacy-first web analytics β a cookie-less Google Analytics alternative with built-in error tracking and performance monitoring. Self-host it or use our cloud. Get started for free!
TypeScript chartsclickhousedockergdprgoogle-analyticsmetricsmonitoringmysqlnestjsprivacyredisself-hostedselfhostedstatisticstailwindcssweb-analyticswebanalyticswebsite
import {
CanActivate,
ExecutionContext,
ForbiddenException,
Injectable,
} from '@nestjs/common'
import { isbot } from 'isbot'
import { ProjectService } from '../../project/project.service'
import { checkRateLimit, getIPDetails } from '../../common/utils'
import { AppLoggerService } from '../../logger/logger.service'
import { getTrustworthyIp, getSinglePid } from './analytics-read.util'
const READ_RATE_LIMIT = 300 // requests per rate window
const AUTHED_READ_RATE_LIMIT = 3000 // requests per rate window
const READ_RATE_WINDOW = 60 // seconds
const BLOCK_DATACENTER_READS =
process.env.ANALYTICS_BLOCK_DATACENTER_READS === 'true'
@Injectable()
export class AnalyticsReadGuard implements CanActivate {
constructor(
private readonly projectService: ProjectService,
private readonly logger: AppLoggerService,
) {}
async canActivate(context: ExecutionContext): Promise<boolean> {
const req = context.switchToHttp().getRequest()
// Only police read (GET) traffic
if (req.method !== 'GET') {
return true
}
// API-key requests are metered separately, per plan
if (req.headers['x-api-key']) {
return true
}
// Logged-in requests - limiting by userId on a more generous limit
const uid = req.user?.sub || req.user?.id || null
if (uid) {
if (AUTHED_READ_RATE_LIMIT > 0) {
await checkRateLimit(
String(uid),
'analytics-read-user',
AUTHED_READ_RATE_LIMIT,
READ_RATE_WINDOW,
)
}
return true
}
let isPublicProject = false
try {
const pid = getSinglePid(req.query || {}, req.params || {})
if (pid) {
const project = await this.projectService.getRedisProject(pid)
isPublicProject = Boolean(project?.public)
}
} catch (reason) {
this.logger.warn(
`AnalyticsReadGuard soft-failed: ${reason}`,
'AnalyticsReadGuard',
)
return true
}
if (!isPublicProject) {
return true
}
// --- Public-project protections only below this line ---
// Bot user-agents never legitimately view a public dashboard
const userAgent = String(req.headers['user-agent'] || '')
if (userAgent && isbot(userAgent)) {
throw new ForbiddenException(
'Automated traffic is not permitted for this resource',
)
}
// The real visitor IP, or '' when only a proxy IP is visible (so we never
// rate-limit or geo-check the shared proxy address)
const ip = getTrustworthyIp(req)
if (BLOCK_DATACENTER_READS && ip) {
try {
if (getIPDetails(ip).isHosting) {
throw new ForbiddenException(
'Automated traffic is not permitted for this resource',
)
}
} catch (reason) {
if (reason instanceof ForbiddenException) {
throw reason
}
// GeoIP lookup failed β ignore, fail open.
}
}
// Opt-in per-IP limit, public projects only, real client IP only.
if (READ_RATE_LIMIT && ip) {
await checkRateLimit(
ip,
'analytics-read',
READ_RATE_LIMIT,
READ_RATE_WINDOW,
)
}
return true
}
}