release: v0.16.0
See CHANGELOG.md for the full v0.16.0 entry. --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: ralksta <ralksta@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Claude Opus 5 <noreply@anthropic.com> Co-authored-by: Ralf <rohlenbo79@gmail.com> Co-authored-by: Paul Thies <110185070+ImScheinox@users.noreply.github.com> Co-authored-by: lancetm714 <108419425+lancetm714@users.noreply.github.com>
This commit is contained in:
Ralksta
155
app/api/analytics/__tests__/track-route.test.ts
Normal file
155
app/api/analytics/__tests__/track-route.test.ts
Normal file
@@ -0,0 +1,155 @@
|
||||
import { describe, it, expect, vi, beforeEach } from 'vitest';
|
||||
|
||||
/**
|
||||
* POST /api/analytics/track had none of the safeguards every comparable route
|
||||
* has: no rate limit, an unbounded key space (`pagePath` straight from the
|
||||
* request body becomes a permanent object key), and a plain `fs.writeFile`
|
||||
* that a process killed mid-write truncates — which the next read then
|
||||
* silently resets to zero (GHSA-w293-x8pc-j4cv).
|
||||
*/
|
||||
|
||||
vi.mock('@/lib/config', () => ({
|
||||
getConfigOrNull: vi.fn(() => ({ analytics: true })),
|
||||
}));
|
||||
|
||||
const checkRateLimit = vi.fn(
|
||||
(_ip: string, _maxRpm: number): { success: boolean; remaining: number; resetAt: number } => ({
|
||||
success: true,
|
||||
remaining: 59,
|
||||
resetAt: 0,
|
||||
}),
|
||||
);
|
||||
vi.mock('@/lib/rate-limit', () => ({
|
||||
checkRateLimit: (ip: string, maxRpm: number) => checkRateLimit(ip, maxRpm),
|
||||
getClientIp: vi.fn(() => '127.0.0.1'),
|
||||
retryAfterSeconds: vi.fn(() => 60),
|
||||
}));
|
||||
|
||||
const atomicWrite = vi.fn(async (_filePath: string, _content: string): Promise<void> => undefined);
|
||||
vi.mock('@/lib/atomicWrite', () => ({
|
||||
atomicWrite: (filePath: string, content: string) => atomicWrite(filePath, content),
|
||||
}));
|
||||
|
||||
let fixtureAnalytics: unknown = null;
|
||||
vi.mock('fs/promises', () => ({
|
||||
default: {
|
||||
readFile: vi.fn(async () => {
|
||||
if (fixtureAnalytics === null) throw Object.assign(new Error('ENOENT'), { code: 'ENOENT' });
|
||||
return JSON.stringify(fixtureAnalytics);
|
||||
}),
|
||||
mkdir: vi.fn(async () => undefined),
|
||||
},
|
||||
}));
|
||||
|
||||
import { POST } from '../track/route';
|
||||
import { getConfigOrNull } from '@/lib/config';
|
||||
|
||||
const mockConfig = getConfigOrNull as unknown as ReturnType<typeof vi.fn>;
|
||||
|
||||
const post = (body: unknown) =>
|
||||
POST(
|
||||
new Request('http://localhost/api/analytics/track', {
|
||||
method: 'POST',
|
||||
body: JSON.stringify(body),
|
||||
headers: { 'user-agent': 'Mozilla/5.0 (X11; Linux x86_64)' },
|
||||
}) as never,
|
||||
);
|
||||
|
||||
const savedData = () => {
|
||||
const call = atomicWrite.mock.calls.at(-1);
|
||||
return JSON.parse(String(call?.[1]));
|
||||
};
|
||||
|
||||
beforeEach(() => {
|
||||
vi.clearAllMocks();
|
||||
checkRateLimit.mockReturnValue({ success: true, remaining: 59, resetAt: 0 });
|
||||
mockConfig.mockReturnValue({ analytics: true });
|
||||
fixtureAnalytics = null;
|
||||
});
|
||||
|
||||
describe('POST /api/analytics/track', () => {
|
||||
it('records a pageview and writes through atomicWrite, not a raw write', async () => {
|
||||
const res = await post({ path: '/deutschland/kloster-chorin' });
|
||||
expect(res.status).toBe(200);
|
||||
|
||||
expect(atomicWrite).toHaveBeenCalledOnce();
|
||||
const data = savedData();
|
||||
expect(data.summary.totalViews).toBe(1);
|
||||
const [dateKey] = Object.keys(data.days);
|
||||
expect(data.days[dateKey].pages['/deutschland/kloster-chorin']).toBe(1);
|
||||
});
|
||||
|
||||
it('is rate-limited per IP', async () => {
|
||||
checkRateLimit.mockReturnValue({ success: false, remaining: 0, resetAt: Date.now() + 60_000 });
|
||||
|
||||
const res = await post({ path: '/' });
|
||||
|
||||
expect(res.status).toBe(429);
|
||||
expect(res.headers.get('Retry-After')).toBeTruthy();
|
||||
expect(atomicWrite).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('truncates a path far longer than any real route', async () => {
|
||||
const huge = '/' + 'a'.repeat(1000);
|
||||
await post({ path: huge });
|
||||
|
||||
const data = savedData();
|
||||
const [dateKey] = Object.keys(data.days);
|
||||
const keys = Object.keys(data.days[dateKey].pages);
|
||||
expect(keys).toHaveLength(1);
|
||||
expect(keys[0].length).toBeLessThanOrEqual(200);
|
||||
});
|
||||
|
||||
it('drops the query string from the path', async () => {
|
||||
await post({ path: '/journal?utm_source=newsletter' });
|
||||
|
||||
const data = savedData();
|
||||
const [dateKey] = Object.keys(data.days);
|
||||
expect(Object.keys(data.days[dateKey].pages)).toEqual(['/journal']);
|
||||
});
|
||||
|
||||
it('caps distinct page keys per day without dropping the pageview itself', async () => {
|
||||
const dateKey = new Date().toISOString().split('T')[0];
|
||||
const pages: Record<string, number> = {};
|
||||
for (let i = 0; i < 500; i++) pages[`/existing-${i}`] = 1;
|
||||
fixtureAnalytics = {
|
||||
summary: { totalViews: 500, lastUpdated: '' },
|
||||
days: { [dateKey]: { pageviews: 500, pages, devices: {} } },
|
||||
};
|
||||
|
||||
const res = await post({ path: '/one-path-too-many' });
|
||||
expect(res.status).toBe(200);
|
||||
|
||||
const data = savedData();
|
||||
// The day's total still counts this visit...
|
||||
expect(data.days[dateKey].pageviews).toBe(501);
|
||||
// ...but the 501st distinct path did not get its own key.
|
||||
expect(Object.keys(data.days[dateKey].pages)).toHaveLength(500);
|
||||
expect(data.days[dateKey].pages['/one-path-too-many']).toBeUndefined();
|
||||
});
|
||||
|
||||
it('still increments an already-tracked path past the cap', async () => {
|
||||
const dateKey = new Date().toISOString().split('T')[0];
|
||||
const pages: Record<string, number> = { '/journal': 10 };
|
||||
for (let i = 0; i < 500; i++) pages[`/existing-${i}`] = 1;
|
||||
fixtureAnalytics = {
|
||||
summary: { totalViews: 510, lastUpdated: '' },
|
||||
days: { [dateKey]: { pageviews: 510, pages, devices: {} } },
|
||||
};
|
||||
|
||||
await post({ path: '/journal' });
|
||||
|
||||
const data = savedData();
|
||||
expect(data.days[dateKey].pages['/journal']).toBe(11);
|
||||
});
|
||||
|
||||
it('does nothing when analytics are disabled', async () => {
|
||||
mockConfig.mockReturnValue({ analytics: false });
|
||||
|
||||
const res = await post({ path: '/' });
|
||||
const body = await res.json();
|
||||
|
||||
expect(body.trackingDisabled).toBe(true);
|
||||
expect(atomicWrite).not.toHaveBeenCalled();
|
||||
});
|
||||
});
|
||||
@@ -1,11 +1,28 @@
|
||||
import { NextResponse } from 'next/server';
|
||||
import { NextRequest, NextResponse } from 'next/server';
|
||||
import fs from 'fs/promises';
|
||||
import path from 'path';
|
||||
import { getConfigOrNull } from '@/lib/config';
|
||||
import { atomicWrite } from '@/lib/atomicWrite';
|
||||
import { checkRateLimit, getClientIp, retryAfterSeconds } from '@/lib/rate-limit';
|
||||
|
||||
const CONTENT_DIR = path.join(process.cwd(), 'content');
|
||||
const ANALYTICS_FILE = path.join(CONTENT_DIR, 'analytics.json');
|
||||
|
||||
/** Requests per minute per IP. One real pageview fires this once. */
|
||||
const ANALYTICS_RPM = 60;
|
||||
|
||||
/**
|
||||
* Distinct page paths tracked per day. Every route this comparably-sized site
|
||||
* has, many times over — high enough that no real page is ever dropped, low
|
||||
* enough that a flood of made-up paths cannot grow the file without bound.
|
||||
* A path over the cap still counts toward the day's total pageviews; it just
|
||||
* does not get its own key.
|
||||
*/
|
||||
const MAX_PAGES_PER_DAY = 500;
|
||||
|
||||
/** Well past any real route on this app; anything longer is not a path someone navigated to. */
|
||||
const MAX_PATH_LENGTH = 200;
|
||||
|
||||
interface AnalyticsData {
|
||||
summary: {
|
||||
totalViews: number;
|
||||
@@ -33,41 +50,76 @@ async function getAnalytics(): Promise<AnalyticsData> {
|
||||
async function saveAnalytics(data: AnalyticsData) {
|
||||
try {
|
||||
await fs.mkdir(CONTENT_DIR, { recursive: true });
|
||||
await fs.writeFile(ANALYTICS_FILE, JSON.stringify(data, null, 2), 'utf8');
|
||||
// Temp-file + rename, not a plain write: a process killed mid-write used
|
||||
// to truncate the file, and a truncated (unparseable) file made the next
|
||||
// getAnalytics() silently reset every count to zero.
|
||||
await atomicWrite(ANALYTICS_FILE, JSON.stringify(data, null, 2));
|
||||
} catch (err) {
|
||||
console.error('[Analytics] Failed to save analytics data:', err);
|
||||
}
|
||||
}
|
||||
|
||||
export async function POST(req: Request) {
|
||||
/**
|
||||
* Serializes the read-modify-write below within this process. Two concurrent
|
||||
* requests each reading the file, incrementing their own in-memory copy and
|
||||
* writing it back would silently drop whichever one wrote last — the file's
|
||||
* own atomicity (saveAnalytics above) does not cover that race, only the
|
||||
* write itself.
|
||||
*/
|
||||
let writeQueue: Promise<void> = Promise.resolve();
|
||||
|
||||
export async function POST(req: NextRequest) {
|
||||
try {
|
||||
const config = getConfigOrNull();
|
||||
if (config?.analytics === false) {
|
||||
return NextResponse.json({ ok: true, trackingDisabled: true });
|
||||
}
|
||||
|
||||
const body = await req.json();
|
||||
const pagePath = (body.path || '/').split('?')[0];
|
||||
const ip = getClientIp(req);
|
||||
const { success, resetAt } = checkRateLimit(`analytics:${ip}`, ANALYTICS_RPM);
|
||||
if (!success) {
|
||||
return NextResponse.json(
|
||||
{ error: 'Too many requests' },
|
||||
{
|
||||
status: 429,
|
||||
headers: { 'Retry-After': String(retryAfterSeconds(resetAt)), 'Cache-Control': 'no-store' },
|
||||
},
|
||||
);
|
||||
}
|
||||
|
||||
const body = await req.json().catch(() => null);
|
||||
const rawPath = typeof body?.path === 'string' ? body.path : '/';
|
||||
const pagePath = (rawPath.split('?')[0].slice(0, MAX_PATH_LENGTH) || '/') as string;
|
||||
const userAgent = req.headers.get('user-agent') || '';
|
||||
const isMobile = /mobile|iphone|ipad|android/i.test(userAgent);
|
||||
const deviceType = isMobile ? 'mobile' : 'desktop';
|
||||
|
||||
const dateKey = new Date().toISOString().split('T')[0];
|
||||
const data = await getAnalytics();
|
||||
|
||||
data.summary.totalViews = (data.summary.totalViews || 0) + 1;
|
||||
data.summary.lastUpdated = new Date().toISOString();
|
||||
const run = writeQueue.then(async () => {
|
||||
const data = await getAnalytics();
|
||||
|
||||
if (!data.days[dateKey]) {
|
||||
data.days[dateKey] = { pageviews: 0, pages: {}, devices: {} };
|
||||
}
|
||||
data.summary.totalViews = (data.summary.totalViews || 0) + 1;
|
||||
data.summary.lastUpdated = new Date().toISOString();
|
||||
|
||||
const dayObj = data.days[dateKey];
|
||||
dayObj.pageviews = (dayObj.pageviews || 0) + 1;
|
||||
dayObj.pages[pagePath] = (dayObj.pages[pagePath] || 0) + 1;
|
||||
dayObj.devices[deviceType] = (dayObj.devices[deviceType] || 0) + 1;
|
||||
if (!data.days[dateKey]) {
|
||||
data.days[dateKey] = { pageviews: 0, pages: {}, devices: {} };
|
||||
}
|
||||
|
||||
const dayObj = data.days[dateKey];
|
||||
dayObj.pageviews = (dayObj.pageviews || 0) + 1;
|
||||
dayObj.devices[deviceType] = (dayObj.devices[deviceType] || 0) + 1;
|
||||
|
||||
// An already-tracked path may still increment past the cap; only a
|
||||
// brand-new key is refused once the day is full.
|
||||
if (dayObj.pages[pagePath] !== undefined || Object.keys(dayObj.pages).length < MAX_PAGES_PER_DAY) {
|
||||
dayObj.pages[pagePath] = (dayObj.pages[pagePath] || 0) + 1;
|
||||
}
|
||||
|
||||
await saveAnalytics(data);
|
||||
});
|
||||
writeQueue = run.catch(() => {});
|
||||
await run;
|
||||
|
||||
await saveAnalytics(data);
|
||||
return NextResponse.json({ ok: true });
|
||||
} catch {
|
||||
return NextResponse.json({ error: 'Failed to record tracking' }, { status: 500 });
|
||||
|
||||
Reference in New Issue
Block a user