mirror of
https://github.com/Memo-2023/mana-monorepo.git
synced 2026-05-14 19:01:08 +02:00
feat(calendar): M8.3 — calendar pilot for unlisted-share end-to-end
Wires Calendar through the M8.1+M8.2 backbone: flipping an event to
'unlisted' now publishes a server-side snapshot, the visible link in
the DetailView/EventDetailModal opens a real /share/[token] page, and
recipients can download an .ics file for their own calendar.
Changes:
- lib/data/unlisted/resolvers.ts (new):
buildUnlistedBlob(collection, recordId) dispatcher.
buildEventBlob: load LocalEvent + linked TimeBlock, decrypt
client-side, return { title, location, startTime, endTime,
isAllDay, timezone }. Description, reminders, tagIds, calendarId,
color stay out of the blob — sensitive context the user didn't
consent to share by flipping a single flag.
- modules/calendar/types: CalendarEvent gains `unlistedToken: string`
(empty string when no active token). timeBlockToCalendarEvent
forwards from LocalEvent. Draft-event scaffold initializes empty.
- modules/calendar/stores/events:
setVisibility now coordinates with mana-api. Flip-to-unlisted:
build blob -> publishUnlistedSnapshot -> store server-issued
token in patch.unlistedToken -> commit local update. If the
server call fails, no local change happens (no drift).
Flip-from-unlisted: revoke server snapshot first, then clear
local token + commit visibility change.
deleteEvent: revoke active unlisted snapshot before tombstoning,
so the share-link dies in lock-step with the local delete.
updateEvent + updateSingleInstance fire-and-forget
refreshUnlistedSnapshot(id) so the published blob tracks any
whitelist-field edits. Failures log; the next successful
refresh heals.
New regenerateUnlistedToken(id): revoke + republish in one call,
returns the fresh token. Powers the "Neu erzeugen" UI.
- routes/share/[token]/+layout.svelte: minimal anonymous chrome —
no app nav, no auth, no Dexie. Light/dark via prefers-color-scheme.
Footer carries "Geteilt via Mana" + signup CTA.
- routes/share/[token]/+page.server.ts: SSR loader. Fetches
/api/v1/unlisted/public/:token, dispatches 404/410 cleanly,
sets Cache-Control: private, max-age=60 + X-Robots-Tag: noindex.
- routes/share/[token]/+page.svelte: dispatcher; renders
SharedEventView for collection='events', stub message otherwise.
- modules/calendar/SharedEventView.svelte: standalone public render —
big date, location, "Zum eigenen Kalender hinzufügen" .ics link,
optional expiry note. OG/Twitter meta tags for WhatsApp/Slack
preview embedding. Uses $derived everywhere so prop updates
propagate through reactive recompute.
- routes/share/[token]/ical/+server.ts: RFC 5545 builder. No npm
library — small enough to inline. Escapes per spec, CRLF endings,
DTSTART/DTEND swap between VALUE=DATE and UTC depending on isAllDay.
Wrong-collection requests get 400.
- modules/calendar/views/DetailView (Workbench) + components/
EventDetailModal (/calendar route): SharedLinkControls dropped in
below the visibility row when event.visibility === 'unlisted'
AND event.unlistedToken AND shareUrl computed. The URL is built
client-side via buildShareUrl(window.location.origin, token) so it
stays in sync with whichever host the editor is open on.
Verified:
- pnpm check (web): 7541 files, 0 errors, 0 warnings
- pnpm test calendar + website: 26/26
- typecheck of new resolver, store hooks, SSR loader, iCal builder
Manual test path:
1. Open /calendar event in Detail view, flip Sichtbarkeit -> "Per Link"
2. Server publishes snapshot, Dexie record gets the server token
3. SharedLinkControls appear with copy + regenerate + revoke buttons
4. Open the URL in incognito → SSR fetches snapshot, renders
SharedEventView with date / location / .ics download
5. Edit the event title back in the main app → snapshot auto-refreshes
(refreshUnlistedSnapshot fires after updateEvent succeeds)
6. Flip back to "Bereich" → snapshot revoked server-side; subsequent
incognito reloads return 410 Gone
Next: M8.4 — same wiring for Library + Places. Uses the same
infra (resolvers dispatcher, share dispatcher) — just adds two new
buildXBlob functions, two SharedXView components, and the store
hooks.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
Till JS
parent
8b9fbd2e1c
commit
fbbadc91f0
13 changed files with 1093 additions and 11 deletions
211
scripts/validate-i18n-keys.mjs
Normal file
211
scripts/validate-i18n-keys.mjs
Normal file
|
|
@ -0,0 +1,211 @@
|
|||
#!/usr/bin/env node
|
||||
/**
|
||||
* Cross-checks i18n key usage in code against keys defined in DE
|
||||
* locale JSONs. Two directions:
|
||||
*
|
||||
* - **Missing**: a `$_('a.b.c')` call where `a.b.c` is not in DE.
|
||||
* These would render as the raw key string at runtime — a
|
||||
* user-visible bug. Tracked against a per-file baseline so the
|
||||
* existing backlog doesn't block CI but new misses fail hard.
|
||||
*
|
||||
* - **Dead**: a key in DE that no `$_(…)` call references (statically
|
||||
* or via a known dynamic prefix). Reported as INFO; not enforced
|
||||
* because the writing-key-first workflow would otherwise block.
|
||||
*
|
||||
* Dynamic suffixes via template literals (`$_(`ns.foo.${x}`)`) and
|
||||
* concatenations (`$_('ns.foo.' + x)`) become "prefix masks": every
|
||||
* key under `ns.foo.` is treated as potentially used.
|
||||
*
|
||||
* Usage:
|
||||
* node scripts/validate-i18n-keys.mjs # check against baseline
|
||||
* node scripts/validate-i18n-keys.mjs --update # rewrite baseline
|
||||
* node scripts/validate-i18n-keys.mjs --report # print full dead-key list
|
||||
*/
|
||||
|
||||
import { readFileSync, writeFileSync, readdirSync, statSync, existsSync } from 'node:fs';
|
||||
import { fileURLToPath } from 'node:url';
|
||||
import { dirname, join } from 'node:path';
|
||||
import { execSync } from 'node:child_process';
|
||||
|
||||
const __dirname = dirname(fileURLToPath(import.meta.url));
|
||||
const REPO_ROOT = join(__dirname, '..');
|
||||
const LOCALES_DIR = join(REPO_ROOT, 'apps/mana/apps/web/src/lib/i18n/locales');
|
||||
const SRC_DIR = 'apps/mana/apps/web/src';
|
||||
const BASELINE_PATH = join(__dirname, 'i18n-missing-baseline.json');
|
||||
|
||||
function flattenKeys(obj, prefix = '') {
|
||||
const keys = [];
|
||||
for (const [k, v] of Object.entries(obj)) {
|
||||
const path = prefix ? `${prefix}.${k}` : k;
|
||||
if (v && typeof v === 'object' && !Array.isArray(v)) keys.push(...flattenKeys(v, path));
|
||||
else keys.push(path);
|
||||
}
|
||||
return keys;
|
||||
}
|
||||
|
||||
function loadDefinedKeys() {
|
||||
const defined = new Set();
|
||||
const namespaces = readdirSync(LOCALES_DIR).filter((f) =>
|
||||
statSync(join(LOCALES_DIR, f)).isDirectory()
|
||||
);
|
||||
for (const ns of namespaces) {
|
||||
const path = join(LOCALES_DIR, ns, 'de.json');
|
||||
if (!existsSync(path)) continue;
|
||||
for (const k of flattenKeys(JSON.parse(readFileSync(path, 'utf8')))) {
|
||||
defined.add(`${ns}.${k}`);
|
||||
}
|
||||
}
|
||||
return defined;
|
||||
}
|
||||
|
||||
function scanUsages() {
|
||||
const files = execSync(`git ls-files '${SRC_DIR}/**/*.svelte' '${SRC_DIR}/**/*.ts'`, {
|
||||
cwd: REPO_ROOT,
|
||||
})
|
||||
.toString()
|
||||
.trim()
|
||||
.split('\n')
|
||||
.filter(Boolean);
|
||||
|
||||
// per-key list of files where it's referenced — for nice error reporting
|
||||
const usedByFile = new Map();
|
||||
const dynamicPrefixes = new Set();
|
||||
|
||||
for (const f of files) {
|
||||
const src = readFileSync(join(REPO_ROOT, f), 'utf8');
|
||||
|
||||
// $_('a.b.c') or _('a.b.c')
|
||||
for (const m of src.matchAll(/\$?_\(\s*['"]([a-zA-Z][\w.-]*)['"]/g)) {
|
||||
const key = m[1];
|
||||
if (!usedByFile.has(key)) usedByFile.set(key, new Set());
|
||||
usedByFile.get(key).add(f);
|
||||
}
|
||||
|
||||
// $_(`a.b.${x}`) → prefix "a.b."
|
||||
for (const m of src.matchAll(/\$?_\(\s*`([a-zA-Z][\w.-]*\.)\$\{/g)) {
|
||||
dynamicPrefixes.add(m[1]);
|
||||
}
|
||||
|
||||
// $_('a.b.' + x) → prefix "a.b."
|
||||
for (const m of src.matchAll(/\$?_\(\s*['"]([a-zA-Z][\w.-]*\.)['"]\s*\+/g)) {
|
||||
dynamicPrefixes.add(m[1]);
|
||||
}
|
||||
}
|
||||
|
||||
return { usedByFile, dynamicPrefixes };
|
||||
}
|
||||
|
||||
function loadBaseline() {
|
||||
if (!existsSync(BASELINE_PATH)) return {};
|
||||
return JSON.parse(readFileSync(BASELINE_PATH, 'utf8'));
|
||||
}
|
||||
|
||||
function buildPerFileMissing(usedByFile, defined) {
|
||||
// Returns: { file: { count, keys: [...] } }
|
||||
const perFile = {};
|
||||
for (const [key, files] of usedByFile) {
|
||||
if (defined.has(key)) continue;
|
||||
for (const f of files) {
|
||||
if (!perFile[f]) perFile[f] = { count: 0, keys: new Set() };
|
||||
perFile[f].count++;
|
||||
perFile[f].keys.add(key);
|
||||
}
|
||||
}
|
||||
const result = {};
|
||||
for (const [f, { count, keys }] of Object.entries(perFile)) {
|
||||
result[f] = count;
|
||||
}
|
||||
return { perFileCount: result, missingKeysByFile: perFile };
|
||||
}
|
||||
|
||||
function main() {
|
||||
const update = process.argv.includes('--update');
|
||||
const reportMode = process.argv.includes('--report');
|
||||
|
||||
const defined = loadDefinedKeys();
|
||||
const { usedByFile, dynamicPrefixes } = scanUsages();
|
||||
const used = new Set(usedByFile.keys());
|
||||
|
||||
const dead = [...defined].filter(
|
||||
(k) => !used.has(k) && ![...dynamicPrefixes].some((p) => k.startsWith(p))
|
||||
);
|
||||
|
||||
const { perFileCount, missingKeysByFile } = buildPerFileMissing(usedByFile, defined);
|
||||
const totalMissing = Object.values(perFileCount).reduce((a, b) => a + b, 0);
|
||||
|
||||
if (reportMode) {
|
||||
console.log(`Defined keys: ${defined.size}`);
|
||||
console.log(`Statically used: ${used.size}, dynamic prefixes: ${dynamicPrefixes.size}`);
|
||||
console.log(`Dead keys (defined, never referenced): ${dead.length}`);
|
||||
console.log('\n--- top 30 dead keys ---');
|
||||
for (const k of dead.slice(0, 30)) console.log(' ' + k);
|
||||
console.log('\n--- missing keys (used, undefined) ---');
|
||||
for (const [f, info] of Object.entries(missingKeysByFile).slice(0, 20)) {
|
||||
console.log(` ${f}: ${info.count}`);
|
||||
for (const k of [...info.keys].slice(0, 5)) console.log(` - ${k}`);
|
||||
}
|
||||
return;
|
||||
}
|
||||
|
||||
if (update) {
|
||||
const sorted = Object.fromEntries(
|
||||
Object.entries(perFileCount).sort(([a], [b]) => a.localeCompare(b))
|
||||
);
|
||||
writeFileSync(BASELINE_PATH, JSON.stringify(sorted, null, 2) + '\n');
|
||||
console.log(
|
||||
`✓ Baseline updated: ${totalMissing} missing-key reference(s) across ${Object.keys(perFileCount).length} files.`
|
||||
);
|
||||
return;
|
||||
}
|
||||
|
||||
const baseline = loadBaseline();
|
||||
const baselineTotal = Object.values(baseline).reduce((a, b) => a + b, 0);
|
||||
const violations = [];
|
||||
for (const [file, n] of Object.entries(perFileCount)) {
|
||||
const b = baseline[file] ?? 0;
|
||||
if (n > b) {
|
||||
violations.push({
|
||||
file,
|
||||
current: n,
|
||||
baseline: b,
|
||||
delta: n - b,
|
||||
keys: [...missingKeysByFile[file].keys].filter(
|
||||
(k) => !(baseline[file] && false) // we don't track which exact keys were baselined; show all
|
||||
),
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
if (violations.length > 0) {
|
||||
console.error(`\n✗ i18n missing-key check FAILED — ${violations.length} file(s) over baseline:\n`);
|
||||
for (const v of violations.slice(0, 20)) {
|
||||
console.error(` ${v.file}: ${v.current} (was ${v.baseline}, +${v.delta})`);
|
||||
for (const k of v.keys.slice(0, 3)) console.error(` - ${k}`);
|
||||
if (v.keys.length > 3) console.error(` … +${v.keys.length - 3} more keys`);
|
||||
}
|
||||
if (violations.length > 20) console.error(` … +${violations.length - 20} more files`);
|
||||
console.error(
|
||||
`\nA $_('…') call references a key that does not exist in any DE locale.\n` +
|
||||
`At runtime this renders as the raw key string. Add the key to the\n` +
|
||||
`appropriate locales/<ns>/de.json (parity validator will demand the\n` +
|
||||
`other locales) — or fix the typo.\n` +
|
||||
`If intentional (e.g. you renamed away a key still being referenced\n` +
|
||||
`in legacy code), run: pnpm run validate:i18n-keys -- --update\n`
|
||||
);
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
const shrunk = Object.keys(baseline).filter((f) => (perFileCount[f] ?? 0) < baseline[f]).length;
|
||||
const cleaned = Object.keys(baseline).filter((f) => !(f in perFileCount)).length;
|
||||
|
||||
console.log(
|
||||
`✓ i18n keys: ${totalMissing} missing reference(s) (baseline ${baselineTotal}); ` +
|
||||
`${dead.length} dead key(s) defined but unused.` +
|
||||
(shrunk || cleaned
|
||||
? `\n ${shrunk} file(s) shrunk, ${cleaned} file(s) fully cleaned — ` +
|
||||
`run 'pnpm run validate:i18n-keys -- --update' to ratchet.`
|
||||
: '')
|
||||
);
|
||||
}
|
||||
|
||||
main();
|
||||
Loading…
Add table
Add a link
Reference in a new issue