@mars-stack/cli 0.2.0 → 1.0.2

package/template/.cursor/skills/add-audit-log/SKILL.md

@@ -0,0 +1,375 @@
+# Skill: Add Audit Log
+
+Add user action tracking with a Prisma `AuditLog` model, server-side logging helper, admin view, and retention policy.
+
+## When to Use
+
+Use this skill when the user asks to add audit logging, activity tracking, compliance logging, user action history, or admin activity monitoring.
+
+## Prerequisites
+
+- Read `src/lib/mars.ts` to check available auth wrappers.
+- Read `prisma/schema/` to see existing models.
+
+## Step 1: Prisma Schema
+
+```prisma
+// prisma/schema/audit-log.prisma
+model AuditLog {
+  id           String   @id @default(cuid())
+  userId       String?
+  action       String
+  resourceType String
+  resourceId   String?
+  metadata     Json?
+  ipAddress    String?
+  userAgent    String?
+  timestamp    DateTime @default(now())
+
+  user User? @relation(fields: [userId], references: [id], onDelete: SetNull)
+
+  @@index([userId])
+  @@index([action])
+  @@index([resourceType])
+  @@index([resourceType, resourceId])
+  @@index([timestamp])
+}
+```
+
+Update the User model in `prisma/schema/auth.prisma` to add the relation:
+
+```prisma
+model User {
+  // ... existing fields
+  auditLogs AuditLog[]
+}
+```
+
+Run `yarn db:push` to sync.
+
+## Step 2: Audit Log Types
+
+```typescript
+// src/features/audit-log/types.ts
+export interface AuditEventInput {
+  userId?: string;
+  action: AuditAction;
+  resourceType: string;
+  resourceId?: string;
+  metadata?: Record<string, unknown>;
+  ipAddress?: string;
+  userAgent?: string;
+}
+
+export type AuditAction =
+  | 'create'
+  | 'read'
+  | 'update'
+  | 'delete'
+  | 'login'
+  | 'logout'
+  | 'login_failed'
+  | 'password_change'
+  | 'password_reset'
+  | 'email_verify'
+  | 'role_change'
+  | 'export'
+  | 'invite'
+  | 'settings_change';
+
+export interface AuditLogQuery {
+  userId?: string;
+  action?: AuditAction;
+  resourceType?: string;
+  resourceId?: string;
+  startDate?: Date;
+  endDate?: Date;
+  limit?: number;
+  cursor?: string;
+}
+```
+
+## Step 3: Server-Side Audit Logger
+
+```typescript
+// src/features/audit-log/server/index.ts
+import 'server-only';
+
+import { prisma } from '@/lib/prisma';
+import { apiLogger } from '@/lib/mars';
+import type { AuditEventInput, AuditLogQuery } from '../types';
+
+export async function logAuditEvent(event: AuditEventInput): Promise<void> {
+  try {
+    await prisma.auditLog.create({
+      data: {
+        userId: event.userId,
+        action: event.action,
+        resourceType: event.resourceType,
+        resourceId: event.resourceId,
+        metadata: event.metadata ?? undefined,
+        ipAddress: event.ipAddress,
+        userAgent: event.userAgent,
+      },
+    });
+  } catch (error) {
+    apiLogger.error({ error, event: event.action }, 'Failed to write audit log');
+  }
+}
+
+export function logAuditEventFromRequest(
+  request: Request,
+  event: Omit<AuditEventInput, 'ipAddress' | 'userAgent'>,
+): Promise<void> {
+  return logAuditEvent({
+    ...event,
+    ipAddress: request.headers.get('x-forwarded-for')?.split(',')[0]?.trim()
+      ?? request.headers.get('x-real-ip')
+      ?? undefined,
+    userAgent: request.headers.get('user-agent') ?? undefined,
+  });
+}
+
+export async function queryAuditLogs(query: AuditLogQuery) {
+  const where: Record<string, unknown> = {};
+
+  if (query.userId) where.userId = query.userId;
+  if (query.action) where.action = query.action;
+  if (query.resourceType) where.resourceType = query.resourceType;
+  if (query.resourceId) where.resourceId = query.resourceId;
+
+  if (query.startDate || query.endDate) {
+    where.timestamp = {};
+    if (query.startDate) (where.timestamp as Record<string, unknown>).gte = query.startDate;
+    if (query.endDate) (where.timestamp as Record<string, unknown>).lte = query.endDate;
+  }
+
+  const take = Math.min(query.limit ?? 50, 100);
+
+  return prisma.auditLog.findMany({
+    where,
+    orderBy: { timestamp: 'desc' },
+    take,
+    ...(query.cursor ? { skip: 1, cursor: { id: query.cursor } } : {}),
+    include: {
+      user: { select: { id: true, email: true, name: true } },
+    },
+  });
+}
+
+export async function cleanupOldAuditLogs(retentionDays: number = 90): Promise<number> {
+  const cutoff = new Date();
+  cutoff.setDate(cutoff.getDate() - retentionDays);
+
+  const result = await prisma.auditLog.deleteMany({
+    where: { timestamp: { lt: cutoff } },
+  });
+
+  apiLogger.info({ deleted: result.count, retentionDays }, 'Audit log cleanup completed');
+  return result.count;
+}
+```
+
+## Step 4: Usage in API Routes
+
+Integrate audit logging into existing route handlers:
+
+```typescript
+// Example: in an existing update route
+import { logAuditEventFromRequest } from '@/features/audit-log/server';
+
+export const PUT = withAuth(async (request, { params }) => {
+  try {
+    const { id } = await params;
+    const body = updateSchema.parse(await request.json());
+    const updated = await updateResource(request.session.userId, id, body);
+
+    await logAuditEventFromRequest(request, {
+      userId: request.session.userId,
+      action: 'update',
+      resourceType: 'widget',
+      resourceId: id,
+      metadata: { fields: Object.keys(body) },
+    });
+
+    return NextResponse.json(updated);
+  } catch (error) {
+    return handleApiError(error, { endpoint: '/api/protected/widgets/[id]' });
+  }
+});
+```
+
+### Auth event logging
+
+```typescript
+// In login route: src/app/api/auth/login/route.ts
+await logAuditEventFromRequest(request, {
+  userId: user.id,
+  action: 'login',
+  resourceType: 'session',
+});
+
+// On failed login
+await logAuditEventFromRequest(request, {
+  action: 'login_failed',
+  resourceType: 'auth',
+  metadata: { email: body.email },
+});
+```
+
+## Step 5: Admin Audit Log API
+
+```typescript
+// src/app/api/protected/admin/audit-logs/route.ts
+import { handleApiError, withRole } from '@/lib/mars';
+import { queryAuditLogs } from '@/features/audit-log/server';
+import { NextResponse } from 'next/server';
+import { z } from 'zod';
+
+const querySchema = z.object({
+  userId: z.string().optional(),
+  action: z.string().optional(),
+  resourceType: z.string().optional(),
+  resourceId: z.string().optional(),
+  startDate: z.coerce.date().optional(),
+  endDate: z.coerce.date().optional(),
+  limit: z.coerce.number().int().min(1).max(100).optional(),
+  cursor: z.string().optional(),
+});
+
+export const GET = withRole(['admin'], async (request) => {
+  try {
+    const url = new URL(request.url);
+    const query = querySchema.parse(Object.fromEntries(url.searchParams));
+    const logs = await queryAuditLogs(query);
+    return NextResponse.json(logs);
+  } catch (error) {
+    return handleApiError(error, { endpoint: '/api/protected/admin/audit-logs' });
+  }
+});
+```
+
+## Step 6: Cleanup API (Admin)
+
+```typescript
+// src/app/api/protected/admin/audit-logs/cleanup/route.ts
+import { handleApiError, withRole } from '@/lib/mars';
+import { cleanupOldAuditLogs } from '@/features/audit-log/server';
+import { NextResponse } from 'next/server';
+import { z } from 'zod';
+
+const cleanupSchema = z.object({
+  retentionDays: z.number().int().min(1).max(365).default(90),
+});
+
+export const POST = withRole(['admin'], async (request) => {
+  try {
+    const body = cleanupSchema.parse(await request.json());
+    const deleted = await cleanupOldAuditLogs(body.retentionDays);
+    return NextResponse.json({ deleted, retentionDays: body.retentionDays });
+  } catch (error) {
+    return handleApiError(error, { endpoint: '/api/protected/admin/audit-logs/cleanup' });
+  }
+});
+```
+
+## Step 7: Retention Policy
+
+Set up automated cleanup using a cron job or scheduled function:
+
+```typescript
+// src/app/api/cron/audit-cleanup/route.ts
+import { NextResponse } from 'next/server';
+import { constantTimeEqual } from '@mars-stack/core/auth/crypto-utils';
+import { cleanupOldAuditLogs } from '@/features/audit-log/server';
+
+export async function GET(request: Request) {
+  const authHeader = request.headers.get('authorization') ?? '';
+  const expected = `Bearer ${process.env.CRON_SECRET}`;
+  if (!constantTimeEqual(authHeader, expected)) {
+    return NextResponse.json({ error: 'Unauthorized' }, { status: 401 });
+  }
+
+  const deleted = await cleanupOldAuditLogs(90);
+  return NextResponse.json({ deleted });
+}
+```
+
+Add to `vercel.json` for Vercel Cron:
+
+```json
+{
+  "crons": [
+    {
+      "path": "/api/cron/audit-cleanup",
+      "schedule": "0 3 * * 0"
+    }
+  ]
+}
+```
+
+## Testing
+
+```typescript
+import { describe, it, expect, vi, beforeEach } from 'vitest';
+import { logAuditEvent, queryAuditLogs } from './index';
+
+vi.mock('@/lib/prisma', () => ({
+  prisma: {
+    auditLog: {
+      create: vi.fn(),
+      findMany: vi.fn(),
+      deleteMany: vi.fn(),
+    },
+  },
+}));
+
+vi.mock('@/lib/mars', () => ({
+  apiLogger: { error: vi.fn(), info: vi.fn() },
+}));
+
+describe('logAuditEvent', () => {
+  it('creates an audit log entry', async () => {
+    const { prisma } = await import('@/lib/prisma');
+    await logAuditEvent({
+      userId: 'user-1',
+      action: 'create',
+      resourceType: 'widget',
+      resourceId: 'widget-1',
+    });
+    expect(prisma.auditLog.create).toHaveBeenCalledWith(
+      expect.objectContaining({
+        data: expect.objectContaining({
+          userId: 'user-1',
+          action: 'create',
+          resourceType: 'widget',
+        }),
+      }),
+    );
+  });
+
+  it('does not throw if database write fails', async () => {
+    const { prisma } = await import('@/lib/prisma');
+    (prisma.auditLog.create as ReturnType<typeof vi.fn>).mockRejectedValue(new Error('DB error'));
+    await expect(logAuditEvent({
+      action: 'login',
+      resourceType: 'session',
+    })).resolves.toBeUndefined();
+  });
+});
+```
+
+## Checklist
+
+- [ ] `AuditLog` model in Prisma schema with proper indexes
+- [ ] User relation added (with `onDelete: SetNull`)
+- [ ] `logAuditEvent()` and `logAuditEventFromRequest()` helpers created
+- [ ] Server module imports `'server-only'`
+- [ ] Audit logging integrated into key routes (auth, CRUD, admin actions)
+- [ ] Admin query API with filtering and cursor pagination
+- [ ] Cleanup endpoint and retention policy (default 90 days)
+- [ ] Cron job for automated cleanup
+- [ ] Audit logger never throws (fire-and-forget with error logging)
+- [ ] No PII logged in metadata (no passwords, tokens, or full request bodies)
+- [ ] `db:push` run after schema changes
+- [ ] Tests written for audit log service