Claude
47c8b37d45
Engagement Phase 1 (docs/website/ENGAGEMENT.md §1.2a, §3.1, §3.2). A subtraction and a replacement in one commit, because leaving the OAuth2 flow half-wired across a release is worse than either end state. Deleted, per the §1.2a inventory: GET /admin/email/connect/start and /connect/callback, the connectStart/connectCallback controllers with the email_oauth_tx signed cookie, the PKCE verifier and CSRF nonce plumbing, the https://mail.google.com/ scope, the borrowed `google` auth-providers client, the OAuth2 nodemailer transport with its smtp.gmail.com:465 literals, the refresh-token decrypt in the model, and the client's Connect Gmail button, redirect banner and six Gmail error strings. `provider` and `refresh_token_enc` stay as columns under the additive-only discipline, unread. Added: a mail transport registry (server/src/engagement/transports) with `smtp` as the sole registration. `credentialFields` is the single declaration the admin form renders, the sanitizer filters against, and the "is it secret" answer comes from, so adding a transport is a registration rather than four edits. email_config gains transport / credential_enc (one encrypted JSON blob, since the field list is the transport's to declare) / reply_to. All six call sites keep their exact failure contracts: the contact form's mailto fallback, the invite's copyable link, the reset's generic 200, and sendTeamNotification's never-throws. One deliberate behaviour change: `enabled` now gates every sender rather than only isConfigured() — the connect flow used to set it as a side effect, and with a credential form the toggle has to mean what it says. Send-test becomes the real verification. Under OAuth2 the sender came back from Google and was guaranteed to belong to the credential; operator-typed, it can be refused, so failures name the sender and the SPF/DMARC reason (§1.2a consequence 2). G22, the silent degradation: an upgraded deployment backfills to smtp with no credentials and every sink politely does nothing. The admin dashboard now warns when the deprecated Gmail token is present and no replacement credential is, so the one deployment this happens to is told. A fresh install has never had mail and is not nagged. Guardrails: new `npm run check:hosts` (§3.2 rule 4) with its own self-test, wired into pr-checks before the install; routes.manifest and routes.guards regenerated (-2 routes). Co-Authored-By: Claude <noreply@anthropic.com>
59 lines
3.8 KiB
JavaScript
59 lines
3.8 KiB
JavaScript
// Admin · Dashboard — the landing summary, plus the /site-mode singleton.
|
|
//
|
|
// Mounted at the ROOT of /api/v1/admin by admin/index.js (not at a prefix),
|
|
// which already applied `noindex, isLoggedIn, staffOnly`. Two singleton URLs
|
|
// that share a swagger tag and a screen but not a path segment live together
|
|
// here rather than in two one-route files, which is what the target tree in
|
|
// docs/website/API_V2_PLAN.md § Phase 2 calls for.
|
|
//
|
|
// A root mount is the one place the split's "always mount at a prefix" rule is
|
|
// relaxed, and it is safe ONLY because this file declares no router-level
|
|
// middleware: a bare `use(gate)` here would run for every request passing
|
|
// through toward another mount and 403 an editor on an unrelated route. Keep
|
|
// gates per-route in this file.
|
|
//
|
|
// GET /dashboard — stats overview + operator warnings, any staff role.
|
|
// PUT /site-mode — live ↔ maintenance, admin only.
|
|
//
|
|
// Neither is the audit log (/activity) nor the bot-scoring state
|
|
// (/bot-activity); those are separate capabilities that read alike. Handlers
|
|
// still live in admin.controller.js; this re-wires routes, not logic.
|
|
|
|
const express = require('express')
|
|
const { body } = require('express-validator')
|
|
|
|
const ctrl = require('./admin.controller')
|
|
const { requireRole } = require('../../../utils/auth')
|
|
const validate = require('../../../middleware/validate')
|
|
|
|
const dashboardRouter = express.Router()
|
|
const adminOnly = requireRole('admin')
|
|
|
|
dashboardRouter.get(
|
|
'/dashboard',
|
|
// #swagger.tags = ['Admin · Dashboard']
|
|
// #swagger.summary = 'Dashboard summary counts'
|
|
// #swagger.security = [{ "cookieAuth": [] }, { "bearerAuth": [] }]
|
|
/* #swagger.responses[200] = { description: 'Summary: site mode, last change, post/user counts and recent activity', content: { "application/json": { schema: { type: "object", properties: { site_mode: { type: "string", example: "live" }, last_change: { type: "object", properties: { at: { type: "string", nullable: true }, by: { type: "string", nullable: true } } }, counts: { type: "object", properties: { posts: { type: "object", additionalProperties: true }, users: { type: "integer" } } }, warnings: { type: "array", description: "Operator warnings needing action; empty when there is nothing to say", items: { type: "object", properties: { code: { type: "string", example: "EMAIL_TRANSPORT_MIGRATION" }, message: { type: "string" }, href: { type: "string" } } } }, recent_activity: { type: "array", items: { type: "object", additionalProperties: true } } } } } } } */
|
|
/* #swagger.responses[401] = { description: 'Not authenticated', content: { "application/json": { schema: { $ref: "#/components/schemas/Error" } } } } */
|
|
ctrl.dashboard,
|
|
)
|
|
dashboardRouter.put(
|
|
'/site-mode',
|
|
// #swagger.tags = ['Admin · Dashboard']
|
|
// #swagger.summary = 'Set site mode (admin only)'
|
|
// #swagger.description = 'Switch the site between live and maintenance.'
|
|
// #swagger.security = [{ "cookieAuth": [] }, { "bearerAuth": [] }]
|
|
/* #swagger.requestBody = { required: true, content: { "application/json": { schema: { $ref: "#/components/schemas/SiteModeRequest" } } } } */
|
|
/* #swagger.responses[200] = { description: 'Updated site mode', content: { "application/json": { schema: { $ref: "#/components/schemas/SiteModeState" } } } } */
|
|
/* #swagger.responses[400] = { description: 'Validation error', content: { "application/json": { schema: { $ref: "#/components/schemas/ValidationError" } } } } */
|
|
/* #swagger.responses[401] = { description: 'Not authenticated', content: { "application/json": { schema: { $ref: "#/components/schemas/Error" } } } } */
|
|
/* #swagger.responses[403] = { description: 'Admin role required', content: { "application/json": { schema: { $ref: "#/components/schemas/Error" } } } } */
|
|
adminOnly,
|
|
body('mode').isIn(['live', 'maintenance']),
|
|
validate,
|
|
ctrl.setSiteMode,
|
|
)
|
|
|
|
module.exports = dashboardRouter
|