api-middleware-migrate

name: api-middleware-migrate description: Migrate API routes from raw authenticateRequest to withApiMiddleware pattern. Takes a route file path, reads current auth/billing/validation, generates the middleware wrapper. Use when working on #7431, #7430, #7434. user-invocable: true disable-model-invocation: true allowed-tools: Read, Edit, Write, Bash, Grep, Glob argument-hint: ""

API Middleware Migration

Migrate a single API route from raw authenticateRequest() + manual validation to the standardized withApiMiddleware() pattern.

Current Pattern (before)

export async function POST(req: NextRequest) {
  const authResult = await authenticateRequest();
  if (!authResult.ok) return authResult.response;

  const rl = await rateLimit(`user:route:${authResult.ctx.user.id}`, 30, 60_000);
  if (!rl.allowed) return rateLimitResponse(rl.remaining, rl.resetAt);

  const body = await req.json();
  if (!body.name || typeof body.name !== 'string') {
    return NextResponse.json({ error: 'Missing name' }, { status: 400 });
  }

  // ... business logic ...
}

Target Pattern (after)

import { withApiMiddleware } from '@/lib/api/middleware';
import { z } from 'zod';

const bodySchema = z.object({
  name: z.string().min(1),
});

export const POST = withApiMiddleware(
  async (req, { userId, body }) => {
    // ... business logic using validated body ...
    return NextResponse.json({ ok: true });
  },
  {
    requireAuth: true,
    rateLimit: true,
    rateLimitConfig: { key: (id) => `route:${id}`, max: 30, windowSeconds: 60 },
    validate: bodySchema,
  },
);

Process

Step 1: Read the route file

Read $ARGUMENTS

Step 2: Identify current patterns

Look for:

• authenticateRequest() / safeAuth() — auth pattern
• rateLimit() / rateLimitPublicRoute() — rate limiting
• req.json() + manual typeof checks — validation
• deductTokens() / creditAddonTokens() — billing
• captureException() — error handling

Step 3: Generate the Zod schema

Convert manual typeof/regex checks to a Zod schema:

• typeof x === 'string' → z.string()
• typeof x === 'number' → z.number()
• Array.isArray(x) → z.array(z.string())
• regex.test(x) → z.string().regex(pattern)

Step 4: Rewrite the route

1. Remove authenticateRequest() boilerplate
2. Remove rateLimit() boilerplate
3. Remove manual validation
4. Wrap handler in withApiMiddleware()
5. Use destructured { user, body } from middleware context

Step 5: Verify

cd web && npx tsc --noEmit
cd web && npx vitest run <test-file-for-this-route>

Checklist (per route)

• Auth pattern identified and migrated
• Rate limit key and params preserved
• All manual validation converted to Zod schema
• Error responses match existing HTTP status codes
• await on all async operations preserved (rateLimit gotcha)
• Test file updated if it mocks authenticateRequest directly
• TypeScript compiles
• Tests pass

Related Issues

• #7431 — Migrate ~60 routes to withApiMiddleware
• #7430 — Extract billing into withTokenBilling middleware
• #7434 — Standardize validation with Zod parseArgs

Notes

• withApiMiddleware already exists at web/src/lib/api/middleware.ts with two overloads:
  • Result-object (legacy): const mid = await withApiMiddleware(req, opts); if (mid.error) return mid.error;
  • Handler-wrapper (preferred): export const POST = withApiMiddleware(handler, opts);
• Options: { requireAuth, rateLimit, rateLimitConfig: { key, max, windowSeconds, useIp?, distributed? }, validate }
• Handler receives (req, { userId, authContext, body }) context object
• Tests at web/src/lib/api/__tests__/middleware.test.ts