Files
backspace/packages/server/src/routes/admin.test.ts
T
Jannis Braun 2f0940c30b feat(admin): manual cleanup of stale tus upload sessions + visibility
Adds an admin-driven sweep on top of the existing 24h auto-expire so
operators can see and reap abandoned `.tus/` sessions without waiting.

- storageJanitor: extract `walkTusDir(predicate)` helper, add
  `getStaleTusInfo` + `cleanupStaleTusSessions(thresholdMs, dryRun)`;
  refactor `cleanupTusStragglers` to delegate while preserving its
  janitor-tick `{ removed }` contract.
- StorageStats gains `staleTusSessions` + `staleTusSize` (fixed 1h
  display threshold).
- New `POST /api/admin/storage/cleanup-tus` route with
  `maxAgeHours` validation (positive finite number, default 1) and
  `dryRun` support; admin-gated.
- StoragePanel: 6th overview card "Stale Uploads" + new cleanup
  subsection mirroring the media-cleanup pattern (preview-then-clean
  with shared result panel styling).
- Tests: 8 new janitor tests covering empty dir, threshold filtering,
  dry-run vs live, oldest-mtime tracking, subdir skipping, and the
  override path on the existing straggler sweep. New
  `routes/admin.test.ts` covers auth/admin gates, validation (zero,
  negative, NaN), default `maxAgeHours`, dry-run vs live unlink.
- Docs: `uploads.md` §Janitor expanded to the full lifecycle (cancel
  DELETE, discard DELETE, auto-expire, straggler sweep, admin route);
  `admin.md` Storage Management updated with the new endpoint and
  StorageStats fields.
2026-05-02 18:44:19 +02:00

235 lines
7.1 KiB
TypeScript

import { describe, it, expect, beforeEach, afterEach, vi } from 'vitest';
import Fastify, { type FastifyInstance } from 'fastify';
import Database from 'better-sqlite3';
import { drizzle } from 'drizzle-orm/better-sqlite3';
import fs from 'node:fs';
import path from 'node:path';
import os from 'node:os';
import crypto from 'node:crypto';
import { fileURLToPath } from 'node:url';
import * as schema from '../db/schema.js';
import { setWorkerId } from '../utils/snowflake.js';
import { signJwt } from '../utils/auth.js';
setWorkerId(11);
const __dirname = path.dirname(fileURLToPath(import.meta.url));
type TestDb = ReturnType<typeof drizzle<typeof schema>>;
let sqlite: Database.Database;
let testDb: TestDb;
let app: FastifyInstance;
let tusTmpDir: string;
vi.mock('../db/index.js', () => ({
getDb: () => testDb,
getRawDb: () => sqlite,
schema,
}));
vi.mock('../config.js', async () => {
const real = await import('../config.js');
return {
config: new Proxy(real.config, {
get(target, prop: string) {
if (prop === 'tusUploadDir') return tusTmpDir;
return (target as Record<string, unknown>)[prop];
},
}),
};
});
function applyMigrations(db: Database.Database): void {
const migrationsDir = path.resolve(__dirname, '../../drizzle');
const files = fs.readdirSync(migrationsDir).filter(f => f.endsWith('.sql')).sort();
for (const f of files) {
const sqlText = fs.readFileSync(path.join(migrationsDir, f), 'utf8');
const statements = sqlText.split(/-->\s*statement-breakpoint/);
for (const stmt of statements) {
const clean = stmt.trim();
if (clean) db.exec(clean);
}
}
}
async function buildApp(): Promise<FastifyInstance> {
const { adminRoutes } = await import('./admin.js');
const f = Fastify();
await f.register(adminRoutes);
return f;
}
const ADMIN_ID = 'admin-1';
const USER_ID = 'user-1';
const ADMIN_USERNAME = 'admin';
const USER_USERNAME = 'normie';
beforeEach(async () => {
sqlite = new Database(':memory:');
sqlite.pragma('foreign_keys = ON');
applyMigrations(sqlite);
testDb = drizzle(sqlite, { schema });
testDb.insert(schema.users).values([
{
id: ADMIN_ID,
username: ADMIN_USERNAME,
passwordHash: 'x',
isAdmin: 1,
createdAt: Date.now(),
},
{
id: USER_ID,
username: USER_USERNAME,
passwordHash: 'x',
isAdmin: 0,
createdAt: Date.now(),
},
]).run();
tusTmpDir = path.join(os.tmpdir(), `backspace-admin-tus-${crypto.randomBytes(8).toString('hex')}`);
app = await buildApp();
});
afterEach(() => {
if (fs.existsSync(tusTmpDir)) {
fs.rmSync(tusTmpDir, { recursive: true, force: true });
}
});
function adminToken(): string {
return signJwt({ userId: ADMIN_ID, username: ADMIN_USERNAME });
}
function userToken(): string {
return signJwt({ userId: USER_ID, username: USER_USERNAME });
}
describe('POST /api/admin/storage/cleanup-tus', () => {
it('rejects unauthenticated requests with 401', async () => {
const res = await app.inject({
method: 'POST',
url: '/api/admin/storage/cleanup-tus',
payload: { maxAgeHours: 1, dryRun: true },
});
expect(res.statusCode).toBe(401);
});
it('rejects non-admin requests with 403', async () => {
const res = await app.inject({
method: 'POST',
url: '/api/admin/storage/cleanup-tus',
headers: { Authorization: `Bearer ${userToken()}` },
payload: { maxAgeHours: 1, dryRun: true },
});
expect(res.statusCode).toBe(403);
});
it('returns 400 when maxAgeHours is zero', async () => {
const res = await app.inject({
method: 'POST',
url: '/api/admin/storage/cleanup-tus',
headers: { Authorization: `Bearer ${adminToken()}` },
payload: { maxAgeHours: 0, dryRun: true },
});
expect(res.statusCode).toBe(400);
});
it('returns 400 when maxAgeHours is negative', async () => {
const res = await app.inject({
method: 'POST',
url: '/api/admin/storage/cleanup-tus',
headers: { Authorization: `Bearer ${adminToken()}` },
payload: { maxAgeHours: -3, dryRun: true },
});
expect(res.statusCode).toBe(400);
});
it('returns 400 when maxAgeHours is NaN/non-finite', async () => {
const res = await app.inject({
method: 'POST',
url: '/api/admin/storage/cleanup-tus',
headers: { Authorization: `Bearer ${adminToken()}` },
payload: { maxAgeHours: 'banana', dryRun: true },
});
expect(res.statusCode).toBe(400);
});
it('returns CleanupResult shape with zeros when .tus/ is empty', async () => {
const res = await app.inject({
method: 'POST',
url: '/api/admin/storage/cleanup-tus',
headers: { Authorization: `Bearer ${adminToken()}` },
payload: { maxAgeHours: 1, dryRun: false },
});
expect(res.statusCode).toBe(200);
const body = res.json();
expect(body).toMatchObject({
dryRun: false,
deletedFiles: 0,
freedBytes: 0,
deletedAttachmentRecords: 0,
errors: [],
});
});
it('dryRun=true returns counts without unlinking', async () => {
fs.mkdirSync(tusTmpDir, { recursive: true });
const stale = path.join(tusTmpDir, 'stale-session');
fs.writeFileSync(stale, 'x'.repeat(64));
const twoHoursAgo = Date.now() - 2 * 60 * 60 * 1000;
fs.utimesSync(stale, twoHoursAgo / 1000, twoHoursAgo / 1000);
const res = await app.inject({
method: 'POST',
url: '/api/admin/storage/cleanup-tus',
headers: { Authorization: `Bearer ${adminToken()}` },
payload: { maxAgeHours: 1, dryRun: true },
});
expect(res.statusCode).toBe(200);
const body = res.json();
expect(body.dryRun).toBe(true);
expect(body.deletedFiles).toBe(1);
expect(body.freedBytes).toBe(64);
expect(fs.existsSync(stale)).toBe(true);
});
it('dryRun=false unlinks stale entries', async () => {
fs.mkdirSync(tusTmpDir, { recursive: true });
const stale = path.join(tusTmpDir, 'stale-session');
fs.writeFileSync(stale, 'y'.repeat(128));
const threeHoursAgo = Date.now() - 3 * 60 * 60 * 1000;
fs.utimesSync(stale, threeHoursAgo / 1000, threeHoursAgo / 1000);
const res = await app.inject({
method: 'POST',
url: '/api/admin/storage/cleanup-tus',
headers: { Authorization: `Bearer ${adminToken()}` },
payload: { maxAgeHours: 1, dryRun: false },
});
expect(res.statusCode).toBe(200);
const body = res.json();
expect(body.dryRun).toBe(false);
expect(body.deletedFiles).toBe(1);
expect(body.freedBytes).toBe(128);
expect(fs.existsSync(stale)).toBe(false);
});
it('defaults maxAgeHours to 1 when omitted', async () => {
fs.mkdirSync(tusTmpDir, { recursive: true });
const stale = path.join(tusTmpDir, 'stale-90min');
fs.writeFileSync(stale, 'z'.repeat(32));
const ninetyMinAgo = Date.now() - 90 * 60 * 1000;
fs.utimesSync(stale, ninetyMinAgo / 1000, ninetyMinAgo / 1000);
const res = await app.inject({
method: 'POST',
url: '/api/admin/storage/cleanup-tus',
headers: { Authorization: `Bearer ${adminToken()}` },
payload: { dryRun: true },
});
expect(res.statusCode).toBe(200);
const body = res.json();
expect(body.deletedFiles).toBe(1);
});
});