Email becomes a DeliveryChannel driven by rules, and the Team pipeline stops being
its own thing. `teamNotify.forumPost` now emits an event; a rule decides who is
mailed, through which template, and how often at most. One walk goes forum write
-> events.emit -> rule -> outbox -> worker -> email channel -> template -> SMTP.
Seven decisions settled by the org lead before any code:
- email only moves; the push tickle and the Discord bridge stay direct calls
- the EVENT carries its access-checked audience, and `members` resolves to it
- the four Team rules are seeded DISABLED, with an admin banner and a note
- team_notification_prefs stays, read by the engine as a scoped preference
- the payload wins and a structural projection fills the gaps
- the digest keeps computing at send time; only its state generalizes
- an unsubscribe token turns off the channel it names, and nothing else
Three defects found while building it:
- `email.button` never absolutized its href, while image and itemList both
did. Every rule-driven CTA would have been a dead relative link, because a
trigger's url variables are validated site-relative by construction.
- Phase 4a enqueued digest-mode recipients for a drain that Phase 6 decided
not to build. An outbox row snapshots the payload and so has none of the
three properties the digest design exists for, including the security one.
- the digest's send-log row carried no address_hash while the instant row
beside it did, which would have made half the mail uncorrelatable in Phase 9.
Also: engagement_digest_state + a replay-safe backfill, engagement_outbox.scope_key,
a v2 unsubscribe token that still verifies v1 forever, and the canonical
/public/engagement/unsubscribe pair with the old /public/teams path kept
permanently — mail is not editable once sent.
Verified with 1464 server tests, 324 client tests, and a live rig (MariaDB +
Mailpit + a real Team) covering the instant mail, the digest, the generic
template, a pre-migration unsubscribe link and the backfill's replay-safety.
Docs: RunicGateway/docs#TBD
Co-Authored-By: Claude <noreply@anthropic.com>
118 lines
5.5 KiB
JavaScript
118 lines
5.5 KiB
JavaScript
require('dotenv').config()
|
|
|
|
const settingsDb = require('../src/model/settings/settings.db')
|
|
const wikiDb = require('../src/model/wiki/wiki.db')
|
|
const users = require('../src/model/users/users.model')
|
|
const { ensureSchema, close } = require('../src/utils/db')
|
|
const { seedTemplates } = require('../src/engagement/templates')
|
|
const { seedTeamRules } = require('../src/engagement/coreRules')
|
|
const brand = require('../src/config/brand')
|
|
|
|
const log = require('../src/utils/logger')('seed')
|
|
|
|
// Default settings — only inserted if the key does not already exist.
|
|
const DEFAULT_SETTINGS = {
|
|
site_mode: 'maintenance', // start safe: site is in maintenance until set live
|
|
site_mode_changed_at: '',
|
|
site_mode_changed_by: '',
|
|
maintenance_message:
|
|
`${brand.shortName} is being shaped beneath a midnight sky. The site will return soon.`,
|
|
status_message: 'In progress.',
|
|
homepage_teaser:
|
|
`${brand.shortName} is still being shaped beneath a midnight sky. A quiet preview for ` +
|
|
'future news, screenshots, guides, and community notes as the world comes online.',
|
|
contact_email: brand.contactEmail,
|
|
site_title: brand.name,
|
|
// Android App Links opt-in — off until an admin enables it (docs/android/APP_LINKS.md).
|
|
mobile_app_links_enabled: 'false',
|
|
// Hosts a module may be installed from (MODULE_SYSTEM.md §2.7.2 decision 6).
|
|
//
|
|
// The environment BOOTSTRAPS this and does not own it: seedDefault is an
|
|
// INSERT IGNORE, so the variable supplies a sane default on a fresh install
|
|
// and never reaches back in to overwrite what an admin later chose in
|
|
// Admin → Modules. Changing MODULE_SOURCE_HOSTS on an existing deployment is
|
|
// therefore a no-op, which is the intended behaviour and not an oversight.
|
|
//
|
|
// An empty stored value forbids every install rather than allowing every host
|
|
// — the safe direction for a setting someone might blank by accident.
|
|
module_source_hosts: process.env.MODULE_SOURCE_HOSTS || 'gitea.whitlocktech.com',
|
|
}
|
|
|
|
// Starter wiki sections (editable later via the admin panel).
|
|
//
|
|
// The SLUGS are deliberately untouched by the de-UO pass: `seedDefault*` only
|
|
// inserts a row that is not already there, so renaming one adds a duplicate page
|
|
// to every existing install rather than renaming anything.
|
|
// [slug, title, description, sort_order]
|
|
const WIKI_CATEGORIES = [
|
|
['guides', 'Guides', 'Getting started and how-to guides.', 10],
|
|
['world', 'World & Lore', `Regions, maps, and the story of ${brand.shortName}.`, 20],
|
|
['gameplay', 'Systems & Gameplay', 'Mechanics, items, monsters, and crafting.', 30],
|
|
['community', 'Community & Rules', 'Player conduct and server policies.', 40],
|
|
]
|
|
|
|
// The 8 starter pages, each mapped to a section. [slug, title, body, categorySlug]
|
|
const WIKI_PAGES = [
|
|
['new-player-guide', 'New Player Guide', 'First steps, basic survival, and early goals.', 'guides'],
|
|
['maps-atlas', 'Maps & Atlas', 'Regions, towns, routes, and travel notes.', 'world'],
|
|
['lore', 'Lore', 'Stories, places, factions, and mysteries.', 'world'],
|
|
['systems', 'Server Systems', 'Server mechanics and custom features.', 'gameplay'],
|
|
['items', 'Items & Rewards', 'Equipment, treasures, rewards, and curiosities.', 'gameplay'],
|
|
['monsters', 'Monsters & Encounters', 'Creatures, bosses, spawns, and dangers.', 'gameplay'],
|
|
['crafting', 'Crafting', 'Professions, materials, recipes, and tools.', 'gameplay'],
|
|
['rules', 'Rules', 'Player conduct, server expectations, and policies.', 'community'],
|
|
]
|
|
|
|
async function seedDefaults() {
|
|
for (const [key, value] of Object.entries(DEFAULT_SETTINGS)) {
|
|
await settingsDb.seedDefault(key, value)
|
|
}
|
|
for (const [slug, title, description, sortOrder] of WIKI_CATEGORIES) {
|
|
await wikiDb.seedDefaultCategory(slug, title, description, sortOrder)
|
|
}
|
|
for (const [slug, title, body, categorySlug] of WIKI_PAGES) {
|
|
await wikiDb.seedDefault(slug, title, body)
|
|
// Attach to its section (only if not already categorized — safe re-run /
|
|
// migration of pages seeded before the wiki upgrade).
|
|
await wikiDb.assignCategoryBySlug(slug, categorySlug)
|
|
}
|
|
// The shipped mail bodies (ENGAGEMENT.md §4.6.1). Idempotent, and it never
|
|
// overwrites a row an operator has edited — `customized = 1` is checked in the
|
|
// UPDATE's own WHERE, not in a read-then-write. Never throws: a template that
|
|
// failed to seed costs the shipped default, which `renderByKey` falls back to
|
|
// anyway, and must not stop a boot.
|
|
await seedTemplates()
|
|
// The four Team rules, seeded ONCE and all disabled (ENGAGEMENT.md Phase 6).
|
|
// Guarded by a settings key rather than re-ensured, so a rule an operator
|
|
// deleted stays deleted and one they enabled stays enabled.
|
|
await seedTeamRules()
|
|
log.info('settings and wiki defaults ensured')
|
|
}
|
|
|
|
// Create the first admin from env vars, only when no users exist yet.
|
|
async function createInitialAdminFromEnv() {
|
|
const { ADMIN_USERNAME, ADMIN_PASSWORD } = process.env
|
|
if (!ADMIN_USERNAME || !ADMIN_PASSWORD) return
|
|
if ((await users.count()) > 0) return
|
|
await users.createUser({ username: ADMIN_USERNAME, password: ADMIN_PASSWORD, role: 'admin' })
|
|
log.info(`created initial admin "${ADMIN_USERNAME}"`)
|
|
}
|
|
|
|
// Allow running standalone: `npm run seed`
|
|
if (require.main === module) {
|
|
;(async () => {
|
|
try {
|
|
await ensureSchema()
|
|
await seedDefaults()
|
|
await createInitialAdminFromEnv()
|
|
} catch (err) {
|
|
log.error('seed failed', err)
|
|
process.exitCode = 1
|
|
} finally {
|
|
await close()
|
|
}
|
|
})()
|
|
}
|
|
|
|
module.exports = { seedDefaults, createInitialAdminFromEnv }
|