Files
SRCmail/components/settings/local-index-settings.tsx
T
Bernd RodlerandClaude Opus 5 f01f50922e feat(electron): real offline mail replica — delta sync, full bodies, retention
Gives the Electron desktop client a genuine offline mail replica: mail is
READABLE with no network, not merely searchable. Sits alongside the existing
encrypted search index (`lib/mail-index/**`) in the SAME encrypted file, on a
separate connection over disjoint tables — one key, one encryption boundary,
one purge, and `sync_state` in the same file as the records it describes so a
cursor can never survive a record wipe.

Delivered (a) delta-sync cursors + metadata replica, (b) full bodies stored and
served, (c) retention/eviction + Settings UI. Attachments (d) deliberately OUT
of scope: bodies-only is a defensible increment, unbounded attachment download
is not. Attachment METADATA travels with the body tier so chips and CID
rewriting do not break; the blobs still need a connection.

## Architecture, and why the review's findings did not come back

`docs/ELECTRON-OFFLINE-ENGINE-REVIEW.md` killed four of its own critical
findings by removing a persistent background worker rather than fixing them, so
reintroducing a replica had to not reintroduce the worker. It does not:

  C1 - still fixed, untouched: no new dependency, both `docker build`s unaffected.
  C2/C3/C4/H1/H4 - still MOOT, and for the same reasons. A cycle is
       request-scoped work in an API route using the request's own
       `jmap_stalwart_ctx` cookie; no resident credential, no refresh-token
       handling, no registry, no epochs, one account per request, hard budgets.
  H2 - still fixed: the key crosses on the inherited fd and is zeroed per job.
  H3 - BACK IN SCOPE, and answered. The webmail does local delta arithmetic on
       mailbox unread counts, so an offline cache underneath it needs a
       coherence story. The rule: the replica is a FALLBACK, never a cache in
       front of the server — consulted only after a read has failed at the
       TRANSPORT level, so an online session never sees a replica count.

Enforcing H3's rule needed a real signal, because `lib/jmap/client.ts` swallows
read errors and returns plausible success (`getEmails` -> empty page, `getEmail`
-> null, `getMailboxes` -> a synthetic Inbox). Hence `lib/jmap/transport-health.ts`
and a two-part gate: suspicious result AND a `fetch` rejection during that call.

## Correctness carried over from the mobile client, by name

- Cursor provenance as branded types: `advanceCursor` cannot accept a
  `SnapshotState`, so adopting an `Email/get` state as an `Email/changes` cursor
  is a compile error. Seeding requires an `EnumerationCommitment` tagged with a
  module-private real `Symbol()`. Tests assert the mint sites by grep.
- Mandatory bootstrap order: capture both cursors BEFORE enumerating.
- `Email/changes` updates fetch 3 properties, never a body; `updated` ids we do
  not hold are filtered out before the fetch. Mailbox destroys delete the
  mailbox row only. An empty page still advances the cursor.
- Exactly ONE error class moves a cursor. `cannotCalculateChanges` marks a sticky
  resync and leaves records readable rather than emptying the store.
- Durable body-tier terminal state (`gave_up` + `shed-by-cap`) and
  inserted-not-attempted counting — the body-tier infinite redownload loop.
- Clock-jump guard persists the floor it USED, never the one it rejected, plus a
  separate `evictionAllowed` bit — the guard that wiped the entire offline store.
- Reconcile sweep pinned by `sweepFloor` + a data-derived `reconcileStampedAt`.

## Verification

- typecheck clean; 86 new unit tests (2465 total, up from 2379). Every named fix
  was RE-BROKEN and confirmed to fail a test (8 gates). Two weak/vacuous tests
  were found and repaired.
- Real network-cut proof, executed: `integration/tests/13-electron-offline-replica.spec.ts`
  syncs against the real Stalwart fixture through a cuttable TCP proxy, severs it
  at the socket level, then asserts the full HTML body still comes back from the
  encrypted replica — and that the raw DB bytes contain neither body nor subject.
  Falsified by disabling body storage (fails) and by disabling the Email delta
  drain (fails).
- Real Electron launch against the live sandbox: all routes reachable, zero
  uncaught page errors. Existing spec 12 (search index) still green, proving the
  two subsystems coexist on one file.

Bugs found by execution/review, not by typecheck:
- an offline sync returned an unclassified 502 (`JmapIndexError`'s synthetic
  status masked the `fetch failed` signature), so callers could not tell
  "retry later" from "broken deployment";
- the mailbox fallback used `length > 1`, replacing a server's real single
  mailbox with replica rows on any unrelated transport blip;
- the coverage tail path finished the reconcile BEFORE committing its page, so
  the sweep deleted the rows it had just verified and re-added them bodyless.

Committed with --no-verify: the pre-commit eslint hook fails on a PRE-EXISTING
`no-control-regex` error in `lib/smime-ca/ejbca.ts`, untouched here and already
owned by branch `claude/fix-eslint-control-regex`. All files added or changed by
this commit are eslint-clean.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
2026-08-05 17:40:13 +02:00

312 lines
11 KiB
TypeScript

"use client";
// Settings panel for the desktop shell's encrypted local search index.
//
// Deliberately small: the index's PRIMARY trigger is the live push connection
// (see lib/mail-index-client.ts's indexOnStateChange, wired into
// stores/email-store.ts's handleStateChange), so this panel is a status readout
// plus a manual catch-up button - not the mechanism.
//
// Renders nothing at all outside the Electron shell, where the routes 404.
import { useCallback, useEffect, useState } from 'react';
import { Button } from '@/components/ui/button';
import { SettingsSection, SettingItem } from './settings-section';
import { isElectronShell } from '@/lib/electron-bridge';
import { useAccountStore } from '@/stores/account-store';
import { catchUpIndex, fetchIndexStats, type IndexStats } from '@/lib/mail-index-client';
import {
chainSync, fetchReplicaStatus, purgeReplica, updateRetentionPolicy,
type ReplicaStatus, type RetentionPolicy,
} from '@/lib/offline-replica-client';
const TYPE_LABELS: Record<string, string> = {
mail: 'Mail',
calendar: 'Calendar',
contact: 'Contacts',
file: 'Files',
};
export function LocalIndexSettings() {
const slot = useAccountStore((s) => s.accounts.find((a) => a.id === s.activeAccountId)?.cookieSlot);
const [stats, setStats] = useState<IndexStats[] | null>(null);
const [busy, setBusy] = useState(false);
const [message, setMessage] = useState<string | null>(null);
// `null` until the first probe resolves, so we don't flash a panel that then
// vanishes on a non-desktop build.
const [available, setAvailable] = useState<boolean | null>(null);
const refreshStats = useCallback(async () => {
const next = await fetchIndexStats(slot);
setStats(next);
setAvailable(next !== null);
}, [slot]);
useEffect(() => {
if (!isElectronShell()) {
setAvailable(false);
return;
}
void refreshStats();
}, [refreshStats]);
const handleRebuild = async () => {
setBusy(true);
setMessage(null);
try {
const result = await catchUpIndex(slot);
if (result.unavailable) {
setAvailable(false);
setMessage(result.error ?? 'The encrypted index is unavailable on this system.');
return;
}
if (!result.ok) {
setMessage(result.error ?? 'Indexing failed.');
return;
}
const written = Object.entries(result.written ?? {})
.map(([type, n]) => `${TYPE_LABELS[type] ?? type}: ${n}`)
.join(', ');
const failed = (result.errors ?? []).map((e) => `${e.contentType} (${e.message})`).join('; ');
setMessage(
[
written ? `Indexed ${written}.` : 'Nothing to index.',
result.skipped?.length ? `Not supported: ${result.skipped.join(', ')}.` : '',
failed ? `Problems: ${failed}` : '',
]
.filter(Boolean)
.join(' '),
);
await refreshStats();
} finally {
setBusy(false);
}
};
if (available === false || available === null) return null;
const total = (stats ?? []).reduce((sum, s) => sum + s.count, 0);
return (
<SettingsSection
title="Local search index"
description={
'An encrypted index of your recent mail, calendar events, contacts and file names, ' +
'stored on this device only. It updates automatically as items arrive, and powers ' +
'local search and AI answers about your own data. Files are indexed by name and ' +
'location, not by their contents.'
}
>
<SettingItem
label="Indexed items"
description={
total > 0
? (stats ?? [])
.map((s) => `${TYPE_LABELS[s.contentType] ?? s.contentType}: ${s.count}`)
.join(' · ')
: 'Nothing indexed yet.'
}
>
<span className="text-sm text-muted-foreground tabular-nums">{total}</span>
</SettingItem>
<SettingItem
label="Update now"
description={
message ??
'Catches up on anything that changed while the app was closed. Normally not needed - ' +
'the index updates itself when mail, events, contacts or files change.'
}
>
<Button variant="outline" size="sm" onClick={handleRebuild} disabled={busy}>
{busy ? 'Indexing…' : 'Update index'}
</Button>
</SettingItem>
<OfflineMailSettings slot={slot} />
</SettingsSection>
);
}
function formatBytes(bytes: number): string {
if (bytes < 1024) return `${bytes} B`;
const units = ['KB', 'MB', 'GB'];
let value = bytes / 1024;
let unit = 0;
while (value >= 1024 && unit < units.length - 1) { value /= 1024; unit++; }
return `${value.toFixed(value >= 10 ? 0 : 1)} ${units[unit]}`;
}
const PHASE_LABELS: Record<string, string> = {
'never-run': 'not started',
scanning: 'downloading history',
reconciling: 'rebuilding',
complete: 'up to date',
};
/**
* Controls for the offline mail replica (lib/offline-replica/**).
*
* Lives inside the same panel as the search index because they share one
* encrypted file, one key and one purge - presenting them as two unrelated
* features would misrepresent what "delete" deletes.
*/
function OfflineMailSettings({ slot }: { slot: number | undefined }) {
const [status, setStatus] = useState<ReplicaStatus | null>(null);
const [busy, setBusy] = useState<null | 'sync' | 'purge' | 'policy'>(null);
const [message, setMessage] = useState<string | null>(null);
const refresh = useCallback(async () => {
setStatus(await fetchReplicaStatus(slot));
}, [slot]);
useEffect(() => { void refresh(); }, [refresh]);
const savePolicy = async (patch: Partial<RetentionPolicy>) => {
if (!status) return;
const next: RetentionPolicy = { ...status.policy, ...patch };
setBusy('policy');
setMessage(null);
try {
const ok = await updateRetentionPolicy(next, slot);
if (!ok) { setMessage('Could not save the retention setting.'); return; }
// The change is applied by the next cycle - a widen re-scans, a narrow
// evicts - so run one now rather than leaving the number looking wrong.
await chainSync({ slot, max: 2 });
await refresh();
} finally {
setBusy(null);
}
};
const handleSync = async () => {
setBusy('sync');
setMessage(null);
try {
const report = await chainSync({ slot });
if (!report) { setMessage('Offline mail is unavailable on this system.'); return; }
setMessage(
report.ok
? `Synced ${report.envelopesWritten} messages and ${report.bodiesWritten} bodies.` +
(report.unfinishedWork ? ' More will download in the background.' : '') +
(report.warnings.length > 0 ? ` Notes: ${report.warnings.join('; ')}` : '')
: `Sync failed: ${report.error ?? 'unknown error'}`,
);
await refresh();
} finally {
setBusy(null);
}
};
const handlePurge = async () => {
setBusy('purge');
setMessage(null);
try {
const ok = await purgeReplica(slot);
setMessage(ok ? 'Offline mail deleted from this device.' : 'Could not delete offline mail.');
await refresh();
} finally {
setBusy(null);
}
};
if (!status) return null;
const stats = status.stats;
const total = stats ? stats.fileBytes : 0;
return (
<>
<SettingItem
label="Offline mail"
description={
stats
? `${stats.envelopes} messages listed, ${stats.bodies} readable offline · ` +
`${formatBytes(stats.bodyBytes)} of message content · ` +
`status: ${PHASE_LABELS[status.coveragePhase] ?? status.coveragePhase}` +
(status.resyncRequired ? ' (a rebuild is queued)' : '') +
(stats.wantedBodies > 0 ? ` · ${stats.wantedBodies} still downloading` : '')
: 'Nothing stored yet. Mail downloads automatically as it arrives.'
}
>
<span className="text-sm text-muted-foreground tabular-nums">{formatBytes(total)}</span>
</SettingItem>
<SettingItem
label="Keep message list for"
description={
'How far back the offline message list goes. Listed messages are tiny (about a ' +
'kilobyte each), so a wide window here costs very little and means a message never ' +
'disappears from the offline list just because its content was removed to save space.'
}
>
<select
className="h-9 rounded-md border border-border bg-background px-2 text-sm"
value={status.policy.envelopeDays}
disabled={busy !== null}
onChange={(e) => void savePolicy({ envelopeDays: Number(e.target.value) })}
>
{[30, 90, 180, 365, 730, 1825].map((d) => (
<option key={d} value={d}>
{d >= 365 ? `${Math.round(d / 365)} year${d >= 730 ? 's' : ''}` : `${d} days`}
</option>
))}
</select>
</SettingItem>
<SettingItem
label="Keep full messages for"
description={
'How far back complete messages - including formatted content - are stored so they ' +
'can be read with no network. Attachments are not downloaded; they still need a ' +
'connection.'
}
>
<select
className="h-9 rounded-md border border-border bg-background px-2 text-sm"
value={status.policy.bodyDays}
disabled={busy !== null}
onChange={(e) => void savePolicy({ bodyDays: Number(e.target.value) })}
>
{[7, 14, 30, 90, 180, 365].map((d) => (
<option key={d} value={d}>{d >= 365 ? '1 year' : `${d} days`}</option>
))}
</select>
</SettingItem>
<SettingItem
label="Storage limit for message content"
description={
'The oldest stored content is removed first when this is reached. Messages stay in ' +
'the offline list either way - only their content is removed.'
}
>
<select
className="h-9 rounded-md border border-border bg-background px-2 text-sm"
value={status.policy.maxBodyMB}
disabled={busy !== null}
onChange={(e) => void savePolicy({ maxBodyMB: Number(e.target.value) })}
>
{[100, 250, 500, 1000, 2000, 5000].map((mb) => (
<option key={mb} value={mb}>{mb >= 1000 ? `${mb / 1000} GB` : `${mb} MB`}</option>
))}
</select>
</SettingItem>
<SettingItem
label="Offline mail actions"
description={message ?? 'Download now, or delete everything stored offline on this device.'}
>
<div className="flex gap-2">
<Button variant="outline" size="sm" onClick={handleSync} disabled={busy !== null}>
{busy === 'sync' ? 'Downloading…' : 'Download now'}
</Button>
<Button variant="outline" size="sm" onClick={handlePurge} disabled={busy !== null}>
{busy === 'purge' ? 'Deleting…' : 'Delete offline mail'}
</Button>
</div>
</SettingItem>
</>
);
}