diff --git a/.env.example b/.env.example index f055250..fd4bd53 100644 --- a/.env.example +++ b/.env.example @@ -6,6 +6,10 @@ DATABASE_URL=postgres://localhost:5432/monmap # Optional: the webapp's connection pool size (default 10). Keep it under # Postgres max_connections. DB_POOL_MAX= +# Optional: TLS to Postgres (require, verify-full or disable). Unset, +# every host except localhost must serve TLS (@monashcoding/db). Set +# `disable` when the database is on a private Docker network. +DATABASE_SSL= # ---- Public site origin ---- # Canonical URLs, sitemap, robots.txt and OG image URLs resolve from this @@ -17,11 +21,11 @@ NEXT_PUBLIC_SITE_URL=https://monmap.monashcoding.com # ---- Central MAC auth (auth.monashcoding.com) ---- # MonMap consumes the central MAC identity service; it does NOT run its # own auth server or hold OAuth secrets. Server code verifies EdDSA JWTs -# locally against the service's JWKS (packages/webapp/lib/mac-auth.ts). +# locally against the service's JWKS (@monashcoding/auth). # # AUTH_URL — read server-side (JWT issuer + JWKS endpoint). -# NEXT_PUBLIC_AUTH_URL — same value, exposed to the browser so the Better -# Auth react client points sign-in/out at the service. +# NEXT_PUBLIC_AUTH_URL — same value, exposed to the browser so the auth +# client points sign-in/out at the service. # JWT_AUDIENCE — expected `aud` claim on MAC tokens. AUTH_URL=https://auth.monashcoding.com NEXT_PUBLIC_AUTH_URL=https://auth.monashcoding.com @@ -30,8 +34,8 @@ JWT_AUDIENCE=mac-suite # ---- PostHog ---- # Public project token (safe to ship to the browser — PostHog API tokens # are write-only for capture). Used by both -# packages/webapp/lib/analytics.ts (the one posthog.init) and -# packages/webapp/lib/posthog-server.ts; same value either side. Both +# packages/webapp/lib/analytics.ts (the browser) and +# packages/webapp/lib/analytics-server.ts; same value either side. Both # send nothing outside production. NEXT_PUBLIC_POSTHOG_PROJECT_TOKEN= # Server-side host. The browser reaches PostHog through the /ingest diff --git a/CLAUDE.md b/CLAUDE.md index 3549445..c935be8 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -91,8 +91,8 @@ than gray. - Client code sends PostHog events only through `lib/analytics.ts`. An eslint rule blocks direct `posthog-js` imports. -- Server code sends events only through `captureServer` in - `lib/posthog-server.ts`. +- Server code sends events only through `serverAnalytics` in + `lib/analytics-server.ts`. - No event, property or label may carry an email, a name, a plan name or a grade. - Page views for the `/search` sorts are counted in Postgres, not PostHog. diff --git a/packages/db/package.json b/packages/db/package.json index d10d6bf..ef180c3 100644 --- a/packages/db/package.json +++ b/packages/db/package.json @@ -11,18 +11,20 @@ }, "scripts": { "generate": "drizzle-kit generate", - "migrate": "drizzle-kit migrate", + "migrate": "node src/migrate.ts", "studio": "drizzle-kit studio", "typecheck": "tsc --noEmit", "test": "node --test 'src/*.test.ts'" }, "dependencies": { + "@monashcoding/db": "0.2.0", "@monmap/scraper": "workspace:*", "dotenv": "^18.0.6", "drizzle-orm": "0.45.4", "postgres": "^3.4.9" }, "devDependencies": { + "@monashcoding/tsconfig": "0.2.0", "drizzle-kit": "^0.31.11" } } diff --git a/packages/db/src/env.ts b/packages/db/src/env.ts index bb56cb8..8e9e0bf 100644 --- a/packages/db/src/env.ts +++ b/packages/db/src/env.ts @@ -14,3 +14,16 @@ export const DATABASE_URL = (() => { if (!url) throw new Error("DATABASE_URL is not set in root .env"); return url; })(); + +/** + * TLS to Postgres: `require`, `verify-full` or `disable`. Unset, + * `@monashcoding/db` requires TLS for every host except localhost. + */ +export const DATABASE_SSL = (() => { + const mode = process.env.DATABASE_SSL; + if (!mode) return undefined; + if (mode === "require" || mode === "verify-full" || mode === "disable") { + return mode; + } + throw new Error("DATABASE_SSL must be require, verify-full or disable"); +})(); diff --git a/packages/db/src/index.ts b/packages/db/src/index.ts index 57a02bc..b7ca7fb 100644 --- a/packages/db/src/index.ts +++ b/packages/db/src/index.ts @@ -1,5 +1,5 @@ import { drizzle } from "drizzle-orm/postgres-js"; -import postgres, { type Options } from "postgres"; +import { createDb as createMacDb, type SslMode } from "@monashcoding/db"; import * as schema from "./schema.ts"; export * from "./schema.ts"; @@ -10,38 +10,39 @@ export * from "./overrides.ts"; export type Database = ReturnType; export interface CreateDbOptions { - /** Override postgres-js pool options. */ - pool?: Options>; + /** Pool size. Defaults to `DB_POOL_MAX`, then 10. */ + max?: number; + /** + * TLS to Postgres. Unset, `@monashcoding/db` requires TLS for every + * host except localhost; pass `disable` for a database on a private + * network that does not serve TLS. + */ + ssl?: SslMode; } /** * Build a Drizzle client bound to a Postgres connection string. * - * We pass `casing: "snake_case"` to match drizzle.config.ts — schema - * fields are camel-cased in TS, snake-cased in the DB. + * The connection comes from `@monashcoding/db`: it names itself + * `monmap` on the server, picks the TLS mode and recycles idle + * sockets. Statements are not prepared: Drizzle runs every query + * through postgres.js `unsafe()`, which never prepares. * - * Pool defaults suit a long-lived process that talks to Postgres - * directly (the self-hosted webapp and the ingest CLI): up to 10 - * connections, idle sockets kept for 5 minutes and each connection - * replaced after an hour. Pass `{ pool }` to tune. - * - * Statements are not prepared. Drizzle runs every query through - * postgres.js `unsafe()`, which never prepares whatever the pool says, - * so `prepare: true` here would have no effect. Do not force it on: - * the variable-length IN and VALUES lists would fill postgres.js's - * per-connection statement cache, which it never evicts. + * The Drizzle client is built here, not taken from the package, + * because the schema needs `casing: "snake_case"` (fields are + * camel-cased in TS, snake-cased in the DB, matching + * drizzle.config.ts) and the package's client has no casing option. */ export function createDb( url: string, options: CreateDbOptions = {}, ): ReturnType> { - const sql = postgres(url, { - max: 10, - prepare: false, - idle_timeout: 300, - max_lifetime: 60 * 60, - connect_timeout: 10, - ...options.pool, + const { sql } = createMacDb({ + app: "monmap", + schema, + url, + ...(options.max === undefined ? {} : { max: options.max }), + ...(options.ssl === undefined ? {} : { ssl: options.ssl }), }); return drizzle(sql, { schema, casing: "snake_case" }); } diff --git a/packages/db/src/migrate.ts b/packages/db/src/migrate.ts new file mode 100644 index 0000000..ee46b29 --- /dev/null +++ b/packages/db/src/migrate.ts @@ -0,0 +1,15 @@ +import { resolve } from "node:path"; +import { fileURLToPath } from "node:url"; +import { runMigrations } from "@monashcoding/db"; +import { DATABASE_SSL, DATABASE_URL } from "./env.ts"; + +// Apply the pending migrations in ../drizzle to DATABASE_URL, on one +// connection. Same ledger (drizzle.__drizzle_migrations) as +// `drizzle-kit migrate`, which this replaces. +await runMigrations({ + app: "monmap", + migrationsFolder: resolve(fileURLToPath(import.meta.url), "../../drizzle"), + url: DATABASE_URL, + ...(DATABASE_SSL === undefined ? {} : { ssl: DATABASE_SSL }), +}); +console.log("Migrations applied."); diff --git a/packages/db/tsconfig.json b/packages/db/tsconfig.json index 4c10534..1edbac5 100644 --- a/packages/db/tsconfig.json +++ b/packages/db/tsconfig.json @@ -1,4 +1,7 @@ { - "extends": "../../tsconfig.base.json", + "extends": "@monashcoding/tsconfig/node.json", + "compilerOptions": { + "allowImportingTsExtensions": true + }, "include": ["src/**/*", "drizzle.config.ts"] } diff --git a/packages/ingest/package.json b/packages/ingest/package.json index d3aa3ca..f7ba638 100644 --- a/packages/ingest/package.json +++ b/packages/ingest/package.json @@ -17,6 +17,7 @@ "drizzle-orm": "0.45.4" }, "devDependencies": { + "@monashcoding/tsconfig": "0.2.0", "tsx": "^4.23.15" } } diff --git a/packages/ingest/src/apply-overrides.ts b/packages/ingest/src/apply-overrides.ts index 322369d..c970767 100644 --- a/packages/ingest/src/apply-overrides.ts +++ b/packages/ingest/src/apply-overrides.ts @@ -15,7 +15,7 @@ import { extractRequirementGroups, units, } from "@monmap/db"; -import { DATABASE_URL } from "@monmap/db/env"; +import { DATABASE_SSL, DATABASE_URL } from "@monmap/db/env"; import { loadCurriculumOverrides } from "./overrides.ts"; import { foldPlaceholderUnits } from "./parse.ts"; @@ -28,7 +28,8 @@ console.log( ); const db = createDb(DATABASE_URL, { - pool: { max: 2, idle_timeout: 0, prepare: false }, + max: 2, + ssl: DATABASE_SSL, }); const rows = await db diff --git a/packages/ingest/src/backfill-curriculum.ts b/packages/ingest/src/backfill-curriculum.ts index 571b765..263bd1b 100644 --- a/packages/ingest/src/backfill-curriculum.ts +++ b/packages/ingest/src/backfill-curriculum.ts @@ -32,7 +32,7 @@ import { units, unitYearLinks, } from "@monmap/db"; -import { DATABASE_URL } from "@monmap/db/env"; +import { DATABASE_SSL, DATABASE_URL } from "@monmap/db/env"; import { extractCourseAosRefs, extractUnitYearLinks, @@ -51,7 +51,8 @@ if (yearFlag !== -1 && !/^\d{4}$/.test(onlyYear ?? "")) const overrides = loadCurriculumOverrides(); const db = createDb(DATABASE_URL, { - pool: { max: 2, idle_timeout: 0, prepare: false }, + max: 2, + ssl: DATABASE_SSL, }); const rows = await db diff --git a/packages/ingest/src/eval-curriculum.ts b/packages/ingest/src/eval-curriculum.ts index a0008e0..bb667b5 100644 --- a/packages/ingest/src/eval-curriculum.ts +++ b/packages/ingest/src/eval-curriculum.ts @@ -41,7 +41,7 @@ import { units, type RequirementGroup, } from "@monmap/db"; -import { DATABASE_URL } from "@monmap/db/env"; +import { DATABASE_SSL, DATABASE_URL } from "@monmap/db/env"; import { loadCurriculumOverrides } from "./overrides.ts"; const outFlag = process.argv.indexOf("--out"); @@ -52,7 +52,8 @@ const onlyYear = yearFlag !== -1 ? process.argv[yearFlag + 1] : undefined; const overrides = loadCurriculumOverrides(); const db = createDb(DATABASE_URL, { - pool: { max: 2, idle_timeout: 0, prepare: false }, + max: 2, + ssl: DATABASE_SSL, }); const legacyAuto = (groups: readonly RequirementGroup[]): Set => { diff --git a/packages/ingest/src/index.ts b/packages/ingest/src/index.ts index 263e6f4..599aacd 100644 --- a/packages/ingest/src/index.ts +++ b/packages/ingest/src/index.ts @@ -2,7 +2,7 @@ import { readdir } from "node:fs/promises"; import { join, resolve } from "node:path"; import { fileURLToPath } from "node:url"; import { createDb } from "@monmap/db"; -import { DATABASE_URL } from "@monmap/db/env"; +import { DATABASE_SSL, DATABASE_URL } from "@monmap/db/env"; import { ingest } from "./ingest.ts"; function parseArgs(argv: readonly string[]): { year: string; allYears: boolean; dataDir: string } { @@ -24,11 +24,11 @@ function parseArgs(argv: readonly string[]): { year: string; allYears: boolean; } const args = parseArgs(process.argv.slice(2)); -// Ingest is a long-running CLI doing bulk inserts — opt out of the -// serverless-tuned defaults from `createDb` and use a larger pool with -// no idle reaping. +// Ingest is a long-running CLI doing bulk inserts, on a small pool of +// its own. const db = createDb(DATABASE_URL, { - pool: { max: 4, idle_timeout: 0, prepare: false }, + max: 4, + ssl: DATABASE_SSL, }); const years = args.allYears diff --git a/packages/ingest/tsconfig.json b/packages/ingest/tsconfig.json index bf5a36d..840c8b0 100644 --- a/packages/ingest/tsconfig.json +++ b/packages/ingest/tsconfig.json @@ -1,4 +1,7 @@ { - "extends": "../../tsconfig.base.json", + "extends": "@monashcoding/tsconfig/node.json", + "compilerOptions": { + "allowImportingTsExtensions": true + }, "include": ["src/**/*"] } diff --git a/packages/scraper/package.json b/packages/scraper/package.json index 2b2f784..c772d93 100644 --- a/packages/scraper/package.json +++ b/packages/scraper/package.json @@ -13,6 +13,7 @@ "typecheck": "tsc --noEmit" }, "devDependencies": { + "@monashcoding/tsconfig": "0.2.0", "tsx": "^4.23.15" } } diff --git a/packages/scraper/tsconfig.json b/packages/scraper/tsconfig.json index bf5a36d..840c8b0 100644 --- a/packages/scraper/tsconfig.json +++ b/packages/scraper/tsconfig.json @@ -1,4 +1,7 @@ { - "extends": "../../tsconfig.base.json", + "extends": "@monashcoding/tsconfig/node.json", + "compilerOptions": { + "allowImportingTsExtensions": true + }, "include": ["src/**/*"] } diff --git a/packages/webapp/README.md b/packages/webapp/README.md index 647ffde..b98f3e2 100644 --- a/packages/webapp/README.md +++ b/packages/webapp/README.md @@ -12,7 +12,7 @@ reviews. It is a Next.js app in the monorepo. - Analytics: client code sends PostHog events only through `lib/analytics.ts` (an eslint rule enforces it), which loads posthog-js on demand. Server code sends them only through - `captureServer` in `lib/posthog-server.ts`. Neither sends anything + `serverAnalytics.capture` in `lib/analytics-server.ts`. Neither sends anything outside production, and no event carries an email, a name, a plan name or a grade. - Page views for the /search sorts are counted in Postgres, not diff --git a/packages/webapp/app/actions.ts b/packages/webapp/app/actions.ts index 884c765..b31c46f 100644 --- a/packages/webapp/app/actions.ts +++ b/packages/webapp/app/actions.ts @@ -1,7 +1,9 @@ "use server" -import { getClaims, getCurrentUser } from "@/lib/auth-server" -import { captureServer } from "@/lib/posthog-server" +import { getClaims } from "@monashcoding/auth/next" + +import { getCurrentUser } from "@/lib/auth-server" +import { serverAnalytics } from "@/lib/analytics-server" import { cleanGradeCode, cleanMark, @@ -132,7 +134,7 @@ export async function createBlankPlanAction( cleanPlanName(formData?.get("name")?.toString()) ?? "Default plan" const state = defaultState(year, null, 3) const plan = await createUserPlan(u.id, name, state) - await captureServer(u.id, "plan_created_server", { handbook_year: year }) + await serverAnalytics.capture(u.id, "plan_created_server", { handbook_year: year }) redirect(`/?plan=${plan.id}`) } diff --git a/packages/webapp/app/api/health/route.ts b/packages/webapp/app/api/health/route.ts new file mode 100644 index 0000000..47c07c2 --- /dev/null +++ b/packages/webapp/app/api/health/route.ts @@ -0,0 +1,21 @@ +import { createHealthHandler } from "@monashcoding/server" +import { sql } from "drizzle-orm" + +import { getDb } from "@/lib/db/client" + +/** + * 200 when the database answers, 503 when it does not, for Dokploy and + * uptime monitors. + * + * GET /api/health + */ +export const dynamic = "force-dynamic" + +export const GET = createHealthHandler({ + service: "monmap", + checks: { + db: async () => { + await getDb().execute(sql`select 1`) + }, + }, +}) diff --git a/packages/webapp/app/api/plan-graph/route.ts b/packages/webapp/app/api/plan-graph/route.ts index 659ca12..398b609 100644 --- a/packages/webapp/app/api/plan-graph/route.ts +++ b/packages/webapp/app/api/plan-graph/route.ts @@ -1,3 +1,5 @@ +import { handleRoute } from "@monashcoding/server" + import type { PlanGraphData } from "@/lib/api/client" import { MAX_GRAPH_CODES, splitCodes } from "@/lib/api/query" import { @@ -6,6 +8,7 @@ import { json, knownYear, searchParams, + ROUTE_OPTIONS, } from "@/lib/api/server" import { expandRequisiteGraph, hydratePlannerUnits } from "@/lib/db/queries" @@ -19,7 +22,7 @@ import { expandRequisiteGraph, hydratePlannerUnits } from "@/lib/db/queries" */ export const dynamic = "force-dynamic" -export async function GET(req: Request): Promise { +export const GET = handleRoute(async function GET(req: Request) { const params = searchParams(req) const year = await knownYear(params.get("year")) const codes = splitCodes(params.get("codes"), MAX_GRAPH_CODES) @@ -36,4 +39,4 @@ export async function GET(req: Request): Promise { units: Object.fromEntries(hydrated.units), } return json(body, HANDBOOK_CACHE) -} +}, ROUTE_OPTIONS) diff --git a/packages/webapp/app/api/planner-year/route.ts b/packages/webapp/app/api/planner-year/route.ts index aa98a1f..8394f58 100644 --- a/packages/webapp/app/api/planner-year/route.ts +++ b/packages/webapp/app/api/planner-year/route.ts @@ -1,3 +1,5 @@ +import { handleRoute } from "@monashcoding/server" + import type { PlannerYearData } from "@/lib/api/client" import { EMPTY_CACHE, @@ -7,6 +9,7 @@ import { NOTHING_HYDRATED, plain, searchParams, + ROUTE_OPTIONS, } from "@/lib/api/server" import { isCode } from "@/lib/db/input" import { @@ -26,7 +29,7 @@ import { plannerUnitCodes } from "@/lib/planner/types" */ export const dynamic = "force-dynamic" -export async function GET(req: Request): Promise { +export const GET = handleRoute(async function GET(req: Request) { const params = searchParams(req) const year = await knownYear(params.get("year")) const courseCode = params.get("course") @@ -55,4 +58,4 @@ export async function GET(req: Request): Promise { ...plain(await hydratePlannerUnits(plannerUnitCodes(course), year)), } return json(body, HANDBOOK_CACHE) -} +}, ROUTE_OPTIONS) diff --git a/packages/webapp/app/api/ratings/route.ts b/packages/webapp/app/api/ratings/route.ts index b1aec4f..96bacb3 100644 --- a/packages/webapp/app/api/ratings/route.ts +++ b/packages/webapp/app/api/ratings/route.ts @@ -1,5 +1,7 @@ +import { handleRoute } from "@monashcoding/server" + import { MAX_RATING_CODES, splitCodes } from "@/lib/api/query" -import { json, RATINGS_CACHE, searchParams } from "@/lib/api/server" +import { json, RATINGS_CACHE, searchParams, ROUTE_OPTIONS } from "@/lib/api/server" import { ratingSummaries } from "@/lib/db/reviews" import { isReviewKind } from "@/lib/reviews/axes" import { cleanEntityCode } from "@/lib/reviews/input" @@ -13,7 +15,7 @@ import { cleanEntityCode } from "@/lib/reviews/input" */ export const dynamic = "force-dynamic" -export async function GET(req: Request): Promise { +export const GET = handleRoute(async function GET(req: Request) { const params = searchParams(req) const kind = params.get("kind") const codes = splitCodes( @@ -23,4 +25,4 @@ export async function GET(req: Request): Promise { ) if (!isReviewKind(kind) || codes.length === 0) return json({}, RATINGS_CACHE) return json(await ratingSummaries(kind, codes), RATINGS_CACHE) -} +}, ROUTE_OPTIONS) diff --git a/packages/webapp/app/api/tree/route.ts b/packages/webapp/app/api/tree/route.ts index aecf27c..bfabe78 100644 --- a/packages/webapp/app/api/tree/route.ts +++ b/packages/webapp/app/api/tree/route.ts @@ -1,8 +1,11 @@ +import { handleRoute } from "@monashcoding/server" + import { EMPTY_CACHE, HANDBOOK_CACHE, json, searchParams, + ROUTE_OPTIONS, } from "@/lib/api/server" import { cleanTreeControls } from "@/lib/db/input" import { listAvailableYears } from "@/lib/db/queries" @@ -17,7 +20,7 @@ import { EMPTY_TREE_PAYLOAD, prefetchTreeData } from "@/lib/tree/prefetch" */ export const dynamic = "force-dynamic" -export async function GET(req: Request): Promise { +export const GET = handleRoute(async function GET(req: Request) { const params = searchParams(req) const controls = cleanTreeControls( { @@ -32,4 +35,4 @@ export async function GET(req: Request): Promise { ) if (!controls) return json(EMPTY_TREE_PAYLOAD, EMPTY_CACHE) return json(await prefetchTreeData(controls), HANDBOOK_CACHE) -} +}, ROUTE_OPTIONS) diff --git a/packages/webapp/app/api/units/route.ts b/packages/webapp/app/api/units/route.ts index 04d60bc..11033bf 100644 --- a/packages/webapp/app/api/units/route.ts +++ b/packages/webapp/app/api/units/route.ts @@ -1,3 +1,5 @@ +import { handleRoute } from "@monashcoding/server" + import { splitCodes } from "@/lib/api/query" import { EMPTY_CACHE, @@ -7,6 +9,7 @@ import { NOTHING_HYDRATED, plain, searchParams, + ROUTE_OPTIONS, } from "@/lib/api/server" import { hydratePlannerUnits } from "@/lib/db/queries" @@ -18,10 +21,10 @@ import { hydratePlannerUnits } from "@/lib/db/queries" */ export const dynamic = "force-dynamic" -export async function GET(req: Request): Promise { +export const GET = handleRoute(async function GET(req: Request) { const params = searchParams(req) const year = await knownYear(params.get("year")) const codes = splitCodes(params.get("codes")) if (!year || codes.length === 0) return json(NOTHING_HYDRATED, EMPTY_CACHE) return json(plain(await hydratePlannerUnits(codes, year)), HANDBOOK_CACHE) -} +}, ROUTE_OPTIONS) diff --git a/packages/webapp/app/api/units/search-rich/route.ts b/packages/webapp/app/api/units/search-rich/route.ts index cbe1fea..3424b52 100644 --- a/packages/webapp/app/api/units/search-rich/route.ts +++ b/packages/webapp/app/api/units/search-rich/route.ts @@ -1,3 +1,5 @@ +import { handleRoute } from "@monashcoding/server" + import type { RichSearchResult } from "@/lib/api/client" import { EMPTY_CACHE, @@ -7,6 +9,7 @@ import { NOTHING_HYDRATED, plain, searchParams, + ROUTE_OPTIONS, } from "@/lib/api/server" import { cleanQuery } from "@/lib/db/input" import { searchUnitsRich } from "@/lib/db/queries" @@ -23,7 +26,7 @@ import { searchUnitsRich } from "@/lib/db/queries" */ export const dynamic = "force-dynamic" -export async function GET(req: Request): Promise { +export const GET = handleRoute(async function GET(req: Request) { const params = searchParams(req) const year = await knownYear(params.get("year")) const q = cleanQuery(params.get("q")) @@ -37,4 +40,4 @@ export async function GET(req: Request): Promise { rank: Object.fromEntries(rank), } return json(body, HANDBOOK_CACHE) -} +}, ROUTE_OPTIONS) diff --git a/packages/webapp/app/api/units/search/route.ts b/packages/webapp/app/api/units/search/route.ts index a02ff93..83b3509 100644 --- a/packages/webapp/app/api/units/search/route.ts +++ b/packages/webapp/app/api/units/search/route.ts @@ -1,9 +1,12 @@ +import { handleRoute } from "@monashcoding/server" + import { EMPTY_CACHE, HANDBOOK_CACHE, json, knownYear, searchParams, + ROUTE_OPTIONS, } from "@/lib/api/server" import { cleanQuery } from "@/lib/db/input" import { searchUnits } from "@/lib/db/queries" @@ -15,10 +18,10 @@ import { searchUnits } from "@/lib/db/queries" */ export const dynamic = "force-dynamic" -export async function GET(req: Request): Promise { +export const GET = handleRoute(async function GET(req: Request) { const params = searchParams(req) const year = await knownYear(params.get("year")) const q = cleanQuery(params.get("q")) if (!year || !q) return json([], EMPTY_CACHE) return json(await searchUnits(q, 25, year), HANDBOOK_CACHE) -} +}, ROUTE_OPTIONS) diff --git a/packages/webapp/app/api/units/text/route.ts b/packages/webapp/app/api/units/text/route.ts index c1043bc..9bbd374 100644 --- a/packages/webapp/app/api/units/text/route.ts +++ b/packages/webapp/app/api/units/text/route.ts @@ -1,3 +1,5 @@ +import { handleRoute } from "@monashcoding/server" + import { MAX_TEXT_CODES, splitCodes } from "@/lib/api/query" import { EMPTY_CACHE, @@ -5,6 +7,7 @@ import { json, knownYear, searchParams, + ROUTE_OPTIONS, } from "@/lib/api/server" import { fetchUnitText } from "@/lib/db/queries" @@ -16,10 +19,10 @@ import { fetchUnitText } from "@/lib/db/queries" */ export const dynamic = "force-dynamic" -export async function GET(req: Request): Promise { +export const GET = handleRoute(async function GET(req: Request) { const params = searchParams(req) const year = await knownYear(params.get("year")) const codes = splitCodes(params.get("codes"), MAX_TEXT_CODES) if (!year || codes.length === 0) return json({}, EMPTY_CACHE) return json(await fetchUnitText(codes, year), HANDBOOK_CACHE) -} +}, ROUTE_OPTIONS) diff --git a/packages/webapp/app/api/views/route.ts b/packages/webapp/app/api/views/route.ts index 976fff0..c9294bd 100644 --- a/packages/webapp/app/api/views/route.ts +++ b/packages/webapp/app/api/views/route.ts @@ -1,4 +1,9 @@ +import { createRateLimiter, handleRoute } from "@monashcoding/server" +import { z } from "zod" + +import { ROUTE_OPTIONS } from "@/lib/api/server" import { recordView, refreshEntityStatsIfStale } from "@/lib/db/entity-stats" +import { logger } from "@/lib/log" import { isReviewKind } from "@/lib/reviews/axes" import { cleanEntityCode } from "@/lib/reviews/input" import { clientIp, isBot, viewDay, visitorKey } from "@/lib/views/visitor" @@ -12,30 +17,40 @@ import { clientIp, isBot, viewDay, visitorKey } from "@/lib/views/visitor" */ export const dynamic = "force-dynamic" +const viewBody = z.object({ kind: z.unknown(), code: z.unknown() }) + +// One address may send 300 views a minute; more are dropped without +// a different answer. Generous, because a campus network shares one +// address, and a visitor's repeat views already count once a day. +const viewLimiter = createRateLimiter({ limit: 300, windowMs: 60_000 }) + const NO_CONTENT = () => new Response(null, { status: 204, headers: { "Cache-Control": "no-store" } }) -export async function POST(req: Request): Promise { +export const POST = handleRoute(async function POST(req: Request) { const userAgent = req.headers.get("user-agent") ?? "" const ip = clientIp(req.headers) if (!ip || isBot(userAgent)) return NO_CONTENT() + if (!viewLimiter.check(ip).allowed) return NO_CONTENT() - let body: unknown + let json: unknown try { - body = JSON.parse((await req.text()).slice(0, 200)) + json = JSON.parse((await req.text()).slice(0, 200)) } catch { return NO_CONTENT() } - const { kind, code: rawCode } = (body ?? {}) as Record - const code = cleanEntityCode(rawCode) + const body = viewBody.safeParse(json) + if (!body.success) return NO_CONTENT() + const { kind } = body.data + const code = cleanEntityCode(body.data.code) if (!isReviewKind(kind) || !code) return NO_CONTENT() const day = viewDay() try { await recordView(kind, code, day, visitorKey(day, ip, userAgent)) } catch (err) { - console.error("recordView failed", err) + logger.error("recordView failed", err) } refreshEntityStatsIfStale() return NO_CONTENT() -} +}, ROUTE_OPTIONS) diff --git a/packages/webapp/app/ingest/[...path]/route.ts b/packages/webapp/app/ingest/[...path]/route.ts index 06f68a2..59607bf 100644 --- a/packages/webapp/app/ingest/[...path]/route.ts +++ b/packages/webapp/app/ingest/[...path]/route.ts @@ -1,69 +1,21 @@ /** - * Same-origin proxy for PostHog (`api_host: "/ingest"` in - * lib/analytics.ts), so ad blockers that block PostHog's + * Same-origin proxy for PostHog (`api_host: "/ingest"`, the default in + * `@monashcoding/analytics`), so ad blockers that block PostHog's * hosts don't drop analytics. * * This is a route handler, not a next.config rewrite, because a rewrite * forwards every request header. That includes the shared * `.monashcoding.com` session cookie, which signs its holder in to every - * MAC app. This handler forwards a short allowlist of headers, never a - * cookie, and drops PostHog's set-cookie. The path and header rules - * live in lib/ingest-proxy.ts. + * MAC app. The package's handler forwards a short allowlist of headers, + * never a cookie, drops PostHog's set-cookie, and only reaches the + * paths posthog-js calls. */ +import { createIngestHandler } from "@monashcoding/analytics/ingest" -import { - BodyTooLarge, - capBody, - forwardRequestHeaders, - forwardResponseHeaders, - ingestTarget, - MAX_BODY, -} from "@/lib/ingest-proxy" +const handler = createIngestHandler() export const dynamic = "force-dynamic" -async function proxy(req: Request): Promise { - const url = new URL(req.url) - const target = ingestTarget(url.pathname, url.search) - if (!target) return new Response(null, { status: 404 }) - if (Number(req.headers.get("content-length")) > MAX_BODY) { - return new Response(null, { status: 413 }) - } - const body = req.method === "GET" || req.method === "HEAD" ? null : req.body - - // Node's fetch needs `duplex` to stream a request body; the DOM - // RequestInit type does not list it yet. - const init: RequestInit & { duplex: "half" } = { - method: req.method, - headers: forwardRequestHeaders(req.headers), - // posthog-js sends gzip or base64 bodies; stream the bytes through - // with a cap instead of buffering them. - body: body?.pipeThrough(capBody(MAX_BODY)), - duplex: "half", - cache: "no-store", - // Set before the body is read, so it bounds the upload too. - signal: AbortSignal.timeout(10_000), - // A redirect to another host must not be fetched from the server. - redirect: "manual", - } - - let upstream: Response - try { - upstream = await fetch(target, init) - } catch (e) { - const tooLarge = e instanceof Error && e.cause instanceof BodyTooLarge - return new Response(null, { status: tooLarge ? 413 : 502 }) - } - if (upstream.status >= 300 && upstream.status < 400) { - return new Response(null, { status: 502 }) - } - - return new Response(upstream.body, { - status: upstream.status, - headers: forwardResponseHeaders(upstream.headers), - }) -} - -export const GET = proxy -export const POST = proxy -export const OPTIONS = proxy +export const GET = handler +export const POST = handler +export const OPTIONS = handler diff --git a/packages/webapp/app/layout.tsx b/packages/webapp/app/layout.tsx index c640761..93302bb 100644 --- a/packages/webapp/app/layout.tsx +++ b/packages/webapp/app/layout.tsx @@ -1,9 +1,8 @@ import type { Metadata, Viewport } from "next" import { Poppins } from "next/font/google" -import { GoogleAnalytics } from "@next/third-parties/google" import "./globals.css" -import { PostHogIdentify } from "@/components/posthog-identify" +import { Analytics } from "@/components/analytics" import { ThemeProvider } from "@/components/theme-provider" import { Toaster } from "@/components/ui/sonner" import { siteUrl } from "@/lib/seo" @@ -17,9 +16,6 @@ const poppins = Poppins({ variable: "--font-sans", }) -// Public by design (it ships in every page), so it lives in code, not .env. -const GA_MEASUREMENT_ID = "G-6QWVWW0NLG" - const SITE_DESCRIPTION = "Plan your Monash degree: drag units into semesters, check prerequisites and track your WAM. Read student reviews and see requisite maps for every Monash unit and course." @@ -121,7 +117,7 @@ export default function RootLayout({ > - + {children} {/* Below 601px sonner uses mobileOffset; the toasts then clear the 48px Progress button. globals.css covers 601-767px. */} @@ -132,9 +128,6 @@ export default function RootLayout({ mobileOffset={{ bottom: 80 }} /> - {/* Page views only, Loads in dev too; filter - localhost out by hostname in the GA reports. */} -